[node:test] add setup and watch for RunOptions #66064

koh110 · 2023-07-14T08:41:49Z

add setup and watch options

The implementation of the setup function includes arguments, but the Node.js documentation does not provide any description of the argument types.
https://nodejs.org/docs/latest-v20.x/api/test.html#runoptions
https://github.com/nodejs/node/blob/v20.4.0/lib/internal/test_runner/runner.js#L510
https://github.com/nodejs/node/blob/v20.4.0/lib/internal/test_runner/harness.js#L29-L31

Please fill in this template.

Use a meaningful title for the pull request. Include the name of the package modified.
Test the change in your own code. (Compile and run.)
Add or edit tests to reflect the change.
Follow the advice from the readme.
Avoid common mistakes.
Run npm test <package to test>.

If changing an existing definition:

Provide a URL to documentation or source code which provides context for the suggested changes: <https://nodejs.org/docs/latest-v20.x/api/test.html#runoptions>
If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.

typescript-bot · 2023-07-14T08:42:30Z

@koh110 Thank you for submitting this PR!

This is a live comment which I will keep updated.

1 package in this PR

node — on npm, on unpkg

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

You can test the changes of this PR in the Playground.

Status

✅ No merge conflicts
✅ Continuous integration tests have passed
✅ Most recent commit is approved by a DT maintainer

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.

Inactive

This PR has been inactive for 11 days — please merge or say something if there's a problem, otherwise it will be closed!

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 66064,
  "author": "koh110",
  "headCommitOid": "31034ca619357d13e9292010acaa0f0409803d48",
  "mergeBaseOid": "77b183c95be2dc99f7399c54c4860f312a456ca8",
  "lastPushDate": "2023-07-14T08:41:49.000Z",
  "lastActivityDate": "2023-08-05T10:14:10.000Z",
  "mergeOfferDate": "2023-07-24T19:26:16.000Z",
  "mergeRequestDate": "2023-08-04T01:06:58.000Z",
  "mergeRequestUser": "koh110",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "node",
      "kind": "edit",
      "files": [
        {
          "path": "types/node/test.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/test/test.ts",
          "kind": "test"
        },
        {
          "path": "types/node/ts4.8/test.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/ts4.8/test/test.ts",
          "kind": "test"
        },
        {
          "path": "types/node/v18/test.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/v18/test/test.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "Microsoft",
        "DefinitelyTyped",
        "jkomyno",
        "alvis",
        "r3nya",
        "btoueg",
        "smac89",
        "touffy",
        "DeividasBakanas",
        "eyqs",
        "Hannes-Magnusson-CK",
        "hoo29",
        "kjin",
        "ajafff",
        "islishude",
        "mwiktorczyk",
        "mohsen1",
        "n-e",
        "galkin",
        "parambirs",
        "eps1lon",
        "SimonSchick",
        "ThomasdenH",
        "WilcoBakker",
        "wwwy3y3",
        "samuela",
        "kuehlein",
        "bhongy",
        "chyzwar",
        "trivikr",
        "yoursunny",
        "qwelias",
        "ExE-Boss",
        "peterblazejewicz",
        "addaleax",
        "victorperin",
        "ZYSzys",
        "NodeJS",
        "LinusU",
        "wafuwafu13",
        "mcollina",
        "Semigradsky"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "rbuckton",
      "date": "2023-07-24T19:25:31.000Z",
      "isMaintainer": true
    },
    {
      "type": "stale",
      "reviewer": "Semigradsky",
      "date": "2023-07-17T08:41:33.000Z",
      "abbrOid": "5a92bf3"
    }
  ],
  "mainBotCommentID": 1635514806,
  "ciResult": "pass"
}

typescript-bot · 2023-07-14T08:42:33Z

🔔 @microsoft @DefinitelyTyped @jkomyno @alvis @r3nya @btoueg @smac89 @Touffy @DeividasBakanas @eyqs @Hannes-Magnusson-CK @hoo29 @kjin @ajafff @islishude @mwiktorczyk @mohsen1 @n-e @galkin @parambirs @eps1lon @SimonSchick @ThomasdenH @WilcoBakker @wwwy3y3 @samuela @kuehlein @bhongy @chyzwar @trivikr @yoursunny @qwelias @ExE-Boss @peterblazejewicz @addaleax @victorperin @ZYSzys @nodejs @LinusU @wafuwafu13 @mcollina @Semigradsky — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

typescript-bot · 2023-07-14T09:24:06Z

@koh110 The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

Semigradsky · 2023-07-15T07:26:19Z

types/node/test.d.ts

+        /**
+         * A function that accepts the TestsStream instance and can be used to setup listeners before any tests are run.
+         */
+        setup?: (root: unknown) => void | Promise<void>;


setup?: (testsStream: TestsStream) => void | Promise<void>;

From doc:

A function that accepts the TestsStream instance

I checked and it seems that the implementation is not TestStream but Test class.
https://github.com/nodejs/node/blob/v20.4.0/lib/internal/test_runner/harness.js#L29-L31
https://github.com/nodejs/node/blob/v20.4.0/lib/internal/test_runner/test.js#L165-L192
https://github.com/nodejs/node/blob/v20.4.0/lib/internal/test_runner/tests_stream.js#L10

const stream = run({ files: files, concurrency: true, setup: function (root) { console.log('setup', root) } })

setup <ref *1> Test { concurrency: 9, nesting: 0, only: false, reporter: TestsStream { _readableState: ReadableState { objectMode: true, highWaterMark: 16, buffer: BufferList { head: null, tail: null, length: 0 }, length: 0, pipes: [], flowing: null, ended: false, endEmitted: false, reading: false,

Should I create Test class and all property?

It can be a bug, I have created nodejs/node#48809

Thanks for your creating issue.
I have modified this PR to match the current implementation.
But should I wait until the issue is resolved?

Semigradsky · 2023-07-15T07:27:36Z

Also please add changes to ts4.8 folder for Typescript<=4.8 and to v18/v18/ts4.8 folders for Node.js 18.x

typescript-bot · 2023-07-15T15:08:13Z

@Semigradsky Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

typescript-bot · 2023-07-24T19:26:16Z

@koh110: Everything looks good here. I am ready to merge this PR (at 31034ca) on your behalf whenever you think it's ready.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

(@microsoft, @DefinitelyTyped, @jkomyno, @alvis, @r3nya, @btoueg, @smac89, @Touffy, @DeividasBakanas, @eyqs, @Hannes-Magnusson-CK, @hoo29, @kjin, @ajafff, @islishude, @mwiktorczyk, @mohsen1, @n-e, @galkin, @parambirs, @eps1lon, @SimonSchick, @ThomasdenH, @WilcoBakker, @wwwy3y3, @samuela, @kuehlein, @bhongy, @chyzwar, @trivikr, @yoursunny, @qwelias, @ExE-Boss, @peterblazejewicz, @addaleax, @victorperin, @ZYSzys, @nodejs, @LinusU, @wafuwafu13, @mcollina, @Semigradsky: you can do this too.)

typescript-bot · 2023-08-04T01:04:10Z

Re-ping @koh110 / @microsoft, @DefinitelyTyped, @jkomyno, @alvis, @r3nya, @btoueg, @smac89, @Touffy, @DeividasBakanas, @eyqs, @Hannes-Magnusson-CK, @hoo29, @kjin, @ajafff, @islishude, @mwiktorczyk, @mohsen1, @n-e, @galkin, @parambirs, @eps1lon, @SimonSchick, @ThomasdenH, @WilcoBakker, @wwwy3y3, @samuela, @kuehlein, @bhongy, @chyzwar, @trivikr, @yoursunny, @qwelias, @ExE-Boss, @peterblazejewicz, @addaleax, @victorperin, @ZYSzys, @nodejs, @LinusU, @wafuwafu13, @mcollina, @Semigradsky:

This PR has been ready to merge for over a week, and I haven't seen any requests to merge it. I will close it on Aug 23rd (in three weeks) if this doesn't happen.

(If there's no reason to avoid merging it, please do so. Otherwise, if it shouldn't be merged or if it needs more time, please close it or turn it into a draft.)

koh110 · 2023-08-04T01:06:58Z

Ready to merge

peterblazejewicz · 2023-08-05T10:14:10Z

note: edited comment to kick the bot str matcher

koh110 requested review from eps1lon and peterblazejewicz as code owners July 14, 2023 08:41

typescript-bot added Critical package Untested Change This PR does not touch tests labels Jul 14, 2023

koh110 force-pushed the node-test branch from 34b5a1a to 31e2de7 Compare July 14, 2023 08:48

typescript-bot added The CI failed When GH Actions fails and removed Untested Change This PR does not touch tests labels Jul 14, 2023

koh110 force-pushed the node-test branch from 31e2de7 to 5a92bf3 Compare July 14, 2023 09:32

typescript-bot removed the The CI failed When GH Actions fails label Jul 14, 2023

Semigradsky reviewed Jul 15, 2023

View reviewed changes

[node:test] add setup and watch for RunOptions

31034ca

koh110 force-pushed the node-test branch from 5a92bf3 to 31034ca Compare July 15, 2023 14:38

Semigradsky mentioned this pull request Jul 17, 2023

test_runner: test object is incorrectly passed to setup() nodejs/node#48809

Closed

rbuckton approved these changes Jul 24, 2023

View reviewed changes

typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Jul 24, 2023

typescript-bot added the Unmerged The author did not merge the PR when it was ready. label Aug 4, 2023

typescript-bot merged commit ec806aa into DefinitelyTyped:master Aug 5, 2023

[node:test] add setup and watch for RunOptions #66064

[node:test] add setup and watch for RunOptions #66064

Uh oh!

Conversation

koh110 commented Jul 14, 2023

Uh oh!

typescript-bot commented Jul 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

1 package in this PR

Code Reviews

Status

Inactive

Uh oh!

typescript-bot commented Jul 14, 2023

Uh oh!

typescript-bot commented Jul 14, 2023

Uh oh!

Semigradsky Jul 15, 2023

Choose a reason for hiding this comment

Uh oh!

koh110 Jul 15, 2023

Choose a reason for hiding this comment

Uh oh!

Semigradsky Jul 17, 2023

Choose a reason for hiding this comment

Uh oh!

koh110 Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

Semigradsky commented Jul 15, 2023

Uh oh!

typescript-bot commented Jul 15, 2023

Uh oh!

typescript-bot commented Jul 24, 2023

Uh oh!

typescript-bot commented Aug 4, 2023

Uh oh!

koh110 commented Aug 4, 2023 • edited by peterblazejewicz Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

peterblazejewicz commented Aug 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

typescript-bot commented Jul 14, 2023 •

edited

Loading

koh110 commented Aug 4, 2023 •

edited by peterblazejewicz

Loading