Skip to content

Commit

Permalink
child_process: runtime deprecate _channel
Browse files Browse the repository at this point in the history
This commit moves DEP0129 to a runtime deprecation.

PR-URL: #27949
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
cjihrig committed May 31, 2019

Verified

This commit was signed with the committer’s verified signature.
cjihrig Colin Ihrig
1 parent 80d9b1c commit d05668d
Showing 2 changed files with 16 additions and 6 deletions.
5 changes: 4 additions & 1 deletion doc/api/deprecations.md
Original file line number Diff line number Diff line change
@@ -2436,12 +2436,15 @@ Node.js versions.
### DEP0129: ChildProcess._channel
<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/27949
description: Runtime deprecation.
- version: v11.14.0
pr-url: https://github.com/nodejs/node/pull/26982
description: Documentation-only.
-->
Type: Documentation-only
Type: Runtime
The `_channel` property of child process objects returned by `spawn()` and
similar functions is not intended for public use. Use `ChildProcess.channel`
17 changes: 12 additions & 5 deletions lib/internal/child_process.js
Original file line number Diff line number Diff line change
@@ -37,7 +37,7 @@ const { TTY } = internalBinding('tty_wrap');
const { UDP } = internalBinding('udp_wrap');
const SocketList = require('internal/socket_list');
const { owner_symbol } = require('internal/async_hooks').symbols;
const { convertToValidSignal } = require('internal/util');
const { convertToValidSignal, deprecate } = require('internal/util');
const { isArrayBufferView } = require('internal/util/types');
const spawn_sync = internalBinding('spawn_sync');
const { kStateSymbol } = require('internal/dgram');
@@ -513,14 +513,21 @@ class Control extends EventEmitter {
}
}

const channelDeprecationMsg = '_channel is deprecated. ' +
'Use ChildProcess.channel instead.';

function setupChannel(target, channel) {
target.channel = channel;

// _channel can be deprecated in version 8
Object.defineProperty(target, '_channel', {
get() { return target.channel; },
set(val) { target.channel = val; },
enumerable: true
get: deprecate(() => {
return target.channel;
}, channelDeprecationMsg, 'DEP0129'),
set: deprecate((val) => {
target.channel = val;
}, channelDeprecationMsg, 'DEP0129'),
configurable: true,
enumerable: false
});

target._handleQueue = null;

0 comments on commit d05668d

Please sign in to comment.