test_runner: add enqueue and dequeue events

MoLow · RafaelGSS · commit de4f14c249fb · 2023-07-03T10:36:49.000-03:00
PR-URL: #48428 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
diff --git a/doc/api/test.md b/doc/api/test.md
@@ -1459,6 +1459,16 @@ object, streaming a series of events representing the execution of the tests.
 
 Emitted when code coverage is enabled and all tests have completed.
 
+### Event: `'test:dequeue'`
+
+* `data` {Object}
+  * `file` {string|undefined} The path of the test file,
+    undefined if test is not ran through a file.
+  * `name` {string} The test name.
+  * `nesting` {number} The nesting level of the test.
+
+Emitted when a test is dequeued, right before it is executed.
+
 ### Event: `'test:diagnostic'`
 
 * `data` {Object}
@@ -1469,6 +1479,16 @@ Emitted when code coverage is enabled and all tests have completed.
 
 Emitted when [`context.diagnostic`][] is called.
 
+### Event: `'test:enqueue'`
+
+* `data` {Object}
+  * `file` {string|undefined} The path of the test file,
+    undefined if test is not ran through a file.
+  * `name` {string} The test name.
+  * `nesting` {number} The nesting level of the test.
+
+Emitted when a test is enqueued for execution.
+
 ### Event: `'test:fail'`
 
 * `data` {Object}
@@ -1518,7 +1538,9 @@ Emitted when all subtests have completed for a given test.
   * `name` {string} The test name.
   * `nesting` {number} The nesting level of the test.
 
-Emitted when a test starts.
+Emitted when a test starts reporting its own and its subtests status.
+This event is guaranteed to be emitted in the same order as the tests are
+defined.
 
 ### Event: `'test:stderr'`
 
diff --git a/lib/internal/test_runner/test.js b/lib/internal/test_runner/test.js
@@ -311,7 +311,9 @@ class Test extends AsyncResource {
   async processPendingSubtests() {
     while (this.pendingSubtests.length > 0 && this.hasConcurrency()) {
       const deferred = ArrayPrototypeShift(this.pendingSubtests);
-      await deferred.test.run();
+      const test = deferred.test;
+      this.reporter.dequeue(test.nesting, kFilename, test.name);
+      await test.run();
       deferred.resolve();
     }
   }
@@ -469,6 +471,7 @@ class Test extends AsyncResource {
     // If there is enough available concurrency to run the test now, then do
     // it. Otherwise, return a Promise to the caller and mark the test as
     // pending for later execution.
+    this.reporter.enqueue(this.nesting, kFilename, this.name);
     if (!this.parent.hasConcurrency()) {
       const deferred = createDeferredPromise();
 
@@ -477,6 +480,7 @@ class Test extends AsyncResource {
       return deferred.promise;
     }
 
+    this.reporter.dequeue(this.nesting, kFilename, this.name);
     return this.run();
   }
 
diff --git a/lib/internal/test_runner/tests_stream.js b/lib/internal/test_runner/tests_stream.js
@@ -49,6 +49,14 @@ class TestsStream extends Readable {
     return { __proto__: null, todo: reason ?? true };
   }
 
+  enqueue(nesting, file, name) {
+    this[kEmitMessage]('test:enqueue', { __proto__: null, nesting, file, name });
+  }
+
+  dequeue(nesting, file, name) {
+    this[kEmitMessage]('test:dequeue', { __proto__: null, nesting, file, name });
+  }
+
   start(nesting, file, name) {
     this[kEmitMessage]('test:start', { __proto__: null, nesting, file, name });
   }
diff --git a/test/parallel/test-runner-reporters.js b/test/parallel/test-runner-reporters.js
@@ -97,7 +97,7 @@ describe('node:test reporters', { concurrency: true }, () => {
                                testFile]);
       assert.strictEqual(child.stderr.toString(), '');
       const stdout = child.stdout.toString();
-      assert.match(stdout, /{"test:start":4,"test:pass":2,"test:fail":2,"test:plan":2,"test:diagnostic":\d+}$/);
+      assert.match(stdout, /{"test:enqueue":5,"test:dequeue":5,"test:start":4,"test:pass":2,"test:fail":2,"test:plan":2,"test:diagnostic":\d+}$/);
       assert.strictEqual(stdout.slice(0, filename.length + 2), `${filename} {`);
     });
   });
@@ -109,7 +109,7 @@ describe('node:test reporters', { concurrency: true }, () => {
     assert.strictEqual(child.stderr.toString(), '');
     assert.match(
       child.stdout.toString(),
-      /^package: reporter-cjs{"test:start":4,"test:pass":2,"test:fail":2,"test:plan":2,"test:diagnostic":\d+}$/,
+      /^package: reporter-cjs{"test:enqueue":5,"test:dequeue":5,"test:start":4,"test:pass":2,"test:fail":2,"test:plan":2,"test:diagnostic":\d+}$/,
     );
   });
 
@@ -120,7 +120,7 @@ describe('node:test reporters', { concurrency: true }, () => {
     assert.strictEqual(child.stderr.toString(), '');
     assert.match(
       child.stdout.toString(),
-      /^package: reporter-esm{"test:start":4,"test:pass":2,"test:fail":2,"test:plan":2,"test:diagnostic":\d+}$/,
+      /^package: reporter-esm{"test:enqueue":5,"test:dequeue":5,"test:start":4,"test:pass":2,"test:fail":2,"test:plan":2,"test:diagnostic":\d+}$/,
     );
   });
 

Original file line number	Diff line number	Diff line change
`@@ -311,7 +311,9 @@ class Test extends AsyncResource {`
`311`	`311`	`async processPendingSubtests() {`
`312`	`312`	`while (this.pendingSubtests.length > 0 && this.hasConcurrency()) {`
`313`	`313`	`const deferred = ArrayPrototypeShift(this.pendingSubtests);`
`314`		`- await deferred.test.run();`
	`314`	`+ const test = deferred.test;`
	`315`	`+ this.reporter.dequeue(test.nesting, kFilename, test.name);`
	`316`	`+ await test.run();`
`315`	`317`	`deferred.resolve();`
`316`	`318`	`}`
`317`	`319`	`}`
`@@ -469,6 +471,7 @@ class Test extends AsyncResource {`
`469`	`471`	`// If there is enough available concurrency to run the test now, then do`
`470`	`472`	`// it. Otherwise, return a Promise to the caller and mark the test as`
`471`	`473`	`// pending for later execution.`
	`474`	`+ this.reporter.enqueue(this.nesting, kFilename, this.name);`
`472`	`475`	`if (!this.parent.hasConcurrency()) {`
`473`	`476`	`const deferred = createDeferredPromise();`
`474`	`477`
`@@ -477,6 +480,7 @@ class Test extends AsyncResource {`
`477`	`480`	`return deferred.promise;`
`478`	`481`	`}`
`479`	`482`
	`483`	`+ this.reporter.dequeue(this.nesting, kFilename, this.name);`
`480`	`484`	`return this.run();`
`481`	`485`	`}`
`482`	`486`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,14 @@ class TestsStream extends Readable {`
`49`	`49`	`return { __proto__: null, todo: reason ?? true };`
`50`	`50`	`}`
`51`	`51`
	`52`	`+ enqueue(nesting, file, name) {`
	`53`	`+ this[kEmitMessage]('test:enqueue', { __proto__: null, nesting, file, name });`
	`54`	`+ }`
	`55`	`+`
	`56`	`+ dequeue(nesting, file, name) {`
	`57`	`+ this[kEmitMessage]('test:dequeue', { __proto__: null, nesting, file, name });`
	`58`	`+ }`
	`59`	`+`
`52`	`60`	`start(nesting, file, name) {`
`53`	`61`	`this[kEmitMessage]('test:start', { __proto__: null, nesting, file, name });`
`54`	`62`	`}`