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

Symbol key props visible in inspection by default #9726

Closed
wants to merge 5 commits into from

Conversation

@mightyiam
Copy link
Contributor

@mightyiam mightyiam commented Nov 21, 2016

I use symbol key properties. And I find it awful that they do
not show up in inspection. I can alter
util.inspect.defaultOptions.showHidden each time I debug. Does
that sound like fun to you? Isn't fun a core principle life?

The way I see it, it is not about the spec or about what is
enumerable/hidden, etc. When inspecting, it is about ease of
access to the information. That's how I see it. Does anyone have
any other thoughts?

Fixes #9709 (which should not have been closed so fast)

I use symbol key properties. And I find it awful that they do
not show up in inspection. I can alter
`util.inspect.defaultOptions.showHidden` each time I debug. Does
that sound like fun to you? Isn't fun a core principle life?

The way I see it, it is not about the spec or about what is
enumerable/hidden, etc. When inspecting, it is about ease of
access to the information. That's how I see it. Does anyone have
any other thoughts?

Fixes #9709 (which should not have been closed so fast)
@@ -371,10 +371,11 @@ function formatValue(ctx, value, recurseTimes) {
// Look up the keys of the object.
var keys = Object.keys(value);
var visibleKeys = arrayToHash(keys);

This comment has been minimized.

@mightyiam

mightyiam Nov 21, 2016
Author Contributor

I don't fully understand what goes on with keys vs. visibleKeys, yet, this seems to work.


if (ctx.showHidden) {
keys = Object.getOwnPropertyNames(value);
keys = keys.concat(Object.getOwnPropertySymbols(value));
keys = Object.getOwnPropertyNames(value).concat(symbolKeys);

This comment has been minimized.

@mightyiam

mightyiam Nov 21, 2016
Author Contributor

This is the same result. The change is to not get the symbols twice.

@@ -588,8 +588,9 @@ assert.doesNotThrow(function() {
'{ a: 123, inspect: [Function: inspect] }');

const subject = { a: 123, [util.inspect.custom]() { return this; } };
const UTC = 'util.inspect.custom';

This comment has been minimized.

@mightyiam

mightyiam Nov 21, 2016
Author Contributor

This trick is solely for line length.

This comment has been minimized.

@mightyiam

mightyiam Nov 21, 2016
Author Contributor

It seems fine because this is in a small block.

This comment has been minimized.

@mscdex

mscdex Nov 21, 2016
Contributor

IMHO 'UTC' isn't a particularly good name. To me, it makes me think of Coordinated Universal Time, but the variable value does not hold anything date/time-related.

This comment has been minimized.

@mightyiam

mightyiam Nov 21, 2016
Author Contributor

Oops. Just a typo. I meant UIC for util.inspect.custom But, from Wikipedia:

UIC may refer to:

In education:

Underwood International College, a department of Yonsei University
United International College, a liberal arts college in China
University of Illinois at Chicago, a public four-year university in Chicago, Illinois
In government:

Uganda Insurance Commission, a government agency
Unit Identification Code, an alphanumeric code used by the United States Department of Defense
In organisations:

International Union of Railways (Union Internationale des Chemins de fer), an international rail transport industry body
UEFA Intertoto Cup, an association football tournament for member clubs of UEFA
Union of Islamic Courts, an armed group in Somalia, now called the "Supreme Islamic Courts Council"
United Industrial Corporation Ltd, a Singapore real estate holding company owned by JG Summit Holdings
In computing:

Uranium Information Centre, a defunct website sponsored by uranium mining companies
User identification code, the user number of the Files-11 file system in the RSX-11 operating system
In other uses:

UIC (band), a punk rock band from Canada
UIC Flames, the intercollegiate athletic program of the University of Illinois at Chicago

What is a good name?

This comment has been minimized.

@addaleax

addaleax Nov 22, 2016
Member

@mightyiam It might be best not to give this a name at all but instead spread the string below across multiple lines?

assert.strictEqual(util.inspect(subject),
'{ a: 123 }');
`{ a: 123,\n [Symbol(${UTC})]: [Function: [${UTC}]] }`);

This comment has been minimized.

@mightyiam

mightyiam Nov 21, 2016
Author Contributor

This is a fix for a seemingly unrelated test that is affected.

@@ -659,7 +660,7 @@ if (typeof Symbol !== 'undefined') {

subject[Symbol('symbol')] = 42;

assert.strictEqual(util.inspect(subject), '{}');
assert.strictEqual(util.inspect(subject), '{ [Symbol(symbol)]: 42 }');

This comment has been minimized.

@mightyiam

mightyiam Nov 21, 2016
Author Contributor

This demonstrates the change.

This comment has been minimized.

@mightyiam

mightyiam Nov 21, 2016
Author Contributor

Just the way I like it 😉

@@ -668,9 +669,8 @@ if (typeof Symbol !== 'undefined') {
subject = [1, 2, 3];
subject[Symbol('symbol')] = 42;

assert.strictEqual(util.inspect(subject), '[ 1, 2, 3 ]');
assert.strictEqual(util.inspect(subject, options),
'[ 1, 2, 3, [length]: 3, [Symbol(symbol)]: 42 ]');

This comment has been minimized.

@mightyiam

mightyiam Nov 21, 2016
Author Contributor

This assertion is removed because we already have an assertion above that symbol key properties are visible with showHidden.

assert.strictEqual(util.inspect(subject, options),
'[ 1, 2, 3, [length]: 3, [Symbol(symbol)]: 42 ]');
assert.strictEqual(util.inspect(subject),
'[ 1, 2, 3, [Symbol(symbol)]: 42 ]');

This comment has been minimized.

@mightyiam

mightyiam Nov 21, 2016
Author Contributor

So in essence, this assertion is not instead of the one in 672, but instead of the one in 671. I guess it shows that symbol key properties can coexist peacefully with other properties in inspection. Or something about the order of properties? In any case, I'm guessing that the essence is preserved.

Copy link
Contributor Author

@mightyiam mightyiam left a comment

LGTM

@@ -588,8 +588,9 @@ assert.doesNotThrow(function() {
'{ a: 123, inspect: [Function: inspect] }');

const subject = { a: 123, [util.inspect.custom]() { return this; } };
const UTC = 'util.inspect.custom';

This comment has been minimized.

@addaleax

addaleax Nov 22, 2016
Member

@mightyiam It might be best not to give this a name at all but instead spread the string below across multiple lines?

lib/util.js Outdated
@@ -371,10 +371,11 @@ function formatValue(ctx, value, recurseTimes) {
// Look up the keys of the object.
var keys = Object.keys(value);
var visibleKeys = arrayToHash(keys);
var symbolKeys = Object.getOwnPropertySymbols(value);

This comment has been minimized.

@addaleax

addaleax Nov 22, 2016
Member

I haven’t run this but right now this looks like this will include even *non-*enumerable Symbol properties?

This comment has been minimized.

@mightyiam

mightyiam Nov 22, 2016
Author Contributor

Yup. That is how Object.getOwnPropertySymbols works. It is like the conversation between it and Object.getOwnPropertyNames is:

  • Object.getOwnPropertyNames: Hey, Symbol. You may join. But don't expect me to list you, even if you're enumerable...
  • Symbol: 😐
  • Object.getOwnPropertySymbols: Gee, did you see that guy? Tell you what, Symbol. I'll list all of you, regardless!
  • Symbol: 😟
  • Object.getOwnPropertyNames: 😦
  • Object.getOwnPropertySymbols: 😊
  • Symbol: 😕

I wouldn't mind changing it to exclude non-enumerable symbol-keyed props. Should I?

This comment has been minimized.

@addaleax

addaleax Nov 22, 2016
Member

Well… it seems a bit weird to list only enumerable string properties but all Symbol properties by default?

This comment has been minimized.

@mightyiam

mightyiam Nov 22, 2016
Author Contributor

I just don't know the reasons for not listing non-enumerable properties. For the sake of explaining my experience with the matter, I'll testify that I:

  1. never made a property non-enumerable before examining this issue
  2. never had to examine the non-enumerable properties of an object. At least not that I know of.

So, it may help that one with experience with the topic of enumerability and non-enumerability will share his thoughts. Also, the thoughts of one who knows the intention of symbols in this regard and why this is the behavior of Object.getOwnPropertySymbols.

@vkurchatkin
Copy link
Contributor

@vkurchatkin vkurchatkin commented Nov 22, 2016

-1. This behaviour is intentional, for the sake of consistency

@mightyiam
Copy link
Contributor Author

@mightyiam mightyiam commented Nov 22, 2016

@vkurchatkin I'm using symbol-keyed props as I would use "global" string constants (identifiers for various entities like state-changing actions, for example). Yet, they are superior to string constants, in that they can never be mimicked/duplicated. They can't be obtained (if you don't use Symbol.for/keyFor) other than explicitly (and hopefully intentionally) exposed by the module that created them. Dues to this superiority, I'm using them wherever I can, instead of the common string constant (const fooBarBaz = 'FOO_BAR_BAZ'). Not seeing them in inspection is heart breaking. And I would imagine that I would like to see them in inspection while not seeing all other things that are currently considered hidden. That is, I wouldn't like to enable util.inspect.defaultOptions.showHidden every debug session and suffer the consequences, that, since I never did that, are still unknown to me.

Please let us find the middle path.

@targos
Copy link
Member

@targos targos commented Nov 22, 2016

Perhaps the middle path could be in the form of a new option (e.g. showSymbols) that adds enumerable Symbol properties to the output.

@mightyiam
Copy link
Contributor Author

@mightyiam mightyiam commented Nov 22, 2016

@vkurchatkin besides stating "-1. This behaviour is intentional, for the sake of consistency", will you please provide further explanation?

@targos that middle path seems lovely to me if that option is on by default 😉

@mightyiam
Copy link
Contributor Author

@mightyiam mightyiam commented Nov 22, 2016

Look, I'm not suggesting to change the behavior of Object.keys or Object.getOwnPropertyNames. I also don't know whether I care to inspect non-enumerable symbols by default. For consistency, I do think that I should change this PR to not inspect non-enumerable symbol-key-props. I only wish to see the enumerable symbols on an object by default when I debug. Is that such a bad idea?

In the strict sense, it is semver-major. It may break a few stringify-foo libraries. But those breakages are probably because of workarounds that they did to get those symbols to display, if any. I'd guess that most stringify-foo libraries do not rely on a core node module, because they wish to work in other environments.

@addaleax
Copy link
Member

@addaleax addaleax commented Nov 22, 2016

For consistency, I do think that I should change this PR to not inspect non-enumerable symbol-key-props.

Yeah, I would appreciate it.

In the strict sense, it is semver-major.

If you think we should discuss considering this a non-major change, you can say so, and I could understand that viewpoint, but generally Node is so widely-used and has been around for so long that we have no other choice than to interpret semver in a strict way.

@mightyiam
Copy link
Contributor Author

@mightyiam mightyiam commented Nov 22, 2016

I see no point trying to circumvent or undermine semver. It is what it is and this is a major change.

@vkurchatkin
Copy link
Contributor

@vkurchatkin vkurchatkin commented Nov 23, 2016

@mightyiam symbol properties are no more visible than non-enumerable string properties, so they have to be behind showHidden flag

@targos I'm fine with adding showSymbols if it's false by default. We could probably add some env variables so that these properties could be personalised

@bnoordhuis
Copy link
Member

@bnoordhuis bnoordhuis commented Nov 23, 2016

I'm fine with showing enumerable symbols. inspect() is for pretty-printing JS values for human inspection.

And for the love of $deity, not more environment variables.

@targos
Copy link
Member

@targos targos commented Nov 23, 2016

Let's see if it breaks something: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/457/

I think I'm also +1 for showing enumerable symbols by default but there should be an option to opt-out.

@silverwind
Copy link
Contributor

@silverwind silverwind commented Nov 23, 2016

@mightyiam what's your issue with util.inspect.defaultOptions.showHidden exactly? You can set it once on the entrypoint of your app and it's enabled pretty much globally. I'm not sure we need a symbol-specific option if it's just a subset of the existing showHidden option.

@mightyiam
Copy link
Contributor Author

@mightyiam mightyiam commented Nov 24, 2016

I've excluded non-enumerable property symbols from inspection.

Do you really think that an option to hide them is a good idea util.inspect.defaultOptions.hidePropertySymbols? Perhaps we wait and see if anyone is actually disturbed by their appearance? I'm guessing that most of the few people who are using them will actually be quite happy that it is slightly easier to debug now.

@mightyiam
Copy link
Contributor Author

@mightyiam mightyiam commented Nov 24, 2016

@silverwind the only issue I have with it is that I have to type it. That can be solved, but it just shouldn't be this way, I think, for the sake of every one who will just solve it for himself somehow.
Also, while I don't have experience with this scenario, I imagine that it may be reasonable to display be default the enumerable symbol properties while still hiding the rest of what is hidden behind showHidden.

lib/util.js Outdated
@@ -371,10 +371,13 @@ function formatValue(ctx, value, recurseTimes) {
// Look up the keys of the object.
var keys = Object.keys(value);
var visibleKeys = arrayToHash(keys);
var symbolKeys = Object.getOwnPropertySymbols(value);
var enumSymbolKeys = symbolKeys

This comment has been minimized.

@addaleax

addaleax Nov 24, 2016
Member

nit: This one can be const

lib/util.js Outdated
@@ -371,10 +371,13 @@ function formatValue(ctx, value, recurseTimes) {
// Look up the keys of the object.
var keys = Object.keys(value);
var visibleKeys = arrayToHash(keys);
var symbolKeys = Object.getOwnPropertySymbols(value);
var enumSymbolKeys = symbolKeys
.filter((key) => value.propertyIsEnumerable(key));

This comment has been minimized.

@addaleax

addaleax Nov 24, 2016
Member

nit: I think we generally indent statement continuations by 4 spaces, not 2

@vkurchatkin
Copy link
Contributor

@vkurchatkin vkurchatkin commented Nov 24, 2016

I'm not sure it's even worth to differentiate enumerable and non-enumerable symbol properties. Is there any difference?

@Trott
Copy link
Member

@Trott Trott commented Mar 9, 2017

I've removed the vote tally in the Google doc from today's meeting and have instead added text directing CTC members to the comment at #9726 (comment).

Based on the history of the Google doc, @fhinkel and @ofrobots recorded themselves as in favor, so I've updated their votes in the comment. The other votes in favor were me interpreting comments in this issue, so I have not moved those over.

@evanlucas
Copy link
Member

@evanlucas evanlucas commented Mar 9, 2017

+1 from me

@cjihrig
Copy link
Contributor

@cjihrig cjihrig commented Mar 9, 2017

I voted +1 earlier in the thread.

@mscdex
Copy link
Contributor

@mscdex mscdex commented Mar 9, 2017

I abstain.

@mhdawson
Copy link
Member

@mhdawson mhdawson commented Mar 10, 2017

+1 from me.

@MylesBorins
Copy link
Member

@MylesBorins MylesBorins commented Mar 15, 2017

I abstain

@Trott
Copy link
Member

@Trott Trott commented Mar 15, 2017

@Fishrock123 indicated a yes vote in the CTC meeting. This passes. Still need to address the nit from @TimothyGu and rebase.

@Fishrock123
Copy link
Member

@Fishrock123 Fishrock123 commented Mar 15, 2017

Correct, I think this is significantly useful for debugging. (Most of us use console.log() to debug things and that should be ok.)

@Trott Trott removed the ctc-agenda label Mar 15, 2017
@addaleax
Copy link
Member

@addaleax addaleax commented Mar 15, 2017

Squashed & freshly rebased version @ addaleax/node@a0b4ff5 (conflict resolution was trivial), CI for that:

CI: https://ci.nodejs.org/job/node-test-commit/8489/
CITGM: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/657/

mightyiam referenced this pull request in addaleax/node Mar 16, 2017
I use symbol key properties. And I find it awful that they do
not show up in inspection. I can alter
`util.inspect.defaultOptions.showHidden` each time I debug. Does
that sound like fun to you? Isn't fun a core principle life?

The way I see it, it is not about the spec or about what is
enumerable/hidden, etc. When inspecting, it is about ease of
access to the information. That's how I see it. Does anyone have
any other thoughts?

Fixes: nodejs#9709
@mightyiam
Copy link
Contributor Author

@mightyiam mightyiam commented Mar 16, 2017

@addaleax I don't mind someone else taking it from here. Just be aware of this issue.

@addaleax
Copy link
Member

@addaleax addaleax commented Mar 16, 2017

Landed in 5bfd13b, thanks for the PR and thanks for the reminder! :)

@addaleax addaleax closed this Mar 16, 2017
addaleax added a commit that referenced this pull request Mar 16, 2017
I use symbol key properties. And I find it awful that they do
not show up in inspection. I can alter
`util.inspect.defaultOptions.showHidden` each time I debug. Does
that sound like fun to you? Isn't fun a core principle life?

The way I see it, it is not about the spec or about what is
enumerable/hidden, etc. When inspecting, it is about ease of
access to the information. That's how I see it. Does anyone have
any other thoughts?

Fixes: #9709
PR-URL: #9726
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
@mightyiam
Copy link
Contributor Author

@mightyiam mightyiam commented Mar 16, 2017

Thanks, everyone!

@mightyiam mightyiam deleted the mightyiam:symbol-key-props-visible branch Mar 16, 2017
jungx098 added a commit to jungx098/node that referenced this pull request Mar 21, 2017
I use symbol key properties. And I find it awful that they do
not show up in inspection. I can alter
`util.inspect.defaultOptions.showHidden` each time I debug. Does
that sound like fun to you? Isn't fun a core principle life?

The way I see it, it is not about the spec or about what is
enumerable/hidden, etc. When inspecting, it is about ease of
access to the information. That's how I see it. Does anyone have
any other thoughts?

Fixes: nodejs#9709
PR-URL: nodejs#9726
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
@jasnell jasnell mentioned this pull request Apr 4, 2017
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).
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.

You can’t perform that action at this time.