-
-
Notifications
You must be signed in to change notification settings - Fork 31
feat(timers deprecation): introduce #255
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
base: main
Are you sure you want to change the base?
Conversation
|
I need review on test cases so I can finish/clean the implementation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a comprehensive codemod recipe to migrate deprecated Node.js timers APIs to modern timer functions. The codemod replaces timers.enroll(), timers.unenroll(), timers.active(), and timers._unrefActive() with standard setTimeout(), clearTimeout(), and Timer#unref() constructs, addressing Node.js deprecations DEP0095, DEP0096, DEP0126, and DEP0127.
Key changes include:
- New utility functions for GCD calculation and indent detection in the codemod-utils package
- Five transformation modules that handle different deprecated APIs
- Comprehensive test suite covering various import/require patterns
- Automated cleanup of unused imports after transformations
Reviewed Changes
Copilot reviewed 45 out of 46 changed files in this pull request and generated 107 comments.
Show a summary per file
| File | Description |
|---|---|
| utils/src/math.ts | Implements GCD function to calculate indentation units |
| utils/src/math.test.ts | Tests for GCD function including edge cases |
| utils/src/ast-grep/indent.ts | Detects indentation style and retrieves line indentation |
| utils/src/ast-grep/indent.test.ts | Tests for indentation detection utilities |
| utils/src/ast-grep/general.ts | Helper functions for AST manipulation |
| utils/src/ast-grep/general.test.ts | Tests for AST manipulation helpers |
| recipes/timers-deprecations/src/*.ts | Five transformation modules for each deprecated API |
| recipes/timers-deprecations/tests/** | Comprehensive test cases for all transformations |
| recipes/timers-deprecations/workflow.yaml | Workflow configuration for codemod execution |
| recipes/timers-deprecations/package.json | Package configuration and test scripts |
| recipes/timers-deprecations/codemod.yaml | Codemod metadata and registry configuration |
| recipes/timers-deprecations/README.md | Documentation with examples and caveats |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
recipes/timers-deprecations/tests/active/expected/active_import-variants.js
Show resolved
Hide resolved
recipes/timers-deprecations/tests/active/expected/active_import-variants.js
Show resolved
Hide resolved
recipes/timers-deprecations/tests/active/expected/active_import-variants.js
Show resolved
Hide resolved
recipes/timers-deprecations/tests/unref/expected/unref_import-variants.js
Show resolved
Hide resolved
recipes/timers-deprecations/tests/unref/expected/unref_import-variants.js
Show resolved
Hide resolved
recipes/timers-deprecations/tests/unref/expected/unref_import-variants.js
Show resolved
Hide resolved
recipes/timers-deprecations/tests/unref/expected/unref_import-variants.js
Show resolved
Hide resolved
recipes/timers-deprecations/tests/unref/expected/unref_import-variants.js
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this and sorry it's taken me a quite a while to get to it. It's been a helluva month :(
|
@AugustinMauroy I tried to review the rest of this, but the browser tab crashes trying to load it (it's big, but I didn't think it was that big). Would it be possible to break this into smaller pieces? |
I already do that. I just sub step for each deprecation + cleanup import |
JakobJingleheimer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this! Smaller PRs though please 🫠
I didn't review all the test files, but the implementation looks good! I don't understand how DEP0095 possibly works, but it has test coverage, so it obviously does 🤪
recipes/timers-deprecations/tests/active/expected/active_import-variants.js
Show resolved
Hide resolved
recipes/timers-deprecations/tests/active/input/active_import-variants.js
Show resolved
Hide resolved
Co-Authored-By: Jacob Smith <[email protected]>
| const matches = rootNode.findAll({ | ||
| rule: { | ||
| any: [ | ||
| { pattern: `${bindingPath}($RESOURCE)` }, | ||
| { pattern: `${bindingPath}($RESOURCE, $$$REST)` }, | ||
| ], | ||
| }, | ||
| }); | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about having just one rule that always returns all arguments, and then we just take the first one, since that’s the only one that matters?
| const matches = rootNode.findAll({ | |
| rule: { | |
| any: [ | |
| { pattern: `${bindingPath}($RESOURCE)` }, | |
| { pattern: `${bindingPath}($RESOURCE, $$$REST)` }, | |
| ], | |
| }, | |
| }); | |
| const args = rootNode.findAll({ | |
| rule: { | |
| any: [ | |
| { pattern: `${bindingPath}($$$ARGS)` }, | |
| ], | |
| }, | |
| }); | |
| firstArg = args[0] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's will need to write something like that:
const argsNode = match.field('arguments');
if (!argsNode) continue;
const argNodes = argsNode
.children()
.filter((c) => ![',', '(', ')'].includes(c.kind()));
const resourceNode = argNodes.length ? argNodes[0] : null;Which isn't better
| { pattern: `${bindingPath}($RESOURCE)` }, | ||
| { pattern: `${bindingPath}($RESOURCE, $$$REST)` }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto: What do you think about having just one rule that always returns all arguments, and then we just take the first one, since that’s the only one that matters?
| { pattern: `${bindingPath}($RESOURCE)` }, | ||
| { pattern: `${bindingPath}($RESOURCE, $$$REST)` }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto: What do you think about having just one rule that always returns all arguments, and then we just take the first one, since that’s the only one that matters?
|
All the comments I added are minor and probably just nits, so feel free to add whatever you think is relevant. Awesome work mate! |
|
I think we can proceed with this as-is, but I would reaaaaaalllly prefer if this was broken into separate migrations with a wrapper. The OP even highlights that these things are separate:
I think that is literally the structure this should have:
|
I think you had right ... But I'm lazy I dunno how to name theses codemod. What do we Win to split codemod into small codemod since we use steps ? |
Co-Authored-By: Bruno Rodrigues <[email protected]>
Fair. Me too
What it says on the tin:
Users may not need or want to migrate AllTheThings. They may want to migrate just a subset. If they want AllTheThings, run the wrapper; if just A, B, C, run A, B, C. It also makes the PR more digestable. It's currently 1.75K LoC 😱 |
Oh make sense !
In future I will not do that again sorry 😅 but this time if I split into multiple pr it's will take more time to ship. |
Yes 😥 I think I'll have a couple hours this weekend to help.
I think only slightly. If there is commonality, hoist it into a helper within the wrapper and share it 🙂 |
If you can do it. But me I'm going to be off so the only action that I will be able to do is to approve pr. |
|
I'm away for a week starting Tuesday. Btw we could also suppose there is a really bad bug in one of these. If they're all together, users can't use any of them; but if they're separate, users who need any of the 3 without the hypothetical bug can use them just fine instead of being stuck. |
timers.enroll()#335timers.unenroll()#336timers.active()#337timers._unrefActive()#338