Skip to content

[Fix] order: ensure arcane imports do not cause undefined behavior #3128

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.

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
merged 1 commit into from
Jan 29, 2025

Conversation

Xunnamius
Copy link
Contributor

@Xunnamius Xunnamius commented Dec 23, 2024

Depends on #3127

This PR implements in import/order: a fix to ensure NaN is never passed into rank-computing functions, which can result in undefined behavior.

A demo package containing this fix is temporarily available for easy testing:

npm install --save-dev eslint-plugin-import@npm:@-xun/eslint-plugin-import-experimental

Ensure strange imports do not cause strange behavior

There are certain edge cases where a NaN rank gets passed around, such as using an import with an absolute specifier under certain configurations. The fix concerns the computeRank function.

This PR includes a unit test to catch potential regressions.

@Xunnamius Xunnamius changed the title [New] order: ensure arcane imports do not cause undefined behavior [Fix] order: ensure arcane imports do not cause undefined behavior Dec 23, 2024
@ljharb ljharb marked this pull request as draft December 23, 2024 04:40
Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

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

seems good overall, assuming the test fails without the fix :-)

@Xunnamius Xunnamius force-pushed the contrib-nan-bugfix branch 2 times, most recently from 64ccfb5 to a77d6b4 Compare January 22, 2025 00:19
Copy link

codecov bot commented Jan 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.65%. Comparing base (668d493) to head (40cf277).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3128      +/-   ##
==========================================
+ Coverage   95.62%   95.65%   +0.02%     
==========================================
  Files          83       83              
  Lines        3636     3658      +22     
  Branches     1284     1305      +21     
==========================================
+ Hits         3477     3499      +22     
  Misses        159      159              

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

@Xunnamius Xunnamius marked this pull request as ready for review January 22, 2025 02:51
@Xunnamius

This comment was marked as resolved.

@ljharb ljharb marked this pull request as draft January 22, 2025 06:01
@Xunnamius Xunnamius force-pushed the contrib-nan-bugfix branch 3 times, most recently from 02d0ab1 to 40cf277 Compare January 26, 2025 07:20
@ljharb ljharb marked this pull request as ready for review January 29, 2025 07:03
@ljharb ljharb force-pushed the contrib-nan-bugfix branch from 40cf277 to 5e7ea1d Compare January 29, 2025 07:05
@ljharb ljharb merged commit 5e7ea1d into import-js:main Jan 29, 2025
341 of 342 checks passed
@Xunnamius Xunnamius deleted the contrib-nan-bugfix branch February 1, 2025 04:49
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Jun 22, 2025
| datasource | package              | from   | to     |
| ---------- | -------------------- | ------ | ------ |
| npm        | eslint-plugin-import | 2.31.0 | 2.32.0 |


## [v2.32.0](https://github.com/import-js/eslint-plugin-import/blob/HEAD/CHANGELOG.md#2320---2025-06-20)

##### Added

- add \[`enforce-node-protocol-usage`] rule and `import/node-version` setting (\[[#3024](import-js/eslint-plugin-import#3024)], thanks \[[@GoldStrikeArch](https://github.com/GoldStrikeArch)] and \[[@sevenc-nanashi](https://github.com/sevenc-nanashi)])
- add TypeScript types (\[[#3097](import-js/eslint-plugin-import#3097)], thanks \[[@G-Rath](https://github.com/G-Rath)])
- \[`extensions`]: add \`pathGroupOverrides to allow enforcement decision overrides based on specifier (\[[#3105](import-js/eslint-plugin-import#3105)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[`order`]: add `sortTypesGroup` option to allow intragroup sorting of type-only imports (\[[#3104](import-js/eslint-plugin-import#3104)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[`order`]: add `newlines-between-types` option to control intragroup sorting of type-only imports (\[[#3127](import-js/eslint-plugin-import#3127)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[`order`]: add `consolidateIslands` option to collapse excess spacing for aesthetically pleasing imports (\[[#3129](import-js/eslint-plugin-import#3129)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])

##### Fixed

- \[`no-unused-modules`]: provide more meaningful error message when no .eslintrc is present (\[[#3116](import-js/eslint-plugin-import#3116)], thanks \[[@michaelfaith](https://github.com/michaelfaith)])
- configs: added missing name attribute for eslint config inspector (\[[#3151](import-js/eslint-plugin-import#3151)], thanks \[[@NishargShah](https://github.com/NishargShah)])
- \[`order`]: ensure arcane imports do not cause undefined behavior (\[[#3128](import-js/eslint-plugin-import#3128)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[`order`]: resolve undefined property access issue when using `named` ordering (\[[#3166](import-js/eslint-plugin-import#3166)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[`enforce-node-protocol-usage`]: avoid a crash with some TS code (\[[#3173](import-js/eslint-plugin-import#3173)], thanks \[[@ljharb](https://github.com/ljharb)])
- \[`order`]: codify invariants from docs into config schema (\[[#3152](import-js/eslint-plugin-import#3152)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])

##### Changed

- \[Docs] \[`extensions`], \[`order`]: improve documentation (\[[#3106](import-js/eslint-plugin-import#3106)], thanks \[[@Xunnamius](https://github.com/Xunnamius)])
- \[Docs] add flat config guide for using `tseslint.config()` (\[[#3125](import-js/eslint-plugin-import#3125)], thanks \[[@lnuvy](https://github.com/lnuvy)])
- \[Docs] add missing comma (\[[#3122](import-js/eslint-plugin-import#3122)], thanks \[[@RyanGst](https://github.com/RyanGst)])
- \[readme] Update flatConfig example to include typescript config (\[[#3138](import-js/eslint-plugin-import#3138)], thanks \[[@intellix](https://github.com/intellix)])
- \[Refactor] \[`order`]: remove unnecessary negative check (\[[#3167](import-js/eslint-plugin-import#3167)], thanks \[[@JounQin](https://github.com/JounQin)])
- \[Docs] \[`no-unused-modules`]: add missing double quote (\[[#3191](import-js/eslint-plugin-import#3191)], thanks \[[@albertpastrana](https://github.com/albertpastrana)])
- \[Docs] `no-restricted-paths`: clarify wording and fix errors (\[[#3172](import-js/eslint-plugin-import#3172)], thanks \[[@greim](https://github.com/greim)])
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy