events: allow use of AbortController with on

[jasnell]

Allows use of an AbortController with events.on(). This builds on #34911, which should land first.

const ee = new EventEmitter(); const ac = new AbortController(); const i = setInterval(() => ee.emit('foo', 'bar')); async function foo() { for await (const f of events.on(ee, 'foo', { signal: ac.signal })) console.log(f); } foo().catch((error) => { if (error.name === 'AbortError') console.error('Iteration was aborted!'); else console.error('There was an error:', error.message); }).finally(() => { clearInterval(i); }); process.nextTick(() => ac.abort());

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!

[nodejs-github-bot]

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

[benjamingr]

This is cool 👍

[github-actions]

Commit Queue failed

- Loading data for nodejs/node/pull/34912 ✔ Done loading data for nodejs/node/pull/34912 ----------------------------------- PR info ------------------------------------ Title events: allow use of AbortController with on (#34912) Author James M Snell (@jasnell) Branch jasnell:abortable-on -> nodejs:master Labels events, semver-minor Commits 7 - events: allow use of AbortController with once - fixup! events: allow use of AbortController with once - fixup! fixup! events: allow use of AbortController with once - fixup! fixup! fixup! events: allow use of AbortController with once - events: allow use of AbortController with on - fixup! events: allow use of AbortController with on - fixup! fixup! events: allow use of AbortController with on Committers 1 - James M Snell PR-URL: https://github.com/nodejs/node/pull/34912 Reviewed-By: Matteo Collina Reviewed-By: Benjamin Gruenbaum Reviewed-By: Denys Otrishko ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/34912 Reviewed-By: Matteo Collina Reviewed-By: Benjamin Gruenbaum Reviewed-By: Denys Otrishko -------------------------------------------------------------------------------- ℹ Last Full PR CI on 2020-08-24T23:10:20Z: https://ci.nodejs.org/job/node-test-pull-request/32923/ - Querying data of job/node-test-pull-request/32923/ ✔ Build data downloaded - Querying failures of job/node-test-commit/40437/ ✔ Data downloaded ✖ 3 failure(s) on the last Jenkins CI run ℹ This PR was created on Mon, 24 Aug 2020 20:52:55 GMT ✔ Approvals: 3 ✔ - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/34912#pullrequestreview-473854472 ✔ - Benjamin Gruenbaum (@benjamingr): https://github.com/nodejs/node/pull/34912#pullrequestreview-474479754 ✔ - Denys Otrishko (@lundibundi): https://github.com/nodejs/node/pull/34912#pullrequestreview-474674079 -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu

[jasnell]

@mcollina ... #34911 needs to land before this one

[lundibundi]

Also, commit-queue currently doesn't support PRs with more than just 1 commit (#34770). At least until we integrate #34770 (comment) (which is hopefully soon).

[nodejs-github-bot]

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

[nodejs-github-bot]

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

[jasnell]

Landed in df1023b