Skip to content

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

Scope measurement container css vars (#78225)

Nick Fitzpatrick0669d80f2bc8
diff --git a/frontend/src/metabase/ui/components/theme/MeasurementProviders.tsx b/frontend/src/metabase/ui/components/theme/MeasurementProviders.tsx
index 0fba401094d..9ca3c8d1ab1 100644
--- a/frontend/src/metabase/ui/components/theme/MeasurementProviders.tsx
+++ b/frontend/src/metabase/ui/components/theme/MeasurementProviders.tsx
@@ -1,6 +1,7 @@
import type { ReactNode } from "react";
import type { ResolvedColorScheme } from "metabase/utils/color-scheme";
+import { MEASUREMENT_ROOT_CLASSNAME } from "metabase/utils/measure-container";
import { EmotionCacheProvider } from "./EmotionCacheProvider";
import { ThemeProvider } from "./ThemeProvider";
@@ -38,7 +39,13 @@ export function MeasurementProviders({ children }: MeasurementProvidersProps) {
const resolvedColorScheme = readCurrentColorScheme();
return (
<EmotionCacheProvider>
- <ThemeProvider resolvedColorScheme={resolvedColorScheme}>
+ {/* Scope variable creation to the measurement container to prevent overriding
+ * main app vars
+ */}
+ <ThemeProvider
+ resolvedColorScheme={resolvedColorScheme}
+ cssVariablesSelector={`.${MEASUREMENT_ROOT_CLASSNAME}`}
+ >
{children}
</ThemeProvider>
</EmotionCacheProvider>
diff --git a/frontend/src/metabase/ui/components/theme/MeasurementProviders.unit.spec.tsx b/frontend/src/metabase/ui/components/theme/MeasurementProviders.unit.spec.tsx
index 5d18b8de781..38a21fefa7c 100644
--- a/frontend/src/metabase/ui/components/theme/MeasurementProviders.unit.spec.tsx
+++ b/frontend/src/metabase/ui/components/theme/MeasurementProviders.unit.spec.tsx
@@ -1,9 +1,21 @@
import { render, screen } from "@testing-library/react";
+import { MEASUREMENT_ROOT_CLASSNAME } from "metabase/utils/measure-container";
+
import { MeasurementProviders } from "./MeasurementProviders";
const SCHEME_ATTR = "data-mantine-color-scheme";
+function getMantineStyleText(): string {
+ // Mantine injects its CSS-variable <style> into <head>, outside the render
+ // container, so query the document directly.
+ return Array.from(
+ document.querySelectorAll('style[data-mantine-styles="true"]'),
+ )
+ .map((tag) => tag.textContent ?? "")
+ .join("\n");
+}
+
describe("MeasurementProviders", () => {
afterEach(() => {
document.documentElement.removeAttribute(SCHEME_ATTR);
@@ -55,4 +67,20 @@ describe("MeasurementProviders", () => {
expect(screen.getByText("measurement content")).toBeInTheDocument();
});
+
+ it("scopes its CSS variables to the measurement container, not :root (UXW-4556)", () => {
+ render(
+ <MeasurementProviders>
+ <div>measurement</div>
+ </MeasurementProviders>,
+ );
+
+ const styleText = getMantineStyleText();
+
+ // Variables are still emitted so the detached node is self-sufficient even in
+ // the embedding SDK (where :root has none), but scoped to the container class
+ // so they can't override or flash the app's :root brand.
+ expect(styleText).toContain(`.${MEASUREMENT_ROOT_CLASSNAME}`);
+ expect(styleText).not.toMatch(/:root\s*\{/);
+ });
});
diff --git a/frontend/src/metabase/utils/measure-container.ts b/frontend/src/metabase/utils/measure-container.ts
index 23c0f2ef35b..2f65beaa155 100644
--- a/frontend/src/metabase/utils/measure-container.ts
+++ b/frontend/src/metabase/utils/measure-container.ts
@@ -7,6 +7,7 @@ interface MeasurementContainerOptions {
}
const DEFAULT_FONT_SIZE = "12.5px";
+export const MEASUREMENT_ROOT_CLASSNAME = "mb-measurement-root";
export function createMeasurementContainer(
options: MeasurementContainerOptions = {},
@@ -14,6 +15,7 @@ export function createMeasurementContainer(
const { fontSize = DEFAULT_FONT_SIZE } = options;
const container = document.createElement("div");
+ container.classList.add(MEASUREMENT_ROOT_CLASSNAME);
container.style.position = "absolute";
container.style.top = "-9999px";
container.style.left = "-9999px";