test_runner: allow adapters to handle individual unhandled promise rejections
Personne n'a encore pris cette issue.
- Langage dominant
- JavaScript
- Étoiles
- 122k
- Forks
- 37.3k
- Merge moyen
- 4 j 2 h
- PR mergées (30 j)
- 283
Description
What is the problem this feature will solve?
(AI disclosure: text written by GPT-6 Astra Extra High, then read, tweaked, and signed-off on by @domenic.)
We are migrating jsdom's tests to node:test. Our Web Platform Tests adapter runs each WPT file inside a jsdom instance, waits for the embedded testharness.js harness to finish, and checks its results against our expectations.
Some WPTs deliberately produce unhandled rejections in iframe windows. These do not necessarily constitute failures of the parent window's test harness. Other rejections should become harness failures, which the adapter needs to evaluate against expected failures for unimplemented functionality.
Currently, node:test fails and aborts the enclosing test when it observes an unhandled rejection, before our adapter can finish evaluating the WPT. Adding our own process.on("unhandledRejection") listener does not prevent the test runner from independently failing the test.
We need a supported way for an embedded test harness to take responsibility for selected rejections, while preserving normal test-runner failure handling for unrelated rejections.
What is the feature you are proposing to solve the problem?
A per-test hook that can handle individual unhandled rejections before the test runner automatically fails or aborts the test.
For example, the API could look like this:
test("embedded harness", {
onUnhandledRejection(reason, promise) {
if (!adapter.ownsPromise(promise)) {
return false;
}
adapter.recordUnhandledRejection(reason, promise);
return true;
}
}, async () => {
await adapter.run();
adapter.assertExpectedResults();
});
The important capabilities would be:
- The hook receives both the rejection reason and the actual promise, allowing the adapter to identify ownership.
- Returning
trueindicates that the adapter accepts responsibility for the rejection. The test runner does not automatically fail or abort the test for that rejection. - Returning
falseorundefinedpreserves current behavior. Throwing from the hook fails the test.
A couple more points GPT-6 Astra Extra High thought were important to include, but seem obvious to @domenic
- Rejections are attributed to the originating test's asynchronous context, including rejections reported after that test finishes. A claimed late rejection should not independently cause the test file to fail; unclaimed late rejections should retain current behavior.
- The hook controls only the test runner's response. It does not suppress other process listeners or change the process's configured unhandled-rejection policy.
This would let adapters classify rejections and finish checking their results without requiring Node to understand the embedded harness's semantics. The adapter would remain responsible for waiting for relevant rejection notifications before completing its test.
What alternatives have you considered?
Stuff that doesn't work that we tried
- Adding a process-level
unhandledRejectionlistener, including a prepended listener. The test runner still receives the event and fails the test. - Using
--unhandled-rejections=none. This suppresses warnings, but does not prevent the test runner from failing the test. - Using
expectFailure. This still lets the runner fail and abort the test instead of letting the embedded harness finish evaluating its results.
Stuff that works but is icky
- Wrapping
process.emitto intercept selected rejection events. Small probes work on Node 22, 24, and 26 while preserving failure handling for unrelated rejections, but this requires monkeypatching and depends on the runner's reporting mechanism. - Using
node:domain. This can redirect rejections, but the API is deprecated and affects more than rejection reporting. - Running the embedded harness in a separate process. This provides control over rejection handling, but adds process management and communication infrastructure.
- Skipping the affected tests. This avoids the immediate failures but loses regression coverage compared to mocha.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la gestion actuelle des rejections non gérées du runner node:test, en utilisant le scénario de l’adaptateur WPT de jsdom et les alternatives au niveau du processus listées comme contexte de reproduction. Définissez la couverture des rejections prises en charge, non prises en charge, déclenchées et tardives ; le travail est terminé lorsque des tests ciblés confirment que les rejections prises en charge n’interrompent pas le test englobant, tandis que les rejections sans rapport conservent le comportement actuel.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, node.js
- Domaine
- testing-qa
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- Active
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100