Skip to content

Commit 1233e92

Browse files
Renegade334richardlau
authored andcommitted
diagnostics_channel: revoke DEP0163
PR-URL: #59758 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>
1 parent 847963b commit 1233e92

File tree

2 files changed

+25
-20
lines changed

2 files changed

+25
-20
lines changed

doc/api/deprecations.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3272,21 +3272,22 @@ Convert them to primitive strings.
32723272

32733273
<!-- YAML
32743274
changes:
3275+
- version: REPLACEME
3276+
pr-url: https://github.com/nodejs/node/pull/59758
3277+
description: Deprecation revoked.
32753278
- version:
32763279
- v18.7.0
32773280
- v16.17.0
32783281
pr-url: https://github.com/nodejs/node/pull/42714
32793282
description: Documentation-only deprecation.
32803283
-->
32813284

3282-
Type: Documentation-only
3283-
3284-
These methods were deprecated because they can be used in a way which does not
3285-
hold the channel reference alive long enough to receive the events.
3285+
Type: Deprecation revoked
32863286

3287-
Use [`diagnostics_channel.subscribe(name, onMessage)`][] or
3288-
[`diagnostics_channel.unsubscribe(name, onMessage)`][] which does the same
3289-
thing instead.
3287+
These methods were deprecated because their use could leave the channel object
3288+
vulnerable to being garbage-collected if not strongly referenced by the user.
3289+
The deprecation was revoked because channel objects are now resistant to
3290+
garbage collection when the channel has active subscribers.
32903291

32913292
### DEP0164: `process.exit(code)`, `process.exitCode` coercion to integer
32923293

@@ -3930,8 +3931,6 @@ an internal nodejs implementation rather than a public facing API, use `node:htt
39303931
[`crypto.setEngine()`]: crypto.md#cryptosetengineengine-flags
39313932
[`decipher.final()`]: crypto.md#decipherfinaloutputencoding
39323933
[`decipher.setAuthTag()`]: crypto.md#deciphersetauthtagbuffer-encoding
3933-
[`diagnostics_channel.subscribe(name, onMessage)`]: diagnostics_channel.md#diagnostics_channelsubscribename-onmessage
3934-
[`diagnostics_channel.unsubscribe(name, onMessage)`]: diagnostics_channel.md#diagnostics_channelunsubscribename-onmessage
39353934
[`dirent.parentPath`]: fs.md#direntparentpath
39363935
[`dirent.path`]: fs.md#direntpath
39373936
[`dns.lookup()`]: dns.md#dnslookuphostname-options-callback

doc/api/diagnostics_channel.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -373,13 +373,17 @@ channel.publish({
373373
added:
374374
- v15.1.0
375375
- v14.17.0
376-
deprecated:
377-
- v18.7.0
378-
- v16.17.0
376+
changes:
377+
- version: REPLACEME
378+
pr-url: https://github.com/nodejs/node/pull/59758
379+
description: Deprecation revoked.
380+
- version:
381+
- v18.7.0
382+
- v16.17.0
383+
pr-url: https://github.com/nodejs/node/pull/44943
384+
description: Documentation-only deprecation.
379385
-->
380386

381-
> Stability: 0 - Deprecated: Use [`diagnostics_channel.subscribe(name, onMessage)`][]
382-
383387
* `onMessage` {Function} The handler to receive channel messages
384388
* `message` {any} The message data
385389
* `name` {string|symbol} The name of the channel
@@ -414,10 +418,15 @@ channel.subscribe((message, name) => {
414418
added:
415419
- v15.1.0
416420
- v14.17.0
417-
deprecated:
418-
- v18.7.0
419-
- v16.17.0
420421
changes:
422+
- version: REPLACEME
423+
pr-url: https://github.com/nodejs/node/pull/59758
424+
description: Deprecation revoked.
425+
- version:
426+
- v18.7.0
427+
- v16.17.0
428+
pr-url: https://github.com/nodejs/node/pull/44943
429+
description: Documentation-only deprecation.
421430
- version:
422431
- v17.1.0
423432
- v16.14.0
@@ -426,8 +435,6 @@ changes:
426435
description: Added return value. Added to channels without subscribers.
427436
-->
428437

429-
> Stability: 0 - Deprecated: Use [`diagnostics_channel.unsubscribe(name, onMessage)`][]
430-
431438
* `onMessage` {Function} The previous subscribed handler to remove
432439
* Returns: {boolean} `true` if the handler was found, `false` otherwise.
433440

@@ -1422,7 +1429,6 @@ Emitted when a new thread is created.
14221429
[`diagnostics_channel.channel(name)`]: #diagnostics_channelchannelname
14231430
[`diagnostics_channel.subscribe(name, onMessage)`]: #diagnostics_channelsubscribename-onmessage
14241431
[`diagnostics_channel.tracingChannel()`]: #diagnostics_channeltracingchannelnameorchannels
1425-
[`diagnostics_channel.unsubscribe(name, onMessage)`]: #diagnostics_channelunsubscribename-onmessage
14261432
[`end` event]: #endevent
14271433
[`error` event]: #errorevent
14281434
[`net.Server.listen()`]: net.md#serverlisten

0 commit comments

Comments
 (0)