test: add constructor test to async-hooks #13096

Shadowbeetle · 2017-05-18T08:11:49Z

Checklist

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

Affected core subsystem(s)

async-hooks

[refack edit: removed documentation checkbox, as it seems it is not needed for this PR]

mscdex · 2017-05-18T08:34:58Z

lib/async_hooks.js

@@ -77,13 +77,13 @@ function fatalError(e) {

 class AsyncHook {
  constructor({ init, before, after, destroy }) {
-    if (init && typeof init !== 'function')
+    if (typeof init !== 'undefined' && typeof init !== 'function')


Why these changes?

Because without them it will accept false without throwing, which I assume is not the expected behaviour

I see. Can we at least use init !== undefined instead? That is the form we use elsewhere in core.

addaleax · 2017-05-18T10:33:36Z

test/parallel/test-async-wrap-constructor.js

+  async_hooks.createHook({ init: 1 })
+} catch (err) {
+  assert.equal(err.message, 'init must be a function')
+}


Can you re-phrase these using assert.throws? e.g.

assert.throws(() => { async_hooks.createHook({ init: 1 }); }, /^TypeError: init must be a function$/);

(Also, please make sure that make lint passes :))

Thanks! I have updated the commit.

addaleax · 2017-05-18T10:57:46Z

test/parallel/test-async-wrap-constructor.js

+if (!common.hasCrypto) {
+  common.skip('missing crypto');
+  return;
+}


Is this block copy-pased or did you check that it is necessary?

Shame on me, completely copy-pasted and unnecessary. I have updated the commit.

AndreasMadsen · 2017-05-18T20:53:19Z

Thanks for taking the time to fix this.

Because without them it will accept false without throwing, which I assume is not the expected behaviour

Could you add those details to the commit message, "test: add constructor test to async-hooks" is a little vague. Since this changes something in the actual async_hooks code you should also prefix the commit message with async_hooks: instead of test: .

refack · 2017-05-18T22:16:12Z

test/parallel/test-async-wrap-constructor.js

+const assert = require('assert');
+const async_hooks = require('async_hooks');
+
+assert.throws(() => {


@Shadowbeetle you gave false as a previously failing argument. Could you add a set of tests with false?
This could be done in a double loop:

for (let badArg of [1, false, true, null, undefined, 'hello']) { for (let field of ['init', 'before', 'after', 'destroy']) { assert.throws(() => { async_hooks.createHook({ [field]: badArg }); }, /^TypeError: before must be a function$/); } }

@refack Thanks, I have included this with a minor change in the commit.

refack

💯

refack · 2017-05-19T11:52:26Z

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

refack · 2017-05-19T12:33:40Z

test/parallel/test-async-wrap-constructor.js

@@ -0,0 +1,12 @@
+'use strict';
+require('../common');
+const assert = require('assert');


Could you add a couple of lines describing what this is testing
https://github.com/nodejs/node/blob/master/doc/guides/writing-tests.md

refack · 2017-05-19T12:34:10Z

test/parallel/test-async-wrap-constructor.js

+  for (const field of ['init', 'before', 'after', 'destroy']) {
+    assert.throws(() => {
+      async_hooks.createHook({ [field]: badArg });
+    }, new RegExp(`^TypeError: ${field} must be a function$`), );


I think the dangling , is a lint error

Shadowbeetle · 2017-05-19T12:34:41Z

Sorry, an extra space sneaked in that broke the lint

AndreasMadsen · 2017-05-19T13:40:55Z

@Shadowbeetle Sorry if what I said was poorly explained, but we need to conform to the commit message guidelines, you can read them here https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#commit-message-guidelines

Something like this should be fine:

async_hooks: add constructor check to AsyncHook

This fixes the async_hooks.AsyncHook constructor such that it throws an error
when provided with falsy values other than undefined.

This fixes the async_hooks.AsyncHook constructor such that it throws an error when provided with falsy values other than undefined.

Shadowbeetle · 2017-05-19T13:54:46Z

@AndreasMadsen I see, sorry I should have read the guidelines more thoroughly. Updated the commit message.

AndreasMadsen · 2017-05-20T09:24:41Z

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

This fixes the async_hooks.AsyncHook constructor such that it throws an error when provided with falsy values other than undefined. PR-URL: #13096 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Andreas Madsen <amwebdk@gmail.com>

AndreasMadsen · 2017-05-21T20:31:12Z

@Shadowbeetle Thanks for your contribution, the commit landed in 6fb27af

PS: I fixed the commit message linebreak and test comment on merge.

refack · 2017-05-21T20:32:27Z

Congrats @Shadowbeetle on your first contribution 🥇
And @AndreasMadsen on your first land 😉

AndreasMadsen · 2017-05-21T20:34:11Z

@refack Thanks. I have landed a few commits, but it has been a while :)

Shadowbeetle · 2017-05-22T07:04:46Z

thanks to everybody for all the help

MylesBorins · 2017-07-17T14:59:04Z

This should likely be part of a larger sync hooks backport

nodejs-github-bot added the async_hooks Issues and PRs related to the async hooks subsystem. label May 18, 2017

mscdex reviewed May 18, 2017

View reviewed changes

addaleax reviewed May 18, 2017

View reviewed changes

Shadowbeetle force-pushed the master branch from 6856908 to 9f29a9f Compare May 18, 2017 10:54

addaleax approved these changes May 18, 2017

View reviewed changes

Shadowbeetle force-pushed the master branch from 9f29a9f to 7a109e6 Compare May 18, 2017 11:07

cjihrig approved these changes May 18, 2017

View reviewed changes

refack reviewed May 18, 2017

View reviewed changes

refack approved these changes May 18, 2017

View reviewed changes

Shadowbeetle force-pushed the master branch from 7a109e6 to 30d1475 Compare May 19, 2017 08:15

refack approved these changes May 19, 2017

View reviewed changes

refack reviewed May 19, 2017

View reviewed changes

Shadowbeetle force-pushed the master branch from 30d1475 to 230425a Compare May 19, 2017 12:33

refack reviewed May 19, 2017

View reviewed changes

async_hooks: add constructor check to async-hooks

2913074

This fixes the async_hooks.AsyncHook constructor such that it throws an error when provided with falsy values other than undefined.

Shadowbeetle force-pushed the master branch from 230425a to 2913074 Compare May 19, 2017 13:52

AndreasMadsen closed this May 21, 2017

jasnell mentioned this pull request May 28, 2017

8.0.0 Release Proposal #12220

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

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

AndreasMadsen added dont-land-on-v6.x and removed lts-watch-v6.x labels Jul 18, 2017

Uh oh!

test: add constructor test to async-hooks #13096

test: add constructor test to async-hooks #13096

Uh oh!

Conversation

Shadowbeetle commented May 18, 2017 • edited by refack Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Affected core subsystem(s)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mscdex May 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndreasMadsen commented May 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

refack May 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

refack left a comment

Choose a reason for hiding this comment

Uh oh!

refack commented May 19, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Shadowbeetle commented May 19, 2017

Uh oh!

AndreasMadsen commented May 19, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Shadowbeetle commented May 19, 2017

Uh oh!

AndreasMadsen commented May 20, 2017

Uh oh!

AndreasMadsen commented May 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

refack commented May 21, 2017

Uh oh!

AndreasMadsen commented May 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Shadowbeetle commented May 22, 2017

Uh oh!

MylesBorins commented Jul 17, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Shadowbeetle commented May 18, 2017 •

edited by refack

Loading

mscdex May 18, 2017 •

edited

Loading

AndreasMadsen commented May 18, 2017 •

edited

Loading

refack May 18, 2017 •

edited

Loading

AndreasMadsen commented May 19, 2017 •

edited

Loading

AndreasMadsen commented May 21, 2017 •

edited

Loading

AndreasMadsen commented May 21, 2017 •

edited

Loading