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.

Sign up for GitHub

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

net,child_process: improve naming in internal code #14449

Closed
wants to merge 2 commits into from
Closed

net,child_process: improve naming in internal code #14449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1dba98f
net,child_process: improve naming in internal code
addaleax Jul 24, 2017
e15e0bc
[squash] add runtime-deprecated aliases
addaleax Jul 24, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,6 +634,17 @@ Type: Runtime

*Note*: change was made while `async_hooks` was an experimental API.

<a id="DEP00XX"></a>
Copy link
Contributor

Choose a reason for hiding this comment

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

As far as I see from Git history, deprecations are usually assigned a number immediately in the pull request.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don’t care much but I think @jasnell has been telling people multiple times to assign the number while landing :)

Copy link
Member

Choose a reason for hiding this comment

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

yeah, it's better to assign when landing... or likely better yet to handle it like the REPLACEME metadata eventually. The reason is because if we end up with more than one deprecation PR at any given time, there's a greater chance of accidentally duplicating the codes or getting them out of order somehow.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, thanks for clarifying :)

### DEP00XX: Several internal properties of net.Server

Type: Runtime

Accessing several internal, undocumented properties of `net.Server` instances
with inappropriate names has been deprecated.

*Note*: As the original API was undocumented and not generally useful for
non-internal code, no replacement API is provided.

[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size
[`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array
[`Buffer.from(buffer)`]: buffer.html#buffer_class_method_buffer_from_buffer
Expand Down
13 changes: 6 additions & 7 deletions lib/internal/child_process.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,16 @@ const handleConversion = {

// if the socket was created by net.Server
if (socket.server) {
// the slave should keep track of the socket
// the worker should keep track of the socket
message.key = socket.server._connectionKey;

var firstTime = !this.channel.sockets.send[message.key];
var socketList = getSocketList('send', this, message.key);

// the server should no longer expose a .connection property
// and when asked to close it should query the socket status from
// the slaves
if (firstTime) socket.server._setupSlave(socketList);
// the workers
if (firstTime) socket.server._setupWorker(socketList);

// Act like socket is detached
if (!options.keepOpen)
Expand Down Expand Up @@ -911,12 +911,12 @@ function _validateStdio(stdio, sync) {
}


function getSocketList(type, slave, key) {
var sockets = slave.channel.sockets[type];
function getSocketList(type, worker, key) {
var sockets = worker.channel.sockets[type];
var socketList = sockets[key];
if (!socketList) {
var Construct = type === 'send' ? SocketListSend : SocketListReceive;
socketList = sockets[key] = new Construct(slave, key);
socketList = sockets[key] = new Construct(worker, key);
}
return socketList;
}
Expand Down Expand Up @@ -958,6 +958,5 @@ module.exports = {
ChildProcess,
setupChannel,
_validateStdio,
getSocketList,
spawnSync
};
64 changes: 46 additions & 18 deletions lib/net.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1187,7 +1187,7 @@ function Server(options, connectionListener) {
Object.defineProperty(this, 'connections', {
get: internalUtil.deprecate(() => {

if (this._usingSlaves) {
if (this._usingWorkers) {
return null;
}
return this._connections;
Expand All @@ -1201,8 +1201,8 @@ function Server(options, connectionListener) {

this[async_id_symbol] = -1;
this._handle = null;
this._usingSlaves = false;
this._slaves = [];
this._usingWorkers = false;
this._workers = [];
this._unref = false;

this.allowHalfOpen = options.allowHalfOpen || false;
Expand Down Expand Up @@ -1555,13 +1555,13 @@ Server.prototype.getConnections = function(cb) {
nextTick(asyncId, cb, err, connections);
}

if (!this._usingSlaves) {
if (!this._usingWorkers) {
end(null, this._connections);
return this;
}

// Poll slaves
var left = this._slaves.length;
// Poll workers
var left = this._workers.length;
var total = this._connections;

function oncount(err, count) {
Expand All @@ -1574,8 +1574,8 @@ Server.prototype.getConnections = function(cb) {
if (--left === 0) return end(null, total);
}

for (var n = 0; n < this._slaves.length; n++) {
this._slaves[n].getConnections(oncount);
for (var n = 0; n < this._workers.length; n++) {
this._workers[n].getConnections(oncount);
}

return this;
Expand All @@ -1598,22 +1598,22 @@ Server.prototype.close = function(cb) {
this._handle = null;
}

if (this._usingSlaves) {
var left = this._slaves.length;
const onSlaveClose = () => {
if (this._usingWorkers) {
var left = this._workers.length;
const onWorkerClose = () => {
if (--left !== 0) return;

this._connections = 0;
this._emitCloseIfDrained();
};

// Increment connections to be sure that, even if all sockets will be closed
// during polling of slaves, `close` event will be emitted only once.
// during polling of workers, `close` event will be emitted only once.
this._connections++;

// Poll slaves
for (var n = 0; n < this._slaves.length; n++)
this._slaves[n].close(onSlaveClose);
// Poll workers
for (var n = 0; n < this._workers.length; n++)
this._workers[n].close(onWorkerClose);
} else {
this._emitCloseIfDrained();
}
Expand Down Expand Up @@ -1646,9 +1646,9 @@ Server.prototype.listenFD = internalUtil.deprecate(function(fd, type) {
}, 'Server.listenFD is deprecated. Use Server.listen({fd: <number>}) instead.',
'DEP0021');

Server.prototype._setupSlave = function(socketList) {
this._usingSlaves = true;
this._slaves.push(socketList);
Server.prototype._setupWorker = function(socketList) {
this._usingWorkers = true;
this._workers.push(socketList);
};

Server.prototype.ref = function() {
Expand Down Expand Up @@ -1693,6 +1693,34 @@ if (process.platform === 'win32') {
_setSimultaneousAccepts = function(handle) {};
}

// TODO(addaleax): Remove these after the Node 9.x branch cut.
Object.defineProperty(Server.prototype, '_usingSlaves', {
get: internalUtil.deprecate(function() {
return this._usingWorkers;
}, 'Accessing internal properties of net.Server is deprecated.', 'DEP00XX'),
set: internalUtil.deprecate((val) => {
this._usingWorkers = val;
}, 'Accessing internal properties of net.Server is deprecated.', 'DEP00XX'),
configurable: true, enumerable: false
});

Object.defineProperty(Server.prototype, '_slaves', {
get: internalUtil.deprecate(function() {
return this._workers;
}, 'Accessing internal properties of net.Server is deprecated.', 'DEP00XX'),
set: internalUtil.deprecate((val) => {
this._workers = val;
}, 'Accessing internal properties of net.Server is deprecated.', 'DEP00XX'),
configurable: true, enumerable: false
});

Object.defineProperty(Server.prototype, '_setupSlave', {
value: internalUtil.deprecate(function(socketList) {
return this._setupWorker(socketList);
}, 'Accessing internal properties of net.Server is deprecated.', 'DEP00XX'),
configurable: true, enumerable: false
});

module.exports = {
_createServerHandle: createServerHandle,
_normalizeArgs: normalizeArgs,
Expand Down