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
Make metabase/ui side-effect free (#79962)
Frasere247190827f6
diff --git a/frontend/build/shared/rspack/side-effect-free-modules.js b/frontend/build/shared/rspack/side-effect-free-modules.jsindex 13a464bbed1..d34cf33be78 100644--- a/frontend/build/shared/rspack/side-effect-free-modules.js+++ b/frontend/build/shared/rspack/side-effect-free-modules.js@@ -33,6 +33,7 @@ const SIDE_EFFECT_FREE_PATHS = [// the lezer tokenizer, so a picker importing only `getClauseDefinition` from it// would otherwise pull CodeMirror into the initial bundle.path.join(REPO_ROOT, "frontend/src/metabase/querying/expressions") + path.sep,+ path.join(REPO_ROOT, "frontend/src/metabase/ui") + path.sep,];/**@@ -52,9 +53,22 @@ const SIDE_EFFECT_PATHS = [REPO_ROOT,"frontend/src/metabase/querying/expressions/pratt/syntax.ts",),+ // Installs our wrapped dropdown on Mantine's own Popover object. Mantine's+ // Combobox, Menu, ColorInput and HoverCard render `Popover.Dropdown`+ // internally, so a bundle that never imports our `Popover` still depends on+ // the replacement having run. ThemeProvider bare-imports it.+ path.join(+ REPO_ROOT,+ "frontend/src/metabase/ui/components/overlays/Popover/register-popover-dropdown.ts",+ ),];const SIDE_EFFECT_FREE_RULE = {+ // Script files only. A CSS module imported for its class names is reachable+ // only through the script that imports it, so it is dropped with that script+ // and needs no flag of its own; leaving CSS at rspack's default also keeps a+ // stray `import "./x.css"` from being shaken should one slip past the lint.+ test: /\.[jt]sx?$/,include: SIDE_EFFECT_FREE_PATHS,// Prefix-matched like `include`, so a directory entry excludes its whole tree.exclude: SIDE_EFFECT_PATHS,diff --git a/frontend/lint/side-effect-files.json b/frontend/lint/side-effect-files.jsonindex d9fbc44f33b..5327537ed7f 100644--- a/frontend/lint/side-effect-files.json+++ b/frontend/lint/side-effect-files.json@@ -197,8 +197,7 @@"frontend/src/metabase/transforms/components/TagMultiSelect/UpdateTagModal/UpdateTagModal.tsx": "self","frontend/src/metabase/transforms/pages/NewTransformPage/CreateTransformModal/form.ts": "self","frontend/src/metabase/transforms/pages/TransformSettingsPage/TransformSettingsSection/UpdateTargetModal/UpdateTargetModal.tsx": "self",- "frontend/src/metabase/ui/components/overlays/HoverCard/index.tsx": "global",- "frontend/src/metabase/ui/components/overlays/Popover/index.tsx": "global",+ "frontend/src/metabase/ui/components/overlays/Popover/register-popover-dropdown.ts": "global","frontend/src/metabase/utils/csp-setup.ts": "global","frontend/src/metabase/utils/date-time.ts": "self","frontend/src/metabase/utils/i18n.ts": "global",diff --git a/frontend/src/metabase/ui/components/overlays/HoverCard/index.tsx b/frontend/src/metabase/ui/components/overlays/HoverCard/index.tsxindex 44e0c5677d1..2b828f15148 100644--- a/frontend/src/metabase/ui/components/overlays/HoverCard/index.tsx+++ b/frontend/src/metabase/ui/components/overlays/HoverCard/index.tsx@@ -1,29 +1,3 @@-import {- type HoverCardDropdownProps,- HoverCard as MantineHoverCard,-} from "@mantine/core";--import { PreventEagerPortal } from "metabase/ui";-import { OverlayStackItem } from "metabase/ui/components/overlays/overlay-stack";-export { hoverCardOverrides } from "./HoverCard.config";-+export { HoverCard } from "@mantine/core";export type { HoverCardDropdownProps, HoverCardProps } from "@mantine/core";--const MantineHoverCardDropdown = MantineHoverCard.Dropdown;-const HoverCardDropdown = function Dropdown({- children,- ...props-}: HoverCardDropdownProps) {- return (- <PreventEagerPortal {...props}>- <MantineHoverCardDropdown {...props}>- <OverlayStackItem />- {children}- </MantineHoverCardDropdown>- </PreventEagerPortal>- );-};-HoverCardDropdown.displayName = MantineHoverCardDropdown.displayName;-MantineHoverCard.Dropdown = HoverCardDropdown;--export const HoverCard: typeof MantineHoverCard = MantineHoverCard;+export { hoverCardOverrides } from "./HoverCard.config";diff --git a/frontend/src/metabase/ui/components/overlays/Menu/Menu.tsx b/frontend/src/metabase/ui/components/overlays/Menu/Menu.tsxindex e1e6265bd49..072f82f51be 100644--- a/frontend/src/metabase/ui/components/overlays/Menu/Menu.tsx+++ b/frontend/src/metabase/ui/components/overlays/Menu/Menu.tsx@@ -1,7 +1,6 @@import type { MenuProps } from "@mantine/core";import { Menu as MantineMenu } from "@mantine/core";-import { MenuDropdown } from "./MenuDropdown";import { MenuItem } from "./MenuItem";export function Menu(props: MenuProps) {@@ -9,7 +8,7 @@ export function Menu(props: MenuProps) {}Menu.Target = MantineMenu.Target;-Menu.Dropdown = MenuDropdown;+Menu.Dropdown = MantineMenu.Dropdown;Menu.Item = MenuItem;Menu.Label = MantineMenu.Label;Menu.Divider = MantineMenu.Divider;diff --git a/frontend/src/metabase/ui/components/overlays/Menu/MenuDropdown/MenuDropdown.tsx b/frontend/src/metabase/ui/components/overlays/Menu/MenuDropdown/MenuDropdown.tsxdeleted file mode 100644index 426f2e43531..00000000000--- a/frontend/src/metabase/ui/components/overlays/Menu/MenuDropdown/MenuDropdown.tsx+++ /dev/null@@ -1,21 +0,0 @@-import type { MenuDropdownProps } from "@mantine/core";-import { Menu } from "@mantine/core";-import type { Ref } from "react";-import { forwardRef } from "react";--import { PreventEagerPortal } from "metabase/ui";-import { OverlayStackItem } from "metabase/ui/components/overlays/overlay-stack";--export const MenuDropdown = forwardRef(function MenuDropdown(- { children, ...props }: MenuDropdownProps,- ref: Ref<HTMLDivElement>,-) {- return (- <PreventEagerPortal {...props}>- <Menu.Dropdown {...props} data-element-id="mantine-popover" ref={ref}>- <OverlayStackItem />- {children}- </Menu.Dropdown>- </PreventEagerPortal>- );-});diff --git a/frontend/src/metabase/ui/components/overlays/Menu/MenuDropdown/index.ts b/frontend/src/metabase/ui/components/overlays/Menu/MenuDropdown/index.tsdeleted file mode 100644index 5b84b9b2d3d..00000000000--- a/frontend/src/metabase/ui/components/overlays/Menu/MenuDropdown/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from "./MenuDropdown";diff --git a/frontend/src/metabase/ui/components/overlays/Popover/PopoverDropdown.tsx b/frontend/src/metabase/ui/components/overlays/Popover/PopoverDropdown.tsxnew file mode 100644index 00000000000..6da742b64e1--- /dev/null+++ b/frontend/src/metabase/ui/components/overlays/Popover/PopoverDropdown.tsx@@ -0,0 +1,42 @@+import {+ type Factory,+ Popover as MantinePopover,+ type PopoverDropdownProps,+ type PopoverStylesNames,+ factory,+} from "@mantine/core";+import cx from "classnames";++import ZIndex from "metabase/css/core/z-index.module.css";+import { PreventEagerPortal } from "metabase/ui/components/utils/PreventEagerPortal";++import { OverlayStackItem } from "../overlay-stack";++const MantinePopoverDropdown = MantinePopover.Dropdown;++type PopoverDropdownFactory = Factory<{+ props: PopoverDropdownProps;+ ref: HTMLDivElement;+ stylesNames: PopoverStylesNames;+ compound: true;+}>;++export const PopoverDropdown = factory<PopoverDropdownFactory>(+ function PopoverDropdown({ children, ...props }, ref) {+ return (+ <PreventEagerPortal {...props}>+ <MantinePopoverDropdown+ {...props}+ className={cx(props.className, ZIndex.Overlay)}+ data-element-id="mantine-popover"+ ref={ref}+ >+ <OverlayStackItem />+ {children}+ </MantinePopoverDropdown>+ </PreventEagerPortal>+ );+ },+);+PopoverDropdown.classes = MantinePopoverDropdown.classes;+PopoverDropdown.displayName = MantinePopoverDropdown.displayName;diff --git a/frontend/src/metabase/ui/components/overlays/Popover/index.tsx b/frontend/src/metabase/ui/components/overlays/Popover/index.tsxindex 397e6b3dede..39d4c2a3e7a 100644--- a/frontend/src/metabase/ui/components/overlays/Popover/index.tsx+++ b/frontend/src/metabase/ui/components/overlays/Popover/index.tsx@@ -1,39 +1,3 @@-import type { PopoverDropdownProps } from "@mantine/core";-import { Popover as MantinePopover } from "@mantine/core";-import cx from "classnames";-import { type Ref, forwardRef } from "react";--import ZIndex from "metabase/css/core/z-index.module.css";-import { PreventEagerPortal } from "metabase/ui";-import { OverlayStackItem } from "metabase/ui/components/overlays/overlay-stack";-+export { Popover } from "@mantine/core";export type { PopoverProps } from "@mantine/core";-export { popoverOverrides } from "./Popover.config";--const MantinePopoverDropdown = MantinePopover.Dropdown;--const PopoverDropdown = forwardRef(function PopoverDropdown(- { children, ...props }: PopoverDropdownProps,- ref: Ref<HTMLDivElement>,-) {- return (- <PreventEagerPortal {...props}>- <MantinePopoverDropdown- {...props}- className={cx(props.className, ZIndex.Overlay)}- data-element-id="mantine-popover"- ref={ref}- >- <OverlayStackItem />- {children}- </MantinePopoverDropdown>- </PreventEagerPortal>- );-});--export const Popover = Object.assign(MantinePopover, {- Dropdown: Object.assign(PopoverDropdown, {- displayName: MantinePopoverDropdown.displayName,- }),-});-export { DEFAULT_POPOVER_Z_INDEX } from "./Popover.config";+export { DEFAULT_POPOVER_Z_INDEX, popoverOverrides } from "./Popover.config";diff --git a/frontend/src/metabase/ui/components/overlays/Popover/register-popover-dropdown.ts b/frontend/src/metabase/ui/components/overlays/Popover/register-popover-dropdown.tsnew file mode 100644index 00000000000..37fa70cfaf3--- /dev/null+++ b/frontend/src/metabase/ui/components/overlays/Popover/register-popover-dropdown.ts@@ -0,0 +1,7 @@+import { Popover as MantinePopover } from "@mantine/core";++import { PopoverDropdown } from "./PopoverDropdown";++// Mantine's Combobox, Menu, ColorInput and HoverCard render `Popover.Dropdown` internally,+// so the wrapped dropdown has to be installed on Mantine's own Popover object for every Select and Menu to get it.+MantinePopover.Dropdown = PopoverDropdown;diff --git a/frontend/src/metabase/ui/components/overlays/Popover/register-popover-dropdown.unit.spec.tsx b/frontend/src/metabase/ui/components/overlays/Popover/register-popover-dropdown.unit.spec.tsxnew file mode 100644index 00000000000..64bf0fea567--- /dev/null+++ b/frontend/src/metabase/ui/components/overlays/Popover/register-popover-dropdown.unit.spec.tsx@@ -0,0 +1,19 @@+import { Select as MantineSelect } from "@mantine/core";+import userEvent from "@testing-library/user-event";++import { render, screen } from "__support__/ui";++// Mantine's own Select, not ours: our Select sets the marker attribute itself,+// so only Mantine's shows whether the wrapped dropdown reached Mantine's Popover.+describe("register-popover-dropdown", () => {+ it("installs the wrapped dropdown on Mantine's Popover once ThemeProvider mounts", async () => {+ render(<MantineSelect label="Fruit" data={["Apple"]} />);++ await userEvent.click(screen.getByLabelText("Fruit"));++ const option = await screen.findByRole("option", { name: "Apple" });+ // The marker sits on the dropdown around the listbox, which no Testing Library query reaches.+ // eslint-disable-next-line testing-library/no-node-access+ expect(option.closest('[data-element-id="mantine-popover"]')).toBeVisible();+ });+});diff --git a/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx b/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsxindex ce00666f76c..082f268caa4 100644--- a/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx+++ b/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx@@ -11,6 +11,7 @@ import { getCspNonce } from "metabase/utils/csp";import type { ColorSettings } from "metabase-types/api";import { getThemeOverrides } from "../../../theme";+import "../../overlays/Popover/register-popover-dropdown";import { useColorScheme } from "../ColorSchemeProvider";import { DatesProvider } from "../DatesProvider";diff --git a/frontend/src/metabase/visualizations/shared/utils/theme.ts b/frontend/src/metabase/visualizations/shared/utils/theme.tsindex 9ce59876744..8f6ce09f4e6 100644--- a/frontend/src/metabase/visualizations/shared/utils/theme.ts+++ b/frontend/src/metabase/visualizations/shared/utils/theme.ts@@ -1,7 +1,9 @@import Color from "color";-import { DEFAULT_METABASE_COMPONENT_THEME } from "metabase/embedding-sdk/theme";-import type { MantineThemeOther } from "metabase/ui";+import {+ DEFAULT_METABASE_COMPONENT_THEME,+ type MantineThemeOther,+} from "metabase/ui";import { color } from "metabase/ui/colors";import { getSizeInPx } from "metabase/visualizations/shared/utils/size-in-px";import type { VisualizationTheme } from "metabase/visualizations/types";