Skip to content

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

Persist selected theme in account settings (#66250)

Denis Berezincd301be7815e
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.edn
index 171be746d3e..7a45109e159 100644
--- a/.clj-kondo/config/modules/config.edn
+++ b/.clj-kondo/config/modules/config.edn
@@ -1228,6 +1228,7 @@
session
settings
system
+ users
util
enterprise/sso}}
diff --git a/e2e/test/scenarios/dashboard/dashboard-reproductions.cy.spec.js b/e2e/test/scenarios/dashboard/dashboard-reproductions.cy.spec.js
index d49897eeab8..cd72eba4d12 100644
--- a/e2e/test/scenarios/dashboard/dashboard-reproductions.cy.spec.js
+++ b/e2e/test/scenarios/dashboard/dashboard-reproductions.cy.spec.js
@@ -1631,7 +1631,7 @@ describe("issue 47170", () => {
it("should show legible dark mode colors in fullscreen mode (metabase#51524)", () => {
cy.visit("/account/profile");
- cy.findByDisplayValue("Light").click();
+ cy.findByDisplayValue("Use system default").click();
H.popover().findByText("Dark").click();
cy.visit(`/dashboard/${ORDERS_DASHBOARD_ID}`);
diff --git a/e2e/test/scenarios/onboarding/setup/user_settings.cy.spec.js b/e2e/test/scenarios/onboarding/setup/user_settings.cy.spec.js
index 4d5e9ddfe09..9471955a6e4 100644
--- a/e2e/test/scenarios/onboarding/setup/user_settings.cy.spec.js
+++ b/e2e/test/scenarios/onboarding/setup/user_settings.cy.spec.js
@@ -253,7 +253,7 @@ describe("user > settings", () => {
it("should toggle through light and dark mode when clicking on the label or icon", () => {
cy.visit("/account/profile");
- cy.findByDisplayValue("Light").click();
+ cy.findByDisplayValue("Use system default").click();
H.popover().findByText("Dark").click();
assertDarkMode();
@@ -266,6 +266,27 @@ describe("user > settings", () => {
cy.realPress([metaKey, "Shift", "L"]);
assertDarkMode();
});
+
+ it("should persist theme selection on browser change", () => {
+ cy.intercept("PUT", "/api/setting/color-scheme").as("saveSetting");
+
+ cy.visit("/account/profile");
+
+ cy.findByDisplayValue("Use system default").click();
+ H.popover().findByText("Dark").click();
+ assertDarkMode();
+
+ cy.wait("@saveSetting");
+
+ // emulate browser change by deleting localStorage values
+ cy.window().then((win) => {
+ win.sessionStorage.clear();
+ win.localStorage.clear();
+ });
+
+ cy.visit("/account/profile");
+ assertDarkMode();
+ });
});
});
diff --git a/frontend/src/metabase-types/api/settings.ts b/frontend/src/metabase-types/api/settings.ts
index 951dfc44428..9ba40ce3f9c 100644
--- a/frontend/src/metabase-types/api/settings.ts
+++ b/frontend/src/metabase-types/api/settings.ts
@@ -585,6 +585,7 @@ export type UserSettings = {
SdkIframeEmbedSetupSettings,
"theme" | "useExistingUserSession"
> | null;
+ "color-scheme"?: string;
};
/**
diff --git a/frontend/src/metabase/app.js b/frontend/src/metabase/app.js
index dfdbc341f3e..d913ee7cb9d 100644
--- a/frontend/src/metabase/app.js
+++ b/frontend/src/metabase/app.js
@@ -38,6 +38,7 @@ import { initializePlugins } from "ee-plugins";
import { ModifiedBackend } from "metabase/common/components/dnd/ModifiedBackend";
import { createTracker } from "metabase/lib/analytics";
import api from "metabase/lib/api";
+import { getUserColorScheme } from "metabase/lib/color-scheme";
import { initializeEmbedding } from "metabase/lib/embed";
import { captureConsoleErrors } from "metabase/lib/errors";
import { MetabaseReduxProvider } from "metabase/lib/redux/custom-context";
@@ -78,7 +79,7 @@ function _init(reducers, getRoutes, callback) {
<MetabaseReduxProvider store={store}>
<EmotionCacheProvider>
<DragDropContextProvider backend={ModifiedBackend} context={{ window }}>
- <ThemeProvider>
+ <ThemeProvider initialColorScheme={getUserColorScheme()}>
<GlobalStyles />
<MetabotProvider>
<Router history={history}>{routes}</Router>
diff --git a/frontend/src/metabase/lib/api.js b/frontend/src/metabase/lib/api.js
index 25dd872da73..d683181a219 100644
--- a/frontend/src/metabase/lib/api.js
+++ b/frontend/src/metabase/lib/api.js
@@ -4,11 +4,10 @@ import querystring from "querystring";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { isTest } from "metabase/env";
import { isWithinIframe } from "metabase/lib/dom";
+import { IFRAMED_IN_SELF } from "metabase/lib/iframe";
import { delay } from "metabase/lib/promise";
import { PLUGIN_EMBEDDING_SDK } from "metabase/plugins";
-import { IS_EMBED_PREVIEW } from "./embed";
-
const ONE_SECOND = 1000;
const MAX_RETRIES = 10;
@@ -80,7 +79,7 @@ export class Api extends EventEmitter {
* This header is only used for analytics and for checking if we want to disable some features in the
* embedding iframe (only for Documents at the time of this comment)
*/
- if (!IS_EMBED_PREVIEW) {
+ if (!IFRAMED_IN_SELF) {
// eslint-disable-next-line no-literal-metabase-strings -- Not a user facing string
headers["X-Metabase-Client"] = "embedding-iframe";
}
diff --git a/frontend/src/metabase/lib/color-scheme.ts b/frontend/src/metabase/lib/color-scheme.ts
new file mode 100644
index 00000000000..34bae0dec71
--- /dev/null
+++ b/frontend/src/metabase/lib/color-scheme.ts
@@ -0,0 +1,15 @@
+export type ResolvedColorScheme = "light" | "dark";
+export type ColorScheme = "auto" | ResolvedColorScheme;
+
+export const isValidColorScheme = (value: string): value is ColorScheme => {
+ return ["light", "dark", "auto"].includes(value);
+};
+
+export const getUserColorScheme = (): ColorScheme | undefined => {
+ if (
+ window.MetabaseUserColorScheme &&
+ isValidColorScheme(window.MetabaseUserColorScheme)
+ ) {
+ return window.MetabaseUserColorScheme;
+ }
+};
diff --git a/frontend/src/metabase/lib/dom.js b/frontend/src/metabase/lib/dom.js
index 12457b17a00..75a30270244 100644
--- a/frontend/src/metabase/lib/dom.js
+++ b/frontend/src/metabase/lib/dom.js
@@ -35,16 +35,6 @@ export const isWithinIframe = function () {
// add a global so we can check if the parent iframe is Metabase
window.METABASE = true;
-// check that we're both iframed, and the parent is a Metabase instance
-// used for detecting if we're previewing an embed
-export const IFRAMED_IN_SELF = (function () {
- try {
- return window.self !== window.parent && window.parent.METABASE;
- } catch (e) {
- return false;
- }
-})();
-
// check whether scrollbars are visible to the user,
// this is off by default on Macs, but can be changed
// Always on on most other non mobile platforms
diff --git a/frontend/src/metabase/lib/embed.js b/frontend/src/metabase/lib/embed.js
index 32a4f53a337..f89cceb2605 100644
--- a/frontend/src/metabase/lib/embed.js
+++ b/frontend/src/metabase/lib/embed.js
@@ -2,7 +2,8 @@ import { push } from "react-router-redux";
import _ from "underscore";
import CS from "metabase/css/core/index.css";
-import { IFRAMED_IN_SELF, isWithinIframe } from "metabase/lib/dom";
+import { isWithinIframe } from "metabase/lib/dom";
+import { IFRAMED_IN_SELF } from "metabase/lib/iframe";
import { setInitialUrlOptions } from "metabase/redux/embed";
// detect if this page is embedded in itself, i.e. it's a embed preview
diff --git a/frontend/src/metabase/lib/iframe.js b/frontend/src/metabase/lib/iframe.js
new file mode 100644
index 00000000000..67a400ddf22
--- /dev/null
+++ b/frontend/src/metabase/lib/iframe.js
@@ -0,0 +1,9 @@
+// check that we're both iframed, and the parent is a Metabase instance
+// used for detecting if we're previewing an embed
+export const IFRAMED_IN_SELF = (function () {
+ try {
+ return window.self !== window.parent && window.parent.METABASE;
+ } catch (e) {
+ return false;
+ }
+})();
diff --git a/frontend/src/metabase/palette/components/Palette.unit.spec.tsx b/frontend/src/metabase/palette/components/Palette.unit.spec.tsx
index fa0e83acdbc..e53d8f78d9d 100644
--- a/frontend/src/metabase/palette/components/Palette.unit.spec.tsx
+++ b/frontend/src/metabase/palette/components/Palette.unit.spec.tsx
@@ -55,6 +55,8 @@ describe("command palette", () => {
});
it("should toggle dark mode", async () => {
+ fetchMock.put("path:/api/setting/color-scheme", 200);
+
setup();
await userEvent.keyboard("[ControlLeft>]k");
await screen.findByTestId("command-palette");
@@ -62,11 +64,18 @@ describe("command palette", () => {
await userEvent.type(input, "dark mode");
await userEvent.click(await screen.findByText("Toggle dark/light mode"));
- const getColorSchemeValue = () =>
- window.localStorage.getItem("metabase-color-scheme");
+ expect(
+ await fetchMock.callHistory
+ .lastCall(/\/api\/setting\/color-scheme/)
+ ?.request?.json(),
+ ).toEqual({ value: "dark" });
- expect(getColorSchemeValue()).toBe("dark");
await userEvent.click(await screen.findByText("Toggle dark/light mode"));
- expect(getColorSchemeValue()).toBe("auto");
+
+ expect(
+ await fetchMock.callHistory
+ .lastCall(/\/api\/setting\/color-scheme/)
+ ?.request?.json(),
+ ).toEqual({ value: "auto" });
});
});
diff --git a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsx b/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsx
index 81256669373..3661fa04122 100644
--- a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsx
+++ b/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsx
@@ -1,8 +1,8 @@
import {
type ReactNode,
createContext,
+ useCallback,
useContext,
- useEffect,
useMemo,
useState,
} from "react";
@@ -10,12 +10,12 @@ import { useMedia } from "react-use";
import { noop } from "underscore";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
+import type {
+ ColorScheme,
+ ResolvedColorScheme,
+} from "metabase/lib/color-scheme";
import { getIsEmbeddingIframe } from "metabase/selectors/embed";
-export type ResolvedColorScheme = "light" | "dark";
-
-export type ColorScheme = "auto" | ResolvedColorScheme;
-
interface ColorSchemeContextType {
colorScheme: ColorScheme;
resolvedColorScheme: ResolvedColorScheme;
@@ -38,6 +38,7 @@ interface ColorSchemeProviderProps {
children: ReactNode;
defaultColorScheme?: ColorScheme;
forceColorScheme?: ResolvedColorScheme | null;
+ onUpdateColorScheme?: (scheme: ColorScheme) => void;
}
const getNextScheme = (scheme: ResolvedColorScheme) =>
@@ -47,20 +48,15 @@ export function ColorSchemeProvider({
children,
defaultColorScheme = "auto",
forceColorScheme,
+ onUpdateColorScheme,
}: ColorSchemeProviderProps) {
const systemColorScheme = useMedia("(prefers-color-scheme: dark)")
? "dark"
: "light";
- const [colorScheme, setColorScheme] = useState<ColorScheme>(() => {
- // Try to get saved preference from localStorage
- if (typeof window !== "undefined") {
- const saved = localStorage.getItem("metabase-color-scheme");
- if (saved === "light" || saved === "dark" || saved === "auto") {
- return saved;
- }
- }
- return defaultColorScheme;
- });
+
+ const [colorScheme, setColorScheme] = useState<ColorScheme>(
+ defaultColorScheme || "auto",
+ );
const resolvedColorScheme = useMemo(() => {
if (forceColorScheme) {
return forceColorScheme;
@@ -71,20 +67,24 @@ export function ColorSchemeProvider({
return colorScheme === "auto" ? systemColorScheme : colorScheme;
}, [colorScheme, forceColorScheme, systemColorScheme]);
- useEffect(() => {
- localStorage.setItem("metabase-color-scheme", colorScheme);
- }, [colorScheme]);
+ const handleColorSchemeUpdate = useCallback(
+ (value: ColorScheme) => {
+ setColorScheme(value);
+ onUpdateColorScheme?.(value);
+ },
+ [onUpdateColorScheme],
+ );
const value: ColorSchemeContextType = isEmbeddingSdk()
? defaultValue
: {
colorScheme,
resolvedColorScheme,
- setColorScheme,
+ setColorScheme: handleColorSchemeUpdate,
systemColorScheme,
toggleColorScheme: () => {
const nextScheme = getNextScheme(resolvedColorScheme);
- setColorScheme(
+ handleColorSchemeUpdate(
nextScheme === systemColorScheme ? "auto" : nextScheme,
);
},
diff --git a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/index.ts b/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/index.ts
index 622ba6c7e7a..a9ac8057c12 100644
--- a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/index.ts
+++ b/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/index.ts
@@ -1,2 +1 @@
export { ColorSchemeProvider, useColorScheme } from "./ColorSchemeProvider";
-export type { ColorScheme } from "./ColorSchemeProvider";
diff --git a/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx b/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx
index 6333a9f7b57..d3b8e3a3405 100644
--- a/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx
+++ b/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx
@@ -5,6 +5,7 @@ import { MantineProvider } from "@mantine/core";
import { merge } from "icepick";
import {
type ReactNode,
+ useCallback,
useContext,
useEffect,
useMemo,
@@ -16,13 +17,17 @@ import {
isStaticEmbedding,
} from "metabase/embedding/config";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
+import { PUT } from "metabase/lib/api";
import { parseHashOptions } from "metabase/lib/browser";
+import type {
+ ColorScheme,
+ ResolvedColorScheme,
+} from "metabase/lib/color-scheme";
import { mutateColors } from "metabase/lib/colors/colors";
import type { DisplayTheme } from "metabase/public/lib/types";
import { getThemeOverrides } from "../../../theme";
import { ColorSchemeProvider, useColorScheme } from "../ColorSchemeProvider";
-import type { ResolvedColorScheme } from "../ColorSchemeProvider/ColorSchemeProvider";
import { DatesProvider } from "../DatesProvider";
import { ThemeProviderContext } from "./context";
@@ -38,6 +43,8 @@ interface ThemeProviderProps {
theme?: MantineThemeOverride;
displayTheme?: DisplayTheme | string;
+
+ initialColorScheme?: ColorScheme | undefined;
}
const ThemeProviderInner = (props: ThemeProviderProps) => {
@@ -164,8 +171,19 @@ export const ThemeProvider = (props: ThemeProviderProps) => {
? getColorSchemeFromDisplayTheme(props.displayTheme)
: schemeFromHash;
+ const handleUpdateColorScheme = useCallback(async (value: ColorScheme) => {
+ await PUT("/api/setting/:key")({
+ key: "color-scheme",
+ value: value,
+ });
+ }, []);
+
return (
- <ColorSchemeProvider forceColorScheme={forceColorScheme}>
+ <ColorSchemeProvider
+ defaultColorScheme={props.initialColorScheme}
+ forceColorScheme={forceColorScheme}
+ onUpdateColorScheme={handleUpdateColorScheme}
+ >
<ThemeProviderInner {...props} />
</ColorSchemeProvider>
);
diff --git a/frontend/src/types/global.d.ts b/frontend/src/types/global.d.ts
index 11175c5e9e5..55a5ce6d983 100644
--- a/frontend/src/types/global.d.ts
+++ b/frontend/src/types/global.d.ts
@@ -2,6 +2,7 @@ interface Window {
MetabaseBootstrap: any;
MetabaseRoot?: string;
MetabaseNonce?: string;
+ MetabaseUserColorScheme?: string;
}
// This allows importing static SVGs from TypeScript files
diff --git a/resources/frontend_client/index_template.html b/resources/frontend_client/index_template.html
index 252f22a64d1..98a9b3ebdc3 100644
--- a/resources/frontend_client/index_template.html
+++ b/resources/frontend_client/index_template.html
@@ -16,7 +16,7 @@
<meta name="apple-mobile-web-app-status-bar-style" content="default" />
<meta name="base-href" content="{{{baseHref}}}" />
<meta name="uri" content="{{{uri}}}" />
-
+
{{#hasColorSchemeMetaTag}}
<meta name="color-scheme" content="light dark" />
{{/hasColorSchemeMetaTag}}
@@ -39,6 +39,10 @@
{{{siteLocalizationJSON}}}
</script>
+ <script type="application/json" id="_metabaseUserColorScheme">
+ {{{userColorScheme}}}
+ </script>
+
<script type="application/json" id="_metabaseNonce">
{{{nonceJSON}}}
</script>
diff --git a/resources/frontend_client/inline_js/index_bootstrap.js b/resources/frontend_client/inline_js/index_bootstrap.js
index 67d4a92fa3b..4de7fc32b26 100644
--- a/resources/frontend_client/inline_js/index_bootstrap.js
+++ b/resources/frontend_client/inline_js/index_bootstrap.js
@@ -2,6 +2,7 @@
window.MetabaseBootstrap = JSON.parse(document.getElementById("_metabaseBootstrap").textContent);
window.MetabaseUserLocalization = JSON.parse(document.getElementById("_metabaseUserLocalization").textContent);
window.MetabaseSiteLocalization = JSON.parse(document.getElementById("_metabaseSiteLocalization").textContent);
+ window.MetabaseUserColorScheme = JSON.parse(document.getElementById("_metabaseUserColorScheme").textContent);
window.MetabaseNonce = JSON.parse(document.getElementById("_metabaseNonce").textContent);
var configuredRoot = document.head.querySelector("meta[name='base-href']").content;
diff --git a/src/metabase/server/routes/index.clj b/src/metabase/server/routes/index.clj
index 2d88ccdc12e..4a108e244d7 100644
--- a/src/metabase/server/routes/index.clj
+++ b/src/metabase/server/routes/index.clj
@@ -11,6 +11,7 @@
[metabase.initialization-status.core :as init-status]
[metabase.settings.core :as setting]
[metabase.system.core :as system]
+ [metabase.users.settings :as users-settings]
[metabase.util.embed :as embed]
[metabase.util.i18n :as i18n :refer [trs]]
[metabase.util.json :as json]
@@ -89,6 +90,7 @@
:siteLocalizationJSON (escape-script (load-localization (system/site-locale)))
:nonceJSON (escape-script (json/encode nonce))
:language (hiccup.util/escape-html (or (i18n/user-locale-string) (system/site-locale)))
+ :userColorScheme (escape-script (json/encode (users-settings/color-scheme)))
:favicon (hiccup.util/escape-html (let [custom-favicon (appearance/application-favicon-url)]
(if (and config/is-dev?
(= custom-favicon "app/assets/img/favicon.ico"))
diff --git a/src/metabase/users/settings.clj b/src/metabase/users/settings.clj
index 089d81355e3..ea45d63cc43 100644
--- a/src/metabase/users/settings.clj
+++ b/src/metabase/users/settings.clj
@@ -109,6 +109,15 @@
:type :boolean
:default true)
+(defsetting color-scheme
+ (deferred-tru "User preference for color scheme. Can be ''light'', ''dark'', or ''auto''.")
+ :user-local :only
+ :encryption :no
+ :export? false
+ :visibility :authenticated
+ :type :string
+ :default "auto")
+
(defsetting trial-banner-dismissal-timestamp
(deferred-tru "The ISO8601 date when a user last dismissed the trial banner.")
:user-local :only