The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Fix missing synced/official icons on collection bookmarks (#72988)
Andrei Chernykh1179d5cd60bb
diff --git a/enterprise/frontend/src/metabase-enterprise/collections/utils.ts b/enterprise/frontend/src/metabase-enterprise/collections/utils.tsindex 29d710b2b50..531437e21de 100644--- a/enterprise/frontend/src/metabase-enterprise/collections/utils.ts+++ b/enterprise/frontend/src/metabase-enterprise/collections/utils.ts@@ -93,6 +93,7 @@ export const getIcon = (return {name: OFFICIAL_COLLECTION.icon,color: OFFICIAL_COLLECTION.color,+ tooltip: OFFICIAL_COLLECTION.tooltips?.default,};}}diff --git a/enterprise/frontend/src/metabase-enterprise/collections/utils.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/collections/utils.unit.spec.tsxindex 69bc3320c06..006b14e3841 100644--- a/enterprise/frontend/src/metabase-enterprise/collections/utils.unit.spec.tsx+++ b/enterprise/frontend/src/metabase-enterprise/collections/utils.unit.spec.tsx@@ -88,7 +88,11 @@ describe("Collections plugin utils", () => {it("should return the correct icon for an official collection", () => {expect(getIcon({ model: "collection", authority_level: "official" }),- ).toEqual({ name: "official_collection", color: "saturated-yellow" });+ ).toEqual({+ name: "official_collection",+ color: "saturated-yellow",+ tooltip: "Official collection",+ });});it("should return the correct icon for a remote synced collection", () => {diff --git a/frontend/src/metabase-types/api/bookmark.ts b/frontend/src/metabase-types/api/bookmark.tsindex 60e901eee0d..f6d66bbafc4 100644--- a/frontend/src/metabase-types/api/bookmark.ts+++ b/frontend/src/metabase-types/api/bookmark.ts@@ -29,6 +29,10 @@ export interface Bookmark {* Defined only when bookmark.type is "card"*/card_type?: CardType;+ /**+ * Defined only when bookmark.type is "collection"+ */+ is_remote_synced?: boolean;}export interface BookmarkOrdering {diff --git a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BookmarkList/BookmarkList.tsx b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BookmarkList/BookmarkList.tsxindex eb8c0cbcc7d..0a672574363 100644--- a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BookmarkList/BookmarkList.tsx+++ b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BookmarkList/BookmarkList.tsx@@ -16,7 +16,8 @@ import { Sortable } from "metabase/common/components/Sortable";import GrabberS from "metabase/css/components/grabber.module.css";import { Bookmarks } from "metabase/entities/bookmarks";import { PLUGIN_COLLECTIONS } from "metabase/plugins";-import { connect } from "metabase/redux";+import { connect, useSelector } from "metabase/redux";+import { getIsTenantUser } from "metabase/selectors/user";import { Icon, Tooltip } from "metabase/ui";import { getIcon } from "metabase/utils/icon";import * as Urls from "metabase/utils/urls";@@ -82,11 +83,17 @@ const BookmarkItem = ({}: BookmarkItemProps) => {const isSelected = isBookmarkSelected(bookmark, selectedItem);const url = Urls.bookmark(bookmark);-- const icon = getIcon({- model: getBookmarkModel(bookmark),- display: bookmark.display,- });+ const isTenantUser = useSelector(getIsTenantUser);++ const icon = getIcon(+ {+ model: getBookmarkModel(bookmark),+ display: bookmark.display,+ authority_level: bookmark.authority_level,+ is_remote_synced: bookmark.is_remote_synced,+ },+ { isTenantUser },+ );const onRemove = () => onDeleteBookmark(bookmark);const isIrregularCollection =diff --git a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BookmarkList/BookmarkList.unit.spec.tsx b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BookmarkList/BookmarkList.unit.spec.tsxindex c501073e056..b3e52b20f0b 100644--- a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BookmarkList/BookmarkList.unit.spec.tsx+++ b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/BookmarkList/BookmarkList.unit.spec.tsx@@ -1,8 +1,14 @@import type { ComponentProps } from "react";import { times } from "underscore";-import { renderWithProviders, screen } from "__support__/ui";-import { createMockBookmark } from "metabase-types/api/mocks";+import { setupEnterprisePlugins } from "__support__/enterprise";+import { mockSettings } from "__support__/settings";+import { renderWithProviders, screen, within } from "__support__/ui";+import { createMockState } from "metabase/redux/store/mocks";+import {+ createMockBookmark,+ createMockTokenFeatures,+} from "metabase-types/api/mocks";import BookmarkList from "./BookmarkList";@@ -14,6 +20,17 @@ const mockProps: ComponentProps<typeof BookmarkList> = {initialState: "expanded",};+const enterpriseState = createMockState({+ settings: mockSettings({+ "token-features": createMockTokenFeatures({+ remote_sync: true,+ official_collections: true,+ audit_app: true,+ }),+ }),+});+setupEnterprisePlugins();+const createBookmarks = (howMany: number) => {return times(howMany, (i) => {const n = i + 1;@@ -50,4 +67,38 @@ describe("BookmarkList", () => {expect(screen.queryByLabelText("grabber icon")).not.toBeInTheDocument();});++ describe("collection bookmark icons (enterprise)", () => {+ it.each([+ {+ name: "Synced",+ icon: "synced_collection",+ overrides: { is_remote_synced: true },+ },+ {+ name: "Official",+ icon: "official_collection",+ overrides: { authority_level: "official" },+ },+ { name: "Regular", icon: "folder", overrides: {} },+ ])(+ "renders the $icon icon for $name collection bookmarks",+ ({ name, icon, overrides }) => {+ renderWithProviders(+ <BookmarkList+ {...mockProps}+ bookmarks={[+ createMockBookmark({ type: "collection", name, ...overrides }),+ ]}+ />,+ { storeInitialState: enterpriseState },+ );++ const row = screen.getByText(name).closest("a");+ expect(+ within(row as HTMLElement).getByLabelText(`${icon} icon`),+ ).toBeInTheDocument();+ },+ );+ });});diff --git a/frontend/src/metabase/ui/components/icons/Icon/Icon.tsx b/frontend/src/metabase/ui/components/icons/Icon/Icon.tsxindex d9bba71ef79..b37e5a11302 100644--- a/frontend/src/metabase/ui/components/icons/Icon/Icon.tsx+++ b/frontend/src/metabase/ui/components/icons/Icon/Icon.tsx@@ -5,6 +5,7 @@ import cx from "classnames";import type { MouseEvent, ReactNode, SVGAttributes } from "react";import { forwardRef } from "react";+import { ALL_COLOR_NAMES } from "metabase/ui/colors/constants/color-names";import type { ColorName } from "metabase/ui/colors/types";import { Tooltip } from "../../overlays/Tooltip";@@ -12,6 +13,17 @@ import { Tooltip } from "../../overlays/Tooltip";import type { IconName } from "./icons";import { Icons } from "./icons";+const PALETTE_KEYS = new Set<string>(ALL_COLOR_NAMES);++/**+ * Mantine's `Box` forwards the `color` prop to the SVG as a presentation+ * attribute, so it only honors valid CSS color strings — bare palette keys+ * like `"saturated-yellow"` are silently ignored. Resolve known palette keys+ * to their `--mb-color-*` CSS variables; pass other strings through.+ */+const resolveIconColor = (color: string | undefined) =>+ color != null && PALETTE_KEYS.has(color) ? `var(--mb-color-${color})` : color;+const defaultSize = 16;export type IconProps = Omit<SVGAttributes<SVGSVGElement>, "color"> &@@ -38,6 +50,13 @@ export const Icon = forwardRef<SVGSVGElement, IconProps>(function Icon() {const IconComponent = (Icons[name] ?? Icons["unknown"]).component;+ // Box forwards `color` as a raw SVG presentation attribute, so palette keys+ // like "saturated-yellow" don't render — only valid CSS color strings do.+ // Resolve known palette keys to their `--mb-color-*` CSS variables.+ if ("color" in restProps) {+ restProps.color = resolveIconColor(restProps.color) as ColorName;+ }+const icon = (<Boxcomponent={IconComponent}diff --git a/frontend/src/metabase/utils/icon.ts b/frontend/src/metabase/utils/icon.tsindex b4f4952effa..b4c2f836804 100644--- a/frontend/src/metabase/utils/icon.ts+++ b/frontend/src/metabase/utils/icon.ts@@ -67,6 +67,7 @@ export const modelIconMap: Record<IconModel, IconName> = {export type IconData = {name: IconName;color?: ColorName;+ tooltip?: string;};/** get an Icon for any entity object, doesn't depend on the entity system */diff --git a/src/metabase/bookmarks/models/bookmark.clj b/src/metabase/bookmarks/models/bookmark.cljindex c9aa258342c..3db63aaec20 100644--- a/src/metabase/bookmarks/models/bookmark.clj+++ b/src/metabase/bookmarks/models/bookmark.clj@@ -31,14 +31,15 @@id. This is required for the frontend entity loading system and does not refer to any particular bookmark id,although the compound key can be inferred from it."[:map {:closed true}- [:id :string]+ [:id :string][:type [:enum "card" "collection" "dashboard" "document"]]- [:item_id ms/PositiveInt]- [:name ms/NonBlankString]- [:authority_level {:optional true} [:maybe :string]]- [:card_type {:optional true} [:maybe ::queries.schema/card-type]]- [:description {:optional true} [:maybe :string]]- [:display {:optional true} [:maybe :string]]])+ [:item_id ms/PositiveInt]+ [:name ms/NonBlankString]+ [:authority_level {:optional true} [:maybe :string]]+ [:is_remote_synced {:optional true} :boolean]+ [:card_type {:optional true} [:maybe ::queries.schema/card-type]]+ [:description {:optional true} [:maybe :string]]+ [:display {:optional true} [:maybe :string]]])(mu/defn- normalize-bookmark-result :- BookmarkResult"Normalizes bookmark results. Bookmarks are left joined against the card, collection, dashboard, and document tables, but only@@ -59,7 +60,7 @@(:card_type normalized-result) (update :card_type keyword))](-> normalized-result(select-keys [:item_id :type :name :card_type :description :display- :authority_level])+ :authority_level :is_remote_synced])(assoc :id id-str))))(defn- bookmarks-union-query@@ -118,10 +119,11 @@[:dashboard.name (mdb/qualify :model/Dashboard :name)][:dashboard.description (mdb/qualify :model/Dashboard :description)][:dashboard.archived (mdb/qualify :model/Dashboard :archived)]- [:collection.name (mdb/qualify :model/Collection :name)]- [:collection.authority_level (mdb/qualify :model/Collection :authority_level)]- [:collection.description (mdb/qualify :model/Collection :description)]- [:collection.archived (mdb/qualify :model/Collection :archived)]+ [:collection.name (mdb/qualify :model/Collection :name)]+ [:collection.authority_level (mdb/qualify :model/Collection :authority_level)]+ [:collection.is_remote_synced (mdb/qualify :model/Collection :is_remote_synced)]+ [:collection.description (mdb/qualify :model/Collection :description)]+ [:collection.archived (mdb/qualify :model/Collection :archived)][:document.name (mdb/qualify :model/Document :name)][:document.archived (mdb/qualify :model/Document :archived)]]left-joins [[:report_card :card] [:= :bookmark.card_id :card.id]diff --git a/test/metabase/bookmarks/api_test.clj b/test/metabase/bookmarks/api_test.cljindex f44812a0a01..8a4ee1c9305 100644--- a/test/metabase/bookmarks/api_test.clj+++ b/test/metabase/bookmarks/api_test.clj@@ -75,6 +75,15 @@:else(throw (ex-info "Unknown type" {:user-id user-id :model model})))))+(deftest synced-collection-bookmark-test+ (testing "GET /api/bookmark returns is_remote_synced: true for remote-synced collection bookmarks"+ (mt/with-temp [:model/Collection synced-coll {:name "Synced" :is_remote_synced true}]+ (bookmark-models (mt/user->id :rasta) synced-coll)+ (is (true? (->> (mt/user-http-request :rasta :get 200 "bookmark")+ (filter #(= (:name %) "Synced"))+ first+ :is_remote_synced))))))+(deftest bookmarks-on-archived-items-test(testing "POST /api/bookmark/:model/:model-id"(mt/with-temp [:model/Collection archived-collection {:name "Test Collection"