Skip to content

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

refactor: extract unified sql editor button (#21199)

ecmadaod5fab09c4802
diff --git a/frontend/src/components/SQLEditorButton.test.tsx b/frontend/src/components/SQLEditorButton.test.tsx
new file mode 100644
index 0000000000..c3a2e3e9e8
--- /dev/null
+++ b/frontend/src/components/SQLEditorButton.test.tsx
@@ -0,0 +1,182 @@
+import { fireEvent, render, screen, waitFor } from "@testing-library/react";
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import {
+ SQL_EDITOR_DATABASE_MODULE,
+ SQL_EDITOR_HOME_MODULE,
+ SQL_EDITOR_PROJECT_MODULE,
+} from "@/app/router/handles";
+import type { Database } from "@/types/proto-es/v1/database_service_pb";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
+import {
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuItem,
+ DropdownMenuTrigger,
+} from "./ui/dropdown-menu";
+import { SQLEditorButton } from "./SQLEditorButton";
+
+const mocks = vi.hoisted(() => ({
+ push: vi.fn(),
+ resolve: vi.fn(() => ({
+ href: "/sql-editor/resolved",
+ fullPath: "/sql-editor/resolved",
+ })),
+ route: {
+ name: "workspace.project.database.detail",
+ params: {
+ projectId: "route-project",
+ instanceId: "route-instance",
+ databaseName: "route-database",
+ } as Record<string, string | undefined>,
+ },
+}));
+
+vi.mock("react-i18next", () => ({
+ initReactI18next: {
+ init: vi.fn(),
+ type: "3rdParty",
+ },
+ useTranslation: () => ({ t: (key: string) => key }),
+}));
+
+vi.mock("@/app/router", () => ({
+ router: {
+ push: mocks.push,
+ resolve: mocks.resolve,
+ },
+ useCurrentRoute: () => mocks.route,
+ SQL_EDITOR_DATABASE_MODULE: "sql-editor.database",
+ SQL_EDITOR_HOME_MODULE: "sql-editor.home",
+ SQL_EDITOR_PROJECT_MODULE: "sql-editor.project",
+}));
+
+const database = {
+ name: "projects/database-project/instances/prod/databases/customers",
+ project: "projects/database-project",
+} as Database;
+
+const project = {
+ name: "projects/explicit-project",
+} as Project;
+
+beforeEach(() => {
+ vi.clearAllMocks();
+ mocks.route = {
+ name: "workspace.project.database.detail",
+ params: {
+ projectId: "route-project",
+ instanceId: "route-instance",
+ databaseName: "route-database",
+ },
+ };
+});
+
+describe("SQLEditorButton", () => {
+ test("builds a database route when a database is provided", () => {
+ render(<SQLEditorButton database={database} project={project} />);
+
+ expect(mocks.resolve).toHaveBeenCalledWith({
+ name: SQL_EDITOR_DATABASE_MODULE,
+ params: {
+ project: "database-project",
+ instance: "prod",
+ database: "customers",
+ },
+ });
+ expect(
+ screen.getByRole("link", { name: "sql-editor.self" })
+ ).toHaveAttribute("href", "/sql-editor/resolved");
+ });
+
+ test("builds a project route when only a project is provided", () => {
+ render(<SQLEditorButton project={project} />);
+
+ expect(mocks.resolve).toHaveBeenCalledWith({
+ name: SQL_EDITOR_PROJECT_MODULE,
+ params: { project: "explicit-project" },
+ });
+ });
+
+ test("derives a contextual route and falls back to SQL Editor home", () => {
+ const view = render(<SQLEditorButton />);
+
+ expect(mocks.resolve).toHaveBeenLastCalledWith({
+ name: SQL_EDITOR_DATABASE_MODULE,
+ params: {
+ project: "route-project",
+ instance: "route-instance",
+ database: "route-database",
+ },
+ });
+
+ mocks.route = {
+ name: "workspace.settings",
+ params: {},
+ };
+ view.rerender(<SQLEditorButton />);
+
+ expect(mocks.resolve).toHaveBeenLastCalledWith({
+ name: SQL_EDITOR_HOME_MODULE,
+ });
+ });
+
+ test("supports new-tab, custom-label, and disabled button behavior", () => {
+ const view = render(
+ <SQLEditorButton
+ database={database}
+ label="Query"
+ openInNewTab
+ />
+ );
+
+ const link = screen.getByRole("link", { name: "Query" });
+ expect(link).toHaveAttribute("target", "_blank");
+ expect(link).toHaveAttribute("rel", "noopener noreferrer");
+
+ view.rerender(
+ <SQLEditorButton
+ database={database}
+ label="Query"
+ disabled
+ />
+ );
+ fireEvent.click(screen.getByRole("link", { name: "Query" }));
+
+ expect(mocks.push).not.toHaveBeenCalled();
+ expect(screen.getByRole("link", { name: "Query" })).toHaveAttribute(
+ "aria-disabled",
+ "true"
+ );
+ });
+
+ test("composes as a dropdown item and closes the menu on selection", async () => {
+ render(
+ <DropdownMenu>
+ <DropdownMenuTrigger>Open</DropdownMenuTrigger>
+ <DropdownMenuContent>
+ <DropdownMenuItem
+ render={
+ <SQLEditorButton
+ project={project}
+ label="Open SQL Editor"
+ openInNewTab
+ />
+ }
+ />
+ </DropdownMenuContent>
+ </DropdownMenu>
+ );
+
+ fireEvent.click(screen.getByRole("button", { name: "Open" }));
+ const item = await screen.findByRole("menuitem", {
+ name: "Open SQL Editor",
+ });
+ fireEvent.click(item);
+
+ await waitFor(() => {
+ expect(
+ screen.queryByRole("menuitem", { name: "Open SQL Editor" })
+ ).not.toBeInTheDocument();
+ });
+ });
+});
diff --git a/frontend/src/components/SQLEditorButton.tsx b/frontend/src/components/SQLEditorButton.tsx
new file mode 100644
index 0000000000..c48a185e49
--- /dev/null
+++ b/frontend/src/components/SQLEditorButton.tsx
@@ -0,0 +1,123 @@
+import { SquareTerminal } from "lucide-react";
+import { type ReactNode, useMemo } from "react";
+import { useTranslation } from "react-i18next";
+import {
+ SQL_EDITOR_DATABASE_MODULE,
+ SQL_EDITOR_HOME_MODULE,
+ SQL_EDITOR_PROJECT_MODULE,
+ useCurrentRoute,
+} from "@/app/router";
+import { RouterLink, type RouterLinkProps } from "@/components/RouterLink";
+import { type ButtonProps, buttonVariants } from "@/components/ui/button";
+import { cn } from "@/lib/utils";
+import type { Database } from "@/types/proto-es/v1/database_service_pb";
+import type { Project } from "@/types/proto-es/v1/project_service_pb";
+import { autoSQLEditorDatabaseRoute } from "@/utils/auto-route";
+import { extractProjectResourceName } from "@/utils/v1/project";
+
+export type SQLEditorButtonProps = Omit<
+ RouterLinkProps,
+ "children" | "className" | "onClick" | "rel" | "target" | "to"
+> &
+ Pick<ButtonProps, "appearance" | "size" | "variant" | "className"> & {
+ database?: Pick<Database, "name" | "project">;
+ project?: Pick<Project, "name">;
+ label?: ReactNode;
+ openInNewTab?: boolean;
+ disabled?: boolean;
+ };
+
+export function SQLEditorButton({
+ database,
+ project,
+ label,
+ openInNewTab = false,
+ disabled = false,
+ appearance,
+ size,
+ variant,
+ className,
+ tabIndex,
+ "aria-label": ariaLabel,
+ ...props
+}: SQLEditorButtonProps) {
+ const { t } = useTranslation();
+ const route = useCurrentRoute();
+ const defaultLabel = t("sql-editor.self");
+ const accessibleLabel =
+ ariaLabel ?? (typeof label === "string" ? label : defaultLabel);
+ const to = useMemo(() => {
+ if (database) {
+ return autoSQLEditorDatabaseRoute(database);
+ }
+ if (project) {
+ return {
+ name: SQL_EDITOR_PROJECT_MODULE,
+ params: {
+ project: extractProjectResourceName(project.name),
+ },
+ };
+ }
+
+ const projectId = getRouteParam(
+ route.params.projectId ?? route.params.project
+ );
+ const instanceId = getRouteParam(
+ route.params.instanceId ?? route.params.instance
+ );
+ const databaseName = getRouteParam(
+ route.params.databaseName ?? route.params.database
+ );
+ if (projectId && instanceId && databaseName) {
+ return {
+ name: SQL_EDITOR_DATABASE_MODULE,
+ params: {
+ project: projectId,
+ instance: instanceId,
+ database: databaseName,
+ },
+ };
+ }
+ if (projectId) {
+ return {
+ name: SQL_EDITOR_PROJECT_MODULE,
+ params: {
+ project: projectId,
+ },
+ };
+ }
+ return { name: SQL_EDITOR_HOME_MODULE };
+ }, [database, project, route.params]);
+
+ return (
+ <RouterLink
+ {...props}
+ to={to}
+ target={openInNewTab ? "_blank" : undefined}
+ rel={openInNewTab ? "noopener noreferrer" : undefined}
+ aria-label={accessibleLabel}
+ aria-disabled={disabled || undefined}
+ tabIndex={disabled ? -1 : tabIndex}
+ className={buttonVariants({
+ appearance,
+ size,
+ variant,
+ className: cn(className, disabled && "cursor-not-allowed opacity-50"),
+ })}
+ onClickCapture={
+ disabled
+ ? (event) => {
+ event.preventDefault();
+ }
+ : undefined
+ }
+ >
+ <SquareTerminal className="size-4" />
+ {label === undefined ? defaultLabel : label}
+ </RouterLink>
+ );
+}
+
+function getRouteParam(value: string | string[] | undefined) {
+ return typeof value === "string" ? value : undefined;
+}
diff --git a/frontend/src/components/WorkspaceSetupGuide.test.tsx b/frontend/src/components/WorkspaceSetupGuide.test.tsx
index 9d5571fe92..339ea78b57 100644
--- a/frontend/src/components/WorkspaceSetupGuide.test.tsx
+++ b/frontend/src/components/WorkspaceSetupGuide.test.tsx
@@ -86,6 +86,9 @@ vi.mock("@/app/router", () => ({
push: mocks.routerPush,
},
useCurrentRoute: () => mocks.currentRoute,
+ SQL_EDITOR_DATABASE_MODULE: "sql-editor.database",
+ SQL_EDITOR_HOME_MODULE: "sql-editor.home",
+ SQL_EDITOR_PROJECT_MODULE: "sql-editor.project",
}));
vi.mock("@/app/analytics/provider", () => ({
@@ -839,6 +842,7 @@ describe("WorkspaceSetupGuide", () => {
expect(actionLink?.textContent).toContain(
"workspace-setup-guide.actions.query"
);
+ expect(actionLink?.querySelector(".lucide-square-terminal")).not.toBeNull();
const secondaryAction = container.querySelector(
"[data-testid='secondary-action']"
diff --git a/frontend/src/components/WorkspaceSetupGuide.tsx b/frontend/src/components/WorkspaceSetupGuide.tsx
index 7e5ab1fd11..055d760187 100644
--- a/frontend/src/components/WorkspaceSetupGuide.tsx
+++ b/frontend/src/components/WorkspaceSetupGuide.tsx
@@ -13,8 +13,8 @@ import {
PROJECT_V1_ROUTE_DATABASES,
SQL_EDITOR_DATABASE_MODULE,
} from "@/app/router/handles";
-import { RouterLink } from "@/components/RouterLink";
-import { Button, buttonVariants } from "@/components/ui/button";
+import { SQLEditorButton } from "@/components/SQLEditorButton";
+import { Button } from "@/components/ui/button";
import { Tooltip } from "@/components/ui/tooltip";
import { useIntroStateByKey } from "@/hooks/useAppState";
import { preCreateIssue } from "@/lib/plan/issue";
@@ -30,11 +30,7 @@ import {
import { cn } from "@/lib/utils";
import { useAppStore } from "@/stores/app";
import { SearchQueryHistoriesRequestSchema } from "@/types/proto-es/v1/query_history_service_pb";
-import {
- autoSQLEditorDatabaseRoute,
- extractProjectResourceName,
- hasWorkspacePermissionV2,
-} from "@/utils";
+import { extractProjectResourceName, hasWorkspacePermissionV2 } from "@/utils";
type SetupKeys = {
hasProject: boolean;
@@ -225,14 +221,14 @@ export function WorkspaceSetupGuide() {
currentRoute.name,
]);
- const databaseRoute = useMemo(() => {
+ const sqlEditorDatabase = useMemo(() => {
if (!setupState.databaseName || !setupState.projectName) {
return undefined;
}
- return autoSQLEditorDatabaseRoute({
+ return {
name: setupState.databaseName,
project: setupState.projectName,
- });
+ };
}, [setupState.databaseName, setupState.projectName]);
const steps = useMemo<SetupStep[]>(
@@ -412,14 +408,13 @@ export function WorkspaceSetupGuide() {
{t("workspace-setup-guide.actions.change")}
</Button>
)}
- {actionStep.key === "hasFirstQuery" && databaseRoute && (
- <RouterLink
+ {actionStep.key === "hasFirstQuery" && sqlEditorDatabase && (
+ <SQLEditorButton
data-testid="active-action"
- to={databaseRoute}
- className={buttonVariants({ size: "sm" })}
- >
- {t("workspace-setup-guide.actions.query")}
- </RouterLink>
+ database={sqlEditorDatabase}
+ size="sm"
+ label={t("workspace-setup-guide.actions.query")}
+ />
)}
<Button
type="button"
diff --git a/frontend/src/components/header/DashboardHeader.test.tsx b/frontend/src/components/header/DashboardHeader.test.tsx
index f317c54f06..a2e8c7ef61 100644
--- a/frontend/src/components/header/DashboardHeader.test.tsx
+++ b/frontend/src/components/header/DashboardHeader.test.tsx
@@ -34,6 +34,10 @@ const mocks = vi.hoisted(() => ({
}));
vi.mock("react-i18next", () => ({
+ initReactI18next: {
+ init: vi.fn(),
+ type: "3rdParty",
+ },
useTranslation: () => ({
t: (key: string) =>
({
@@ -71,6 +75,10 @@ vi.mock("@/components/header/ProfileMenuTrigger", () => ({
}));
vi.mock("@/app/router", () => ({
+ router: {
+ resolve: mocks.resolve,
+ push: mocks.push,
+ },
useCurrentRoute: () => mocks.currentRoute,
useNavigate: () => ({
resolve: mocks.resolve,
@@ -187,18 +195,19 @@ describe("DashboardHeader", () => {
render();
- const sqlEditorButton = Array.from(
- container.querySelectorAll("button")
- ).find((button) => button.textContent?.includes("SQL Editor"));
- expect(sqlEditorButton).not.toBeUndefined();
- act(() => {
- sqlEditorButton?.click();
- });
- expect(window.open).toHaveBeenCalledWith(
- `/${SQL_EDITOR_DATABASE_MODULE}`,
- "_blank",
- "noopener,noreferrer"
+ const sqlEditorLink = container.querySelector(
+ 'a[aria-label="SQL Editor"]'
);
+ expect(sqlEditorLink?.getAttribute("target")).toBe("_blank");
+ expect(sqlEditorLink?.getAttribute("rel")).toBe("noopener noreferrer");
+ expect(mocks.resolve).toHaveBeenCalledWith({
+ name: SQL_EDITOR_DATABASE_MODULE,
+ params: {
+ project: "sample-project",
+ instance: "prod",
+ database: "db",
+ },
+ });
const myIssuesButton = Array.from(
container.querySelectorAll("button")
diff --git a/frontend/src/components/header/DashboardHeader.tsx b/frontend/src/components/header/DashboardHeader.tsx
index ab2d260d7d..353af8e77f 100644
--- a/frontend/src/components/header/DashboardHeader.tsx
+++ b/frontend/src/components/header/DashboardHeader.tsx
@@ -1,23 +1,14 @@
-import {
- Bot,
- CircleDot,
- Menu,
- MessagesSquare,
- SquareTerminal,
-} from "lucide-react";
+import { Bot, CircleDot, Menu, MessagesSquare } from "lucide-react";
import { useMemo, useSyncExternalStore } from "react";
import { useTranslation } from "react-i18next";
import { v4 as uuidv4 } from "uuid";
import {
- SQL_EDITOR_DATABASE_MODULE,
- SQL_EDITOR_HOME_MODULE,
- SQL_EDITOR_PROJECT_MODULE,
- useCurrentRoute,
useNavigate,
WORKSPACE_ROUTE_LANDING,
WORKSPACE_ROUTE_MY_ISSUES,
} from "@/app/router";
import { BytebaseLogo } from "@/components/BytebaseLogo";
+import { SQLEditorButton } from "@/components/SQLEditorButton";
import { Button } from "@/components/ui/button";
import { useRecentVisit, useSubscription } from "@/hooks/useAppState";
import { cn } from "@/lib/utils";
@@ -49,7 +40,6 @@ export function DashboardHeader({
const { t } = useTranslation();
const { record } = useRecentVisit();
const { subscription } = useSubscription();
- const route = useCurrentRoute();
const navigate = useNavigate();
const currentPlan = subscription?.plan ?? PlanType.FREE;
const windowWidth = useSyncExternalStore(
@@ -60,40 +50,6 @@ export function DashboardHeader({
const isDesktopLabelVisible = windowWidth >= 640;
const isLargeLabelVisible = windowWidth >= 1024;
- const sqlEditorHref = useMemo(() => {
- const projectId = route.params.projectId as string | undefined;
- const instanceId = route.params.instanceId as string | undefined;
- const databaseName = route.params.databaseName as string | undefined;
-
- if (projectId) {
- if (instanceId && databaseName) {
- return navigate.resolve({
- name: SQL_EDITOR_DATABASE_MODULE,
- params: {
- project: projectId,
- instance: instanceId,
- database: databaseName,
- },
- }).href;
- }
- return navigate.resolve({
- name: SQL_EDITOR_PROJECT_MODULE,
- params: {
- project: projectId,
- },
- }).href;
- }
-
- return navigate.resolve({
- name: SQL_EDITOR_HOME_MODULE,
- }).href;
- }, [
- navigate,
- route.params.databaseName,
- route.params.instanceId,
- route.params.projectId,
- ]);
-
const myIssueHref = useMemo(
() =>
navigate.resolve({
@@ -164,20 +120,18 @@ export function DashboardHeader({
</Button>
) : null}
- <Button
+ <SQLEditorButton
size="sm"
appearance="outline"
aria-label={t("sql-editor.self")}
title={t("sql-editor.self")}
- onClick={() => {
- window.open(sqlEditorHref, "_blank", "noopener,noreferrer");
- }}
- >
- <SquareTerminal className="h-4 w-4" />
- {isLargeLabelVisible ? (
- <span className="whitespace-nowrap">{t("sql-editor.self")}</span>
- ) : null}
- </Button>
+ openInNewTab
+ label={
+ isLargeLabelVisible ? (
+ <span className="whitespace-nowrap">{t("sql-editor.self")}</span>
+ ) : null
+ }
+ />
<Button
size="sm"
diff --git a/frontend/src/components/header/ProfileMenuTrigger.test.tsx b/frontend/src/components/header/ProfileMenuTrigger.test.tsx
index 92a25d6961..64d1fa7311 100644
--- a/frontend/src/components/header/ProfileMenuTrigger.test.tsx
+++ b/frontend/src/components/header/ProfileMenuTrigger.test.tsx
@@ -14,7 +14,10 @@ const mocks = vi.hoisted(() => ({
uploadLicense: vi.fn(),
emitStorageChangedEvent: vi.fn(),
push: vi.fn(),
- resolve: vi.fn(({ name }: { name: string }) => ({ fullPath: `/${name}` })),
+ resolve: vi.fn(({ name }: { name: string }) => ({
+ fullPath: `/${name}`,
+ href: `/${name}`,
+ })),
currentRoute: {
name: "sql-editor.home",
fullPath: "/sql-editor",
@@ -27,6 +30,10 @@ const mocks = vi.hoisted(() => ({
}));
vi.mock("react-i18next", () => ({
+ initReactI18next: {
+ init: vi.fn(),
+ type: "3rdParty",
+ },
useTranslation: () => ({
i18n: {
language: "en-US",
@@ -73,10 +80,12 @@ vi.mock("@/components/ui/dropdown-menu", () => ({
DropdownMenuItem: ({
children,
onClick,
+ render,
}: {
- children: ReactElement | string;
+ children?: ReactElement | string;
onClick?: () => void;
- }) => <button onClick={onClick}>{children}</button>,
+ render?: ReactElement;
+ }) => render ?? <button onClick={onClick}>{children}</button>,
DropdownMenuSeparator: () => <div />,
DropdownMenuSubmenu: ({ children }: { children: ReactElement[] }) => (
<div>{children}</div>
@@ -101,6 +110,10 @@ vi.mock("./common", () => ({
}));
vi.mock("@/app/router", () => ({
+ router: {
+ push: mocks.push,
+ resolve: mocks.resolve,
+ },
useCurrentRoute: () => mocks.currentRoute,
useNavigate: () => ({
push: mocks.push,
@@ -110,7 +123,9 @@ vi.mock("@/app/router", () => ({
AUTH_SIGNIN_MODULE: "auth.signin",
WORKSPACE_ROUTE_LANDING: "workspace.landing",
ACCOUNT_ROUTE: "account",
+ SQL_EDITOR_DATABASE_MODULE: "sql-editor.database",
SQL_EDITOR_HOME_MODULE: "sql-editor.home",
+ SQL_EDITOR_PROJECT_MODULE: "sql-editor.project",
}));
vi.mock("@/hooks/useAppState", () => ({
@@ -170,6 +185,7 @@ beforeEach(async () => {
vi.clearAllMocks();
mocks.hideQuickStart = false;
mocks.isDev = false;
+ mocks.currentRoute.name = "sql-editor.home";
window.open = vi.fn();
({ ProfileMenuTrigger } = await import("./ProfileMenuTrigger"));
});
@@ -229,6 +245,23 @@ describe("ProfileMenuTrigger", () => {
unmount();
});
+ test("renders the shared SQL Editor link outside SQL Editor", () => {
+ mocks.currentRoute.name = "workspace.landing";
+ const { container, render, unmount } = renderIntoContainer(
+ <ProfileMenuTrigger size="medium" link />
+ );
+
+ render();
+
+ const sqlEditorLink = Array.from(container.querySelectorAll("a")).find(
+ (link) => link.textContent?.includes("Go to SQL Editor")
+ );
+ expect(sqlEditorLink).not.toBeUndefined();
+ expect(sqlEditorLink).toHaveAttribute("target", "_blank");
+
+ unmount();
+ });
+
test("hides quick start when the app feature disables it", () => {
mocks.hideQuickStart = true;
const { container, render, unmount } = renderIntoContainer(
diff --git a/frontend/src/components/header/ProfileMenuTrigger.tsx b/frontend/src/components/header/ProfileMenuTrigger.tsx
index 296a961ac2..c1b637b6bd 100644
--- a/frontend/src/components/header/ProfileMenuTrigger.tsx
+++ b/frontend/src/components/header/ProfileMenuTrigger.tsx
@@ -4,11 +4,11 @@ import { useTranslation } from "react-i18next";
import {
ACCOUNT_ROUTE,
isSqlEditorRouteName,
- SQL_EDITOR_HOME_MODULE,
useCurrentRoute,
useNavigate,
WORKSPACE_ROUTE_LANDING,
} from "@/app/router";
+import { SQLEditorButton } from "@/components/SQLEditorButton";
import { UserAvatar } from "@/components/UserAvatar";
import {
DropdownMenu,
@@ -89,7 +89,8 @@ export function ProfileMenuTrigger({
const logoClass = size === "small" ? "mr-2" : "mr-4";
- const sqlEditorMenuLabel = isSqlEditorRouteName(route.name)
+ const isInSQLEditor = isSqlEditorRouteName(route.name);
+ const sqlEditorMenuLabel = isInSQLEditor
? t("settings.general.workspace.default-landing-page.go-to-workspace")
: t("settings.general.workspace.default-landing-page.go-to-sql-editor");
@@ -101,9 +102,7 @@ export function ProfileMenuTrigger({
const handleWorkspaceToggle = () => {
const target = navigate.resolve({
- name: isSqlEditorRouteName(route.name)
- ? WORKSPACE_ROUTE_LANDING
- : SQL_EDITOR_HOME_MODULE,
+ name: WORKSPACE_ROUTE_LANDING,
});
setOpen(false);
window.open(target.fullPath, "_blank", "noopener,noreferrer");
@@ -238,9 +237,23 @@ export function ProfileMenuTrigger({
</DropdownMenuItem>
) : null}
- <DropdownMenuItem onClick={handleWorkspaceToggle}>
- {sqlEditorMenuLabel}
- </DropdownMenuItem>
+ {isInSQLEditor ? (
+ <DropdownMenuItem onClick={handleWorkspaceToggle}>
+ {sqlEditorMenuLabel}
+ </DropdownMenuItem>
+ ) : (
+ <DropdownMenuItem
+ render={
+ <SQLEditorButton
+ openInNewTab
+ appearance="secondary"
+ size="sm"
+ className="w-full justify-start"
+ label={sqlEditorMenuLabel}
+ />
+ }
+ />
+ )}
<DropdownMenuSeparator className="mx-0" />
diff --git a/frontend/src/routes/project/ProjectDatabaseDetailPage.tsx b/frontend/src/routes/project/ProjectDatabaseDetailPage.tsx
index 312d9e2001..7393aa7c2e 100644
--- a/frontend/src/routes/project/ProjectDatabaseDetailPage.tsx
+++ b/frontend/src/routes/project/ProjectDatabaseDetailPage.tsx
@@ -8,7 +8,6 @@ import { ComponentPermissionGuard } from "@/components/ComponentPermissionGuard"
import { TransferProjectSheet } from "@/components/database";
import { Alert } from "@/components/ui/alert";
import { Button } from "@/components/ui/button";
-import { Dialog, DialogContent, DialogTitle } from "@/components/ui/dialog";
import { Tabs, TabsList, TabsTrigger } from "@/components/ui/tabs";
import { pushNotification } from "@/stores";
import { useAppStore } from "@/stores/app";
@@ -67,8 +66,6 @@ export function ProjectDatabaseDetailPage({
parseProjectDatabaseDetailTabHash(hash)
);
const [showTransferDrawer, setShowTransferDrawer] = useState(false);
- const [showIncorrectProjectModal, setShowIncorrectProjectModal] =
- useState(false);
const handleTabChange = useCallback(
(tab: string | number | null) => {
@@ -99,10 +96,6 @@ export function ProjectDatabaseDetailPage({
handleTabChange(PROJECT_DATABASE_DETAIL_TAB_SETTING);
}, [handleTabChange]);
- const handleSQLEditorFailed = useCallback(() => {
- setShowIncorrectProjectModal(true);
- }, []);
-
const handleTransferProject = useCallback(
async (projectName: string) => {
try {
@@ -176,10 +169,7 @@ export function ProjectDatabaseDetailPage({
)}
<div className="flex flex-col items-start gap-y-2 xl:flex-row xl:items-center xl:justify-between xl:gap-x-2">
- <DatabaseDetailHeader
- database={detail.database}
- onSQLEditorFailed={handleSQLEditorFailed}
- />
+ <DatabaseDetailHeader database={detail.database} />
<DatabaseDetailActions
database={detail.database}
isDefaultProject={detail.isDefaultProject}
@@ -238,36 +228,6 @@ export function ProjectDatabaseDetailPage({
</ComponentPermissionGuard>
)}
- <Dialog
- open={showIncorrectProjectModal}
- onOpenChange={setShowIncorrectProjectModal}
- >
- <DialogContent className="p-6">
- <DialogTitle>{t("common.warning")}</DialogTitle>
- <p className="mt-3 text-sm text-control-light">
- {t("common.missing-required-permission", {
- permissions: "bb.sql.select",
- })}
- </p>
- <div className="mt-6 flex justify-end gap-x-2">
- <Button
- appearance="outline"
- onClick={() => setShowIncorrectProjectModal(false)}
- >
- {t("common.cancel")}
- </Button>
- <Button
- onClick={() => {
- setShowIncorrectProjectModal(false);
- setShowTransferDrawer(true);
- }}
- >
- {t("database.transfer-project")}
- </Button>
- </div>
- </DialogContent>
- </Dialog>
-
<TransferProjectSheet
open={showTransferDrawer}
databases={[detail.database]}
diff --git a/frontend/src/routes/project/ProjectDatabasesPage.test.tsx b/frontend/src/routes/project/ProjectDatabasesPage.test.tsx
index b6a6d4d887..7476ee4124 100644
--- a/frontend/src/routes/project/ProjectDatabasesPage.test.tsx
+++ b/frontend/src/routes/project/ProjectDatabasesPage.test.tsx
@@ -68,6 +68,9 @@ vi.mock("@/app/router", () => ({
name: mocks.routerCurrentName,
query: mocks.routerCurrentQuery,
}),
+ SQL_EDITOR_DATABASE_MODULE: "sql-editor.database",
+ SQL_EDITOR_HOME_MODULE: "sql-editor.home",
+ SQL_EDITOR_PROJECT_MODULE: "sql-editor.project",
}));
vi.mock("@/app/analytics/provider", () => ({
@@ -569,13 +572,12 @@ describe("ProjectDatabasesPage", () => {
"projects/demo/instances/prod/databases/app",
]);
- const sqlEditorButton = Array.from(
- container.querySelectorAll("button")
- ).find((button) =>
- button.textContent?.includes(
+ const sqlEditorButton = Array.from(container.querySelectorAll("a")).find(
+ (link) =>
+ link.textContent?.includes(
"db.project-instance-synced-sql-editor-action"
)
- ) as HTMLButtonElement;
+ ) as HTMLAnchorElement;
expect(sqlEditorButton.className).toContain("bg-accent");
expect(nextActionButton.className).toContain("border-control-border");
expect(
diff --git a/frontend/src/routes/project/ProjectDatabasesPage.tsx b/frontend/src/routes/project/ProjectDatabasesPage.tsx
index 2a5bc6c8d0..58b9661850 100644
--- a/frontend/src/routes/project/ProjectDatabasesPage.tsx
+++ b/frontend/src/routes/project/ProjectDatabasesPage.tsx
@@ -1,6 +1,6 @@
import { create } from "@bufbuild/protobuf";
import { FieldMaskSchema } from "@bufbuild/protobuf/wkt";
-import { Plus, SquareTerminal } from "lucide-react";
+import { Plus } from "lucide-react";
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import { Trans, useTranslation } from "react-i18next";
import { createBehaviorMetric } from "@/app/analytics/behavior";
@@ -32,6 +32,7 @@ import {
ProjectPageLayout,
ProjectPageToolbar,
} from "@/components/ProjectPageLayout";
+import { SQLEditorButton } from "@/components/SQLEditorButton";
import { Alert } from "@/components/ui/alert";
import {
AlertDialog,
@@ -71,7 +72,6 @@ import {
} from "@/types/proto-es/v1/database_service_pb";
import { unknownDatabase } from "@/types/v1/database";
import {
- autoSQLEditorDatabaseRoute,
engineNameV1,
extractInstanceResourceName,
getDefaultPagination,
@@ -530,16 +530,13 @@ export function ProjectDatabasesPage({ projectId }: { projectId: string }) {
}, [projectName, visibleDatabases]);
const handleOpenFirstDatabaseInSQLEditor = useCallback(() => {
- const firstDatabase = visibleDatabases[0];
- if (!firstDatabase) return;
behaviorAnalytics.captureMetric(
createBehaviorMetric("post sync sql editor clicked", {
routeId: router.currentRoute.value.name?.toString(),
resource: projectName,
})
);
- router.push(autoSQLEditorDatabaseRoute(firstDatabase));
- }, [projectName, visibleDatabases]);
+ }, [projectName]);
useProductIntro({
id: CONNECT_DATABASE_PRODUCT_INTRO,
@@ -675,13 +672,16 @@ export function ProjectDatabasesPage({ projectId }: { projectId: string }) {
permissions={["bb.sql.select"]}
project={project}
>
- <Button
- size="sm"
- onClick={handleOpenFirstDatabaseInSQLEditor}
+ <span
+ className="inline-flex"
+ onClickCapture={handleOpenFirstDatabaseInSQLEditor}
>
- <SquareTerminal className="size-4" />
- {t("db.project-instance-synced-sql-editor-action")}
- </Button>
+ <SQLEditorButton
+ size="sm"
+ database={visibleDatabases[0]}
+ label={t("db.project-instance-synced-sql-editor-action")}
+ />
+ </span>
</PermissionGuard>
<PermissionGuard
permissions={PERMISSIONS_FOR_DATABASE_CREATE_ISSUE}
diff --git a/frontend/src/routes/project/database-detail/DatabaseDetailHeader.tsx b/frontend/src/routes/project/database-detail/DatabaseDetailHeader.tsx
index c39321361f..72d79d3bdc 100644
--- a/frontend/src/routes/project/database-detail/DatabaseDetailHeader.tsx
+++ b/frontend/src/routes/project/database-detail/DatabaseDetailHeader.tsx
@@ -31,13 +31,7 @@ const extractDatabaseParts = (resource: string) => {
};
};
-export function DatabaseDetailHeader({
- database,
- onSQLEditorFailed,
-}: {
- database: Database;
- onSQLEditorFailed?: (database: Database) => void;
-}) {
+export function DatabaseDetailHeader({ database }: { database: Database }) {
const { t } = useTranslation();
const [copied, setCopied] = useState(false);
const { databaseName } = useMemo(
@@ -158,10 +152,7 @@ export function DatabaseDetailHeader({
<span>{extractReleaseUID(database.release)}</span>
</div>
)}
- <DatabaseSQLEditorButton
- database={database}
- onFailed={onSQLEditorFailed}
- />
+ <DatabaseSQLEditorButton database={database} />
</div>
</div>
);
diff --git a/frontend/src/routes/project/database-detail/DatabaseExportSchemaButton.test.tsx b/frontend/src/routes/project/database-detail/DatabaseExportSchemaButton.test.tsx
new file mode 100644
index 0000000000..6c1a5992f0
--- /dev/null
+++ b/frontend/src/routes/project/database-detail/DatabaseExportSchemaButton.test.tsx
@@ -0,0 +1,32 @@
+import { render, screen } from "@testing-library/react";
+import { describe, expect, test, vi } from "vitest";
+import type { Database } from "@/types/proto-es/v1/database_service_pb";
+import { DatabaseExportSchemaButton } from "./DatabaseExportSchemaButton";
+
+vi.mock("react-i18next", () => ({
+ initReactI18next: {
+ init: vi.fn(),
+ type: "3rdParty",
+ },
+ useTranslation: () => ({ t: (key: string) => key }),
+}));
+
+describe("DatabaseExportSchemaButton", () => {
+ test("uses the standard database action button height", () => {
+ render(
+ <DatabaseExportSchemaButton
+ database={
+ {
+ name: "projects/demo/instances/prod/databases/customers",
+ } as Database
+ }
+ />
+ );
+
+ const trigger = screen.getByRole("button", {
+ name: /database.export-schema$/,
+ });
+ expect(trigger).toHaveClass("h-9");
+ expect(trigger).not.toHaveClass("h-8");
+ });
+});
diff --git a/frontend/src/routes/project/database-detail/DatabaseExportSchemaButton.tsx b/frontend/src/routes/project/database-detail/DatabaseExportSchemaButton.tsx
index a33c2c63db..9f7b381c5e 100644
--- a/frontend/src/routes/project/database-detail/DatabaseExportSchemaButton.tsx
+++ b/frontend/src/routes/project/database-detail/DatabaseExportSchemaButton.tsx
@@ -4,6 +4,7 @@ import { ChevronDown, Download } from "lucide-react";
import { useCallback, useMemo, useState } from "react";
import { useTranslation } from "react-i18next";
import { databaseServiceClientConnect } from "@/api";
+import { Button } from "@/components/ui/button";
import {
DropdownMenu,
DropdownMenuContent,
@@ -106,7 +107,7 @@ export function DatabaseExportSchemaButton({
return (
<DropdownMenu open={open} onOpenChange={setOpen}>
<DropdownMenuTrigger
- className="inline-flex h-8 items-center justify-center gap-x-2 whitespace-nowrap rounded-sm border border-control-border bg-background px-3 text-sm font-medium text-control shadow-xs hover:bg-control-bg cursor-pointer outline-hidden focus-visible:ring-2 focus-visible:ring-accent disabled:cursor-not-allowed disabled:opacity-50"
+ render={<Button appearance="outline" />}
disabled={disabled || exporting}
>
<Download className="size-4" />
diff --git a/frontend/src/routes/project/database-detail/DatabaseSQLEditorButton.test.tsx b/frontend/src/routes/project/database-detail/DatabaseSQLEditorButton.test.tsx
new file mode 100644
index 0000000000..acd3183ef8
--- /dev/null
+++ b/frontend/src/routes/project/database-detail/DatabaseSQLEditorButton.test.tsx
@@ -0,0 +1,99 @@
+import { fireEvent, render, screen } from "@testing-library/react";
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import type { Database } from "@/types/proto-es/v1/database_service_pb";
+import { DatabaseSQLEditorButton } from "./DatabaseSQLEditorButton";
+
+const mocks = vi.hoisted(() => ({
+ hasProjectPermission: vi.fn(() => false),
+ hasWorkspacePermission: vi.fn(() => false),
+ push: vi.fn(),
+ resolve: vi.fn(() => ({
+ href: "/sql-editor/projects/proj/instances/prod/databases/customers",
+ fullPath: "/sql-editor/projects/proj/instances/prod/databases/customers",
+ })),
+ routeName: "workspace.project.database.detail",
+}));
+
+vi.mock("react-i18next", () => ({
+ initReactI18next: {
+ init: vi.fn(),
+ type: "3rdParty",
+ },
+ useTranslation: () => ({ t: (key: string) => key }),
+}));
+
+vi.mock("@/app/router", () => ({
+ router: {
+ push: mocks.push,
+ resolve: mocks.resolve,
+ currentRoute: {
+ get value() {
+ return { name: mocks.routeName };
+ },
+ },
+ },
+ useCurrentRoute: () => ({ name: mocks.routeName, params: {} }),
+ SQL_EDITOR_DATABASE_MODULE: "sql-editor.database",
+ SQL_EDITOR_HOME_MODULE: "sql-editor.home",
+ SQL_EDITOR_PROJECT_MODULE: "sql-editor.project",
+}));
+
+vi.mock("@/stores/app", () => ({
+ useAppStore: (selector: (state: Record<string, unknown>) => unknown) =>
+ selector({
+ currentUser: undefined,
+ hasProjectPermission: mocks.hasProjectPermission,
+ hasWorkspacePermission: mocks.hasWorkspacePermission,
+ projectPoliciesByName: {},
+ roles: [],
+ workspacePolicy: undefined,
+ }),
+}));
+
+vi.mock("@/hooks/useProjectByName", () => ({
+ useProjectByName: (name: string) => ({ name }),
+}));
+
+const database = {
+ name: "projects/proj/instances/prod/databases/customers",
+ project: "projects/proj",
+} as Database;
+
+beforeEach(() => {
+ vi.clearAllMocks();
+ mocks.hasProjectPermission.mockReturnValue(false);
+ mocks.routeName = "workspace.project.database.detail";
+});
+
+describe("DatabaseSQLEditorButton", () => {
+ test("renders the shared database link in a new tab outside SQL Editor", () => {
+ mocks.hasProjectPermission.mockReturnValue(true);
+ render(<DatabaseSQLEditorButton database={database} />);
+
+ const link = screen.getByRole("link", { name: "sql-editor.self" });
+ expect(link).toHaveAttribute("target", "_blank");
+ expect(link).toHaveAttribute("rel", "noopener noreferrer");
+ expect(mocks.resolve).toHaveBeenCalledWith({
+ name: "sql-editor.database",
+ params: {
+ project: "proj",
+ instance: "prod",
+ database: "customers",
+ },
+ });
+ expect(mocks.hasProjectPermission).toHaveBeenCalledWith(
+ expect.objectContaining({ name: "projects/proj" }),
+ "bb.sql.select"
+ );
+ });
+
+ test("disables the link when project query access is missing", () => {
+ render(<DatabaseSQLEditorButton database={database} />);
+
+ const link = screen.getByRole("link", { name: "sql-editor.self" });
+ expect(link).toHaveAttribute("aria-disabled", "true");
+
+ fireEvent.click(link);
+ expect(mocks.push).not.toHaveBeenCalled();
+ });
+});
diff --git a/frontend/src/routes/project/database-detail/DatabaseSQLEditorButton.tsx b/frontend/src/routes/project/database-detail/DatabaseSQLEditorButton.tsx
index ba52898850..728986ee5f 100644
--- a/frontend/src/routes/project/database-detail/DatabaseSQLEditorButton.tsx
+++ b/frontend/src/routes/project/database-detail/DatabaseSQLEditorButton.tsx
@@ -1,70 +1,32 @@
-import { SquareTerminal } from "lucide-react";
-import { useCallback } from "react";
-import { useTranslation } from "react-i18next";
-import { router } from "@/app/router";
-import { useAppStore } from "@/stores/app";
+import { useCurrentRoute } from "@/app/router";
+import { PermissionGuard } from "@/components/PermissionGuard";
+import { SQLEditorButton } from "@/components/SQLEditorButton";
+import { useProjectByName } from "@/hooks/useProjectByName";
import type { Database } from "@/types/proto-es/v1/database_service_pb";
-import { defaultProject, isDefaultProject } from "@/types/v1/project";
-import { autoSQLEditorDatabaseRoute } from "@/utils";
export function DatabaseSQLEditorButton({
database,
disabled = false,
- onFailed,
}: {
database: Database;
disabled?: boolean;
- onFailed?: (database: Database) => void;
}) {
- const { t } = useTranslation();
- const hasProjectPermissionFn = useAppStore(
- (state) => state.hasProjectPermission
- );
- const hasWorkspacePermissionFn = useAppStore(
- (state) => state.hasWorkspacePermission
- );
-
- const handleClick = useCallback(() => {
- if (disabled) {
- return;
- }
-
- if (isDefaultProject(database.project)) {
- const canQuery =
- hasWorkspacePermissionFn("bb.sql.select") ||
- hasProjectPermissionFn(
- defaultProject(database.project),
- "bb.sql.select"
- );
- if (!canQuery) {
- onFailed?.(database);
- return;
- }
- }
-
- const route = router.resolve(autoSQLEditorDatabaseRoute(database));
-
- if (router.currentRoute.value.name?.toString().startsWith("sql-editor")) {
- void router.push(route);
- return;
- }
-
- window.open(route.fullPath, "_blank");
- }, [
- database,
- disabled,
- hasProjectPermissionFn,
- hasWorkspacePermissionFn,
- onFailed,
- ]);
+ const route = useCurrentRoute();
+ const project = useProjectByName(database.project);
return (
- <dd
- className="flex cursor-pointer items-center text-sm textlabel hover:text-accent md:mr-4"
- onClick={handleClick}
- >
- <SquareTerminal className="mr-1 size-4" />
- {t("sql-editor.self")}
+ <dd className="md:mr-4">
+ <PermissionGuard permissions={["bb.sql.select"]} project={project}>
+ {({ disabled: permissionDisabled }) => (
+ <SQLEditorButton
+ database={database}
+ disabled={disabled || permissionDisabled}
+ openInNewTab={!route.name?.startsWith("sql-editor")}
+ appearance="secondary"
+ size="sm"
+ />
+ )}
+ </PermissionGuard>
</dd>
);
}
diff --git a/frontend/src/routes/workspace/general/GeneralSection.tsx b/frontend/src/routes/workspace/general/GeneralSection.tsx
index e6752f67bc..6c08235450 100644
--- a/frontend/src/routes/workspace/general/GeneralSection.tsx
+++ b/frontend/src/routes/workspace/general/GeneralSection.tsx
@@ -9,13 +9,12 @@ import {
useState,
} from "react";
import { useTranslation } from "react-i18next";
-import { router } from "@/app/router";
-import { SQL_EDITOR_HOME_MODULE } from "@/app/router/handles";
import { LearnMoreLink } from "@/components/LearnMoreLink";
import {
PermissionGuard,
usePermissionCheck,
} from "@/components/PermissionGuard";
+import { SQLEditorButton } from "@/components/SQLEditorButton";
import { Alert } from "@/components/ui/alert";
import { Button } from "@/components/ui/button";
import { Dialog, DialogContent, DialogTitle } from "@/components/ui/dialog";
@@ -127,10 +126,6 @@ export const GeneralSection = forwardRef<SectionHandle, GeneralSectionProps>(
disabled: isSaaSMode,
});
- const goToSQLEditor = () => {
- router.push({ name: SQL_EDITOR_HOME_MODULE });
- };
-
return (
<>
<FormSection title={title} style={{ paddingTop: 8 }}>
@@ -260,11 +255,11 @@ export const GeneralSection = forwardRef<SectionHandle, GeneralSectionProps>(
>
{t("common.ok")}
</Button>
- <Button onClick={goToSQLEditor}>
- {t(
+ <SQLEditorButton
+ label={t(
"settings.general.workspace.default-landing-page.go-to-sql-editor"
)}
- </Button>
+ />
</div>
</DialogContent>
</Dialog>