Skip to content

Fix numeric color sorting in parcats bundles - #7959

Open
CAOShurong wants to merge 3 commits into
plotly:masterfrom
CAOShurong:codex/fix-parcats-numeric-bundle-sort
Open

Fix numeric color sorting in parcats bundles#7959
CAOShurong wants to merge 3 commits into
plotly:masterfrom
CAOShurong:codex/fix-parcats-numeric-bundle-sort

Conversation

@CAOShurong

Copy link
Copy Markdown

Closes #7952.

When bundlecolors is enabled, the parcats path sorter prepends each path's raw color to an array of category indices, then compares those arrays with JavaScript's < and > operators. That coerces the arrays to comma-separated strings, so numeric colors such as 1, 10, 2, 20 are ordered lexicographically.

This change compares the sort arrays element by element. Numeric colors now retain numeric order, while display-category indices and the existing value-index tie-breaker keep their current roles. A browser regression test renders a bundled parcats trace and checks the resulting path view-model order.

Verification:

  • npm run lint — passed (2,479 files)
  • npm run cibuild — passed
  • npm run test-jasmine -- parcats --nowatch --report-spec — the new regression passed; the run had 27 successes and the same four pre-existing Chrome 151/Windows drag-callback failures reproduced before the implementation
  • npm run test-bundle — 10 bundle suites passed; the unrelated MathJax v2 config suite timed out on Chrome 151/Windows

The repository does not define a type-check script. The Windows test-syntax and full build commands also hit an existing glob portability problem (0 source files found), so I am relying on the successful CI build above and the repository's hosted CI for those Linux gates.

AI assistance disclosure: This contribution was developed and tested with OpenAI Codex. The implementation, regression coverage, and observed command results are disclosed above.

@camdecoster camdecoster left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks like a good fix to me! I left one comment for you to consider. After that's resolved, I'll approve.

}

return a.length - b.length;
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What do you think of adding a JSDoc comment and a block to handle NaN values? This likely wouldn't happen in practice, but it could.

Suggested change
}
/**
* Compare two sort arrays element by element in ascending order.
* Values that do not order against each other, for example NaN, sort last.
* The shorter array sorts first when one array is a prefix of the other.
*
* @param {Array} a
* @param {Array} b
*/
function compareArrays(a, b) {
for (let i = 0; i < Math.min(a.length, b.length); i++) {
const valA = a[i];
const valB = b[i];
if (valA < valB) return -1;
if (valA > valB) return 1;
// Handle values that do not order against each other (NaN, undefined, etc.)
if (valA !== valB) {
// Sort these after every orderable value.
const badA = isNaN(valA);
const badB = isNaN(valB);
if (badA !== badB) return badA ? 1 : -1;
}
}
return a.length - b.length;
}

Per review suggestion from camdecoster:
- Add JSDoc comment documenting ascending-order comparison,
  NaN-sorting behavior, and prefix handling.
- Handle values that do not order against each other (NaN,
  undefined) by sorting them after every orderable value.
- Add test verifying NaN color values sort after orderable
  values in bundled parallel-categories paths.

The 4 pre-existing drag/reorder test failures are unchanged
by this commit (27->28 passing, same 4 baseline failures).
@CAOShurong

Copy link
Copy Markdown
Author

Thanks @camdecoster for the suggestion! I've implemented it in commit \�ec4e475:

  • Added the JSDoc comment documenting the ascending-order comparison, NaN-sorting behavior, and prefix handling.
  • Added the NaN handling block: values that do not order against each other (NaN, undefined, etc.) now sort after every orderable value, using the \isNaN\ check as you suggested.
  • Added a Jasmine test (\should sort NaN color values after orderable values) verifying that [10, NaN, 2, NaN]\ sorts to [2, 10, NaN, NaN].

The new test and the existing numeric-color test both pass. The 4 pre-existing drag/reorder test failures are unchanged by this commit (they fail identically on the prior head).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG]: bundlecolors in parallel_categories plot (Parcats) sort numerical values out of order

2 participants