feat: add support unstable_unmockModule #15080

BondarenkoAlex · 2024-05-21T19:19:56Z

Closes #15079

Summary

Test plan

linux-foundation-easycla · 2024-05-21T19:20:03Z

The committers listed above are authorized under a signed CLA.

✅ login: BondarenkoAlex / name: Aleksei Bondarenko (4607472, 86aae09, f114dfb, ff0e2e9, 7a2c4af)
✅ login: SimenB / name: Simen Bekkhus (818e185)

netlify · 2024-05-21T19:20:14Z

✅ Deploy Preview for jestjs ready!

Name	Link
🔨 Latest commit	`818e185`
🔍 Latest deploy log	https://app.netlify.com/sites/jestjs/deploys/668146177ebf5400085b75a0
😎 Deploy Preview	https://deploy-preview-15080--jestjs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

SimenB

exciting start, thanks!

Could you:

add an integration test
fix CI failure (we need to add the new function to the types in @jest/environment)
add docs
add a changelog entry
sign the CLA

the code itself looks correct, we just need a few things in addition to that 🙂

mrazauskas · 2024-05-23T06:33:27Z

After implementing typings, could you add type tests as well, please? Similar tests of .unstable_mockModule(). They live in this file: https://github.com/jestjs/jest/blob/main/packages/jest-types/__typetests__/jest.test.ts

To run the type test: build the library and run yarn test-types.

By the way, .unstable_mockModule() is only documented here: https://jestjs.io/docs/ecmascript-modules#module-mocking-in-esm. Adding an example with .unstable_unmockModule() to this page should be enough.

BondarenkoAlex · 2024-05-24T10:37:38Z

Where do I add integration test?
Where do i find file with?
P.S. Sorry for my English

mrazauskas · 2024-05-24T10:43:06Z

Tests of .unstable_mockModule() live in this file:

jest/e2e/native-esm/__tests__/native-esm.test.js

Line 228 in 0d222c1

jestObject.unstable_mockModule('../mockedModule.mjs', () => ({foo: 'bar'}), {

I think you can add .unstable_unmockModule() test there too.

(Don’t worry about your the English skills. This is friendly open-source project. Many of users / contributors are not native speakers.)

packages/jest-types/__typetests__/jest.test.ts

packages/jest-environment/src/index.ts

SimenB

We're getting close! 🙂

CI is currently failing on the new tests added. One thing is that the snapshots aren't updated (you can do so by running yarn jest nativeEsm.test -u). However, the main problem is that those new tests are failing. The best way to work on them locally is to cd into e2e/native-esm and run yarn followed by node --experimental-vm-modules --no-warnings ../../packages/jest/bin/jest.js.

SimenB · 2024-05-29T07:00:18Z

e2e/native-esm/__tests__/native-esm.test.js

+
+  jestObject.unstable_unmockModule('../index.js');
+
+  const importedMockAfterUnmock = await import('../reexport.js');


I don't think this will work as ../reexport.js already has a reference to the old (mocked) index.js.

Do you have an example of a test of ours using unmock that works in this way? If not, I think you can just delete the test

Yes. It is not work with "mock" and "unmock"

test('test', () => { jest.mock('./dependencyModule', () => { return {getSecretNumber: () => 1000}; }); const {getSecretNumber} = require("./dependencyModule"); console.log(getSecretNumber()); // output original implementation. Not mock impl. jest.unmock('./dependencyModule'); // it is the reset implementation in the file });

SimenB · 2024-05-29T07:01:35Z

Also, I think it'd be easiest to move the mocking tests to its own file so you can use resetModules in between each test run as mocking and unmocking the same module leaks between tests. Something like this:

diff --git c/e2e/native-esm/__tests__/native-esm-mocks.test.js w/e2e/native-esm/__tests__/native-esm-mocks.test.js
new file mode 100644
index 0000000000..3670a3525d
--- /dev/null
+++ w/e2e/native-esm/__tests__/native-esm-mocks.test.js
@@ -0,0 +1,82 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+afterEach(() => {
+  import.meta.jest.resetModules();
+});
+
+test('can mock module', async () => {
+  import.meta.jest.unstable_mockModule(
+    '../mockedModule.mjs',
+    () => ({foo: 'bar'}),
+    {virtual: true},
+  );
+
+  const importedMock = await import('../mockedModule.mjs');
+
+  expect(Object.keys(importedMock)).toEqual(['foo']);
+  expect(importedMock.foo).toBe('bar');
+});
+
+test('can mock transitive module', async () => {
+  import.meta.jest.unstable_mockModule('../index.js', () => ({foo: 'bar'}));
+
+  const importedMock = await import('../reexport.js');
+
+  expect(Object.keys(importedMock)).toEqual(['foo']);
+  expect(importedMock.foo).toBe('bar');
+});
+
+test('can unmock module', async () => {
+  import.meta.jest.unstable_mockModule('../index.js', () => ({
+    double: num => num * 1000,
+  }));
+
+  const importedMock = await import('../index.js');
+  expect(importedMock.double(2)).toBe(2000);
+
+  import.meta.jest.unstable_unmockModule('../index.js');
+
+  const importedMockAfterUnmock = await import('../index.js');
+  expect(importedMockAfterUnmock.double(2)).toBe(4);
+});
+
+test('can unmock transitive module', async () => {
+  import.meta.jest.unstable_mockModule('../index.js', () => ({
+    double: num => num * 1000,
+  }));
+
+  const importedMock = await import('../reexport.js');
+  expect(importedMock.double(2)).toBe(2000);
+
+  import.meta.jest.unstable_unmockModule('../index.js');
+
+  const importedMockAfterUnmock = await import('../reexport.js');
+  expect(importedMockAfterUnmock.double(2)).toBe(4);
+});
+
+test("can unmock module; don't override mock", async () => {
+  import.meta.jest.unstable_mockModule('../index.js', () => ({
+    double: num => num * 1000,
+  }));
+
+  const importedMock = await import('../index.js');
+  expect(importedMock.double(2)).toBe(2000);
+
+  import.meta.jest.unstable_unmockModule('../index.js');
+
+  const importedMockAfterUnmock = await import('../index.js');
+  expect(importedMockAfterUnmock.double(2)).toBe(4);
+
+  import.meta.jest.unstable_mockModule('../index.js', () => ({
+    double: () => 'never call',
+  }));
+
+  const importedMockAfterOverride = await import('../index.js');
+  expect(importedMockAfterOverride.double(2)).not.toBe('never call');
+  expect(importedMockAfterOverride.double(2)).toBe(2000);
+});
diff --git c/e2e/native-esm/__tests__/native-esm.test.js w/e2e/native-esm/__tests__/native-esm.test.js
index 2f5070a826..0b2a0a009d 100644
--- c/e2e/native-esm/__tests__/native-esm.test.js
+++ w/e2e/native-esm/__tests__/native-esm.test.js
@@ -224,76 +224,6 @@ test('require of ESM should throw correct error', () => {
   );
 });
 
-test('can mock module', async () => {
-  jestObject.unstable_mockModule('../mockedModule.mjs', () => ({foo: 'bar'}), {
-    virtual: true,
-  });
-
-  const importedMock = await import('../mockedModule.mjs');
-
-  expect(Object.keys(importedMock)).toEqual(['foo']);
-  expect(importedMock.foo).toBe('bar');
-});
-
-test('can mock transitive module', async () => {
-  jestObject.unstable_mockModule('../index.js', () => ({foo: 'bar'}));
-
-  const importedMock = await import('../reexport.js');
-
-  expect(Object.keys(importedMock)).toEqual(['foo']);
-  expect(importedMock.foo).toBe('bar');
-});
-
-test('can unmock module', async () => {
-  jestObject.unstable_mockModule('../index.js', () => ({
-    double: num => num * 1000,
-  }));
-
-  const importedMock = await import('../index.js');
-  expect(importedMock.double(2)).toBe(2000);
-
-  jestObject.unstable_unmockModule('../index.js');
-
-  const importedMockAfterUnmock = await import('../index.js');
-  expect(importedMockAfterUnmock.double(2)).toBe(4);
-});
-
-test('can unmock transitive module', async () => {
-  jestObject.unstable_mockModule('../index.js', () => ({
-    double: num => num * 1000,
-  }));
-
-  const importedMock = await import('../reexport.js');
-  expect(importedMock.double(2)).toBe(2000);
-
-  jestObject.unstable_unmockModule('../index.js');
-
-  const importedMockAfterUnmock = await import('../reexport.js');
-  expect(importedMockAfterUnmock.double(2)).toBe(4);
-});
-
-test('can unmock module; don`t override mock', async () => {
-  jestObject.unstable_mockModule('../index.js', () => ({
-    double: num => num * 1000,
-  }));
-
-  const importedMock = await import('../index.js');
-  expect(importedMock.double(2)).toBe(2000);
-
-  jestObject.unstable_unmockModule('../index.js');
-
-  const importedMockAfterUnmock = await import('../index.js');
-  expect(importedMockAfterUnmock.double(2)).toBe(4);
-
-  jestObject.unstable_mockModule('../index.js', () => ({
-    double: () => 'never call',
-  }));
-
-  const importedMockAfterOverride = await import('../index.js');
-  expect(importedMockAfterOverride.double(2)).not.toBe('never call');
-  expect(importedMockAfterOverride.double(2)).toBe(2000);
-});
-
 test('supports imports using "node:" prefix', () => {
   expect(dns).toBe(prefixDns);
 });

BondarenkoAlex · 2024-06-02T13:24:35Z

CI is currently failing on the new tests added. One thing is that the snapshots aren't updated (you can do so by running yarn jest nativeEsm.test -u). However, the main problem is that those new tests are failing. The best way to work on them locally is to cd into e2e/native-esm and run yarn followed by node --experimental-vm-modules --no-warnings ../../packages/jest/bin/jest.js.

bondarenko@MacBook-Pro-Banki-2 native-esm % node --experimental-vm-modules --no-warnings ../../packages/jest/bin/jest.js
node:internal/modules/cjs/loader:435
      throw err;
      ^

Error: Cannot find module '/Users/bondarenko/Documents/Bond/jest/packages/jest-cli/build/index.js'. Please verify that the package.json has a valid "main" entry
    at tryPackage (node:internal/modules/cjs/loader:427:19)
    at Function.Module._findPath (node:internal/modules/cjs/loader:640:18)
    at Function.Module._resolveFilename (node:internal/modules/cjs/loader:1014:27)
    at Function.Module._load (node:internal/modules/cjs/loader:873:27)
    at Module.require (node:internal/modules/cjs/loader:1100:19)
    at require (node:internal/modules/cjs/helpers:108:18)
    at Object.<anonymous> (/Users/bondarenko/Documents/Bond/jest/packages/jest-cli/bin/jest.js:16:3)
    at Module._compile (node:internal/modules/cjs/loader:1198:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1252:10)
    at Module.load (node:internal/modules/cjs/loader:1076:32) {
  code: 'MODULE_NOT_FOUND',
  path: '/Users/bondarenko/Documents/Bond/jest/packages/jest-cli/package.json',
  requestPath: '..'
}

https://github.com/jestjs/jest/blob/main/packages/jest-cli/bin/jest.js#L16

Closes jestjs#15079

BondarenkoAlex · 2024-06-23T14:48:37Z

@SimenB @mrazauskas
All tests are passed.

SimenB

great stuff, thanks!

CHANGELOG.md

github-actions · 2024-08-02T00:09:51Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

BondarenkoAlex mentioned this pull request May 21, 2024

[Bug]: jest.resetModules does not works for jest.unstable_mockModule #15079

Closed

SimenB requested changes May 21, 2024

View reviewed changes

BondarenkoAlex force-pushed the main branch 4 times, most recently from f53d35b to 5294823 Compare May 26, 2024 20:38

mrazauskas reviewed May 27, 2024

View reviewed changes

packages/jest-types/__typetests__/jest.test.ts Outdated Show resolved Hide resolved

mrazauskas reviewed May 27, 2024

View reviewed changes

packages/jest-environment/src/index.ts Outdated Show resolved Hide resolved

mrazauskas reviewed May 27, 2024

View reviewed changes

packages/jest-environment/src/index.ts Outdated Show resolved Hide resolved

BondarenkoAlex force-pushed the main branch 3 times, most recently from d91b8a7 to 87db828 Compare May 27, 2024 12:44

SimenB requested changes May 29, 2024

View reviewed changes

SimenB reviewed May 29, 2024

View reviewed changes

BondarenkoAlex force-pushed the main branch from 87db828 to 11254a0 Compare June 4, 2024 16:16

BondarenkoAlex force-pushed the main branch from 11254a0 to e2ea999 Compare June 16, 2024 14:03

BondarenkoAlex force-pushed the main branch from e2ea999 to 9bc8a23 Compare June 23, 2024 14:16

BondarenkoAlex added 5 commits June 23, 2024 17:26

feat: add support unstable_unmockModule

f114dfb

Closes jestjs#15079

test: add integration test for unstable_unmockModule

7a2c4af

Closes jestjs#15079

chore: add types for unstable_unmockModule

86aae09

Closes jestjs#15079

docs: add doc for unstable_unmockModule

4607472

Closes jestjs#15079

chore: update CHANGELOG.md

ff0e2e9

Closes jestjs#15079

BondarenkoAlex force-pushed the main branch from 9bc8a23 to ff0e2e9 Compare June 23, 2024 14:30

BondarenkoAlex requested a review from SimenB June 25, 2024 16:38

SimenB approved these changes Jun 30, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

818e185

SimenB merged commit 9c9ce8a into jestjs:main Jun 30, 2024
5 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Aug 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support unstable_unmockModule #15080

feat: add support unstable_unmockModule #15080

BondarenkoAlex commented May 21, 2024

linux-foundation-easycla bot commented May 21, 2024 •

edited

Loading

netlify bot commented May 21, 2024 •

edited

Loading

SimenB left a comment •

edited

Loading

mrazauskas commented May 23, 2024

BondarenkoAlex commented May 24, 2024

mrazauskas commented May 24, 2024

SimenB left a comment

SimenB May 29, 2024

BondarenkoAlex Jun 2, 2024

SimenB commented May 29, 2024

BondarenkoAlex commented Jun 2, 2024 •

edited

Loading

BondarenkoAlex commented Jun 23, 2024

SimenB left a comment

github-actions bot commented Aug 2, 2024


		jestObject.unstable_unmockModule('../index.js');

		const importedMockAfterUnmock = await import('../reexport.js');

feat: add support unstable_unmockModule #15080

feat: add support unstable_unmockModule #15080

Conversation

BondarenkoAlex commented May 21, 2024

Summary

Test plan

linux-foundation-easycla bot commented May 21, 2024 • edited Loading

netlify bot commented May 21, 2024 • edited Loading

✅ Deploy Preview for jestjs ready!

SimenB left a comment • edited Loading

Choose a reason for hiding this comment

mrazauskas commented May 23, 2024

BondarenkoAlex commented May 24, 2024

mrazauskas commented May 24, 2024

SimenB left a comment

Choose a reason for hiding this comment

SimenB May 29, 2024

Choose a reason for hiding this comment

BondarenkoAlex Jun 2, 2024

Choose a reason for hiding this comment

SimenB commented May 29, 2024

BondarenkoAlex commented Jun 2, 2024 • edited Loading

BondarenkoAlex commented Jun 23, 2024

SimenB left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 2, 2024

linux-foundation-easycla bot commented May 21, 2024 •

edited

Loading

netlify bot commented May 21, 2024 •

edited

Loading

SimenB left a comment •

edited

Loading

BondarenkoAlex commented Jun 2, 2024 •

edited

Loading