Skip to content

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

fix: default query role to least-privileged SQL select role (#20252)

p0ny974ae8544521
diff --git a/frontend/src/react/components/sql-editor/RequestQueryButton.test.tsx b/frontend/src/react/components/sql-editor/RequestQueryButton.test.tsx
index ce8fc277d6..4b69a53eb1 100644
--- a/frontend/src/react/components/sql-editor/RequestQueryButton.test.tsx
+++ b/frontend/src/react/components/sql-editor/RequestQueryButton.test.tsx
@@ -11,7 +11,9 @@ const mocks = vi.hoisted(() => ({
useTranslation: vi.fn(() => ({ t: (key: string) => key })),
useVueState: vi.fn<(getter: () => unknown) => unknown>(),
useProjectV1Store: vi.fn(),
+ useRoleStore: vi.fn(),
useSQLEditorStore: vi.fn(),
+ useSubscriptionV1Store: vi.fn(),
hasFeature: vi.fn(() => true),
parseStringToResource: vi.fn((s: string) => ({
databaseFullName: s,
@@ -29,7 +31,9 @@ vi.mock("@/react/hooks/useVueState", () => ({
vi.mock("@/store", () => ({
useProjectV1Store: mocks.useProjectV1Store,
+ useRoleStore: mocks.useRoleStore,
useSQLEditorStore: mocks.useSQLEditorStore,
+ useSubscriptionV1Store: mocks.useSubscriptionV1Store,
hasFeature: mocks.hasFeature,
}));
@@ -38,11 +42,16 @@ vi.mock("@/components/RoleGrantPanel/DatabaseResourceForm/common", () => ({
}));
vi.mock("@/types", () => ({
- PresetRoleType: { SQL_EDITOR_USER: "roles/sqlEditorUser" },
+ PRESET_ROLES: ["roles/sqlEditorReadUser", "roles/sqlEditorUser"],
+ PresetRoleType: {
+ SQL_EDITOR_READ_USER: "roles/sqlEditorReadUser",
+ SQL_EDITOR_USER: "roles/sqlEditorUser",
+ },
}));
vi.mock("@/types/proto-es/v1/subscription_service_pb", () => ({
PlanFeature: {
+ FEATURE_CUSTOM_ROLES: 47,
FEATURE_JIT: 5,
FEATURE_REQUEST_ROLE_WORKFLOW: 6,
},
@@ -79,8 +88,14 @@ vi.mock("@/react/components/ui/button", () => ({
}));
vi.mock("./RoleGrantPanel", () => ({
- RoleGrantPanel: ({ onClose }: { onClose: () => void }) => (
- <div data-testid="role-grant-panel">
+ RoleGrantPanel: ({
+ onClose,
+ role,
+ }: {
+ onClose: () => void;
+ role: string;
+ }) => (
+ <div data-testid="role-grant-panel" data-role={role}>
<button data-close-btn onClick={onClose}>
Close
</button>
@@ -146,7 +161,26 @@ const setupDefaultMocks = (allowJIT = false, allowRequestRole = true) => {
allowRequestRole,
})),
});
+ mocks.useRoleStore.mockReturnValue({
+ roleList: [
+ {
+ name: "roles/sqlEditorUser",
+ permissions: ["bb.sql.select", "bb.sql.dml", "bb.sql.explain"],
+ },
+ {
+ name: "roles/queryOnly",
+ permissions: ["bb.sql.select"],
+ },
+ {
+ name: "roles/sqlEditorReadUser",
+ permissions: ["bb.sql.select", "bb.sql.explain"],
+ },
+ ],
+ });
mocks.useSQLEditorStore.mockReturnValue({ project: "projects/proj1" });
+ mocks.useSubscriptionV1Store.mockReturnValue({
+ hasInstanceFeature: vi.fn(() => false),
+ });
mocks.hasFeature.mockReturnValue(true);
mocks.useVueState.mockImplementation((getter: () => unknown) => getter());
};
@@ -182,7 +216,7 @@ describe("RequestQueryButton", () => {
<RequestQueryButton
text={false}
permissionDeniedDetail={makePermissionDeniedDetail({
- requiredPermissions: ["bb.sql.select", "bb.issues.create"],
+ requiredPermissions: ["bb.sql.select"],
})}
/>
);
@@ -233,6 +267,149 @@ describe("RequestQueryButton", () => {
unmount();
});
+ test("non-JIT role request defaults to least-permission SQL select role", async () => {
+ setupDefaultMocks(false, true);
+ const { container, render, unmount } = renderIntoContainer(
+ <RequestQueryButton
+ text={false}
+ permissionDeniedDetail={makePermissionDeniedDetail({
+ requiredPermissions: ["bb.sql.select"],
+ })}
+ />
+ );
+ render();
+
+ const btn = container.querySelector("button") as HTMLButtonElement;
+ await act(async () => {
+ btn.click();
+ });
+
+ expect(
+ container
+ .querySelector("[data-testid='role-grant-panel']")
+ ?.getAttribute("data-role")
+ ).toBe("roles/sqlEditorReadUser");
+ unmount();
+ });
+
+ test("non-JIT role request defaults to role covering denied permission", async () => {
+ setupDefaultMocks(false, true);
+ const { container, render, unmount } = renderIntoContainer(
+ <RequestQueryButton
+ text={false}
+ permissionDeniedDetail={makePermissionDeniedDetail({
+ requiredPermissions: ["bb.sql.dml"],
+ })}
+ />
+ );
+ render();
+
+ const btn = container.querySelector("button") as HTMLButtonElement;
+ await act(async () => {
+ btn.click();
+ });
+
+ expect(
+ container
+ .querySelector("[data-testid='role-grant-panel']")
+ ?.getAttribute("data-role")
+ ).toBe("roles/sqlEditorUser");
+ unmount();
+ });
+
+ test("non-JIT role request ignores custom roles when feature is disabled", async () => {
+ setupDefaultMocks(false, true);
+ const { container, render, unmount } = renderIntoContainer(
+ <RequestQueryButton
+ text={false}
+ permissionDeniedDetail={makePermissionDeniedDetail({
+ requiredPermissions: ["bb.sql.select"],
+ })}
+ />
+ );
+ render();
+
+ const btn = container.querySelector("button") as HTMLButtonElement;
+ await act(async () => {
+ btn.click();
+ });
+
+ expect(
+ container
+ .querySelector("[data-testid='role-grant-panel']")
+ ?.getAttribute("data-role")
+ ).toBe("roles/sqlEditorReadUser");
+ unmount();
+ });
+
+ test("non-JIT role request can default to custom role when feature is enabled", async () => {
+ setupDefaultMocks(false, true);
+ mocks.useSubscriptionV1Store.mockReturnValue({
+ hasInstanceFeature: vi.fn(() => true),
+ });
+ const { container, render, unmount } = renderIntoContainer(
+ <RequestQueryButton
+ text={false}
+ permissionDeniedDetail={makePermissionDeniedDetail({
+ requiredPermissions: ["bb.sql.select"],
+ })}
+ />
+ );
+ render();
+
+ const btn = container.querySelector("button") as HTMLButtonElement;
+ await act(async () => {
+ btn.click();
+ });
+
+ expect(
+ container
+ .querySelector("[data-testid='role-grant-panel']")
+ ?.getAttribute("data-role")
+ ).toBe("roles/queryOnly");
+ unmount();
+ });
+
+ test("non-JIT role request works without Array.prototype.toSorted", async () => {
+ setupDefaultMocks(false, true);
+ const descriptor = Object.getOwnPropertyDescriptor(
+ Array.prototype,
+ "toSorted"
+ );
+ Object.defineProperty(Array.prototype, "toSorted", {
+ configurable: true,
+ value: undefined,
+ });
+
+ try {
+ const { container, render, unmount } = renderIntoContainer(
+ <RequestQueryButton
+ text={false}
+ permissionDeniedDetail={makePermissionDeniedDetail({
+ requiredPermissions: ["bb.sql.select"],
+ })}
+ />
+ );
+ render();
+
+ const btn = container.querySelector("button") as HTMLButtonElement;
+ await act(async () => {
+ btn.click();
+ });
+
+ expect(
+ container
+ .querySelector("[data-testid='role-grant-panel']")
+ ?.getAttribute("data-role")
+ ).toBe("roles/sqlEditorReadUser");
+ unmount();
+ } finally {
+ if (descriptor) {
+ Object.defineProperty(Array.prototype, "toSorted", descriptor);
+ }
+ }
+ });
+
test("click in JIT mode opens AccessGrantRequestDrawer", async () => {
setupDefaultMocks(true, true);
const { container, render, unmount } = renderIntoContainer(
diff --git a/frontend/src/react/components/sql-editor/RequestQueryButton.tsx b/frontend/src/react/components/sql-editor/RequestQueryButton.tsx
index c84986bff5..8c0f50377e 100644
--- a/frontend/src/react/components/sql-editor/RequestQueryButton.tsx
+++ b/frontend/src/react/components/sql-editor/RequestQueryButton.tsx
@@ -6,14 +6,54 @@ import { FeatureBadge } from "@/react/components/FeatureBadge";
import { PermissionGuard } from "@/react/components/PermissionGuard";
import { Button } from "@/react/components/ui/button";
import { useVueState } from "@/react/hooks/useVueState";
-import { hasFeature, useProjectV1Store, useSQLEditorStore } from "@/store";
+import {
+ hasFeature,
+ useProjectV1Store,
+ useRoleStore,
+ useSQLEditorStore,
+ useSubscriptionV1Store,
+} from "@/store";
import type { DatabaseResource, Permission } from "@/types";
-import { PresetRoleType } from "@/types";
+import { PRESET_ROLES, PresetRoleType } from "@/types";
import type { PermissionDeniedDetail } from "@/types/proto-es/v1/common_pb";
+import type { Role } from "@/types/proto-es/v1/role_service_pb";
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
import { AccessGrantRequestDrawer } from "./AccessGrantRequestDrawer";
import { RoleGrantPanel } from "./RoleGrantPanel";
+const SQL_SELECT_PERMISSION = "bb.sql.select";
+
+const getDefaultQueryRole = (
+ roles: readonly Pick<Role, "name" | "permissions">[],
+ requiredPermissions: readonly string[],
+ hasCustomRoleFeature: boolean
+) => {
+ const permissions =
+ requiredPermissions.length > 0
+ ? requiredPermissions
+ : [SQL_SELECT_PERMISSION];
+ const candidates = [...roles]
+ .filter((role) => hasCustomRoleFeature || PRESET_ROLES.includes(role.name))
+ .filter((role) =>
+ permissions.every((permission) => role.permissions.includes(permission))
+ )
+ .sort((a, b) => {
+ const permissionCountDelta = a.permissions.length - b.permissions.length;
+ if (permissionCountDelta !== 0) {
+ return permissionCountDelta;
+ }
+ if (a.name === PresetRoleType.SQL_EDITOR_READ_USER) {
+ return -1;
+ }
+ if (b.name === PresetRoleType.SQL_EDITOR_READ_USER) {
+ return 1;
+ }
+ return a.name.localeCompare(b.name);
+ });
+
+ return candidates[0]?.name ?? PresetRoleType.SQL_EDITOR_USER;
+};
+
interface Props {
readonly size?: "sm" | "default";
readonly text?: boolean;
@@ -34,9 +74,21 @@ export function RequestQueryButton({
const projectStore = useProjectV1Store();
const editorStore = useSQLEditorStore();
+ const roleStore = useRoleStore();
+ const subscriptionStore = useSubscriptionV1Store();
const projectName = useVueState(() => editorStore.project);
const project = useVueState(() => projectStore.getProjectByName(projectName));
+ const hasCustomRoleFeature = useVueState(() =>
+ subscriptionStore.hasInstanceFeature(PlanFeature.FEATURE_CUSTOM_ROLES)
+ );
+ const defaultQueryRole = useVueState(() =>
+ getDefaultQueryRole(
+ roleStore.roleList,
+ permissionDeniedDetail.requiredPermissions,
+ hasCustomRoleFeature
+ )
+ );
const useJIT = useMemo(
() =>
@@ -110,7 +162,7 @@ export function RequestQueryButton({
<RoleGrantPanel
projectName={projectName}
databaseResources={missingResources}
- role={PresetRoleType.SQL_EDITOR_USER}
+ role={defaultQueryRole}
requiredPermissions={permissionDeniedDetail.requiredPermissions}
onClose={() => setShowPanel(false)}
/>