console: sub-millisecond accuracy for console.time #3166

targos · 2015-10-03T10:27:58Z

This makes the output of console.timeEnd in line with major browsers.

targos · 2015-10-03T11:25:22Z

I just pushed an update to the doc.

thefourtheye · 2015-10-03T11:54:44Z

doc/api/console.markdown

@@ -93,7 +92,7 @@ Example:
      ;
    }
    console.timeEnd('100-elements');
-    // prints 100-elements: 262ms
+    // prints 100-elements: 225.438ms


Why this change is necessary?

Edit: Ah, I see it now. That is kind of the point of this PR

Bikeshedding: this belongs to the first commit «console: sub-millisecond accuracy for console.time», not to «doc: reword description of console.time».

I moved this change to the first commit

Trott · 2015-10-03T15:47:36Z

Should it be semver-minor? More of an enhancement than a bug fix?

Trott · 2015-10-03T15:51:58Z

LGTM if CI is happy and if there's consensus on the semver implications of the change.

targos · 2015-10-03T16:10:45Z

CI: https://ci.nodejs.org/job/node-test-commit/720/
I agree with @Trott about semver-minor.

ChALkeR · 2015-10-03T21:51:27Z

Sign in to view

-timer's name as the parameter.
+Starts a timer that can be used to compute the duration of an operation. Timers
+are identified by a unique name. Use the same name when you call
+[`console.timeEnd()`](#console_console_timeend_label) to stop the timer and


Does this break refs?

Btw, this change is not directly related to this PR.

ChALkeR · 2015-10-03T21:51:34Z

Sign in to view


 Stops a timer that was previously started by calling
-[`console.time()`](#console_console_time_label) and print the result to the
+[`console.time()`](#console_console_time_label) and prints the result to the


Does this break refs?

ChALkeR · 2015-10-03T21:54:34Z

The JS part LGTM.
I suspect that this breaks the docs, though. Why are those non-trivial changes in docs included in this PR, btw?

targos · 2015-10-04T07:20:45Z

@ChALkeR you are right, the doc refs are broken because I changed the titles. Do you you prefer to review the doc changes in another PR or just a second commit in this one ?

aheckmann · 2015-10-05T14:01:48Z

test/parallel/test-console.js

+assert.ok(/^label: \d+\.\d{3}ms$/.test(strings.shift().trim()));
+assert.ok(/^__proto__: \d+\.\d{3}ms$/.test(strings.shift().trim()));
+assert.ok(/^constructor: \d+\.\d{3}ms$/.test(strings.shift().trim()));
+assert.ok(/^hasOwnProperty: \d+\.\d{3}ms$/.test(strings.shift().trim()));


If we consider the output of the console functions to be part of the API, the I think one could view this as semver-major. The change to thses tests demonstrates how downstream apps output parsing will break.

Good point, I don't know what is the policy about console output.
Recent changes to the output of util.format were considered semver-minor IIRC.
cc @nodejs/collaborators

I'm going to say semver-minor for changes to console output but it's never as clear cut as it appears. For this, I personally feel it's small enough of a change that -minor is appropriate.

The probability of this breaking anything is near zero. Still, there seems to be no reason for pulling this into 4.x branch.

Fishrock123 · 2015-10-06T03:18:43Z

I'm not sure this isn't actually semver-major.

It's almost irrelevant right now. It'l probably have to land in v5.x anyways, but we should err on the side of caution still.

targos · 2015-10-06T06:59:05Z

OK for semver-major, this is safer. I added it to the 5.0 milestone.

targos · 2015-10-07T18:10:19Z

I put the doc changes in a separate commit. PTAL.

silverwind · 2015-10-07T18:31:52Z

Sign in to view

@@ -74,16 +74,16 @@ Defaults to `false`. Colors are customizable, see below.

 ### console.time(label)


Maybe call the parameter timerName to be in line with mdn?

same could be done in code, maybe as a seperate commit too.

ChALkeR · 2015-10-07T18:43:07Z

«console: sub-millisecond accuracy for console.time» + one-line doc change («262ms» → «225.438ms») LGTM.
«doc: reword description of console.time» — no review from me, I am not a native English speaker. Also, both versions look fine to me.

evanlucas · 2015-10-08T13:18:07Z

LGTM if CI is green

Trott · 2015-10-08T17:27:23Z

semver-major means TSC has to review before landing, right?

jasnell · 2015-10-08T17:33:02Z

@Trott ... no, semver-major changes can land in master at any time so long as there is good review. They cannot land in stable branches, however, without very good reason and TSC or LTS WG review.

jasnell · 2015-10-08T17:33:46Z

That said, if the change may be controversial or particularly disruptive, you may want to hold off landing until more folks have had the time to review it.

silverwind · 2015-10-08T17:39:51Z

@jasnell is correct. There's no reason to hold off universally approved semver-major commits with our current model, unless you specifically don't want something to land on the next major release.

Trott · 2015-10-08T17:47:05Z

The onboarding.md that I have bookmarked says this:

semver-major (breaking) changes must be reviewed in some form by the TSC

Maybe the onboarding.md needs to be updated? Or there's a newer one that I should use instead of the one I've been using? (I'm reluctant to post the link publicly here because it's a secret gist and not a public gist.)

Or maybe it really does need TSC review. As recently as three days ago, that was the conclusion for a different semver-major PR. #3078 (comment)

/cc @Fishrock123

trevnorris · 2015-10-08T18:16:35Z

I don't think that means we need to have a formal vote on the breaking change. Only that someone from the TSC approves the PR.

Trott · 2015-10-08T18:38:38Z

@trevnorris +1 for a liberal interpretation of in some form.

targos · 2015-10-08T19:29:40Z

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

Fishrock123 · 2015-10-09T02:55:26Z

@Trott ... no, semver-major changes can land in master at any time so long as there is good review. They cannot land in stable branches, however, without very good reason and TSC or LTS WG review.

I would dispute not:

Pull Requests that require an increase in the Major version must be elevated for review by the TSC. This does not necessarily mean that the PR must be put onto the TSC meeting agenda. If enough TSC members sign-off on the PR and there is clear consensus among TSC members for the change, the Pull Request can be landed. Where there is disagreement among TSC members, semver-major Pull Requests should be put on the TSC meeting agenda.

https://github.com/nodejs/dev-policy#accepting-modifications-through-a-consensus-seeking-process

I think it is best to keep it this way, at least for now.

Fishrock123 · 2015-10-09T02:56:18Z

I don't think that means we need to have a formal vote on the breaking change. Only that someone from the TSC approves the PR.

See above. :)

targos · 2015-10-09T06:14:26Z

CI is happy minus the usual test-stringbytes-external.

@Trott @evanlucas @ChALkeR @nodejs/tsc: LGTY ?

Trott · 2015-10-09T06:26:13Z

doc/api/console.markdown

+are identified by a unique name. Use the same name when you call
+[`console.timeEnd()`](#console_console_timeend_timername) to stop the timer and
+output the elapsed time in milliseconds. Timer durations are accurate to the
+sub-millisecond.


Nittiest of all possible nits: The last sentence describes the timer precision, not the accuracy.

Slightly less nitty nit: sub-millisecond is true, but we know that it will be three decimal places, so you could just say it's to the microsecond.

Of course, I can't come up with wording for either of these nits that's better than what's already there, so ¯_(ツ)_/¯

The last sentence describes the timer precision, not the accuracy.

You are right, I will replace "accurate" with "precise" when I land it if nobody objects.

... so you could just say it's to the microsecond

I wanted to do that but I am not sure it's true all the time and on all platforms. Perhaps if the CPU is overloaded we can lose precision ? I really don't know.

Another possibility is just to remove that last sentence entirely. I don't think MDN indicates how many decimal places their timer is good for, for example. People can use it and they get as many decimal places as they get.

MDN stuff for reference:

https://developer.mozilla.org/en-US/docs/Web/API/Console/time

https://developer.mozilla.org/en-US/docs/Web/API/Console/timeEnd

For this sentence I took inspiration from https://developer.chrome.com/devtools/docs/console-api#consoletimelabel
I fine with removing it as well

Ah. Well, in that case, I'm fine with leaving it. If it's good enough for Chrome docs, it's good enough for me.

Sorry for all the bikeshedding on this. LGTM no matter which way you decide to go with it (leave it, remove it, change it as described).

Trott · 2015-10-09T06:27:18Z

A couple of nits, but I'm OK if they're addressed at a later date or ignored entirely. (They're nits after all.)

LGTM

silverwind · 2015-10-09T07:03:05Z

Overall LGTM. There's one more slight difference to browser implementations: They limit the amount of active timers to 10000. I don't think we need this, but at least mention it.

targos · 2015-10-09T07:27:01Z

Yes, they also don't throw when you call console.timeEnd() with a non-existing timer. Another difference is that console.time() is a no-op if a timer with the same name is already running. Our implementation restarts it.
I'd like to improve this as well but I think it's out of scope for this PR.

targos · 2015-10-16T17:35:15Z

Can I have a sign-off from someone in @nodejs/tsc ?

trevnorris · 2015-10-16T18:49:46Z

LGTM

This makes the output of console.timeEnd in line with major browsers. PR-URL: #3166 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

PR-URL: #3166 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

Name it timerName instead of label. It is clearer that way and matches the description in the doc. It is also how it's named in MDN. PR-URL: #3166 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

targos · 2015-10-16T19:11:15Z

Thanks! Landed in 642928b...8c043c1

This makes the output of console.timeEnd in line with major browsers. PR-URL: #3166 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

PR-URL: #3166 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

Name it timerName instead of label. It is clearer that way and matches the description in the doc. It is also how it's named in MDN. PR-URL: #3166 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

Notable changes: * buffer: (Breaking) Removed both 'raw' and 'raws' encoding types from Buffer, these have been deprecated for a long time (Sakthipriyan Vairamani) nodejs#2859. * console: (Breaking) Values reported by console.time() now have 3 decimals of accuracy added (Michaël Zasso) nodejs#3166. * fs: - fs.readFile*(), fs.writeFile*(), and fs.appendFile*() now also accept a file descriptor as their first argument (Johannes Wüller) nodejs#3163. - (Breaking) In fs.readFile(), if an encoding is specified and the internal toString() fails the error is no longer thrown but is passed to the callback (Evan Lucas) nodejs#3485. - (Breaking) In fs.read() (using the fs.read(fd, length, position, encoding, callback) form), if the internal toString() fails the error is no longer thrown but is passed to the callback (Evan Lucas) nodejs#3503. * http: - Fixed a bug where pipelined http requests would stall (Fedor Indutny) nodejs#3342. - (Breaking) When parsing HTTP, don't add duplicates of the following headers: Retry-After, ETag, Last-Modified, Server, Age, Expires. This is in addition to the following headers which already block duplicates: Content-Type, Content-Length, User-Agent, Referer, Host, Authorization, Proxy-Authorization, If-Modified-Since, If-Unmodified-Since, From, Location, Max-Forwards (James M Snell) nodejs#3090. - (Breaking) The callback argument to OutgoingMessage#setTimeout() must be a function or a TypeError is thrown (James M Snell) nodejs#3090. - (Breaking) HTTP methods and header names must now conform to the RFC 2616 "token" rule, a list of allowed characters that excludes control characters and a number of separator characters. Specifically, methods and header names must now match /^[a-zA-Z0-9_!#$%&'*+.^`|~-]+$/ or a TypeError will be thrown (James M Snell) nodejs#2526. * node: - (Breaking) Deprecated the _linklist module (Rich Trott) nodejs#3078. - (Breaking) Removed require.paths and require.registerExtension(), both had been previously set to throw Error when accessed (Sakthipriyan Vairamani) nodejs#2922. * npm: Upgraded to version 3.3.6 from 2.14.7, see https://github.com/npm/npm/releases/tag/v3.3.6 for more details. This is a major version bump for npm and it has seen a significant amount of change. Please see the original npm v3.0.0 release notes for a list of major changes (Rebecca Turner) nodejs#3310. * src: (Breaking) Bumped NODE_MODULE_VERSION to 47 from 46, this is necessary due to the V8 upgrade. Native add-ons will need to be recompiled (Rod Vagg) nodejs#3400. * timers: Attempt to reuse the timer handle for setTimeout().unref(). This fixes a long-standing known issue where unrefed timers would perviously hold beforeExit open (Fedor Indutny) nodejs#3407. * tls: - Added ALPN Support (Shigeki Ohtsu) nodejs#2564. - TLS options can now be passed in an object to createSecurePair() (Коренберг Марк) nodejs#2441. - (Breaking) The default minimum DH key size for tls.connect() is now 1024 bits and a warning is shown when DH key size is less than 2048 bits. This a security consideration to prevent "logjam" attacks. A new minDHSize TLS option can be used to override the default. (Shigeki Ohtsu) nodejs#1831. * util: - (Breaking) util.p() was deprecated for years, and has now been removed (Wyatt Preul) nodejs#3432. - (Breaking) util.inherits() can now work with ES6 classes. This is considered a breaking change because of potential subtle side-effects caused by a change from directly reassigning the prototype of the constructor using `ctor.prototype = Object.create(superCtor.prototype, { constructor: { ... } })` to using `Object.setPrototypeOf(ctor.prototype, superCtor.prototype)` (Michaël Zasso) nodejs#3455. * v8: (Breaking) Upgraded to 4.6.85.25 from 4.5.103.35 (Ali Ijaz Sheikh) nodejs#3351. - Implements the spread operator, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator for further information. - Implements new.target, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/new.target for further information. * zlib: Decompression now throws on truncated input (e.g. unexpected end of file) (Yuval Brik) nodejs#2595. PR-URL: nodejs#3466

Notable changes: * buffer: (Breaking) Removed both 'raw' and 'raws' encoding types from Buffer, these have been deprecated for a long time (Sakthipriyan Vairamani) #2859. * console: (Breaking) Values reported by console.time() now have 3 decimals of accuracy added (Michaël Zasso) #3166. * fs: - fs.readFile*(), fs.writeFile*(), and fs.appendFile*() now also accept a file descriptor as their first argument (Johannes Wüller) #3163. - (Breaking) In fs.readFile(), if an encoding is specified and the internal toString() fails the error is no longer thrown but is passed to the callback (Evan Lucas) #3485. - (Breaking) In fs.read() (using the fs.read(fd, length, position, encoding, callback) form), if the internal toString() fails the error is no longer thrown but is passed to the callback (Evan Lucas) #3503. * http: - Fixed a bug where pipelined http requests would stall (Fedor Indutny) #3342. - (Breaking) When parsing HTTP, don't add duplicates of the following headers: Retry-After, ETag, Last-Modified, Server, Age, Expires. This is in addition to the following headers which already block duplicates: Content-Type, Content-Length, User-Agent, Referer, Host, Authorization, Proxy-Authorization, If-Modified-Since, If-Unmodified-Since, From, Location, Max-Forwards (James M Snell) #3090. - (Breaking) The callback argument to OutgoingMessage#setTimeout() must be a function or a TypeError is thrown (James M Snell) #3090. - (Breaking) HTTP methods and header names must now conform to the RFC 2616 "token" rule, a list of allowed characters that excludes control characters and a number of separator characters. Specifically, methods and header names must now match /^[a-zA-Z0-9_!#$%&'*+.^`|~-]+$/ or a TypeError will be thrown (James M Snell) #2526. * node: - (Breaking) Deprecated the _linklist module (Rich Trott) #3078. - (Breaking) Removed require.paths and require.registerExtension(), both had been previously set to throw Error when accessed (Sakthipriyan Vairamani) #2922. * npm: Upgraded to version 3.3.6 from 2.14.7, see https://github.com/npm/npm/releases/tag/v3.3.6 for more details. This is a major version bump for npm and it has seen a significant amount of change. Please see the original npm v3.0.0 release notes for a list of major changes (Rebecca Turner) #3310. * src: (Breaking) Bumped NODE_MODULE_VERSION to 47 from 46, this is necessary due to the V8 upgrade. Native add-ons will need to be recompiled (Rod Vagg) #3400. * timers: Attempt to reuse the timer handle for setTimeout().unref(). This fixes a long-standing known issue where unrefed timers would perviously hold beforeExit open (Fedor Indutny) #3407. * tls: - Added ALPN Support (Shigeki Ohtsu) #2564. - TLS options can now be passed in an object to createSecurePair() (Коренберг Марк) #2441. - (Breaking) The default minimum DH key size for tls.connect() is now 1024 bits and a warning is shown when DH key size is less than 2048 bits. This a security consideration to prevent "logjam" attacks. A new minDHSize TLS option can be used to override the default. (Shigeki Ohtsu) #1831. * util: - (Breaking) util.p() was deprecated for years, and has now been removed (Wyatt Preul) #3432. - (Breaking) util.inherits() can now work with ES6 classes. This is considered a breaking change because of potential subtle side-effects caused by a change from directly reassigning the prototype of the constructor using `ctor.prototype = Object.create(superCtor.prototype, { constructor: { ... } })` to using `Object.setPrototypeOf(ctor.prototype, superCtor.prototype)` (Michaël Zasso) #3455. * v8: (Breaking) Upgraded to 4.6.85.25 from 4.5.103.35 (Ali Ijaz Sheikh) #3351. - Implements the spread operator, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator for further information. - Implements new.target, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/new.target for further information. * zlib: Decompression now throws on truncated input (e.g. unexpected end of file) (Yuval Brik) #2595. PR-URL: #3466

targos added the console label Oct 3, 2015

targos force-pushed the targos:precise-console-time branch Oct 3, 2015

thefourtheye reviewed Oct 3, 2015
View changes

targos added the semver-minor label Oct 3, 2015

ChALkeR reviewed Oct 3, 2015
View changes

aheckmann reviewed Oct 5, 2015
View changes

targos removed the semver-minor label Oct 6, 2015

targos added this to the 5.0.0 milestone Oct 6, 2015

targos added the semver-major label Oct 6, 2015

targos force-pushed the targos:precise-console-time branch Oct 7, 2015

silverwind reviewed Oct 7, 2015
View changes

targos force-pushed the targos:precise-console-time branch 2 times, most recently Oct 8, 2015

Trott reviewed Oct 9, 2015
View changes

rvagg mentioned this pull request Oct 16, 2015

v5.0.0 Planning & Checklist #3397

Closed

13 of 13 tasks complete

targos added 3 commits Oct 7, 2015

console: sub-millisecond accuracy for console.time

419f7d4

This makes the output of console.timeEnd in line with major browsers. PR-URL: #3166 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

doc: reword description of console.time

fc72a57

PR-URL: #3166 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

targos force-pushed the targos:precise-console-time branch to 8c043c1 Oct 16, 2015

targos merged commit 8c043c1 into nodejs:master Oct 16, 2015

targos deleted the targos:precise-console-time branch Oct 16, 2015

targos added a commit that referenced this pull request Oct 19, 2015

doc: reword description of console.time

f6ebc82

PR-URL: #3166 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

rvagg mentioned this pull request Oct 21, 2015

Release proposal: v5.0.0 #3466

Merged

silverwind mentioned this pull request Oct 29, 2015

console: change doc to follow major browser console doc #3584

Closed

Krinkle mentioned this pull request Nov 2, 2015

Prefix commit subjects with semver level jquery/contribute.jquery.org#130

Closed

		@@ -74,16 +74,16 @@ Defaults to `false`. Colors are customizable, see below.

		### console.time(label)

nodejs / node

console: sub-millisecond accuracy for console.time #3166

console: sub-millisecond accuracy for console.time #3166

Conversation

targos commented Oct 3, 2015

targos commented Oct 3, 2015

This comment has been minimized.

thefourtheye Oct 3, 2015 Contributor

This comment has been minimized.

ChALkeR Oct 7, 2015 Member

This comment has been minimized.

targos Oct 8, 2015 Author Member

Trott commented Oct 3, 2015

Trott commented Oct 3, 2015

targos commented Oct 3, 2015

This comment has been minimized.

ChALkeR Oct 3, 2015 Member

This comment has been minimized.

ChALkeR Oct 3, 2015 Member

This comment has been minimized.

ChALkeR Oct 3, 2015 Member

ChALkeR commented Oct 3, 2015

targos commented Oct 4, 2015

This comment has been minimized.

aheckmann Oct 5, 2015 Contributor

This comment has been minimized.

targos Oct 5, 2015 Author Member

This comment has been minimized.

jasnell Oct 6, 2015 Member

This comment has been minimized.

ChALkeR Oct 7, 2015 Member

Fishrock123 commented Oct 6, 2015

targos commented Oct 6, 2015

targos commented Oct 7, 2015

This comment has been minimized.

silverwind Oct 7, 2015 Contributor

This comment has been minimized.

silverwind Oct 7, 2015 Contributor

This comment has been minimized.

targos Oct 8, 2015 Author Member

ChALkeR commented Oct 7, 2015

evanlucas commented Oct 8, 2015

Trott commented Oct 8, 2015

jasnell commented Oct 8, 2015

jasnell commented Oct 8, 2015

silverwind commented Oct 8, 2015

Trott commented Oct 8, 2015

trevnorris commented Oct 8, 2015

Trott commented Oct 8, 2015

targos commented Oct 8, 2015

Fishrock123 commented Oct 9, 2015

Fishrock123 commented Oct 9, 2015

targos commented Oct 9, 2015

This comment has been minimized.

Trott Oct 9, 2015 Member

This comment has been minimized.

targos Oct 9, 2015 Author Member

This comment has been minimized.

Trott Oct 9, 2015 Member

This comment has been minimized.

targos Oct 9, 2015 Author Member

This comment has been minimized.

Trott Oct 9, 2015 Member

Trott commented Oct 9, 2015

silverwind commented Oct 9, 2015

targos commented Oct 9, 2015

targos commented Oct 16, 2015

trevnorris commented Oct 16, 2015

targos commented Oct 16, 2015

thefourtheye Oct 3, 2015
Contributor

ChALkeR Oct 7, 2015
Member

targos Oct 8, 2015
Author Member

ChALkeR Oct 3, 2015
Member

ChALkeR Oct 3, 2015
Member

ChALkeR Oct 3, 2015
Member

aheckmann Oct 5, 2015
Contributor

targos Oct 5, 2015
Author Member

jasnell Oct 6, 2015
Member

ChALkeR Oct 7, 2015
Member

silverwind Oct 7, 2015
Contributor

silverwind Oct 7, 2015
Contributor

targos Oct 8, 2015
Author Member

Trott Oct 9, 2015
Member

targos Oct 9, 2015
Author Member

Trott Oct 9, 2015
Member

targos Oct 9, 2015
Author Member

Trott Oct 9, 2015
Member