doc: add "type" to test runner event details #49014

philnash · 2023-08-04T06:30:49Z

In version 20.0.0 (and backported to 19.9.0 and 18.7.0) 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.

nodejs-github-bot · 2023-08-04T06:30:53Z

Review requested:

@nodejs/test_runner

aduh95 · 2023-08-04T06:58:00Z

Our commit guidelines say that the first word after the subsystem should be an imperative verb, can you fix that? s/adds/add/

aduh95 · 2023-08-04T06:59:51Z

Do you want to add an entry to the history YAML list?

philnash · 2023-08-04T07:09:14Z

@aduh95 I'll fix the commit message. What history YAML do you mean? Thanks!

atlowChemi · 2023-08-04T08:57:35Z

What history YAML do you mean? Thanks!

@philnash the doumentation contains version history mentioning when features were added/changed. See for example:

node/doc/api/test.md

Lines 1068 to 1078 in 9f8b9ea

    
           <!-- YAML 
        
           added: 
        
             - v18.6.0 
        
             - v16.17.0 
        
           changes: 
        
             - version: 
        
               - v19.8.0 
        
               - v18.16.0 
        
               pr-url: https://github.com/nodejs/node/pull/46889 
        
               description: Calling `it()` is now equivalent to calling `test()`. 
        
           -->

lpinca · 2023-08-04T16:02:16Z

doc/api/test.md

@@ -2061,6 +2061,8 @@ Emitted when a test is enqueued for execution.
    * `duration_ms` {number} The duration of the test in milliseconds.
    * `error` {Error} An error wrapping the error thrown by the test.
      * `cause` {Error} The actual error thrown by the test.
+    * `type` {string|undefined} The type of the test, used to denote whether
+      this is a suite


Suggested change

this is a suite

this is a suite.

lpinca · 2023-08-04T16:02:23Z

doc/api/test.md

@@ -2076,6 +2078,8 @@ Emitted when a test fails.
 * `data` {Object}
  * `details` {Object} Additional execution metadata.
    * `duration_ms` {number} The duration of the test in milliseconds.
+    * `type` {string|undefined} The type of the test, used to denote whether
+      this is a suite


Suggested change

this is a suite

this is a suite.

philnash · 2023-08-07T00:05:27Z

I corrected the grammar (period at the end of the sentences) and added a history YAML describing the update.

Thanks for all who reviewed this!

doc/api/test.md

In version 20.0.0 (and backported to 19.9.0 and 18.7.0) 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.

nodejs-github-bot · 2023-08-08T18:43:44Z

Landed in 1cfd61b

In version 20.0.0 (and backported to 19.9.0 and 18.7.0) 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. PR-URL: nodejs#49014 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il>

In version 20.0.0 (and backported to 19.9.0 and 18.7.0) 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. PR-URL: #49014 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il>

In version 20.0.0 (and backported to 19.9.0 and 18.7.0) 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. PR-URL: nodejs#49014 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il>

In version 20.0.0 (and backported to 19.9.0 and 18.7.0) 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. PR-URL: #49014 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il>

In version 20.0.0 (and backported to 19.9.0 and 18.7.0) 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. PR-URL: nodejs/node#49014 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il>

nodejs-github-bot added doc Issues and PRs related to the documentations. test_runner Issues and PRs related to the test runner subsystem. labels Aug 4, 2023

philnash force-pushed the test-runner-docs-event-details-type branch from dfba73c to 878a4b1 Compare August 4, 2023 06:47

philnash mentioned this pull request Aug 4, 2023

[node] adds "type" to test runner event details DefinitelyTyped/DefinitelyTyped#66282

Merged

7 tasks

philnash changed the title ~~doc: adds "type" to test runner event details~~ doc: add "type" to test runner event details Aug 4, 2023

philnash force-pushed the test-runner-docs-event-details-type branch from 878a4b1 to 17a35fe Compare August 4, 2023 07:10

lpinca reviewed Aug 4, 2023

View reviewed changes

lpinca approved these changes Aug 4, 2023

View reviewed changes

benjamingr approved these changes Aug 6, 2023

View reviewed changes

philnash force-pushed the test-runner-docs-event-details-type branch from 17a35fe to e710793 Compare August 7, 2023 00:04

philnash force-pushed the test-runner-docs-event-details-type branch 2 times, most recently from ee84e70 to 40757af Compare August 7, 2023 03:24

atlowChemi reviewed Aug 7, 2023

View reviewed changes

doc/api/test.md Outdated Show resolved Hide resolved

philnash force-pushed the test-runner-docs-event-details-type branch from 40757af to f257615 Compare August 7, 2023 05:51

atlowChemi approved these changes Aug 7, 2023

View reviewed changes

debadree25 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 7, 2023

aymen94 approved these changes Aug 7, 2023

View reviewed changes

lpinca added the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 8, 2023

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 8, 2023

nodejs-github-bot merged commit 1cfd61b into nodejs:main Aug 8, 2023
20 checks passed

UlisesGascon mentioned this pull request Aug 15, 2023

v20.6.0 proposal #49185

Merged

targos mentioned this pull request Nov 28, 2023

v18.19.0 release proposal #50953

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add "type" to test runner event details #49014

doc: add "type" to test runner event details #49014

philnash commented Aug 4, 2023

nodejs-github-bot commented Aug 4, 2023

aduh95 commented Aug 4, 2023

aduh95 commented Aug 4, 2023

philnash commented Aug 4, 2023

atlowChemi commented Aug 4, 2023

lpinca Aug 4, 2023

lpinca Aug 4, 2023

philnash commented Aug 7, 2023

nodejs-github-bot commented Aug 8, 2023

doc: add "type" to test runner event details #49014

doc: add "type" to test runner event details #49014

Conversation

philnash commented Aug 4, 2023

nodejs-github-bot commented Aug 4, 2023

aduh95 commented Aug 4, 2023

aduh95 commented Aug 4, 2023

philnash commented Aug 4, 2023

atlowChemi commented Aug 4, 2023

lpinca Aug 4, 2023

Choose a reason for hiding this comment

lpinca Aug 4, 2023

Choose a reason for hiding this comment

philnash commented Aug 7, 2023

nodejs-github-bot commented Aug 8, 2023