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
Convert sandboxes and advanced_permissions plugin modules to TypeScript (#77487)
Andrei Chernykh8fd7008e9008
diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/components/ImpersonationModal/ImpersonationModal.tsx b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/components/ImpersonationModal/ImpersonationModal.tsxindex 243ebbb80cc..a796fb36c64 100644--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/components/ImpersonationModal/ImpersonationModal.tsx+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/components/ImpersonationModal/ImpersonationModal.tsx@@ -4,8 +4,10 @@ import { useMount } from "react-use";import { updateDataPermission } from "metabase/admin/permissions/permissions";import { DataPermissionType } from "metabase/admin/permissions/types";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";+import type { ModalComponentProps } from "metabase/common/components/ModalRoute";import { useDatabaseQuery } from "metabase/common/hooks";import { useDispatch } from "metabase/redux";+import { parseIntParam } from "metabase/urls";import { updateImpersonation } from "metabase-enterprise/advanced_permissions/reducer";import { getImpersonation } from "metabase-enterprise/advanced_permissions/selectors";import type {@@ -25,13 +27,10 @@ import {import { ImpersonationModalView } from "./ImpersonationModalView";-interface ImpersonationModalProps {- params: ImpersonationModalParams;- onClose: () => void;-}-const parseParams = (params: ImpersonationModalParams): ImpersonationParams => {- const groupId = parseInt(params.groupId);+ // NaN preserves the pre-conversion parseInt behavior for the+ // route-guaranteed param+ const groupId = parseIntParam(params.groupId) ?? NaN;const databaseId = getImpersonatedDatabaseId(params);return {@@ -43,7 +42,7 @@ const parseParams = (params: ImpersonationModalParams): ImpersonationParams => {export const ImpersonationModal = ({params,onClose,-}: ImpersonationModalProps) => {+}: ModalComponentProps) => {const { groupId, databaseId } = parseParams(params);const {diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/components/ImpersonationModal/ImpersonationModal.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/components/ImpersonationModal/ImpersonationModal.unit.spec.tsxindex 0783c320404..dc27469a329 100644--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/components/ImpersonationModal/ImpersonationModal.unit.spec.tsx+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/components/ImpersonationModal/ImpersonationModal.unit.spec.tsx@@ -14,12 +14,11 @@ import {waitFor,waitForLoaderToBeRemoved,} from "__support__/ui";-import { modalRoute } from "metabase/common/components/ModalRoute";+import type { ModalComponentProps } from "metabase/common/components/ModalRoute";import { Route } from "metabase/router";import { ImpersonationModal } from "metabase-enterprise/advanced_permissions/components/ImpersonationModal/ImpersonationModal";import { advancedPermissionsSlice } from "metabase-enterprise/advanced_permissions/reducer";import { getImpersonations } from "metabase-enterprise/advanced_permissions/selectors";-import type { AdvancedPermissionsStoreState } from "metabase-enterprise/advanced_permissions/types";import { shared } from "metabase-enterprise/shared/reducer";import {createMockDatabase,@@ -37,6 +36,7 @@ const setup = async ({hasImpersonation = true,databaseDetails = {},} = {}) => {+ const onClose = jest.fn();const database = createMockDatabase({id: databaseId,tables: [createMockTable()],@@ -65,13 +65,12 @@ const setup = async ({const { store } = renderWithProviders(<><Route path="/" />- <Route path="database/:databaseId">- {modalRoute(- "impersonated/group/:groupId",- // @ts-expect-error - params prop can't be inferred- ImpersonationModal,+ <Route+ path="database/:databaseId/impersonated/group/:groupId"+ component={(props: ModalComponentProps) => (+ <ImpersonationModal {...props} onClose={onClose} />)}- </Route>+ /></>,{initialRoute: `database/${databaseId}/impersonated/group/${groupId}`,@@ -87,7 +86,7 @@ const setup = async ({await waitForLoaderToBeRemoved();- return store;+ return { store, onClose };};describe("impersonation modal", () => {@@ -137,18 +136,15 @@ describe("impersonation modal", () => {});it("should not update impersonation if it has not changed", async () => {- const store = await setup({ userAttributes: ["foo"] });+ const { store } = await setup({ userAttributes: ["foo"] });await userEvent.click(screen.getByText(/save/i));- expect(- // Unjustified type cast. FIXME- getImpersonations(store.getState() as AdvancedPermissionsStoreState),- ).toHaveLength(0);+ expect(getImpersonations(store.getState())).toHaveLength(0);});it("should create impersonation", async () => {- const store = await setup({ hasImpersonation: false });+ const { store, onClose } = await setup({ hasImpersonation: false });await userEvent.click(await screen.findByPlaceholderText("Pick a user attribute"),@@ -159,10 +155,7 @@ describe("impersonation modal", () => {await userEvent.click(await screen.findByRole("button", { name: /save/i }));await waitFor(() => {- expect(- // Unjustified type cast. FIXME- getImpersonations(store.getState() as AdvancedPermissionsStoreState),- ).toStrictEqual([+ expect(getImpersonations(store.getState())).toStrictEqual([{attribute: "foo",db_id: 1,@@ -170,10 +163,12 @@ describe("impersonation modal", () => {},]);});++ expect(onClose).toHaveBeenCalled();});it("should update impersonation", async () => {- const store = await setup();+ const { store, onClose } = await setup();await userEvent.click(await screen.findByPlaceholderText("Pick a user attribute"),@@ -184,10 +179,7 @@ describe("impersonation modal", () => {await userEvent.click(await screen.findByRole("button", { name: /save/i }));await waitFor(() => {- expect(- // Unjustified type cast. FIXME- getImpersonations(store.getState() as AdvancedPermissionsStoreState),- ).toStrictEqual([+ expect(getImpersonations(store.getState())).toStrictEqual([{attribute: "bar",db_id: 1,@@ -195,6 +187,8 @@ describe("impersonation modal", () => {},]);});++ expect(onClose).toHaveBeenCalled();});it("should show only already selected attribute if attributes array is empty", async () => {diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/graph.ts b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/graph.tsindex e61db9ce1d3..5ed09899cd8 100644--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/graph.ts+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/graph.ts@@ -15,7 +15,6 @@ import {DataPermission,DataPermissionValue,type GroupsPermissions,- type NativePermissions,type PermissionEntityId,} from "metabase-types/api";@@ -56,7 +55,7 @@ export function upgradeViewPermissionsIfNeeded(permissions: GroupsPermissions,groupId: number,entityId: PermissionEntityId,- value: NativePermissions,+ value: DataPermissionValue,database: Database,) {// get permission for item up one level or db if we're already at the top most entity:diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/index.js b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/index.tsxsimilarity index 77%rename from enterprise/frontend/src/metabase-enterprise/advanced_permissions/index.jsrename to enterprise/frontend/src/metabase-enterprise/advanced_permissions/index.tsxindex c5514078e67..4b3d4f30dfd 100644--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/index.js+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/index.tsx@@ -1,9 +1,5 @@import { t } from "ttag";-import {- getDatabaseFocusPermissionsUrl,- getGroupFocusPermissionsUrl,-} from "metabase/admin/permissions/utils/urls";import { modalRoute } from "metabase/common/components/ModalRoute";import {PLUGIN_ADMIN_PERMISSIONS_DATABASE_ACTIONS,@@ -15,6 +11,7 @@ import {PLUGIN_ADVANCED_PERMISSIONS,PLUGIN_DATA_PERMISSIONS,PLUGIN_REDUCERS,+ type PermissionOption,} from "metabase/plugins";import { push } from "metabase/router";import { hasPremiumFeature } from "metabase-enterprise/settings";@@ -27,6 +24,7 @@ import {} from "./graph";import { advancedPermissionsSlice, getImpersonatedPostAction } from "./reducer";import { getImpersonations } from "./selectors";+import { getEditImpersonationUrl } from "./utils";const IMPERSONATED_PERMISSION_OPTION = {// eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045@@ -34,7 +32,7 @@ const IMPERSONATED_PERMISSION_OPTION = {value: DataPermissionValue.IMPERSONATED,icon: "database",iconColor: "warning",-};+} satisfies PermissionOption;const BLOCK_PERMISSION_OPTION = {// eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045@@ -42,14 +40,17 @@ const BLOCK_PERMISSION_OPTION = {value: DataPermissionValue.BLOCKED,icon: "close",iconColor: "danger",-};+} satisfies PermissionOption;/*** Initialize advanced permissions plugin features that depend on hasPremiumFeature.*/export function initializePlugin() {if (hasPremiumFeature("advanced_permissions")) {- const addSelectedAdvancedPermission = (options, value) => {+ const addSelectedAdvancedPermission = (+ options: PermissionOption[],+ value: string,+ ) => {if (value === IMPERSONATED_PERMISSION_OPTION.value) {return [...options, IMPERSONATED_PERMISSION_OPTION];}@@ -86,9 +87,6 @@ export function initializePlugin() {),);- PLUGIN_ADVANCED_PERMISSIONS.isBlockPermission = (value) =>- value === BLOCK_PERMISSION_OPTION.value;-PLUGIN_ADVANCED_PERMISSIONS.getDatabaseLimitedAccessPermission = (value,) => {@@ -124,15 +122,11 @@ export function initializePlugin() {PLUGIN_REDUCERS.advancedPermissionsPlugin =advancedPermissionsSlice.reducer;- PLUGIN_DATA_PERMISSIONS.permissionsPayloadExtraSelectors.push(- (state, data) => {- const impersonations = getImpersonations(state);- const impersonationGroupIds = impersonations.map(- (i) => `${i.group_id}`,- );- return [{ impersonations }, impersonationGroupIds];- },- );+ PLUGIN_DATA_PERMISSIONS.permissionsPayloadExtraSelectors.push((state) => {+ const impersonations = getImpersonations(state);+ const impersonationGroupIds = impersonations.map((i) => `${i.group_id}`);+ return [{ impersonations }, impersonationGroupIds];+ });PLUGIN_DATA_PERMISSIONS.hasChanges.push((state) => getImpersonations(state).length > 0,@@ -144,8 +138,13 @@ export function initializePlugin() {label: t`Edit Impersonated`,iconColor: "warning",icon: "database",- actionCreator: (entityId, groupId, view) =>- push(getEditImpersonationUrl(entityId, groupId, view)),+ actionCreator: (entityId, groupId, view) => {+ if (entityId == null) {+ throw new Error("Impersonation can only be configured for databases");+ }++ return push(getEditImpersonationUrl(entityId, groupId, view));+ },});PLUGIN_DATA_PERMISSIONS.upgradeViewPermissionsIfNeeded =@@ -154,19 +153,3 @@ export function initializePlugin() {shouldRestrictNativeQueryPermissions;}}--const getDatabaseViewImpersonationModalUrl = (entityId, groupId) => {- const baseUrl = getDatabaseFocusPermissionsUrl(entityId);- return `${baseUrl}/impersonated/group/${groupId}`;-};--const getGroupViewImpersonationModalUrl = (entityId, groupId) => {- const baseUrl = getGroupFocusPermissionsUrl(groupId);-- return `${baseUrl}/impersonated/database/${entityId.databaseId}`;-};--const getEditImpersonationUrl = (entityId, groupId, view) =>- view === "database"- ? getDatabaseViewImpersonationModalUrl(entityId, groupId)- : getGroupViewImpersonationModalUrl(entityId, groupId);diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/selectors.ts b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/selectors.tsindex 2ab06802fb4..133fbf3e3f4 100644--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/selectors.ts+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/selectors.ts@@ -1,15 +1,20 @@+import type { State } from "metabase/redux/store";import type { DatabaseId, GroupId } from "metabase-types/api";import type { AdvancedPermissionsStoreState } from "./types";+const getPluginState = (state: State) =>+ // the plugin slice is registered by initializePlugin, so it is present+ // whenever these selectors run+ (state as AdvancedPermissionsStoreState).plugins.advancedPermissionsPlugin;+export const getImpersonation =- (databaseId: DatabaseId, groupId: GroupId) =>- (state: AdvancedPermissionsStoreState) =>- state.plugins.advancedPermissionsPlugin.impersonations.find(+ (databaseId: DatabaseId, groupId: GroupId) => (state: State) =>+ getPluginState(state).impersonations.find((impersonation) =>impersonation.db_id === databaseId &&impersonation.group_id === groupId,);-export const getImpersonations = (state: AdvancedPermissionsStoreState) =>- state.plugins.advancedPermissionsPlugin.impersonations;+export const getImpersonations = (state: State) =>+ getPluginState(state).impersonations;diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/types.ts b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/types.tsindex 0ab52925ab8..412d34ddc2b 100644--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/types.ts+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/types.ts@@ -17,7 +17,7 @@ export interface AdvancedPermissionsStoreState extends EnterpriseState {export type ImpersonationDraft = PartialBy<Impersonation, "attribute">;export type ImpersonationModalParams = {- groupId: string;+ groupId?: string;impersonatedDatabaseId?: string;databaseId?: string;};diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/actions.js b/enterprise/frontend/src/metabase-enterprise/sandboxes/actions.tssimilarity index 76%rename from enterprise/frontend/src/metabase-enterprise/sandboxes/actions.jsrename to enterprise/frontend/src/metabase-enterprise/sandboxes/actions.tsindex 4bf4b8be36f..f0e4f168604 100644--- a/enterprise/frontend/src/metabase-enterprise/sandboxes/actions.js+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/actions.ts@@ -4,6 +4,7 @@ import {LOAD_DATA_PERMISSIONS,SAVE_DATA_PERMISSIONS,UPDATE_DATA_PERMISSION,+ type UpdateDataPermissionPayload,updateDataPermission,} from "metabase/admin/permissions/permissions";import { DataPermissionType } from "metabase/admin/permissions/types";@@ -13,34 +14,44 @@ import {createThunkAction,handleActions,} from "metabase/redux";+import type { GroupTableAccessPolicy } from "metabase-types/api";import { DataPermission, DataPermissionValue } from "metabase-types/api";+import type { RawGroupTableAccessPolicyParams } from "./types";import { getPolicyKey, getPolicyKeyFromParams } from "./utils";export const UPDATE_TABLE_SANDBOXING_PERMISSION ="metabase-enterprise/sandboxes/UPDATE_TABLE_SANDBOXING_PERMISSION";export const updateTableSandboxingPermission = createThunkAction(UPDATE_TABLE_SANDBOXING_PERMISSION,- (params) => async (dispatch) => {- const { groupId, ...entityId } = params;+ (params: RawGroupTableAccessPolicyParams) => async (dispatch) => {return dispatch(updateDataPermission({- groupId,+ ...params,permission: {type: DataPermissionType.ACCESS,permission: DataPermission.VIEW_DATA,},value: DataPermissionValue.SANDBOXED,- entityId,}),);},);const UPDATE_POLICY = "metabase-enterprise/sandboxes/UPDATE_POLICY";-export const updatePolicy = createAction(UPDATE_POLICY);+export const updatePolicy = createAction<GroupTableAccessPolicy>(UPDATE_POLICY);-const groupTableAccessPolicies = handleActions(+// handleActions types the whole map with one payload generic, so handlers+// narrow this union structurally+type SandboxesReducerPayload =+ | GroupTableAccessPolicy+ | UpdateDataPermissionPayload+ | undefined;++const groupTableAccessPolicies = handleActions<+ Record<string, GroupTableAccessPolicy>,+ SandboxesReducerPayload+>({[LOAD_DATA_PERMISSIONS]: {next: () => ({}),@@ -50,6 +61,11 @@ const groupTableAccessPolicies = handleActions(},[UPDATE_POLICY]: {next: (state, { payload }) => {+ // never hit at runtime; narrows the map-wide payload union to this+ // action's payload, a policy+ if (!payload || !("table_id" in payload)) {+ return state;+ }const key = getPolicyKey(payload);return {...state,@@ -59,7 +75,7 @@ const groupTableAccessPolicies = handleActions(},[UPDATE_DATA_PERMISSION]: {next: (state, { payload }) => {- if (!payload || !payload.entityId) {+ if (!payload || !("entityId" in payload) || !payload.entityId) {return state;}diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/components/EditSandboxingModal/EditSandboxingModal.tsx b/enterprise/frontend/src/metabase-enterprise/sandboxes/components/EditSandboxingModal/EditSandboxingModal.tsxindex 24595ce9d9f..62dfd0884e9 100644--- a/enterprise/frontend/src/metabase-enterprise/sandboxes/components/EditSandboxingModal/EditSandboxingModal.tsx+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/components/EditSandboxingModal/EditSandboxingModal.tsx@@ -78,8 +78,8 @@ const getDraftPolicy = ({groupId,}: GroupTableAccessPolicyParams): GroupTableAccessPolicyDraft => {return {- table_id: parseInt(tableId),- group_id: parseInt(groupId),+ table_id: parseInt(String(tableId)),+ group_id: parseInt(String(groupId)),card_id: null,attribute_remappings: { "": null },};diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/components/LoginAttributesWidget/LoginAttributesWidget.tsx b/enterprise/frontend/src/metabase-enterprise/sandboxes/components/LoginAttributesWidget/LoginAttributesWidget.tsxindex 18e66b1f699..d924aaeb37a 100644--- a/enterprise/frontend/src/metabase-enterprise/sandboxes/components/LoginAttributesWidget/LoginAttributesWidget.tsx+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/components/LoginAttributesWidget/LoginAttributesWidget.tsx@@ -18,10 +18,10 @@ import type {import { LoginAttributeMappingEditor } from "./LoginAttributeMappingEditor";interface Props extends HTMLAttributes<HTMLDivElement> {- name: string;+ name?: string;title?: string;description?: string;- userId?: UserId;+ userId?: UserId | null;}const isInheritedValue = (diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/containers/EditSandboxingModal.tsx b/enterprise/frontend/src/metabase-enterprise/sandboxes/containers/EditSandboxingModal.tsxindex 1ad45322d6e..037e04ad689 100644--- a/enterprise/frontend/src/metabase-enterprise/sandboxes/containers/EditSandboxingModal.tsx+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/containers/EditSandboxingModal.tsx@@ -1,11 +1,13 @@import { t } from "ttag";+import { GROUPS_BASE_PATH } from "metabase/admin/permissions/utils/urls";import {skipToken,useGetGroupTableAccessPolicyQuery,useListUserAttributesQuery,} from "metabase/api";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";+import type { ModalComponentProps } from "metabase/common/components/ModalRoute";import { useDispatch, useSelector } from "metabase/redux";import { parseIntParam } from "metabase/urls";import { getGroupTableAccessPolicy } from "metabase-enterprise/sandboxes/selectors";@@ -13,21 +15,17 @@ import type { GroupTableAccessPolicy } from "metabase-types/api";import { updatePolicy, updateTableSandboxingPermission } from "../actions";import EditSandboxingModal from "../components/EditSandboxingModal";-import type { GroupTableAccessPolicyParams, SandboxesState } from "../types";--interface EditSandboxingModalContainerProps {- params: GroupTableAccessPolicyParams;- onClose: () => void;-}const EditSandboxingModalContainer = ({params,+ location,onClose,-}: EditSandboxingModalContainerProps) => {+}: ModalComponentProps) => {const dispatch = useDispatch();const groupId = parseIntParam(params.groupId);const tableId = parseIntParam(params.tableId);+ const databaseId = parseIntParam(params.databaseId);const {data: fetchedPolicy,@@ -48,18 +46,17 @@ const EditSandboxingModalContainer = ({error: attributesError,} = useListUserAttributesQuery();- // The plugins state is added dynamically by the enterprise plugin system,- // so we need to cast to SandboxesState (same approach as the old connect-based mapStateToProps).const draftPolicy = useSelector((state) =>- // Unjustified type cast. FIXME- getGroupTableAccessPolicy(state as unknown as SandboxesState, { params }),+ groupId != null && tableId != null+ ? getGroupTableAccessPolicy(state, { params: { groupId, tableId } })+ : undefined,);- if (tableId == null) {+ if (groupId == null || tableId == null || databaseId == null) {return <LoadingAndErrorWrapper error={t`Invalid table id`} />;}- const policy = draftPolicy ?? fetchedPolicy;+ const policy = draftPolicy ?? fetchedPolicy ?? undefined;const isLoading = isPoliciesLoading || isAttributesLoading;const error = policiesError || attributesError;@@ -74,7 +71,17 @@ const EditSandboxingModalContainer = ({const handleSave = async (policy: GroupTableAccessPolicy) => {dispatch(updatePolicy(policy));- dispatch(updateTableSandboxingPermission(params));+ dispatch(+ updateTableSandboxingPermission({+ groupId,+ entityId: { databaseId, schemaName: params.schemaName, tableId },+ // the modal is mounted under both permissions editor views; only+ // permission post-actions read the view+ view: location.pathname.startsWith(GROUPS_BASE_PATH)+ ? "group"+ : "database",+ }),+ );onClose();};@@ -82,7 +89,7 @@ const EditSandboxingModalContainer = ({<EditSandboxingModalpolicy={policy}attributes={attributes || []}- params={params}+ params={{ groupId, tableId }}onCancel={onClose}onSave={handleSave}/>diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/index.js b/enterprise/frontend/src/metabase-enterprise/sandboxes/index.tsxsimilarity index 69%rename from enterprise/frontend/src/metabase-enterprise/sandboxes/index.jsrename to enterprise/frontend/src/metabase-enterprise/sandboxes/index.tsxindex 92d0bfff372..d472584aa77 100644--- a/enterprise/frontend/src/metabase-enterprise/sandboxes/index.js+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/index.tsx@@ -1,6 +1,7 @@import { t } from "ttag";import _ from "underscore";+import { isTableEntityId } from "metabase/admin/permissions/utils/data-entity-id";import {getDatabaseFocusPermissionsUrl,getGroupFocusPermissionsUrl,@@ -16,9 +17,15 @@ import {PLUGIN_ADMIN_USER_FORM_FIELDS,PLUGIN_DATA_PERMISSIONS,PLUGIN_REDUCERS,+ type PermissionOption,} from "metabase/plugins";import { push } from "metabase/router";import { hasPremiumFeature } from "metabase-enterprise/settings";+import type {+ GroupId,+ PermissionEntityId,+ TableEntityId,+} from "metabase-types/api";import { DataPermissionValue } from "metabase-types/api";import sandboxingReducer from "./actions";@@ -33,28 +40,46 @@ const OPTION_SEGMENTED = {value: DataPermissionValue.SANDBOXED,icon: "permissions_limited",iconColor: "brand",-};+} satisfies PermissionOption;-const getDatabaseViewSandboxModalUrl = (entityId, groupId) => {- const baseUrl = getDatabaseFocusPermissionsUrl(entityId, groupId);+const getDatabaseViewSandboxModalUrl = (+ entityId: TableEntityId,+ groupId: GroupId,+) => {+ const baseUrl = getDatabaseFocusPermissionsUrl(entityId);return `${baseUrl}/segmented/group/${groupId}`;};-const getGroupViewSandboxModalUrl = (entityId, groupId) => {- const baseUrl = getGroupFocusPermissionsUrl(groupId, {- ...entityId,- tableId: null,- });- return `${baseUrl}/${entityId.tableId}/segmented`;+const getGroupViewSandboxModalUrl = (+ entityId: TableEntityId,+ groupId: GroupId,+) => {+ // the group view URL nests the table segment after the group, so the helper+ // gets only the schema-level ids+ const { tableId, ...schemaEntityId } = entityId;+ const baseUrl = getGroupFocusPermissionsUrl(groupId, schemaEntityId);+ return `${baseUrl}/${tableId}/segmented`;};-const getEditSegementedAccessUrl = (entityId, groupId, view) =>- view === "database"+const getEditSegementedAccessUrl = (+ entityId: PermissionEntityId | undefined,+ groupId: GroupId,+ view: "database" | "group",+) => {+ if (entityId == null || !isTableEntityId(entityId)) {+ throw new Error("Sandboxing can only be configured for tables");+ }++ return view === "database"? getDatabaseViewSandboxModalUrl(entityId, groupId): getGroupViewSandboxModalUrl(entityId, groupId);+};-const getEditSegmentedAccessPostAction = (entityId, groupId, view) =>- push(getEditSegementedAccessUrl(entityId, groupId, view));+const getEditSegmentedAccessPostAction = (+ entityId: PermissionEntityId,+ groupId: GroupId,+ view: "database" | "group",+) => push(getEditSegementedAccessUrl(entityId, groupId, view));/*** Initialize sandboxes plugin features that depend on hasPremiumFeature.@@ -86,7 +111,9 @@ export function initializePlugin() {PLUGIN_DATA_PERMISSIONS.permissionsPayloadExtraSelectors.push((state) => {const sandboxes = getDraftPolicies(state);- const modifiedGroupIds = _.uniq(sandboxes.map((sb) => sb.group_id));+ const modifiedGroupIds = _.uniq(+ sandboxes.map((sb) => String(sb.group_id)),+ );return [{ sandboxes }, modifiedGroupIds];});diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/index.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/sandboxes/index.unit.spec.tsxnew file mode 100644index 00000000000..88ecb4f35b3--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/index.unit.spec.tsx@@ -0,0 +1,80 @@+import { PLUGIN_DATA_PERMISSIONS, reinitialize } from "metabase/plugins";+import { createMockState } from "metabase/redux/store/mocks";+import { hasPremiumFeature } from "metabase-enterprise/settings";+import type { GroupTableAccessPolicy } from "metabase-types/api";++import { initializePlugin } from "./index";++jest.mock("metabase-enterprise/settings", () => ({+ hasPremiumFeature: jest.fn(),+}));++// jest.mock above replaces the real implementation with a mock+const mockHasPremiumFeature = hasPremiumFeature as jest.MockedFunction<+ typeof hasPremiumFeature+>;++const createPolicy = (+ groupId: number,+ tableId: number,+): GroupTableAccessPolicy => ({+ id: tableId,+ group_id: groupId,+ table_id: tableId,+ card_id: null,+ attribute_remappings: {},+ permission_id: null,+});++const createSandboxesState = (policies: GroupTableAccessPolicy[]) => ({+ ...createMockState(),+ plugins: {+ shared: { attributes: null },+ sandboxingPlugin: {+ groupTableAccessPolicies: Object.fromEntries(+ policies.map((policy) => [+ `${policy.group_id}:${policy.table_id}`,+ policy,+ ]),+ ),+ },+ },+});++describe("sandboxes initializePlugin", () => {+ beforeAll(() => {+ mockHasPremiumFeature.mockImplementation(+ (feature) => feature === "sandboxes",+ );+ initializePlugin();+ });++ afterAll(() => {+ reinitialize();+ });++ it("reports draft policies and their group ids as strings in the permissions save payload", () => {+ const [selector] = PLUGIN_DATA_PERMISSIONS.permissionsPayloadExtraSelectors;+ const policies = [+ createPolicy(2, 5),+ createPolicy(2, 6),+ createPolicy(3, 7),+ ];++ const [extraData, modifiedGroupIds] = selector(+ createSandboxesState(policies),+ );++ expect(extraData).toEqual({ sandboxes: policies });+ // string ids are required to match the save payload's string-keyed+ // modified-group bookkeeping in getModifiedGroupsPermissionsGraphParts+ expect(modifiedGroupIds).toEqual(["2", "3"]);+ });++ it("reports policy drafts as pending changes", () => {+ const [hasChanges] = PLUGIN_DATA_PERMISSIONS.hasChanges;++ expect(hasChanges(createSandboxesState([createPolicy(2, 5)]))).toBe(true);+ expect(hasChanges(createSandboxesState([]))).toBe(false);+ });+});diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/selectors.ts b/enterprise/frontend/src/metabase-enterprise/sandboxes/selectors.tsindex c94c47bbe88..43cf5d28f40 100644--- a/enterprise/frontend/src/metabase-enterprise/sandboxes/selectors.ts+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/selectors.ts@@ -1,19 +1,26 @@import { createSelector } from "@reduxjs/toolkit";+import type { State } from "metabase/redux/store";+import type { GroupTableAccessPolicyParams, SandboxesState } from "./types";import { getPolicyKeyFromParams } from "./utils";+const getPluginState = (state: State) =>+ // the plugin slice is registered by initializePlugin, so it is present+ // whenever these selectors run+ (state as SandboxesState).plugins.sandboxingPlugin;+export const getGroupTableAccessPolicy = (- state: SandboxesState,+ state: State,{ params }: { params: GroupTableAccessPolicyParams },) => {const key = getPolicyKeyFromParams(params);- return state.plugins.sandboxingPlugin.groupTableAccessPolicies[key];+ return getPluginState(state).groupTableAccessPolicies[key];};-export const getDraftPolicies = (state: SandboxesState) => {- return Object.values(state.plugins.sandboxingPlugin.groupTableAccessPolicies);+export const getDraftPolicies = (state: State) => {+ return Object.values(getPluginState(state).groupTableAccessPolicies);};export const hasPolicyChanges = createSelector(diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/types.ts b/enterprise/frontend/src/metabase-enterprise/sandboxes/types.tsindex 5c2ec5f442d..fea224dc73b 100644--- a/enterprise/frontend/src/metabase-enterprise/sandboxes/types.ts+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/types.ts@@ -1,12 +1,25 @@+import type { UpdateDataPermissionParams } from "metabase/admin/permissions/permissions";import type { EnterpriseSharedState } from "metabase-enterprise/shared/reducer";import type { EnterpriseState } from "metabase-enterprise/shared/types";import type {+ GroupId,GroupTableAccessPolicy,ParameterTarget,+ TableId,UserAttributeKey,} from "metabase-types/api";-export type GroupTableAccessPolicyParams = { groupId: string; tableId: string };+export type RawGroupTableAccessPolicyParams = Pick<+ UpdateDataPermissionParams,+ "entityId" | "groupId" | "view"+>;++// route-param strings and UPDATE_DATA_PERMISSION payload numbers template+// into the same policy key+export type GroupTableAccessPolicyParams = {+ groupId: GroupId | string;+ tableId: TableId | string;+};export interface SandboxesState extends EnterpriseState {plugins: {diff --git a/frontend/src/metabase/admin/permissions/permissions.ts b/frontend/src/metabase/admin/permissions/permissions.tsindex c3b09193caa..f5da3223db3 100644--- a/frontend/src/metabase/admin/permissions/permissions.ts+++ b/frontend/src/metabase/admin/permissions/permissions.ts@@ -209,7 +209,7 @@ export interface UpdateDataPermissionParams {entityId: PermissionEntityId;view: "database" | "group";}-interface UpdateDataPermissionPayload {+export interface UpdateDataPermissionPayload {groupId: GroupId;permissionInfo: Pick<PermissionSectionConfig,@@ -289,7 +289,7 @@ export const saveDataPermissions = createThunkAction(const advancedPermissions =PLUGIN_DATA_PERMISSIONS.permissionsPayloadExtraSelectors.reduce<{modifiedGroupIds: string[];- permissions: Record<string, undefined | { group_id: string }[]>;+ permissions: Record<string, undefined | { group_id: number }[]>;}>((data, selector) => {const [extraData, modifiedGroupIds] = selector(state);diff --git a/frontend/src/metabase/admin/permissions/types.ts b/frontend/src/metabase/admin/permissions/types.tsindex 53361be27d9..a773b563f28 100644--- a/frontend/src/metabase/admin/permissions/types.ts+++ b/frontend/src/metabase/admin/permissions/types.ts@@ -1,9 +1,11 @@-import type { ThunkDispatch, UnknownAction } from "@reduxjs/toolkit";import type { ReactElement, ReactNode } from "react";-import type { State } from "metabase/redux/store";-import type { ColorName } from "metabase/ui/colors/types";-import type { GroupId, IconName } from "metabase-types/api";+import type {+ PermissionAction,+ PermissionConfirmationProps,+ PermissionOption,+ PostActionFunction,+} from "metabase/plugins";import {DataPermission,DataPermissionValue,@@ -11,6 +13,12 @@ import {} from "metabase-types/api/permissions";export { DataPermission, DataPermissionValue };+export type {+ PermissionAction,+ PermissionConfirmationProps,+ PermissionOption,+ PostActionFunction,+};export type GroupRouteParams = {groupId?: number;@@ -80,39 +88,6 @@ export type PermissionsGraphDiff = {groups: Record<number | string, GroupPermissionsDiff>;};-export interface PermissionOption {- label: string;- value: DataPermissionValue;- icon: IconName;- iconColor: ColorName;-}--export interface PermissionAction {- label: string;- icon: IconName;- iconColor: ColorName;- actionCreator: (- entityId: PermissionEntityId | undefined,- id: number,- view: "database" | "group",- ) => ThunkDispatch<State, unknown, UnknownAction>;-}--export interface PermissionConfirmationProps {- title: string;- message: string | ReactNode;- confirmButtonText: string;- cancelButtonText: string;-}--type PostActionFunction = (- entityId: PermissionEntityId,- groupId: GroupId,- view: "database" | "group",- value: DataPermissionValue,- getState: () => State,-) => void;-export type PermissionSectionConfig = {permission: DataPermission;type: DataPermissionType;diff --git a/frontend/src/metabase/plugins/index.ts b/frontend/src/metabase/plugins/index.tsindex 7c5a123d5d4..a5b53abf8f8 100644--- a/frontend/src/metabase/plugins/index.ts+++ b/frontend/src/metabase/plugins/index.ts@@ -127,6 +127,10 @@ export {PLUGIN_ADMIN_PERMISSIONS_TABS,PLUGIN_APPLICATION_PERMISSIONS,PLUGIN_GROUP_MANAGERS,+ type PermissionAction,+ type PermissionConfirmationProps,+ type PermissionOption,+ type PostActionFunction,} from "./oss/permissions";export { PLUGIN_REMOTE_SYNC } from "./oss/remote-sync";export {diff --git a/frontend/src/metabase/plugins/oss/auth.ts b/frontend/src/metabase/plugins/oss/auth.tsindex d8ff8e28933..24d5cade035 100644--- a/frontend/src/metabase/plugins/oss/auth.ts+++ b/frontend/src/metabase/plugins/oss/auth.ts@@ -1,5 +1,7 @@+import type { ComponentType } from "react";+import { PluginPlaceholder } from "metabase/plugins/components/PluginPlaceholder";-import type { User } from "metabase-types/api";+import type { User, UserId } from "metabase-types/api";import type { GetAuthProviders } from "../types";@@ -36,7 +38,9 @@ const getDefaultPluginIsPasswordUser = (): ((user: User) => boolean)[] => [];export const PLUGIN_IS_PASSWORD_USER = getDefaultPluginIsPasswordUser();-const getDefaultPluginAdminUserFormFields = () => ({+const getDefaultPluginAdminUserFormFields = (): {+ FormLoginAttributes: ComponentType<{ userId?: UserId | null }>;+} => ({FormLoginAttributes: PluginPlaceholder,});diff --git a/frontend/src/metabase/plugins/oss/core.ts b/frontend/src/metabase/plugins/oss/core.tsindex 8a42eac7da6..a9bd9a9455e 100644--- a/frontend/src/metabase/plugins/oss/core.ts+++ b/frontend/src/metabase/plugins/oss/core.ts@@ -150,6 +150,7 @@ export const PLUGIN_DASHBOARD_SUBSCRIPTION_PARAMETERS_SECTION_OVERRIDE =getDefaultDashboardSubscriptionParametersSectionOverride();const getDefaultReducers = () => ({+ advancedPermissionsPlugin: () => null,applicationPermissionsPlugin: () => null,sandboxingPlugin: () => null,shared: () => null,@@ -158,6 +159,7 @@ const getDefaultReducers = () => ({});export const PLUGIN_REDUCERS: {+ advancedPermissionsPlugin: any;applicationPermissionsPlugin: any;sandboxingPlugin: any;shared: any;diff --git a/frontend/src/metabase/plugins/oss/permissions.ts b/frontend/src/metabase/plugins/oss/permissions.tsindex c1a04eb33bd..27b54a26cfd 100644--- a/frontend/src/metabase/plugins/oss/permissions.ts+++ b/frontend/src/metabase/plugins/oss/permissions.ts@@ -1,15 +1,18 @@-import type { ReactNode } from "react";+import type { Action, ThunkDispatch } from "@reduxjs/toolkit";+import type { ReactElement, ReactNode } from "react";import type { State } from "metabase/redux/store";import { getUserIsAdmin } from "metabase/selectors/user";+import type { ColorName } from "metabase/ui/colors/types";import type Database from "metabase-lib/v1/metadata/Database";import type {DataPermission,DatabaseEntityId,Dataset,Group,- GroupPermissions,+ GroupId,GroupsPermissions,+ IconName,PermissionEntityId,PermissionSubject,SpecialGroupType,@@ -19,30 +22,82 @@ import { DataPermissionValue } from "metabase-types/api";import type { PluginGroupManagersType } from "../types";-const getDefaultAdminPermissionsDatabaseRoutes = () => [];-const getDefaultAdminPermissionsDatabaseGroupRoutes = () => [];-const getDefaultAdminPermissionsDatabasePostActions = () => ({+// These describe the entries EE plugins contribute to the admin permissions+// editor. They live here (not in metabase/admin) because shared plugin code+// cannot import from feature modules; metabase/admin/permissions/types+// re-exports them.+export interface PermissionOption {+ label: string;+ value: DataPermissionValue;+ icon: IconName;+ iconColor: ColorName;+}++export interface PermissionAction {+ label: string;+ icon: IconName;+ iconColor: ColorName;+ actionCreator: (+ entityId: PermissionEntityId | undefined,+ groupId: GroupId,+ view: "database" | "group",+ ) => Action;+}++export interface PermissionConfirmationProps {+ title: string;+ message: ReactNode;+ confirmButtonText: string;+ cancelButtonText: string;+}++export type PostActionFunction = (+ entityId: PermissionEntityId,+ groupId: GroupId,+ view: "database" | "group",+ value: DataPermissionValue,+ getState: () => State,+) =>+ | Action+ | ((+ dispatch: ThunkDispatch<State, unknown, Action>,+ getState: () => State,+ ) => unknown)+ | void;++const getDefaultAdminPermissionsDatabaseRoutes = (): ReactElement[] => [];+const getDefaultAdminPermissionsDatabaseGroupRoutes = (): ReactElement[] => [];+const getDefaultAdminPermissionsDatabasePostActions = (): {+ impersonated: PostActionFunction | null;+} => ({impersonated: null,});-const getDefaultAdminPermissionsDatabaseActions = () => ({+const getDefaultAdminPermissionsDatabaseActions = (): {+ impersonated: PermissionAction[];+} => ({impersonated: [],});-const getDefaultAdminPermissionsTableOptions = () => [];-const getDefaultAdminPermissionsTableRoutes = () => [];-const getDefaultAdminPermissionsTableGroupRoutes = () => [];-const getDefaultAdminPermissionsTableFieldsOptions = () => [];+const getDefaultAdminPermissionsTableOptions = (): PermissionOption[] => [];+const getDefaultAdminPermissionsTableRoutes = (): ReactElement[] => [];+const getDefaultAdminPermissionsTableGroupRoutes = (): ReactElement[] => [];+const getDefaultAdminPermissionsTableFieldsOptions =+ (): PermissionOption[] => [];const getDefaultAdminPermissionsTableFieldsConfirmations = (): Array<(_permissions: GroupsPermissions,_groupId: number,_entityId: PermissionEntityId,_value: DataPermissionValue,- ) => any+ ) => PermissionConfirmationProps | undefined> => [];-const getDefaultAdminPermissionsTableFieldsActions = () => ({+const getDefaultAdminPermissionsTableFieldsActions = (): {+ sandboxed: PermissionAction[];+} => ({sandboxed: [],});-const getDefaultAdminPermissionsTableFieldsPostAction = () => ({+const getDefaultAdminPermissionsTableFieldsPostAction = (): {+ sandboxed: PostActionFunction | null;+} => ({sandboxed: null,});@@ -79,7 +134,7 @@ const getDefaultDataPermissions = () => ({export const PLUGIN_DATA_PERMISSIONS: {permissionsPayloadExtraSelectors: ((state: State,- ) => [Record<string, undefined | { group_id: string }[]>, string[]])[];+ ) => [Record<string, undefined | { group_id: number }[]>, string[]])[];hasChanges: ((state: State) => boolean)[];shouldRestrictNativeQueryPermissions: (permissions: GroupsPermissions,@@ -95,10 +150,10 @@ export const PLUGIN_DATA_PERMISSIONS: {permissions: GroupsPermissions,groupId: number,entityId: PermissionEntityId,- value: any,+ value: DataPermissionValue,database: Database,permission: DataPermission,- ) => GroupPermissions)+ ) => GroupsPermissions)| null;} = getDefaultDataPermissions();@@ -111,13 +166,21 @@ export const PLUGIN_ADMIN_USER_MENU_ITEMS = getDefaultAdminUserMenuItems();export const PLUGIN_ADMIN_USER_MENU_ROUTES = getDefaultAdminUserMenuRoutes();const getDefaultAdvancedPermissions = () => ({- addDatabasePermissionOptions: (permissions: any[], _database: Database) =>- permissions,- addSchemaPermissionOptions: (permissions: any[], _value: string) =>- permissions,- addTablePermissionOptions: (permissions: any[], _value: string) =>- permissions,- getDatabaseLimitedAccessPermission: (_value: string) => null,+ addDatabasePermissionOptions: (+ permissions: PermissionOption[],+ _database: Database,+ ) => permissions,+ addSchemaPermissionOptions: (+ permissions: PermissionOption[],+ _value: string,+ ) => permissions,+ addTablePermissionOptions: (+ permissions: PermissionOption[],+ _value: string,+ ) => permissions,+ getDatabaseLimitedAccessPermission: (+ _value: string,+ ): DataPermissionValue | null => null,isAccessPermissionDisabled: (_value: string,_subject: "schemas" | "tables" | "fields",