doc, test: add note to response.getHeaders #12887

refack · 2017-05-07T18:51:52Z

also correct language for the same note for querystring.parse
add assertions for said note

Fixes: #12885
Ref: #12883

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)

test,doc

refack · 2017-05-07T18:54:41Z

CI: https://ci.nodejs.org/job/node-test-commit/9722/

addaleax · 2017-05-07T18:53:15Z

doc/api/querystring.md

-prototypically extend from the JavaScript `Object`. This means that the
-typical `Object` methods such as `obj.toString()`, `obj.hasOwnProperty()`,
-and others are not defined and *will not work*.
+prototypically extend the JavaScript `Object`. This means that typical`Object`


typo: space after typical

addaleax · 2017-05-07T18:55:12Z

doc/api/querystring.md

-and others are not defined and *will not work*.
+prototypically extend the JavaScript `Object`. This means that typical`Object`
+methods such as `obj.toString()`, `obj.hasOwnProperty()`, and others are not
+defined and *will not work*. As well `obj instanceof Object === false`.


Can you try to use complete sentences in the documentation? Also, this isn’t that simple anyway. Other Contexts can have different Object objects anyway – the better advice is to avoid instanceof for builtins in JS code (i.e. please drop the last sentence here).

Reasonable 👍

addaleax · 2017-05-07T18:55:47Z

doc/api/http.md

@@ -974,7 +974,11 @@ const headerNames = response.getHeaderNames();
 added: v7.7.0
 -->

-* Returns: {Object}
+* Returns: {Object}  
+  *Note*: The object returned by the `response.getHeaders()` method _does not_


Can you put this note at the end of the documentation section?

Only difference is that there there is no explicit * Returns: {Object}

TimothyGu · 2017-05-07T18:52:50Z

doc/api/http.md

@@ -1,4 +1,4 @@
-# HTTP
+# HTTP


What's going on with this hunk?

I don't know, reverting

There's a weird space at line 559 that made my editor decide it's a UTF-8 file, and added the BOM.

You mean UTF-16?

UTF-8 can have a BOM too

TimothyGu · 2017-05-07T18:53:27Z

doc/api/http.md

@@ -974,7 +974,11 @@ const headerNames = response.getHeaderNames();
 added: v7.7.0
 -->

-* Returns: {Object}
+* Returns: {Object}  
+  *Note*: The object returned by the `response.getHeaders()` method _does not_


Can you put the note in the prose like querystring.parse()?

TimothyGu · 2017-05-07T18:53:47Z

doc/api/http.md

-* Returns: {Object}
+* Returns: {Object}  
+  *Note*: The object returned by the `response.getHeaders()` method _does not_
+  prototypically extend the JavaScript `Object`. This means that typical`Object`


Missing space between "typical" and "Object"

TimothyGu · 2017-05-07T18:54:27Z

doc/api/http.md

+  *Note*: The object returned by the `response.getHeaders()` method _does not_
+  prototypically extend the JavaScript `Object`. This means that typical`Object`
+  methods such as `obj.toString()`, `obj.hasOwnProperty()`, and others are not
+  defined and *will not work*. As well `obj instanceof Object === false`.


Either make the last bit a complete sentence, or fold it into the previous sentence.

TimothyGu · 2017-05-07T18:54:49Z

test/parallel/test-http-mutable-headers.js

      // eslint-disable-next-line no-restricted-properties
-      assert.deepEqual(res.getHeaders(), {});
+      assert.deepEqual(headers, {});


deepStrictEqual while at it?

Need to remove prototype from {}, but why not...

refack · 2017-05-07T19:16:43Z

Addressed. PTAL.

refack · 2017-05-07T19:17:48Z

New CI: https://ci.nodejs.org/job/node-test-commit/9723/

addaleax · 2017-05-07T19:18:24Z

doc/api/http.md

@@ -982,6 +982,11 @@ header-related http module methods. The keys of the returned object are the
 header names and the values are the respective header values. All header names
 are lowercase.

+*Note*: The object returned by the `response.getHeaders()` method _does not_
+prototypically extend the JavaScript `Object`. This means that typical`Object`


still a missing space after “typical”

TimothyGu · 2017-05-07T19:18:23Z

doc/api/http.md

@@ -982,6 +982,11 @@ header-related http module methods. The keys of the returned object are the
 header names and the values are the respective header values. All header names
 are lowercase.

+*Note*: The object returned by the `response.getHeaders()` method _does not_
+prototypically extend the JavaScript `Object`. This means that typical`Object`


Still missing a space.

TimothyGu · 2017-05-07T19:18:56Z

test/parallel/test-http-mutable-headers.js

-      assert.deepEqual(res.getHeaders(), {});
+      const headers = res.getHeaders();
+      const objLike = Object.create(Object.getPrototypeOf(headers));
+      assert.deepStrictEqual(headers, objLike);


Why not just compare it to Object.create(null)?

Fails on 7.10 🤷‍♂️

Changed.
(Well the test fails anyway in other places on 7.10)

addaleax

Looks good, but the old querystring.md wording sounded a bit clearer to me.

refack · 2017-05-07T19:35:29Z

/cc @nodejs/documentation comments about the wording?

mscdex · 2017-05-07T20:47:09Z

doc/api/http.md

@@ -982,6 +982,11 @@ header-related http module methods. The keys of the returned object are the
 header names and the values are the respective header values. All header names
 are lowercase.

+*Note*: The object returned by the `response.getHeaders()` method _does not_
+prototypically extend the JavaScript `Object`. This means that typical `Object`


s/extend the/inherit from the/

thefourtheye · 2017-05-08T01:04:10Z

doc/api/http.md

@@ -556,7 +556,7 @@ Returns `request`.
 added: v0.1.17
 -->

-This class inherits from [`net.Server`][] and has the following additional events:
+This�class inherits from [`net.Server`][] and has the following additional events:


Just to be sure, the extra whitespace at the end of this line has been removed, right?

There's a Unicode white space there, that I converted to \u0020. I'll make sure that it's right

There was a \0x00A0 at position 5 I replaced with \u0020. I verified with a hex compare.

thefourtheye · 2017-05-08T01:06:12Z

test/parallel/test-http-mutable-headers.js

-      // eslint-disable-next-line no-restricted-properties
-      assert.deepEqual(res.getHeaders(), {});
+      const headers = res.getHeaders();
+      const objLike = Object.create(null);


Nit: This is an object, not object like :D

I had this discussion with @addaleax. How can it be an Object if objLike instaceof Object === false ?
According to OOP definitions "not" objLike is an Object. It's actually a null with properies 😉

I could call it sonOfNull...

I agree with @thefourtheye, it's still an object according to the spec.

refack · 2017-05-08T02:58:57Z

doc/api/http.md

@@ -556,7 +556,7 @@ Returns `request`.
 added: v0.1.17
 -->

-This class inherits from [`net.Server`][] and has the following additional events:
+This class inherits from [`net.Server`][] and has the following additional events:


replaced a \u00A0 with a \u0020, so now the document is ANSI and not UTF-8

@refack Just to be clear, our docs are UTF-8 and don’t need to be restricted to ASCII. This change is obviously fine, but it might be a good idea to tell your editor to not use BOMs for UTF-8.

mscdex · 2017-05-08T03:03:45Z

doc/api/querystring.md

-prototypically extend from the JavaScript `Object`. This means that the
-typical `Object` methods such as `obj.toString()`, `obj.hasOwnProperty()`,
-and others are not defined and *will not work*.
+prototypically extend the JavaScript `Object`. This means that typical `Object`


s/extend the/inherit from the/

thefourtheye · 2017-05-08T08:17:05Z

test/parallel/test-http-mutable-headers.js

-      // eslint-disable-next-line no-restricted-properties
-      assert.deepEqual(res.getHeaders(), {});
+      const headers = res.getHeaders();
+      const exoticObj = Object.create(null);


Nit: I am being extremely pedantic here. So please ignore this comment, if you don't agree. Quoting 9.1 Ordinary Object Internal Methods and Internal Slots,

All ordinary objects have an internal slot called [[Prototype]]. The value of this internal slot is either null or an object and is used for implementing inheritance.

This object doesn't do or posses anything exotic. So this is still a normal object I believe.

I agree with @thefourtheye. Probably better to call it something like simpleObj or bareObj or something similar without getting too wordy...

* also correct language for the same note for querystring.parse * add assertions for said note PR-URL: nodejs#12887 Fixes: nodejs#12885 Refs: nodejs#12883 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

refack · 2017-05-10T15:09:22Z

landed in e1cabf6

refack · 2017-05-10T15:43:57Z

Post land CI:https://ci.nodejs.org/job/node-test-commit/9785/

mscdex · 2017-05-10T15:56:07Z

@refack I think you left that CI comment on the wrong PR? That CI run is for this commit: "test: use assert regexp in tls no cert test"

refack · 2017-05-10T16:21:25Z

@refack I think you left that CI comment on the wrong PR? That CI run is for this commit: "test: use assert regexp in tls no cert test"

Since the CI is on master the one CI job covers three small lands I did almost together.

* also correct language for the same note for querystring.parse * add assertions for said note PR-URL: nodejs#12887 Fixes: nodejs#12885 Refs: nodejs#12883 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

gibfahn · 2017-06-20T23:07:00Z

Should this be backported to v6.x-staging? If yes please follow the guide and raise a backport PR, if no let me know or add the dont-land-on label.

refack requested a review from mscdex May 7, 2017 18:51

refack self-assigned this May 7, 2017

refack added doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem. test Issues and PRs related to the tests. labels May 7, 2017

addaleax requested changes May 7, 2017

View reviewed changes

TimothyGu reviewed May 7, 2017

View reviewed changes

refack force-pushed the fix-12885-change-doc branch from 178a714 to 1bc296e Compare May 7, 2017 19:16

addaleax reviewed May 7, 2017

View reviewed changes

TimothyGu reviewed May 7, 2017

View reviewed changes

refack force-pushed the fix-12885-change-doc branch 2 times, most recently from 1677823 to f13cde2 Compare May 7, 2017 19:25

TimothyGu approved these changes May 7, 2017

View reviewed changes

addaleax approved these changes May 7, 2017

View reviewed changes

lpinca approved these changes May 7, 2017

View reviewed changes

mscdex reviewed May 7, 2017

View reviewed changes

thefourtheye reviewed May 8, 2017

View reviewed changes

refack force-pushed the fix-12885-change-doc branch from f13cde2 to b303aef Compare May 8, 2017 02:53

refack commented May 8, 2017

View reviewed changes

mscdex reviewed May 8, 2017

View reviewed changes

refack force-pushed the fix-12885-change-doc branch from b303aef to f16669a Compare May 8, 2017 03:11

thefourtheye approved these changes May 8, 2017

View reviewed changes

refack closed this May 10, 2017

refack force-pushed the fix-12885-change-doc branch from f16669a to e1cabf6 Compare May 10, 2017 15:08

refack deleted the fix-12885-change-doc branch May 10, 2017 15:09

refack mentioned this pull request May 10, 2017

doc: res.getHeaders return value wrong in docs #12885

Closed

jasnell mentioned this pull request May 28, 2017

8.0.0 Release Proposal #12220

Closed

refack removed their assignment Jun 12, 2017

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

gibfahn added the backport-requested-v6.x label Jun 20, 2017

doc, test: add note to response.getHeaders #12887

doc, test: add note to response.getHeaders #12887

Conversation

refack commented May 7, 2017 • edited Loading

Checklist

Affected core subsystem(s)

refack commented May 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack commented May 7, 2017

refack commented May 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

addaleax left a comment

Choose a reason for hiding this comment

refack commented May 7, 2017

mscdex May 7, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mscdex May 8, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack commented May 10, 2017

refack commented May 10, 2017

mscdex commented May 10, 2017

refack commented May 10, 2017

gibfahn commented Jun 20, 2017

refack commented May 7, 2017 •

edited

Loading

mscdex May 7, 2017 •

edited

Loading

mscdex May 8, 2017 •

edited

Loading