timers: runtime-deprecate {un}enroll() #18066

Fishrock123 · 2018-01-09T18:31:05Z

This was never a Very Good API, and generally just left so many open ends for inconsistent behavior. The "optimization" benefit of this API is little to none. Makes a starting step towards removing it so that in the future, timers, especially in their async_hooks interactions, can be simplified.

For posterity: enroll() & unenroll() have been exposed since 0.1.very-early, predating setTimeout() & clearTimeout() in Node. They have never been documented.

@nodejs/tsc

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

Affected core subsystem(s)

timers

ChALkeR

LGTM.

Those seem to have been used in net.js and/or _http_outgoing.js until #17704 and got to some number of npm modules from there (where whole lib files were copied), but that doesn't seem to be significant.

Trott · 2018-01-12T04:49:42Z

doc/api/deprecations.md

+
+Type: Runtime
+
+`timers.enroll()` has been deprecated in favor of using the publicly documented timers APIs, namely [`setTimeout()`][] and [`setInterval()`][].


Nit: Can we make this more concise? Maybe this?:

timers.enroll() is deprecated. Please use [setTimeout()][] or [setInterval()][] instead.

(Similarly for the other deprecation message below.)

mcollina

LGTM

evanlucas · 2018-01-12T14:35:55Z

lib/timers.js

+}
+
+exports.unenroll = function(item) {
+  process.emitWarning('timers.unenroll is deprecated. ' +


Will this not emit the warning every time it is called vs just the first time? Any reason to not use util.deprecate() for this?

good catch.

Also, message should probably include () after the function name: timers.unenroll() is deprecated.

maclover7 · 2018-01-20T23:25:39Z

ping @Fishrock123

Fishrock123 · 2018-01-26T16:59:30Z

Updated, new CI: https://ci.nodejs.org/job/node-test-pull-request/12753/

Fishrock123 · 2018-01-26T17:38:19Z

what...

how do I run the markdown linter? :|

Fishrock123 · 2018-01-26T17:45:01Z

Ok, hope I fixed that. New CI: https://ci.nodejs.org/job/node-test-pull-request/12756/

mcollina · 2018-01-29T03:56:55Z

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

This was never a Very Good API, and generally just left so many open ends for inconsistent behavior. The "optimization" benefit of this API is little to none. Makes a starting step towards removing it so that in the future timers, especially in their async_hooks interactions, can be simplified. PR-URL: nodejs#18066 Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

Fishrock123 · 2018-02-02T19:07:57Z

Thanks, landed in 68783ae

This was never a Very Good API, and generally just left so many open ends for inconsistent behavior. The "optimization" benefit of this API is little to none. Makes a starting step towards removing it so that in the future timers, especially in their async_hooks interactions, can be simplified. PR-URL: nodejs#18066 Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

Another nail in the coffin here, farewell ye ol C-style apis. These apis caused numerous other issues that required far too many safeguards. This gets us one step closer to not having to worry about those issues anymore. Refs: nodejs#18066 Refs: nodejs#20298 PR-URL: nodejs#26760

Another nail in the coffin here, farewell ye ol C-style apis. These apis caused numerous other issues that required far too many safeguards. This gets us one step closer to not having to worry about those issues anymore. Refs: nodejs#18066 Refs: nodejs#20298 PR-URL: nodejs#26760 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

Another nail in the coffin here, farewell ye ol C-style apis. These apis caused numerous other issues that required far too many safeguards. This gets us one step closer to not having to worry about those issues anymore. Refs: #18066 Refs: #20298 PR-URL: #26760 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

Fishrock123 added timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout. semver-major PRs that contain breaking changes and should be released in the next major version. labels Jan 9, 2018

nodejs-github-bot added the timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout. label Jan 9, 2018

TimothyGu approved these changes Jan 9, 2018

View reviewed changes

ChALkeR self-requested a review January 9, 2018 18:38

jasnell approved these changes Jan 9, 2018

View reviewed changes

cjihrig approved these changes Jan 9, 2018

View reviewed changes

lpinca approved these changes Jan 10, 2018

View reviewed changes

ChALkeR approved these changes Jan 12, 2018

View reviewed changes

jasnell requested a review from a team January 12, 2018 00:46

Trott reviewed Jan 12, 2018

View reviewed changes

mcollina approved these changes Jan 12, 2018

View reviewed changes

evanlucas reviewed Jan 12, 2018

View reviewed changes

maclover7 added the wip Issues and PRs that are still a work in progress. label Jan 20, 2018

Fishrock123 force-pushed the deprecate-{un}enroll branch from b36a973 to 6276c85 Compare January 26, 2018 16:58

Fishrock123 force-pushed the deprecate-{un}enroll branch from 6276c85 to 6feb500 Compare January 26, 2018 17:42

maclover7 force-pushed the master branch from bb5575a to 993b716 Compare January 26, 2018 22:02

cjihrig force-pushed the master branch from 993b716 to 082f952 Compare January 26, 2018 22:36

BridgeAR approved these changes Feb 2, 2018

View reviewed changes

BridgeAR added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed wip Issues and PRs that are still a work in progress. labels Feb 2, 2018

Fishrock123 force-pushed the deprecate-{un}enroll branch from 6feb500 to 0c67ccd Compare February 2, 2018 19:04

Fishrock123 force-pushed the deprecate-{un}enroll branch from 0c67ccd to 68783ae Compare February 2, 2018 19:05

Fishrock123 merged commit 68783ae into nodejs:master Feb 2, 2018

Fishrock123 deleted the deprecate-{un}enroll branch February 2, 2018 19:08

Fishrock123 added doc Issues and PRs related to the documentations. and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Feb 2, 2018

tniessen added the deprecations Issues and PRs related to deprecations. label Sep 7, 2018

Fishrock123 mentioned this pull request Mar 18, 2019

timers: deprecate active() and _unrefActive() #26760

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

timers: runtime-deprecate {un}enroll() #18066

timers: runtime-deprecate {un}enroll() #18066

Fishrock123 commented Jan 9, 2018

ChALkeR left a comment •

edited

Loading

Trott Jan 12, 2018

mcollina left a comment

evanlucas Jan 12, 2018

lpinca Jan 12, 2018

Trott Jan 13, 2018

maclover7 commented Jan 20, 2018

Fishrock123 commented Jan 26, 2018

Fishrock123 commented Jan 26, 2018

Fishrock123 commented Jan 26, 2018

mcollina commented Jan 29, 2018

Fishrock123 commented Feb 2, 2018


		Type: Runtime

		`timers.enroll()` has been deprecated in favor of using the publicly documented timers APIs, namely [`setTimeout()`][] and [`setInterval()`][].

timers: runtime-deprecate {un}enroll() #18066

timers: runtime-deprecate {un}enroll() #18066

Conversation

Fishrock123 commented Jan 9, 2018

Checklist

Affected core subsystem(s)

ChALkeR left a comment • edited Loading

Choose a reason for hiding this comment

Trott Jan 12, 2018

Choose a reason for hiding this comment

mcollina left a comment

Choose a reason for hiding this comment

evanlucas Jan 12, 2018

Choose a reason for hiding this comment

lpinca Jan 12, 2018

Choose a reason for hiding this comment

Trott Jan 13, 2018

Choose a reason for hiding this comment

maclover7 commented Jan 20, 2018

Fishrock123 commented Jan 26, 2018

Fishrock123 commented Jan 26, 2018

Fishrock123 commented Jan 26, 2018

mcollina commented Jan 29, 2018

Fishrock123 commented Feb 2, 2018

ChALkeR left a comment •

edited

Loading