Skip to content

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

Add a permissions modal for data actions (#85451)

Alexander Polyankine67ee106f9b6
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/components/CollectionPermissionsModal/CollectionPermissionsModal.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/components/CollectionPermissionsModal/CollectionPermissionsModal.tsx
deleted file mode 100644
index 1eb72f5d23d..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/components/CollectionPermissionsModal/CollectionPermissionsModal.tsx
+++ /dev/null
@@ -1,33 +0,0 @@
-import { skipToken, useListCollectionsQuery } from "metabase/api";
-import { CollectionPermissionsModal as CollectionPermissionsModalBase } from "metabase/permissions";
-import type { CollectionPermissionsModalProps } from "metabase/plugins";
-import { Modal } from "metabase/ui";
-
-export function CollectionPermissionsModal({
- opened,
- collectionId,
- namespace,
- onClose,
-}: CollectionPermissionsModalProps) {
- useListCollectionsQuery(
- namespace === "snippets" || namespace === "data-actions"
- ? { namespace }
- : skipToken,
- );
-
- return (
- <Modal
- opened={opened}
- onClose={onClose}
- size="lg"
- withCloseButton={false}
- padding={0}
- >
- <CollectionPermissionsModalBase
- params={{ slug: String(collectionId) }}
- namespace={namespace ?? null}
- onClose={onClose}
- />
- </Modal>
- );
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/components/CollectionPermissionsModal/index.ts b/enterprise/frontend/src/metabase-enterprise/data-studio/library/components/CollectionPermissionsModal/index.ts
deleted file mode 100644
index ffa5b20562e..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/components/CollectionPermissionsModal/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { CollectionPermissionsModal } from "./CollectionPermissionsModal";
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/index.ts b/enterprise/frontend/src/metabase-enterprise/data-studio/library/index.ts
index 4d9ff5a3531..1efdb15ca15 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/index.ts
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/index.ts
@@ -3,7 +3,6 @@ import { PLUGIN_DATA_REFERENCE } from "metabase/querying/components/DataReferenc
import { useGetLibraryCollectionQuery } from "metabase-enterprise/api";
import { hasPremiumFeature } from "metabase-enterprise/settings";
-import { CollectionPermissionsModal } from "./components/CollectionPermissionsModal";
import { CreateLibraryModal } from "./components/CreateLibraryModal";
import { DataReferenceLibraryPane } from "./components/DataReferenceLibraryPane";
import { PublishTablesModal } from "./components/PublishTablesModal";
@@ -37,7 +36,6 @@ export function initializePlugin() {
getEntityPickerSyntheticLibraryItem;
PLUGIN_DATA_REFERENCE.LibraryPane = DataReferenceLibraryPane;
PLUGIN_LIBRARY.CreateLibraryModal = CreateLibraryModal;
- PLUGIN_LIBRARY.CollectionPermissionsModal = CollectionPermissionsModal;
PLUGIN_LIBRARY.PublishTablesModal = PublishTablesModal;
PLUGIN_LIBRARY.UnpublishTablesModal = UnpublishTablesModal;
PLUGIN_LIBRARY.useGetLibraryCollectionQuery = useGetLibraryCollectionQuery;
diff --git a/enterprise/frontend/src/metabase-enterprise/snippets/components/SnippetCollectionPermissionsModal/SnippetCollectionPermissionsModal.tsx b/enterprise/frontend/src/metabase-enterprise/snippets/components/SnippetCollectionPermissionsModal/SnippetCollectionPermissionsModal.tsx
deleted file mode 100644
index 6c40e351983..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/snippets/components/SnippetCollectionPermissionsModal/SnippetCollectionPermissionsModal.tsx
+++ /dev/null
@@ -1,28 +0,0 @@
-import { useListCollectionsQuery } from "metabase/api";
-import { CollectionPermissionsModal } from "metabase/permissions";
-import type { SnippetCollectionPermissionsModalProps } from "metabase/plugins";
-import { Modal } from "metabase/ui";
-
-export function SnippetCollectionPermissionsModal({
- opened,
- collectionId,
- onClose,
-}: SnippetCollectionPermissionsModalProps) {
- useListCollectionsQuery({ namespace: "snippets" });
-
- return (
- <Modal
- opened={opened}
- onClose={onClose}
- size="lg"
- withCloseButton={false}
- padding={0}
- >
- <CollectionPermissionsModal
- params={{ slug: String(collectionId) }}
- onClose={onClose}
- namespace="snippets"
- />
- </Modal>
- );
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/snippets/components/SnippetCollectionPermissionsModal/index.ts b/enterprise/frontend/src/metabase-enterprise/snippets/components/SnippetCollectionPermissionsModal/index.ts
deleted file mode 100644
index 031c4e30d08..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/snippets/components/SnippetCollectionPermissionsModal/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { SnippetCollectionPermissionsModal } from "./SnippetCollectionPermissionsModal";
diff --git a/enterprise/frontend/src/metabase-enterprise/snippets/index.tsx b/enterprise/frontend/src/metabase-enterprise/snippets/index.tsx
index 7a224c2656a..8c535010438 100644
--- a/enterprise/frontend/src/metabase-enterprise/snippets/index.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/snippets/index.tsx
@@ -13,7 +13,6 @@ import { hasPremiumFeature } from "metabase-enterprise/settings";
import { CollectionRow } from "./components/CollectionRow";
import { MoveSnippetModal } from "./components/MoveSnippetModal";
import { SnippetCollectionHeaderMenu } from "./components/SnippetCollectionHeaderMenu";
-import { SnippetCollectionPermissionsModal } from "./components/SnippetCollectionPermissionsModal";
import { SnippetCollectionPickerModal } from "./components/SnippetCollectionPickerModal";
/**
@@ -24,8 +23,6 @@ export function initializePlugin() {
// Add new menu option
PLUGIN_SNIPPET_FOLDERS.isEnabled = true;
PLUGIN_SNIPPET_FOLDERS.CollectionPickerModal = SnippetCollectionPickerModal;
- PLUGIN_SNIPPET_FOLDERS.CollectionPermissionsModal =
- SnippetCollectionPermissionsModal;
PLUGIN_SNIPPET_FOLDERS.MoveSnippetModal = MoveSnippetModal;
PLUGIN_SNIPPET_SIDEBAR_PLUS_MENU_OPTIONS.push((snippetSidebar) => ({
icon: "folder",
diff --git a/frontend/src/metabase/common/collections/components/CollectionRowMenu/CollectionRowMenu.tsx b/frontend/src/metabase/common/collections/components/CollectionRowMenu/CollectionRowMenu.tsx
index 59e76196991..17d097ea503 100644
--- a/frontend/src/metabase/common/collections/components/CollectionRowMenu/CollectionRowMenu.tsx
+++ b/frontend/src/metabase/common/collections/components/CollectionRowMenu/CollectionRowMenu.tsx
@@ -38,20 +38,25 @@ export function CollectionRowMenu({
PLUGIN_REMOTE_SYNC.getIsRemoteSyncReadOnly,
);
- const showPermissionsOption =
- isAdmin &&
- (PLUGIN_LIBRARY.isEnabled || PLUGIN_SNIPPET_FOLDERS.isEnabled) &&
- collection.namespace !== "transforms" &&
- collection.namespace !== "data-actions";
+ const hasPermissionsModal = match(collection.namespace)
+ .with("data-actions", () => true)
+ .with("transforms", () => false)
+ .with("snippets", () => PLUGIN_SNIPPET_FOLDERS.isEnabled)
+ .otherwise(() => PLUGIN_LIBRARY.isEnabled);
+ const showPermissionsOption = isAdmin && hasPermissionsModal;
const isRoot = isRootCollection(collection);
+ const canEdit = collection.can_write && !remoteSyncReadOnly;
- if (!collection.can_write || remoteSyncReadOnly) {
- return null;
+ if (collection.archived) {
+ return canEdit ? (
+ <UnarchiveCollectionButton collection={collection} />
+ ) : null;
}
- if (collection.archived) {
- return <UnarchiveCollectionButton collection={collection} />;
+ const showEditOptions = canEdit && !isRoot;
+ if (!showEditOptions && !showPermissionsOption) {
+ return null;
}
const optionsLabel = match(collection.namespace)
@@ -77,7 +82,7 @@ export function CollectionRowMenu({
</Tooltip>
</Menu.Target>
<Menu.Dropdown>
- {!isRoot && (
+ {showEditOptions && (
<Menu.Item
leftSection={<Icon name="pencil" />}
onClick={() => onOpenModal({ type: "edit", collection })}
@@ -93,7 +98,7 @@ export function CollectionRowMenu({
{t`Change permissions`}
</Menu.Item>
)}
- {!isRoot && (
+ {showEditOptions && (
<Menu.Item
leftSection={<Icon name="archive" />}
onClick={() =>
diff --git a/frontend/src/metabase/common/collections/components/CollectionRowMenu/CollectionRowMenu.unit.spec.tsx b/frontend/src/metabase/common/collections/components/CollectionRowMenu/CollectionRowMenu.unit.spec.tsx
index 65b3bbaa082..3c5be72f164 100644
--- a/frontend/src/metabase/common/collections/components/CollectionRowMenu/CollectionRowMenu.unit.spec.tsx
+++ b/frontend/src/metabase/common/collections/components/CollectionRowMenu/CollectionRowMenu.unit.spec.tsx
@@ -72,12 +72,14 @@ const setup = ({
"token-features": createMockTokenFeatures({
library: true,
remote_sync: true,
+ snippet_collections: true,
}),
}),
currentUser: createMockUser({ is_superuser: isAdmin }),
});
setupEnterpriseOnlyPlugin("library");
setupEnterpriseOnlyPlugin("remote_sync");
+ setupEnterpriseOnlyPlugin("snippets");
return renderWithProviders(
<CollectionRowMenusWithModal
@@ -116,20 +118,36 @@ describe("CollectionRowMenu", () => {
expect(queryMenuItem(/Change permissions/)).not.toBeInTheDocument();
});
- it("renders nothing if collection is not writable", () => {
- setup({ collection: { can_write: false } });
+ it("renders nothing for non-admins if collection is not writable", () => {
+ setup({ collection: { can_write: false }, isAdmin: false });
expect(
screen.queryByRole("button", { name: "Collection options" }),
).not.toBeInTheDocument();
});
- it("renders nothing if remote sync is set to read-only", () => {
- setup({ remoteSyncType: "read-only" });
+ it("renders nothing for non-admins if remote sync is set to read-only", () => {
+ setup({ remoteSyncType: "read-only", isAdmin: false });
expect(
screen.queryByRole("button", { name: "Collection options" }),
).not.toBeInTheDocument();
});
+ it.each([
+ { namespace: "snippets", label: "Snippet folder options" },
+ { namespace: "data-actions", label: "Folder options" },
+ ] as const)(
+ "renders only the permissions option for $namespace folders if remote sync is set to read-only",
+ async ({ namespace, label }) => {
+ setup({ remoteSyncType: "read-only", collection: { namespace } });
+
+ await userEvent.click(screen.getByRole("button", { name: label }));
+
+ expect(getMenuItem(/Change permissions/)).toBeInTheDocument();
+ expect(queryMenuItem(/Edit folder details/)).not.toBeInTheDocument();
+ expect(queryMenuItem(/Archive/)).not.toBeInTheDocument();
+ },
+ );
+
it("uses snippet folder labels for snippet collections", async () => {
setup({ collection: { namespace: "snippets" } });
@@ -148,15 +166,14 @@ describe("CollectionRowMenu", () => {
expect(queryMenuItem(/Change permissions/)).not.toBeInTheDocument();
});
- it("does not render permissions option for data actions folders", async () => {
+ it("renders the permissions option for data actions folders", async () => {
setup({ collection: { namespace: "data-actions" } });
await userEvent.click(
screen.getByRole("button", { name: "Folder options" }),
);
- expect(getMenuItem(/Edit folder details/)).toBeInTheDocument();
- expect(queryMenuItem(/Change permissions/)).not.toBeInTheDocument();
+ expect(getMenuItem(/Change permissions/)).toBeInTheDocument();
});
it("archives a collection after confirmation", async () => {
diff --git a/frontend/src/metabase/common/collections/components/CollectionRowModal/CollectionRowModal.tsx b/frontend/src/metabase/common/collections/components/CollectionRowModal/CollectionRowModal.tsx
index 1befd41cf7a..44234705141 100644
--- a/frontend/src/metabase/common/collections/components/CollectionRowModal/CollectionRowModal.tsx
+++ b/frontend/src/metabase/common/collections/components/CollectionRowModal/CollectionRowModal.tsx
@@ -6,7 +6,7 @@ import { useUpdateCollectionMutation } from "metabase/api";
import { useInvalidateCollectionItems } from "metabase/common/collections/hooks";
import { ConfirmModal } from "metabase/common/components/ConfirmModal";
import { useMetadataToasts } from "metabase/common/hooks";
-import { PLUGIN_LIBRARY, PLUGIN_SNIPPET_FOLDERS } from "metabase/plugins";
+import { CollectionPermissionsModal } from "metabase/permissions";
import type { Collection } from "metabase-types/api";
import { EditCollectionModal } from "./EditCollectionModal";
@@ -58,7 +58,11 @@ export function CollectionRowModal({
<EditCollectionModal collection={collection} onClose={handleClose} />
))
.with({ type: "permissions" }, ({ collection }) => (
- <PermissionsModal collection={collection} onClose={handleClose} />
+ <CollectionPermissionsModal
+ params={{ slug: String(collection.id) }}
+ namespace={collection.namespace ?? null}
+ onClose={handleClose}
+ />
))
.with({ type: "archive" }, ({ collection, customArchiveMessage }) => (
<ArchiveCollectionModal
@@ -70,32 +74,6 @@ export function CollectionRowModal({
.exhaustive();
}
-type PermissionsModalProps = {
- collection: Collection;
- onClose: () => void;
-};
-
-function PermissionsModal({ collection, onClose }: PermissionsModalProps) {
- if (collection.namespace === "snippets") {
- return (
- <PLUGIN_SNIPPET_FOLDERS.CollectionPermissionsModal
- opened
- collectionId={collection.id}
- onClose={onClose}
- />
- );
- }
-
- return (
- <PLUGIN_LIBRARY.CollectionPermissionsModal
- opened
- collectionId={collection.id}
- namespace={collection.namespace}
- onClose={onClose}
- />
- );
-}
-
type ArchiveCollectionModalProps = {
collection: Collection;
customArchiveMessage?: string;
diff --git a/frontend/src/metabase/data-studio/actions/pages/ActionListPage/ActionListPage.tsx b/frontend/src/metabase/data-studio/actions/pages/ActionListPage/ActionListPage.tsx
index 237142c8bb0..031fb4469da 100644
--- a/frontend/src/metabase/data-studio/actions/pages/ActionListPage/ActionListPage.tsx
+++ b/frontend/src/metabase/data-studio/actions/pages/ActionListPage/ActionListPage.tsx
@@ -49,6 +49,7 @@ export function ActionListPage() {
const canCreate = isAdmin && canCreateActions(databases);
const {
tree,
+ rootCollection,
isLoading: isLoadingActions,
error: actionsError,
} = useBuildActionTree({
@@ -86,6 +87,7 @@ export function ActionListPage() {
to: Urls.dataStudioArchivedActions(),
},
],
+ permissionsCollection: rootCollection,
onOpenModal: setCollectionModal,
}}
renderRowMenu={renderRowMenu}
diff --git a/frontend/src/metabase/data-studio/actions/pages/ActionListPage/ActionListPage.unit.spec.tsx b/frontend/src/metabase/data-studio/actions/pages/ActionListPage/ActionListPage.unit.spec.tsx
index 13990d6428e..23175be3fa6 100644
--- a/frontend/src/metabase/data-studio/actions/pages/ActionListPage/ActionListPage.unit.spec.tsx
+++ b/frontend/src/metabase/data-studio/actions/pages/ActionListPage/ActionListPage.unit.spec.tsx
@@ -5,8 +5,10 @@ import {
setupActionsEndpoints,
setupCollectionByIdEndpoint,
setupCollectionItemsEndpoint,
+ setupCollectionPermissionsGraphEndpoint,
setupCollectionsEndpoints,
setupDatabasesEndpoints,
+ setupGroupsEndpoint,
} from "__support__/server-mocks";
import { mockSettings } from "__support__/settings";
import { createMockState } from "__support__/state";
@@ -17,7 +19,11 @@ import {
within,
} from "__support__/ui";
import { Route } from "metabase/router";
-import type { Database, WritebackAction } from "metabase-types/api";
+import type {
+ Database,
+ EnterpriseSettings,
+ WritebackAction,
+} from "metabase-types/api";
import {
createMockCollection,
createMockDatabase,
@@ -32,7 +38,7 @@ type SetupOpts = {
databases?: Database[];
actions?: WritebackAction[];
isAdmin?: boolean;
- hasLibrary?: boolean;
+ remoteSyncType?: EnterpriseSettings["remote-sync-type"];
};
const ACTIONS_DATABASE = createMockDatabase({
@@ -44,7 +50,7 @@ function setup({
databases = [ACTIONS_DATABASE],
actions = [],
isAdmin = true,
- hasLibrary = false,
+ remoteSyncType,
}: SetupOpts) {
setupDatabasesEndpoints(databases);
setupActionsEndpoints(actions);
@@ -58,18 +64,23 @@ function setup({
],
});
- if (hasLibrary) {
- setupEnterpriseOnlyPlugin("library");
+ const state = createMockState({
+ settings: mockSettings({
+ "remote-sync-type": remoteSyncType,
+ "remote-sync-enabled": remoteSyncType != null,
+ "token-features": createMockTokenFeatures({
+ remote_sync: remoteSyncType != null,
+ }),
+ }),
+ currentUser: createMockUser({ is_superuser: isAdmin }),
+ });
+ if (remoteSyncType != null) {
+ setupEnterpriseOnlyPlugin("remote_sync");
}
renderWithProviders(<Route path="/" element={<ActionListPage />} />, {
withRouter: true,
- storeInitialState: createMockState({
- currentUser: createMockUser({ is_superuser: isAdmin }),
- settings: mockSettings({
- "token-features": createMockTokenFeatures({ library: hasLibrary }),
- }),
- }),
+ storeInitialState: state,
});
}
@@ -158,8 +169,30 @@ describe("ActionListPage", () => {
).toBeInTheDocument();
});
- it("does not offer changing the permissions of data actions", async () => {
- setup({ hasLibrary: true });
+ it.each([undefined, "read-only"] as const)(
+ "opens the permissions of the data actions root from the page menu with remote sync %s",
+ async (remoteSyncType) => {
+ setupGroupsEndpoint([]);
+ setupCollectionPermissionsGraphEndpoint({ revision: 1, groups: {} });
+ setup({ remoteSyncType });
+
+ await userEvent.click(
+ await screen.findByRole("button", { name: "Data action options" }),
+ );
+ await userEvent.click(
+ screen.getByRole("menuitem", { name: /Change permissions/ }),
+ );
+
+ expect(
+ await within(screen.getByRole("dialog")).findByRole("heading", {
+ name: "Permissions for Root",
+ }),
+ ).toBeInTheDocument();
+ },
+ );
+
+ it("does not offer non-admins to change the permissions of data actions", async () => {
+ setup({ isAdmin: false });
await userEvent.click(
await screen.findByRole("button", { name: "Data action options" }),
diff --git a/frontend/src/metabase/data-studio/common/components/LibraryTreePage/LibraryPageMenu/LibraryPageMenu.tsx b/frontend/src/metabase/data-studio/common/components/LibraryTreePage/LibraryPageMenu/LibraryPageMenu.tsx
index f9b3ca0c02f..b2be6398770 100644
--- a/frontend/src/metabase/data-studio/common/components/LibraryTreePage/LibraryPageMenu/LibraryPageMenu.tsx
+++ b/frontend/src/metabase/data-studio/common/components/LibraryTreePage/LibraryPageMenu/LibraryPageMenu.tsx
@@ -3,7 +3,6 @@ import { t } from "ttag";
import type { CollectionRowModalState } from "metabase/common/collections/components/CollectionRowModal";
import { ForwardRefLink } from "metabase/common/components/Link";
import { getUserIsAdmin } from "metabase/current-user";
-import { PLUGIN_REMOTE_SYNC } from "metabase/plugins";
import { useSelector } from "metabase/redux";
import { Button, FixedSizeIcon, Icon, Menu } from "metabase/ui";
import type { Collection, IconName } from "metabase-types/api";
@@ -17,7 +16,7 @@ export type LibraryPageAction = {
export type LibraryPageMenuProps = {
label: string;
actions?: LibraryPageAction[];
- /** Admins get a Change permissions item for it, unless remote sync is read-only. */
+ /** Admins get a Change permissions item for it. */
permissionsCollection?: Collection;
onOpenModal: (modal: CollectionRowModalState) => void;
};
@@ -29,11 +28,9 @@ export function LibraryPageMenu({
onOpenModal,
}: LibraryPageMenuProps) {
const isAdmin = useSelector(getUserIsAdmin);
- const isRemoteSyncReadOnly = useSelector(
- PLUGIN_REMOTE_SYNC.getIsRemoteSyncReadOnly,
- );
- const editablePermissionsCollection =
- isAdmin && !isRemoteSyncReadOnly ? permissionsCollection : undefined;
+ const editablePermissionsCollection = isAdmin
+ ? permissionsCollection
+ : undefined;
if (editablePermissionsCollection == null && actions.length === 0) {
return null;
diff --git a/frontend/src/metabase/data-studio/snippets/pages/SnippetListPage/SnippetListPage.unit.spec.tsx b/frontend/src/metabase/data-studio/snippets/pages/SnippetListPage/SnippetListPage.unit.spec.tsx
index db863905658..487439eddda 100644
--- a/frontend/src/metabase/data-studio/snippets/pages/SnippetListPage/SnippetListPage.unit.spec.tsx
+++ b/frontend/src/metabase/data-studio/snippets/pages/SnippetListPage/SnippetListPage.unit.spec.tsx
@@ -19,7 +19,7 @@ import {
import { reinitialize } from "metabase/plugins";
import { Route } from "metabase/router";
import { dataStudioArchivedSnippets } from "metabase/urls";
-import type { User } from "metabase-types/api";
+import type { EnterpriseSettings, User } from "metabase-types/api";
import {
createMockCollection,
createMockNativeQuerySnippet,
@@ -32,13 +32,18 @@ import { SnippetListPage } from "./SnippetListPage";
type SetupOpts = {
isEnterprise?: boolean;
user?: Partial<User>;
+ remoteSyncType?: EnterpriseSettings["remote-sync-type"];
};
const NATIVE_WRITE_USER: Partial<User> = {
permissions: { can_create_native_queries: true },
};
-function setup({ isEnterprise = false, user = NATIVE_WRITE_USER }: SetupOpts) {
+function setup({
+ isEnterprise = false,
+ user = NATIVE_WRITE_USER,
+ remoteSyncType,
+}: SetupOpts) {
setupCollectionsEndpoints({
collections: [
createMockCollection({ id: "root", name: "Root", namespace: "snippets" }),
@@ -67,8 +72,11 @@ function setup({ isEnterprise = false, user = NATIVE_WRITE_USER }: SetupOpts) {
});
const state = createMockState({
settings: mockSettings({
+ "remote-sync-type": remoteSyncType,
+ "remote-sync-enabled": remoteSyncType != null,
"token-features": createMockTokenFeatures({
snippet_collections: isEnterprise,
+ remote_sync: remoteSyncType != null,
}),
}),
currentUser: createMockUser(user),
@@ -76,6 +84,9 @@ function setup({ isEnterprise = false, user = NATIVE_WRITE_USER }: SetupOpts) {
if (isEnterprise) {
setupEnterpriseOnlyPlugin("snippets");
}
+ if (remoteSyncType != null) {
+ setupEnterpriseOnlyPlugin("remote_sync");
+ }
renderWithProviders(<Route path="/" element={<SnippetListPage />} />, {
withRouter: true,
@@ -180,27 +191,31 @@ describe("SnippetListPage", () => {
).not.toBeInTheDocument();
});
- it("opens the permissions of the snippets collection from the page menu", async () => {
- setupGroupsEndpoint([]);
- setupCollectionPermissionsGraphEndpoint({ revision: 1, groups: {} });
- setup({
- isEnterprise: true,
- user: { ...NATIVE_WRITE_USER, is_superuser: true },
- });
-
- await userEvent.click(
- await screen.findByRole("button", { name: "Snippet options" }),
- );
- await userEvent.click(
- screen.getByRole("menuitem", { name: /Change permissions/ }),
- );
-
- expect(
- await within(screen.getByRole("dialog")).findByRole("heading", {
- name: "Permissions for Root",
- }),
- ).toBeInTheDocument();
- });
+ it.each([undefined, "read-only"] as const)(
+ "opens the permissions of the snippets collection from the page menu with remote sync %s",
+ async (remoteSyncType) => {
+ setupGroupsEndpoint([]);
+ setupCollectionPermissionsGraphEndpoint({ revision: 1, groups: {} });
+ setup({
+ isEnterprise: true,
+ user: { ...NATIVE_WRITE_USER, is_superuser: true },
+ remoteSyncType,
+ });
+
+ await userEvent.click(
+ await screen.findByRole("button", { name: "Snippet options" }),
+ );
+ await userEvent.click(
+ screen.getByRole("menuitem", { name: /Change permissions/ }),
+ );
+
+ expect(
+ await within(screen.getByRole("dialog")).findByRole("heading", {
+ name: "Permissions for Root",
+ }),
+ ).toBeInTheDocument();
+ },
+ );
it("offers only archived snippets without snippet folders", async () => {
setup({ user: { ...NATIVE_WRITE_USER, is_superuser: true } });
diff --git a/frontend/src/metabase/permissions/components/CollectionPermissionsModal/CollectionPermissionsModal.tsx b/frontend/src/metabase/permissions/components/CollectionPermissionsModal/CollectionPermissionsModal.tsx
index 0926a4bffef..d9a8785b979 100644
--- a/frontend/src/metabase/permissions/components/CollectionPermissionsModal/CollectionPermissionsModal.tsx
+++ b/frontend/src/metabase/permissions/components/CollectionPermissionsModal/CollectionPermissionsModal.tsx
@@ -2,14 +2,18 @@ import { useCallback, useEffect } from "react";
import { t } from "ttag";
import _ from "underscore";
-import { useListCollectionsTreeQuery } from "metabase/api";
+import {
+ skipToken,
+ useListCollectionsQuery,
+ useListCollectionsTreeQuery,
+} from "metabase/api";
import { isPersonalCollectionChild } from "metabase/common/collections/utils";
import { Link } from "metabase/common/components/Link";
import { ModalContent } from "metabase/common/components/ModalContent";
import CS from "metabase/css/core/index.css";
import { connect, useSelector } from "metabase/redux";
import type { State } from "metabase/redux/store";
-import { Button } from "metabase/ui";
+import { Button, Modal } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { Collection, CollectionNamespace } from "metabase-types/api";
@@ -69,7 +73,7 @@ const mapDispatchToProps = {
saveCollectionPermissions,
};
-interface CollectionPermissionsModalProps {
+interface CollectionPermissionsModalBodyProps {
permissionEditor: PermissionEditorType | null;
isDirty: boolean;
onClose: () => void;
@@ -82,7 +86,7 @@ interface CollectionPermissionsModalProps {
saveCollectionPermissions: (namespace: CollectionNamespace) => void;
}
-const CollectionPermissionsModal = ({
+const CollectionPermissionsModalBody = ({
permissionEditor,
isDirty,
onClose,
@@ -92,9 +96,10 @@ const CollectionPermissionsModal = ({
initialize,
updateCollectionPermission,
saveCollectionPermissions,
-}: CollectionPermissionsModalProps) => {
+}: CollectionPermissionsModalBodyProps) => {
const { data: collectionsList } =
useListCollectionsTreeQuery(collectionsQuery);
+ useListCollectionsQuery(namespace != null ? { namespace } : skipToken);
const originalPermissionsState = useSelector(
({ admin }) => admin.permissions.originalCollectionPermissions,
@@ -185,7 +190,34 @@ const CollectionPermissionsModal = ({
);
};
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default _.compose(connect(mapStateToProps, mapDispatchToProps))(
- CollectionPermissionsModal,
-);
+const ConnectedCollectionPermissionsModalBody = _.compose(
+ connect(mapStateToProps, mapDispatchToProps),
+)(CollectionPermissionsModalBody);
+
+type CollectionPermissionsModalProps = {
+ params: { slug?: string };
+ namespace?: CollectionNamespace;
+ onClose: () => void;
+};
+
+export function CollectionPermissionsModal({
+ params,
+ namespace,
+ onClose,
+}: CollectionPermissionsModalProps) {
+ return (
+ <Modal
+ opened
+ onClose={onClose}
+ withCloseButton={false}
+ padding={0}
+ size="lg"
+ >
+ <ConnectedCollectionPermissionsModalBody
+ params={params}
+ namespace={namespace}
+ onClose={onClose}
+ />
+ </Modal>
+ );
+}
diff --git a/frontend/src/metabase/permissions/components/CollectionPermissionsModal/CollectionPermissionsModal.unit.spec.tsx b/frontend/src/metabase/permissions/components/CollectionPermissionsModal/CollectionPermissionsModal.unit.spec.tsx
new file mode 100644
index 00000000000..999d6ad6571
--- /dev/null
+++ b/frontend/src/metabase/permissions/components/CollectionPermissionsModal/CollectionPermissionsModal.unit.spec.tsx
@@ -0,0 +1,102 @@
+import userEvent from "@testing-library/user-event";
+
+import {
+ setupCollectionPermissionsGraphEndpoint,
+ setupCollectionsEndpoints,
+ setupGroupsEndpoint,
+} from "__support__/server-mocks";
+import { renderWithProviders, screen, waitFor, within } from "__support__/ui";
+import type { CollectionNamespace } from "metabase-types/api";
+import {
+ createMockCollection,
+ createMockGroup,
+} from "metabase-types/api/mocks";
+
+import { CollectionPermissionsModal } from "./CollectionPermissionsModal";
+
+const ALL_USERS_GROUP = createMockGroup({
+ id: 1,
+ name: "All Users",
+ magic_group_type: "all-internal-users",
+});
+
+const ADMIN_GROUP = createMockGroup({
+ id: 2,
+ name: "Administrators",
+ magic_group_type: "admin",
+});
+
+function setup(namespace: CollectionNamespace) {
+ setupGroupsEndpoint([ALL_USERS_GROUP, ADMIN_GROUP]);
+ setupCollectionsEndpoints({
+ collections: [
+ createMockCollection({
+ id: "root",
+ name: "Root",
+ namespace,
+ }),
+ ],
+ });
+ setupCollectionPermissionsGraphEndpoint({
+ revision: 1,
+ groups: {
+ [ALL_USERS_GROUP.id]: { root: "read" },
+ [ADMIN_GROUP.id]: { root: "write" },
+ },
+ });
+ renderWithProviders(
+ <CollectionPermissionsModal
+ params={{ slug: "root" }}
+ namespace={namespace}
+ onClose={jest.fn()}
+ />,
+ );
+}
+
+async function getPermissionSelects() {
+ const dialog = await screen.findByRole("dialog");
+ await within(dialog).findByRole("heading", { name: "Permissions for Root" });
+ const [adminSelect, allUsersSelect] =
+ within(dialog).getAllByTestId("permissions-select");
+ return { dialog, allUsersSelect, adminSelect };
+}
+
+describe("CollectionPermissionsModal", () => {
+ it("should keep curate to admins in the data actions namespace and say why", async () => {
+ setup("data-actions");
+
+ const { dialog, allUsersSelect, adminSelect } =
+ await getPermissionSelects();
+ expect(adminSelect).toHaveTextContent("Curate");
+ expect(adminSelect).toHaveAttribute("aria-disabled", "true");
+
+ await userEvent.click(allUsersSelect);
+ expect(
+ within(screen.getByRole("listbox"))
+ .getAllByRole("option")
+ .map((option) => option.textContent),
+ ).toEqual(["No access"]);
+
+ await userEvent.hover(within(dialog).getByLabelText("info icon"));
+ await waitFor(() =>
+ expect(screen.getByRole("tooltip")).toHaveTextContent(
+ "Only administrators can create and edit data actions. Groups with View access can run them.",
+ ),
+ );
+ });
+
+ it("should offer curate to any group in the snippets namespace", async () => {
+ setup("snippets");
+
+ const { dialog, allUsersSelect } = await getPermissionSelects();
+ await userEvent.click(allUsersSelect);
+ expect(
+ within(screen.getByRole("listbox"))
+ .getAllByRole("option")
+ .map((option) => option.textContent),
+ ).toEqual(["Curate", "No access"]);
+ expect(
+ within(dialog).queryByLabelText("info icon"),
+ ).not.toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/permissions/constants/messages.ts b/frontend/src/metabase/permissions/constants/messages.ts
index 40d7feb7869..d7af86e5c4a 100644
--- a/frontend/src/metabase/permissions/constants/messages.ts
+++ b/frontend/src/metabase/permissions/constants/messages.ts
@@ -10,6 +10,12 @@ export const Messages = {
get UNABLE_TO_CHANGE_DATA_ANALYST_LIBRARY_PERMISSIONS() {
return t`Data Analysts always have full access to library collections.`;
},
+ get ONLY_ADMINS_CAN_CURATE_DATA_ACTIONS() {
+ return t`Only administrators can create and edit data actions. Groups with View access can run them.`;
+ },
+ get ONLY_ADMINS_CAN_CURATE_DATA_APPS() {
+ return t`Only administrators can create and edit data apps. Groups with View access can use them.`;
+ },
get NATIVE_PERMISSION_REQUIRES_DATA_ACCESS() {
return t`Groups with View data access set to "Blocked" can't create queries.`;
},
diff --git a/frontend/src/metabase/permissions/index.ts b/frontend/src/metabase/permissions/index.ts
index c41c462dba7..b979d6d7aa7 100644
--- a/frontend/src/metabase/permissions/index.ts
+++ b/frontend/src/metabase/permissions/index.ts
@@ -1,6 +1,6 @@
export { ApplicationPermissionsHelp } from "./components/ApplicationPermissionsHelp";
export { CollectionPermissionsHelp } from "./components/CollectionPermissionsHelp";
-export { default as CollectionPermissionsModal } from "./components/CollectionPermissionsModal/CollectionPermissionsModal";
+export { CollectionPermissionsModal } from "./components/CollectionPermissionsModal/CollectionPermissionsModal";
export { DataPermissionsHelp } from "./components/DataPermissionsHelp";
export { LegacyPermissionsModal } from "./components/LegacyPermissionsModal/LegacyPermissionsModal";
export { PermissionsConfirm } from "./components/PermissionsConfirm";
diff --git a/frontend/src/metabase/permissions/selectors/collection-permissions.tsx b/frontend/src/metabase/permissions/selectors/collection-permissions.tsx
index 63e2caaf4ab..8c632157ba9 100644
--- a/frontend/src/metabase/permissions/selectors/collection-permissions.tsx
+++ b/frontend/src/metabase/permissions/selectors/collection-permissions.tsx
@@ -225,6 +225,54 @@ const getCollectionPermission = (
const getNamespace = (_state: State, props: CollectionIdProps) =>
props.namespace;
+const ADMIN_ONLY_WRITE_NAMESPACE_HINTS: Partial<
+ Record<NonNullable<CollectionNamespace>, () => string>
+> = {
+ "data-actions": () => Messages.ONLY_ADMINS_CAN_CURATE_DATA_ACTIONS,
+ "data-apps": () => Messages.ONLY_ADMINS_CAN_CURATE_DATA_APPS,
+};
+
+const getAdminOnlyWriteHint = (namespace?: CollectionNamespace) =>
+ namespace != null
+ ? ADMIN_ONLY_WRITE_NAMESPACE_HINTS[namespace]?.()
+ : undefined;
+
+const isAdminOnlyWriteNamespace = (namespace?: CollectionNamespace) =>
+ getAdminOnlyWriteHint(namespace) != null;
+
+type CollectionOptionsOpts = {
+ value: DataPermissionValue;
+ isIACollection: boolean;
+ isAdminOnlyWrite: boolean;
+ isTenantCollection: boolean;
+ isExternal: boolean;
+};
+
+const canCurate = ({
+ value,
+ isIACollection,
+ isAdminOnlyWrite,
+ isTenantCollection,
+ isExternal,
+}: CollectionOptionsOpts) =>
+ !isIACollection &&
+ !(isAdminOnlyWrite && value !== COLLECTION_OPTIONS.write.value) &&
+ !(isTenantCollection && isExternal);
+
+const getCollectionOptions = (opts: CollectionOptionsOpts) =>
+ canCurate(opts)
+ ? [
+ COLLECTION_OPTIONS.write,
+ COLLECTION_OPTIONS.read,
+ COLLECTION_OPTIONS.none,
+ ]
+ : [COLLECTION_OPTIONS.read, COLLECTION_OPTIONS.none];
+
+const getCollectionAccessColumn = (namespace?: CollectionNamespace) => {
+ const hint = getAdminOnlyWriteHint(namespace);
+ return { name: t`Collection access`, ...(hint != null && { hint }) };
+};
+
const getToggleLabel = (namespace?: CollectionNamespace) =>
FOLDER_NAMESPACES.includes(namespace ?? null)
? t`Also change sub-folders`
@@ -263,6 +311,7 @@ export const getCollectionsPermissionEditor = createSelector(
const hasChildren = (collection.children?.length ?? 0) > 0;
const toggleLabel = hasChildren ? getToggleLabel(namespace) : null;
+ const isAdminOnlyWrite = isAdminOnlyWriteNamespace(namespace);
const isTenantCollection = PLUGIN_TENANTS.isTenantCollection(collection);
const sortedGroups = [...groups].sort(
@@ -308,15 +357,19 @@ export const getCollectionsPermissionEditor = createSelector(
];
const isIACollection = isInstanceAnalyticsCollection(collection);
+ const value = getCollectionPermission(
+ permissions,
+ group.id,
+ collection.id,
+ );
- const options =
- isIACollection || (isTenantCollection && isExternal)
- ? [COLLECTION_OPTIONS.read, COLLECTION_OPTIONS.none]
- : [
- COLLECTION_OPTIONS.write,
- COLLECTION_OPTIONS.read,
- COLLECTION_OPTIONS.none,
- ];
+ const options = getCollectionOptions({
+ value,
+ isIACollection,
+ isAdminOnlyWrite,
+ isTenantCollection,
+ isExternal,
+ });
const disabledTooltip = getCollectionDisabledTooltip(
groupType,
@@ -341,11 +394,7 @@ export const getCollectionsPermissionEditor = createSelector(
hasChildren,
isDisabled,
disabledTooltip,
- value: getCollectionPermission(
- permissions,
- group.id,
- collection.id,
- ),
+ value,
warning: getCollectionWarning(
group.id,
// Unjustified type cast. FIXME
@@ -363,7 +412,7 @@ export const getCollectionsPermissionEditor = createSelector(
return {
title: t`Permissions for ${collection.name}`,
filterPlaceholder: t`Search for a group`,
- columns: [{ name: t`Group name` }, { name: t`Collection access` }],
+ columns: [{ name: t`Group name` }, getCollectionAccessColumn(namespace)],
entities,
};
},
diff --git a/frontend/src/metabase/plugins/index.ts b/frontend/src/metabase/plugins/index.ts
index 0fc5c22760c..3099adf584d 100644
--- a/frontend/src/metabase/plugins/index.ts
+++ b/frontend/src/metabase/plugins/index.ts
@@ -84,7 +84,6 @@ export {
} from "./oss/notifications-sdk";
export {
PLUGIN_LIBRARY,
- type CollectionPermissionsModalProps,
type CreateLibraryModalProps,
type PublishTablesModalProps,
type UnpublishTablesModalProps,
@@ -147,7 +146,6 @@ export { PLUGIN_SMTP_OVERRIDE } from "./oss/smtp-override";
export {
PLUGIN_SNIPPET_FOLDERS,
type MoveSnippetModalProps,
- type SnippetCollectionPermissionsModalProps,
type SnippetCollectionPickerModalProps,
type SnippetSidebarContext,
type SnippetSidebarMenuOption,
diff --git a/frontend/src/metabase/plugins/oss/library.ts b/frontend/src/metabase/plugins/oss/library.ts
index a867c4c0807..f618a02a48e 100644
--- a/frontend/src/metabase/plugins/oss/library.ts
+++ b/frontend/src/metabase/plugins/oss/library.ts
@@ -13,7 +13,6 @@ import type {
Collection,
CollectionId,
CollectionItem,
- CollectionNamespace,
CollectionType,
DatabaseId,
GetLibraryCollectionResponse,
@@ -49,13 +48,6 @@ export type UnpublishTablesModalProps = {
onClose: () => void;
};
-export type CollectionPermissionsModalProps = {
- opened: boolean;
- collectionId: CollectionId;
- namespace?: CollectionNamespace | null;
- onClose: () => void;
-};
-
export type LibraryCollectionType =
| "library"
| "library-data"
@@ -112,7 +104,6 @@ type LibraryPlugin = {
}) => OmniPickerItem[] | undefined;
getEntityPickerSyntheticLibraryItem: GetEntityPickerSyntheticLibraryItemFunction;
CreateLibraryModal: ComponentType<CreateLibraryModalProps>;
- CollectionPermissionsModal: ComponentType<CollectionPermissionsModalProps>;
PublishTablesModal: ComponentType<PublishTablesModalProps>;
UnpublishTablesModal: ComponentType<UnpublishTablesModalProps>;
useGetLibraryCollectionQuery: UseQuery<
@@ -149,9 +140,6 @@ const getDefaultPluginLibrary = (): LibraryPlugin => ({
CreateLibraryModal:
// Unjustified type cast. FIXME
PluginPlaceholder as ComponentType<CreateLibraryModalProps>,
- CollectionPermissionsModal:
- // Unjustified type cast. FIXME
- PluginPlaceholder as ComponentType<CollectionPermissionsModalProps>,
PublishTablesModal:
// Unjustified type cast. FIXME
PluginPlaceholder as ComponentType<PublishTablesModalProps>,
diff --git a/frontend/src/metabase/plugins/oss/snippets.ts b/frontend/src/metabase/plugins/oss/snippets.ts
index dab6e197bd8..18dcccfd1d3 100644
--- a/frontend/src/metabase/plugins/oss/snippets.ts
+++ b/frontend/src/metabase/plugins/oss/snippets.ts
@@ -39,12 +39,6 @@ export type SnippetCollectionPickerModalProps = {
onClose: () => void;
};
-export type SnippetCollectionPermissionsModalProps = {
- opened: boolean;
- collectionId: CollectionId;
- onClose: () => void;
-};
-
export type MoveSnippetModalProps = {
snippet: NativeQuerySnippet;
onClose: () => void;
@@ -53,7 +47,6 @@ export type MoveSnippetModalProps = {
export type SnippetFoldersPlugin = {
isEnabled: boolean;
CollectionPickerModal: ComponentType<SnippetCollectionPickerModalProps>;
- CollectionPermissionsModal: ComponentType<SnippetCollectionPermissionsModalProps>;
MoveSnippetModal: ComponentType<MoveSnippetModalProps>;
};
@@ -62,9 +55,6 @@ export const getDefaultPluginSnippetFolders = () => ({
CollectionPickerModal:
// Unjustified type cast. FIXME
PluginPlaceholder as ComponentType<SnippetCollectionPickerModalProps>,
- CollectionPermissionsModal:
- // Unjustified type cast. FIXME
- PluginPlaceholder as ComponentType<SnippetCollectionPermissionsModalProps>,
// Unjustified type cast. FIXME
MoveSnippetModal: PluginPlaceholder as ComponentType<MoveSnippetModalProps>,
});
diff --git a/frontend/src/metabase/querying/components/SnippetSidebar/tests/premium.unit.spec.tsx b/frontend/src/metabase/querying/components/SnippetSidebar/tests/premium.unit.spec.tsx
index 1b675fe6ae5..1b30cd6a9f3 100644
--- a/frontend/src/metabase/querying/components/SnippetSidebar/tests/premium.unit.spec.tsx
+++ b/frontend/src/metabase/querying/components/SnippetSidebar/tests/premium.unit.spec.tsx
@@ -1,6 +1,6 @@
import userEvent from "@testing-library/user-event";
-import { getIcon, screen } from "__support__/ui";
+import { getIcon, queryIcon, screen } from "__support__/ui";
import { reinitialize } from "metabase/plugins";
import type { SetupOpts } from "./setup";
@@ -21,15 +21,15 @@ describe("SnippetSidebar (EE with token feature)", () => {
it("should display the `Change permissions` menu for admin users", async () => {
await setup();
+ await userEvent.click(getIcon("ellipsis"));
- expect(getIcon("ellipsis")).toBeInTheDocument();
+ expect(await screen.findByText("Change permissions")).toBeInTheDocument();
});
it("should not display the `Change permissions` menu for non-admin users", async () => {
await setup({ user: { is_superuser: false } });
- await userEvent.click(getIcon("ellipsis"));
- expect(screen.queryByText("Change permissions")).not.toBeInTheDocument();
+ expect(queryIcon("ellipsis")).not.toBeInTheDocument();
});
it("should display the `New snippet` and the `New folder` option", async () => {
diff --git a/frontend/src/metabase/querying/components/SnippetSidebar/tests/setup.tsx b/frontend/src/metabase/querying/components/SnippetSidebar/tests/setup.tsx
index b3d19e01c7a..8d5756b2588 100644
--- a/frontend/src/metabase/querying/components/SnippetSidebar/tests/setup.tsx
+++ b/frontend/src/metabase/querying/components/SnippetSidebar/tests/setup.tsx
@@ -20,7 +20,10 @@ import {
import { SnippetSidebar } from "../SnippetSidebar";
-const ROOT_COLLECTION = createMockCollection({ id: "root" });
+const ROOT_COLLECTION = createMockCollection({
+ id: "root",
+ namespace: "snippets",
+});
const MOCK_SNIPPET = createMockNativeQuerySnippet();
export interface SetupOpts {
@@ -35,7 +38,10 @@ export async function setup({
user = { is_superuser: true },
}: SetupOpts = {}) {
setupNativeQuerySnippetEndpoints({ snippets: [MOCK_SNIPPET] });
- setupCollectionsEndpoints({ collections: [ROOT_COLLECTION] });
+ setupCollectionsEndpoints({
+ collections: [ROOT_COLLECTION],
+ rootCollection: ROOT_COLLECTION,
+ });
setupCollectionItemsEndpoint({
collection: ROOT_COLLECTION,
collectionItems: [
diff --git a/frontend/src/metabase/routes.tsx b/frontend/src/metabase/routes.tsx
index 711bbf0a53e..f3be4bcd689 100644
--- a/frontend/src/metabase/routes.tsx
+++ b/frontend/src/metabase/routes.tsx
@@ -385,7 +385,9 @@ export const getRoutes = (store: AppStore): RouteObject[] => [
{modalRoute("archive", ArchiveCollectionModal, {
noWrap: true,
})}
- {modalRoute("permissions", CollectionPermissionsModal)}
+ {modalRoute("permissions", CollectionPermissionsModal, {
+ noWrap: true,
+ })}
{modalRoute(
"move-questions-dashboard",
MoveQuestionsIntoDashboardsModal,