events: allow use of AbortController with on by jasnell · Pull Request #34912 · nodejs/node · GitHub

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

good work!

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

This is cool 👍

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

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

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).

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

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

Signed-off-by: James M Snell <jasnell@gmail.com>

Landed in df1023b

Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: #34912 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: nodejs#34912 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

This was missed in the original PR. Refs: nodejs#34912

This was missed in the original PR. Refs: #34912 PR-URL: #37965 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: nodejs#34912 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: #34912 Backport-PR-URL: #38386 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

This was missed in the original PR. Refs: #34912 PR-URL: #37965 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

nodejs-github-bot added the events Issues and PRs related to the events subsystem / EventEmitter. label Aug 24, 2020

jasnell force-pushed the abortable-on branch from c037247 to e590f54 Compare August 24, 2020 20:54

jasnell added the semver-minor PRs that contain new features and should be released in the next minor version. label Aug 24, 2020

mcollina approved these changes Aug 24, 2020

View reviewed changes

jasnell force-pushed the abortable-on branch from e590f54 to 05e0b6e Compare August 24, 2020 21:33

jasnell added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 24, 2020

jasnell force-pushed the abortable-on branch from 05e0b6e to a99628f Compare August 24, 2020 21:35

github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 24, 2020

This comment has been minimized.

Sign in to view

jasnell added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 24, 2020

github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 24, 2020

github-actions Bot mentioned this pull request Aug 25, 2020

CI Reliability 2020-08-25 nodejs/reliability#54

Open

11 tasks

benjamingr approved these changes Aug 25, 2020

View reviewed changes

lundibundi approved these changes Aug 25, 2020

View reviewed changes

Comment thread lib/events.js Outdated

Comment thread test/parallel/test-event-on-async-iterator.js Outdated

github-actions Bot mentioned this pull request Aug 26, 2020

CI Reliability 2020-08-26 nodejs/reliability#55

Open

9 tasks

mcollina added the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 26, 2020

github-actions Bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 26, 2020

github-actions Bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Aug 26, 2020

github-actions Bot mentioned this pull request Aug 27, 2020

CI Reliability 2020-08-27 nodejs/reliability#56

Open

10 tasks

jasnell force-pushed the abortable-on branch from 08a96ca to 3fbe212 Compare August 27, 2020 16:14

jasnell added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 27, 2020

github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 27, 2020

lundibundi reviewed Aug 28, 2020

View reviewed changes

Comment thread lib/events.js Outdated

events: allow use of AbortController with on

5394928

Signed-off-by: James M Snell <jasnell@gmail.com>

jasnell force-pushed the abortable-on branch from 3fbe212 to 5394928 Compare September 2, 2020 14:50

jasnell closed this Sep 2, 2020

richardlau added dont-land-on-v12.x labels Sep 2, 2020

addaleax added a commit to addaleax/node that referenced this pull request Mar 29, 2021

doc: add missing events.on metadata

6609047

This was missed in the original PR. Refs: nodejs#34912

addaleax mentioned this pull request Mar 29, 2021

doc: add missing events.on metadata #37965

Closed

targos added backport-open-v14.x and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. dont-land-on-v14.x labels Apr 24, 2021

targos mentioned this pull request Apr 24, 2021

[v14.x] Backport AbortController and friends #38386

Closed

targos added backported-to-v14.x and removed backport-open-v14.x labels Apr 30, 2021

danielleadams mentioned this pull request May 3, 2021

v14.17.0 proposal #38507

Merged

events: allow use of AbortController with on by jasnell · Pull Request #34912 · nodejs/node · GitHub

Uh oh!

Uh oh!

events: allow use of AbortController with on - #34912

events: allow use of AbortController with on#34912
jasnell wants to merge 1 commit into
nodejs:masterfrom
jasnell:abortable-on

jasnell commented Aug 24, 2020

Uh oh!

mcollina left a comment

Uh oh!

This comment has been minimized.

nodejs-github-bot commented Aug 24, 2020

Uh oh!

benjamingr left a comment

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Aug 26, 2020

Uh oh!

jasnell commented Aug 27, 2020

Uh oh!

lundibundi commented Aug 27, 2020

Uh oh!

nodejs-github-bot commented Aug 27, 2020

Uh oh!

Uh oh!

nodejs-github-bot commented Aug 28, 2020

Uh oh!

jasnell commented Sep 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

events: allow use of AbortController with on by jasnell · Pull Request #34912 · nodejs/node · GitHub

Uh oh!

Uh oh!

events: allow use of AbortController with on - #34912

events: allow use of AbortController with on#34912jasnell wants to merge 1 commit intonodejs:masternodejs/node:masterfrom jasnell:abortable-onjasnell/node:abortable-onCopy head branch name to clipboard

Conversation

jasnell commented Aug 24, 2020

Checklist

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

nodejs-github-bot commented Aug 24, 2020

Uh oh!

benjamingr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Aug 26, 2020

Uh oh!

jasnell commented Aug 27, 2020

Uh oh!

lundibundi commented Aug 27, 2020

Uh oh!

nodejs-github-bot commented Aug 27, 2020

Uh oh!

Uh oh!

nodejs-github-bot commented Aug 28, 2020

Uh oh!

jasnell commented Sep 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

events: allow use of AbortController with on#34912
jasnell wants to merge 1 commit into
nodejs:masterfrom
jasnell:abortable-on