doc: add test reporter event lifecycle diagram - #63780
Open
Han5991 wants to merge 3 commits into
Open
Conversation
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
atlowChemi
approved these changes
Jun 8, 2026
Member
|
Ping @MoLow |
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
Member
|
This needs a rebase to resolve conflicts in |
Document the lifecycle of node:test reporter events under Class: TestsStream, with an ASCII diagram that distinguishes declaration-order events from their execution-order twins (test:dequeue/test:complete), the leaf vs suite flow, and the run-level finale. Fixes: nodejs#51908 Signed-off-by: sangwook <rewq5991@gmail.com>
Han5991
force-pushed
the
doc/test-reporter-events-lifecycle
branch
from
August 24, 2026 11:24
bddf765 to
6763fea
Compare
Contributor
Author
|
I pushed to resolve the issue, so please approve it again. |
atlowChemi
reviewed
Aug 25, 2026
Member
There was a problem hiding this comment.
@Han5991 this mostly LGTM. Should this also mention test:interrupted?
The diagram only covered the normal path, ending at test:summary. Add an INTERRUPTION branch so the abnormal path is covered too: on SIGINT the run exits before the buffered declaration ordered events are flushed, so neither the run level finale nor the interrupted tests' own results are emitted. Signed-off-by: sangwook <rewq5991@gmail.com>
Contributor
Author
It would be good to add that! I've added it. |
The lint-js-and-md job hit the 15 minute job execution limit on the previous push; eslint alone took 11m30s on that runner. Empty commit to re-run the linters. Signed-off-by: sangwook <rewq5991@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an "Event lifecycle" section under
Class: TestsStreamwith an ASCII diagram showing how reporter events relate: declaration-order events vs their execution-order twins (test:dequeue/test:complete), the leaf vs suite flow, and the run-level finale.Fixes: #51908