Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

chore: optimize sql editor landing (#21405)

ecmadao47a923697c33
diff --git a/frontend/scripts/ui-guideline-legacy-debt.json b/frontend/scripts/ui-guideline-legacy-debt.json
index 41a11c637e..982b1a3e4a 100644
--- a/frontend/scripts/ui-guideline-legacy-debt.json
+++ b/frontend/scripts/ui-guideline-legacy-debt.json
@@ -2562,30 +2562,6 @@
"token": "hover:bg-gray-200",
"count": 1
},
- {
- "path": "src/routes/workspace/LandingPage.tsx",
- "rule": "no-native-control",
- "token": "button",
- "count": 2
- },
- {
- "path": "src/routes/workspace/LandingPage.tsx",
- "rule": "no-raw-color",
- "token": "bg-white",
- "count": 1
- },
- {
- "path": "src/routes/workspace/LandingPage.tsx",
- "rule": "no-raw-color",
- "token": "hover:bg-gray-100",
- "count": 4
- },
- {
- "path": "src/routes/workspace/LandingPage.tsx",
- "rule": "no-raw-color",
- "token": "text-gray-500",
- "count": 6
- },
{
"path": "src/routes/workspace/MemberDatabaseResourceName.tsx",
"rule": "no-raw-color",
diff --git a/frontend/src/components/ui/quick-link.tsx b/frontend/src/components/ui/quick-link.tsx
new file mode 100644
index 0000000000..11ef146629
--- /dev/null
+++ b/frontend/src/components/ui/quick-link.tsx
@@ -0,0 +1,60 @@
+import { Button as BaseButton } from "@base-ui/react/button";
+import { cva } from "class-variance-authority";
+import type { ComponentProps, ReactNode } from "react";
+import { RouterLink, type RouterLinkProps } from "@/components/RouterLink";
+import { cn } from "@/lib/utils";
+
+const quickLinkVariants = cva(
+ "flex h-auto items-center justify-center gap-x-2 cursor-pointer border border-control-border rounded-sm bg-background px-4 py-5 text-sm leading-5 font-normal text-main hover:bg-control-bg no-underline focus:outline-hidden focus-visible:ring-2 focus-visible:ring-accent focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50"
+);
+
+type QuickLinkContentProps = {
+ readonly icon: ReactNode;
+ readonly children: ReactNode;
+};
+
+type QuickLinkButtonProps = Omit<ComponentProps<"button">, "children"> &
+ QuickLinkContentProps;
+
+export function QuickLinkButton({
+ icon,
+ children,
+ className,
+ ref,
+ style,
+ ...props
+}: QuickLinkButtonProps) {
+ return (
+ <BaseButton
+ {...props}
+ ref={ref}
+ className={cn(quickLinkVariants(), className)}
+ style={style}
+ >
+ <span>{icon}</span>
+ <span>{children}</span>
+ </BaseButton>
+ );
+}
+
+type QuickLinkLinkProps = Omit<RouterLinkProps, "children"> &
+ QuickLinkContentProps;
+
+export function QuickLinkLink({
+ icon,
+ children,
+ className,
+ style,
+ ...props
+}: QuickLinkLinkProps) {
+ return (
+ <RouterLink
+ {...props}
+ className={cn(quickLinkVariants(), className)}
+ style={style}
+ >
+ <span>{icon}</span>
+ <span>{children}</span>
+ </RouterLink>
+ );
+}
diff --git a/frontend/src/modules/sql-editor/components/SQLEditorHeader.test.tsx b/frontend/src/modules/sql-editor/components/SQLEditorHeader.test.tsx
index 30b08c4f2e..71f949914c 100644
--- a/frontend/src/modules/sql-editor/components/SQLEditorHeader.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SQLEditorHeader.test.tsx
@@ -336,7 +336,7 @@ describe("SQLEditorHeader", () => {
unmount();
});
- test("keeps SQL Editor when clicking the current workspace", () => {
+ test("does nothing when clicking the current workspace", () => {
const { render, unmount } = renderIntoContainer(<SQLEditorHeader />);
render();
@@ -347,11 +347,9 @@ describe("SQLEditorHeader", () => {
});
});
- expect(mocks.resolve).toHaveBeenCalledWith({
- name: "sql-editor.home",
- });
+ expect(mocks.resolve).not.toHaveBeenCalled();
expect(mocks.record).not.toHaveBeenCalled();
- expect(mocks.push).toHaveBeenCalledWith({ name: "sql-editor.home" });
+ expect(mocks.push).not.toHaveBeenCalled();
expect(mocks.switchWorkspace).not.toHaveBeenCalled();
expect(mocks.assignLocation).not.toHaveBeenCalled();
diff --git a/frontend/src/modules/sql-editor/components/SQLEditorHeader.tsx b/frontend/src/modules/sql-editor/components/SQLEditorHeader.tsx
index fb3794a741..95dfcd29ef 100644
--- a/frontend/src/modules/sql-editor/components/SQLEditorHeader.tsx
+++ b/frontend/src/modules/sql-editor/components/SQLEditorHeader.tsx
@@ -92,20 +92,13 @@ export function SQLEditorHeader() {
}, [t]);
const handleSelectWorkspace = useCallback(
- (workspaceName: string, event: React.MouseEvent<HTMLElement>) => {
+ (workspaceName: string) => {
+ if (workspaceName === workspace?.name) return;
+
const route = navigate.resolve({
name: SQL_EDITOR_HOME_MODULE,
});
- if (workspaceName === workspace?.name) {
- if (event.ctrlKey || event.metaKey) {
- window.open(route.fullPath, "_blank");
- } else {
- void navigate.push({ name: SQL_EDITOR_HOME_MODULE });
- }
- return;
- }
-
void switchWorkspace(workspaceName, false, true).then(() => {
globalThis.location.assign(route.fullPath);
});
diff --git a/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.test.tsx b/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.test.tsx
index ec8f8722ac..983842f3fa 100644
--- a/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.test.tsx
@@ -45,6 +45,12 @@ const mocks = vi.hoisted(() => {
async (project: string) => project
),
setAsidePanelTab: vi.fn(),
+ cleanupLegacyPouchDatabases: vi.fn(async () => undefined),
+ permissionState: {
+ missedBasicPermissions: [] as string[],
+ missedPermissions: [] as string[],
+ permitted: true,
+ },
getOrFetchDatabaseByName: vi.fn(async (name: string) => ({
name,
project: "projects/proj1",
@@ -105,17 +111,13 @@ vi.mock("react-i18next", () => ({
vi.mock("@/components/ComponentPermissionGuard", () => ({
PermissionDeniedFallback: () => <div data-testid="denied" />,
- useComponentPermissionState: () => ({
- missedBasicPermissions: [],
- missedPermissions: [],
- permitted: true,
- }),
+ useComponentPermissionState: vi.fn(() => mocks.permissionState),
usePermissionDataReady: () => true,
}));
vi.mock("@/hooks/useAppProject", () => ({
- useAppProject: () => ({
- name: "projects/proj1",
+ useAppProject: (name: string) => ({
+ name: name || "projects/-1",
}),
}));
@@ -189,7 +191,7 @@ vi.mock("@/modules/sql-editor/store/tab", () => ({
}));
vi.mock("@/modules/sql-editor/legacy/migration", () => ({
- cleanupLegacyPouchDatabases: vi.fn(async () => undefined),
+ cleanupLegacyPouchDatabases: mocks.cleanupLegacyPouchDatabases,
}));
vi.mock("./SQLEditorHomePage", () => ({
@@ -204,6 +206,7 @@ const renderShell = () => {
root.render(<SQLEditorRouteShell />);
});
return {
+ container,
unmount: () =>
act(() => {
root.unmount();
@@ -251,6 +254,12 @@ beforeEach(() => {
contentSize: BigInt(new TextEncoder().encode("select 1").length),
}));
mocks.editorState.project = "projects/proj1";
+ mocks.cleanupLegacyPouchDatabases.mockResolvedValue(undefined);
+ mocks.permissionState = {
+ missedBasicPermissions: [],
+ missedPermissions: [],
+ permitted: true,
+ };
mocks.tabsState.tabsById = new Map();
mocks.tabsState.openTmpTabList = [];
mocks.tabsState.currentTabId = "";
@@ -285,6 +294,135 @@ beforeEach(() => {
});
describe("SQLEditorRouteShell", () => {
+ test("waits for bootstrap before rendering the project selector", async () => {
+ let finishCleanup: (value: undefined) => void;
+ const cleanup = new Promise<undefined>((resolve) => {
+ finishCleanup = resolve;
+ });
+ mocks.editorState.project = "";
+ mocks.renderRoute = {
+ ...mocks.renderRoute,
+ name: "sql-editor.home",
+ params: {},
+ query: {},
+ };
+ mocks.currentRoute = mocks.renderRoute;
+ mocks.cleanupLegacyPouchDatabases.mockReturnValueOnce(cleanup);
+
+ const { container, unmount } = renderShell();
+
+ expect(
+ container.querySelector('[data-testid="sql-editor-home"]')
+ ).toBeNull();
+
+ await act(async () => {
+ finishCleanup(undefined);
+ await cleanup;
+ await Promise.resolve();
+ await Promise.resolve();
+ });
+
+ expect(
+ container.querySelector('[data-testid="sql-editor-home"]')
+ ).not.toBeNull();
+ unmount();
+ });
+
+ test("renders the project selector before workspace-level route permissions", async () => {
+ mocks.editorState.project = "";
+ mocks.renderRoute = {
+ ...mocks.renderRoute,
+ name: "sql-editor.home",
+ params: {},
+ query: {},
+ requiredPermissions: ["bb.projects.get"],
+ };
+ mocks.currentRoute = mocks.renderRoute;
+ mocks.permissionState = {
+ missedBasicPermissions: ["bb.roles.list"],
+ missedPermissions: ["bb.projects.get"],
+ permitted: false,
+ };
+
+ const { container, unmount } = renderShell();
+
+ await act(async () => {
+ await Promise.resolve();
+ await Promise.resolve();
+ await Promise.resolve();
+ });
+
+ expect(
+ container.querySelector('[data-testid="sql-editor-home"]')
+ ).not.toBeNull();
+ expect(container.querySelector('[data-testid="denied"]')).toBeNull();
+ unmount();
+ });
+
+ test("does not auto-select a project when the editor has no selection", async () => {
+ mocks.editorState.project = "";
+ mocks.renderRoute = {
+ ...mocks.renderRoute,
+ name: "sql-editor",
+ params: {},
+ query: {},
+ };
+ mocks.currentRoute = {
+ ...mocks.currentRoute,
+ name: "sql-editor",
+ params: {},
+ query: {},
+ };
+ mocks.maybeSwitchProject.mockImplementation(async (project: string) =>
+ project ? project : undefined
+ );
+
+ const { unmount } = renderShell();
+
+ await act(async () => {
+ await Promise.resolve();
+ await Promise.resolve();
+ await Promise.resolve();
+ });
+
+ expect(mocks.searchProjects).not.toHaveBeenCalled();
+ expect(mocks.maybeSwitchProject).not.toHaveBeenCalledWith(
+ "projects/proj1"
+ );
+ expect(mocks.editorState.setProject).toHaveBeenCalledWith("");
+ unmount();
+ });
+
+ test("does not restore the default project when it is the only project", async () => {
+ mocks.editorState.project = "projects/proj1";
+ mocks.renderRoute = {
+ ...mocks.renderRoute,
+ name: "sql-editor",
+ params: {},
+ query: {},
+ };
+ mocks.currentRoute = {
+ ...mocks.currentRoute,
+ name: "sql-editor",
+ params: {},
+ query: {},
+ };
+ const { unmount } = renderShell();
+
+ await act(async () => {
+ await Promise.resolve();
+ await Promise.resolve();
+ await Promise.resolve();
+ });
+
+ expect(mocks.searchProjects).not.toHaveBeenCalled();
+ expect(mocks.maybeSwitchProject).not.toHaveBeenCalledWith(
+ "projects/proj1"
+ );
+ expect(mocks.editorState.setProject).toHaveBeenCalledWith("");
+ unmount();
+ });
+
test("keeps a restored data explorer tab that matches the database route", async () => {
mocks.tabsState.initProject.mockImplementationOnce(async () => {
const tab = {
diff --git a/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.tsx b/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.tsx
index b2445c8f46..adc7805756 100644
--- a/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.tsx
+++ b/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.tsx
@@ -1,5 +1,5 @@
import dayjs from "dayjs";
-import { debounce, head, omit } from "lodash-es";
+import { debounce, omit } from "lodash-es";
import { useEffect, useRef, useState } from "react";
import { useTranslation } from "react-i18next";
import { router, useCurrentRoute, useNavigate } from "@/app/router";
@@ -46,7 +46,6 @@ import {
extractInstanceResourceName,
extractProjectResourceName,
extractSavedQueryID,
- getDefaultPagination,
getSheetStatement,
isSavedQueryReadableV1,
storageKeySqlEditorSidebarTab,
@@ -159,18 +158,6 @@ export function SQLEditorRouteShell() {
})();
}, []);
- const fallbackToFirstProject = async () => {
- const { projects } = await useAppStore.getState().searchProjects({
- pageSize: getDefaultPagination(),
- pageToken: "",
- });
- return (
- head(projects)?.name ??
- useAppStore.getState().serverInfo?.defaultProject ??
- ""
- );
- };
-
const initializeProject = async () => {
const projectInQuery = route.query.project as string | undefined;
const projectInParams = route.params.project as string | undefined;
@@ -185,11 +172,15 @@ export function SQLEditorRouteShell() {
project = getSQLEditorEditorState().project;
}
- let initializeSuccess = !!(await maybeSwitchProject(project));
- if (!initializeSuccess) {
- project = await fallbackToFirstProject();
- initializeSuccess = !!(await maybeSwitchProject(project));
+ if (
+ !projectInQuery &&
+ !projectInParams &&
+ project === useAppStore.getState().serverInfo?.defaultProject
+ ) {
+ project = "";
}
+
+ const initializeSuccess = !!(await maybeSwitchProject(project));
if (!initializeSuccess) {
getSQLEditorEditorState().setProject("");
}
@@ -769,7 +760,22 @@ export function SQLEditorRouteShell() {
checkBasicWorkspacePermissions: true,
});
- if (!projectContextReady || !permissionReady) {
+ // The SQL Editor home route is where a project-scoped user chooses the
+ // project whose IAM policy grants access. Do not require workspace-level
+ // editor permissions before showing that selector.
+ if (!project && route.name === SQL_EDITOR_HOME_MODULE && bootstrapDone) {
+ return (
+ <div className="h-full min-h-0 flex flex-col">
+ <SQLEditorHomePage />
+ </div>
+ );
+ }
+
+ if (
+ (!project && route.name === SQL_EDITOR_HOME_MODULE && !bootstrapDone) ||
+ !projectContextReady ||
+ !permissionReady
+ ) {
return (
<div className="flex items-center justify-center h-screen">
<span className="text-control-light">…</span>
diff --git a/frontend/src/modules/sql-editor/components/SavedQueryPane.test.tsx b/frontend/src/modules/sql-editor/components/SavedQueryPane.test.tsx
index 306ce286ce..6f24d0a141 100644
--- a/frontend/src/modules/sql-editor/components/SavedQueryPane.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SavedQueryPane.test.tsx
@@ -31,6 +31,7 @@ const mocks = vi.hoisted(() => ({
useTranslation: vi.fn(() => ({ t: (key: string) => key })),
useSheetContext: vi.fn(),
useSheetContextByView: vi.fn(),
+ project: "projects/proj1",
}));
vi.mock("react-i18next", () => ({
@@ -42,6 +43,11 @@ vi.mock("@/modules/sql-editor/model/Sheet", () => ({
useSheetContextByView: mocks.useSheetContextByView,
}));
+vi.mock("@/modules/sql-editor/store/editor", () => ({
+ useSQLEditorEditorState: (selector: (state: { project: string }) => unknown) =>
+ selector({ project: mocks.project }),
+}));
+
// ---- primitive mocks --------------------------------------------------------
vi.mock("@/components/ui/button", () => ({
@@ -384,6 +390,7 @@ let SavedQueryPane: typeof import("./SavedQueryPane").SavedQueryPane;
beforeEach(async () => {
vi.clearAllMocks();
+ mocks.project = "projects/proj1";
({ SavedQueryPane } = await import("./SavedQueryPane"));
});
@@ -395,6 +402,22 @@ afterEach(() => {
// ---- tests ------------------------------------------------------------------
describe("SavedQueryPane", () => {
+ test("renders an empty state instead of saved-query trees without a project", () => {
+ mocks.project = "";
+ setupDefaultMocks();
+ const { container, render, unmount } = renderIntoContainer(
+ <SavedQueryPane />
+ );
+ render();
+
+ expect(container.textContent).toContain("common.empty");
+ expect(
+ container.querySelectorAll("[data-testid='sheet-tree']")
+ ).toHaveLength(0);
+
+ unmount();
+ });
+
test("1. Renders SheetTree for each enabled view", () => {
setupDefaultMocks();
const { container, render, unmount } = renderIntoContainer(
diff --git a/frontend/src/modules/sql-editor/components/SavedQueryPane.tsx b/frontend/src/modules/sql-editor/components/SavedQueryPane.tsx
index cf6bc84477..491de401af 100644
--- a/frontend/src/modules/sql-editor/components/SavedQueryPane.tsx
+++ b/frontend/src/modules/sql-editor/components/SavedQueryPane.tsx
@@ -27,6 +27,7 @@ import {
useSheetContext,
useSheetContextByView,
} from "@/modules/sql-editor/model/Sheet";
+import { useSQLEditorEditorState } from "@/modules/sql-editor/store/editor";
import { FilterMenuItem } from "./FilterMenuItem";
import { SheetTree, type SheetTreeHandle } from "./SheetTree";
@@ -42,6 +43,7 @@ function collectSelectableNodes(
export function SavedQueryPane() {
const { t } = useTranslation();
+ const project = useSQLEditorEditorState((s) => s.project);
const sheetContext = useSheetContext();
const { filter, filterChanged, setFilter } = sheetContext;
@@ -116,7 +118,8 @@ export function SavedQueryPane() {
},
];
- const showMultiSelectToolbar = multiSelectMode && filter.showMine;
+ const showMultiSelectToolbar =
+ !!project && multiSelectMode && filter.showMine;
const hasAnyView = filter.showMine || views.length > 0;
return (
@@ -169,28 +172,36 @@ export function SavedQueryPane() {
showMultiSelectToolbar && "pb-16"
)}
>
- {filter.showMine && (
- <SheetTree
- key="my"
- ref={mineSheetTreeRef}
- view="my"
- multiSelectMode={multiSelectMode}
- checkedNodes={checkedNodes}
- onMultiSelectModeChange={setMultiSelectMode}
- onCheckedNodesChange={setCheckedNodes}
- />
- )}
- {views.map((view) => (
- // Non-"my" trees intentionally omit multi-select callbacks. Vue
- // bound v-model only on the `my` tree; wiring them everywhere let
- // a shared/draft right-click populate the my tree's checkedNodes,
- // which the toolbar's Delete flow acts on.
- <SheetTree key={view} view={view} />
- ))}
- {!hasAnyView && (
- <div className="mt-10 text-center text-sm text-control-light">
- {t("common.no-data")}
+ {!project ? (
+ <div className="mt-16 text-center text-sm text-control-light">
+ {t("common.empty")}
</div>
+ ) : (
+ <>
+ {filter.showMine && (
+ <SheetTree
+ key="my"
+ ref={mineSheetTreeRef}
+ view="my"
+ multiSelectMode={multiSelectMode}
+ checkedNodes={checkedNodes}
+ onMultiSelectModeChange={setMultiSelectMode}
+ onCheckedNodesChange={setCheckedNodes}
+ />
+ )}
+ {views.map((view) => (
+ // Non-"my" trees intentionally omit multi-select callbacks. Vue
+ // bound v-model only on the `my` tree; wiring them everywhere let
+ // a shared/draft right-click populate the my tree's checkedNodes,
+ // which the toolbar's Delete flow acts on.
+ <SheetTree key={view} view={view} />
+ ))}
+ {!hasAnyView && (
+ <div className="mt-10 text-center text-sm text-control-light">
+ {t("common.no-data")}
+ </div>
+ )}
+ </>
)}
</div>
diff --git a/frontend/src/modules/sql-editor/components/Welcome.test.tsx b/frontend/src/modules/sql-editor/components/Welcome.test.tsx
index 6861a9751e..ee176b5f42 100644
--- a/frontend/src/modules/sql-editor/components/Welcome.test.tsx
+++ b/frontend/src/modules/sql-editor/components/Welcome.test.tsx
@@ -1,4 +1,4 @@
-import type { ReactElement } from "react";
+import type { MouseEvent as ReactMouseEvent, ReactElement } from "react";
import { act } from "react";
import { createRoot } from "react-dom/client";
import { beforeEach, describe, expect, test, vi } from "vitest";
@@ -8,26 +8,31 @@ import { beforeEach, describe, expect, test, vi } from "vitest";
).IS_REACT_ACT_ENVIRONMENT = true;
const mocks = vi.hoisted(() => ({
- useTranslation: vi.fn(() => ({ t: (key: string) => key })),
- usePermissionCheck:
- vi.fn<
- (
- perms: readonly string[],
- project?: unknown
- ) => [boolean, string | undefined]
- >(),
routerPush: vi.fn(),
+ navigatePush: vi.fn(),
+ navigateResolve: vi.fn(() => ({ fullPath: "/sql-editor/projects/selected" })),
+ onChangeProject: vi.fn(),
+ fetchDatabases: vi.fn(),
+ projectName: "" as string,
projectData: { name: "projects/test" } as { name: string },
+ projects: [] as { name: string }[],
+ hasDefaultProject: false,
+ defaultProjectName: "",
themeDark: false,
+ deniedPermissions: new Set<string>(),
}));
vi.mock("react-i18next", () => ({
initReactI18next: { type: "3rdParty", init: () => {} },
- useTranslation: mocks.useTranslation,
+ useTranslation: () => ({ t: (key: string) => key }),
}));
vi.mock("@/components/PermissionGuard", () => ({
- usePermissionCheck: mocks.usePermissionCheck,
+ PermissionGuard: ({ children }: { children: ReactElement }) => children,
+ usePermissionCheck: (permissions: readonly string[]) => [
+ !permissions.some((permission) => mocks.deniedPermissions.has(permission)),
+ "missing permission",
+ ],
}));
vi.mock("@/components/BytebaseLogo", () => ({
@@ -46,21 +51,101 @@ vi.mock("@/components/BytebaseLogo", () => ({
),
}));
+vi.mock("@/hooks/useAppState", () => ({
+ useProjectList: (
+ _query: string,
+ { excludeDefault = true }: { excludeDefault?: boolean } = {}
+ ) => ({
+ projects: [
+ ...(mocks.hasDefaultProject && !excludeDefault
+ ? [{ name: "projects/default" }]
+ : []),
+ ...mocks.projects,
+ ],
+ isLoading: false,
+ }),
+}));
+
vi.mock("@/hooks/useAppProject", () => ({
- useAppProject: () => mocks.projectData,
+ useAppProject: (name: string) =>
+ name ? { ...mocks.projectData, name } : undefined,
}));
vi.mock("@/app/router", async (importOriginal) => ({
...(await importOriginal<typeof import("@/app/router")>()),
router: { push: mocks.routerPush },
+ SQL_EDITOR_PROJECT_MODULE: "sql-editor.project",
+ useNavigate: () => ({
+ push: mocks.navigatePush,
+ resolve: mocks.navigateResolve,
+ }),
+}));
+
+vi.mock("@/app/router/handles", () => ({
+ PROJECT_V1_ROUTE_DASHBOARD: "workspace.project",
+ PROJECT_V1_ROUTE_INSTANCE_CREATE: "workspace.project.instance.create",
+}));
+
+vi.mock("@/utils/v1/project", () => ({
+ extractProjectResourceName: (name: string) => name.replace("projects/", ""),
+}));
+
+vi.mock("@/lib/productIntro", () => ({
+ CREATE_PROJECT_PRODUCT_INTRO: "create-project",
+ PRODUCT_INTRO_QUERY_KEY: "product-intro",
+}));
+
+vi.mock("@/modules/sql-editor/store/editor", () => ({
+ useSQLEditorEditorState: (
+ selector: (state: { project: string }) => unknown
+ ) => selector({ project: mocks.projectName }),
+}));
+
+vi.mock("@/modules/sql-editor/store", () => ({
+ useSQLEditorStore: (
+ selector: (state: { maybeSwitchProject: typeof mocks.onChangeProject }) => unknown
+ ) => selector({ maybeSwitchProject: mocks.onChangeProject }),
}));
-vi.mock("@/stores", () => ({
- useProjectV1Store: vi.fn(),
+vi.mock("@/stores/app", () => {
+ const state = {
+ get serverInfo() {
+ return { defaultProject: mocks.defaultProjectName };
+ },
+ fetchDatabases: mocks.fetchDatabases,
+ };
+ return {
+ useAppStore: Object.assign(
+ (selector: (store: typeof state) => unknown) => selector(state),
+ { getState: () => state }
+ ),
+ };
+});
+
+vi.mock("@/components/header/ProjectSwitchPanel", () => ({
+ ProjectSwitchPanel: ({
+ onSelectProject,
+ }: {
+ onSelectProject: (
+ project: { name: string },
+ event: ReactMouseEvent<HTMLElement>
+ ) => void;
+ }) => (
+ <button
+ data-testid="choose-project"
+ onClick={(event) =>
+ onSelectProject({ name: "projects/selected" }, event)
+ }
+ >
+ Choose project
+ </button>
+ ),
}));
-vi.mock("@/modules/sql-editor/store/editor-vue-state", () => ({
- useSQLEditorVueState: vi.fn(),
+vi.mock("@/components/ui/popover", () => ({
+ Popover: ({ children }: { children: ReactElement }) => <>{children}</>,
+ PopoverContent: ({ children }: { children: ReactElement }) => <>{children}</>,
+ PopoverTrigger: ({ render }: { render: ReactElement }) => render,
}));
vi.mock("@/assets/logo-full.svg", () => ({
@@ -99,117 +184,262 @@ const renderIntoContainer = (element: ReactElement) => {
};
};
+const flushEffects = async () => {
+ await act(async () => {
+ await Promise.resolve();
+ });
+};
+
beforeEach(async () => {
vi.clearAllMocks();
+ mocks.projectName = "";
+ mocks.projects = [];
+ mocks.hasDefaultProject = false;
+ mocks.defaultProjectName = "";
mocks.themeDark = false;
- // Default: both permissions granted.
- mocks.usePermissionCheck.mockReturnValue([true, undefined]);
+ mocks.deniedPermissions.clear();
+ window.open = vi.fn();
+ mocks.fetchDatabases.mockResolvedValue({ databases: [] });
({ Welcome } = await import("./Welcome"));
});
describe("Welcome", () => {
- test("renders both buttons when both permissions present", () => {
+ test("switches to a selected accessible project", async () => {
+ mocks.projects = [{ name: "projects/selected" }];
+ mocks.onChangeProject.mockResolvedValue("projects/selected");
const { container, render, unmount } = renderIntoContainer(
<Welcome onChangeConnection={() => {}} />
);
render();
- expect(container.firstElementChild?.className).toContain("gap-y-10");
+
expect(
- container.querySelector('[data-testid="welcome-logo"]')?.className
- ).toContain("h-20");
+ container.querySelector('[data-testid="select-project"]')
+ ).not.toBeNull();
expect(
- container.querySelector('[data-testid="welcome-logo"]')?.className
- ).toContain("w-44");
- expect(container.textContent).toContain("sql-editor.add-a-new-instance");
- expect(container.textContent).toContain("sql-editor.connect-to-a-database");
+ container.querySelector('[data-testid="create-project"]')
+ ).toBeNull();
+
+ act(() => {
+ (
+ container.querySelector(
+ '[data-testid="choose-project"]'
+ ) as HTMLButtonElement
+ ).click();
+ });
+ expect(mocks.onChangeProject).toHaveBeenCalledWith("projects/selected");
+ await flushEffects();
+ expect(mocks.navigatePush).toHaveBeenCalledWith({
+ fullPath: "/sql-editor/projects/selected",
+ });
unmount();
});
- test("passes dark SQL Editor theme to the logo", () => {
- mocks.themeDark = true;
+ test("offers project creation when no accessible project exists", () => {
const { container, render, unmount } = renderIntoContainer(
<Welcome onChangeConnection={() => {}} />
);
render();
- expect(
- container.querySelector('[data-testid="welcome-logo"]')?.getAttribute(
- "data-builtin-theme"
- )
- ).toBe("dark");
+
+ act(() => {
+ (
+ container.querySelector(
+ '[data-testid="create-project"]'
+ ) as HTMLButtonElement
+ ).click();
+ });
+ expect(mocks.routerPush).toHaveBeenCalledWith({
+ name: "workspace.project",
+ query: { "product-intro": "create-project" },
+ });
unmount();
});
- test("hides Add-Instance when missing bb.instances.create", () => {
- mocks.usePermissionCheck.mockImplementation((perms) => {
- if (perms.includes("bb.instances.create")) return [false, "missing"];
- return [true, undefined];
- });
+ test("treats the default project as no project", () => {
+ mocks.hasDefaultProject = true;
const { container, render, unmount } = renderIntoContainer(
<Welcome onChangeConnection={() => {}} />
);
render();
- expect(container.textContent).not.toContain(
- "sql-editor.add-a-new-instance"
- );
- expect(container.textContent).toContain("sql-editor.connect-to-a-database");
+
+ expect(
+ container.querySelector('[data-testid="select-project"]')
+ ).toBeNull();
+ expect(
+ container.querySelector('[data-testid="create-project"]')
+ ).not.toBeNull();
unmount();
});
- test("hides Connect when missing bb.sql.select", () => {
- mocks.usePermissionCheck.mockImplementation((perms) => {
- if (perms.includes("bb.sql.select")) return [false, "missing"];
- return [true, undefined];
+ test("keeps database connection available for an explicit default project", async () => {
+ mocks.projectName = "projects/default";
+ mocks.defaultProjectName = "projects/default";
+ mocks.fetchDatabases.mockResolvedValue({
+ databases: [{ name: "databases/default" }],
});
const { container, render, unmount } = renderIntoContainer(
<Welcome onChangeConnection={() => {}} />
);
render();
- expect(container.textContent).toContain("sql-editor.add-a-new-instance");
- expect(container.textContent).not.toContain(
- "sql-editor.connect-to-a-database"
- );
+ await flushEffects();
+
+ expect(
+ container.querySelector('[data-testid="create-project"]')
+ ).toBeNull();
+ expect(
+ container.querySelector('[data-testid="create-project-instance"]')
+ ).toBeNull();
+ expect(
+ container.querySelector('[data-testid="connect-database"]')
+ ).not.toBeNull();
+
unmount();
});
- test("hides both buttons when neither permission present", () => {
- mocks.usePermissionCheck.mockReturnValue([false, "missing"]);
+ test("keeps project creation visible but disabled without permission", () => {
+ mocks.deniedPermissions.add("bb.projects.create");
const { container, render, unmount } = renderIntoContainer(
<Welcome onChangeConnection={() => {}} />
);
render();
- expect(container.querySelectorAll("button")).toHaveLength(0);
+
+ expect(
+ container.querySelector('[data-testid="create-project"]')
+ ).toBeDisabled();
unmount();
});
- test("routes to instance dashboard with #add hash on Add-Instance click", () => {
+ test("opens a selected project in a new tab on a modified click", async () => {
+ mocks.projects = [{ name: "projects/selected" }];
const { container, render, unmount } = renderIntoContainer(
<Welcome onChangeConnection={() => {}} />
);
render();
- const buttons = container.querySelectorAll("button");
- // Add-Instance is the first button (matches Vue order).
+
act(() => {
- (buttons[0] as HTMLButtonElement).click();
+ container
+ .querySelector('[data-testid="choose-project"]')
+ ?.dispatchEvent(
+ new MouseEvent("click", { bubbles: true, ctrlKey: true })
+ );
});
+ await flushEffects();
+
+ expect(window.open).toHaveBeenCalledWith(
+ "/sql-editor/projects/selected",
+ "_blank"
+ );
+ expect(mocks.onChangeProject).not.toHaveBeenCalled();
+ expect(mocks.navigatePush).not.toHaveBeenCalled();
+ unmount();
+ });
+
+ test("creates an instance in the selected project when it has no databases", async () => {
+ mocks.projectName = "projects/test";
+ const { container, render, unmount } = renderIntoContainer(
+ <Welcome onChangeConnection={() => {}} />
+ );
+ render();
+ await flushEffects();
+
+ const addInstance = container.querySelector(
+ '[data-testid="create-project-instance"]'
+ ) as HTMLButtonElement;
+ expect(addInstance).not.toBeNull();
+ expect(container.querySelector('[data-testid="connect-database"]')).toBeNull();
+ act(() => addInstance.click());
expect(mocks.routerPush).toHaveBeenCalledWith({
- name: "workspace.instance",
- hash: "#add",
+ name: "workspace.project.instance.create",
+ params: { projectId: "test" },
});
unmount();
});
- test("invokes onChangeConnection on Connect click", () => {
+ test("keeps instance creation visible but disabled without project permission", async () => {
+ mocks.projectName = "projects/test";
+ mocks.deniedPermissions.add("bb.instances.create");
+ const { container, render, unmount } = renderIntoContainer(
+ <Welcome onChangeConnection={() => {}} />
+ );
+ render();
+ await flushEffects();
+
+ expect(
+ container.querySelector('[data-testid="create-project-instance"]')
+ ).toBeDisabled();
+ unmount();
+ });
+
+ test("keeps the database action visible but disabled without query permission", async () => {
+ mocks.projectName = "projects/test";
+ mocks.fetchDatabases.mockResolvedValue({
+ databases: [{ name: "databases/db" }],
+ });
+ mocks.deniedPermissions.add("bb.sql.select");
+ const { container, render, unmount } = renderIntoContainer(
+ <Welcome onChangeConnection={() => {}} />
+ );
+ render();
+ await flushEffects();
+
+ expect(
+ container.querySelector('[data-testid="connect-database"]')
+ ).toBeDisabled();
+ unmount();
+ });
+
+ test("opens the connection panel when a database is available", async () => {
+ mocks.projectName = "projects/test";
+ mocks.fetchDatabases.mockResolvedValue({
+ databases: [{ name: "databases/db" }],
+ });
const onChangeConnection = vi.fn();
const { container, render, unmount } = renderIntoContainer(
<Welcome onChangeConnection={onChangeConnection} />
);
render();
- const buttons = container.querySelectorAll("button");
- // Connect is the second button (matches Vue order).
+ await flushEffects();
+
act(() => {
- (buttons[1] as HTMLButtonElement).click();
+ (
+ container.querySelector(
+ '[data-testid="connect-database"]'
+ ) as HTMLButtonElement
+ ).click();
});
expect(onChangeConnection).toHaveBeenCalledTimes(1);
unmount();
});
+
+ test("keeps both recovery actions available when database discovery fails", async () => {
+ mocks.projectName = "projects/test";
+ mocks.fetchDatabases.mockRejectedValue(new Error("network error"));
+ const { container, render, unmount } = renderIntoContainer(
+ <Welcome onChangeConnection={() => {}} />
+ );
+ render();
+ await flushEffects();
+
+ expect(
+ container.querySelector('[data-testid="create-project-instance"]')
+ ).not.toBeNull();
+ expect(
+ container.querySelector('[data-testid="connect-database"]')
+ ).not.toBeNull();
+
+ unmount();
+ });
+
+ test("passes dark SQL Editor theme to the logo", () => {
+ mocks.themeDark = true;
+ const { container, render, unmount } = renderIntoContainer(
+ <Welcome onChangeConnection={() => {}} />
+ );
+ render();
+ expect(
+ container.querySelector('[data-testid="welcome-logo"]')?.getAttribute(
+ "data-builtin-theme"
+ )
+ ).toBe("dark");
+ unmount();
+ });
});
diff --git a/frontend/src/modules/sql-editor/components/Welcome.tsx b/frontend/src/modules/sql-editor/components/Welcome.tsx
index 44c72a04f1..f3e58113c4 100644
--- a/frontend/src/modules/sql-editor/components/Welcome.tsx
+++ b/frontend/src/modules/sql-editor/components/Welcome.tsx
@@ -1,11 +1,33 @@
import { LayersIcon, LinkIcon } from "lucide-react";
+import { type MouseEvent as ReactMouseEvent, useEffect, useState } from "react";
import { useTranslation } from "react-i18next";
-import { router } from "@/app/router";
-import { INSTANCE_ROUTE_DASHBOARD } from "@/app/router/handles";
+import { router, SQL_EDITOR_PROJECT_MODULE, useNavigate } from "@/app/router";
+import {
+ PROJECT_V1_ROUTE_DASHBOARD,
+ PROJECT_V1_ROUTE_INSTANCE_CREATE,
+} from "@/app/router/handles";
import { BytebaseLogo } from "@/components/BytebaseLogo";
-import { usePermissionCheck } from "@/components/PermissionGuard";
+import { ProjectSwitchPanel } from "@/components/header/ProjectSwitchPanel";
+import {
+ PermissionGuard,
+ usePermissionCheck,
+} from "@/components/PermissionGuard";
+import {
+ Popover,
+ PopoverContent,
+ PopoverTrigger,
+} from "@/components/ui/popover";
import { useAppProject } from "@/hooks/useAppProject";
+import { useProjectList } from "@/hooks/useAppState";
+import {
+ CREATE_PROJECT_PRODUCT_INTRO,
+ PRODUCT_INTRO_QUERY_KEY,
+} from "@/lib/productIntro";
+import { useSQLEditorStore } from "@/modules/sql-editor/store";
import { useSQLEditorEditorState } from "@/modules/sql-editor/store/editor";
+import { useAppStore } from "@/stores/app";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
+import { extractProjectResourceName } from "@/utils/v1/project";
import { isDarkTheme } from "./theme/derive";
import { useSQLEditorTheme } from "./theme/SQLEditorThemeScope";
import { WelcomeButton } from "./WelcomeButton";
@@ -21,24 +43,138 @@ export type WelcomeProps = {
export function Welcome({ onChangeConnection }: WelcomeProps) {
const { t } = useTranslation();
+ const navigate = useNavigate();
const theme = useSQLEditorTheme();
const projectName = useSQLEditorEditorState((s) => s.project);
+ const defaultProjectName = useAppStore(
+ (s) => s.serverInfo?.defaultProject ?? ""
+ );
+ const maybeSwitchProject = useSQLEditorStore((s) => s.maybeSwitchProject);
+ const { projects, isLoading: isLoadingProjects } = useProjectList("", {
+ excludeDefault: true,
+ });
+ const [isProjectSelectorOpen, setProjectSelectorOpen] = useState(false);
+ const [databaseState, setDatabaseState] = useState<
+ "loading" | "empty" | "available" | "unavailable"
+ >("loading");
const resolvedProject = useAppProject(projectName);
const project = projectName ? resolvedProject : undefined;
+ const isDefaultProject = project?.name === defaultProjectName;
+
+ const [canCreateProject] = usePermissionCheck(["bb.projects.create"]);
+ const [canCreateInstance] = usePermissionCheck(
+ ["bb.instances.create"],
+ project
+ );
+ const [canConnect] = usePermissionCheck(["bb.sql.select"], project);
+
+ useEffect(() => {
+ if (!project?.name) return;
+
+ let cancelled = false;
+ setDatabaseState("loading");
+ void useAppStore
+ .getState()
+ .fetchDatabases({
+ parent: project.name,
+ pageSize: 1,
+ silent: true,
+ })
+ .then(({ databases }) => {
+ if (!cancelled) {
+ setDatabaseState(databases.length > 0 ? "available" : "empty");
+ }
+ })
+ .catch(() => {
+ if (!cancelled) {
+ setDatabaseState("unavailable");
+ }
+ });
- const [showCreateInstanceButton] = usePermissionCheck([
- "bb.instances.create",
- ]);
- const [showConnectButton] = usePermissionCheck(["bb.sql.select"], project);
+ return () => {
+ cancelled = true;
+ };
+ }, [project?.name]);
+
+ const handleCreateProject = () => {
+ setProjectSelectorOpen(false);
+ router.push({
+ name: PROJECT_V1_ROUTE_DASHBOARD,
+ query: {
+ [PRODUCT_INTRO_QUERY_KEY]: CREATE_PROJECT_PRODUCT_INTRO,
+ },
+ });
+ };
const handleCreateInstance = () => {
+ if (!project?.name) return;
router.push({
- name: INSTANCE_ROUTE_DASHBOARD,
- hash: "#add",
+ name: PROJECT_V1_ROUTE_INSTANCE_CREATE,
+ params: {
+ projectId: extractProjectResourceName(project.name),
+ },
});
};
+ const handleSelectProject = async (
+ selectedProject: Project,
+ event: ReactMouseEvent<HTMLElement>
+ ) => {
+ const route = navigate.resolve({
+ name: SQL_EDITOR_PROJECT_MODULE,
+ params: {
+ project: extractProjectResourceName(selectedProject.name),
+ },
+ });
+ if (event.ctrlKey || event.metaKey) {
+ window.open(route.fullPath, "_blank");
+ return;
+ }
+ const switchedProject = await maybeSwitchProject(selectedProject.name);
+ if (!switchedProject) return;
+ await navigate.push(route);
+ };
+
+ const createProjectAction = (
+ <PermissionGuard permissions={["bb.projects.create"]}>
+ <WelcomeButton
+ data-testid="create-project"
+ disabled={!canCreateProject}
+ icon={<LayersIcon className="size-5 text-control-light" />}
+ onClick={handleCreateProject}
+ >
+ {t("quick-action.new-project")}
+ </WelcomeButton>
+ </PermissionGuard>
+ );
+
+ const createInstanceAction = (
+ <PermissionGuard permissions={["bb.instances.create"]} project={project}>
+ <WelcomeButton
+ data-testid="create-project-instance"
+ disabled={!canCreateInstance}
+ icon={<LayersIcon className="size-5 text-control-light" />}
+ onClick={handleCreateInstance}
+ >
+ {t("sql-editor.add-a-new-instance")}
+ </WelcomeButton>
+ </PermissionGuard>
+ );
+
+ const connectDatabaseAction = (
+ <PermissionGuard permissions={["bb.sql.select"]} project={project}>
+ <WelcomeButton
+ data-testid="connect-database"
+ disabled={!canConnect}
+ icon={<LinkIcon className="size-5 text-control-light" />}
+ onClick={onChangeConnection}
+ >
+ {t("sql-editor.connect-to-a-database")}
+ </WelcomeButton>
+ </PermissionGuard>
+ );
+
return (
<div className="w-full h-full flex flex-col items-center justify-center gap-y-10">
<BytebaseLogo
@@ -46,24 +182,48 @@ export function Welcome({ onChangeConnection }: WelcomeProps) {
className="h-20 w-44"
/>
<div className="flex items-center flex-wrap gap-4">
- {showCreateInstanceButton && (
- <WelcomeButton
- variant="secondary"
- icon={<LayersIcon strokeWidth={1.5} className="size-8" />}
- onClick={handleCreateInstance}
- >
- {t("sql-editor.add-a-new-instance")}
- </WelcomeButton>
- )}
- {showConnectButton && (
- <WelcomeButton
- variant="primary"
- icon={<LinkIcon strokeWidth={1.5} className="size-8" />}
- onClick={onChangeConnection}
+ {!projectName && !isLoadingProjects && projects.length === 0
+ ? createProjectAction
+ : null}
+ {!projectName && projects.length > 0 ? (
+ <Popover
+ open={isProjectSelectorOpen}
+ onOpenChange={setProjectSelectorOpen}
>
- {t("sql-editor.connect-to-a-database")}
- </WelcomeButton>
- )}
+ <PopoverTrigger
+ render={
+ <WelcomeButton
+ data-testid="select-project"
+ icon={<LayersIcon className="size-5 text-control-light" />}
+ >
+ {t("project.select")}
+ </WelcomeButton>
+ }
+ />
+ <PopoverContent
+ align="center"
+ sideOffset={8}
+ className="w-[24rem] max-w-[calc(100vw-2rem)] p-0! py-3!"
+ >
+ <ProjectSwitchPanel
+ currentProjectName={projectName}
+ excludeDefaultProject
+ onClose={() => setProjectSelectorOpen(false)}
+ onRequestCreate={handleCreateProject}
+ onSelectProject={(selectedProject, event) => {
+ void handleSelectProject(selectedProject, event);
+ }}
+ />
+ </PopoverContent>
+ </Popover>
+ ) : null}
+ {project && !isDefaultProject && databaseState !== "loading"
+ ? createInstanceAction
+ : null}
+ {project &&
+ (databaseState === "available" || databaseState === "unavailable")
+ ? connectDatabaseAction
+ : null}
</div>
</div>
);
diff --git a/frontend/src/modules/sql-editor/components/WelcomeButton.test.tsx b/frontend/src/modules/sql-editor/components/WelcomeButton.test.tsx
index 226e6fc3e2..f37ced4210 100644
--- a/frontend/src/modules/sql-editor/components/WelcomeButton.test.tsx
+++ b/frontend/src/modules/sql-editor/components/WelcomeButton.test.tsx
@@ -34,7 +34,7 @@ beforeEach(async () => {
});
describe("WelcomeButton", () => {
- test("renders icon above label", () => {
+ test("matches the workspace landing quick-link style", () => {
const { container, render, unmount } = renderIntoContainer(
<WelcomeButton icon={<span data-testid="icon">I</span>}>
Hello
@@ -44,6 +44,10 @@ describe("WelcomeButton", () => {
const button = container.querySelector("button");
expect(button?.textContent).toContain("Hello");
expect(container.querySelector('[data-testid="icon"]')).not.toBeNull();
+ expect(button?.className).toContain("focus-visible:ring-2");
+ expect(button?.className).toContain("bg-background");
+ expect(button?.className).toContain("hover:bg-control-bg");
+ expect(button?.className).toContain("rounded-sm");
unmount();
});
@@ -63,25 +67,4 @@ describe("WelcomeButton", () => {
unmount();
});
- test("applies primary variant classes by default", () => {
- const { container, render, unmount } = renderIntoContainer(
- <WelcomeButton icon={<span>I</span>}>Primary</WelcomeButton>
- );
- render();
- const button = container.querySelector("button");
- expect(button?.className).toContain("bg-accent");
- unmount();
- });
-
- test("applies secondary variant classes when variant='secondary'", () => {
- const { container, render, unmount } = renderIntoContainer(
- <WelcomeButton icon={<span>I</span>} variant="secondary">
- Secondary
- </WelcomeButton>
- );
- render();
- const button = container.querySelector("button");
- expect(button?.className).toContain("border-control-border");
- unmount();
- });
});
diff --git a/frontend/src/modules/sql-editor/components/WelcomeButton.tsx b/frontend/src/modules/sql-editor/components/WelcomeButton.tsx
index d72746b458..ab278d7cb3 100644
--- a/frontend/src/modules/sql-editor/components/WelcomeButton.tsx
+++ b/frontend/src/modules/sql-editor/components/WelcomeButton.tsx
@@ -1,51 +1,21 @@
-import { Button as BaseButton } from "@base-ui/react/button";
-import { cva, type VariantProps } from "class-variance-authority";
import type { ComponentProps, ReactNode } from "react";
-import { cn } from "@/lib/utils";
+import { QuickLinkButton } from "@/components/ui/quick-link";
-/**
- * Big square icon-over-label button used on the SQL Editor Welcome screen.
- * Mirrors frontend/src/views/sql-editor/EditorPanel/Welcome/Button.vue,
- * which wraps NButton at 7rem × 7rem with a vertical flex content slot.
- */
-const welcomeButtonVariants = cva(
- "inline-flex flex-col items-center justify-center gap-2 min-w-28 h-28 px-4 rounded-xs text-sm font-medium cursor-pointer transition-colors focus:outline-hidden focus-visible:ring-2 focus-visible:ring-accent focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50",
- {
- variants: {
- variant: {
- primary: "bg-accent text-accent-text hover:bg-accent-hover",
- secondary:
- "border border-control-border bg-transparent text-control hover:bg-control-bg",
- },
- },
- defaultVariants: {
- variant: "primary",
- },
- }
-);
-
-type WelcomeButtonProps = Omit<ComponentProps<"button">, "children"> &
- VariantProps<typeof welcomeButtonVariants> & {
- readonly icon: ReactNode;
- readonly children: ReactNode;
- };
+type WelcomeButtonProps = Omit<ComponentProps<"button">, "children"> & {
+ readonly icon: ReactNode;
+ readonly children: ReactNode;
+};
export function WelcomeButton({
icon,
children,
- variant,
className,
ref,
...props
}: WelcomeButtonProps) {
return (
- <BaseButton
- ref={ref}
- className={cn(welcomeButtonVariants({ variant, className }))}
- {...props}
- >
- <span className="flex items-center justify-center">{icon}</span>
- <span>{children}</span>
- </BaseButton>
+ <QuickLinkButton ref={ref} className={className} {...props} icon={icon}>
+ {children}
+ </QuickLinkButton>
);
}
diff --git a/frontend/src/routes/workspace/LandingPage.navigation.test.ts b/frontend/src/routes/workspace/LandingPage.navigation.test.ts
index 8a8547f57c..b939eaf706 100644
--- a/frontend/src/routes/workspace/LandingPage.navigation.test.ts
+++ b/frontend/src/routes/workspace/LandingPage.navigation.test.ts
@@ -10,4 +10,13 @@ describe("LandingPage navigation", () => {
expect(source).not.toContain("ProjectSwitchDialog");
expect(source).not.toContain("setShowProjectSwitchDialog");
});
+
+ test("uses shared controls and semantic colors for quick-link interactions", () => {
+ expect(source).toContain(
+ 'import { QuickLinkButton, QuickLinkLink } from "@/components/ui/quick-link"'
+ );
+ expect(source).toContain("<QuickLinkButton");
+ expect(source).toContain("<QuickLinkLink");
+ expect(source).not.toContain("QUICK_LINK_TILE_CLASS");
+ });
});
diff --git a/frontend/src/routes/workspace/LandingPage.tsx b/frontend/src/routes/workspace/LandingPage.tsx
index 25b8332bd6..d387744e39 100644
--- a/frontend/src/routes/workspace/LandingPage.tsx
+++ b/frontend/src/routes/workspace/LandingPage.tsx
@@ -47,7 +47,9 @@ import {
WORKSPACE_ROUTE_WORKLOAD_IDENTITIES,
} from "@/app/router/handles";
import { RouterLink } from "@/components/RouterLink";
+import { Button } from "@/components/ui/button";
import { Checkbox } from "@/components/ui/checkbox";
+import { QuickLinkButton, QuickLinkLink } from "@/components/ui/quick-link";
import {
Sheet,
SheetBody,
@@ -55,6 +57,7 @@ import {
SheetHeader,
SheetTitle,
} from "@/components/ui/sheet";
+import { Tooltip } from "@/components/ui/tooltip";
import { useOptionalCurrentUser, useServerState } from "@/hooks/useAppState";
import { useRecentVisit } from "@/hooks/useRecentVisit";
import { useAppStore } from "@/stores/app";
@@ -387,7 +390,7 @@ function ConfigSheet({
onDragEnter={() => handleDragEnter(i)}
onDragEnd={handleDragEnd}
onDragOver={(e: DragEvent) => e.preventDefault()}
- className="flex items-center justify-between p-2 hover:bg-gray-100 rounded-sm cursor-grab"
+ className="flex items-center justify-between rounded-sm p-2 hover:bg-control-bg cursor-grab"
>
<div className="flex items-center gap-x-2">
<Checkbox
@@ -395,23 +398,25 @@ function ConfigSheet({
disabled={selected.length <= 1}
onCheckedChange={() => uncheck(item.id)}
/>
- <item.icon className="w-5 h-5 text-gray-500" />
+ <item.icon className="w-5 h-5 text-control-light" />
{item.title}
</div>
- <GripVertical className="w-5 h-5 text-gray-500" />
+ <GripVertical className="w-5 h-5 text-control-light" />
</div>
))}
- {unselected.length > 0 && <div className="border-t my-2" />}
+ {unselected.length > 0 && (
+ <div className="my-2 border-t border-control-border" />
+ )}
{unselected.map((item) => (
<div
key={item.id}
- className="flex items-center gap-x-2 p-2 hover:bg-gray-100 rounded-sm cursor-pointer"
+ className="flex items-center gap-x-2 rounded-sm p-2 hover:bg-control-bg cursor-pointer"
onClick={() => check(item.id)}
>
<Checkbox checked={false} />
- <item.icon className="w-5 h-5 text-gray-500" />
+ <item.icon className="w-5 h-5 text-control-light" />
{item.title}
</div>
))}
@@ -465,12 +470,19 @@ export function LandingPage(_: Record<string, never> = {}) {
<div className="font-semibold text-2xl">
{t("landing.quick-link.self")}
</div>
- <button
- className="p-1 rounded-xs hover:bg-gray-100"
- onClick={() => setShowConfigDrawer(true)}
- >
- <Settings className="w-4 h-4 text-gray-500" />
- </button>
+ <Tooltip content={t("landing.quick-link.manage")}>
+ <Button
+ appearance="secondary"
+ size="xs"
+ className="aspect-square px-0"
+ onClick={() => setShowConfigDrawer(true)}
+ >
+ <Settings className="w-4 h-4 text-control-light" />
+ <span className="sr-only">
+ {t("landing.quick-link.manage")}
+ </span>
+ </Button>
+ </Tooltip>
</div>
{lastProject && lastVisitProjectPath && (
<RouterLink
@@ -484,30 +496,26 @@ export function LandingPage(_: Record<string, never> = {}) {
<div className="grid grid-cols-2 md:grid-cols-3 lg:grid-cols-4 xl:grid-cols-5 gap-4">
{quickLinkList.map((link) => {
- const tileClass =
- "flex justify-center items-center gap-x-2 cursor-pointer border rounded-sm px-4 py-5 bg-white hover:bg-gray-100 no-underline text-main";
if (link.route) {
return (
- <RouterLink
+ <QuickLinkLink
key={link.id}
to={{ name: link.route }}
- className={tileClass}
+ icon={<link.icon className="w-5 h-5 text-control-light" />}
>
- <link.icon className="w-5 h-5 text-gray-500" />
{link.title}
- </RouterLink>
+ </QuickLinkLink>
);
}
return (
- <button
+ <QuickLinkButton
key={link.id}
type="button"
- className={tileClass}
onClick={() => handleClick(link)}
+ icon={<link.icon className="w-5 h-5 text-control-light" />}
>
- <link.icon className="w-5 h-5 text-gray-500" />
{link.title}
- </button>
+ </QuickLinkButton>
);
})}
</div>