Skip to content

fix: Heatmap sorting - #31752

Merged
michael-s-molina merged 1 commit into
apache:masterfrom
michael-s-molina:fix-heatmap-sorting
Jan 9, 2025
Merged

michael-s-molina merged 1 commit into
apache:masterfrom
michael-s-molina:fix-heatmap-sorting

Conversation

@michael-s-molina

Copy link
Copy Markdown
Member

SUMMARY

Fixes #31318 by giving users the flexibility to sort a Heatmap chart by only one axis.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Screen.Recording.2025-01-08.at.11.01.26.mov

TESTING INSTRUCTIONS

Check the original issue for instructions.

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

@dosubot dosubot Bot added the viz:charts:heatmap Related to the Heatmap chart label Jan 8, 2025
@michael-s-molina

Copy link
Copy Markdown
Member Author

@nicholaslimck

@korbit-ai korbit-ai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review by Korbit AI

Korbit automatically attempts to detect when you fix issues in new commits.
Category Issue Fix Detected
Functionality Array index access without bounds check ▹ view
Functionality Unsafe Value Type Assertion in Formatter ▹ view
Files scanned ​
File Path Reviewed
superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/types.ts ✅
superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/buildQuery.ts ✅
superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/transformProps.ts ✅
superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/controlPanel.tsx ✅

Explore our documentation to understand the languages and file types we support and the files we ignore.

Need a new review? Comment /korbit-review on this PR and I'll review your latest changes.

Korbit Guide: Usage and Customization

Interacting with Korbit

  • You can manually ask Korbit to review your PR using the /korbit-review command in a comment at the root of your PR.
  • You can ask Korbit to generate a new PR description using the /korbit-generate-pr-description command in any comment on your PR.
  • Too many Korbit comments? I can resolve all my comment threads if you use the /korbit-resolve command in any comment on your PR.
  • Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
  • Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.

Customizing Korbit

  • Check out our docs on how you can make Korbit work best for you and your team.
  • Customize Korbit for your organization through the Korbit Console.

Current Korbit Configuration

General Settings ​
Setting Value
Review Schedule Automatic excluding drafts
Max Issue Count 10
Automatic PR Descriptions ❌
Issue Categories ​
Category Enabled
Naming ✅
Database Operations ✅
Documentation ✅
Logging ✅
Error Handling ✅
Systems and Environment ✅
Objects and Data Structures ✅
Readability and Maintainability ✅
Asynchronous Processing ✅
Design Patterns ✅
Third-Party Libraries ✅
Performance ✅
Security ✅
Functionality ✅

Feedback and Support

Note

Korbit Pro is free for open source projects 🎉

Looking to add Korbit to your team? Get started with a free 2 week trial here

}
if (sort_y_axis) {
orderby.push([
sort_y_axis.includes('value') ? metric : columns[1],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Array index access without bounds check category Functionality

Tell me more
What is the issue?

No validation that columns[1] exists before accessing it

Why this matters

If groupby is empty array, columns[1] will be undefined, potentially causing incorrect sorting behavior or runtime errors

Suggested change

Add validation: sort_y_axis.includes('value') ? metric : (columns[1] ?? columns[0])

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

Comment on lines +159 to +162
formatter: (params: CallbackDataParams) => {
const paramsValue = params.value as (string | number)[];
return valueFormatter(paramsValue?.[2] as number | null | undefined);
},

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unsafe Value Type Assertion in Formatter category Functionality

Tell me more
What is the issue?

The type assertion of params.value to (string | number)[] may lead to runtime errors if the actual value structure differs from the expected format.

Why this matters

If the data structure changes or if params.value is undefined, the code could crash during chart rendering. The current implementation doesn't provide proper runtime validation of the data structure.

Suggested change

Add proper runtime validation:

formatter: (params: CallbackDataParams) => {
  if (!params.value || !Array.isArray(params.value)) {
    return '';
  }
  const value = params.value[2];
  return valueFormatter(typeof value === 'number' ? value : null);
}
Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

@justinpark justinpark left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@michael-s-molina
michael-s-molina merged commit a477d84 into apache:master Jan 9, 2025
sadpandajoe pushed a commit to preset-io/superset that referenced this pull request Mar 21, 2025
(cherry picked from commit a477d84)
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 5.0.0 First shipped in 5.0.0 labels Jul 29, 2025
qfcwell pushed a commit to qfcwell/superset that referenced this pull request May 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels plugins size/M viz:charts:heatmap Related to the Heatmap chart 🚢 5.0.0 First shipped in 5.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Heatmap y-axis sorting logic broken

3 participants