doc, module: change stability of async customization hooks to experimental #60302
Conversation
|
Review requested:
|
nodejs-github-bot
added
doc
Flarna
force-pushed
the
loaderhooks-experimental
branch
2 times, most recently
from
686506b to
31c0694
Compare
Flarna
force-pushed
the
loaderhooks-experimental
branch
2 times, most recently
from
df81a7d to
f036b18
Compare
| <!-- type=misc --> | ||
| > Stability: 1.2 - Release candidate (asynchronous version) | ||
| > Stability: 1 - Experimental (asynchronous version) |
There was a problem hiding this comment.
Any stability level 1.x is experimental. See https://nodejs.org/docs/latest/api/documentation.html#stability-index
We don’t really have a level for “pending removal” so maybe the most appropriate level is the most experimental one:
| > Stability: 1 - Experimental (asynchronous version) | |
| > Stability: 1.0 - Early development (asynchronous version) |
There was a problem hiding this comment.
It's not early development though
There was a problem hiding this comment.
I think deprecated would be the state for pending removal but that seems too early to me.
I selected a similar state/wording as for async_hooks (except the migration hints) because it seems very similar:
- no 100% replacement as of now
- works fine for some usecases
- has flows which can't/are not planned to be fixed
- high overhead at least in some cases
There was a problem hiding this comment.
It was decided that "deprecated" was reserved for stable features:
Lines 48 to 49 in 38bf955
There was a problem hiding this comment.
Maybe just create a new stage like 1.9 - Pending removal? And we can add a note next to it that the sync hooks are the intended replacement.
There was a problem hiding this comment.
If neither 1.2 - Release candidate nor 1.0 - Early Development makes sense, maybe 1.1 - Active development ?
I feel that whether/when to remove it would be a different question due to the existing usage, but it somewhat certain that even if it stays, it would have to have changes in order to be really functional - there are too many quirks right now.
mcollina
added
the
tsc-agenda
There is ongoing work to replace async customization hooks by a synchronous variant. As a result bugs/design flaws or the async variant (thread leak, overhead) are not addressed. Adapt stability index to avoid wrong assumptions they might move to stable. Refs: nodejs/loaders#201 Refs: nodejs/loaders#198
Co-authored-by: Antoine du Hamel <[email protected]>
Flarna
force-pushed
the
loaderhooks-experimental
branch
from
ae4d294 to
1690620
Compare
Flarna
added
the
commit-queue-squash
|
FWIW #59666 lists some of the existing bugs in the async cutomization hooks that can explain why this is a bit too far from "release candidate" (they are not yet documented as "known caveats", but have existed from v20) |
8 participants
There is ongoing work to replace async customization hooks by a synchronous variant. As a result bugs/design flaws or the async variant (thread leak, overhead) are not addressed.
Adapt stability index to avoid wrong assumptions they might move to stable.
Refs: nodejs/loaders#201
Refs: nodejs/loaders#198