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.

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

http: add new functions to OutgoingMessage #10805

Merged
merged 1 commit into from Feb 20, 2017

Conversation

@mscdex
Copy link
Contributor

@mscdex mscdex commented Jan 14, 2017

This PR adds various functions to allow more (official/public) access to the current headers for an outgoing HTTP message. It allows users to avoid having to access the private ._headers property directly to get the same information.

/cc @nodejs/http

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

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)
  • http
@mscdex mscdex added the http label Jan 14, 2017
@mscdex mscdex mentioned this pull request Jan 14, 2017
3 of 3 tasks complete
@Fishrock123 Fishrock123 self-assigned this Jan 14, 2017
@mscdex mscdex force-pushed the mscdex:http-server-res-getheaders branch Jan 14, 2017
doc/api/http.md Outdated
@@ -917,6 +917,32 @@ Example:
var contentType = response.getHeader('content-type');
```

### response.getHeaders([namesOnly])

This comment has been minimized.

@thefourtheye

thefourtheye Jan 14, 2017
Contributor

Wouldn't it be better if we getHeaderNames? We would avoid polymorphic return types as well.

This comment has been minimized.

@mscdex

mscdex Jan 14, 2017
Author Contributor

I don't really have a strong opinion one way or the other.

This comment has been minimized.

@jasnell

jasnell Jan 16, 2017
Member

I'd certainly prefer two separate methods here.

doc/api/http.md Outdated
response.setHeader('Foo', 'bar');
response.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);

var headerNames = response.getHeaders(true);

This comment has been minimized.

@thefourtheye

thefourtheye Jan 14, 2017
Contributor

Nit: const?

This comment has been minimized.

@mscdex

mscdex Jan 14, 2017
Author Contributor

Probably, although the rest of the document is still a mixture of const and var.

lib/_http_outgoing.js Outdated
for (var i = 0; i < keys.length; ++i) {
const key = keys[i];
const val = headers[key][1];
if (val instanceof Array)

This comment has been minimized.

@thefourtheye

thefourtheye Jan 14, 2017
Contributor

Why not Array.isArray?

This comment has been minimized.

@mscdex

mscdex Jan 14, 2017
Author Contributor

Performance. Array.isArray() isn't as fast yet.

Copy link
Member

@mcollina mcollina left a comment

Given that this is a new API, why do we want to support the same pattern? I think that the properties can just be arrays.

For backward compatibility, we might consider adding a _headers accessor that does the same we are doing here.

lib/_http_outgoing.js Outdated
const ret = new OutgoingHeaders();
for (var i = 0; i < keys.length; ++i) {
const key = keys[i];
const val = headers[key][1];

This comment has been minimized.

@mcollina

mcollina Jan 16, 2017
Member

For my own curiosity, have you checked if const within a loop has any perf penalty vs a var outside the loop?

This comment has been minimized.

@mscdex

mscdex Jan 16, 2017
Author Contributor

I didn't specifically compare vs. var, but it's not aborting optimizations because of it or anything (which can still in happen in some cases in V8 5.4).

lib/_http_outgoing.js Outdated
ret[key] = val;
}
return ret;
};

This comment has been minimized.

@mcollina

mcollina Jan 16, 2017
Member

If someone is currently leveraging _headers, will using getHeaders() negate some of the performance benefit of the changes in #10558?

This comment has been minimized.

@mscdex

mscdex Jan 16, 2017
Author Contributor

There will be some overhead obviously, because a copy is being made. However, we need some kind of stable, public API for this to avoid breakage when people rely on a "private" property that could change in value over time for various reasons.

This comment has been minimized.

@jasnell

jasnell Jan 16, 2017
Member

The perf hit obviously depends entirely on what they are using it for. This could vary wildly.

This comment has been minimized.

@mscdex

mscdex Jan 16, 2017
Author Contributor

Right, but if we provide enough API to cover common use cases, I am not worried about it.

@mscdex
Copy link
Contributor Author

@mscdex mscdex commented Jan 16, 2017

@mcollina I'm just trying to both have a public and documented API and also make it so that in case we want to further optimize how we store headers in the future (for example, if at some point we end up switching to a Map for storing outgoing headers), we can do that without breaking anyone (while speeding up core).

@mcollina
Copy link
Member

@mcollina mcollina commented Jan 16, 2017

@mscdex sorry, I might not have expressed myself correctly. I mean, why this new API should have the exact same output of the previous _headers. It seems the best way to store headers is to store them in an array. Then, let have getHeaders() return an object with arrays. It would be easier to process both in core and remove a lot of ifs on the application side.

If we need something that has the same API of _headers, we can just add the accessor and a deprecation warning.

@mscdex
Copy link
Contributor Author

@mscdex mscdex commented Jan 16, 2017

@mcollina Currently this getHeaders() returns the format used prior to #10558 for an easier (like "find and replace" easy) transition from a private to public API. Also, the naming more closely matches the other APIs we have (setHeader(), removeHeader(), and getHeader()).

I'm not sure what you mean with your other suggestions. If we added another private property (e.g. ._headersNew) that contains the new storage method used by #10558 and made _headers a getter that prints a deprecation message, then we still wouldn't have a public API and people would probably just migrate over to the new private property -- something I'm trying to avoid.

@mcollina
Copy link
Member

@mcollina mcollina commented Jan 16, 2017

@mcollina Currently this getHeaders() returns the format used prior to #10558 for an easier (like "find and replace" easy) transition from a private to public API. Also, the naming more closely matches the other APIs we have (setHeader(), removeHeader(), and getHeader()).

That find-and-replace will yield a suboptimal performance, because essentially we will have to generate the "old" data structure for every access to getHeaders(). Find-and-replace still requires manual work, which might be costly and require many library updates, excluding the fact that module authors would have to take into account multiple Node.js versions. Essentially, we are forced to have _headers anyway for the time being.

I'm not sure what you mean with your other suggestions. If we added another private property (e.g. ._headersNew) that contains the new storage method used by #10558 and made _headers a getter that prints a deprecation message, then we still wouldn't have a public API and people would probably just migrate over to the new private property -- something I'm trying to avoid.

I propose to have _headers return the "old" strings-and-array object with an accessor, and have getHeaders() return the new object with just arrays. That will solve all our problems, providing a fast access to the new data structure, and a "slow" access to the legacy one.

@mscdex
Copy link
Contributor Author

@mscdex mscdex commented Jan 16, 2017

@mcollina What do you mean by "strings-and-array object?" When you say "old" are you referring to before or after #10558? Also, could you perhaps share some code that demonstrates what you're proposing? I think that might clear up my confusion...

@mcollina
Copy link
Member

@mcollina mcollina commented Jan 16, 2017

@mscdex I mean, pre-10558 vs post-10558. There is no need for this block of code in the new API:

https://github.com/nodejs/node/pull/10805/files#diff-286202fdbdd74ede6f5f5334b6176b5cR441

Ideally, we should avoid that loop in all the cases if someone uses the latest APIs. Because it is a new API, there is no need for be backward-compatible and we can design it in the best way.

I think the new API should just be a 1-1 map of what we have internally, and have the old _headers pre-10558 returns the "old" data format with an accessor.

Another alternative I might see performing better is to have getHeaders(), just return the array of the keys, so it can be iterated easily and we can use getHeader() to fetch the value. getHeader() has been there since v0.4.
In this way we push the for loop on the user code, avoiding things like:

// getHeaders does a full iteration
var headers = res.getHeaders()
var keys = Object.keys(headers)
// we do a second full iteration here
for (var i = 0; i < keys.length; i++) {
  // do something with the header
} 

to something like

var headers = res.getHeaders()
// we just iterate once
for (var i  = 0; i < headers.length; i++) {
  // do something with the header
}

Yes, it requires more work for things like the fresh module, but it would lead to an implementation that is overall more performant than the previous one.

@mscdex
Copy link
Contributor Author

@mscdex mscdex commented Jan 16, 2017

@mcollina Well, for the latter suggestion, that's already possible with this PR as-is: you just call getHeaders(true) (or perhaps getHeaderNames(), which has been suggested).

As far as using the format we now have, I don't think it's worth sending to the user because they're not typically going to be interested in the original casing of each header (they just want the name and value). Besides, we'd still want to clone the headers object (and any headers that have array values) in one way or another to avoid users mutating the values for headers outside of core, so we'd still need to loop over the object to be able to do that.

Copy link
Member

@jasnell jasnell left a comment

Would prefer there to be two methods, one for the headers object, another for the names. Also, it needs to be clarified that the values in the object will be either String or Arrays of Strings.

doc/api/http.md Outdated
@@ -917,6 +917,32 @@ Example:
var contentType = response.getHeader('content-type');
```

### response.getHeaders([namesOnly])

This comment has been minimized.

@jasnell

jasnell Jan 16, 2017
Member

I'd certainly prefer two separate methods here.

doc/api/http.md Outdated
// headerNames === ['foo', 'set-cookie']

var headers = response.getHeaders();
// headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }

This comment has been minimized.

@jasnell

jasnell Jan 16, 2017
Member

Having this return only a shallow copy could be a bit dangerous, yes?

// users think they're getting a copy
var headers = response.getHeaders();
// whoops, mutates the original
headers['set-cookie'].shift()

This comment has been minimized.

@mscdex

mscdex Jan 16, 2017
Author Contributor

No, array header values are cloned also, but that's as far as it goes.

@mscdex mscdex force-pushed the mscdex:http-server-res-getheaders branch Jan 16, 2017
@mscdex
Copy link
Contributor Author

@mscdex mscdex commented Jan 16, 2017

@thefourtheye @jasnell Alright, I've split the function up into getHeaderNames() and getHeaders() now.

@thefourtheye
Copy link
Contributor

@thefourtheye thefourtheye commented Jan 16, 2017

@mscdex Did you forget to push the commit? I don't see getHeaderNames changes yet.

@mscdex mscdex force-pushed the mscdex:http-server-res-getheaders branch Jan 16, 2017
mscdex added a commit to mscdex/io.js that referenced this pull request Feb 26, 2017
PR-URL: nodejs#10805
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
@mscdex mscdex mentioned this pull request Feb 26, 2017
4 of 4 tasks complete
@mscdex
Copy link
Contributor Author

@mscdex mscdex commented Feb 26, 2017

@mscdex mscdex mentioned this pull request Feb 26, 2017
italoacasas added a commit to italoacasas/node that referenced this pull request Feb 28, 2017
PR-URL: nodejs#11562
Backport-of: nodejs#10805
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
@gibfahn gibfahn mentioned this pull request Mar 17, 2017
28 of 31 tasks complete
@jasnell jasnell mentioned this pull request Apr 4, 2017
@MylesBorins
Copy link
Member

@MylesBorins MylesBorins commented May 16, 2017

@mscdex would you be able to backport to v6.x? I know if it last minute, but you would need to do it early this week to get it in the next v6.x minor. We will definitely be doing another minor before v6.x goes into maintenance mode, so we can definitely get this in later if you are not rushed

jasnell added a commit to jasnell/node that referenced this pull request May 29, 2017
* **Async Hooks**
  * The `async_hooks` module has landed in core
    [[`4a7233c178`](nodejs@4a7233c)]
    [nodejs#12892](nodejs#12892).

* **Buffer**
  * Using the `--pending-deprecation` flag will cause Node.js to emit a
    deprecation warning when using `new Buffer(num)` or `Buffer(num)`.
    [[`d2d32ea5a2`](nodejs@d2d32ea)]
    [nodejs#11968](nodejs#11968).
  * `new Buffer(num)` and `Buffer(num)` will zero-fill new `Buffer` instances
    [[`7eb1b4658e`](nodejs@7eb1b46)]
    [nodejs#12141](nodejs#12141).
  * Many `Buffer` methods now accept `Uint8Array` as input
    [[`beca3244e2`](nodejs@beca324)]
    [nodejs#10236](nodejs#10236).

* **Child Process**
  * Argument and kill signal validations have been improved
    [[`97a77288ce`](nodejs@97a7728)]
    [nodejs#12348](nodejs#12348),
    [[`d75fdd96aa`](nodejs@d75fdd9)]
    [nodejs#10423](nodejs#10423).
  * Child Process methods accept `Uint8Array` as input
    [[`627ecee9ed`](nodejs@627ecee)]
    [nodejs#10653](nodejs#10653).

* **Console**
  * Error events emitted when using `console` methods are now supressed.
    [[`f18e08d820`](nodejs@f18e08d)]
    [nodejs#9744](nodejs#9744).

* **Dependencies**
  * The npm client has been updated to 5.0.0
    [[`3c3b36af0f`](nodejs@3c3b36a)]
    [nodejs#12936](nodejs#12936).
  * V8 has been updated to 5.8 with forward ABI stability to 6.0
    [[`60d1aac8d2`](nodejs@60d1aac)]
    [nodejs#12784](nodejs#12784).

* **Domains**
  * Native `Promise` instances are now `Domain` aware
    [[`84dabe8373`](nodejs@84dabe8)]
    [nodejs#12489](nodejs#12489).

* **Errors**
  * We have started assigning static error codes to errors generated by Node.js.
    This has been done through multiple commits and is still a work in
    progress.

* **File System**
  * The utility class `fs.SyncWriteStream` has been deprecated
    [[`7a55e34ef4`](nodejs@7a55e34)]
    [nodejs#10467](nodejs#10467).
  * The deprecated `fs.read()` string interface has been removed
    [[`3c2a9361ff`](nodejs@3c2a936)]
    [nodejs#9683](nodejs#9683).

* **HTTP**
  * Improved support for userland implemented Agents
    [[`90403dd1d0`](nodejs@90403dd)]
    [nodejs#11567](nodejs#11567).
  * Outgoing Cookie headers are concatenated into a single string
    [[`d3480776c7`](nodejs@d348077)]
    [nodejs#11259](nodejs#11259).
  * The `httpResponse.writeHeader()` method has been deprecated
    [[`fb71ba4921`](nodejs@fb71ba4)]
    [nodejs#11355](nodejs#11355).
  * New methods for accessing HTTP headers have been added to `OutgoingMessage`
    [[`3e6f1032a4`](nodejs@3e6f103)]
    [nodejs#10805](nodejs#10805).

* **Lib**
  * All deprecation messages have been assigned static identifiers
    [[`5de3cf099c`](nodejs@5de3cf0)]
    [nodejs#10116](nodejs#10116).
  * The legacy `linkedlist` module has been removed
    [[`84a23391f6`](nodejs@84a2339)]
    [nodejs#12113](nodejs#12113).

* **N-API**
  * Experimental support for the new N-API API has been added
    [[`56e881d0b0`](nodejs@56e881d)]
    [nodejs#11975](nodejs#11975).

* **Process**
  * Process warning output can be redirected to a file using the
    `--redirect-warnings` command-line argument
    [[`03e89b3ff2`](nodejs@03e89b3)]
    [nodejs#10116](nodejs#10116).
  * Process warnings may now include additional detail
    [[`dd20e68b0f`](nodejs@dd20e68)]
    [nodejs#12725](nodejs#12725).

* **REPL**
  * REPL magic mode has been deprecated
    [[`3f27f02da0`](nodejs@3f27f02)]
    [nodejs#11599](nodejs#11599).

* **Src**
  * `NODE_MODULE_VERSION` has been updated to 57
    (nodejs@ec7cbaf)]
    [nodejs#12995](nodejs#12995).
  * Add `--pending-deprecation` command-line argument and
    `NODE_PENDING_DEPRECATION` environment variable
    [[`a16b570f8c`](nodejs@a16b570)]
    [nodejs#11968](nodejs#11968).
  * The `--debug` command-line argument has been deprecated. Note that
    using `--debug` will enable the *new* Inspector-based debug protocol
    as the legacy Debugger protocol previously used by Node.js has been
    removed. [[`010f864426`](nodejs@010f864)]
    [nodejs#12949](nodejs#12949).
  * Throw when the `-c` and `-e` command-line arguments are used at the same
    time [[`a5f91ab230`](nodejs@a5f91ab)]
    [nodejs#11689](nodejs#11689).
  * Throw when the `--use-bundled-ca` and `--use-openssl-ca` command-line
    arguments are used at the same time.
    [[`8a7db9d4b5`](nodejs@8a7db9d)]
    [nodejs#12087](nodejs#12087).

* **Stream**
  * `Stream` now supports `destroy()` and `_destroy()` APIs
    [[`b6e1d22fa6`](nodejs@b6e1d22)]
    [nodejs#12925](nodejs#12925).
  * `Stream` now supports the `_final()` API
    [[`07c7f198db`](nodejs@07c7f19)]
    [nodejs#12828](nodejs#12828).

* **TLS**
  * The `rejectUnauthorized` option now defaults to `true`
    [[`348cc80a3c`](nodejs@348cc80)]
    [nodejs#5923](nodejs#5923).
  * The `tls.createSecurePair()` API now emits a runtime deprecation
    [[`a2ae08999b`](nodejs@a2ae089)]
    [nodejs#11349](nodejs#11349).
  * A runtime deprecation will now be emitted when `dhparam` is less than
    2048 bits [[`d523eb9c40`](nodejs@d523eb9)]
    [nodejs#11447](nodejs#11447).

* **URL**
  * The WHATWG URL implementation is now a fully-supported Node.js API
    [[`d080ead0f9`](nodejs@d080ead)]
    [nodejs#12710](nodejs#12710).

* **Util**
  * `Symbol` keys are now displayed by default when using `util.inspect()`
    [[`5bfd13b81e`](nodejs@5bfd13b)]
    [nodejs#9726](nodejs#9726).
  * `toJSON` errors will be thrown when formatting `%j`
    [[`455e6f1dd8`](nodejs@455e6f1)]
    [nodejs#11708](nodejs#11708).
  * Convert `inspect.styles` and `inspect.colors` to prototype-less objects
    [[`aab0d202f8`](nodejs@aab0d20)]
    [nodejs#11624](nodejs#11624).
  * The new `util.promisify()` API has been added
    [[`99da8e8e02`](nodejs@99da8e8)]
    [nodejs#12442](nodejs#12442).

* **Zlib**
  * Support `Uint8Array` in Zlib convenience methods
    [[`91383e47fd`](nodejs@91383e4)]
    [nodejs#12001](nodejs#12001).
  * Zlib errors now use `RangeError` and `TypeError` consistently
    [[`b514bd231e`](nodejs@b514bd2)]
    [nodejs#11391](nodejs#11391).
jasnell added a commit that referenced this pull request May 30, 2017
* **Async Hooks**
  * The `async_hooks` module has landed in core
    [[`4a7233c178`](4a7233c)]
    [#12892](#12892).

* **Buffer**
  * Using the `--pending-deprecation` flag will cause Node.js to emit a
    deprecation warning when using `new Buffer(num)` or `Buffer(num)`.
    [[`d2d32ea5a2`](d2d32ea)]
    [#11968](#11968).
  * `new Buffer(num)` and `Buffer(num)` will zero-fill new `Buffer` instances
    [[`7eb1b4658e`](7eb1b46)]
    [#12141](#12141).
  * Many `Buffer` methods now accept `Uint8Array` as input
    [[`beca3244e2`](beca324)]
    [#10236](#10236).

* **Child Process**
  * Argument and kill signal validations have been improved
    [[`97a77288ce`](97a7728)]
    [#12348](#12348),
    [[`d75fdd96aa`](d75fdd9)]
    [#10423](#10423).
  * Child Process methods accept `Uint8Array` as input
    [[`627ecee9ed`](627ecee)]
    [#10653](#10653).

* **Console**
  * Error events emitted when using `console` methods are now supressed.
    [[`f18e08d820`](f18e08d)]
    [#9744](#9744).

* **Dependencies**
  * The npm client has been updated to 5.0.0
    [[`3c3b36af0f`](3c3b36a)]
    [#12936](#12936).
  * V8 has been updated to 5.8 with forward ABI stability to 6.0
    [[`60d1aac8d2`](60d1aac)]
    [#12784](#12784).

* **Domains**
  * Native `Promise` instances are now `Domain` aware
    [[`84dabe8373`](84dabe8)]
    [#12489](#12489).

* **Errors**
  * We have started assigning static error codes to errors generated by Node.js.
    This has been done through multiple commits and is still a work in
    progress.

* **File System**
  * The utility class `fs.SyncWriteStream` has been deprecated
    [[`7a55e34ef4`](7a55e34)]
    [#10467](#10467).
  * The deprecated `fs.read()` string interface has been removed
    [[`3c2a9361ff`](3c2a936)]
    [#9683](#9683).

* **HTTP**
  * Improved support for userland implemented Agents
    [[`90403dd1d0`](90403dd)]
    [#11567](#11567).
  * Outgoing Cookie headers are concatenated into a single string
    [[`d3480776c7`](d348077)]
    [#11259](#11259).
  * The `httpResponse.writeHeader()` method has been deprecated
    [[`fb71ba4921`](fb71ba4)]
    [#11355](#11355).
  * New methods for accessing HTTP headers have been added to `OutgoingMessage`
    [[`3e6f1032a4`](3e6f103)]
    [#10805](#10805).

* **Lib**
  * All deprecation messages have been assigned static identifiers
    [[`5de3cf099c`](5de3cf0)]
    [#10116](#10116).
  * The legacy `linkedlist` module has been removed
    [[`84a23391f6`](84a2339)]
    [#12113](#12113).

* **N-API**
  * Experimental support for the new N-API API has been added
    [[`56e881d0b0`](56e881d)]
    [#11975](#11975).

* **Process**
  * Process warning output can be redirected to a file using the
    `--redirect-warnings` command-line argument
    [[`03e89b3ff2`](03e89b3)]
    [#10116](#10116).
  * Process warnings may now include additional detail
    [[`dd20e68b0f`](dd20e68)]
    [#12725](#12725).

* **REPL**
  * REPL magic mode has been deprecated
    [[`3f27f02da0`](3f27f02)]
    [#11599](#11599).

* **Src**
  * `NODE_MODULE_VERSION` has been updated to 57
    (ec7cbaf)]
    [#12995](#12995).
  * Add `--pending-deprecation` command-line argument and
    `NODE_PENDING_DEPRECATION` environment variable
    [[`a16b570f8c`](a16b570)]
    [#11968](#11968).
  * The `--debug` command-line argument has been deprecated. Note that
    using `--debug` will enable the *new* Inspector-based debug protocol
    as the legacy Debugger protocol previously used by Node.js has been
    removed. [[`010f864426`](010f864)]
    [#12949](#12949).
  * Throw when the `-c` and `-e` command-line arguments are used at the same
    time [[`a5f91ab230`](a5f91ab)]
    [#11689](#11689).
  * Throw when the `--use-bundled-ca` and `--use-openssl-ca` command-line
    arguments are used at the same time.
    [[`8a7db9d4b5`](8a7db9d)]
    [#12087](#12087).

* **Stream**
  * `Stream` now supports `destroy()` and `_destroy()` APIs
    [[`b6e1d22fa6`](b6e1d22)]
    [#12925](#12925).
  * `Stream` now supports the `_final()` API
    [[`07c7f198db`](07c7f19)]
    [#12828](#12828).

* **TLS**
  * The `rejectUnauthorized` option now defaults to `true`
    [[`348cc80a3c`](348cc80)]
    [#5923](#5923).
  * The `tls.createSecurePair()` API now emits a runtime deprecation
    [[`a2ae08999b`](a2ae089)]
    [#11349](#11349).
  * A runtime deprecation will now be emitted when `dhparam` is less than
    2048 bits [[`d523eb9c40`](d523eb9)]
    [#11447](#11447).

* **URL**
  * The WHATWG URL implementation is now a fully-supported Node.js API
    [[`d080ead0f9`](d080ead)]
    [#12710](#12710).

* **Util**
  * `Symbol` keys are now displayed by default when using `util.inspect()`
    [[`5bfd13b81e`](5bfd13b)]
    [#9726](#9726).
  * `toJSON` errors will be thrown when formatting `%j`
    [[`455e6f1dd8`](455e6f1)]
    [#11708](#11708).
  * Convert `inspect.styles` and `inspect.colors` to prototype-less objects
    [[`aab0d202f8`](aab0d20)]
    [#11624](#11624).
  * The new `util.promisify()` API has been added
    [[`99da8e8e02`](99da8e8)]
    [#12442](#12442).

* **Zlib**
  * Support `Uint8Array` in Zlib convenience methods
    [[`91383e47fd`](91383e4)]
    [#12001](#12001).
  * Zlib errors now use `RangeError` and `TypeError` consistently
    [[`b514bd231e`](b514bd2)]
    [#11391](#11391).
jasnell added a commit that referenced this pull request May 30, 2017
* **Async Hooks**
  * The `async_hooks` module has landed in core
    [[`4a7233c178`](4a7233c)]
    [#12892](#12892).

* **Buffer**
  * Using the `--pending-deprecation` flag will cause Node.js to emit a
    deprecation warning when using `new Buffer(num)` or `Buffer(num)`.
    [[`d2d32ea5a2`](d2d32ea)]
    [#11968](#11968).
  * `new Buffer(num)` and `Buffer(num)` will zero-fill new `Buffer` instances
    [[`7eb1b4658e`](7eb1b46)]
    [#12141](#12141).
  * Many `Buffer` methods now accept `Uint8Array` as input
    [[`beca3244e2`](beca324)]
    [#10236](#10236).

* **Child Process**
  * Argument and kill signal validations have been improved
    [[`97a77288ce`](97a7728)]
    [#12348](#12348),
    [[`d75fdd96aa`](d75fdd9)]
    [#10423](#10423).
  * Child Process methods accept `Uint8Array` as input
    [[`627ecee9ed`](627ecee)]
    [#10653](#10653).

* **Console**
  * Error events emitted when using `console` methods are now supressed.
    [[`f18e08d820`](f18e08d)]
    [#9744](#9744).

* **Dependencies**
  * The npm client has been updated to 5.0.0
    [[`3c3b36af0f`](3c3b36a)]
    [#12936](#12936).
  * V8 has been updated to 5.8 with forward ABI stability to 6.0
    [[`60d1aac8d2`](60d1aac)]
    [#12784](#12784).

* **Domains**
  * Native `Promise` instances are now `Domain` aware
    [[`84dabe8373`](84dabe8)]
    [#12489](#12489).

* **Errors**
  * We have started assigning static error codes to errors generated by Node.js.
    This has been done through multiple commits and is still a work in
    progress.

* **File System**
  * The utility class `fs.SyncWriteStream` has been deprecated
    [[`7a55e34ef4`](7a55e34)]
    [#10467](#10467).
  * The deprecated `fs.read()` string interface has been removed
    [[`3c2a9361ff`](3c2a936)]
    [#9683](#9683).

* **HTTP**
  * Improved support for userland implemented Agents
    [[`90403dd1d0`](90403dd)]
    [#11567](#11567).
  * Outgoing Cookie headers are concatenated into a single string
    [[`d3480776c7`](d348077)]
    [#11259](#11259).
  * The `httpResponse.writeHeader()` method has been deprecated
    [[`fb71ba4921`](fb71ba4)]
    [#11355](#11355).
  * New methods for accessing HTTP headers have been added to `OutgoingMessage`
    [[`3e6f1032a4`](3e6f103)]
    [#10805](#10805).

* **Lib**
  * All deprecation messages have been assigned static identifiers
    [[`5de3cf099c`](5de3cf0)]
    [#10116](#10116).
  * The legacy `linkedlist` module has been removed
    [[`84a23391f6`](84a2339)]
    [#12113](#12113).

* **N-API**
  * Experimental support for the new N-API API has been added
    [[`56e881d0b0`](56e881d)]
    [#11975](#11975).

* **Process**
  * Process warning output can be redirected to a file using the
    `--redirect-warnings` command-line argument
    [[`03e89b3ff2`](03e89b3)]
    [#10116](#10116).
  * Process warnings may now include additional detail
    [[`dd20e68b0f`](dd20e68)]
    [#12725](#12725).

* **REPL**
  * REPL magic mode has been deprecated
    [[`3f27f02da0`](3f27f02)]
    [#11599](#11599).

* **Src**
  * `NODE_MODULE_VERSION` has been updated to 57
    (ec7cbaf)]
    [#12995](#12995).
  * Add `--pending-deprecation` command-line argument and
    `NODE_PENDING_DEPRECATION` environment variable
    [[`a16b570f8c`](a16b570)]
    [#11968](#11968).
  * The `--debug` command-line argument has been deprecated. Note that
    using `--debug` will enable the *new* Inspector-based debug protocol
    as the legacy Debugger protocol previously used by Node.js has been
    removed. [[`010f864426`](010f864)]
    [#12949](#12949).
  * Throw when the `-c` and `-e` command-line arguments are used at the same
    time [[`a5f91ab230`](a5f91ab)]
    [#11689](#11689).
  * Throw when the `--use-bundled-ca` and `--use-openssl-ca` command-line
    arguments are used at the same time.
    [[`8a7db9d4b5`](8a7db9d)]
    [#12087](#12087).

* **Stream**
  * `Stream` now supports `destroy()` and `_destroy()` APIs
    [[`b6e1d22fa6`](b6e1d22)]
    [#12925](#12925).
  * `Stream` now supports the `_final()` API
    [[`07c7f198db`](07c7f19)]
    [#12828](#12828).

* **TLS**
  * The `rejectUnauthorized` option now defaults to `true`
    [[`348cc80a3c`](348cc80)]
    [#5923](#5923).
  * The `tls.createSecurePair()` API now emits a runtime deprecation
    [[`a2ae08999b`](a2ae089)]
    [#11349](#11349).
  * A runtime deprecation will now be emitted when `dhparam` is less than
    2048 bits [[`d523eb9c40`](d523eb9)]
    [#11447](#11447).

* **URL**
  * The WHATWG URL implementation is now a fully-supported Node.js API
    [[`d080ead0f9`](d080ead)]
    [#12710](#12710).

* **Util**
  * `Symbol` keys are now displayed by default when using `util.inspect()`
    [[`5bfd13b81e`](5bfd13b)]
    [#9726](#9726).
  * `toJSON` errors will be thrown when formatting `%j`
    [[`455e6f1dd8`](455e6f1)]
    [#11708](#11708).
  * Convert `inspect.styles` and `inspect.colors` to prototype-less objects
    [[`aab0d202f8`](aab0d20)]
    [#11624](#11624).
  * The new `util.promisify()` API has been added
    [[`99da8e8e02`](99da8e8)]
    [#12442](#12442).

* **Zlib**
  * Support `Uint8Array` in Zlib convenience methods
    [[`91383e47fd`](91383e4)]
    [#12001](#12001).
  * Zlib errors now use `RangeError` and `TypeError` consistently
    [[`b514bd231e`](b514bd2)]
    [#11391](#11391).
@Trott Trott mentioned this pull request Jun 23, 2017
2 of 2 tasks complete
@MylesBorins
Copy link
Member

@MylesBorins MylesBorins commented Sep 19, 2017

@mscdex would you be willing to backport?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

You can’t perform that action at this time.