fix(explore): add matrixify_enable guard to prevent stale validators on pre-revamp charts by sadpandajoe · Pull Request #38765 · apache/superset

sadpandajoe · 2026-03-20T15:59:51Z

User description

SUMMARY

Some charts are failing to load in explore view as well as the Save/Update buttons are disabled and the initial query is blocked by invisible validation errors.

Root cause: isMatrixifyVisible() evaluates mode values (matrixify_mode_rows/matrixify_mode_columns) without first checking whether matrixify is enabled (matrixify_enable). Pre-revamp charts have stale mode defaults ('dimensions'/'metrics') persisted in form_data, so isMatrixifyVisible() returns true and validators fire on empty matrixify controls. The errors are invisible because matrixify tab controls are excluded from the error banner.

Fix (3 parts):

Runtime guard (matrixifyControls.tsx): isMatrixifyVisible() now checks matrixify_enable === true before evaluating mode values. Handles undefined (old charts) via !== true.
Form_data migration (store.ts): handleDeprecatedControls() normalizes stale matrixify modes on legacy charts. Detects old per-axis enable flags (matrixify_enable_vertical_layout / matrixify_enable_horizontal_layout) to preserve modes for charts that genuinely used matrixify. Required because 4 downstream UI consumers (ExploreChartPanel, ChartContextMenu, DrillBySubmenu, ChartRenderer) infer "matrixify is active" from mode values alone.
Dashboard + explore consistency (hydrateExplore.ts, store.ts): handleDeprecatedControls exported and called in hydrateExplore and applyDefaultFormData so both explore and dashboard paths normalize stale form_data.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A — logic-only fix with no UI changes.

TESTING INSTRUCTIONS

Open a chart that was saved before the matrixify revamp (any chart without matrixify_enable in its form_data)
Verify the chart loads and queries without errors
Verify the Save/Update buttons are enabled
Even with the Matrixify feature flag disabled, confirm that charts no longer hit hidden validation errors (control definitions and validators are registered regardless of the feature flag)
Open a chart that uses matrixify (matrixify_enable: true) — verify matrixify controls still work correctly
Open a pre-revamp chart on a dashboard — verify it renders without issues

Automated tests (34 total):

matrixifyControls.test.tsx (15 tests): Direct isMatrixifyVisible guard tests + validator injection via real mapStateToProps
store.test.tsx (19 tests): Migration, dashboard hydration, old per-axis flag detection, round-trip validation

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 Description

Fix stale Matrixify settings so saved charts load and save normally

What Changed

Charts saved before the Matrixify change now ignore old Matrixify defaults unless Matrixify is actually enabled, preventing hidden validation errors from blocking load and save.
Legacy charts that used the older per-axis Matrixify settings are now carried forward correctly, keeping active Matrixify layouts working while resetting unused sides.
Dashboard and Explore both apply the same cleanup so chart settings stay consistent across entry points.
Added tests for hidden validation behavior, legacy setting cleanup, and dashboard hydration paths.

Impact

✅ Fewer blocked chart saves
✅ Fewer chart load failures for older saved charts
✅ Consistent Matrixify behavior in Explore and dashboards

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

bito-code-review · 2026-03-20T16:00:02Z

Code Review Agent Run #b767fe

Actionable Suggestions - 0

Additional Suggestions - 1

superset-frontend/packages/superset-ui-chart-controls/test/shared-controls/matrixifyControls.test.tsx - 1

Missing return type hints · Line 37-50

Helper functions buildControls and buildState lack explicit return type hints, which violates the codebase's type safety standards requiring explicit annotations for all functions, including test helpers. This improves consistency and enables better static checking without changing behavior.

Code suggestion

 @@ -37,1 +37,1 @@
- const buildControls = (overrides: Record<string, any> = {}) => {
+ const buildControls = (overrides: Record<string, any> = {}): Record<string, { value: any }> => {
 @@ -47,4 +47,4 @@
- const buildState = (
-   controlValues: Record<string, any> = {},
-   formData: Record<string, any> = {},
- ) =>
+ const buildState = (
+   controlValues: Record<string, any> = {},
+   formData: Record<string, any> = {},
+ ): ControlPanelState =>

Review Details

Files reviewed - 5 · Commit Range: d307100..88a9b3b
- superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/matrixifyControls.tsx
- superset-frontend/packages/superset-ui-chart-controls/test/shared-controls/matrixifyControls.test.tsx
- superset-frontend/src/explore/actions/hydrateExplore.ts
- superset-frontend/src/explore/store.test.tsx
- superset-frontend/src/explore/store.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

codeant-ai-for-open-source · 2026-03-20T16:01:16Z

Sequence Diagram

This PR fixes legacy chart loading by normalizing stale matrixify fields before control state is built, and by gating matrixify visibility on an explicit enable flag. Together, these changes prevent hidden validators from blocking initial queries and save actions.

sequenceDiagram
    participant User
    participant ExploreOrDashboard
    participant Store
    participant MatrixifyControls
    participant UI

    User->>ExploreOrDashboard: Open legacy chart
    ExploreOrDashboard->>Store: Normalize deprecated form data
    Store->>Store: If enable missing migrate old flags or disable stale modes
    ExploreOrDashboard->>MatrixifyControls: Build controls from normalized form data
    MatrixifyControls->>MatrixifyControls: Require matrixify enable true before mode checks
    MatrixifyControls-->>UI: No hidden matrixify validators
    UI-->>User: Chart loads and save update stays enabled

Generated by CodeAnt AI

netlify · 2026-03-20T16:01:51Z

✅ Deploy Preview for superset-docs-preview ready!

Name	Link
🔨 Latest commit	`9fcf6d8`
🔍 Latest deploy log	https://app.netlify.com/projects/superset-docs-preview/deploys/69c6ad00f77bb00009c71f51
😎 Deploy Preview	https://deploy-preview-38765--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.

Copilot

Pull request overview

Fixes a regression where legacy (pre-matrixify-revamp) charts can end up with hidden matrixify validation errors in Explore due to stale persisted matrixify_mode_* values, and normalizes legacy matrixify-related form_data during Explore and dashboard hydration.

Changes:

Guard isMatrixifyVisible() behind matrixify_enable === true to prevent invisible validators from firing on legacy charts.
Add handleDeprecatedControls() migration logic to normalize legacy matrixify fields (including old per-axis enable flags) and apply it consistently across Explore + dashboard hydration paths.
Add/expand unit tests covering the guard behavior, validator injection, and form_data normalization.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
superset-frontend/src/explore/store.ts	Exports and extends deprecated-control normalization to migrate/reset legacy matrixify fields; applies normalization in `applyDefaultFormData`.
superset-frontend/src/explore/store.test.tsx	Adds regression tests for legacy matrixify normalization across Explore and dashboard paths.
superset-frontend/src/explore/actions/hydrateExplore.ts	Runs deprecated-control normalization before storing initial `form_data` in Redux state.
superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/matrixifyControls.tsx	Adds `matrixify_enable` guard in `isMatrixifyVisible()` and exports it for testing.
superset-frontend/packages/superset-ui-chart-controls/test/shared-controls/matrixifyControls.test.tsx	New tests for visibility guard and validator injection behavior.

Copilot · 2026-03-20T16:12:54Z

superset-frontend/src/explore/actions/hydrateExplore.ts

+    // must reflect the same migration so the two stay consistent.
+    handleDeprecatedControls(initialFormData);
+
    const initialExploreState = {
      form_data: initialFormData,
      slice: initialSlice,


hydrateExplore mutates initialFormData in place (now including handleDeprecatedControls(initialFormData)). When initialFormData is sourced from initialSlice?.form_data (from Redux state), this can mutate the sliceEntities cache/state object. Consider cloning (and possibly deep-cloning) the initial form_data before any in-place edits/migrations so Redux state isn't mutated indirectly.

Pre-existing pattern — lines 80–103 of this same function already mutate initialFormData in place (viz_type, time_range, groupby, granularity_sqla, dashboardId). Cloning just for this call would be inconsistent; fixing the broader mutation-of-Redux-state issue is out of scope for this bug fix.

Copilot · 2026-03-20T16:12:54Z

superset-frontend/src/explore/store.test.tsx

+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+(window as any).featureFlags = {};


This test file assigns window.featureFlags at module scope but doesn't restore the prior value. To avoid cross-test leakage when Jest reuses the same environment for multiple files, consider capturing the existing window.featureFlags in beforeAll/beforeEach and restoring it in afterAll/afterEach.

This follows the existing codebase pattern (e.g. ExploreChartHeader.test.tsx:43 does the same). Setting to an empty {} at module scope doesn't leak test-specific state between files.

Copilot · 2026-03-20T16:12:54Z

superset-frontend/src/explore/store.ts

+  if (!('matrixify_enable' in formData)) {
+    const hadVerticalLayout =
+      formData.matrixify_enable_vertical_layout === true;
+    const hadHorizontalLayout =
+      formData.matrixify_enable_horizontal_layout === true;
+
+    if (hadVerticalLayout || hadHorizontalLayout) {
+      // Pre-revamp chart that genuinely used matrixify — migrate to new flag
+      formData.matrixify_enable = true;
+      if (!hadVerticalLayout) formData.matrixify_mode_rows = 'disabled';
+      if (!hadHorizontalLayout) formData.matrixify_mode_columns = 'disabled';
+    } else {


handleDeprecatedControls migrates legacy per-axis matrixify flags to the new matrixify_enable toggle, but it leaves the deprecated keys (matrixify_enable_vertical_layout / matrixify_enable_horizontal_layout) on formData. Because applyDefaultFormData later merges all keys from cleanedFormData, these deprecated fields can be carried forward and re-persisted. Consider deleting these deprecated properties after migration so the normalized form_data no longer contains removed controls.

Follows the existing convention in this function — the y_axis_zero migration (line 57–60) also leaves the deprecated key on formData after migrating its value. The old per-axis keys are dead data (no code reads them after the revamp), so leaving them is harmless and consistent.

bito-code-review · 2026-03-20T17:06:52Z

Code Review Agent Run #aea000

Actionable Suggestions - 0

Review Details

Files reviewed - 1 · Commit Range: 88a9b3b..ae79c1b
- superset-frontend/src/explore/actions/hydrateExplore.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

gabotorresruiz · 2026-03-24T01:24:08Z

superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/matrixifyControls.tsx

+// The matrixify_enable guard prevents hidden validators from firing on
+// pre-revamp charts with stale matrixify_mode defaults (fix for #38519).
 const isMatrixifyVisible = (
  controls: any,


Just a small NIT: controls is typed as any. Given that the function only accesses controls?.[key]?.value, a narrower type like Record<string, { value?: unknown } | undefined> or something like that would be sufficient.

This aligns with the project's ongoing removal of any
Not a blocker.

nice callout. Done.

michael-s-molina · 2026-03-24T17:58:29Z

@sadpandajoe @msyavuz Is this complementary or a duplicate of #38759?

bito-code-review · 2026-03-24T18:29:34Z

Code Review Agent Run #a9f5e3

Actionable Suggestions - 0

Review Details

Files reviewed - 5 · Commit Range: ae61a0c..570c05a
- superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/matrixifyControls.tsx
- superset-frontend/packages/superset-ui-chart-controls/test/shared-controls/matrixifyControls.test.tsx
- superset-frontend/src/explore/actions/hydrateExplore.ts
- superset-frontend/src/explore/store.test.tsx
- superset-frontend/src/explore/store.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

The previous commit replaced `controls: any` with `ControlStateMapping` in isMatrixifyVisible but left test helpers returning incompatible types, breaking the tsc step in CI. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

sadpandajoe · 2026-03-24T20:40:27Z

@sadpandajoe @msyavuz Is this complementary or a duplicate of #38759?

This should be complimentary

bito-code-review · 2026-03-24T21:42:28Z

Code Review Agent Run #250285

Actionable Suggestions - 0

Review Details

Files reviewed - 3 · Commit Range: 570c05a..5a194fd
- superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/matrixifyControls.test.ts
- superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/matrixifyControls.tsx
- superset-frontend/packages/superset-ui-chart-controls/test/shared-controls/matrixifyControls.test.tsx
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

github-actions · 2026-04-12T03:54:06Z

🎪 Showtime is building environment on GHA for 9fcf6d8

github-actions · 2026-04-12T04:13:48Z

🎪 Showtime deployed environment on GHA for 9fcf6d8

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

pull-request-size bot added the size/XL label Mar 20, 2026

dosubot bot added the explore Namespace | Anything related to Explore label Mar 20, 2026

github-actions bot added the packages label Mar 20, 2026

codeant-ai-for-open-source bot added the size:XL This PR changes 500-999 lines, ignoring generated files label Mar 20, 2026

sadpandajoe requested review from Copilot and msyavuz March 20, 2026 16:05

Copilot started reviewing on behalf of sadpandajoe March 20, 2026 16:05 View session

Copilot AI reviewed Mar 20, 2026

View reviewed changes

gabotorresruiz approved these changes Mar 24, 2026

View reviewed changes

sadpandajoe requested review from betodealmeida, craig-rueda, dpgaspar, eschutho, geido, hainenber, kgabryje, michael-s-molina, mistercrunch, nytai, rusackas and villebro as code owners March 24, 2026 17:24

github-actions bot added i18n Namespace | Anything related to localization i18n:italian Translation related to Italian language doc Namespace | Anything related to documentation plugins dependencies:npm labels Mar 24, 2026

sadpandajoe removed request for geido, hainenber, michael-s-molina and villebro March 24, 2026 17:26

Merge branch 'master' into fix-echart-save-issue

9fcf6d8

codeant-ai-for-open-source bot added size:XL This PR changes 500-999 lines, ignoring generated files and removed size:XXL This PR changes 1000+ lines, ignoring generated files labels Mar 27, 2026

sadpandajoe added the hold:testing! On hold for testing label Mar 30, 2026

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

		// eslint-disable-next-line @typescript-eslint/no-explicit-any
		(window as any).featureFlags = {};

Conversation

sadpandajoe commented Mar 20, 2026 • edited by codeant-ai-for-open-source bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

CodeAnt-AI Description

What Changed

Impact

Checking Your Pull Request

Talking to CodeAnt AI

Example

Preserve Org Learnings with CodeAnt

Example

Retrigger review

Check Your Repository Health

Uh oh!

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

Uh oh!

Code Review Agent Run #b767fe

Uh oh!

codeant-ai-for-open-source bot commented Mar 20, 2026

Sequence Diagram

Uh oh!

netlify bot commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for superset-docs-preview ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

sadpandajoe Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

sadpandajoe Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

sadpandajoe Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Code Review Agent Run #aea000

Uh oh!

gabotorresruiz Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

sadpandajoe Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

michael-s-molina commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Code Review Agent Run #a9f5e3

Uh oh!

sadpandajoe commented Mar 24, 2026

Uh oh!

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

Uh oh!

Code Review Agent Run #250285

Uh oh!

github-actions bot commented Apr 12, 2026

Uh oh!

github-actions bot commented Apr 12, 2026

Uh oh!

sadpandajoe commented Mar 20, 2026 •

edited by codeant-ai-for-open-source bot

Loading

bito-code-review bot commented Mar 20, 2026 •

edited

Loading

netlify bot commented Mar 20, 2026 •

edited

Loading

bito-code-review bot commented Mar 20, 2026 •

edited

Loading

michael-s-molina commented Mar 24, 2026 •

edited

Loading

bito-code-review bot commented Mar 24, 2026 •

edited

Loading

bito-code-review bot commented Mar 24, 2026 •

edited

Loading