doc: Add Documentation Deprecation for process._tickCallback by lholmquist · Pull Request #29781 · nodejs/node

lholmquist · 2019-09-30T18:06:53Z

Related to #29671.

This starts the documentation deprecation of process._tickCallback

It was suggested that --pending-deprecation could be enabled for this, however, i'm not really sure how to get the value of the --pending-deprecation flag. I've looked at previous commits that do this, but the way they do it, doesn't seem to work in the file that this deprecation needs to happen in. So any guidance there would be great.

Since this API was never documented in the process docs, i didn't add any docs there. If someone feels strongly that docs should be added(and label as deprecated), then i'm open to that.

A remaining question is if this API should be replaced by the suggestion in the other PR, #29671

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

jasnell · 2019-09-30T18:54:14Z

@nodejs/tsc ... any objections to landing this documentation-only deprecation as a semver-minor?

Trott · 2019-09-30T21:38:24Z

@nodejs/tsc ... any objections to landing this documentation-only deprecation as a semver-minor?

I appreciate the ping and feel free to do that in the future if you want, but FYI, no need for TSC approval for landing doc-only deprecations in a minor release. As it says in https://github.com/nodejs/node/blob/2487f390307b28be8c2d1d137f483900937237eb/COLLABORATOR_GUIDE.md#deprecations:

Documentation-Only Deprecations may land in a minor release.

(It's a bit buried in there, suggesting that there might be too much text or something, but it's there!)

Trott · 2019-10-01T04:38:47Z

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3951/

lholmquist · 2019-10-01T10:01:24Z

(It's a bit buried in there, suggesting that there might be too much text or something, but it's there!)

sort of a side note here. I wonder if that deprecation section should be broken out into its own doc under doc/guides?

jasnell · 2019-10-01T15:34:12Z

I appreciate the ping and feel free to do that in the future if you want, but FYI, no need for TSC approval for landing doc-only deprecations in a minor release

Yep, I believe I wrote that particular section. Was just a courtesy ping.

benjamingr

I would prefer adding a warning about why and it being risky.

Trott · 2019-10-01T16:41:17Z

Yep, I believe I wrote that particular section.

Yep, I'm definitely aware that you wrote the original text. The reason I mentioned it is because it's changed from when you wrote it to remove the semver-major/semver-minor choice. But I didn't want to point that out for some reason. Seemed kind of discourteous somehow but I can't really explain why I was feeling that. Maybe I'm just strange. Anyway...

Original text:

Documentation-Only Deprecations may be handled as semver-minor or semver-major changes.

Current text:

Apply the notable change label to all pull requests that introduce
Documentation-Only Deprecations. Such deprecations have no impact on code
execution. Thus, they are not breaking changes (semver-major).

Speaking of which, notable change label applied! 😄

lholmquist · 2019-10-01T16:48:44Z

@benjamingr i would also like to add a "pending-deprecation" warning if the flag was specificed, but i wasn't sure how to get access to that flag in the file it should happen in, https://github.com/nodejs/node/blob/master/lib/internal/bootstrap/node.js#L287

addaleax · 2019-10-01T16:53:05Z

@lholmquist That sounds good! In that file, CLI flags aren’t available yet (because the results have to be identical across Node.js versions).

You can look for the process.binding deprecation in lib/internal/bootstrap/pre_execution.js and add a second statement to that if, that should take care of it.

lholmquist · 2019-10-01T17:09:15Z

@addaleax thanks. I'll take a look

lholmquist · 2019-10-01T17:42:31Z

@addaleax thanks! that did it

nodejs-github-bot · 2019-10-01T18:04:49Z

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

Trott · 2019-10-02T21:33:51Z

(Added semver-minor because the additional warning with --pending-deprecation is a feature enhancement, or at least could be interpreted as one.)

Trott · 2019-10-02T21:35:16Z

Landed in 83418b5

This change also supports --pending-deprecation for the new deprecation. PR-URL: #29781 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

vsemozhetbyt · 2019-10-03T01:29:21Z

Do we replace DEP0XXX on landing?

richardlau · 2019-10-03T01:47:39Z

Do we replace DEP0XXX on landing?

In this case #29820 is assigning a code.

I had thought that our process was to assign on landing, but I just checked and it turns out our documented process is for it to happen on release: https://github.com/nodejs/node/blob/e2dcbf1c3231513c38151d729f180a54ea902da9/doc/releases.md#step-3-update-any-replaceme-and-dep00xx-tags-in-the-docs

In any case we have checks in the makefile so release builds will fail if any instances of DEP0XXX remain:

node/Makefile

Lines 937 to 940 in 70c2444

 @if [ "$(DISTTYPE)"="release" ] &&\
`grep -q DEP...X doc/api/deprecations.md`;then\
echo'Please update DEP...X in doc/api/deprecations.md (See doc/releases.md)';\
exit 1 ;\

BridgeAR · 2019-10-03T02:03:25Z

@richardlau it is documented that it should happen while landing but that's at the very end of the paragraph.

This assignment should occur when the PR is landed, but a check will be made when the release build is run.

So it's mainly a safeguard for the release team.

richardlau · 2019-10-03T02:09:18Z

@richardlau it is documented that it should happen while landing but that's at the very end of the paragraph.
This assignment should occur when the PR is landed, but a check will be made when the release build is run.
So it's mainly a safeguard for the release team.

🤦‍♂ You're right, I didn't read far enough. It's late.

This change also supports --pending-deprecation for the new deprecation. PR-URL: #29781 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

Notable changes: * build: * Add `--force-context-aware` flag to prevent usage of native node addons that aren't context aware #29631 * deprecations: * Add documentation-only deprecation for `process._tickCallback()` #29781 * esm: * Using JSON modules is experimental again #29754 * fs: * Introduce `opendir()` and `fs.Dir` to iterate through directories #29349 * process: * Add source-map support to stack traces by using `--source-map-support` #29564 * tls: * Honor `pauseOnConnect` option #29635 * Add option for private keys for OpenSSL engines #28973 PR-URL: #29919

doc: Add Documentation Deprecation for process._tickCallback
2b668e7

nodejs-github-bot added deprecations Issues and PRs related to deprecations. doc Issues and PRs related to the documentations. labels Sep 30, 2019

lholmquist mentioned this pull request Sep 30, 2019
process: deprecate process._tickCallback #29671
Closed
4 tasks

squash: add pr-url
c788308

jasnell approved these changes Sep 30, 2019
View reviewed changes

Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 1, 2019

squash: fix linting issue
f868b9c

Trott added the notable-change PRs with changes that should be highlighted in changelogs. label Oct 1, 2019

benjamingr approved these changes Oct 1, 2019
View reviewed changes

squash: add a supports --pending-deprecation
6dad852

addaleax approved these changes Oct 1, 2019
View reviewed changes

BridgeAR approved these changes Oct 1, 2019
View reviewed changes

Trott added the semver-minor PRs that contain new features and should be released in the next minor version. label Oct 2, 2019

Trott closed this Oct 2, 2019

richardlau mentioned this pull request Oct 3, 2019
doc: add missing deprecation code #29820
Closed
3 tasks

BridgeAR mentioned this pull request Oct 10, 2019
v12.12.0 proposal #29919
Merged

mscdex mentioned this pull request Jun 7, 2020
doc: wrong info for http deprecation #33779
Closed

Uh oh!

Uh oh!

Conversation

lholmquist commented Sep 30, 2019

Checklist

Uh oh!

jasnell commented Sep 30, 2019

Uh oh!

Trott commented Sep 30, 2019

Uh oh!

Trott commented Oct 1, 2019

Uh oh!

lholmquist commented Oct 1, 2019

Uh oh!

jasnell commented Oct 1, 2019

Uh oh!

benjamingr left a comment

Choose a reason for hiding this comment

Uh oh!

Trott commented Oct 1, 2019• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lholmquist commented Oct 1, 2019

Uh oh!

addaleax commented Oct 1, 2019

Uh oh!

lholmquist commented Oct 1, 2019

Uh oh!

lholmquist commented Oct 1, 2019

Uh oh!

nodejs-github-bot commented Oct 1, 2019

Uh oh!

Trott commented Oct 2, 2019

Uh oh!

Trott commented Oct 2, 2019

Uh oh!

vsemozhetbyt commented Oct 3, 2019

Uh oh!

richardlau commented Oct 3, 2019

Uh oh!

BridgeAR commented Oct 3, 2019

Uh oh!

richardlau commented Oct 3, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Trott commented Oct 1, 2019•
edited
Loading