Skip to content

Commit

Permalink
test_runner: run top level tests in a microtask
Browse files Browse the repository at this point in the history
This commit updates the test harness to prevent top level
tests from executing immediately. This allows certain config
data, such as filtering options, to be discovered before running
the tests.

PR-URL: #52092
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
  • Loading branch information
cjihrig authored and marco-ippolito committed May 23, 2024
1 parent 77e2bf0 commit e2ae436
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 2 deletions.
13 changes: 12 additions & 1 deletion lib/internal/test_runner/harness.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ const {
setupTestReporters,
shouldColorizeTestFiles,
} = require('internal/test_runner/utils');
const { queueMicrotask } = require('internal/process/task_queues');
const { bigint: hrtime } = process.hrtime;

const testResources = new SafeMap();
Expand Down Expand Up @@ -189,6 +190,7 @@ function setup(root) {

root.harness = {
__proto__: null,
allowTestsToRun: false,
bootstrapComplete: false,
watching: false,
coverage: FunctionPrototypeBind(collectCoverage, null, root, coverage),
Expand Down Expand Up @@ -232,7 +234,16 @@ function getGlobalRoot() {

async function startSubtest(subtest) {
await reportersSetup;
getGlobalRoot().harness.bootstrapComplete = true;

const root = getGlobalRoot();
if (!root.harness.bootstrapComplete) {
root.harness.bootstrapComplete = true;
queueMicrotask(() => {
root.harness.allowTestsToRun = true;
root.processPendingSubtests();
});
}

await subtest.start();
}

Expand Down
1 change: 1 addition & 0 deletions lib/internal/test_runner/runner.js
Original file line number Diff line number Diff line change
Expand Up @@ -590,6 +590,7 @@ function run(options) {
}
const runFiles = () => {
root.harness.bootstrapComplete = true;
root.harness.allowTestsToRun = true;
return SafePromiseAllSettledReturnVoid(testFiles, (path) => {
const subtest = runTestFile(path, filesWatcher, opts);
filesWatcher?.runningSubtests.set(path, subtest);
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/test_runner/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,7 @@ class Test extends AsyncResource {
// it. Otherwise, return a Promise to the caller and mark the test as
// pending for later execution.
this.reporter.enqueue(this.nesting, this.loc, this.name);
if (!this.parent.hasConcurrency()) {
if (!this.root.harness.allowTestsToRun || !this.parent.hasConcurrency()) {
const deferred = createDeferredPromise();

deferred.test = this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ not ok 1 - fails
*
*
*
*
*
*
...
1..1
# tests 1
Expand Down

0 comments on commit e2ae436

Please sign in to comment.