The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
embedding-hub: preserve "Select data" state + reset next steps after changing data segregation strategy (#71368)
Nicolò Prettoc4a27f18d34c
diff --git a/e2e/test/scenarios/embedding/embedding-hub/embedding-hub.cy.spec.ts b/e2e/test/scenarios/embedding/embedding-hub/embedding-hub.cy.spec.tsindex ebba6aeb3ac..a475355e37a 100644--- a/e2e/test/scenarios/embedding/embedding-hub/embedding-hub.cy.spec.ts+++ b/e2e/test/scenarios/embedding/embedding-hub/embedding-hub.cy.spec.ts@@ -1598,6 +1598,89 @@ describe("scenarios - embedding hub", () => {).should("be.visible");});++ it("reopens the create tenants step after changing the segregation strategy", () => {+ H.addPostgresDatabase("QA Postgres12");++ cy.log("pre-complete RLS and create a tenant");+ cy.sandboxTable({+ table_id: STATIC_ORDERS_ID,+ group_id: ALL_EXTERNAL_USERS_GROUP_ID,+ });+ cy.request("POST", "/api/ee/tenant", {+ name: "Legacy Tenant",+ slug: "legacy-tenant",+ attributes: {+ organization_id: "legacy-org",+ },+ });++ cy.intercept("PUT", "/api/permissions/graph").as(+ "updatePermissionsGraph",+ );+ cy.intercept("GET", "/api/ee/embedding-hub/checklist").as("getChecklist");++ cy.visit("/admin/embedding/setup-guide/permissions");++ cy.log("reopen the strategy step and switch to connection impersonation");+ H.main()+ .findByRole("listitem", {+ name: "Which data segregation strategy does your database use?",+ })+ .click();++ H.main()+ .findByRole("radio", { name: /Connection impersonation/ })+ .scrollIntoView()+ .click();++ H.main()+ .findByRole("button", { name: "Use connection impersonation" })+ .scrollIntoView()+ .click();++ cy.log("complete the new select-data step");+ H.main().findByPlaceholderText("Pick a database").click();+ H.popover().findByText("QA Postgres12").click();+ H.main().findByRole("button", { name: "Next" }).click();++ cy.wait("@updatePermissionsGraph");++ cy.log("create tenants should reopen instead of skipping to summary");+ H.main()+ .findByRole("listitem", {+ name: "Create tenants",+ timeout: 10_000,+ })+ .should("have.attr", "aria-current", "step");++ H.main()+ .findByRole("listitem", { name: "Summary" })+ .should("not.have.attr", "aria-current", "step");++ cy.log("creating a new tenant should go to summary");+ H.main().within(() => {+ cy.findByPlaceholderText("Tenant name").clear().type("Acme Corp");+ cy.findByPlaceholderText("tenant_role").type("acme_role");+ cy.findByPlaceholderText("tenant-slug").clear().type("acme-corp");+ });++ H.main().findByRole("button", { name: "Create tenants" }).click();++ H.undoToast()+ .findByText("Tenants created successfully")+ .should("be.visible");++ H.main()+ .findByRole("listitem", { name: "Summary", timeout: 10_000 })+ .should("have.attr", "aria-current", "step");++ H.main()+ .contains(+ "All users in Acme Corp will connect using the acme_role database role.",+ )+ .should("be.visible");+ });});describe("database routing create tenants step", () => {diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/CreateTenantsOnboardingStep.tsx b/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/CreateTenantsOnboardingStep.tsxindex f7e3660bed2..010ad9f7287 100644--- a/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/CreateTenantsOnboardingStep.tsx+++ b/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/CreateTenantsOnboardingStep.tsx@@ -1,9 +1,11 @@-import { useCallback, useState } from "react";+import type { SetStateAction } from "react";+import { useCallback } from "react";import { t } from "ttag";import { getErrorMessage } from "metabase/api/utils";import { useToast } from "metabase/common/hooks";import type { DataSegregationStrategy } from "metabase/embedding/embedding-hub";+import { createEmptyTenantDraft } from "metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/utils";import { slugify } from "metabase/lib/formatting";import type { CreatedTenantData } from "metabase/plugins/oss/tenants";import {@@ -26,11 +28,15 @@ import { getIsolationFieldConfig } from "./isolation-field-config";export const CreateTenantsOnboardingStep = ({onTenantsCreated,+ tenants,+ onTenantsChange,selectedFieldIds,strategy,rlsColumnName,}: {onTenantsCreated?: (tenants: CreatedTenantData[]) => void;+ tenants: CreatedTenantData[];+ onTenantsChange: (value: SetStateAction<CreatedTenantData[]>) => void;selectedFieldIds?: FieldId[];strategy?: DataSegregationStrategy | null;rlsColumnName?: string | null;@@ -39,17 +45,16 @@ export const CreateTenantsOnboardingStep = ({const [createTenant, { isLoading }] = useCreateTenantMutation();- const [tenants, setTenants] = useState<CreatedTenantData[]>([- createEmptyTenant(1),- ]);-const addTenantCard = useCallback(() => {- setTenants((prev) => [...prev, createEmptyTenant(prev.length + 1)]);- }, []);+ onTenantsChange((prev) => [+ ...prev,+ createEmptyTenantDraft(prev.length + 1),+ ]);+ }, [onTenantsChange]);const updateTenantCard = useCallback((index: number, field: keyof CreatedTenantData, value: string) => {- setTenants((prev) =>+ onTenantsChange((prev) =>prev.map((tenant, i) => {if (i !== index) {return tenant;@@ -66,12 +71,15 @@ export const CreateTenantsOnboardingStep = ({}),);},- [],+ [onTenantsChange],);- const removeTenantCard = useCallback((index: number) => {- setTenants((prev) => prev.filter((_, i) => i !== index));- }, []);+ const removeTenantCard = useCallback(+ (index: number) => {+ onTenantsChange((prev) => prev.filter((_, i) => i !== index));+ },+ [onTenantsChange],+ );const fieldConfig = getIsolationFieldConfig(strategy);@@ -235,9 +243,3 @@ const TenantFormField = ({/></Stack>);--const createEmptyTenant = (index: number): CreatedTenantData => ({- name: `Tenant ${index}`,- dataIsolationFieldValue: "",- slug: `tenant-${index}`,-});diff --git a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/RlsDataSelector/RlsDataSelector.tsx b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/RlsDataSelector/RlsDataSelector.tsxindex 4441ac58c02..8292dc48c3a 100644--- a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/RlsDataSelector/RlsDataSelector.tsx+++ b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/RlsDataSelector/RlsDataSelector.tsx@@ -1,4 +1,5 @@-import { useCallback, useState } from "react";+import type { SetStateAction } from "react";+import { useCallback } from "react";import { t } from "ttag";import { getErrorMessage } from "metabase/api/utils";@@ -26,16 +27,18 @@ export interface RlsSelectionResult {}interface RlsDataSelectorProps {+ selections: TableColumnSelection[];+ onSelectionsChange: (value: SetStateAction<TableColumnSelection[]>) => void;onSuccess: (result: RlsSelectionResult) => void;}-export const RlsDataSelector = ({ onSuccess }: RlsDataSelectorProps) => {+export const RlsDataSelector = ({+ selections,+ onSelectionsChange,+ onSuccess,+}: RlsDataSelectorProps) => {const [sendToast] = useToast();- const [selections, setSelections] = useState<TableColumnSelection[]>([- { tableId: null, columnId: null },- ]);-const { handleUpsertPolicies, isCreatingPolicy, isLoadingPolicies } =useUpsertGroupTableAccessPolicies({ tableColumnSelections: selections });@@ -69,25 +72,27 @@ export const RlsDataSelector = ({ onSuccess }: RlsDataSelectorProps) => {}, [handleUpsertPolicies, selections, onSuccess, sendToast]);const addTable = useCallback(() => {- setSelections((prev) => [...prev, { tableId: null, columnId: null }]);- }, []);-- const removeTable = useCallback((nextIndex: number) => {- setSelections((prev) =>- prev.filter((_, prevIndex) => prevIndex !== nextIndex),- );- }, []);+ onSelectionsChange((prev) => [...prev, createEmptyTableColumnSelection()]);+ }, [onSelectionsChange]);++ const removeTable = useCallback(+ (nextIndex: number) => {+ onSelectionsChange((prev) =>+ prev.filter((_, prevIndex) => prevIndex !== nextIndex),+ );+ },+ [onSelectionsChange],+ );const updateTable = useCallback((index: number, selection: TableColumnSelection) => {- setSelections((prev) => {- const newSelections = [...prev];- newSelections[index] = selection;-- return newSelections;- });+ onSelectionsChange((prev) =>+ prev.map((prevSelection, prevIndex) =>+ prevIndex === index ? selection : prevSelection,+ ),+ );},- [],+ [onSelectionsChange],);const canRemove = selections.length > 1;@@ -144,3 +149,8 @@ export const RlsDataSelector = ({ onSuccess }: RlsDataSelectorProps) => {</Stack>);};++export const createEmptyTableColumnSelection = (): TableColumnSelection => ({+ tableId: null,+ columnId: null,+});diff --git a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/RlsDataSelector/index.ts b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/RlsDataSelector/index.tsindex 7218ce268f3..b5d89cef4ac 100644--- a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/RlsDataSelector/index.ts+++ b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/RlsDataSelector/index.ts@@ -1,5 +1,6 @@export {RlsDataSelector,+ createEmptyTableColumnSelection,type TableColumnSelection,type RlsSelectionResult,} from "./RlsDataSelector";diff --git a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/SetupPermissionsAndTenantsPage.tsx b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/SetupPermissionsAndTenantsPage.tsxindex 179de6f6f41..5fed606368f 100644--- a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/SetupPermissionsAndTenantsPage.tsx+++ b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/SetupPermissionsAndTenantsPage.tsx@@ -20,11 +20,17 @@ import {import { DatabaseRoutingStepContent } from "./DatabaseRoutingStepContent";import { EnableTenantsStepContent } from "./EnableTenantsStepContent";import { MoveDashboardStepContent } from "./MoveDashboardStepContent";-import type { RlsSelectionResult } from "./RlsDataSelector";-import { RlsDataSelector } from "./RlsDataSelector";+import type {+ RlsSelectionResult,+ TableColumnSelection,+} from "./RlsDataSelector";+import {+ RlsDataSelector,+ createEmptyTableColumnSelection,+} from "./RlsDataSelector";import S from "./SetupPermissionsAndTenantsPage.module.css";import { useLastXrayDashboard } from "./hooks/use-xray-dashboards";-+import { createEmptyTenantDraft } from "./utils";const SETUP_GUIDE_PATH = "/admin/embedding/setup-guide";export const SetupPermissionsAndTenantsPage = () => {@@ -42,13 +48,20 @@ export const SetupPermissionsAndTenantsPage = () => {// Track the tenants created in this onboarding flowconst [createdTenants, setCreatedTenants] = useState<CreatedTenantData[]>([]);+ const [needsTenantRecreation, setNeedsTenantRecreation] = useState(false);++ const [tenantDrafts, setTenantDrafts] = useState<CreatedTenantData[]>(() => [+ createEmptyTenantDraft(1),+ ]);// Track RLS selection from the "Select data" step (in-session only)- const [rlsSelection, setRlsSelection] = useState<RlsSelectionResult>({- fieldIds: [],- tableNames: [],- columnName: null,- });+ const [rlsSelection, setRlsSelection] = useState<RlsSelectionResult>(+ createEmptyRlsSelection,+ );++ const [rlsSelectionsDraft, setRlsSelectionsDraft] = useState<+ TableColumnSelection[]+ >(() => [createEmptyTableColumnSelection()]);const isMoveDashboardDone = checklist?.["move-dashboard-to-shared"] ?? false;@@ -64,7 +77,13 @@ export const SetupPermissionsAndTenantsPage = () => {const isDataSegregationSetupDone =checklist?.["setup-data-segregation-strategy"] ?? false;- const isTenantsCreated = checklist?.["create-tenants"] ?? false;+ const backendStrategy =+ checklistResponse?.["data-isolation-strategy"] ?? null;+ const isTenantsCreatedFromBackend = checklist?.["create-tenants"] ?? false;+ const isTenantsCreated =+ !needsTenantRecreation &&+ (createdTenants.length > 0 ||+ (isTenantsCreatedFromBackend && activeStrategy === backendStrategy));// When data segregation is finally configured, we permanently// mark this step as done. Otherwise rely on UI state.@@ -162,11 +181,29 @@ export const SetupPermissionsAndTenantsPage = () => {<DataSegregationStrategyPickervalue={activeStrategy}onChange={(value) => {+ const hasStrategyChanged = value !== activeStrategy;+setSelectedStrategy(value);setIsStrategyConfirmed(false);++ if (hasStrategyChanged) {+ setCreatedTenants([]);+ setTenantDrafts([createEmptyTenantDraft(1)]);+ setRlsSelection(createEmptyRlsSelection());+ setRlsSelectionsDraft([createEmptyTableColumnSelection()]);+ }}}onConfirm={() => {+ const confirmedStrategy = activeStrategy;+ const shouldRecreateTenants =+ confirmedStrategy !== backendStrategy;+setIsStrategyConfirmed(true);+ setNeedsTenantRecreation(shouldRecreateTenants);++ if (shouldRecreateTenants) {+ setCreatedTenants([]);+ }// User is re-configuring the data segregation,// so we need to _always_ go to the next step.@@ -184,6 +221,8 @@ export const SetupPermissionsAndTenantsPage = () => {{match(activeStrategy).with("row-column-level-security", () => (<RlsDataSelector+ selections={rlsSelectionsDraft}+ onSelectionsChange={setRlsSelectionsDraft}onSuccess={(result) => {setRlsSelection(result);@@ -207,7 +246,13 @@ export const SetupPermissionsAndTenantsPage = () => {title={t`Create tenants`}><PLUGIN_TENANTS.CreateTenantsOnboardingStep- onTenantsCreated={setCreatedTenants}+ onTenantsCreated={(tenants) => {+ setCreatedTenants(tenants);+ setNeedsTenantRecreation(false);+ setTenantDrafts([createEmptyTenantDraft(1)]);+ }}+ tenants={tenantDrafts}+ onTenantsChange={setTenantDrafts}selectedFieldIds={rlsSelection.fieldIds}strategy={activeStrategy}rlsColumnName={rlsSelection.columnName}@@ -230,3 +275,9 @@ export const SetupPermissionsAndTenantsPage = () => {</Stack>);};++const createEmptyRlsSelection = (): RlsSelectionResult => ({+ fieldIds: [],+ tableNames: [],+ columnName: null,+});diff --git a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/utils.ts b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/utils.tsnew file mode 100644index 00000000000..fec9c8cd9cc--- /dev/null+++ b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/utils.ts@@ -0,0 +1,7 @@+import type { CreatedTenantData } from "metabase/plugins/oss/tenants";++export const createEmptyTenantDraft = (index: number): CreatedTenantData => ({+ name: `Tenant ${index}`,+ dataIsolationFieldValue: "",+ slug: `tenant-${index}`,+});diff --git a/frontend/src/metabase/plugins/oss/tenants.ts b/frontend/src/metabase/plugins/oss/tenants.tsindex 9ba2dc357f7..3a3834a981a 100644--- a/frontend/src/metabase/plugins/oss/tenants.ts+++ b/frontend/src/metabase/plugins/oss/tenants.ts@@ -1,4 +1,5 @@import type React from "react";+import type { SetStateAction } from "react";import type {OmniPickerCollectionItem,@@ -39,6 +40,8 @@ const getDefaultPluginTenants = () => ({tenantsRoutes: null as React.ReactElement | null,CreateTenantsOnboardingStep: PluginPlaceholder as React.ComponentType<{onTenantsCreated?: (tenants: CreatedTenantData[]) => void;+ tenants: CreatedTenantData[];+ onTenantsChange: (value: SetStateAction<CreatedTenantData[]>) => void;selectedFieldIds?: number[];strategy?: DataSegregationStrategy | null;rlsColumnName?: string | null;@@ -113,6 +116,8 @@ export const PLUGIN_TENANTS: {tenantsRoutes: React.ReactElement | null;CreateTenantsOnboardingStep: React.ComponentType<{onTenantsCreated?: (tenants: CreatedTenantData[]) => void;+ tenants: CreatedTenantData[];+ onTenantsChange: (value: SetStateAction<CreatedTenantData[]>) => void;selectedFieldIds?: number[];strategy?: DataSegregationStrategy | null;rlsColumnName?: string | null;