feat(theming): land Ant Design v5 overhaul — dynamic themes, real dark mode + massive styling refactor

.gitattributes

@@ -1,3 +1,4 @@
 docker/**/*.sh text eol=lf
 *.svg binary
 *.ipynb binary
+*.geojson binary

.github/workflows/docker.yml

@@ -111,6 +111,9 @@ jobs:
           docker compose up superset-init --exit-code-from superset-init
 
   docker-compose-image-tag:
+    # Run this job only on pushes to master (not for PRs)
+    # goal is to check that building the latest image works, not required for all PR pushes
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
     runs-on: ubuntu-24.04
     steps:
       - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"

.github/workflows/pre-commit.yml

@@ -53,6 +53,14 @@ jobs:
           cd docs
           yarn install --immutable
 
+      - name: Cache pre-commit environments
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-v2-${{ runner.os }}-py${{ matrix.python-version }}-${{ hashFiles('.pre-commit-config.yaml') }}
+          restore-keys: |
+            pre-commit-v2-${{ runner.os }}-py${{ matrix.python-version }}-
+
       - name: pre-commit
         run: |
           set +e  # Don't exit immediately on failure

.github/workflows/superset-e2e.yml

@@ -73,6 +73,7 @@ jobs:
         with:
           persist-credentials: false
           submodules: recursive
+          ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
       - name: Checkout using ref (workflow_dispatch)
         if: github.event_name == 'workflow_dispatch' && github.event.inputs.ref != ''
         uses: actions/checkout@v4
@@ -137,9 +138,16 @@ jobs:
           NODE_OPTIONS: "--max-old-space-size=4096"
         with:
           run: cypress-run-all ${{ env.USE_DASHBOARD }} ${{ matrix.app_root }}
+      - name: Set safe app root
+        if: failure()
+        id: set-safe-app-root
+        run: |
+          APP_ROOT="${{ matrix.app_root }}"
+          SAFE_APP_ROOT=${APP_ROOT//\//_}
+          echo "safe_app_root=$SAFE_APP_ROOT" >> $GITHUB_OUTPUT
       - name: Upload Artifacts
         uses: actions/upload-artifact@v4
         if: failure()
         with:
           path: ${{ github.workspace }}/superset-frontend/cypress-base/cypress/screenshots
-          name: cypress-artifact-${{ github.run_id }}-${{ github.job }}-${{ matrix.browser }}-${{ matrix.parallel_id }}
+          name: cypress-artifact-${{ github.run_id }}-${{ github.job }}-${{ matrix.browser }}-${{ matrix.parallel_id }}--${{ steps.set-safe-app-root.outputs.safe_app_root }}

.github/workflows/superset-frontend.yml

@@ -26,6 +26,8 @@ jobs:
         uses: actions/checkout@v4
         with:
           persist-credentials: false
+          fetch-depth: 0
+          ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
 
       - name: Check for File Changes
         id: check
@@ -39,6 +41,10 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
+          echo "git rev-parse --short HEAD"
+          git rev-parse --short HEAD
+          echo "git show -s --format=raw HEAD"
+          git show -s --format=raw HEAD
           docker buildx build \
             -t $TAG \
             --cache-from=type=registry,ref=apache/superset-cache:3.10-slim-bookworm \
@@ -115,24 +121,6 @@ jobs:
           files: merged-output/coverage-summary.json
           slug: apache/superset
 
-  core-cover:
-    needs: frontend-build
-    if: needs.frontend-build.outputs.should-run == 'true'
-    runs-on: ubuntu-24.04
-    steps:
-      - name: Download Docker Image Artifact
-        uses: actions/download-artifact@v4
-        with:
-          name: docker-image
-
-      - name: Load Docker Image
-        run: docker load < docker-image.tar.gz
-
-      - name: superset-ui/core coverage
-        run: |
-          docker run --rm $TAG bash -c \
-          "npm run core:cover"
-
   lint-frontend:
     needs: frontend-build
     if: needs.frontend-build.outputs.should-run == 'true'
@@ -144,7 +132,8 @@ jobs:
           name: docker-image
 
       - name: Load Docker Image
-        run: docker load < docker-image.tar.gz
+        run: |
+          docker load < docker-image.tar.gz
 
       - name: eslint
         run: |

.pre-commit-config.yaml

@@ -58,7 +58,7 @@ repos:
       - id: prettier
         additional_dependencies:
           - prettier@3.5.3
-        args: ["--ignore-path=./superset-frontend/.prettierignore"]
+        args: ["--ignore-path=./superset-frontend/.prettierignore", "--exclude", "site-packages"]
         files: "superset-frontend"
   - repo: local
     hooks:

UPDATING.md

@@ -26,6 +26,7 @@ assists people when migrating to a new version.
 - [33116](https://github.com/apache/superset/pull/33116) In Echarts Series charts (e.g. Line, Area, Bar, etc.) charts, the `x_axis_sort_series` and `x_axis_sort_series_ascending` form data items have been renamed with `x_axis_sort` and `x_axis_sort_asc`.
 There's a migration added that can potentially affect a significant number of existing charts.
 - [32317](https://github.com/apache/superset/pull/32317) The horizontal filter bar feature is now out of testing/beta development and its feature flag `HORIZONTAL_FILTER_BAR` has been removed.
+- [31590](https://github.com/apache/superset/pull/31590) Marks the begining of intricate work around supporting dynamic Theming, and breaks support for [THEME_OVERRIDES](https://github.com/apache/superset/blob/732de4ac7fae88e29b7f123b6cbb2d7cd411b0e4/superset/config.py#L671) in favor of a new theming system based on AntD V5. Likely this will be in disrepair until settling over the 5.x lifecycle.
 - [31976](https://github.com/apache/superset/pull/31976) Removed the `DISABLE_LEGACY_DATASOURCE_EDITOR` feature flag. The previous value of the feature flag was `True` and now the feature is permanently removed.
 - [31959](https://github.com/apache/superset/pull/32000) Removes CSV_UPLOAD_MAX_SIZE config, use your web server to control file upload size.
 - [31959](https://github.com/apache/superset/pull/31959) Removes the following endpoints from data uploads: `/api/v1/database/<id>/<file type>_upload` and `/api/v1/database/<file type>_metadata`, in favour of new one (Details on the PR). And simplifies permissions.

superset-embedded-sdk/src/index.ts

@@ -89,6 +89,7 @@ export type EmbeddedDashboard = {
     callbackFn: ObserveDataMaskCallbackFn,
   ) => void;
   getDataMask: () => Record<string, any>;
+  setThemeConfig: (themeConfig: Record<string, any>) => void;
 };
 
 /**
@@ -245,6 +246,18 @@ export async function embedDashboard({
     ourPort.start();
     ourPort.defineMethod('observeDataMask', callbackFn);
   };
+  // TODO: Add proper types once theming branch is merged
+  const setThemeConfig = async (themeConfig: Record<string, any>): Promise<void> => {
+    try {
+      ourPort.emit('setThemeConfig', { themeConfig });
+      log('Theme config sent successfully (or at least message dispatched)');
+    } catch (error) {
+      log(
+        'Error sending theme config. Ensure the iframe side implements the "setThemeConfig" method.',
+      );
+      throw error;
+    }
+  };
 
   return {
     getScrollSize,
@@ -253,5 +266,6 @@ export async function embedDashboard({
     getActiveTabs,
     observeDataMask,
     getDataMask,
+    setThemeConfig
   };
 }

superset-frontend/.eslintignore

@@ -19,7 +19,6 @@
 coverage/**
 dist/*
 src/assets/images/*
-src/assets/stylesheets/*
 node_modules/*
 node_modules*/*
 vendor/*

superset-frontend/.eslintrc.js

@@ -52,7 +52,7 @@ const restrictedImportsRules = {
     message: 'Lodash Memoize is unsafe! Please use memoize-one instead',
   },
   'no-testing-library-react': {
-    name: '@testing-library/react',
+    name: '@superset-ui/core/spec',
     message: 'Please use spec/helpers/testing-library instead',
   },
   'no-testing-library-react-dom-utils': {
@@ -63,10 +63,6 @@ const restrictedImportsRules = {
     name: 'antd',
     message: 'Please import Ant components from the index of src/components',
   },
-  'no-antd-v5': {
-    name: 'antd-v5',
-    message: 'Please import Ant v5 components from the index of src/components',
-  },
   'no-superset-theme': {
     name: '@superset-ui/core',
     importNames: ['supersetTheme'],
@@ -101,6 +97,15 @@ module.exports = {
         // resolve modules from `/superset_frontend/node_modules` and `/superset_frontend`
         moduleDirectory: ['node_modules', '.'],
       },
+      typescript: {
+        alwaysTryTypes: true,
+        project: [
+          './tsconfig.json',
+          './packages/superset-ui-core/tsconfig.json',
+          './packages/superset-ui-chart-controls/',
+          './plugins/*/tsconfig.json',
+        ],
+      },
     },
     // only allow import from top level of module
     'import/core-modules': importCoreModules,
@@ -295,9 +300,9 @@ module.exports = {
           'error',
           {
             paths: Object.values(restrictedImportsRules).filter(
-              r => r.name !== 'antd-v5',
+              r => r.name !== 'antd',
             ),
-            patterns: ['antd/*'],
+            patterns: [],
           },
         ],
       },
@@ -330,7 +335,9 @@ module.exports = {
       rules: {
         'import/no-extraneous-dependencies': [
           'error',
-          { devDependencies: true },
+          {
+            devDependencies: true,
+          },
         ],
         'no-only-tests/no-only-tests': 'error',
         'max-classes-per-file': 0,
@@ -373,7 +380,7 @@ module.exports = {
         'fixtures.*',
         'cypress-base/cypress/**/*',
         'Stories.tsx',
-        'packages/superset-ui-core/src/style/index.tsx',
+        'packages/superset-ui-core/src/theme/index.tsx',
       ],
       rules: {
         'theme-colors/no-literal-colors': 0,

superset-frontend/.storybook/main.js

@@ -24,6 +24,7 @@ module.exports = {
   stories: [
     '../src/@(components|common|filters|explore|views|dashboard|features)/**/*.stories.@(tsx|jsx)',
     '../packages/superset-ui-demo/storybook/stories/**/*.*.@(tsx|jsx)',
+    '../packages/superset-ui-core/src/components/**/*.stories.@(tsx|jsx)',
   ],
 
   addons: [

superset-frontend/.storybook/preview.jsx

@@ -17,31 +17,75 @@
  * under the License.
  */
 import { withJsx } from '@mihkeleidast/storybook-addon-source';
-import { supersetTheme, ThemeProvider } from '@superset-ui/core';
-import { AntdThemeProvider } from '../src/components/AntdThemeProvider';
+import { themeObject, css, exampleThemes } from '@superset-ui/core';
 import { combineReducers, createStore, applyMiddleware, compose } from 'redux';
 import thunk from 'redux-thunk';
 import { Provider } from 'react-redux';
 import reducerIndex from 'spec/helpers/reducerIndex';
-import { GlobalStyles } from '../src/GlobalStyles';
+import { Global } from '@emotion/react';
+import { App, Layout, Space, Content } from 'antd';
 
 import 'src/theme.ts';
 import './storybook.css';
 
+export const GlobalStylesOverrides = () => (
+  <Global
+    styles={css`
+      html,
+      body,
+      #storybook-root {
+        margin: 0 !important;
+        padding: 0 !important;
+        min-height: 100vh !important;
+      }
+
+      .ant-app {
+        min-height: 100vh !important;
+      }
+    `}
+  />
+);
+
 const store = createStore(
   combineReducers(reducerIndex),
   {},
   compose(applyMiddleware(thunk)),
 );
 
-const themeDecorator = Story => (
-  <ThemeProvider theme={supersetTheme}>
-    <AntdThemeProvider>
-      <GlobalStyles />
-      <Story />
-    </AntdThemeProvider>
-  </ThemeProvider>
-);
+export const globalTypes = {
+  theme: {
+    name: 'Theme',
+    description: 'Global theme for components',
+    defaultValue: 'superset',
+    toolbar: {
+      icon: 'paintbrush',
+      items: Object.keys(exampleThemes),
+    },
+  },
+};
+
+const themeDecorator = (Story, context) => {
+  const themeKey = context.globals.theme || 'superset';
+  themeObject.setConfig(exampleThemes[themeKey]);
+
+  return (
+    <themeObject.SupersetThemeProvider>
+      <App>
+        <GlobalStylesOverrides />
+        <Layout
+          style={{
+            minHeight: '100vh',
+            width: '100%',
+            padding: 24,
+            backgroundColor: themeObject.theme.colorBgBase,
+          }}
+        >
+          <Story {...context} />
+        </Layout>
+      </App>
+    </themeObject.SupersetThemeProvider>
+  );
+};
 
 const providerDecorator = Story => (
   <Provider store={store}>
@@ -81,5 +125,5 @@ export const parameters = {
       ],
     },
   },
-  controls: { expanded: true, sort: 'alpha' },
+  controls: { expanded: true, sort: 'alpha', disableSaveFromUI: true },
 };

superset-frontend/.storybook/storybook.css

@@ -1,3 +1,2 @@
 body {
-  background: transparent;
 }