test_runner: support module mocking #52848

cjihrig · 2024-05-05T17:52:41Z

This commit adds experimental module mocking to the test runner.

nodejs-github-bot · 2024-05-05T17:52:46Z

Review requested:

@nodejs/test_runner
@nodejs/web-infra

benjamingr · 2024-05-05T18:13:22Z

doc/api/test.md

+This function is used to mock the exports of ECMAScript modules, CommonJS
+modules, and Node.js builtin modules. Any references to the original module
+prior to mocking are not impacted. The following example demonstrates how a mock
+is created for a module.


The " Any references to the original module prior to mocking are not impacted." part probably needs emphasizing (that users need to dynamically import their function under test and ensure it was not imported (and resolved its imports) prior to t.mock.module )

benjamingr

LGTM for experimental, this was fun to play with. TODOs seem reasonable and the ergonomics bother me a bit but code looks good and that can be discussed after landing.

doc/api/test.md

rozzilla

Super! 🎉

benjamingr · 2024-05-05T18:20:11Z

@nodejs/loaders might wanna take a look too

cjihrig · 2024-05-05T19:07:34Z

the ergonomics bother me a bit

What would you like the ergonomics to look like? ESM is kind of restrictive here in ways that CJS is not. Is there a C++ API I can leverage to uncache or change an existing ES module? If so, I would happily use that instead.

lib/test/mock_loader.js

lib/internal/test_runner/mock/mock.js

doc/api/test.md

lib/test/mock_loader.js

benjamingr · 2024-05-06T10:54:24Z

What would you like the ergonomics to look like? ESM is kind of restrictive here in ways that CJS is not. Is there a C++ API I can leverage to uncache or change an existing ES module? If so, I would happily use that instead.

In big'ish new features I'm in the camp of "land and iterate" hence why I read then approved this PR. There is time for API bikeshedding later IMO for this sort of active development work.

That said, it would be nice if:

The code warned when you .mock a module that was already loaded
The code examples showed a more complete example of mocking through a third file (so imports only happen after .mock happened)

I have no better API ideas (other than changing the original module since it's live bindings which is bad and we shouldn't do).

nodejs-github-bot · 2024-05-16T13:38:52Z

CI: https://ci.nodejs.org/job/node-test-pull-request/59244/

GeoffreyBooth

Great work! I'm impressed that you managed to achieve this without any changes to the modules internals.

Maybe in a future PR we could expose this in a way that other test frameworks could use it too?

doc/api/test.md

MoLow · 2024-05-16T14:05:06Z

Maybe in a future PR we could expose this in a way that other test frameworks could use it too?

it is already exposed. you can import { mock } from 'node:test' and use a different framework for the actual testing

cjihrig · 2024-05-16T14:13:07Z

@MoLow I cancelled your CI run because it's going to fail on Windows: https://ci.nodejs.org/job/node-test-binary-windows-js-suites/27754/RUN_SUBSET=3,nodes=win11-arm64-COMPILED_BY-vs2022-arm64/console

This commit adds experimental module mocking to the test runner.

nodejs-github-bot · 2024-05-16T21:19:03Z

CI: https://ci.nodejs.org/job/node-test-pull-request/59257/ 🟡

cjihrig · 2024-05-18T14:44:27Z

This needs a re-approval in order to land via the commit queue.

nodejs-github-bot · 2024-05-19T05:09:10Z

Landed in a619789

hossain666 · 2024-05-25T20:10:17Z

4983546@@

This commit adds experimental module mocking to the test runner. PR-URL: #52848 Fixes: #51164 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>

This commit adds experimental module mocking to the test runner. PR-URL: nodejs#52848 Fixes: nodejs#51164 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>

Notable changes: buffer: * (SEMVER-MINOR) add .bytes() method to Blob (Matthew Aitken) #53221 cli: * (SEMVER-MINOR) add `NODE_RUN_PACKAGE_JSON_PATH` env (Yagiz Nizipli) #53058 * (SEMVER-MINOR) add `NODE_RUN_SCRIPT_NAME` env to `node --run` (Yagiz Nizipli) #53032 doc: * (SEMVER-MINOR) add context.assert docs (Colin Ihrig) #53169 * (SEMVER-MINOR) improve explanation about built-in modules (Joyee Cheung) #52762 * add StefanStojanovic to collaborators (StefanStojanovic) #53118 fs: * mark recursive cp methods as stable (Théo LUDWIG) #53127 lib: * (SEMVER-MINOR) add EventSource Client (Aras Abbasi) #51575 * (SEMVER-MINOR) replace MessageEvent with undici's (Matthew Aitken) #52370 module: * (SEMVER-MINOR) print amount of load time of a cjs module (Vinicius Lourenço) #52213 net: * (SEMVER-MINOR) add new net.server.listen tracing channel (Paolo Insogna) #53136 process: * (SEMVER-MINOR) add process.getBuiltinModule(id) (Joyee Cheung) #52762 src,permission: * (SEMVER-MINOR) --allow-wasi & prevent WASI exec (Rafael Gonzaga) #53124 test_runner: * (SEMVER-MINOR) add snapshot testing (Colin Ihrig) #53169 * (SEMVER-MINOR) add context.fullName (Colin Ihrig) #53169 * (SEMVER-MINOR) support module mocking (Colin Ihrig) #52848 PR-URL: TODO

Notable changes: buffer: * (SEMVER-MINOR) add .bytes() method to Blob (Matthew Aitken) #53221 cli: * (SEMVER-MINOR) add `NODE_RUN_PACKAGE_JSON_PATH` env (Yagiz Nizipli) #53058 * (SEMVER-MINOR) add `NODE_RUN_SCRIPT_NAME` env to `node --run` (Yagiz Nizipli) #53032 doc: * (SEMVER-MINOR) add context.assert docs (Colin Ihrig) #53169 * (SEMVER-MINOR) improve explanation about built-in modules (Joyee Cheung) #52762 * add StefanStojanovic to collaborators (StefanStojanovic) #53118 * add Marco Ippolito to TSC (Rafael Gonzaga) #53008 fs: * mark recursive cp methods as stable (Théo LUDWIG) #53127 lib: * (SEMVER-MINOR) add EventSource Client (Aras Abbasi) #51575 * (SEMVER-MINOR) replace MessageEvent with undici's (Matthew Aitken) #52370 module: * (SEMVER-MINOR) print amount of load time of a cjs module (Vinicius Lourenço) #52213 net: * (SEMVER-MINOR) add new net.server.listen tracing channel (Paolo Insogna) #53136 process: * (SEMVER-MINOR) add process.getBuiltinModule(id) (Joyee Cheung) #52762 src,permission: * (SEMVER-MINOR) --allow-wasi & prevent WASI exec (Rafael Gonzaga) #53124 test_runner: * (SEMVER-MINOR) add snapshot testing (Colin Ihrig) #53169 * (SEMVER-MINOR) add context.fullName (Colin Ihrig) #53169 * (SEMVER-MINOR) support module mocking (Colin Ihrig) #52848 PR-URL: #53379

Notable changes: buffer: * (SEMVER-MINOR) add .bytes() method to Blob (Matthew Aitken) #53221 cli: * (SEMVER-MINOR) add `NODE_RUN_PACKAGE_JSON_PATH` env (Yagiz Nizipli) #53058 * (SEMVER-MINOR) add `NODE_RUN_SCRIPT_NAME` env to `node --run` (Yagiz Nizipli) #53032 doc: * (SEMVER-MINOR) add context.assert docs (Colin Ihrig) #53169 * (SEMVER-MINOR) improve explanation about built-in modules (Joyee Cheung) #52762 * add StefanStojanovic to collaborators (StefanStojanovic) #53118 * add Marco Ippolito to TSC (Rafael Gonzaga) #53008 fs: * mark recursive cp methods as stable (Théo LUDWIG) #53127 lib: * (SEMVER-MINOR) add EventSource Client (Aras Abbasi) #51575 * (SEMVER-MINOR) replace MessageEvent with undici's (Matthew Aitken) #52370 module: * (SEMVER-MINOR) print amount of load time of a cjs module (Vinicius Lourenço) #52213 net: * (SEMVER-MINOR) add new net.server.listen tracing channel (Paolo Insogna) #53136 process: * (SEMVER-MINOR) add process.getBuiltinModule(id) (Joyee Cheung) #52762 src: * (SEMVER-MINOR) traverse parent folders while running `--run` (Yagiz Nizipli) #53154 src,permission: * (SEMVER-MINOR) --allow-wasi & prevent WASI exec (Rafael Gonzaga) #53124 test_runner: * (SEMVER-MINOR) add snapshot testing (Colin Ihrig) #53169 * (SEMVER-MINOR) add context.fullName (Colin Ihrig) #53169 * (SEMVER-MINOR) support module mocking (Colin Ihrig) #52848 PR-URL: #53379

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels May 5, 2024

cjihrig mentioned this pull request May 5, 2024

Feature Request: Module level mocking #51164

Closed

iambumblehead mentioned this pull request May 5, 2024

added bosschaert demo iambumblehead/esmock#301

Closed

benjamingr reviewed May 5, 2024

View reviewed changes

benjamingr approved these changes May 5, 2024

View reviewed changes

benjamingr reviewed May 5, 2024

View reviewed changes

doc/api/test.md Show resolved Hide resolved

rozzilla reviewed May 5, 2024

View reviewed changes

aduh95 reviewed May 5, 2024

View reviewed changes

MoLow reviewed May 6, 2024

View reviewed changes

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

MoLow reviewed May 6, 2024

View reviewed changes

lib/test/mock_loader.js Show resolved Hide resolved

MoLow approved these changes May 6, 2024

View reviewed changes

RafaelGSS approved these changes May 6, 2024

View reviewed changes

cjihrig force-pushed the mock-new branch from 79bfc35 to 208c8f0 Compare May 14, 2024 15:29

cjihrig added request-ci Add this label to start a Jenkins CI on a PR. labels May 14, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 14, 2024

MoLow added the request-ci Add this label to start a Jenkins CI on a PR. label May 16, 2024

MoLow approved these changes May 16, 2024

View reviewed changes

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 16, 2024

GeoffreyBooth approved these changes May 16, 2024

View reviewed changes

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

cjihrig force-pushed the mock-new branch 2 times, most recently from 03734eb to cb1caed Compare May 16, 2024 14:12

cjihrig added 2 commits May 16, 2024 10:41

test_runner: support module mocking

d5bcd75

This commit adds experimental module mocking to the test runner.

squash

4983546

cjihrig force-pushed the mock-new branch from cb1caed to 4983546 Compare May 16, 2024 19:12

cjihrig added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label May 16, 2024

nodejs deleted a comment from nodejs-github-bot May 16, 2024

cjihrig added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed needs-ci PRs that need a full CI run. labels May 16, 2024

cjihrig requested a review from MoLow May 16, 2024 23:06

cjihrig added the semver-minor PRs that contain new features and should be released in the next minor version. label May 18, 2024

GeoffreyBooth approved these changes May 19, 2024

View reviewed changes

GeoffreyBooth added the commit-queue Add this label to land a pull request using GitHub Actions. label May 19, 2024

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 19, 2024

nodejs-github-bot merged commit a619789 into nodejs:main May 19, 2024
62 checks passed

cjihrig deleted the mock-new branch May 19, 2024 13:32

RafaelGSS mentioned this pull request Jun 7, 2024

v22.3.0 proposal #53379

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test_runner: support module mocking #52848

test_runner: support module mocking #52848

cjihrig commented May 5, 2024 •

edited

nodejs-github-bot commented May 5, 2024

benjamingr May 5, 2024

benjamingr left a comment

rozzilla left a comment

benjamingr commented May 5, 2024

cjihrig commented May 5, 2024

benjamingr commented May 6, 2024

nodejs-github-bot commented May 16, 2024

GeoffreyBooth left a comment

MoLow commented May 16, 2024

cjihrig commented May 16, 2024

nodejs-github-bot commented May 16, 2024 •

edited by cjihrig

cjihrig commented May 18, 2024

nodejs-github-bot commented May 19, 2024

hossain666 commented May 25, 2024

test_runner: support module mocking #52848

test_runner: support module mocking #52848

Conversation

cjihrig commented May 5, 2024 • edited

nodejs-github-bot commented May 5, 2024

benjamingr May 5, 2024

Choose a reason for hiding this comment

benjamingr left a comment

Choose a reason for hiding this comment

rozzilla left a comment

Choose a reason for hiding this comment

benjamingr commented May 5, 2024

cjihrig commented May 5, 2024

benjamingr commented May 6, 2024

nodejs-github-bot commented May 16, 2024

GeoffreyBooth left a comment

Choose a reason for hiding this comment

MoLow commented May 16, 2024

cjihrig commented May 16, 2024

nodejs-github-bot commented May 16, 2024 • edited by cjihrig

cjihrig commented May 18, 2024

nodejs-github-bot commented May 19, 2024

hossain666 commented May 25, 2024

cjihrig commented May 5, 2024 •

edited

nodejs-github-bot commented May 16, 2024 •

edited by cjihrig