Skip to content

fix(echarts): Sort series by name using natural comparison #32850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Vitor-Avila merged 2 commits into from
Mar 26, 2025
+122 −5
Merged

fix(echarts): Sort series by name using natural comparison #32850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac7c4fd
fix(echarts): Sort series by name using naturalCompare
Vitor-Avila Mar 25, 2025
49803da
Addressing PR feedback
Vitor-Avila Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions superset-frontend/plugins/plugin-chart-echarts/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@
"lib"
],
"dependencies": {
"@types/react-redux": "^7.1.10",
"d3-array": "^1.2.0",
"lodash": "^4.17.21",
"dayjs": "^1.11.13",
"@types/react-redux": "^7.1.10"
"lodash": "^4.17.21"

@mistercrunch mistercrunch Mar 25, 2025

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.

should this be a peerDep?

@Vitor-Avila Vitor-Avila Mar 25, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@mistercrunch hmm not sure. Since we changed the approach in the PR to use Intl.Collator there's no real changes in package.json -- it's just sorting these.

@mistercrunch mistercrunch Mar 25, 2025 •
edited
Loading

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.

oh wait, I thought it was new dep you added, but you simply re-ordered them. Now wondering whether it should have been a peerDep in the first place (?)

@Vitor-Avila Vitor-Avila Mar 26, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yeah, they were just re-ordered by running pre-commit before pushing this. I'm not too familiar with the package.json configs so not sure if we need these explicitly listed as a dependency, but I can look into updating this if needed.

},
"peerDependencies": {
"@superset-ui/chart-controls": "*",
Expand Down
12 changes: 9 additions & 3 deletions superset-frontend/plugins/plugin-chart-echarts/src/utils/series.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,15 @@ export function sortAndFilterSeries(
case SortSeriesType.Avg:
aggregator = name => ({ name, value: meanBy(rows, name) });
break;
default:
aggregator = name => ({ name, value: name.toLowerCase() });
break;
default: {
const collator = new Intl.Collator(undefined, {
numeric: true,
sensitivity: 'base',
});
return seriesNames.sort((a, b) =>
sortSeriesAscending ? collator.compare(a, b) : collator.compare(b, a),
);
}
}

const sortedValues = seriesNames.map(aggregator);
Expand Down
111 changes: 111 additions & 0 deletions superset-frontend/plugins/plugin-chart-echarts/test/utils/series.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,39 @@ const sortData: DataRecord[] = [
{ my_x_axis: null, x: 4, y: 3, z: 7 },
];

const sortDataWithNumbers: DataRecord[] = [
{
my_x_axis: 'my_axis',
'9. September': 6,
6: 1,
'11. November': 8,
8: 2,
'10. October': 1,
10: 4,
'3. March': 2,
'8. August': 6,
2: 1,
12: 3,
9: 1,
'1. January': 1,
'4. April': 12,
'2. February': 9,
5: 4,
3: 1,
11: 2,
'12. December': 4,
1: 7,
'6. June': 1,
4: 5,
7: 2,
c: 0,
'7. July': 2,
d: 0,
'5. May': 4,
a: 1,
},
];

const totalStackedValues = [3, 15, 14];

test('sortRows by name ascending', () => {
Expand Down Expand Up @@ -288,6 +321,84 @@ test('sortAndFilterSeries by name descending', () => {
sortAndFilterSeries(sortData, 'my_x_axis', [], SortSeriesType.Name, false),
).toEqual(['z', 'y', 'x']);
});
test('sortAndFilterSeries by name with numbers asc', () => {
expect(
sortAndFilterSeries(
sortDataWithNumbers,
'my_x_axis',
[],
SortSeriesType.Name,
true,
),
).toEqual([
'1',
'1. January',
'2',
'2. February',
'3',
'3. March',
'4',
'4. April',
'5',
'5. May',
'6',
'6. June',
'7',
'7. July',
'8',
'8. August',
'9',
'9. September',
'10',
'10. October',
'11',
'11. November',
'12',
'12. December',
'a',
'c',
'd',
]);
});
test('sortAndFilterSeries by name with numbers desc', () => {
expect(
sortAndFilterSeries(
sortDataWithNumbers,
'my_x_axis',
[],
SortSeriesType.Name,
false,
),
).toEqual([
'd',
'c',
'a',
'12. December',
'12',
'11. November',
'11',
'10. October',
'10',
'9. September',
'9',
'8. August',
'8',
'7. July',
'7',
'6. June',
'6',
'5. May',
'5',
'4. April',
'4',
'3. March',
'3',
'2. February',
'2',
'1. January',
'1',
]);
});

describe('extractSeries', () => {
it('should generate a valid ECharts timeseries series object', () => {
Expand Down