fix: Allows X-Axis Sort By for custom SQL #30393
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michael-s-molina
added
the
v4.1
villebro
approved these changes
Sep 25, 2024
Comment on lines
70
to
79
| const xAxisValue = controls?.x_axis?.value as QueryFormColumn; | ||
| // Given that we don't know the type of a custom SQL column, | ||
| // we treat it as sortable and give the responsibility to the | ||
| // user to provide a sortable result. | ||
| const isCustomSQL = !isPhysicalColumn(xAxisValue); | ||
| return ( | ||
| isForcedCategorical(controls) || | ||
| isCustomSQL || | ||
| checkColumnType( | ||
| getColumnLabel(controls?.x_axis?.value as QueryFormColumn), | ||
| getColumnLabel(xAxisValue), |
There was a problem hiding this comment.
I was wondering why this was passing our 100 % coverage check, but it turns out this file is tsx which is ignored in the check. I'm thinking at some point we should really move this type of critical non-React logic into .ts files and start adding tests for them. For this specific function, I'd maybe move it under src/shared-controls/utils/isSortable.ts and then add a test for it.
There was a problem hiding this comment.
@villebro I extracted the function and added tests.
villebro
approved these changes
Sep 25, 2024
sadpandajoe
pushed a commit
that referenced
this pull request
Sep 26, 2024
(cherry picked from commit abf2943)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
This PR fixes an issue where the X-Axis Sort By control was disappearing when a custom SQL was being used as an x-axis. Given that we currently have no way to identify the result type of a custom SQL, we make the control available and give the responsibility to the user to provide a sortable result. We implement the same behavior for the Time Grain control as you can see in the recordings.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Screen.Recording.2024-09-25.at.15.33.41.mov
Screen.Recording.2024-09-25.at.16.19.55.mov
TESTING INSTRUCTIONS
Check the videos for instructions.
ADDITIONAL INFORMATION