rusackas commented on code in PR #42602:
URL: https://github.com/apache/superset/pull/42602#discussion_r3685662123
##########
docs/src/components/StorybookWrapper.jsx:
##########
@@ -78,15 +80,39 @@ function getProviders() {
return container || document.body;
};
+ // `themeObject` is a module-level singleton (superset-core/src/theme
+ // index.tsx: `Theme.fromConfig()`), created once with no dark/light
+ // config, so SupersetThemeProvider always rendered whatever that default
+ // algorithm was -- it had no way to know about Docusaurus's theme toggle.
+ // Docusaurus tracks the toggle in React context (useColorMode), so
+ // mirror it onto the singleton via the toggleDarkMode() method Theme
+ // already exposes for exactly this purpose.
+ //
+ // Use useLayoutEffect (not useEffect) so the sync runs before the
+ // browser paints. This component only ever mounts client-side (it's
+ // built inside a BrowserOnly callback), so there's no SSR mismatch
+ // concern -- and running synchronously before paint avoids a brief
+ // flash of the singleton's previous palette when a page loads directly
+ // in dark mode or the toggle fires during route navigation.
+ function ThemeSync({ children }) {
+ const { colorMode } = useColorMode();
+ React.useLayoutEffect(() => {
+ themeObject.toggleDarkMode(colorMode === 'dark');
+ }, [colorMode]);
Review Comment:
Good catch, this one's real, and worse than the earlier flash issue. The
useLayoutEffect fix from last round runs before paint, but
SupersetThemeProvider still registered its listener in a passive useEffect, so
on an initial dark-mode load ThemeSync's toggle could fire before any listener
existed and the notification just got dropped. Switched the provider's own
listener registration to useLayoutEffect too, since it's nested inside
ThemeSync it now registers first. Pushed in e47b5a659ae.
##########
superset-frontend/packages/superset-core/src/theme/SupersetThemeProvider.test.tsx:
##########
@@ -0,0 +1,160 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { render, screen, act } from '@testing-library/react';
+import { theme as antdThemeImport } from 'antd';
+import { Theme } from './Theme';
+
+// SupersetThemeProvider stores theme state via React.useState, then
+// registers a listener (in a useEffect, on mount) that calls setThemeState
+// whenever a *later* call to setConfig/toggleDarkMode runs on the same
+// Theme instance. Every provider currently mounted from that instance
+// listens independently, so toggling the instance updates all of them, not
+// just the most recently rendered one. Consumers
+// (docs/src/components/StorybookWrapper.jsx in particular) rely on this:
+// they call toggleDarkMode() from outside, on one or more already-mounted
+// providers sharing a single Theme instance, expecting it to propagate to
+// all of them.
+//
+// The probe below reads the theme via antd's theme.useToken() -- the same
+// context-consumption path every real antd component (Button, Input, ...)
+// uses internally -- rather than reading themeObject.theme directly off the
+// singleton. That distinction matters: React bails out of re-rendering a
+// child whose element reference didn't change (the common "static children
+// prop" case, true here since <Probe /> is passed once and never
+// recreated), UNLESS that child consumes a React Context whose value
+// changed, which bypasses the bail-out. A probe reading the plain object
+// directly would misleadingly appear "not updated" even though every real
+// themed component downstream re-renders correctly.
+function makeProbe() {
+ let renderCount = 0;
+ let lastColorBgBase: string | undefined;
+ function Probe() {
+ const { token } = antdThemeImport.useToken();
+ renderCount += 1;
+ lastColorBgBase = token.colorBgBase;
+ return <div data-test="probe" />;
Review Comment:
This one's not right. We configure RTL's testIdAttribute to data-test in
spec/helpers/setup.ts, so getByTestId here actually matches data-test, not
data-testid. This test passes as written.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
