Skip to content
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

util: do not mark experimental feature as deprecated #55740

Merged
merged 2 commits into from
Nov 8, 2024

Conversation

aduh95
Copy link
Contributor

@aduh95 aduh95 commented Nov 6, 2024

A deprecated API has stability guarantees that an experimental API does not. I don't think we should mark an experimental API as deprecated without first graduating it to stable. Instead we can emit an experimental warning which would tell the user the API was renamed.

@nodejs-github-bot nodejs-github-bot added needs-ci PRs that need a full CI run. util Issues and PRs related to the built-in util module. labels Nov 6, 2024
Copy link
Member

@legendecas legendecas left a comment

Choose a reason for hiding this comment

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

There were deprecations for experimental APIs like https://github.com/nodejs/node/blob/main/doc/api/deprecations.md#dep0173-the-assertcalltracker-class.

Maybe we could document that experimental APIs will not go through deprecation cycles?

@RedYetiDev RedYetiDev added experimental Issues and PRs related to experimental features. deprecations Issues and PRs related to deprecations. labels Nov 6, 2024
Copy link

codecov bot commented Nov 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.40%. Comparing base (1aa7135) to head (6e9e54a).
Report is 128 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #55740   +/-   ##
=======================================
  Coverage   88.40%   88.40%           
=======================================
  Files         654      654           
  Lines      187747   187749    +2     
  Branches    36127    36131    +4     
=======================================
+ Hits       165972   165977    +5     
- Misses      15009    15012    +3     
+ Partials     6766     6760    -6     
Files with missing lines Coverage Δ
lib/internal/util.js 97.11% <100.00%> (+<0.01%) ⬆️
lib/util.js 97.75% <100.00%> (ø)

... and 24 files with indirect coverage changes

@aduh95
Copy link
Contributor Author

aduh95 commented Nov 6, 2024

Maybe we could document that experimental APIs will not go through deprecation cycles?

SGTM

Copy link
Member

@legendecas legendecas 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 to me with code ExperimentalWarning. Thanks for updating the util function expectWarning as well!

@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Nov 7, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 7, 2024
@nodejs-github-bot
Copy link
Collaborator

@nodejs-github-bot
Copy link
Collaborator

@marco-ippolito marco-ippolito added the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 8, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 8, 2024
@nodejs-github-bot nodejs-github-bot merged commit 94be10a into nodejs:main Nov 8, 2024
63 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 94be10a

@aduh95 aduh95 deleted the experimental-not-deprecated branch November 8, 2024 16:22
aduh95 added a commit that referenced this pull request Nov 16, 2024
PR-URL: #55740
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
tpoisseau pushed a commit to tpoisseau/node that referenced this pull request Nov 21, 2024
PR-URL: nodejs#55740
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Ceres6 pushed a commit to Ceres6/node that referenced this pull request Nov 26, 2024
PR-URL: nodejs#55740
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Ceres6 pushed a commit to Ceres6/node that referenced this pull request Nov 26, 2024
PR-URL: nodejs#55740
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
@ruyadorno
Copy link
Member

This commit does not land cleanly on v22.x-staging and will need manual backport in case we want it in v22.x.

@ruyadorno ruyadorno added the backport-requested-v22.x PRs awaiting manual backport to the v22.x-staging branch. label Nov 27, 2024
aduh95 added a commit that referenced this pull request Nov 27, 2024
PR-URL: #55740
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
@aduh95 aduh95 added backported-to-v22.x PRs backported to the v22.x-staging branch. and removed backport-requested-v22.x PRs awaiting manual backport to the v22.x-staging branch. labels Nov 27, 2024
ruyadorno pushed a commit that referenced this pull request Nov 27, 2024
PR-URL: #55740
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. backported-to-v22.x PRs backported to the v22.x-staging branch. deprecations Issues and PRs related to deprecations. experimental Issues and PRs related to experimental features. needs-ci PRs that need a full CI run. util Issues and PRs related to the built-in util module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants