Add vi.createMockFromModule (Like jest.createMockFromModule)

[segevfiner]

Clear and concise description of the problem

I want to create a manual mock (__mocks__), but only specialize parts of the default mock that is automatically created by vitest, in Jest I could do:

import { jest } from '@jest/globals';

const mod = jest.createMockFromModule<typeof import('../foo')>('../foo');
mod.bar = jest.fn(() => 'qux');
export = mod;

But createMockFromModule is not available in Vitest, and importMock is not the same, as when used inside a manual mock, it just ends up importing the manual mock itself cyclicly. createMockFromModule always returns the automatically created mock object even if there is a manual mock.

Suggested solution

Add vi.createMockFromModule or under a different name that better fits it's async nature in vitest, that acts like vi.importMock but always return an automatically created mock even if there is a manual mock.

Alternative

Manually mock everything in the manual mock, which is cumbersome and harder to maintain.

Additional context

Encountered while migrating some tests from Jest to Vitest due to Jest's ESM issues.

#3718

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[hi-ogawa]

But createMockFromModule is not available in Vitest, and importMock is not the same, as when used inside a manual mock, it just ends up importing the manual mock itself cyclicly.

Is this maybe a bug? Or if it's causing some infinite loop, that needs to be fixed at least?

[segevfiner]

Not an infinite loop, you are just getting your own module namespace object as far as I can tell. And I think importMock is supposed to import manual mocks so not a bug as far as I can tell.

[hi-ogawa]

And I think importMock is supposed to import manual mocks so not a bug as far as I can tell.

It's called importMock, which sounds like an opposite of importActual https://vitest.dev/api/vi.html#vi-importactual but I thought the intent is simply "import actual + auto mocking" and could behave like Jest's createMockFromModule https://jestjs.io/docs/jest-object#jestcreatemockfrommodulemodulename.

vitest/packages/vitest/src/runtime/mocker.ts

Lines 437 to 455 in e4e939b

	public async importActual<T>(rawId: string, importer: string, callstack?: string[] | null): Promise<T> {
	const { id, fsPath } = await this.resolvePath(rawId, importer)
	const result = await this.executor.cachedRequest(id, fsPath, callstack || [importer])
	return result as T
	}
	public async importMock(rawId: string, importee: string): Promise<any> {
	const { id, fsPath, external } = await this.resolvePath(rawId, importee)
	const normalizedId = this.normalizePath(fsPath)
	let mock = this.getDependencyMock(normalizedId)
	if (mock === undefined)
	mock = this.resolveMockPath(fsPath, external)
	if (mock === null) {
	const mod = await this.executor.cachedRequest(id, fsPath, [importee])
	return this.mockObject(mod)
	}

Btw, can you setup a small reproduction to illustrate what you want to do with a concrete code? That would be helpful anyway as a test case if it's implemented. Also it would also help for us to suggest a workaround with what's currently possible.

One idea just came to my mind is to still use vi.mock and overwrite some exports like this:

// use `setupFiles` to setup mock for all test files

import { vi, beforeEach } from "vitest"
import * as fooLib from "./foo";

// setup auto mocking for a whole module
vi.mock("./foo");

beforeEach(() => {
  // then customize some named export
  vi.mocked(fooLib).bar.mockImplementation(() => 'qux');
});

[segevfiner]

@hi-ogawa Here is an attempt to show what I'm trying to do, though a bit of a contrived example, I hope it shows what I'm trying to do: https://github.com/segevfiner/vitest-partial-manual-mock

[sheremet-va]

I don't think we can support any dynamic imports for this use case because ESM needs to know every named import during parsing, but maybe we can support something like this:

// __mocks__/foo.js

export * from '../foo.js' with { mock: 'auto' }
export const bar = vi.fn(() => 'qux')

[segevfiner]

I don't think we can support any dynamic imports for this use case because ESM needs to know every named import during parsing, but maybe we can support something like this:

// __mocks__/foo.js

export * from '../foo.js' with { mock: 'auto' }
export const bar = vi.fn(() => 'qux')

AFAIK you can do dynamic imports in ESM, aka import(), though it is async so you will need top level await, what's not supported is dynamic export, e.g. replace the entire exports of this module with the given object, which is why I had to use export = which kinda fakes it by transpiling to CJS (module.exports = ...), but a valid way of doing this without relying on some special handling of that syntax by Vitest might be needed as you suggested.

[sheremet-va]

AFAIK you can do dynamic imports in ESM, aka import(), though it is async so you will need top level await, what's not supported is dynamic export

Yes, this is what I meant. The JS engine cannot parse the file to see all exported variables if you use a dynamic import because there is no mechanism to dynamically export variables.

e.g. replace the entire exports of this module with the given object, which is why I had to use export = which kinda fakes it by transpiling to CJS (module.exports = ...), but a valid way of doing this without relying on some special handling of that syntax by Vitest might be needed as you suggested.

This only works in Node.js runner because Vitest supports loading source code as CJS, this will not work in the browser (and module mocking is supported in the browser mode in the latest beta). This will also not work in future versions of Vitest because we cannot process files that were imported using require (you can currently import this file, but you cannot import other things in this file without leaving Vitest module system because all imports are transformed into require if it uses the CJS transform).

on some special handling of that syntax by Vitest might be needed as you suggested.

Also, export = is not an ESM syntax and it requires special handling to process already. My proposal already works with the ESM syntax, and it only requires the processing of the foo file, not the __mocks__/foo file.

[rezam7596]

To achieve the desired behavior, I used vi.mock within the __mocks__ file:

// __mocks__/foo.js

vi.mock('../foo.js', async (importOriginal) => ({
  ...(await importOriginal()),
  bar: vi.fn(() => 'qux')
}));

In the test file, I included:

vi.mock('./foo.js');

Initially, I wasn’t certain this logic would work, given that vi.mock is running within the __mocks__ directory. While it achieves the same behavior as jest.createMockFromModule, this approach may be impacted by future updates in Vitest, so it’s something to monitor.

[segevfiner]

Last time I tried, I got an infinite loop from vi.mock as it imported back the same manual mock module I'm currently defining.

[rezam7596]

For me, with the latest version (2.1.4), it worked

[hi-ogawa]

There was a related discussion with a similar use case #7548 and now I found that there might be an createMockFromModule alternative by directly using automocking utility from @vitest/mocker. Here is an example to mock all exports except one. cc @GerroDen

https://stackblitz.com/github/hi-ogawa/reproductions/tree/main/vitest-5482-createMockFromModule?file=foo.spec.ts

vi.mock(import("./foo"), async (importOriginal) => {
  const original = await importOriginal();
  // use automocking utility provided by @vitest/mocker
  const { vi } = await import("vitest");
  const { mockObject } = await import("@vitest/mocker");
  const mocked = mockObject(
    {
      type: "automock",
      spyOn: vi.spyOn,
      globalConstructors: {
        Object,
        Function,
        RegExp,
        Array,
        Map,
      },
    },
    original,
  );
  return {
    ...mocked,               // mock all exports
    addOne: original.addOne, // expect this one
  };
});

Perhaps we can support this vi.importActual + mockObject combo as vi utility. (Or should vi.importMock already work like that?)

[hi-ogawa]

For OP's case #5482 (comment), vi.importActual + mockObject should work though I think the main concern is about simulating export = mod without writing each named export in __mocks__ file.

Example: __mocks__/foo.ts

// __mocks__/foo.ts
import { vi } from 'vitest';
import { mockObject } from '@vitest/mocker';

const original = await vi.importActual('../foo');
const mocked = mockObject(
  {
    type: "automock",
    spyOn: vi.spyOn,
    globalConstructors: {
      Object,
      Function,
      RegExp,
      Array,
      Map,
    },
  },
  original,
);
export const foo = mocked.foo;
export const bar = mocked.bar;
export const hello = vi.fn(() => 'TEST');