Skip to content

Slightly improve module deprecation warnings #58442

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

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

Slightly improve module deprecation warnings #58442

wants to merge 2 commits into from

Conversation

dario-piotrowicz
Copy link
Member

As suggested by @shivarm I'm adding to all the various module deprecation warnings the suggestion of what alternative module should be used instead, I am also updating the sys warning to refer to node:util instead of util.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/streams

@dario-piotrowicz dario-piotrowicz added the semver-major PRs that contain breaking changes and should be released in the next major version. label May 23, 2025
@nodejs-github-bot nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels May 23, 2025
@dario-piotrowicz
Copy link
Member Author

I've added the semver-major label since this PR is making changes to code introduced in #58337 which was under semver-major, so I figured that it probably makes sense to also mark this PR as semver-major (so that it's not going to be applied to old releases with the other changes), please let me know if I'm wrong 🙂

@codecov Codecov
Copy link

codecov bot commented May 23, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.18%. Comparing base (e9c6004) to head (95e9c1a).
Report is 23 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #58442   +/-   ##
=======================================
  Coverage   90.18%   90.18%           
=======================================
  Files         635      635           
  Lines      187224   187224           
  Branches    36760    36762    +2     
=======================================
+ Hits       168850   168851    +1     
+ Misses      11139    11126   -13     
- Partials     7235     7247   +12
Files with missing lines Coverage Δ
lib/_stream_duplex.js 100.00% <100.00%> (ø)
lib/_stream_passthrough.js 100.00% <100.00%> (ø)
lib/_stream_readable.js 100.00% <100.00%> (ø)
lib/_stream_transform.js 100.00% <100.00%> (ø)
lib/_stream_wrap.js 100.00% <100.00%> (ø)
lib/_stream_writable.js 100.00% <100.00%> (ø)
lib/_tls_common.js 100.00% <100.00%> (ø)
lib/_tls_wrap.js 100.00% <100.00%> (ø)
lib/sys.js 100.00% <100.00%> (ø)

... and 20 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@anonrig anonrig added the request-ci Add this label to start a Jenkins CI on a PR. label May 24, 2025
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 24, 2025
@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/67042/

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/67049/

@RaisinTen RaisinTen added dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. dont-land-on-v22.x PRs that should not land on the v22.x-staging branch and should not be released in v22.x. dont-land-on-v23.x PRs that should not land on the v23.x-staging branch and should not be released in v23.x. dont-land-on-v24.x PRs that should not land on the v18.x-staging branch and should not be released in v24.x. and removed semver-major PRs that contain breaking changes and should be released in the next major version. labels May 26, 2025
RaisinTen
RaisinTen approved these changes May 26, 2025
View reviewed changes
Copy link
Member

@RaisinTen RaisinTen left a comment

Choose a reason for hiding this comment

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

Looks good. The dont-land labels are more appropriate than the semver-major label, so I have replaced the label.

@dario-piotrowicz
Copy link
Member Author

Looks good. The dont-land labels are more appropriate than the semver-major label, so I have replaced the label.

Thanks @RaisinTen 🙏

(I did consider using the dont-land labels but I wasn't sure which would be more appropriate here, good to know for next time 🙏)

@dario-piotrowicz dario-piotrowicz added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. labels May 26, 2025
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 26, 2025
@nodejs-github-bot
Copy link
Collaborator

Landed in d3bc454...83052ff

nodejs-github-bot pushed a commit that referenced this pull request May 26, 2025
@dario-piotrowicz @nodejs-github-bot
lib: add module to use in module deprecation warnings
d5abfbf 
PR-URL: #58442
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
nodejs-github-bot pushed a commit that referenced this pull request May 26, 2025
@dario-piotrowicz @nodejs-github-bot
lib: add node: prefix in sys module deprecation warning
83052ff 
PR-URL: #58442
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
@dario-piotrowicz dario-piotrowicz deleted the dario/module-deprecations-add-instead branch May 26, 2025 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anonrig anonrig anonrig approved these changes

@RaisinTen RaisinTen RaisinTen approved these changes

@bjohansebas bjohansebas bjohansebas approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. dont-land-on-v22.x PRs that should not land on the v22.x-staging branch and should not be released in v22.x. dont-land-on-v23.x PRs that should not land on the v23.x-staging branch and should not be released in v23.x. dont-land-on-v24.x PRs that should not land on the v18.x-staging branch and should not be released in v24.x. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@dario-piotrowicz @nodejs-github-bot @anonrig @RaisinTen @bjohansebas