Skip to content

Commit e73c381

Browse files
authored
fix(vite): support virtual:msw imports in vitest (#2802)
1 parent 6d6aef1 commit e73c381

8 files changed

Lines changed: 139 additions & 103 deletions

File tree

‎src/vite/options.d.ts‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎src/vite/plugin.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -784,7 +784,7 @@ test('serves only the worker in worker-only mode with an absolute base URL', asy
784784
server.environments.client.pluginContainer.resolveId('virtual:msw'),
785785
).resolves.toBeNull()
786786
await expect(
787-
server.environments.ssr.pluginContainer.resolveId('virtual:msw/options'),
787+
server.environments.ssr.pluginContainer.resolveId('virtual:msw'),
788788
).resolves.toBeNull()
789789
})
790790

‎src/vite/plugin.ts‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import type { Plugin } from 'vite'
55
const WORKER_FILENAME = 'mockServiceWorker.js'
66
const WORKER_SCRIPT_PATH = new URL('../mockServiceWorker.js', import.meta.url)
77
const VIRTUAL_MODULE_ID = 'virtual:msw'
8-
const VIRTUAL_OPTIONS_ID = 'virtual:msw/options'
98
const RUNTIME_PATH = fileURLToPath(new URL('./runtime.js', import.meta.url))
109

1110
export interface MswPluginOptions {
@@ -53,33 +52,37 @@ export function msw(options: MswPluginOptions = {}): Plugin {
5352

5453
return {
5554
name: 'msw',
56-
async resolveId(id) {
55+
resolveId(id) {
5756
if (mode === 'worker-only') {
5857
return
5958
}
6059

61-
if (id === VIRTUAL_OPTIONS_ID) {
62-
return `\0${VIRTUAL_OPTIONS_ID}`
63-
}
64-
6560
if (id === VIRTUAL_MODULE_ID) {
66-
return this.resolve(RUNTIME_PATH)
61+
return `\0${VIRTUAL_MODULE_ID}`
6762
}
6863
},
6964
load(id) {
70-
if (mode === 'worker-only' || id !== `\0${VIRTUAL_OPTIONS_ID}`) {
65+
if (mode === 'worker-only' || id !== `\0${VIRTUAL_MODULE_ID}`) {
7166
return
7267
}
7368

69+
// Tools like Vitest import the runtime natively when it's installed
70+
// in "node_modules". Provide it with the environment's options from here
71+
// so it never has to import a virtual module that only Vite can resolve.
7472
if (this.environment.config.consumer === 'server') {
75-
return `export { defaultNetworkOptions } from 'msw/node'`
73+
return `
74+
import { defaultNetworkOptions } from 'msw/node'
75+
import { createNetwork } from ${JSON.stringify(RUNTIME_PATH)}
76+
export const network = await createNetwork(defaultNetworkOptions)
77+
`
7678
}
7779

7880
environmentsUsingNetwork.add(this.environment.name)
7981

8082
return `
8183
import { createDefaultNetworkOptions } from 'msw/browser'
82-
export const defaultNetworkOptions = createDefaultNetworkOptions(${JSON.stringify(workerUrl)})
84+
import { createNetwork } from ${JSON.stringify(RUNTIME_PATH)}
85+
export const network = await createNetwork(createDefaultNetworkOptions(${JSON.stringify(workerUrl)}))
8386
`
8487
},
8588
configResolved(config) {

‎src/vite/runtime.ts‎

Lines changed: 85 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,117 +1,117 @@
11
/// <reference types="vite/client" />
22

3-
import {
4-
defineNetwork,
5-
NetworkReadyState,
6-
type NetworkApi,
7-
} from 'msw/experimental'
8-
import { defaultNetworkOptions } from 'virtual:msw/options'
3+
import { defineNetwork, NetworkReadyState } from 'msw/experimental'
94

105
const hot = import.meta.hot
116
const hotData: { disposeNetwork?: () => Promise<void> } | undefined = hot?.data
127

13-
// SSR imports can re-evaluate this module before the old HMR listener runs.
14-
while (hotData?.disposeNetwork) {
15-
const disposePrevious = hotData.disposeNetwork
16-
await disposePrevious()
8+
export async function createNetwork(
9+
options: Parameters<typeof defineNetwork>[0],
10+
): Promise<ReturnType<typeof defineNetwork>> {
11+
// SSR imports can re-evaluate the network before the old HMR listener runs.
12+
while (hotData?.disposeNetwork) {
13+
const disposePrevious = hotData.disposeNetwork
14+
await disposePrevious()
1715

18-
if (hotData.disposeNetwork === disposePrevious) {
19-
break
16+
if (hotData.disposeNetwork === disposePrevious) {
17+
break
18+
}
2019
}
21-
}
2220

23-
export const network: NetworkApi<typeof defaultNetworkOptions.sources> =
24-
defineNetwork<typeof defaultNetworkOptions.sources>(defaultNetworkOptions)
21+
const network = defineNetwork(options)
2522

26-
if (hot && hotData) {
27-
let resumeAfterUpdate = false
28-
let retired = false
29-
let pendingOperation: Promise<void> | undefined
30-
const configure = network.configure
31-
const enable = network.enable
32-
const disable = network.disable
23+
if (hot && hotData) {
24+
let resumeAfterUpdate = false
25+
let retired = false
26+
let pendingOperation: Promise<void> | undefined
27+
const configure = network.configure
28+
const enable = network.enable
29+
const disable = network.disable
3330

34-
const runOperation = (action: () => void | Promise<void>) => {
35-
const result = pendingOperation ? pendingOperation.then(action) : action()
31+
const runOperation = (action: () => void | Promise<void>) => {
32+
const result = pendingOperation ? pendingOperation.then(action) : action()
3633

37-
if (result instanceof Promise) {
38-
const operation = result.finally(() => {
39-
if (pendingOperation === operation) {
40-
pendingOperation = undefined
41-
}
42-
})
43-
pendingOperation = operation
34+
if (result instanceof Promise) {
35+
const operation = result.finally(() => {
36+
if (pendingOperation === operation) {
37+
pendingOperation = undefined
38+
}
39+
})
40+
pendingOperation = operation
4441

45-
return operation
42+
return operation
43+
}
4644
}
47-
}
4845

49-
const stop = () => {
50-
if (network.readyState === NetworkReadyState.ENABLED) {
51-
return disable()
46+
const stop = () => {
47+
if (network.readyState === NetworkReadyState.ENABLED) {
48+
return disable()
49+
}
5250
}
53-
}
5451

55-
// An SSR entry may be re-evaluated while this module remains cached.
56-
network.configure = (options) => {
57-
void runOperation(() => {
58-
if (retired) {
59-
return
60-
}
52+
// An SSR entry may be re-evaluated while this module remains cached.
53+
network.configure = (options) => {
54+
void runOperation(() => {
55+
if (retired) {
56+
return
57+
}
6158

62-
const stopped = stop()
59+
const stopped = stop()
6360

64-
if (stopped instanceof Promise) {
65-
return stopped.then(() => configure(options))
66-
}
61+
if (stopped instanceof Promise) {
62+
return stopped.then(() => configure(options))
63+
}
6764

68-
configure(options)
69-
})
70-
}
71-
network.enable = async () => {
72-
await runOperation(() => {
73-
if (!retired && network.readyState === NetworkReadyState.DISABLED) {
74-
return enable()
75-
}
76-
})
77-
}
78-
network.disable = async () => {
79-
await runOperation(stop)
80-
}
65+
configure(options)
66+
})
67+
}
68+
network.enable = async () => {
69+
await runOperation(() => {
70+
if (!retired && network.readyState === NetworkReadyState.DISABLED) {
71+
return enable()
72+
}
73+
})
74+
}
75+
network.disable = async () => {
76+
await runOperation(stop)
77+
}
8178

82-
const disableNetwork = async () => {
83-
await network.disable()
84-
}
79+
const disableNetwork = async () => {
80+
await network.disable()
81+
}
8582

86-
const beforeUpdate = async () => {
87-
resumeAfterUpdate = network.readyState === NetworkReadyState.ENABLED
88-
await disableNetwork()
89-
}
83+
const beforeUpdate = async () => {
84+
resumeAfterUpdate = network.readyState === NetworkReadyState.ENABLED
85+
await disableNetwork()
86+
}
9087

91-
const afterUpdate = async () => {
92-
const shouldResume = resumeAfterUpdate
93-
resumeAfterUpdate = false
88+
const afterUpdate = async () => {
89+
const shouldResume = resumeAfterUpdate
90+
resumeAfterUpdate = false
9491

95-
if (shouldResume && network.readyState === NetworkReadyState.DISABLED) {
96-
await network.enable()
92+
if (shouldResume && network.readyState === NetworkReadyState.DISABLED) {
93+
await network.enable()
94+
}
9795
}
98-
}
9996

100-
hot.on('vite:beforeUpdate', beforeUpdate)
101-
hot.on('vite:afterUpdate', afterUpdate)
102-
hot.on('vite:beforeFullReload', disableNetwork)
97+
hot.on('vite:beforeUpdate', beforeUpdate)
98+
hot.on('vite:afterUpdate', afterUpdate)
99+
hot.on('vite:beforeFullReload', disableNetwork)
100+
101+
const disposeNetwork = async () => {
102+
retired = true
103+
resumeAfterUpdate = false
103104

104-
const disposeNetwork = async () => {
105-
retired = true
106-
resumeAfterUpdate = false
105+
hot.off('vite:beforeUpdate', beforeUpdate)
106+
hot.off('vite:afterUpdate', afterUpdate)
107+
hot.off('vite:beforeFullReload', disableNetwork)
107108

108-
hot.off('vite:beforeUpdate', beforeUpdate)
109-
hot.off('vite:afterUpdate', afterUpdate)
110-
hot.off('vite:beforeFullReload', disableNetwork)
109+
await disableNetwork()
110+
}
111111

112-
await disableNetwork()
112+
hotData.disposeNetwork = disposeNetwork
113+
hot.dispose(disposeNetwork)
113114
}
114115

115-
hotData.disposeNetwork = disposeNetwork
116-
hot.dispose(disposeNetwork)
116+
return network
117117
}

‎src/vite/tsconfig.build.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"extends": "../../tsconfig.base.json",
3-
"include": ["./index.ts", "./plugin.ts", "./runtime.ts", "./options.d.ts"],
3+
"include": ["./index.ts", "./plugin.ts", "./runtime.ts"],
44
"compilerOptions": {
55
"types": ["node"]
66
}
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
/// <reference types="msw/vite/client" />
2+
/**
3+
* @see https://github.com/mswjs/msw/issues/2799
4+
*/
5+
import { http, HttpResponse } from 'msw/http'
6+
import { network } from 'virtual:msw'
7+
8+
beforeAll(async () => {
9+
await network.enable()
10+
})
11+
12+
afterEach(() => {
13+
network.resetHandlers()
14+
})
15+
16+
afterAll(async () => {
17+
await network.disable()
18+
})
19+
20+
test('applies a handler override from the virtual module network', async () => {
21+
network.use(
22+
http.get('http://localhost/user', () => {
23+
return HttpResponse.json({ id: 42, username: 'john' })
24+
}),
25+
)
26+
27+
const response = await fetch('http://localhost/user')
28+
29+
expect.soft(response.status).toBe(200)
30+
await expect(response.json()).resolves.toEqual({ id: 42, username: 'john' })
31+
})

‎tsdown.config.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ const viteConfig: UserConfig = {
7676
platform: 'node',
7777
entry: ['./src/vite/index.ts', './src/vite/runtime.ts'],
7878
deps: {
79-
neverBundle: ['vite', 'msw/experimental', 'virtual:msw/options'],
79+
neverBundle: ['vite', 'msw/experimental'],
8080
onlyBundle: false,
8181
},
8282
format: ['esm'],

‎vitest.config.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ export default defineConfig({
4242
test: {
4343
fileParallelism: true,
4444
globals: true,
45+
server: {
46+
deps: {
47+
// Load the built plugin natively, the same way Vitest
48+
// loads it from "node_modules" when "msw" is installed.
49+
external: [/\/lib\/vite\//],
50+
},
51+
},
4552
onConsoleLog(_log, _logType, entity) {
4653
return entity?.project.name !== 'browser'
4754
},

0 commit comments

Comments
 (0)