Skip to content

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

Show pinned items in the collection contents list (#79679)

Andrei Chernykh3b936768f0fa
diff --git a/e2e/support/helpers/e2e-collection-helpers.ts b/e2e/support/helpers/e2e-collection-helpers.ts
index 21fb947a359..a5040190411 100644
--- a/e2e/support/helpers/e2e-collection-helpers.ts
+++ b/e2e/support/helpers/e2e-collection-helpers.ts
@@ -63,16 +63,17 @@ export const getUnpinnedSection = () => {
export const openPinnedItemMenu = (name: string) => {
cy.log(`open pinned item menu: ${name}`);
- // Hovering a pinned item can trigger an async re-render (e.g. a pinned
- // metric runs its query), which detaches a chained `.within()` subject. Hover
- // first, then re-query the actions button so the click acts on a settled
- // element and Cypress can retry on detach.
+ // Hovering a pinned item can trigger an async re-render, which replaces the
+ // hovered node and drops its :hover state, hiding the actions button again.
+ // Hover first so the button settles, then realClick: the real pointer
+ // movement re-applies :hover to the current node, so the click cannot race
+ // the visibility toggle.
getPinnedSection().findByText(name).closest("a").realHover();
getPinnedSection()
.findByText(name)
.closest("a")
.findByLabelText("Actions")
- .click();
+ .realClick();
};
export const openUnpinnedItemMenu = (name: string) => {
diff --git a/e2e/test/scenarios/collections/collection-pinned-overview.cy.spec.js b/e2e/test/scenarios/collections/collection-pinned-overview.cy.spec.js
index 53b218fa8a7..82597adb807 100644
--- a/e2e/test/scenarios/collections/collection-pinned-overview.cy.spec.js
+++ b/e2e/test/scenarios/collections/collection-pinned-overview.cy.spec.js
@@ -55,13 +55,18 @@ describe("scenarios > collection pinned items overview", () => {
cy.intercept("POST", "/api/card/**/query").as("getCardQuery");
cy.intercept("GET", "/api/**/items?pinned_state*").as("getPinnedItems");
+ cy.intercept("GET", "/api/**/items?models*").as("getCollectionItems");
});
- it("should be able to pin a dashboard", () => {
+ it("should be able to pin a dashboard and keep it in the contents list", () => {
openRootCollection();
H.openUnpinnedItemMenu(DASHBOARD_NAME);
H.popover().findByText("Pin this").click();
- cy.wait("@getPinnedItems");
+ cy.wait(["@getPinnedItems", "@getCollectionItems"]);
+
+ cy.findByTestId("collection-table")
+ .findByText(DASHBOARD_NAME)
+ .should("be.visible");
H.getPinnedSection().within(() => {
cy.icon("dashboard").should("be.visible");
@@ -227,17 +232,19 @@ describe("scenarios > collection pinned items overview", () => {
// on specific elements rather than truly simulating mouse movements across the screen
H.dragAndDrop("draggingViz", "pinnedItems");
- cy.findByTestId("collection-table")
- .findByText("Orders, Count, Grouped by Created At (year)")
- .should("not.exist");
-
cy.findByTestId("pinned-items")
.findByText("Orders, Count, Grouped by Created At (year)")
.should("exist");
+
+ // Pinned items stay in the contents list below the pinned section
+ cy.wait("@getCollectionItems");
+ cy.findByTestId("collection-table")
+ .findByText("Orders, Count, Grouped by Created At (year)")
+ .should("be.visible");
});
});
const openRootCollection = () => {
cy.visit("/collection/root");
- cy.wait("@getPinnedItems");
+ cy.wait(["@getPinnedItems", "@getCollectionItems"]);
};
diff --git a/e2e/test/scenarios/collections/collections.cy.spec.js b/e2e/test/scenarios/collections/collections.cy.spec.js
index b552799cc2f..f7b9d558403 100644
--- a/e2e/test/scenarios/collections/collections.cy.spec.js
+++ b/e2e/test/scenarios/collections/collections.cy.spec.js
@@ -1139,7 +1139,6 @@ describe("scenarios > collection items listing", () => {
method: "GET",
pathname: "/api/collection/root/items",
query: {
- pinned_state: "is_not_pinned",
q: query,
},
}).as(alias);
@@ -1249,7 +1248,6 @@ describe("scenarios > collection items listing", () => {
{
method: "GET",
pathname: "/api/collection/root/items",
- query: { pinned_state: "is_not_pinned" },
},
(request) => {
const models = new URL(request.url).searchParams
diff --git a/e2e/test/scenarios/collections/instance-analytics.cy.spec.js b/e2e/test/scenarios/collections/instance-analytics.cy.spec.js
index 0990beb1a3b..d2e2e510fec 100644
--- a/e2e/test/scenarios/collections/instance-analytics.cy.spec.js
+++ b/e2e/test/scenarios/collections/instance-analytics.cy.spec.js
@@ -31,7 +31,9 @@ describe("scenarios > Metabase Analytics Collection (AuditV2) ", () => {
H.openNavigationSidebar();
cy.findByRole("link", { name: /Usage analytics/i }).click();
- cy.findByRole("link", { name: /Metabase metrics/i }).click();
+ H.getPinnedSection()
+ .findByRole("link", { name: /Metabase metrics/i })
+ .click();
cy.findByRole("link", { name: /Question views last week/i }).click();
cy.findByRole("button", { name: /Editor/ }).click();
diff --git a/e2e/test/scenarios/collections/permissions.cy.spec.js b/e2e/test/scenarios/collections/permissions.cy.spec.js
index 572af7e5e68..937bf369a07 100644
--- a/e2e/test/scenarios/collections/permissions.cy.spec.js
+++ b/e2e/test/scenarios/collections/permissions.cy.spec.js
@@ -68,17 +68,17 @@ describe("collection permissions", () => {
cy.findByTestId("pinned-items").should("not.exist");
pinItem("Orders in a dashboard");
- cy.findByTestId("collection-table")
+ cy.findByTestId("pinned-items")
.findByText("Orders in a dashboard")
- .should("not.exist");
+ .should("be.visible");
pinItem("Orders, Count");
- cy.findByTestId("collection-table")
+ cy.findByTestId("pinned-items")
.findByText("Orders, Count")
- .should("not.exist");
+ .should("be.visible");
- // Should see "pinned items" and items should be in that section
- cy.findByTestId("pinned-items").within(() => {
+ // Pinned items also stay in the contents list
+ cy.findByTestId("collection-table").within(() => {
cy.findByText("Orders in a dashboard");
cy.findByText("Orders, Count");
});
diff --git a/e2e/test/scenarios/metrics/metrics-collection.cy.spec.js b/e2e/test/scenarios/metrics/metrics-collection.cy.spec.js
index f1bec6d4431..449a822570b 100644
--- a/e2e/test/scenarios/metrics/metrics-collection.cy.spec.js
+++ b/e2e/test/scenarios/metrics/metrics-collection.cy.spec.js
@@ -55,9 +55,10 @@ describe("scenarios > metrics > collection", () => {
H.getPinnedSection()
.findByText(ORDERS_SCALAR_METRIC.name)
.should("be.visible");
+ // Pinned items also stay in the contents list below the pinned section
H.getUnpinnedSection()
.findByText(ORDERS_SCALAR_METRIC.name)
- .should("not.exist");
+ .should("be.visible");
H.openPinnedItemMenu(ORDERS_SCALAR_METRIC.name);
H.popover().findByText("Unpin").click();
H.getPinnedSection().should("not.exist");
@@ -71,7 +72,7 @@ describe("scenarios > metrics > collection", () => {
.should("be.visible");
H.getUnpinnedSection()
.findByText(ORDERS_SCALAR_METRIC.name)
- .should("not.exist");
+ .should("be.visible");
});
it("should be possible to add and remove a metric from bookmarks", () => {
diff --git a/e2e/test/scenarios/organization/bookmarks-collection.cy.spec.js b/e2e/test/scenarios/organization/bookmarks-collection.cy.spec.js
index 062f118a5f8..e818ee31acd 100644
--- a/e2e/test/scenarios/organization/bookmarks-collection.cy.spec.js
+++ b/e2e/test/scenarios/organization/bookmarks-collection.cy.spec.js
@@ -296,7 +296,8 @@ function archive(name) {
}
function bookmarkPinnedItem(name) {
- cy.findByText(name)
+ H.getPinnedSection()
+ .findByText(name)
.closest("a")
.find(".Icon-ellipsis")
.click({ force: true });
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.module.css b/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.module.css
new file mode 100644
index 00000000000..e47c1b924fc
--- /dev/null
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.module.css
@@ -0,0 +1,12 @@
+.root {
+ overflow: hidden;
+}
+
+.main {
+ overflow-y: auto;
+}
+
+.table {
+ container-name: ItemsTableContainer;
+ container-type: inline-size;
+}
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.styled.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.styled.tsx
deleted file mode 100644
index a69882ebf0c..00000000000
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.styled.tsx
+++ /dev/null
@@ -1,30 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import styled from "@emotion/styled";
-
-export const CollectionRoot = styled.div`
- height: 100%;
- overflow: hidden;
- position: relative;
- background-color: var(--mb-color-background_page-secondary);
-`;
-
-export const CollectionMain = styled.div`
- margin: 0 auto;
- overflow-y: auto;
- max-height: 100%;
- padding: 1rem 5%;
-`;
-
-interface CollectionTableProps {
- hasPinnedItems?: boolean;
-}
-
-export const CollectionTable = styled.div<CollectionTableProps>`
- margin-top: ${(props) => (props.hasPinnedItems ? "2rem" : "")};
- container-name: ItemsTableContainer;
- container-type: inline-size;
-`;
-
-export const CollectionEmptyContent = styled.div`
- margin-top: calc(20vh - 3.5rem);
-`;
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx
index 77977ff4b60..b04d3a381e4 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx
@@ -1,25 +1,15 @@
-import { useCallback } from "react";
-
import {
- useCreateBookmarkMutation,
- useDeleteBookmarkMutation,
useGetCollectionQuery,
useListBookmarksQuery,
useListCollectionsTreeQuery,
} from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { useDatabaseListQuery } from "metabase/common/hooks";
-import { useDispatch, useSelector } from "metabase/redux";
-import type { UploadFileProps } from "metabase/redux/uploads";
-import { uploadFile as uploadFileAction } from "metabase/redux/uploads";
+import { useSelector } from "metabase/redux";
import { getMetadata } from "metabase/selectors/metadata";
import { getUserIsAdmin } from "metabase/selectors/user";
import { getSetting } from "metabase/settings";
-import type {
- BookmarkId,
- BookmarkType,
- CollectionId,
-} from "metabase-types/api";
+import type { CollectionId } from "metabase-types/api";
import { CollectionContentView } from "./CollectionContentView";
@@ -54,24 +44,6 @@ export function CollectionContent({
const isAdmin = useSelector(getUserIsAdmin);
- const dispatch = useDispatch();
-
- const [createBookmarkMutation] = useCreateBookmarkMutation();
- const [deleteBookmarkMutation] = useDeleteBookmarkMutation();
-
- const createBookmark = (id: BookmarkId, type: BookmarkType) =>
- createBookmarkMutation({ id, type });
- const deleteBookmark = (id: BookmarkId, type: BookmarkType) =>
- deleteBookmarkMutation({ id, type });
-
- const uploadFile = useCallback(
- ({ file, modelId, collectionId, tableId, uploadMode }: UploadFileProps) =>
- dispatch(
- uploadFileAction({ file, modelId, collectionId, tableId, uploadMode }),
- ),
- [dispatch],
- );
-
const error =
bookmarksError || databasesError || collectionsError || collectionError;
@@ -89,10 +61,7 @@ export function CollectionContent({
bookmarks={bookmarks}
collection={collection}
collectionId={collectionId}
- createBookmark={createBookmark}
- deleteBookmark={deleteBookmark}
isAdmin={isAdmin}
- uploadFile={uploadFile}
uploadsEnabled={uploadsEnabled}
canCreateUploadInDb={canCreateUploadInDb}
/>
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentPinnedItems.unit.spec.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentPinnedItems.unit.spec.tsx
new file mode 100644
index 00000000000..3f1be3984ca
--- /dev/null
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentPinnedItems.unit.spec.tsx
@@ -0,0 +1,64 @@
+import {
+ setupBookmarksEndpoints,
+ setupCollectionByIdEndpoint,
+ setupCollectionItemsEndpoint,
+ setupCollectionsEndpoints,
+ setupDatabasesEndpoints,
+ setupNullGetUserKeyValueEndpoints,
+} from "__support__/server-mocks";
+import { renderWithProviders, screen, within } from "__support__/ui";
+import { Route } from "metabase/router";
+import {
+ createMockCollection,
+ createMockCollectionItem,
+ createMockDatabase,
+} from "metabase-types/api/mocks";
+
+import { CollectionContent } from "./CollectionContent";
+
+const collection = createMockCollection({ id: 1, can_write: true });
+
+const pinnedDashboard = createMockCollectionItem({
+ id: 1,
+ name: "Pinned dashboard",
+ model: "dashboard",
+ collection_position: 1,
+});
+
+const regularQuestion = createMockCollectionItem({
+ id: 2,
+ name: "Regular question",
+ model: "card",
+});
+
+function setup() {
+ setupDatabasesEndpoints([createMockDatabase()]);
+ setupBookmarksEndpoints([]);
+ setupNullGetUserKeyValueEndpoints();
+ setupCollectionByIdEndpoint({ collections: [collection] });
+ setupCollectionsEndpoints({ collections: [collection] });
+ setupCollectionItemsEndpoint({
+ collection,
+ collectionItems: [pinnedDashboard, regularQuestion],
+ });
+
+ renderWithProviders(
+ <Route path="/" element={<CollectionContent collectionId={1} />} />,
+ { withRouter: true, withDND: true },
+ );
+}
+
+describe("CollectionContent pinned items", () => {
+ it("shows pinned items in both the pinned section and the contents list", async () => {
+ setup();
+
+ const pinnedSection = within(await screen.findByTestId("pinned-items"));
+ expect(
+ await pinnedSection.findByText("Pinned dashboard"),
+ ).toBeInTheDocument();
+
+ const table = within(await screen.findByTestId("collection-table"));
+ expect(await table.findByText("Pinned dashboard")).toBeInTheDocument();
+ expect(table.getByText("Regular question")).toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentUpload.unit.spec.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentUpload.unit.spec.tsx
index 8dfb4cbbb55..c352f7af2c2 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentUpload.unit.spec.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentUpload.unit.spec.tsx
@@ -6,10 +6,8 @@ import {
setupCollectionByIdEndpoint,
setupCollectionItemsEndpoint,
setupCollectionsEndpoints,
- setupDashboardQuestionCandidatesEndpoint,
setupDatabasesEndpoints,
setupNullGetUserKeyValueEndpoints,
- setupSearchEndpoints,
setupUserMetabotPermissionsEndpoint,
} from "__support__/server-mocks";
import {
@@ -69,10 +67,8 @@ const uploadedModel2 = createMockCollectionItem({
async function setupCollectionContent(overrides = {}) {
setupUserMetabotPermissionsEndpoint();
setupDatabasesEndpoints([createMockDatabase({ can_upload: true })]);
- setupSearchEndpoints([]);
setupBookmarksEndpoints([]);
setupNullGetUserKeyValueEndpoints();
- setupDashboardQuestionCandidatesEndpoint([]);
const settings = createMockSettingsState({
"uploads-settings": {
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
index 2ca1c124e95..e0364c0f20f 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
@@ -8,35 +8,35 @@ import { t } from "ttag";
import ErrorBoundary from "metabase/ErrorBoundary";
import {
Api,
+ useCreateBookmarkMutation,
+ useDeleteBookmarkMutation,
useDeleteCollectionMutation,
- useListCollectionItemsQuery,
} from "metabase/api";
import { listTag } from "metabase/api/tags";
import { ArchivedEntityBanner } from "metabase/archive/components/ArchivedEntityBanner";
import { useSetArchive } from "metabase/archive/hooks";
import { CollectionBulkActions } from "metabase/collections/components/CollectionBulkActions";
+import { CollectionHeader } from "metabase/collections/components/CollectionHeader";
import { PinnedItemsGrid } from "metabase/collections/components/PinnedItemsGrid";
-import Header from "metabase/collections/containers/CollectionHeader";
import { trackCollectionBookmarked } from "metabase/common/collections/analytics";
import { getComposedDragProps } from "metabase/common/collections/dropzone";
import type {
CollectionOrTableIdProps,
- CreateBookmark,
- DeleteBookmark,
OnFileUpload,
- UploadFile,
} from "metabase/common/collections/types";
-import {
- isRootTrashCollection,
- isTrashedCollection,
-} from "metabase/common/collections/utils";
+import { isTrashedCollection } from "metabase/common/collections/utils";
import { ItemsDragLayer } from "metabase/common/components/dnd/ItemsDragLayer";
import { useSetCollection, useToast } from "metabase/common/hooks";
import { useListSelect } from "metabase/common/hooks/use-list-select";
import { useDispatch } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
-import { MAX_UPLOAD_SIZE, MAX_UPLOAD_STRING } from "metabase/redux/uploads";
+import {
+ MAX_UPLOAD_SIZE,
+ MAX_UPLOAD_STRING,
+ uploadFile as uploadFileAction,
+} from "metabase/redux/uploads";
import { useNavigate } from "metabase/router";
+import { Box } from "metabase/ui";
import type Database from "metabase-lib/v1/metadata/Database";
import type {
Bookmark,
@@ -48,7 +48,7 @@ import type {
import { ModelUploadModal } from "../ModelUploadModal";
import UploadOverlay from "../UploadOverlay";
-import { CollectionMain, CollectionRoot } from "./CollectionContent.styled";
+import S from "./CollectionContent.module.css";
import { CollectionItemsTable } from "./CollectionItemsTable";
import { useCollectionChartPaste } from "./use-collection-chart-paste";
@@ -59,10 +59,7 @@ export const CollectionContentView = ({
bookmarks,
collection,
collectionId,
- createBookmark,
- deleteBookmark,
isAdmin,
- uploadFile,
uploadsEnabled,
canCreateUploadInDb,
}: {
@@ -70,29 +67,27 @@ export const CollectionContentView = ({
bookmarks?: Bookmark[];
collection: Collection;
collectionId: CollectionId;
- createBookmark: CreateBookmark;
- deleteBookmark: DeleteBookmark;
isAdmin: boolean;
- uploadFile: UploadFile;
uploadsEnabled: boolean;
canCreateUploadInDb: boolean;
}) => {
const dispatch = useDispatch();
const navigate = useNavigate();
const [deleteCollection] = useDeleteCollectionMutation();
+ const [createBookmark] = useCreateBookmarkMutation();
+ const [deleteBookmark] = useDeleteBookmarkMutation();
+ const archive = useSetArchive();
+ const setCollection = useSetCollection();
+ const [sendToast] = useToast();
useCollectionChartPaste(collection);
- const { data: pinnedItemsData, isLoading: loading } =
- useListCollectionItemsQuery({
- id: collectionId,
- pinned_state: "is_pinned",
- sort_column: "name",
- sort_direction: "asc",
- });
+ const isBookmarked =
+ bookmarks?.some(
+ (bookmark) =>
+ bookmark.type === "collection" && bookmark.item_id === collectionId,
+ ) ?? false;
- const list = pinnedItemsData?.data;
- const [isBookmarked, setIsBookmarked] = useState(false);
const [selectedItems, setSelectedItems] = useState<CollectionItem[] | null>(
null,
);
@@ -104,6 +99,16 @@ export const CollectionContentView = ({
] = useDisclosure(false);
const [uploadedFile, setUploadedFile] = useState<File | null>(null);
+ const { clear, getIsSelected, selected, selectOnlyTheseItems, toggleItem } =
+ useListSelect(itemKeyFn);
+ const previousCollection = usePrevious(collection);
+
+ useEffect(() => {
+ if (previousCollection && previousCollection.id !== collection.id) {
+ clear();
+ }
+ }, [previousCollection, collection, clear]);
+
const saveFile = useCallback(
(file: File) => {
setUploadedFile(file);
@@ -117,37 +122,12 @@ export const CollectionContentView = ({
const { collectionId, tableId } = uploadFileArgs;
if (uploadedFile && (collectionId || tableId)) {
closeModelUploadModal();
- uploadFile({
- file: uploadedFile,
- ...uploadFileArgs,
- });
+ dispatch(uploadFileAction({ file: uploadedFile, ...uploadFileArgs }));
}
},
- [uploadFile, uploadedFile, closeModelUploadModal],
+ [dispatch, uploadedFile, closeModelUploadModal],
);
- const { clear, getIsSelected, selected, selectOnlyTheseItems, toggleItem } =
- useListSelect(itemKeyFn);
- const previousCollection = usePrevious(collection);
-
- useEffect(() => {
- if (previousCollection && previousCollection.id !== collection.id) {
- clear();
- }
- }, [previousCollection, collection, clear]);
-
- useEffect(() => {
- const shouldBeBookmarked = !!bookmarks?.some(
- (bookmark) =>
- bookmark.type === "collection" && bookmark.item_id === collectionId,
- );
- setIsBookmarked(shouldBeBookmarked);
- }, [bookmarks, collectionId]);
-
- const archive = useSetArchive();
- const setCollection = useSetCollection();
- const [sendToast] = useToast();
-
const handleFileRejections = useCallback(
(rejected: FileRejection[]) => {
if (!rejected.length) {
@@ -216,12 +196,12 @@ export const CollectionContentView = ({
};
const handleCreateBookmark = () => {
- createBookmark(collectionId.toString(), "collection");
+ createBookmark({ id: collectionId, type: "collection" });
trackCollectionBookmarked();
};
const handleDeleteBookmark = () => {
- deleteBookmark(collectionId.toString(), "collection");
+ deleteBookmark({ id: collectionId, type: "collection" });
};
const canCreateUpload =
@@ -233,11 +213,14 @@ export const CollectionContentView = ({
? getComposedDragProps(getRootProps())
: {};
- const pinnedItems = list && !isRootTrashCollection(collection) ? list : [];
- const hasPinnedItems = pinnedItems.length > 0;
-
return (
- <CollectionRoot {...dropzoneProps}>
+ <Box
+ className={S.root}
+ h="100%"
+ pos="relative"
+ bg="background_page-secondary"
+ {...dropzoneProps}
+ >
{canCreateUpload && (
<>
<ModelUploadModal
@@ -284,9 +267,9 @@ export const CollectionContentView = ({
/>
)}
- <CollectionMain>
+ <Box className={S.main} mx="auto" mah="100%" px="5%" py="md">
<ErrorBoundary>
- <Header
+ <CollectionHeader
collection={collection}
isAdmin={isAdmin}
isBookmarked={isBookmarked}
@@ -294,7 +277,7 @@ export const CollectionContentView = ({
onDeleteBookmark={handleDeleteBookmark}
canUpload={canCreateUpload}
uploadsEnabled={uploadsEnabled}
- saveFile={saveFile}
+ onSaveFile={saveFile}
/>
</ErrorBoundary>
@@ -304,7 +287,7 @@ export const CollectionContentView = ({
bookmarks={bookmarks}
createBookmark={createBookmark}
deleteBookmark={deleteBookmark}
- items={pinnedItems}
+ collectionId={collectionId}
collection={collection}
onMove={handleMove}
onCopy={handleCopy}
@@ -320,8 +303,6 @@ export const CollectionContentView = ({
bookmarks={bookmarks}
createBookmark={createBookmark}
deleteBookmark={deleteBookmark}
- loadingPinnedItems={loading}
- hasPinnedItems={hasPinnedItems}
showFilterBar
selected={selected}
toggleItem={toggleItem}
@@ -339,8 +320,8 @@ export const CollectionContentView = ({
setSelectedAction={setSelectedAction}
/>
</ErrorBoundary>
- </CollectionMain>
+ </Box>
<ItemsDragLayer />
- </CollectionRoot>
+ </Box>
);
};
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx
index 8868685f534..8038d1f94d3 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsTable.tsx
@@ -44,10 +44,7 @@ import type {
SortingOptions,
} from "metabase-types/api";
-import {
- CollectionEmptyContent,
- CollectionTable,
-} from "./CollectionContent.styled";
+import S from "./CollectionContent.module.css";
import { CollectionItemsToolbar } from "./CollectionItemsToolbar";
const shouldDebounceSearchText = (
@@ -97,8 +94,6 @@ export type CollectionItemsTableProps = {
getIsSelected: (item: CollectionItem) => boolean;
handleCopy: (items: CollectionItem[]) => void;
handleMove: (items: CollectionItem[]) => void;
- hasPinnedItems: boolean;
- loadingPinnedItems: boolean;
models: CollectionItemModel[];
pageSize: number;
showDashboardQuestions: boolean;
@@ -116,9 +111,9 @@ const DefaultEmptyContentComponent = ({
collection?: Collection;
}) => {
return (
- <CollectionEmptyContent>
+ <Box mt="15vh">
<CollectionEmptyState collection={collection} />
- </CollectionEmptyContent>
+ </Box>
);
};
@@ -148,8 +143,6 @@ export const CollectionItemsTable = ({
getIsSelected,
handleCopy,
handleMove,
- hasPinnedItems,
- loadingPinnedItems,
models = ALL_MODELS,
pageSize = COLLECTION_PAGE_SIZE,
showFilterBar,
@@ -178,7 +171,7 @@ export const CollectionItemsTable = ({
const trimmedSearchText =
searchText.trim().length > 0 ? debouncedSearchText.trim() : "";
- const [unpinnedItemsSorting, setUnpinnedItemsSorting] = useState<
+ const [itemsSorting, setItemsSorting] = useState<
SortingOptions<ListCollectionItemsSortColumn>
>(() => getDefaultSortingOptions(collection));
@@ -207,15 +200,18 @@ export const CollectionItemsTable = ({
[collectionId, setPage],
);
- const handleUnpinnedItemsSortingChange = useCallback(
+ const handleItemsSortingChange = useCallback(
(sortingOpts: SortingOptions<ListCollectionItemsSortColumn>) => {
- setUnpinnedItemsSorting(sortingOpts);
+ setItemsSorting(sortingOpts);
setPage(0);
},
[setPage],
);
- const showAllItems = isEmbeddingSdk() || isRootTrashCollection(collection);
+ // Dashboard questions are only ever listed in the SDK and in the trash.
+ const showDashboardQuestionsInList =
+ (isEmbeddingSdk() || isRootTrashCollection(collection)) &&
+ showDashboardQuestions;
return (
<CollectionItemsTableContent
@@ -230,8 +226,6 @@ export const CollectionItemsTable = ({
getIsSelected={getIsSelected}
handleCopy={handleCopy}
handleMove={handleMove}
- hasPinnedItems={hasPinnedItems}
- loadingPinnedItems={loadingPinnedItems}
page={page}
pageSize={pageSize}
searchText={searchText}
@@ -240,8 +234,8 @@ export const CollectionItemsTable = ({
selectOnlyTheseItems={selectOnlyTheseItems}
showFilterBar={showFilterBar}
toggleItem={toggleItem}
- unpinnedItemsSorting={unpinnedItemsSorting}
- unpinnedQuery={
+ itemsSorting={itemsSorting}
+ itemsQuery={
collectionId === undefined
? skipToken
: {
@@ -250,10 +244,8 @@ export const CollectionItemsTable = ({
...(showFilterBar ? { include_available_models: true } : {}),
limit: pageSize,
offset: pageSize * page,
- ...(showAllItems
- ? { show_dashboard_questions: showDashboardQuestions }
- : { pinned_state: "is_not_pinned" }),
- ...unpinnedItemsSorting,
+ show_dashboard_questions: showDashboardQuestionsInList,
+ ...itemsSorting,
...(trimmedSearchText.length > 0 ? { q: trimmedSearchText } : {}),
}
}
@@ -263,7 +255,7 @@ export const CollectionItemsTable = ({
onPreviousPage={handlePreviousPage}
onSearchTextChange={handleSearchTextChange}
onSelectedFiltersChange={handleSelectedFiltersChange}
- onUnpinnedItemsSortingChange={handleUnpinnedItemsSortingChange}
+ onItemsSortingChange={handleItemsSortingChange}
/>
);
};
@@ -272,14 +264,14 @@ type CollectionItemsTableContentProps = CollectionItemsTableProps & {
page: number;
searchText: string;
selectedFilters: CollectionItemModel[] | null;
- unpinnedItemsSorting: SortingOptions<ListCollectionItemsSortColumn>;
- unpinnedQuery: ListCollectionItemsRequest | typeof skipToken;
+ itemsSorting: SortingOptions<ListCollectionItemsSortColumn>;
+ itemsQuery: ListCollectionItemsRequest | typeof skipToken;
onNextPage: () => void;
onPreviousPage: () => void;
onSearchTextChange: (searchText: string) => void;
onSelectedFiltersChange: (filters: CollectionItemModel[] | null) => void;
- onUnpinnedItemsSortingChange: (
- unpinnedItemsSorting: SortingOptions<ListCollectionItemsSortColumn>,
+ onItemsSortingChange: (
+ itemsSorting: SortingOptions<ListCollectionItemsSortColumn>,
) => void;
visibleColumns: CollectionContentTableColumn[];
};
@@ -295,8 +287,6 @@ const CollectionItemsTableContent = ({
getIsSelected,
handleCopy,
handleMove,
- hasPinnedItems,
- loadingPinnedItems,
page,
pageSize = COLLECTION_PAGE_SIZE,
searchText,
@@ -305,20 +295,20 @@ const CollectionItemsTableContent = ({
selectOnlyTheseItems,
showFilterBar,
toggleItem,
- unpinnedItemsSorting,
- unpinnedQuery,
+ itemsSorting,
+ itemsQuery,
visibleColumns,
onClick,
onNextPage,
onPreviousPage,
onSearchTextChange,
onSelectedFiltersChange,
- onUnpinnedItemsSortingChange,
+ onItemsSortingChange,
}: CollectionItemsTableContentProps) => {
- const { data, isFetching: fetchingUnpinnedItems } =
- useListCollectionItemsQuery(unpinnedQuery);
+ const { data, isFetching: fetchingItems } =
+ useListCollectionItemsQuery(itemsQuery);
- const unpinnedItems = data?.data ?? [];
+ const items = data?.data ?? [];
const availableModels = data?.available_models ?? [];
const total = data?.total;
const visibleColumnsMap = useMemo(
@@ -329,32 +319,27 @@ const CollectionItemsTableContent = ({
const hasPagination: boolean = total ? total > pageSize : false;
const unselected = getIsSelected
- ? unpinnedItems.filter((item) => !getIsSelected(item))
- : unpinnedItems;
+ ? items.filter((item) => !getIsSelected(item))
+ : items;
const hasUnselected = unselected.length > 0;
const handleSelectAll = () => {
- selectOnlyTheseItems?.(unpinnedItems);
+ selectOnlyTheseItems?.(items);
};
- const loading = loadingPinnedItems || fetchingUnpinnedItems;
const hasSearchQuery =
- unpinnedQuery !== skipToken && Boolean(unpinnedQuery.q?.trim());
+ itemsQuery !== skipToken && Boolean(itemsQuery.q?.trim());
const hasSearchText = searchText.trim().length > 0 || hasSearchQuery;
const hasActiveFilters = hasSearchText || selectedFilters != null;
- const isSearching = fetchingUnpinnedItems && hasSearchQuery;
- const isEmpty =
- !loading &&
- !hasPinnedItems &&
- unpinnedItems.length === 0 &&
- !hasActiveFilters;
+ const isSearching = fetchingItems && hasSearchQuery;
+ const isEmpty = !fetchingItems && items.length === 0 && !hasActiveFilters;
if (isEmpty) {
return <EmptyContentComponent collection={collection} />;
}
const showNoResults =
- !fetchingUnpinnedItems && hasActiveFilters && unpinnedItems.length === 0;
+ !fetchingItems && hasActiveFilters && items.length === 0;
const showTable = !showNoResults;
return (
@@ -366,22 +351,21 @@ const CollectionItemsTableContent = ({
selectedFilters={selectedFilters}
onSearchTextChange={onSearchTextChange}
onSelectedFiltersChange={onSelectedFiltersChange}
- hasPinnedItems={hasPinnedItems}
isSearching={isSearching}
/>
)}
{showNoResults && <CollectionNoResults hasSearchText={hasSearchText} />}
{showTable && (
- <CollectionTable data-testid="collection-table">
+ <Box className={S.table} data-testid="collection-table">
<ItemsTable
databases={databases}
bookmarks={bookmarks}
createBookmark={createBookmark}
deleteBookmark={deleteBookmark}
- items={unpinnedItems}
+ items={items}
collection={collection}
- sortingOptions={unpinnedItemsSorting}
- onSortingOptionsChange={onUnpinnedItemsSortingChange}
+ sortingOptions={itemsSorting}
+ onSortingOptionsChange={onItemsSortingChange}
selectedItems={selected}
hasUnselected={hasUnselected}
getIsSelected={getIsSelected}
@@ -408,13 +392,13 @@ const CollectionItemsTableContent = ({
page={page}
pageSize={pageSize}
total={total}
- itemsLength={unpinnedItems.length}
+ itemsLength={items.length}
onNextPage={onNextPage}
onPreviousPage={onPreviousPage}
/>
)}
</div>
- </CollectionTable>
+ </Box>
)}
</>
);
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsToolbar.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsToolbar.tsx
index aca79ada7a7..dcb76a5a01f 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsToolbar.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionItemsToolbar.tsx
@@ -10,7 +10,6 @@ type CollectionItemsToolbarProps = {
availableModels: string[];
selectedFilters: CollectionItemModel[] | null;
onSearchTextChange: (searchText: string) => void;
- hasPinnedItems?: boolean;
isSearching: boolean;
onSelectedFiltersChange: (filters: CollectionItemModel[] | null) => void;
};
@@ -20,7 +19,6 @@ export function CollectionItemsToolbar({
availableModels,
selectedFilters,
onSearchTextChange,
- hasPinnedItems,
isSearching,
onSelectedFiltersChange,
}: CollectionItemsToolbarProps) {
@@ -35,12 +33,7 @@ export function CollectionItemsToolbar({
const rightSection = isSearching ? <Loader size="xs" /> : clearButton;
return (
- <Flex
- mb="md"
- gap="0.75rem"
- mt={hasPinnedItems ? "xl" : 0}
- data-testid="collection-items-toolbar"
- >
+ <Flex mb="md" gap="0.75rem" data-testid="collection-items-toolbar">
<TextInput
flex="1"
bdrs="md"
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/CollectionHeader.module.css b/frontend/src/metabase/collections/components/CollectionHeader/CollectionHeader.module.css
new file mode 100644
index 00000000000..cb35d9070ea
--- /dev/null
+++ b/frontend/src/metabase/collections/components/CollectionHeader/CollectionHeader.module.css
@@ -0,0 +1,3 @@
+.actions {
+ align-self: start;
+}
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/CollectionHeader.styled.tsx b/frontend/src/metabase/collections/components/CollectionHeader/CollectionHeader.styled.tsx
deleted file mode 100644
index 3e25479bc5f..00000000000
--- a/frontend/src/metabase/collections/components/CollectionHeader/CollectionHeader.styled.tsx
+++ /dev/null
@@ -1,25 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import styled from "@emotion/styled";
-
-import { breakpointMinSmall } from "metabase/styled-components/theme";
-
-export const HeaderRoot = styled.div`
- display: flex;
- justify-content: space-between;
- flex-direction: column;
- margin-bottom: 2rem;
- padding-top: 0.25rem;
-
- ${breakpointMinSmall} {
- align-items: center;
- flex-direction: row;
- padding-top: 0.5rem;
- }
-`;
-
-export const HeaderActions = styled.div`
- display: flex;
- margin-top: 0.5rem;
- align-self: start;
- gap: 0.5rem;
-`;
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/CollectionHeader.tsx b/frontend/src/metabase/collections/components/CollectionHeader/CollectionHeader.tsx
index 0b36557c1de..11bc06fe4f7 100644
--- a/frontend/src/metabase/collections/components/CollectionHeader/CollectionHeader.tsx
+++ b/frontend/src/metabase/collections/components/CollectionHeader/CollectionHeader.tsx
@@ -1,16 +1,18 @@
+import { useUpdateCollectionMutation } from "metabase/api";
import {
isInstanceAnalyticsCollection,
isLibraryCollection,
isTrashedCollection,
} from "metabase/common/collections/utils";
-import type { Collection } from "metabase-types/api";
+import { Flex } from "metabase/ui";
+import type { Collection, UpdateCollectionRequest } from "metabase-types/api";
import { CollectionMenu } from "../CollectionMenu";
import CollectionBookmark from "./CollectionBookmark";
import { CollectionCaption } from "./CollectionCaption";
import { CollectionExportAnalytics } from "./CollectionExportAnalytics";
-import { HeaderActions, HeaderRoot } from "./CollectionHeader.styled";
+import S from "./CollectionHeader.module.css";
import { CollectionInfoSidebarToggle } from "./CollectionInfoSidebarToggle";
import { CollectionNewButton } from "./CollectionNewButton";
import { CollectionPermissions } from "./CollectionPermissions";
@@ -21,25 +23,36 @@ export interface CollectionHeaderProps {
collection: Collection;
isAdmin: boolean;
isBookmarked: boolean;
- onUpdateCollection: (entity: Collection, values: Partial<Collection>) => void;
onCreateBookmark: (collection: Collection) => void;
onDeleteBookmark: (collection: Collection) => void;
canUpload: boolean;
uploadsEnabled: boolean;
- saveFile: (file: File) => void;
+ onSaveFile: (file: File) => void;
}
-const CollectionHeader = ({
+export const CollectionHeader = ({
collection,
isAdmin,
isBookmarked,
- onUpdateCollection,
onCreateBookmark,
onDeleteBookmark,
- saveFile,
+ onSaveFile,
canUpload,
uploadsEnabled,
}: CollectionHeaderProps): JSX.Element => {
+ const [updateCollection] = useUpdateCollectionMutation();
+
+ const handleUpdateCollection = (
+ collection: Collection,
+ values: Partial<Collection>,
+ ) =>
+ // Header edits (rename, description, official marker) only target concrete
+ // writable collections and send fields the update API accepts.
+ updateCollection({
+ id: collection.id,
+ ...values,
+ } as UpdateCollectionRequest);
+
const isTrash = isTrashedCollection(collection);
const isInstanceAnalytics = isInstanceAnalyticsCollection(collection);
const isSemanticLayer = isLibraryCollection(collection);
@@ -53,20 +66,31 @@ const CollectionHeader = ({
const showCollectionMenu = !isInstanceAnalytics && !isSemanticLayer;
return (
- <HeaderRoot>
+ <Flex
+ justify="space-between"
+ direction={{ base: "column", sm: "row" }}
+ align={{ base: "stretch", sm: "center" }}
+ mb="xl"
+ pt={{ base: "xs", sm: "sm" }}
+ >
<CollectionCaption
collection={collection}
- onUpdateCollection={onUpdateCollection}
+ onUpdateCollection={handleUpdateCollection}
/>
{!isTrash && !isSemanticLayer && (
- <HeaderActions data-testid="collection-menu">
+ <Flex
+ className={S.actions}
+ mt="sm"
+ gap="sm"
+ data-testid="collection-menu"
+ >
{showNewButton && <CollectionNewButton />}
{showUploadButton && (
<CollectionUpload
collection={collection}
uploadsEnabled={uploadsEnabled}
isAdmin={isAdmin}
- saveFile={saveFile}
+ onSaveFile={onSaveFile}
/>
)}
{showTimelinesButton && (
@@ -84,20 +108,17 @@ const CollectionHeader = ({
/>
<CollectionInfoSidebarToggle
collection={collection}
- onUpdateCollection={onUpdateCollection}
+ onUpdateCollection={handleUpdateCollection}
/>
{showCollectionMenu && (
<CollectionMenu
collection={collection}
isAdmin={isAdmin}
- onUpdateCollection={onUpdateCollection}
+ onUpdateCollection={handleUpdateCollection}
/>
)}
- </HeaderActions>
+ </Flex>
)}
- </HeaderRoot>
+ </Flex>
);
};
-
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default CollectionHeader;
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/CollectionUpload.styled.tsx b/frontend/src/metabase/collections/components/CollectionHeader/CollectionUpload.styled.tsx
deleted file mode 100644
index d384ed602c6..00000000000
--- a/frontend/src/metabase/collections/components/CollectionHeader/CollectionUpload.styled.tsx
+++ /dev/null
@@ -1,29 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import styled from "@emotion/styled";
-
-export const InfoModalTitle = styled.h2`
- text-align: center;
- font-size: 1.375rem; /* 22px 🤦‍♀️ */
-`;
-
-export const InfoModalBody = styled.div`
- color: var(--mb-color-text-secondary);
-`;
-
-export const NewBadge = styled.div`
- padding: 5px 10px;
- font-size: 0.875rem;
- font-weight: 700;
- color: var(--mb-color-core-brand);
- background-color: var(--mb-color-background_surface-brand-subtle);
- margin: 0 auto;
- border-radius: 6px;
-`;
-
-export const InfoModalContainer = styled.div`
- display: flex;
- flex-direction: column;
- gap: 1rem;
- align-items: center;
- justify-content: center;
-`;
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/CollectionUpload.tsx b/frontend/src/metabase/collections/components/CollectionHeader/CollectionUpload.tsx
index c2717af61f9..73d3e59ba2b 100644
--- a/frontend/src/metabase/collections/components/CollectionHeader/CollectionUpload.tsx
+++ b/frontend/src/metabase/collections/components/CollectionHeader/CollectionUpload.tsx
@@ -17,12 +17,12 @@ export function CollectionUpload({
collection,
uploadsEnabled,
isAdmin,
- saveFile,
+ onSaveFile,
}: {
collection: Collection;
uploadsEnabled: boolean;
isAdmin: boolean;
- saveFile: (file: File) => void;
+ onSaveFile: (file: File) => void;
}) {
const [showInfoModal, setShowInfoModal] = useState(false);
const uploadInputRef = useRef<HTMLInputElement>(null);
@@ -55,7 +55,7 @@ export function CollectionUpload({
trackCSVFileUploadClicked();
const file = event.target.files?.[0];
if (file !== undefined) {
- saveFile(file);
+ onSaveFile(file);
// reset the input so that the same file can be uploaded again
if (uploadInputRef.current) {
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/CollectionUploadInfoModal.tsx b/frontend/src/metabase/collections/components/CollectionHeader/CollectionUploadInfoModal.tsx
index faa2061e7c8..0f074d8fae3 100644
--- a/frontend/src/metabase/collections/components/CollectionHeader/CollectionUploadInfoModal.tsx
+++ b/frontend/src/metabase/collections/components/CollectionHeader/CollectionUploadInfoModal.tsx
@@ -3,14 +3,7 @@ import { t } from "ttag";
import { Link } from "metabase/common/components/Link";
import { useSelector } from "metabase/redux";
import { getApplicationName } from "metabase/selectors/whitelabel";
-import { Button, Modal } from "metabase/ui";
-
-import {
- InfoModalBody,
- InfoModalContainer,
- InfoModalTitle,
- NewBadge,
-} from "./CollectionUpload.styled";
+import { Box, Button, Modal, Stack, Text, Title } from "metabase/ui";
export const UploadInfoModal = ({
isAdmin,
@@ -28,19 +21,33 @@ export const UploadInfoModal = ({
padding="2rem"
styles={{ header: { marginBottom: "1rem" } }}
>
- <InfoModalContainer>
- <NewBadge>{t`New`}</NewBadge>
- <InfoModalTitle>{t`Upload CSVs to ${applicationName}`}</InfoModalTitle>
+ <Stack gap="md" align="center" justify="center">
+ <Text
+ component="div"
+ px="sm"
+ py="xs"
+ fz="md"
+ fw={700}
+ c="core-brand"
+ bg="background_surface-brand-subtle"
+ mx="auto"
+ bdrs="sm"
+ >
+ {t`New`}
+ </Text>
+ <Title order={2} ta="center" fz="xl">
+ {t`Upload CSVs to ${applicationName}`}
+ </Title>
{isAdmin ? (
<>
- <InfoModalBody>
+ <Box c="text-secondary">
<p>
{t`Team members will be able to upload CSV files and work with them just like any other data source.`}
</p>
<p>
{t`You'll be able to pick the default database where the data should be stored when enabling the feature.`}
</p>
- </InfoModalBody>
+ </Box>
<Button
component={Link}
to="/admin/settings/uploads"
@@ -52,15 +59,15 @@ export const UploadInfoModal = ({
</>
) : (
<>
- <InfoModalBody>
+ <Box c="text-secondary">
<p>
{t`You'll need to ask your admin to enable this feature to get started. Then, you'll be able to upload CSV files and work with them just like any other data source.`}
</p>
- </InfoModalBody>
+ </Box>
<Button onClick={onClose}>{t`Got it`}</Button>
</>
)}
- </InfoModalContainer>
+ </Stack>
</Modal>
);
};
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/index.ts b/frontend/src/metabase/collections/components/CollectionHeader/index.ts
index 9977be4b7ff..3ee159fc93b 100644
--- a/frontend/src/metabase/collections/components/CollectionHeader/index.ts
+++ b/frontend/src/metabase/collections/components/CollectionHeader/index.ts
@@ -1,2 +1 @@
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export { default } from "./CollectionHeader";
+export { CollectionHeader } from "./CollectionHeader";
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/tests/common.unit.spec.tsx b/frontend/src/metabase/collections/components/CollectionHeader/tests/common.unit.spec.tsx
index bde608f384a..0849e93bed8 100644
--- a/frontend/src/metabase/collections/components/CollectionHeader/tests/common.unit.spec.tsx
+++ b/frontend/src/metabase/collections/components/CollectionHeader/tests/common.unit.spec.tsx
@@ -1,10 +1,16 @@
import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
import { screen, within } from "__support__/ui";
import type { CollectionId } from "metabase-types/api";
import { setup } from "./setup";
+const lastUpdateRequestBody = (collectionId: CollectionId) =>
+ fetchMock.callHistory
+ .lastCall(`update-collection-${collectionId}`)
+ ?.request?.json();
+
describe("CollectionHeader", () => {
describe("collection name", () => {
it("should be able to edit name with write access", async () => {
@@ -13,7 +19,7 @@ describe("CollectionHeader", () => {
can_write: true,
};
- const { onUpdateCollection, collection: myCollection } = setup({
+ const { collection: myCollection } = setup({
collection,
});
@@ -21,7 +27,7 @@ describe("CollectionHeader", () => {
await userEvent.clear(input);
await userEvent.type(input, `New name{Enter}`);
- expect(onUpdateCollection).toHaveBeenCalledWith(myCollection, {
+ expect(await lastUpdateRequestBody(myCollection.id)).toEqual({
name: "New name",
});
});
@@ -71,7 +77,7 @@ describe("CollectionHeader", () => {
can_write: true,
};
- const { onUpdateCollection, collection: myCollection } = setup({
+ const { collection: myCollection } = setup({
collection,
});
@@ -80,7 +86,7 @@ describe("CollectionHeader", () => {
const longName = "a".repeat(110);
await userEvent.type(input, `${longName}{Enter}`);
- expect(onUpdateCollection).toHaveBeenCalledWith(myCollection, {
+ expect(await lastUpdateRequestBody(myCollection.id)).toEqual({
name: longName.slice(0, 100),
});
});
@@ -93,7 +99,7 @@ describe("CollectionHeader", () => {
can_write: true,
};
- const { onUpdateCollection, collection: myCollection } = setup({
+ const { collection: myCollection } = setup({
collection,
});
@@ -106,7 +112,7 @@ describe("CollectionHeader", () => {
await userEvent.type(input, "New description");
await userEvent.tab();
- expect(onUpdateCollection).toHaveBeenCalledWith(myCollection, {
+ expect(await lastUpdateRequestBody(myCollection.id)).toEqual({
description: "New description",
});
});
@@ -117,7 +123,7 @@ describe("CollectionHeader", () => {
can_write: true,
};
- const { onUpdateCollection, collection: myCollection } = setup({
+ const { collection: myCollection } = setup({
collection,
});
@@ -125,7 +131,7 @@ describe("CollectionHeader", () => {
await userEvent.type(input, "New description");
await userEvent.tab();
- expect(onUpdateCollection).toHaveBeenCalledWith(myCollection, {
+ expect(await lastUpdateRequestBody(myCollection.id)).toEqual({
description: "New description",
});
});
@@ -165,7 +171,7 @@ describe("CollectionHeader", () => {
can_write: true,
};
- const { onUpdateCollection, collection: myCollection } = setup({
+ const { collection: myCollection } = setup({
collection,
});
@@ -179,7 +185,7 @@ describe("CollectionHeader", () => {
await userEvent.type(input, longDescription);
await userEvent.tab();
- expect(onUpdateCollection).toHaveBeenCalledWith(myCollection, {
+ expect(await lastUpdateRequestBody(myCollection.id)).toEqual({
description: longDescription.slice(0, 255),
});
});
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/tests/setup.tsx b/frontend/src/metabase/collections/components/CollectionHeader/tests/setup.tsx
index 66b22de6131..30150a2e69c 100644
--- a/frontend/src/metabase/collections/components/CollectionHeader/tests/setup.tsx
+++ b/frontend/src/metabase/collections/components/CollectionHeader/tests/setup.tsx
@@ -4,6 +4,7 @@ import {
} from "__support__/enterprise";
import {
setupDashboardQuestionCandidatesEndpoint,
+ setupUpdateCollectionEndpoint,
setupUserKeyValueEndpoints,
} from "__support__/server-mocks";
import { mockSettings } from "__support__/settings";
@@ -17,7 +18,7 @@ import {
} from "metabase-types/api/mocks";
import type { CollectionHeaderProps } from "../CollectionHeader";
-import CollectionHeader from "../CollectionHeader";
+import { CollectionHeader } from "../CollectionHeader";
const getProps = (
opts?: Partial<CollectionHeaderProps>,
@@ -27,9 +28,8 @@ const getProps = (
isBookmarked: false,
canUpload: false,
uploadsEnabled: true,
- onUpdateCollection: jest.fn(),
onCreateBookmark: jest.fn(),
- saveFile: jest.fn(),
+ onSaveFile: jest.fn(),
onDeleteBookmark: jest.fn(),
...opts,
});
@@ -66,6 +66,8 @@ export const setup = ({
...otherProps,
});
+ setupUpdateCollectionEndpoint(props.collection);
+
const settings = mockSettings({
"token-features": createMockTokenFeatures(tokenFeatures),
});
diff --git a/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.tsx b/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.tsx
index 3ab28d1032a..d461a0e9c5d 100644
--- a/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.tsx
+++ b/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.tsx
@@ -1,6 +1,7 @@
import { useMemo } from "react";
import _ from "underscore";
+import { skipToken, useListCollectionItemsQuery } from "metabase/api";
import { PinnedItemSortDropTarget } from "metabase/collections/components/PinnedItemSortDropTarget";
import { CompactPinnedItemCard } from "metabase/common/collections/components/CompactPinnedItemCard";
import PinDropZone from "metabase/common/collections/components/PinDropZone";
@@ -8,17 +9,23 @@ import type {
CreateBookmark,
DeleteBookmark,
} from "metabase/common/collections/types";
+import { isRootTrashCollection } from "metabase/common/collections/utils";
import { ItemDragSource } from "metabase/common/components/dnd/ItemDragSource";
import { Box, SimpleGrid, rem } from "metabase/ui";
import type Database from "metabase-lib/v1/metadata/Database";
-import type { Bookmark, Collection, CollectionItem } from "metabase-types/api";
+import type {
+ Bookmark,
+ Collection,
+ CollectionId,
+ CollectionItem,
+} from "metabase-types/api";
type Props = {
databases?: Database[];
bookmarks?: Bookmark[];
createBookmark: CreateBookmark;
deleteBookmark: DeleteBookmark;
- items: CollectionItem[];
+ collectionId: CollectionId;
collection: Collection;
onCopy: (items: CollectionItem[]) => void;
onMove: (items: CollectionItem[]) => void;
@@ -29,17 +36,31 @@ export function PinnedItemsGrid({
bookmarks,
createBookmark,
deleteBookmark,
- items,
+ collectionId,
collection,
onCopy,
onMove,
}: Props) {
- const sortedItems = useMemo(
- () => _.sortBy(items, (item) => item.collection_position),
- [items],
+ // Trashed items keep their pin position, but the trash never shows a pinned section.
+ const showPinnedItems = !isRootTrashCollection(collection);
+
+ const { data: pinnedItemsData } = useListCollectionItemsQuery(
+ showPinnedItems
+ ? {
+ id: collectionId,
+ pinned_state: "is_pinned",
+ sort_column: "name",
+ sort_direction: "asc",
+ }
+ : skipToken,
);
- if (items.length === 0) {
+ const sortedItems = useMemo(() => {
+ const items = pinnedItemsData?.data ?? [];
+ return _.sortBy(items, (item) => item.collection_position);
+ }, [pinnedItemsData]);
+
+ if (sortedItems.length === 0) {
return (
<Box mb={rem(48)} pos="relative">
<PinDropZone variant="pin" empty />
diff --git a/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.unit.spec.tsx b/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.unit.spec.tsx
index e32cdc622ff..86c75382207 100644
--- a/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.unit.spec.tsx
+++ b/frontend/src/metabase/collections/components/PinnedItemsGrid/PinnedItemsGrid.unit.spec.tsx
@@ -1,3 +1,4 @@
+import { setupCollectionItemsEndpoint } from "__support__/server-mocks";
import { renderWithProviders, screen, within } from "__support__/ui";
import type { Collection, CollectionItem } from "metabase-types/api";
import {
@@ -58,9 +59,11 @@ function setup({
mockOnCopy.mockReset();
mockOnMove.mockReset();
+ setupCollectionItemsEndpoint({ collection, collectionItems: items });
+
return renderWithProviders(
<PinnedItemsGrid
- items={items}
+ collectionId={collection.id}
collection={collection}
onCopy={mockOnCopy}
onMove={mockOnMove}
@@ -74,17 +77,18 @@ function setup({
}
describe("PinnedItemsGrid", () => {
- it("should render pinned items of all types in one section", () => {
+ it("should render pinned items of all types in one section", async () => {
setup();
- const section = within(screen.getByTestId("pinned-items"));
+ const section = within(await screen.findByTestId("pinned-items"));
expect(section.getByText(dashboardItem.name)).toBeInTheDocument();
expect(section.getByText(metricItem.name)).toBeInTheDocument();
expect(section.getByText(questionItem.name)).toBeInTheDocument();
expect(section.getByText(modelItem.name)).toBeInTheDocument();
});
- it("should not group items into typed sections", () => {
+ it("should not group items into typed sections", async () => {
setup();
+ await screen.findByTestId("pinned-items");
expect(screen.queryByText("Metrics")).not.toBeInTheDocument();
expect(screen.queryByText("Pinned questions")).not.toBeInTheDocument();
expect(screen.queryByText("Dashboards")).not.toBeInTheDocument();
@@ -95,9 +99,9 @@ describe("PinnedItemsGrid", () => {
).not.toBeInTheDocument();
});
- it("should render items sorted by collection_position across types", () => {
+ it("should render items sorted by collection_position across types", async () => {
setup();
- const names = screen.getAllByText(
+ const names = await screen.findAllByText(
/Dashboard Foo|Metric Bar|Question Baz|Model Qux/,
);
expect(names.map((name) => name.textContent)).toEqual([
diff --git a/frontend/src/metabase/collections/components/UploadOverlay/UploadOverlay.module.css b/frontend/src/metabase/collections/components/UploadOverlay/UploadOverlay.module.css
new file mode 100644
index 00000000000..237f1dbfbfb
--- /dev/null
+++ b/frontend/src/metabase/collections/components/UploadOverlay/UploadOverlay.module.css
@@ -0,0 +1,6 @@
+.overlay {
+ z-index: 1;
+ border: 1px dashed var(--mb-color-core-brand);
+ transition: opacity 0.2s;
+ pointer-events: none;
+}
diff --git a/frontend/src/metabase/collections/components/UploadOverlay/UploadOverlay.styled.tsx b/frontend/src/metabase/collections/components/UploadOverlay/UploadOverlay.styled.tsx
deleted file mode 100644
index 525402f95eb..00000000000
--- a/frontend/src/metabase/collections/components/UploadOverlay/UploadOverlay.styled.tsx
+++ /dev/null
@@ -1,27 +0,0 @@
-// eslint-disable-next-line no-restricted-imports
-import styled from "@emotion/styled";
-
-export const DragOverlay = styled.div<{ isDragActive: boolean }>`
- position: absolute;
- top: 0;
- left: 0;
- right: 0;
- bottom: 0;
- z-index: 1;
- display: flex;
- flex-direction: column;
- justify-content: center;
- align-items: center;
- gap: 1rem;
- background-color: var(--mb-color-background_surface-brand-subtle);
- opacity: ${(props) => (props.isDragActive ? 0.9 : 0)};
- transition: opacity 0.2s;
- border: 1px dashed var(--mb-color-core-brand);
- border-radius: 0.5rem;
- margin: 0.5rem 4%;
- padding: 4rem;
- color: var(--mb-color-core-brand);
- font-size: 1.125rem;
- font-weight: bold;
- pointer-events: none;
-`;
diff --git a/frontend/src/metabase/collections/components/UploadOverlay/UploadOverlay.tsx b/frontend/src/metabase/collections/components/UploadOverlay/UploadOverlay.tsx
index e88c314179a..901da54f627 100644
--- a/frontend/src/metabase/collections/components/UploadOverlay/UploadOverlay.tsx
+++ b/frontend/src/metabase/collections/components/UploadOverlay/UploadOverlay.tsx
@@ -1,9 +1,9 @@
import { t } from "ttag";
-import { Icon } from "metabase/ui";
+import { Flex, Icon, rem } from "metabase/ui";
import type { Collection } from "metabase-types/api";
-import { DragOverlay } from "./UploadOverlay.styled";
+import S from "./UploadOverlay.module.css";
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default function UploadOverlay({
@@ -14,9 +14,29 @@ export default function UploadOverlay({
collection: Collection;
}) {
return (
- <DragOverlay isDragActive={isDragActive}>
+ <Flex
+ className={S.overlay}
+ pos="absolute"
+ top={0}
+ left={0}
+ right={0}
+ bottom={0}
+ direction="column"
+ justify="center"
+ align="center"
+ gap="md"
+ mx="4%"
+ my="sm"
+ p={rem(64)}
+ bdrs="md"
+ bg="background_surface-brand-subtle"
+ c="core-brand"
+ fz="lg"
+ fw="bold"
+ opacity={isDragActive ? 0.9 : 0}
+ >
<Icon name="upload" size="24" />
<div>{t`Drop here to upload to ${collection.name}`}</div>
- </DragOverlay>
+ </Flex>
);
}
diff --git a/frontend/src/metabase/collections/containers/CollectionHeader/CollectionHeader.tsx b/frontend/src/metabase/collections/containers/CollectionHeader/CollectionHeader.tsx
deleted file mode 100644
index acc0bfd9deb..00000000000
--- a/frontend/src/metabase/collections/containers/CollectionHeader/CollectionHeader.tsx
+++ /dev/null
@@ -1,20 +0,0 @@
-import { collectionApi } from "metabase/api";
-import { connect } from "metabase/redux";
-import { uploadFile } from "metabase/redux/uploads";
-import type { Collection } from "metabase-types/api";
-
-import CollectionHeader from "../../components/CollectionHeader";
-
-const mapDispatchToProps = {
- onUpdateCollection: (collection: Collection, values: Partial<Collection>) =>
- // Unjustified type cast. FIXME
- collectionApi.endpoints.updateCollection.initiate({
- id: collection.id,
- ...values,
- } as any),
-
- onUpload: uploadFile,
-};
-
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default connect(null, mapDispatchToProps)(CollectionHeader);
diff --git a/frontend/src/metabase/collections/containers/CollectionHeader/index.ts b/frontend/src/metabase/collections/containers/CollectionHeader/index.ts
deleted file mode 100644
index 9977be4b7ff..00000000000
--- a/frontend/src/metabase/collections/containers/CollectionHeader/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export { default } from "./CollectionHeader";
diff --git a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx
index 3340fe0af2e..6bee0acc11f 100644
--- a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx
+++ b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.tsx
@@ -135,7 +135,7 @@ function ActionMenuInner({
trackCollectionItemBookmarked(item);
}
const normalizedModel = normalizeItemModel(item);
- toggleBookmark?.(item.id.toString(), normalizedModel);
+ toggleBookmark?.({ id: item.id, type: normalizedModel });
};
return handler;
}, [createBookmark, deleteBookmark, isBookmarked, item]);
diff --git a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx
index 21495702ad7..174814fa65e 100644
--- a/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx
+++ b/frontend/src/metabase/common/collections/components/ActionMenu/ActionMenu.unit.spec.tsx
@@ -23,6 +23,7 @@ interface SetupOpts {
collection?: Collection;
databases?: Database[];
isXrayEnabled?: boolean;
+ withBookmarks?: boolean;
}
const setup = ({
@@ -30,6 +31,7 @@ const setup = ({
collection = createMockCollection({ can_write: true }),
databases = [],
isXrayEnabled = false,
+ withBookmarks = false,
}: SetupOpts) => {
const storeInitialState = createMockState({
entities: createMockEntitiesState({
@@ -43,6 +45,8 @@ const setup = ({
const metadata = getMetadata(storeInitialState);
const onCopy = jest.fn();
const onMove = jest.fn();
+ const createBookmark = withBookmarks ? jest.fn() : undefined;
+ const deleteBookmark = withBookmarks ? jest.fn() : undefined;
renderWithProviders(
<ActionMenu
@@ -51,14 +55,34 @@ const setup = ({
databases={metadata.databasesList()}
onCopy={onCopy}
onMove={onMove}
+ createBookmark={createBookmark}
+ deleteBookmark={deleteBookmark}
/>,
{ storeInitialState },
);
- return { onCopy, onMove };
+ return { onCopy, onMove, createBookmark, deleteBookmark };
};
describe("ActionMenu", () => {
+ describe("bookmarks", () => {
+ it("should bookmark an item with its id and model", async () => {
+ const item = createMockCollectionItem({
+ id: 1,
+ name: "Dashboard",
+ model: "dashboard",
+ can_write: true,
+ });
+
+ const { createBookmark } = setup({ item, withBookmarks: true });
+
+ await userEvent.click(getIcon("ellipsis"));
+ await userEvent.click(await screen.findByText("Bookmark"));
+
+ expect(createBookmark).toHaveBeenCalledWith({ id: 1, type: "dashboard" });
+ });
+ });
+
describe("moving and archiving", () => {
it("should duplicate an item", async () => {
const item = createMockCollectionItem({
@@ -112,9 +136,11 @@ describe("ActionMenu", () => {
personal_owner_id: 1,
});
- setup({ item });
+ setup({ item, withBookmarks: true });
- expect(queryIcon("ellipsis")).not.toBeInTheDocument();
+ await userEvent.click(getIcon("ellipsis"));
+
+ expect(await screen.findByText("Bookmark")).toBeInTheDocument();
expect(screen.queryByText("Move")).not.toBeInTheDocument();
expect(screen.queryByText("Move to trash")).not.toBeInTheDocument();
});
@@ -126,12 +152,26 @@ describe("ActionMenu", () => {
can_write: false,
});
- setup({ item });
+ setup({ item, withBookmarks: true });
- expect(queryIcon("ellipsis")).not.toBeInTheDocument();
+ await userEvent.click(getIcon("ellipsis"));
+
+ expect(await screen.findByText("Bookmark")).toBeInTheDocument();
expect(screen.queryByText("Move")).not.toBeInTheDocument();
expect(screen.queryByText("Move to trash")).not.toBeInTheDocument();
});
+
+ it("should not render the menu at all when no actions are available", () => {
+ const item = createMockCollectionItem({
+ name: "My Read Only collection",
+ model: "collection",
+ can_write: false,
+ });
+
+ setup({ item, withBookmarks: false });
+
+ expect(queryIcon("ellipsis")).not.toBeInTheDocument();
+ });
});
describe("x-rays", () => {
diff --git a/frontend/src/metabase/common/collections/types.ts b/frontend/src/metabase/common/collections/types.ts
index 7ca991c1e00..37eb71cc068 100644
--- a/frontend/src/metabase/common/collections/types.ts
+++ b/frontend/src/metabase/common/collections/types.ts
@@ -1,15 +1,15 @@
import type { UploadMode } from "metabase/redux/store/upload";
import type { ColorName } from "metabase/ui/colors/types";
import type {
- BookmarkId,
- BookmarkType,
CardId,
Collection,
CollectionAuthorityLevel,
CollectionId,
CollectionItem,
CollectionType,
+ CreateBookmarkRequest,
Dashboard,
+ DeleteBookmarkRequest,
IconName,
TableId,
} from "metabase-types/api";
@@ -72,9 +72,6 @@ export type OnToggleBookmark = () => void | null;
export type OnDrop = () => void;
export type OnToggleSelected = () => void | null;
export type OnToggleSelectedWithItem = (item: CollectionItem) => void;
-export type CreateBookmark = (id: BookmarkId, collection: BookmarkType) => void;
-export type DeleteBookmark = (id: BookmarkId, type: BookmarkType) => void;
+export type CreateBookmark = (request: CreateBookmarkRequest) => void;
+export type DeleteBookmark = (request: DeleteBookmarkRequest) => void;
export type OnFileUpload = (props: CollectionOrTableIdProps) => void;
-export type UploadFile = (
- props: { file: File } & CollectionOrTableIdProps,
-) => void;
diff --git a/frontend/test/__support__/server-mocks/collection.ts b/frontend/test/__support__/server-mocks/collection.ts
index 662f6aa1913..3dcf73ee2d8 100644
--- a/frontend/test/__support__/server-mocks/collection.ts
+++ b/frontend/test/__support__/server-mocks/collection.ts
@@ -155,6 +155,16 @@ export function setupCollectionVirtualSchemaEndpoints(
});
}
+function matchesPinnedState(item: CollectionItem, pinnedState: string | null) {
+ if (pinnedState === "is_pinned") {
+ return item.collection_position != null;
+ }
+ if (pinnedState === "is_not_pinned") {
+ return item.collection_position == null;
+ }
+ return true;
+}
+
function handleCollectionItemsResponse({
call,
collectionItems,
@@ -166,13 +176,14 @@ function handleCollectionItemsResponse({
}) {
const url = new URL(call.url);
const models = modelsParam ?? url.searchParams.getAll("models");
+ const pinnedState = url.searchParams.get("pinned_state");
// As in the API, requesting no models at all returns every item.
const matchedItems: CollectionItem[] = models.includes("no_models")
? []
- : collectionItems.filter(
- ({ model }) => models.length === 0 || models.includes(model),
- );
+ : collectionItems
+ .filter(({ model }) => models.length === 0 || models.includes(model))
+ .filter((item) => matchesPinnedState(item, pinnedState));
const q = url.searchParams.get("q")?.toLowerCase().trim();
const searchedItems = q