Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Gate SDK query builder controls on create-queries permission (#76862)

Mahatthana (Kelvin) Nomsawadi960b9fa2d123
diff --git a/e2e/test-component/scenarios/embedding-sdk/sdk-question-permissions.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/sdk-question-permissions.cy.spec.tsx
new file mode 100644
index 00000000000..5795063a229
--- /dev/null
+++ b/e2e/test-component/scenarios/embedding-sdk/sdk-question-permissions.cy.spec.tsx
@@ -0,0 +1,46 @@
+import { InteractiveQuestion } from "@metabase/embedding-sdk-react";
+
+import { USERS } from "e2e/support/cypress_data";
+import { ORDERS_QUESTION_ID } from "e2e/support/cypress_sample_instance_data";
+import { getSdkRoot } from "e2e/support/helpers/e2e-embedding-sdk-helpers";
+import { mountSdkContent } from "e2e/support/helpers/embedding-sdk-component-testing";
+import { signInAsAdminAndEnableEmbeddingSdk } from "e2e/support/helpers/embedding-sdk-testing";
+import { mockAuthProviderAndJwtSignIn } from "e2e/support/helpers/embedding-sdk-testing/embedding-sdk-helpers";
+
+describe("scenarios > embedding-sdk > sdk-question query builder editing controls permissions (EMB-1963)", () => {
+ beforeEach(() => {
+ signInAsAdminAndEnableEmbeddingSdk();
+ });
+
+ it("hides Filter, Summarize, and the notebook editor toggle when the user lacks create-queries permission on the underlying table", () => {
+ // `readonly` has create-queries: no
+ cy.signOut();
+ mockAuthProviderAndJwtSignIn(USERS.readonly);
+
+ mountSdkContent(<InteractiveQuestion questionId={ORDERS_QUESTION_ID} />);
+
+ getSdkRoot().within(() => {
+ cy.findByTestId("visualization-root").should("be.visible");
+
+ cy.button("Filter").should("not.exist");
+ cy.button("Summarize").should("not.exist");
+ cy.findByTestId("notebook-button").should("not.exist");
+ });
+ });
+
+ it("shows Filter, Summarize, and the notebook editor toggle when the user has create-queries permission on the underlying table", () => {
+ // `readonlynosql` has create-queries: query-builder
+ cy.signOut();
+ mockAuthProviderAndJwtSignIn(USERS.readonlynosql);
+
+ mountSdkContent(<InteractiveQuestion questionId={ORDERS_QUESTION_ID} />);
+
+ getSdkRoot().within(() => {
+ cy.findByTestId("visualization-root").should("be.visible");
+
+ cy.button("Filter").should("be.visible");
+ cy.button("Summarize").should("be.visible");
+ cy.findByTestId("notebook-button").should("be.visible");
+ });
+ });
+});
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Breakout/BreakoutDropdown/BreakoutDropdown.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Breakout/BreakoutDropdown/BreakoutDropdown.tsx
index 6f8fc200520..b18ecc5d36b 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Breakout/BreakoutDropdown/BreakoutDropdown.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Breakout/BreakoutDropdown/BreakoutDropdown.tsx
@@ -9,6 +9,7 @@ import {
import type { PopoverProps } from "metabase/ui";
import { useSdkQuestionContext } from "../../../context";
+import { shouldRenderQueryBuilderEditingControl } from "../../../utils/should-render-query-builder-editing-control";
import { ToolbarButton } from "../../util/ToolbarButton";
import { BreakoutBadgeList } from "../BreakoutBadgeList";
import { BreakoutPicker } from "../BreakoutPicker";
@@ -103,7 +104,7 @@ export const BreakoutDropdown = (
) => {
const { question } = useSdkQuestionContext();
- if (!question) {
+ if (!question || !shouldRenderQueryBuilderEditingControl(question)) {
return null;
}
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/EditorButton/EditorButton.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/EditorButton/EditorButton.tsx
index 28bd1420167..55f663db2c7 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/EditorButton/EditorButton.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/EditorButton/EditorButton.tsx
@@ -29,17 +29,13 @@ export type EditorButtonProps = {
function shouldShowEditButton({
question,
- isActionListVisible,
isBrandNew = false,
}: {
question: Question;
- isActionListVisible: boolean;
isBrandNew?: boolean;
}) {
const { isEditable } = Lib.queryDisplayInfo(question.query());
- return (
- isEditable && isActionListVisible && !question.isArchived() && !isBrandNew
- );
+ return isEditable && !question.isArchived() && !isBrandNew;
}
/**
@@ -55,19 +51,18 @@ export const EditorButton = ({
...actionIconProps
}: EditorButtonProps) => {
const { question } = useSdkQuestionContext();
+
+ if (!question || !shouldShowEditButton({ question })) {
+ return null;
+ }
+
return (
- question &&
- shouldShowEditButton({
- question,
- isActionListVisible: true,
- }) && (
- <SdkActionIcon
- tooltip={t`Edit question`}
- icon="pencil_lines"
- data-testid="notebook-button"
- data-active={isOpen}
- {...actionIconProps}
- />
- )
+ <SdkActionIcon
+ tooltip={t`Edit question`}
+ icon="pencil_lines"
+ data-testid="notebook-button"
+ data-active={isOpen}
+ {...actionIconProps}
+ />
);
};
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Filter/FilterDropdown/FilterDropdown.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Filter/FilterDropdown/FilterDropdown.tsx
index ce6b073a7b6..7dfca575267 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Filter/FilterDropdown/FilterDropdown.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Filter/FilterDropdown/FilterDropdown.tsx
@@ -12,6 +12,7 @@ import { getFilterItems } from "metabase/querying/filters/components/FilterPanel
import type { PopoverProps } from "metabase/ui";
import { useSdkQuestionContext } from "../../../context";
+import { shouldRenderQueryBuilderEditingControl } from "../../../utils/should-render-query-builder-editing-control";
import { ToolbarButton } from "../../util/ToolbarButton";
import { FilterBadgeList } from "../FilterBadgeList";
import { FilterPicker } from "../FilterPicker/FilterPicker";
@@ -113,7 +114,7 @@ const FilterDropdownInner = ({
export const FilterDropdown = ({ withColumnItemIcon }: FilterDropdownProps) => {
const { question } = useSdkQuestionContext();
- if (!question) {
+ if (!question || !shouldRenderQueryBuilderEditingControl(question)) {
return null;
}
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Summarize/SummarizeDropdown/SummarizeDropdown.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Summarize/SummarizeDropdown/SummarizeDropdown.tsx
index dd9b70b4f60..979bd4aeb1f 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Summarize/SummarizeDropdown/SummarizeDropdown.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Summarize/SummarizeDropdown/SummarizeDropdown.tsx
@@ -9,7 +9,9 @@ import {
} from "embedding-sdk-bundle/components/private/util/MultiStepPopover";
import { type PopoverProps, Tooltip } from "metabase/ui";
+import { useSdkQuestionContext } from "../../../context";
import { useStageChangeTooltip } from "../../../hooks/use-stage-change-tooltip";
+import { shouldRenderQueryBuilderEditingControl } from "../../../utils/should-render-query-builder-editing-control";
import { ToolbarButton } from "../../util/ToolbarButton";
import { SummarizeBadgeList } from "../SummarizeBadgeList";
import {
@@ -49,6 +51,12 @@ export const SummarizeDropdown = ({
const [step, setStep] = useState<MultiStepState<"picker" | "list">>(null);
+ const { question } = useSdkQuestionContext();
+
+ if (!shouldRenderQueryBuilderEditingControl(question)) {
+ return null;
+ }
+
const onSelectBadge = (item?: SDKAggregationItem) => {
setSelectedAggregationItem(item);
setStep("picker");
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/util/ToolbarButton/ToolbarButton.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/util/ToolbarButton/ToolbarButton.tsx
index 751d99fb0d1..4e76dd0f0d2 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/util/ToolbarButton/ToolbarButton.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/util/ToolbarButton/ToolbarButton.tsx
@@ -28,7 +28,7 @@ function _ToolbarButton(
iconUrl ? (
<img src={iconUrl} alt="" width={16} height={16} />
) : icon ? (
- <Icon name={icon} />
+ <Icon name={icon} aria-hidden />
) : undefined
}
py="sm"
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/utils/should-render-query-builder-editing-control.ts b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/utils/should-render-query-builder-editing-control.ts
new file mode 100644
index 00000000000..cffea31a3aa
--- /dev/null
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/utils/should-render-query-builder-editing-control.ts
@@ -0,0 +1,21 @@
+import * as Lib from "metabase-lib";
+import type Question from "metabase-lib/v1/Question";
+
+/**
+ * Matches main app's FilterHeaderButton/QuestionSummarizeWidget/QuestionNotebookButton
+ * gating. Three of the main app's conditions don't apply to the SDK and are omitted:
+ * - `queryBuilderMode` — no notebook-mode toggle exposed by the SDK
+ * - `isObjectDetail` — the SDK hardcodes `isObjectDetail={false}` in Visualization.tsx
+ * - `isActionListVisible` — governs the legacy static/iframe embed's `action_buttons` option
+ */
+export function shouldRenderQueryBuilderEditingControl(
+ question: Question | undefined,
+): boolean {
+ if (!question) {
+ return false;
+ }
+
+ const { isEditable, isNative } = Lib.queryDisplayInfo(question.query());
+
+ return isEditable && !isNative && !question.isArchived();
+}
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/utils/should-render-query-builder-editing-control.unit.spec.ts b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/utils/should-render-query-builder-editing-control.unit.spec.ts
new file mode 100644
index 00000000000..e9f31d5342a
--- /dev/null
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/utils/should-render-query-builder-editing-control.unit.spec.ts
@@ -0,0 +1,85 @@
+import { createMockMetadata } from "__support__/metadata";
+import * as Lib from "metabase-lib";
+import {
+ DEFAULT_TEST_QUERY,
+ SAMPLE_DATABASE,
+ SAMPLE_METADATA,
+ SAMPLE_PROVIDER,
+} from "metabase-lib/test-helpers";
+import Question from "metabase-lib/v1/Question";
+import {
+ ORDERS_ID,
+ createSampleDatabase,
+} from "metabase-types/api/mocks/presets";
+
+import { shouldRenderQueryBuilderEditingControl } from "./should-render-query-builder-editing-control";
+
+describe("shouldRenderQueryBuilderEditingControl", () => {
+ it("returns false when there is no question", () => {
+ expect(shouldRenderQueryBuilderEditingControl(undefined)).toBe(false);
+ });
+
+ it("returns true for an editable, non-native, non-archived question", () => {
+ const editableQuery = Lib.createTestQuery(
+ SAMPLE_PROVIDER,
+ DEFAULT_TEST_QUERY,
+ );
+ const editableQuestion = Question.create({
+ metadata: SAMPLE_METADATA,
+ }).setQuery(editableQuery);
+
+ expect(shouldRenderQueryBuilderEditingControl(editableQuestion)).toBe(true);
+ });
+
+ it("returns false when missing create-queries permission (isEditable: false)", () => {
+ // Mirrors the backend: create a query without create-queries permission.
+ const sampleDatabase = createSampleDatabase();
+ const databaseWithoutOrders = {
+ ...sampleDatabase,
+ tables: sampleDatabase.tables?.filter((table) => table.id !== ORDERS_ID),
+ };
+ const metadataWithoutOrders = createMockMetadata({
+ databases: [databaseWithoutOrders],
+ });
+ const notEditableQuery = Lib.fromJsQueryAndMetadata(metadataWithoutOrders, {
+ database: databaseWithoutOrders.id,
+ type: "query",
+ query: { "source-table": ORDERS_ID },
+ });
+ const notEditableQuestion = Question.create({
+ metadata: metadataWithoutOrders,
+ }).setQuery(notEditableQuery);
+
+ expect(shouldRenderQueryBuilderEditingControl(notEditableQuestion)).toBe(
+ false,
+ );
+ });
+
+ it("returns false for a native query, even when editable", () => {
+ const nativeQuestion = Question.create({
+ metadata: SAMPLE_METADATA,
+ DEPRECATED_RAW_MBQL_type: "native",
+ DEPRECATED_RAW_MBQL_databaseId: SAMPLE_DATABASE.id,
+ });
+
+ expect(shouldRenderQueryBuilderEditingControl(nativeQuestion)).toBe(false);
+ });
+
+ it("returns false for an archived question", () => {
+ const editableQuery = Lib.createTestQuery(
+ SAMPLE_PROVIDER,
+ DEFAULT_TEST_QUERY,
+ );
+ const editableQuestion = Question.create({
+ metadata: SAMPLE_METADATA,
+ }).setQuery(editableQuery);
+ const archivedQuestion = editableQuestion.setCard({
+ ...editableQuestion.card(),
+ archived: true,
+ });
+
+ expect(shouldRenderQueryBuilderEditingControl(archivedQuestion)).toBe(
+ false,
+ );
+ });
+});