/
setupWorker.ts
231 lines (206 loc) · 6.68 KB
/
setupWorker.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
import { isNodeProcess } from 'is-node-process'
import { StrictEventEmitter } from 'strict-event-emitter'
import {
SetupWorkerInternalContext,
SetupWorkerApi,
ServiceWorkerIncomingEventsMap,
WorkerLifecycleEventsMap,
} from './glossary'
import { createStartHandler } from './start/createStartHandler'
import { createStop } from './stop/createStop'
import * as requestHandlerUtils from '../utils/internal/requestHandlerUtils'
import { ServiceWorkerMessage } from '../utils/createBroadcastChannel'
import { jsonParse } from '../utils/internal/jsonParse'
import { RequestHandler } from '../handlers/RequestHandler'
import { RestHandler } from '../handlers/RestHandler'
import { prepareStartHandler } from './start/utils/prepareStartHandler'
import { createFallbackStart } from './start/createFallbackStart'
import { createFallbackStop } from './stop/createFallbackStop'
import { devUtils } from '../utils/internal/devUtils'
import { pipeEvents } from '../utils/internal/pipeEvents'
interface Listener {
target: EventTarget
eventType: string
callback: EventListener
}
// Declare the list of event handlers on the module's scope
// so it persists between Fash refreshes of the application's code.
let listeners: Listener[] = []
/**
* Creates a new mock Service Worker registration
* with the given request handlers.
* @param {RequestHandler[]} requestHandlers List of request handlers
* @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker`}
*/
export function setupWorker(
...requestHandlers: RequestHandler[]
): SetupWorkerApi {
requestHandlers.forEach((handler) => {
if (Array.isArray(handler))
throw new Error(
devUtils.formatMessage(
'Failed to call "setupWorker" given an Array of request handlers (setupWorker([a, b])), expected to receive each handler individually: setupWorker(a, b).',
),
)
})
// Error when attempting to run this function in a Node.js environment.
if (isNodeProcess()) {
throw new Error(
devUtils.formatMessage(
'Failed to execute `setupWorker` in a non-browser environment. Consider using `setupServer` for Node.js environment instead.',
),
)
}
const emitter = new StrictEventEmitter<WorkerLifecycleEventsMap>()
const publicEmitter = new StrictEventEmitter<WorkerLifecycleEventsMap>()
pipeEvents(emitter, publicEmitter)
const context: SetupWorkerInternalContext = {
// Mocking is not considered enabled until the worker
// signals back the successful activation event.
isMockingEnabled: false,
startOptions: undefined,
worker: null,
registration: null,
requestHandlers: [...requestHandlers],
emitter,
workerChannel: {
on(eventType, callback) {
context.events.addListener(
navigator.serviceWorker,
'message',
(event: MessageEvent) => {
// Avoid messages broadcasted from unrelated workers.
if (event.source !== context.worker) {
return
}
const message = jsonParse<
ServiceWorkerMessage<typeof eventType, any>
>(event.data)
if (!message) {
return
}
if (message.type === eventType) {
callback(event, message)
}
},
)
},
send(type) {
context.worker?.postMessage(type)
},
},
events: {
addListener(
target: EventTarget,
eventType: string,
callback: EventListener,
) {
target.addEventListener(eventType, callback)
listeners.push({ eventType, target, callback })
return () => {
target.removeEventListener(eventType, callback)
}
},
removeAllListeners() {
for (const { target, eventType, callback } of listeners) {
target.removeEventListener(eventType, callback)
}
listeners = []
},
once(eventType) {
const bindings: Array<() => void> = []
return new Promise<
ServiceWorkerMessage<
typeof eventType,
ServiceWorkerIncomingEventsMap[typeof eventType]
>
>((resolve, reject) => {
const handleIncomingMessage = (event: MessageEvent) => {
try {
const message = JSON.parse(event.data)
if (message.type === eventType) {
resolve(message)
}
} catch (error) {
reject(error)
}
}
bindings.push(
context.events.addListener(
navigator.serviceWorker,
'message',
handleIncomingMessage,
),
context.events.addListener(
navigator.serviceWorker,
'messageerror',
reject,
),
)
}).finally(() => {
bindings.forEach((unbind) => unbind())
})
},
},
useFallbackMode:
!('serviceWorker' in navigator) || location.protocol === 'file:',
}
const startHandler = context.useFallbackMode
? createFallbackStart(context)
: createStartHandler(context)
const stopHandler = context.useFallbackMode
? createFallbackStop(context)
: createStop(context)
return {
start: prepareStartHandler(startHandler, context),
stop() {
context.events.removeAllListeners()
context.emitter.removeAllListeners()
publicEmitter.removeAllListeners()
stopHandler()
},
use(...handlers) {
requestHandlerUtils.use(context.requestHandlers, ...handlers)
},
restoreHandlers() {
requestHandlerUtils.restoreHandlers(context.requestHandlers)
},
resetHandlers(...nextHandlers) {
context.requestHandlers = requestHandlerUtils.resetHandlers(
requestHandlers,
...nextHandlers,
)
},
printHandlers() {
context.requestHandlers.forEach((handler) => {
const { header, callFrame } = handler.info
const pragma = handler.info.hasOwnProperty('operationType')
? '[graphql]'
: '[rest]'
console.groupCollapsed(`${pragma} ${header}`)
if (callFrame) {
console.log(`Declaration: ${callFrame}`)
}
console.log('Handler:', handler)
if (handler instanceof RestHandler) {
console.log(
'Match:',
`https://mswjs.io/repl?path=${handler.info.path}`,
)
}
console.groupEnd()
})
},
events: {
on(...args) {
return publicEmitter.on(...args)
},
removeListener(...args) {
return publicEmitter.removeListener(...args)
},
removeAllListeners(...args) {
return publicEmitter.removeAllListeners(...args)
},
},
}
}