🤖 Merge PR #66282 [node] adds "type" to test runner event details by @…

…philnash In [version 20.0.0 (and backported to 19.9.0 and 18.7.0)](nodejs/node#47094) the test runner started reporting on whether a test was a suite. This was exposed to reporters in the `details` object of a `test:pass` or `test:fail` event but this hasn't been documented. This adds the `type` property to both event's `details` object.
DefinitelyTyped · Aug 11, 2023 · 15ee4f9 · 15ee4f9
1 parent 7c8a586
commit 15ee4f9
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 8 deletions.
diff --git a/types/node/test.d.ts b/types/node/test.d.ts
@@ -1241,6 +1241,11 @@ interface TestFail {
          * The error thrown by the test.
          */
         error: Error;
+        /**
+         * The type of the test, used to denote whether this is a suite.
+         * @since 20.0.0, 19.9.0, 18.17.0
+         */
+        type?: 'suite';
     };
     /**
      * The test name.
@@ -1276,6 +1281,11 @@ interface TestPass {
          * The duration of the test in milliseconds.
          */
         duration_ms: number;
+        /**
+         * The type of the test, used to denote whether this is a suite.
+         * @since 20.0.0, 19.9.0, 18.17.0
+         */
+        type?: 'suite';
     };
     /**
      * The test name.

diff --git a/types/node/test/test.ts b/types/node/test/test.ts
@@ -670,14 +670,15 @@ class TestReporter extends Transform {
             case 'test:fail':
                 callback(
                     null,
-                    `${event.data.name}/${event.data.details.duration_ms}/
+                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.details.type}/
                     ${event.data.details.error}/${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
                 );
                 break;
             case 'test:pass':
                 callback(
                     null,
-                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
+                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.details.type}/
+                    ${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
                 );
                 break;
             case 'test:plan':

diff --git a/types/node/ts4.8/test.d.ts b/types/node/ts4.8/test.d.ts
@@ -1223,6 +1223,11 @@ interface TestFail {
          * The error thrown by the test.
          */
         error: Error;
+        /**
+         * The type of the test, used to denote whether this is a suite.
+         * @since 20.0.0, 19.9.0, 18.17.0
+         */
+        type?: 'suite';
     };
     /**
      * The test name.
@@ -1258,6 +1263,11 @@ interface TestPass {
          * The duration of the test in milliseconds.
          */
         duration_ms: number;
+        /**
+         * The type of the test, used to denote whether this is a suite.
+         * @since 20.0.0, 19.9.0, 18.17.0
+         */
+        type?: 'suite';
     };
     /**
      * The test name.

diff --git a/types/node/ts4.8/test/test.ts b/types/node/ts4.8/test/test.ts
@@ -640,14 +640,15 @@ class TestReporter extends Transform {
             case 'test:fail':
                 callback(
                     null,
-                    `${event.data.name}/${event.data.details.duration_ms}/
+                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.details.type}/
                     ${event.data.details.error}/${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
                 );
                 break;
             case 'test:pass':
                 callback(
                     null,
-                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
+                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.details.type}/
+                    ${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
                 );
                 break;
             case 'test:plan':

diff --git a/types/node/v18/test.d.ts b/types/node/v18/test.d.ts
@@ -756,6 +756,11 @@ interface TestFail {
          * The error thrown by the test.
          */
         error: Error;
+        /**
+         * The type of the test, used to denote whether this is a suite.
+         * @since 18.17.0
+         */
+        type?: 'suite';
     };
     /**
      * The test name.
@@ -791,6 +796,11 @@ interface TestPass {
          * The duration of the test in milliseconds.
          */
         duration_ms: number;
+        /**
+         * The type of the test, used to denote whether this is a suite.
+         * @since 18.17.0
+         */
+        type?: 'suite';
     };
     /**
      * The test name.

diff --git a/types/node/v18/test/test.ts b/types/node/v18/test/test.ts
@@ -549,14 +549,15 @@ class TestReporter extends Transform {
             case 'test:fail':
                 callback(
                     null,
-                    `${event.data.name}/${event.data.details.duration_ms}/
+                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.details.type}/
                     ${event.data.details.error}/${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
                 );
                 break;
             case 'test:pass':
                 callback(
                     null,
-                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
+                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.details.type}/
+                    ${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
                 );
                 break;
             case 'test:plan':

diff --git a/types/node/v18/ts4.8/test.d.ts b/types/node/v18/ts4.8/test.d.ts
@@ -742,6 +742,11 @@ interface TestFail {
          * The error thrown by the test.
          */
         error: Error;
+        /**
+         * The type of the test, used to denote whether this is a suite.
+         * @since 18.17.0
+         */
+        type?: 'suite';
     };
     /**
      * The test name.
@@ -777,6 +782,11 @@ interface TestPass {
          * The duration of the test in milliseconds.
          */
         duration_ms: number;
+        /**
+         * The type of the test, used to denote whether this is a suite.
+         * @since 18.17.0
+         */
+        type?: 'suite';
     };
     /**
      * The test name.

diff --git a/types/node/v18/ts4.8/test/test.ts b/types/node/v18/ts4.8/test/test.ts
@@ -548,14 +548,15 @@ class TestReporter extends Transform {
             case 'test:fail':
                 callback(
                     null,
-                    `${event.data.name}/${event.data.details.duration_ms}/
+                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.details.type}/
                     ${event.data.details.error}/${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
                 );
                 break;
             case 'test:pass':
                 callback(
                     null,
-                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
+                    `${event.data.name}/${event.data.details.duration_ms}/${event.data.details.type}/
+                    ${event.data.nesting}/${event.data.testNumber}/${event.data.todo}/${event.data.skip}/${event.data.file}`,
                 );
                 break;
             case 'test:plan':