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
Restore theme preference after login (#66892)
Gabriel Moreno8d7c058ec097
diff --git a/e2e/test/scenarios/onboarding/setup/user_settings.cy.spec.js b/e2e/test/scenarios/onboarding/setup/user_settings.cy.spec.jsindex e97e21eb025..57511efe950 100644--- a/e2e/test/scenarios/onboarding/setup/user_settings.cy.spec.js+++ b/e2e/test/scenarios/onboarding/setup/user_settings.cy.spec.js@@ -356,6 +356,43 @@ describe("user > settings", () => {});});});++ it("should apply user's color scheme preference immediately after login (metabase#66874)", () => {+ // First, set the color scheme preference while logged in+ cy.intercept("PUT", "/api/setting/color-scheme").as("saveColorScheme");++ cy.visit("/account/profile", stubSystemColorScheme("dark"));+ cy.findByDisplayValue("Use system default").click();+ H.popover().findByText("Light").click();++ cy.wait("@saveColorScheme");++ assertLightMode();++ cy.signOut();+ cy.visit("/", stubSystemColorScheme("dark"));++ // Verify that the theme is restored to "auto" after sign out+ assertDarkMode();++ cy.intercept("GET", "/api/session/properties").as("sessionProperties");++ // Sign-in is done manually in order to test theme replacement throughout+ // react navigation, where no new metadata is passed or injected into the+ // window object, and the theme is purely updated from session properties+ cy.findByLabelText("Email address").type(email);+ cy.findByLabelText("Password").type(password);+ cy.button("Sign in").click();++ cy.wait("@sessionProperties");++ // Verify light mode is applied immediately after login+ assertLightMode();++ // Verify the theme selector shows the correct value+ cy.visit("/account/profile", stubSystemColorScheme("dark"));+ cy.findByDisplayValue("Light").should("exist");+ });});});@@ -381,3 +418,27 @@ function stubCurrentUser(authenticationMethod) {).as("getUser");});}++/**+ * Stub the system color scheme preference+ *+ * @param {boolean} prefersDark - Whether the system prefers dark mode+ * @returns {Object} - The stub object+ */+function stubSystemColorScheme(preferredColorScheme = "light") {+ return {+ onBeforeLoad: (win) => {+ cy.stub(win, "matchMedia").callsFake((query) => {+ return {+ matches: query === `(prefers-color-scheme: ${preferredColorScheme})`,+ media: query,+ addEventListener: cy.stub(),+ removeEventListener: cy.stub(),+ addListener: cy.stub(), // deprecated but sometimes needed+ removeListener: cy.stub(),+ dispatchEvent: cy.stub(),+ };+ });+ },+ };+}diff --git a/frontend/src/metabase/api/session.ts b/frontend/src/metabase/api/session.tsindex 577b14e9906..f3bc8b8f6d4 100644--- a/frontend/src/metabase/api/session.ts+++ b/frontend/src/metabase/api/session.ts@@ -1,3 +1,7 @@+import {+ isValidColorScheme,+ setUserColorSchemeAfterUpdate,+} from "metabase/lib/color-scheme";import MetabaseSettings from "metabase/lib/settings";import { loadSettings } from "metabase/redux/settings";import type {@@ -40,6 +44,14 @@ export const sessionApi = Api.injectEndpoints({dispatch(loadSettings(data));// compatibility layer for legacy settings on the window objectMetabaseSettings.setAll(data);++ // Sync color-scheme setting to window.MetabaseUserColorScheme+ if (+ data["color-scheme"] &&+ isValidColorScheme(data["color-scheme"])+ ) {+ setUserColorSchemeAfterUpdate(data["color-scheme"]);+ }}),}),}),diff --git a/frontend/src/metabase/lib/settings.ts b/frontend/src/metabase/lib/settings.tsindex 3e49de60ab0..1610685dcba 100644--- a/frontend/src/metabase/lib/settings.ts+++ b/frontend/src/metabase/lib/settings.ts@@ -108,6 +108,14 @@ class MetabaseSettings {this._listeners[key]!.push(callback);}+ /**+ * @deprecated remove an event listener+ */+ off(key: SettingKey, callback: SettingListener) {+ this._listeners[key] =+ this._listeners[key]?.filter((c) => c !== callback) || [];+ }+/*** @deprecated use getSetting(state, "admin-email")*/diff --git a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsx b/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsxindex 3661fa04122..61d948bf61b 100644--- a/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsx+++ b/frontend/src/metabase/ui/components/theme/ColorSchemeProvider/ColorSchemeProvider.tsx@@ -3,6 +3,7 @@ import {createContext,useCallback,useContext,+ useEffect,useMemo,useState,} from "react";@@ -57,6 +58,20 @@ export function ColorSchemeProvider({const [colorScheme, setColorScheme] = useState<ColorScheme>(defaultColorScheme || "auto",);++ useEffect(() => {+ // NOTE: The `defaultColorScheme` prop may change in cases where the+ // page hasn't reloaded (therefore embedded user preferences haven't+ // changed) but a new set of preferences arives from events, such as+ // session changes after login/logout.+ //+ // If such new preferences specify a different color scheme, we then+ // react to those changes.+ //+ // See: `ThemeProvider.tsx:181`+ setColorScheme(defaultColorScheme);+ }, [defaultColorScheme]);+const resolvedColorScheme = useMemo(() => {if (forceColorScheme) {return forceColorScheme;diff --git a/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx b/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsxindex 3a0038e5a8f..4934c684da8 100644--- a/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx+++ b/frontend/src/metabase/ui/components/theme/ThemeProvider/ThemeProvider.tsx@@ -25,9 +25,11 @@ import type {} from "metabase/lib/color-scheme";import {getUserColorScheme,+ isValidColorScheme,setUserColorSchemeAfterUpdate,} from "metabase/lib/color-scheme";import { mutateColors } from "metabase/lib/colors/colors";+import MetabaseSettings from "metabase/lib/settings";import type { DisplayTheme } from "metabase/public/lib/types";import { getThemeOverrides } from "../../../theme";@@ -175,6 +177,24 @@ export const ThemeProvider = (props: ThemeProviderProps) => {? getColorSchemeFromDisplayTheme(props.displayTheme): schemeFromHash;+ const [colorSchemeFromSettings, setColorSchemeFromSettings] =+ useState<ColorScheme>(() => getUserColorScheme() ?? "auto");++ // FIXME: Not only does this use a deprecated API, it also adds a complementary+ // method to the already deprecated method to remove the listener. This is just+ // done provisionally for CI testing purposes.+ useEffect(() => {+ const updateSetting = (value: ColorScheme) => {+ if (value && isValidColorScheme(value)) {+ setColorSchemeFromSettings(value);+ }+ };++ MetabaseSettings.on("color-scheme", updateSetting);++ return () => MetabaseSettings.off("color-scheme", updateSetting);+ }, [setColorSchemeFromSettings]);+const handleUpdateColorScheme = useCallback(async (value: ColorScheme) => {await PUT("/api/setting/:key")({key: "color-scheme",@@ -186,7 +206,7 @@ export const ThemeProvider = (props: ThemeProviderProps) => {return (<ColorSchemeProvider- defaultColorScheme={getUserColorScheme()}+ defaultColorScheme={colorSchemeFromSettings ?? getUserColorScheme()}forceColorScheme={forceColorScheme}onUpdateColorScheme={handleUpdateColorScheme}>