async_hooks,test: add test for async hooks parity for async/await #20626

MayaLekova · 2018-05-09T13:35:40Z

Add a basic test ensuring parity between before-after and
init-promiseResolve hooks when using async/await.

Refs: #20516

This is the first of a series of short commits adding a few conformance tests for async hooks. Using them will hopefully reduce the possibility of having regressions when we start to re-optimize the promises in V8. There will be separate tests in V8 as well.

Please feel free to give ideas about specific tests to include (the CLS use case is already planned) and if you prefer that I squash all the upcoming tests in a single commit or PR.

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

mcollina

Good work! I've left some notes!

mcollina · 2018-05-09T14:36:03Z

test/async-hooks/test-async-await.js

+                       'after hook called for promise without prior call' +
+                       'to before hook');
+    promiseCallbacks.set(asyncId, 0);
+  }


we should remove things from the map here.

Please check if this still applies to the new version - now the maps are more meant to reflect the state of the promises created, so IMO no need to clean them in the hooks.

mcollina · 2018-05-09T14:37:05Z

test/async-hooks/test-async-await.js

+const util = require('util');
+
+const sleep = util.promisify(setTimeout);
+const promiseCallbacks = new Map();


these are not really callbacks, or maybe I got it wrong. Can we use a more clear name?

Renamed, thanks.

mcollina · 2018-05-09T14:37:41Z

test/async-hooks/test-async-await.js

+    assert.strictEqual(promiseCallbacks.get(asyncId), 1,
+                       'after hook called for promise without prior call' +
+                       'to before hook');
+    promiseCallbacks.set(asyncId, 0);


I would prefer if we used something different from 0. Maybe can we use a string instead?

mcollina · 2018-05-09T14:40:06Z

test/async-hooks/test-async-await.js

+function checkPromiseCallbacks() {
+  for (const balance of promiseCallbacks.values()) {
+    assert.strictEqual(balance, 0,
+                       'mismatch between before and after hook calls');


this would not verify if before and init fired. I know that these events would not fire for each promise, but maybe we should verify that as well.

Reworked the test. The only thing currently missing is the check for double calls of 'promiseResolve' hook, which, for some reason, fails in Node.js 8 and 10.

mcollina · 2018-05-09T14:45:48Z

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

mcollina · 2018-05-09T14:53:12Z

cc @AndreasMadsen

AndreasMadsen · 2018-05-09T18:17:41Z

I'm not a huge fan of the test abstraction myself, but considering we are using it in every other test this should properly use:

const initHooks = require('./init-hooks');
const { checkInvocations } = require('./hook-checks');

for the validation.

Add a basic test ensuring parity between before-after and init-promiseResolve hooks when using async/await. Refs: nodejs#20516

Add ability to initHooks and to checkInvocations utilities to transmit promiseResolve hook as well. Refs: nodejs#20516

Reword async/await test to make use of the initHooks utility and an attempt to clarify the test's logic. Refs: nodejs#20516

mcollina · 2018-05-11T10:43:16Z

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

MayaLekova · 2018-05-11T10:46:04Z

Regarding the previous run of the CI, I looked through the Jenkins output and both failing jobs have this message: ERROR: Error fetching remote repo 'jenkins_tmp' - not sure it's related to the code change.

mcollina

LGTM

TimothyGu · 2018-05-13T19:37:19Z

test/async-hooks/test-async-await.js

+  checkPromisesExecutionState();
+}));
+
+async function asyncFunc(callback) {


Unused callback param

Thanks, removed.

Refs: nodejs#20516

bmeurer

LGTM

mcollina · 2018-05-14T08:45:30Z

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

mcollina · 2018-05-14T14:22:24Z

I think @TimothyGu comment has been addressed, landing now.

mcollina · 2018-05-14T14:27:11Z

Landed in e993e45

Add a basic test ensuring parity between before-after and init-promiseResolve hooks when using async/await. Add ability to initHooks and to checkInvocations utilities to transmit promiseResolve hook as well. See: #20516 PR-URL: #20626 Refs: #20516 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Benedikt Meurer <benedikt.meurer@gmail.com>

mcollina · 2018-05-14T14:29:30Z

Congrats for your first PR to Node.js @MayaLekova!

Add a basic test ensuring parity between before-after and init-promiseResolve hooks when using async/await. Add ability to initHooks and to checkInvocations utilities to transmit promiseResolve hook as well. See: #20516 PR-URL: #20626 Refs: #20516 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Benedikt Meurer <benedikt.meurer@gmail.com>

Add a basic test ensuring parity between before-after and init-promiseResolve hooks when using async/await. Add ability to initHooks and to checkInvocations utilities to transmit promiseResolve hook as well. See: nodejs#20516 PR-URL: nodejs#20626 Refs: nodejs#20516 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Benedikt Meurer <benedikt.meurer@gmail.com>

nodejs-github-bot added async_hooks Issues and PRs related to the async hooks subsystem. test Issues and PRs related to the tests. labels May 9, 2018

mcollina reviewed May 9, 2018

View reviewed changes

jasnell approved these changes May 9, 2018

View reviewed changes

MayaLekova added 3 commits May 11, 2018 11:49

async_hooks,test: add test for async hooks parity for async/await

64a2c4b

Add a basic test ensuring parity between before-after and init-promiseResolve hooks when using async/await. Refs: nodejs#20516

async_hooks,test: enhance initHooks with promiseResolve hook

35b8fcf

Add ability to initHooks and to checkInvocations utilities to transmit promiseResolve hook as well. Refs: nodejs#20516

async_hooks,test: refactor async/await test to use initHooks

dc98e80

Reword async/await test to make use of the initHooks utility and an attempt to clarify the test's logic. Refs: nodejs#20516

MayaLekova force-pushed the fix-async-hooks branch from 0475116 to dc98e80 Compare May 11, 2018 10:37

mcollina approved these changes May 11, 2018

View reviewed changes

benjamingr approved these changes May 13, 2018

View reviewed changes

TimothyGu reviewed May 13, 2018

View reviewed changes

async_hooks,test: remove unused param from async/await test

d70af92

Refs: nodejs#20516

bmeurer approved these changes May 14, 2018

View reviewed changes

mcollina closed this May 14, 2018

addaleax mentioned this pull request May 14, 2018

v10.2.0 proposal #20724

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

async_hooks,test: add test for async hooks parity for async/await #20626

async_hooks,test: add test for async hooks parity for async/await #20626

MayaLekova commented May 9, 2018

mcollina left a comment

mcollina May 9, 2018

MayaLekova May 11, 2018

mcollina May 9, 2018

MayaLekova May 11, 2018

mcollina May 9, 2018

MayaLekova May 11, 2018

mcollina May 9, 2018

MayaLekova May 11, 2018

mcollina commented May 9, 2018

mcollina commented May 9, 2018

AndreasMadsen commented May 9, 2018

mcollina commented May 11, 2018 •

edited

Loading

MayaLekova commented May 11, 2018

mcollina left a comment

TimothyGu May 13, 2018

MayaLekova May 14, 2018

bmeurer left a comment

mcollina commented May 14, 2018

mcollina commented May 14, 2018

mcollina commented May 14, 2018

mcollina commented May 14, 2018

async_hooks,test: add test for async hooks parity for async/await #20626

async_hooks,test: add test for async hooks parity for async/await #20626

Conversation

MayaLekova commented May 9, 2018

Checklist

mcollina left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcollina commented May 9, 2018

mcollina commented May 9, 2018

AndreasMadsen commented May 9, 2018

mcollina commented May 11, 2018 • edited Loading

MayaLekova commented May 11, 2018

mcollina left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bmeurer left a comment

Choose a reason for hiding this comment

mcollina commented May 14, 2018

mcollina commented May 14, 2018

mcollina commented May 14, 2018

mcollina commented May 14, 2018

mcollina commented May 11, 2018 •

edited

Loading