events: allow safely adding listener to abortSignal #48596
Conversation
nodejs-github-bot
added
needs-ci
atlowChemi
force-pushed
the
add-userLand-method-for-safely-adding-listener-to-abortSignal
branch
from
416dafb
to
d9f2b58
Compare
I wrote in the PRs description I want to do that after getting some feedback about the idea 🙈😅 |
atlowChemi
force-pushed
the
add-userLand-method-for-safely-adding-listener-to-abortSignal
branch
from
d9f2b58
to
0e45c8f
Compare
|
I need to think about this, but generally good. also cc @ronag |
lib/util.js
Outdated
| signal.addEventListener( | ||
| 'abort', | ||
| listener, | ||
| { __proto__: null, ...options, once: true, [kResistStopPropagation]: true }, |
There was a problem hiding this comment.
I think it makes sense to enforce the once option for the abort event, but I'd be happy to know if anyone thinks otherwise I'm happy to change 🙂
There was a problem hiding this comment.
once: true makes sense for me here (and also not accepting options).
I'm wondering if we should do
if (signal.aborted) {
queueMicrotask(() => listener())`
}(and either way the alternative is to at least check for signal.aborted since the behavior right now would be to add the listener and not do cleanup)
There was a problem hiding this comment.
I think I approached this with a different mindset than you 🙂
I was thinking of exposing a "safe" version of addEventListener.
I was thinking we could also use this internally for all places currently using kResistStopPropagation (even when they use kWeakHandler etc)
Since I was thinking of a safe implementation, I wanted it to behave quite the same, hence I accepted the options and did not check for aborted prior to adding the listener.
That said, I am happy to change this to work as you were expecting for it to work 🙂
There was a problem hiding this comment.
OK, I re-implemented, let me know what you think 🙂
There was a problem hiding this comment.
I was thinking of exposing a "safe" version of addEventListener.
Forgetting to cleanup if the signal is already aborted is a common bug and if we can help users with it that's good.
We can still use kWeakRef I believe? The idea of kWeakListener (or whatever we named it) is to prevent cases where the user forgets to remove the listener and the listener keeps a live reference to the object. I'm even less sure if we should expose it.
There was a problem hiding this comment.
Oh I was not talking of exposing it, just about allowing us to use it via this utility, in internal calls
doc/api/util.md
Outdated
| @@ -14,6 +14,60 @@ it: | |||
| const util = require('node:util'); | |||
| ``` | |||
|
|
|||
| ## `util.addSafeAbortSignalAbortListener(signal, resource)` | |||
There was a problem hiding this comment.
Bikeshed: can we get a shorter name? util.addAbortListener
There was a problem hiding this comment.
Sure, I was not happy with the name I gave, but was not sure what would be a good name 🙂
There was a problem hiding this comment.
Changed to your suggestion
It's actually hard to reason about new functionality without seeing an example and the best form of examples are tests. |
Makes sense, will keep that in mind 👍🏽 |
doc/api/util.md
Outdated
| // Do something when signal is aborted. | ||
| }); | ||
| } finally { | ||
| disposable?.[Symbol.dispose](); |
There was a problem hiding this comment.
Are we planning to backport Symbol.dispose to v18.x?
There was a problem hiding this comment.
There was a problem hiding this comment.
Yes, hopefully, why?
People building transpiled code and target v18.x should still benefit from it.
doc/api/util.md
Outdated
| **Default:** `false`. | ||
| * `signal` {AbortSignal} The listener will be removed when the given | ||
| AbortSignal object's `abort()` method is called. | ||
| * Returns: {Disposable} that removes the `abort` listener. |
There was a problem hiding this comment.
Do we need to return an object that is currently not standardized yet? Can we return something that we can control?
There was a problem hiding this comment.
Can we return something that we can control?
I'm also not sure how the docs should look and I'm not sure "disposable" is the name (is it?) but it's basically "something that has a Symbol.dispose".
Unlike AbortSignal/EventTarget - disposables are just a function call - so we control this.
There was a problem hiding this comment.
atlowChemi
force-pushed
the
add-userLand-method-for-safely-adding-listener-to-abortSignal
branch
from
0e45c8f
to
d8c8109
Compare
|
If we are doing this maybe we might as well expose the weak listener option as well? |
That can be a parameter so maybe: // Semantics are:
// when the signal aborts _or_ it's already aborted - close the file handle
// if the file handle goes out of scope - remove the listener
using addAbortListener(signal, () => fileHandle.close(), fileHandle);Do you think in terms oof footgun-ness to usefulness it's good enough to expose? |
atlowChemi
force-pushed
the
add-userLand-method-for-safely-adding-listener-to-abortSignal
branch
2 times, most recently
from
9717ae4
to
b708f4d
Compare
That makes sense to me, if anyone involved doesn't object I'll move it to |
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Refs: nodejs#48596 PR-URL: nodejs#52081 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: nodejs#52081 Refs: nodejs#48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: nodejs#52081 Refs: nodejs#48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: nodejs#52081 Refs: nodejs#48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: nodejs#52081 Refs: nodejs#48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: nodejs#52081 Refs: nodejs#48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: nodejs#52081 Refs: nodejs#48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: nodejs#52081 Refs: nodejs#48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: nodejs#52081 Refs: nodejs#48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Refs: #48596 PR-URL: #52081 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Refs: #48596 PR-URL: #52081 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #52081 Refs: #48596 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
I am not sure this is the correct way to expose such a util,
and I still need to add docs and UT, just wanted to get some feedback first 🙂Refs: #48550 (comment)
@mcollina @benjamingr CC