fix(chart-customizations): support migration of dynamic group by by DamianPendrak · Pull Request #37176 · apache/superset

DamianPendrak · 2026-01-15T17:43:51Z

SUMMARY

The #36062 introduced changes to support more chart customization types. It does not handle the migration of the old dynamic group by. This is fixed in this PR

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

Checkout any commit before feat(dashboard): chart customizations modal and plugins #36062. For example 481bfa0
Create dynamic group by for any dashboard
Checkout to this PR
The created dynamic group by should be visible in the sidebar and working properly

ADDITIONAL INFORMATION

Has associated issue:
Required feature flags:
Changes UI
Includes DB Migration (follow approval process in SIP-59)
- Migration is atomic, supports rollback & is backwards-compatible
- Confirm DB migration upgrade and downgrade tested
- Runtime estimates and downtime expectations provided
Introduces new feature or API
Removes existing feature or API

codeant-ai-for-open-source · 2026-01-15T17:43:57Z

CodeAnt AI is reviewing your PR.

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

bito-code-review · 2026-01-15T17:44:01Z

Code Review Agent Run #e96f10

Actionable Suggestions - 0

Additional Suggestions - 1

superset-frontend/packages/superset-ui-core/src/query/types/Dashboard.ts - 1
- TypeScript 'any' usage · Line 259-259
  
  The controlValues property uses 'any' type, which violates the project's strict no-any policy for TypeScript. Consider replacing with 'unknown' for better type safety in this legacy interface.
  Code suggestion
  @@ -257,4 +257,4 @@ - controlValues?: { - enableEmptyFilter?: boolean; - [key: string]: any; - }; + controlValues?: { + enableEmptyFilter?: boolean; + [key: string]: unknown; + };

Review Details

Files reviewed - 9 · Commit Range: d128507..d128507
- superset-frontend/packages/superset-ui-core/src/query/types/Dashboard.ts
- superset-frontend/src/dashboard/actions/hydrate.js
- superset-frontend/src/dashboard/components/nativeFilters/FilterBar/FilterControls/FilterControls.tsx
- superset-frontend/src/dashboard/components/nativeFilters/FilterBar/state.ts
- superset-frontend/src/dashboard/components/nativeFilters/FiltersConfigModal/utils.ts
- superset-frontend/src/dashboard/components/nativeFilters/state.ts
- superset-frontend/src/dashboard/util/migrateChartCustomization.test.ts
- superset-frontend/src/dashboard/util/migrateChartCustomization.ts
- superset-frontend/src/dataMask/reducer.ts
Files skipped - 0
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

/review - Manually triggers a full AI review.
/pause - Pauses automatic reviews on this pull request.
/resume - Resumes automatic reviews.
/resolve - Marks all Bito-posted review comments as resolved.
/abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by

netlify · 2026-01-15T17:47:00Z

✅ Deploy Preview for superset-docs-preview ready!

Name	Link
🔨 Latest commit	`d128507`
🔍 Latest deploy log	https://app.netlify.com/projects/superset-docs-preview/deploys/6969275b682be8000877e073
😎 Deploy Preview	https://deploy-preview-37176--superset-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

codeant-ai-for-open-source · 2026-01-15T17:48:45Z

@@ -96,8 +100,16 @@ const selectChartCustomizationConfiguration = createSelector(
      state.dashboardInfo.metadata?.chart_customization_config || EMPTY_ARRAY,
    selectDashboardChartIds,


Suggestion: The selector accesses state.dashboardInfo.metadata without checking whether state.dashboardInfo exists; if dashboardInfo is undefined this will throw at runtime. Add optional chaining on dashboardInfo so the selector safely falls back to EMPTY_ARRAY when dashboardInfo is not present. [null pointer]

Severity Level: Critical 🚨

- ❌ Dashboard render crashes on missing dashboardInfo. - ❌ Chart customizations sidebar fails to mount. - ⚠️ Unit tests mocking partial store may fail.

Suggested change

selectDashboardChartIds,

state.dashboardInfo?.metadata?.chart_customization_config || EMPTY_ARRAY,

Steps of Reproduction ✅

1. Open the dashboard UI component that uses chart customizations which calls useChartCustomizationConfiguration (see useChartCustomizationConfiguration at superset-frontend/src/dashboard/components/nativeFilters/state.ts:127). 2. During initial render the selector selectChartCustomizationConfiguration is executed (defined at superset-frontend/src/dashboard/components/nativeFilters/state.ts:100-101). 3. If Redux state has no dashboardInfo key (state.dashboardInfo === undefined) the expression at superset-frontend/src/dashboard/components/nativeFilters/state.ts:101 attempts to read `.metadata` on undefined and throws a TypeError. 4. Reproduce in tests by mocking react-redux useSelector to return a store object without dashboardInfo and rendering any component that calls useChartCustomizationConfiguration; the component render will throw at the selector line shown above.

Prompt for AI Agent 🤖

This is a comment left during a code review. **Path:** superset-frontend/src/dashboard/components/nativeFilters/state.ts **Line:** 101:101 **Comment:** *Null Pointer: The selector accesses `state.dashboardInfo.metadata` without checking whether `state.dashboardInfo` exists; if `dashboardInfo` is undefined this will throw at runtime. Add optional chaining on `dashboardInfo` so the selector safely falls back to `EMPTY_ARRAY` when `dashboardInfo` is not present. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.

codeant-ai-for-open-source · 2026-01-15T17:48:45Z

+        const hasLegacyFormat = rawChartCustomizationConfig.some(item =>
+          isLegacyChartCustomizationFormat(item),
+        );
+
+        const chartCustomizationConfig = hasLegacyFormat
+          ? migrateChartCustomizationArray(rawChartCustomizationConfig)
+          : (rawChartCustomizationConfig as ChartCustomization[]);


Suggestion: Logic bug / unsafe migration: when any legacy item exists the code calls migrateChartCustomizationArray with the entire rawChartCustomizationConfig (including already-modern items), potentially re-migrating or corrupting items that are already in the new format; instead, migrate only legacy items and preserve existing new items (while keeping original order). [possible bug]

Severity Level: Critical 🚨

- ❌ Dashboard hydration can corrupt chart customization entries. - ❌ Sidebar chart customization shows incorrect items. - ⚠️ Affects dashboards with mixed-format customization arrays. - ⚠️ Migration may alter saved dashboard configuration.

Suggested change

const hasLegacyFormat = rawChartCustomizationConfig.some(item =>

isLegacyChartCustomizationFormat(item),

);

const chartCustomizationConfig = hasLegacyFormat

? migrateChartCustomizationArray(rawChartCustomizationConfig)

: (rawChartCustomizationConfig as ChartCustomization[]);

// Migrate only legacy items and preserve non-legacy items in original order.

const legacyItems = rawChartCustomizationConfig.filter(item =>

isLegacyChartCustomizationFormat(item),

);

const migratedLegacyItems = legacyItems.length

? migrateChartCustomizationArray(legacyItems)

: [];

// Reconstruct final array preserving order: replace legacy entries with migrated ones.

let migratedIndex = 0;

const chartCustomizationConfig = rawChartCustomizationConfig.map(item =>

isLegacyChartCustomizationFormat(item)

? (migratedLegacyItems[migratedIndex++] as ChartCustomization)

: (item as ChartCustomization),

);

Steps of Reproduction ✅

1. Open the dashboard page that triggers dashboard hydration. The HYDRATE_DASHBOARD action is handled by the reducer at superset-frontend/src/dataMask/reducer.ts in the HYDRATE_DASHBOARD case (lines ~220-320). The migration code runs at lines 223-232 in that file. 2. Ensure the dashboard metadata returned from the backend includes chart_customization_config with a mix of legacy-format and already-modern-format items (the reducer reads metadata?.chart_customization_config at line 223). 3. When the HYDRATE_DASHBOARD action is dispatched, the reducer evaluates hasLegacyFormat using isLegacyChartCustomizationFormat (imported from src/dashboard/util/migrateChartCustomization) at lines 226-228. 4. Because at least one legacy item exists, the current code calls migrateChartCustomizationArray with the entire rawChartCustomizationConfig array (line 231). If migrateChartCustomizationArray expects legacy-only inputs or transforms items generically, this will re-process modern items and can change/corrupt them. Observe unexpected/mutated chart customization entries after hydration in the dashboard UI (sidebar customizations missing or altered), originating from reducer lines 223-232. Note: This reproduces concretely by creating a dashboard metadata payload containing mixed-format chart_customization_config and loading that dashboard so the HYDRATE_DASHBOARD reducer branch executes (see reducer.ts lines 220-236).

Prompt for AI Agent 🤖

This is a comment left during a code review. **Path:** superset-frontend/src/dataMask/reducer.ts **Line:** 226:232 **Comment:** *Possible Bug: Logic bug / unsafe migration: when any legacy item exists the code calls `migrateChartCustomizationArray` with the entire `rawChartCustomizationConfig` (including already-modern items), potentially re-migrating or corrupting items that are already in the new format; instead, migrate only legacy items and preserve existing new items (while keeping original order). Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.

migrateChartCustomizationArray checks if the item is legacy and only then migrates it

codeant-ai-for-open-source · 2026-01-15T17:48:51Z

CodeAnt AI finished reviewing your PR.

github-actions · 2026-01-15T18:26:28Z

🎪 Showtime is building environment on GHA for b29ce96

github-actions · 2026-01-15T18:28:06Z

🎪 Showtime is building environment on GHA for e75d556

github-actions · 2026-01-31T20:00:38Z

🎪 Showtime deployed environment on GHA for e75d556

• Environment: http://35.93.128.118:8080 (admin/admin)
• Lifetime: 72h auto-cleanup
• Updates: New commits create fresh environments automatically

github-actions · 2026-02-03T19:50:33Z

⚠️ DEPRECATED WORKFLOW ⚠️

@sadpandajoe This workflow is deprecated! Please use the new Superset Showtime system instead:

Replace "testenv-up" label with "🎪 trigger-start"
Better reliability and easier management
See https://github.com/mistercrunch/superset-showtime for details

Processing your ephemeral environment request here. Action: up. More information on how to use or configure ephemeral environments

github-actions · 2026-02-03T19:59:22Z

@sadpandajoe Ephemeral environment spinning up at http://54.214.116.16:8080. Credentials are 'admin'/'admin'. Please allow several minutes for bootstrapping and startup.

rebecanogueira-preset · 2026-02-09T14:06:37Z

@DamianPendrak has this been tested yet or do you need QA validation for this PR?

DamianPendrak · 2026-02-12T09:24:57Z

@rebecanogueira-preset I need QA validation for this PR

bito-code-review · 2026-02-15T09:53:54Z

Code Review Agent Run #5239b6

Actionable Suggestions - 0

Additional Suggestions - 1

superset-frontend/src/dashboard/components/nativeFilters/FilterBar/state.ts - 1
- Code duplication in prefix checks · Line 91-92
  
  The code manually checks for CHART_CUSTOMIZATION_PREFIX and LEGACY_GROUPBY_PREFIX instead of using the existing isChartCustomization helper function. This creates duplication and risks inconsistency if the helper's logic changes. Consider refactoring to use the helper for better maintainability.

Review Details

Files reviewed - 9 · Commit Range: c4393b7..e492958
- superset-frontend/packages/superset-ui-core/src/query/types/Dashboard.ts
- superset-frontend/src/dashboard/actions/hydrate.ts
- superset-frontend/src/dashboard/components/nativeFilters/FilterBar/FilterControls/FilterControls.tsx
- superset-frontend/src/dashboard/components/nativeFilters/FilterBar/state.ts
- superset-frontend/src/dashboard/components/nativeFilters/FiltersConfigModal/utils.ts
- superset-frontend/src/dashboard/components/nativeFilters/state.ts
- superset-frontend/src/dashboard/util/migrateChartCustomization.test.ts
- superset-frontend/src/dashboard/util/migrateChartCustomization.ts
- superset-frontend/src/dataMask/reducer.ts
Files skipped - 0
Tools
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
- Eslint (Linter) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

/review - Manually triggers a full AI review.
/pause - Pauses automatic reviews on this pull request.
/resume - Resumes automatic reviews.
/resolve - Marks all Bito-posted review comments as resolved.
/abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by

dosubot · 2026-02-20T21:11:17Z

Related Documentation

Checked 0 published document(s) in 2 knowledge base(s). No updates required.

^{How did I do? Any feedback?}

…che#37176) (cherry picked from commit 1a77e17)

…che#37176)

pull-request-size Bot added the size/XL label Jan 15, 2026

github-actions Bot added the packages label Jan 15, 2026

dosubot Bot added the dashboard:native-filters Related to the native filters of the Dashboard label Jan 15, 2026

DamianPendrak changed the title ~~fix(chart-customizations) support migration of dynamic group by~~ fix(chart-customizations): support migration of dynamic group by Jan 15, 2026

codeant-ai-for-open-source Bot reviewed Jan 15, 2026

View reviewed changes

sadpandajoe added the 🎪 ⚡ showtime-trigger-start Create new ephemeral environment for this PR label Jan 15, 2026

github-actions Bot added 🎪 b29ce96 🚦 building 🎪 ⌛ 48h Environment expires after 48 hours (default) and removed 🎪 ⚡ showtime-trigger-start Create new ephemeral environment for this PR labels Jan 15, 2026

github-actions Bot added 🎪 e75d556 🚦 building labels Jan 15, 2026

github-actions Bot added 🎪 b29ce96 🚦 deploying and removed 🎪 b29ce96 🚦 building labels Jan 15, 2026

github-actions Bot added 🎪 e75d556 🚦 deploying and removed 🎪 e75d556 🚦 deploying labels Jan 31, 2026

github-actions Bot removed 🎪 e75d556 🌐 35.93.128.118:8080 labels Feb 3, 2026

sadpandajoe added the testenv-up label Feb 3, 2026

DamianPendrak added 3 commits February 15, 2026 09:49

support migration groupby filters

c4393b7

Fix unsafe selector access

1f8d9f2

Prettier

e492958

DamianPendrak force-pushed the fix/chart-customization-migration branch from e75d556 to e492958 Compare February 15, 2026 08:49

sadpandajoe removed the hold:testing! On hold for testing label Feb 20, 2026

sadpandajoe merged commit 1a77e17 into apache:master Feb 20, 2026
69 of 70 checks passed

aminghadersohi pushed a commit to preset-io/superset that referenced this pull request Mar 13, 2026

fix(chart-customizations): support migration of dynamic group by (apa…

9f22e76

…che#37176) (cherry picked from commit 1a77e17)

sadpandajoe removed the 🎪 ⌛ 72h label Mar 19, 2026

devin-ai-integration Bot mentioned this pull request Apr 16, 2026

test(dashboard): add edge case tests for legacy chart customization migration andreicinca/superset#9

Open

9 tasks

qfcwell pushed a commit to qfcwell/superset that referenced this pull request May 12, 2026

fix(chart-customizations): support migration of dynamic group by (apa…

270252f

…che#37176)

		@@ -96,8 +100,16 @@ const selectChartCustomizationConfiguration = createSelector(
		state.dashboardInfo.metadata?.chart_customization_config \|\| EMPTY_ARRAY,
		selectDashboardChartIds,

	selectDashboardChartIds,
	state.dashboardInfo?.metadata?.chart_customization_config \|\| EMPTY_ARRAY,

-        const hasLegacyFormat = rawChartCustomizationConfig.some(item =>
-          isLegacyChartCustomizationFormat(item),
-        );
-        const chartCustomizationConfig = hasLegacyFormat
-          ? migrateChartCustomizationArray(rawChartCustomizationConfig)
-          : (rawChartCustomizationConfig as ChartCustomization[]);
+        // Migrate only legacy items and preserve non-legacy items in original order.
+        const legacyItems = rawChartCustomizationConfig.filter(item =>
+          isLegacyChartCustomizationFormat(item),
+        );
+        const migratedLegacyItems = legacyItems.length
+          ? migrateChartCustomizationArray(legacyItems)
+          : [];
+        // Reconstruct final array preserving order: replace legacy entries with migrated ones.
+        let migratedIndex = 0;
+        const chartCustomizationConfig = rawChartCustomizationConfig.map(item =>
+          isLegacyChartCustomizationFormat(item)
+            ? (migratedLegacyItems[migratedIndex++] as ChartCustomization)
+            : (item as ChartCustomization),
+        );

Conversation

DamianPendrak commented Jan 15, 2026

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

Uh oh!

codeant-ai-for-open-source Bot commented Jan 15, 2026

Thanks for using CodeAnt! 🎉

Uh oh!

bito-code-review Bot commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Agent Run #e96f10

Uh oh!

netlify Bot commented Jan 15, 2026

✅ Deploy Preview for superset-docs-preview ready!

Uh oh!

codeant-ai-for-open-source Bot Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

codeant-ai-for-open-source Bot Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

DamianPendrak Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

codeant-ai-for-open-source Bot commented Jan 15, 2026

Uh oh!

github-actions Bot commented Jan 15, 2026

Uh oh!

github-actions Bot commented Jan 15, 2026

Uh oh!

github-actions Bot commented Jan 31, 2026

Uh oh!

github-actions Bot commented Feb 3, 2026

Uh oh!

github-actions Bot commented Feb 3, 2026

Uh oh!

rebecanogueira-preset commented Feb 9, 2026

Uh oh!

DamianPendrak commented Feb 12, 2026

Uh oh!

bito-code-review Bot commented Feb 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Agent Run #5239b6

Uh oh!

Uh oh!

dosubot Bot commented Feb 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bito-code-review Bot commented Jan 15, 2026 •

edited

Loading

bito-code-review Bot commented Feb 15, 2026 •

edited

Loading