fix(collection)!: default sort comparison algorithm

[Renegade334]

Please describe the changes this PR makes and why it should be merged:

The documentation for Collection#sort and Collection#toSorted implies that if no comparison function is passed to the method, the default comparison behaviour mirrors that of Array.prototype.sort – in other words, stringwise comparison by UTF-16 code points.

As things stand, that's not the case. There are a couple of significant issues with the current implementation of defaultSort:

• The function doesn't implement stringwise comparison but instead just uses the > operator, which preferentially performs numeric comparison of its operands.
  • For example, '1.0' is sorted after 1 with stringwise comparison, but '1.0' > 1 is false.
• The function returns -1 (ie. A before B) if A is neither greater than B nor strict-equal to B. However, this isn't logically correct in a sort comparison context, and leads to violations of the required properties of a reliable comparator.
  • For example:

    const a = { a: 1 };
    const b = { b: 2 };
    defaultSort(a, b); // -1
    defaultSort(b, a); // also -1

I'm assuming that the intention is for the default behaviour to mirror that of Array.prototype.sort, and so this PR rewrites the function to follow the ECMA-262 specification for the default comparison algorithm. The docblocks are also updated to reflect this more accurately.

Status and versioning classification:

• Code changes have been tested against the Discord API, or there are no code changes
• I know how to update typings and have done so, or typings don't need updating

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
discord-js	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 26, 2024 9:49am
discord-js-guide	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 26, 2024 9:49am

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.18%. Comparing base (6cbe248) to head (8bdfa16).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10412      +/-   ##
==========================================
+ Coverage   38.01%   43.18%   +5.16%     
==========================================
  Files         239      229      -10     
  Lines       15471    17683    +2212     
  Branches     1353     1189     -164     
==========================================
+ Hits         5881     7636    +1755     
- Misses       9575    10003     +428     
- Partials       15       44      +29     

Flag	Coverage Δ
collection	100.00% <100.00%> (ø)
proxy	66.27% <ø> (ø)
rest	87.37% <ø> (ø)
ws	36.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[kyranet]

I'm labelling this as semver-major because it changes the behaviour of Collection#sort without arguments, which may have been desirable to users (and not longer is anymore).

Resolved