net: handle normalized args in normalizeArgs() #13069

cjihrig · 2017-05-16T23:44:40Z

This commit allows normalizeArgs() to be called with its own previous output. Prior to this change, multiple calls to normalizeArgs() would create a nested structure that produced invalid arguments.

cc: @vdeturckheim @joyeecheung @mcollina @jasnell (from othiym23/async-listener#110)

Checklist

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

Affected core subsystem(s)

net

mscdex · 2017-05-16T23:56:40Z

lib/net.js

@@ -125,6 +125,10 @@ function normalizeArgs(args) {
  const arg0 = args[0];
  var options = {};
  if (typeof arg0 === 'object' && arg0 !== null) {
+    // Handle the case where the arguments were already normalized.
+    if (Array.isArray(arg0))


Using instanceof Array should be faster.

Actually, in my experiences Array.isArray is faster because of the difficult-to-optimize nature of the instanceof operator under ES2015+…

Do you have a benchmark that shows this on master?

I'm curious, wouldn't Array.isArray always be a safer choice? Or because we know how arg0 is created in this specific case we can safely use instanceof Array?

refack · 2017-05-17T01:21:42Z

Just an idea, put a symbol on it, to distinguish from arbitrary Arrays

joyeecheung · 2017-05-17T02:33:11Z

lib/net.js

@@ -125,6 +125,10 @@ function normalizeArgs(args) {
  const arg0 = args[0];
  var options = {};
  if (typeof arg0 === 'object' && arg0 !== null) {


If this is doing the same thing as the if (arguments.length === 1 && Array.isArray(arguments[0])) block in Socket.prototype.connect, maybe remove the similar logic there?

@joyeecheung it is related, but not the same thing.

vdeturckheim · 2017-05-17T13:38:51Z

LGTM!

cjihrig · 2017-05-17T13:40:42Z

Just an idea, put a symbol on it, to distinguish from arbitrary Arrays

I'm open to it if others are.

mcollina

LGTM

cjihrig · 2017-05-18T16:26:54Z

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

watson · 2017-05-18T16:31:18Z

Out of curiosity, when is normalizeArgs() called recursively?

cjihrig · 2017-05-18T16:38:58Z

@watson for example in othiym23/async-listener#110. normalizeArgs() returns an array of length 2. Node's check in Socket.prototype.connect() explicitly checks for a length of 1. This could be fixed in a few ways (add more logic in async-listener, remove the length of 1 check). I think allowing normalizeArgs() to consume its own output is the most flexible solution.

cjihrig · 2017-05-18T16:47:05Z

Actually, the more I think about it, the more I like the idea of just dropping the arguments.length === 1 check in Socket.prototype.connect().

watson · 2017-05-18T16:47:48Z

@cjihrig you mean the code I added? Weird, I thought we tested async-listener against that patch since that was the whole reason for the patch 😅

watson · 2017-05-18T16:49:37Z

@cjihrig it was kind of an ugly hack. And allowing normalizeArgs to be called recursively would fix part of that. But we'll then still have to run these 3 lines twice: https://github.com/cjihrig/node-1/blob/27ae95a21958b3c7d91c688da6093e96fc167e5c/lib/net.js#L957-L959

cjihrig · 2017-05-18T16:51:44Z

I do indeed mean that code :-D

We tested it, but @vdeturckheim came to me with this script, which was still failing.

And allowing normalizeArgs to be called recursively would fix part of that. But we'll then still have to run these 3 lines twice

Yea, removing the arguments.length === 1 check should fix the problem. @refack's suggestion of attaching a symbol might be helpful as well, since we don't want to support arbitrary arrays.

watson · 2017-05-18T16:55:43Z

Ah, ok got it now thanks for the explanation 😄

Yeah, the symbol trick might be ok

cjihrig · 2017-05-18T18:31:18Z

New commit (3564d322fd891dccc97e80c90f522412bad54da5) has the symbol approach.

mscdex · 2017-05-18T18:42:37Z

lib/internal/net.js

@@ -10,5 +10,6 @@ function isLegalPort(port) {
 }

 module.exports = {
-  isLegalPort
+  isLegalPort,
+  kNormalizedConnectSymbol: Symbol('normalizedConnect')


It's also used by listen(). Perhaps we should just call it normalizedArgsSymbol with a 'normalizedArgs' symbol value? Keeping it generic may also help if we ever need/want it for other normalization functions, like the ones in child_process or something.

cjihrig · 2017-05-18T21:39:42Z

@mscdex renamed the symbol as you suggested.

watson · 2017-05-18T21:48:32Z

LGTM 👍

cjihrig · 2017-05-19T14:25:19Z

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

EDIT: Some platforms fail with EADDRNOTAVAIL. Others fail with ECONNREFUSED. Updated the test to handle both. CI: https://ci.nodejs.org/job/node-test-pull-request/8174/

This commit attaches a Symbol to the result of net._normalizeArgs(). This prevents normal arrays from being passed to the internal Socket.prototype.connect() bypass logic. PR-URL: nodejs#13069 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

vdeturckheim · 2017-05-19T15:30:38Z

Awesome! Thank you @cjihrig !!

This commit attaches a Symbol to the result of net._normalizeArgs(). This prevents normal arrays from being passed to the internal Socket.prototype.connect() bypass logic. PR-URL: nodejs#13069 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

MylesBorins · 2017-07-17T14:49:18Z

Should this land on v6.x?

If so it will need a manual backport

mcollina · 2017-07-17T15:51:00Z

I'm 👎 to backport. This would need a lot of other changes.

nodejs-github-bot added the net Issues and PRs related to the net subsystem. label May 16, 2017

mscdex reviewed May 16, 2017

View reviewed changes

joyeecheung reviewed May 17, 2017

View reviewed changes

vdeturckheim mentioned this pull request May 17, 2017

update argument management in net.Socket.prototype.connect to handle node 8 othiym23/async-listener#110

Closed

mcollina approved these changes May 17, 2017

View reviewed changes

vdeturckheim approved these changes May 17, 2017

View reviewed changes

cjihrig force-pushed the normalize branch from 27ae95a to 3564d32 Compare May 18, 2017 18:30

mscdex reviewed May 18, 2017

View reviewed changes

cjihrig force-pushed the normalize branch from 3564d32 to 793cb47 Compare May 18, 2017 21:39

refack approved these changes May 18, 2017

View reviewed changes

mcollina approved these changes May 19, 2017

View reviewed changes

joyeecheung approved these changes May 19, 2017

View reviewed changes

cjihrig force-pushed the normalize branch from 793cb47 to 2da5eec Compare May 19, 2017 14:24

cjihrig force-pushed the normalize branch from 2da5eec to 4dd7f54 Compare May 19, 2017 14:40

cjihrig force-pushed the normalize branch from 4dd7f54 to 51664fc Compare May 19, 2017 15:24

cjihrig merged commit 51664fc into nodejs:master May 19, 2017

cjihrig deleted the normalize branch May 19, 2017 15:25

jasnell mentioned this pull request May 28, 2017

8.0.0 Release Proposal #12220

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

MylesBorins added the lts-watch-v6.x label Jul 17, 2017

mcollina added dont-land-on-v4.x and removed lts-watch-v6.x labels Jul 17, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

net: handle normalized args in normalizeArgs() #13069

net: handle normalized args in normalizeArgs() #13069

cjihrig commented May 16, 2017

mscdex May 16, 2017

TimothyGu May 17, 2017

mscdex May 17, 2017

watson May 17, 2017

refack commented May 17, 2017

joyeecheung May 17, 2017

cjihrig May 17, 2017

vdeturckheim commented May 17, 2017

cjihrig commented May 17, 2017

mcollina left a comment

cjihrig commented May 18, 2017

watson commented May 18, 2017

cjihrig commented May 18, 2017

cjihrig commented May 18, 2017

watson commented May 18, 2017

watson commented May 18, 2017

cjihrig commented May 18, 2017

watson commented May 18, 2017

cjihrig commented May 18, 2017

mscdex May 18, 2017

cjihrig commented May 18, 2017

watson commented May 18, 2017 •

edited

Loading

cjihrig commented May 19, 2017 •

edited

Loading

vdeturckheim commented May 19, 2017

MylesBorins commented Jul 17, 2017 •

edited

Loading

mcollina commented Jul 17, 2017

net: handle normalized args in normalizeArgs() #13069

net: handle normalized args in normalizeArgs() #13069

Conversation

cjihrig commented May 16, 2017

Checklist

Affected core subsystem(s)

mscdex May 16, 2017

Choose a reason for hiding this comment

TimothyGu May 17, 2017

Choose a reason for hiding this comment

mscdex May 17, 2017

Choose a reason for hiding this comment

watson May 17, 2017

Choose a reason for hiding this comment

refack commented May 17, 2017

joyeecheung May 17, 2017

Choose a reason for hiding this comment

cjihrig May 17, 2017

Choose a reason for hiding this comment

vdeturckheim commented May 17, 2017

cjihrig commented May 17, 2017

mcollina left a comment

Choose a reason for hiding this comment

cjihrig commented May 18, 2017

watson commented May 18, 2017

cjihrig commented May 18, 2017

cjihrig commented May 18, 2017

watson commented May 18, 2017

watson commented May 18, 2017

cjihrig commented May 18, 2017

watson commented May 18, 2017

cjihrig commented May 18, 2017

mscdex May 18, 2017

Choose a reason for hiding this comment

cjihrig commented May 18, 2017

watson commented May 18, 2017 • edited Loading

cjihrig commented May 19, 2017 • edited Loading

vdeturckheim commented May 19, 2017

MylesBorins commented Jul 17, 2017 • edited Loading

mcollina commented Jul 17, 2017

watson commented May 18, 2017 •

edited

Loading

cjihrig commented May 19, 2017 •

edited

Loading

MylesBorins commented Jul 17, 2017 •

edited

Loading