/
handleRequest.test.ts
276 lines (239 loc) · 7.91 KB
/
handleRequest.test.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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
import { Headers } from 'headers-polyfill'
import { StrictEventEmitter } from 'strict-event-emitter'
import { ServerLifecycleEventsMap } from '../node/glossary'
import { SharedOptions } from '../sharedOptions'
import { RequestHandler } from '../handlers/RequestHandler'
import { rest } from '../rest'
import { handleRequest, HandleRequestOptions } from './handleRequest'
import { response } from '../response'
import { context, MockedRequest } from '..'
import { RequiredDeep } from '../typeUtils'
const options: RequiredDeep<SharedOptions> = {
onUnhandledRequest: jest.fn(),
}
const callbacks: Partial<Record<keyof HandleRequestOptions<any>, any>> = {
onPassthroughResponse: jest.fn(),
onMockedResponse: jest.fn(),
}
function setup() {
const emitter = new StrictEventEmitter<ServerLifecycleEventsMap>()
const listener = jest.fn()
const createMockListener = (name: string) => {
return (...args: any) => {
listener(name, ...args)
}
}
emitter.on('request:start', createMockListener('request:start'))
emitter.on('request:match', createMockListener('request:match'))
emitter.on('request:unhandled', createMockListener('request:unhandled'))
emitter.on('request:end', createMockListener('request:end'))
emitter.on('response:mocked', createMockListener('response:mocked'))
emitter.on('response:bypass', createMockListener('response:bypass'))
const events = listener.mock.calls
return { emitter, events }
}
beforeEach(() => {
jest.spyOn(global.console, 'warn').mockImplementation()
})
afterEach(() => {
jest.resetAllMocks()
})
test('returns undefined for a request with the "x-msw-bypass" header equal to "true"', async () => {
const { emitter, events } = setup()
const request = new MockedRequest(new URL('http://localhost/user'), {
headers: new Headers({
'x-msw-bypass': 'true',
}),
})
const handlers: Array<RequestHandler> = []
const result = await handleRequest(
request,
handlers,
options,
emitter,
callbacks,
)
expect(result).toBeUndefined()
expect(events).toEqual([
['request:start', request],
['request:end', request],
])
expect(options.onUnhandledRequest).not.toHaveBeenCalled()
expect(callbacks.onPassthroughResponse).toHaveBeenNthCalledWith(1, request)
expect(callbacks.onMockedResponse).not.toHaveBeenCalled()
})
test('does not bypass a request with "x-msw-bypass" header set to arbitrary value', async () => {
const { emitter } = setup()
const request = new MockedRequest(new URL('http://localhost/user'), {
headers: new Headers({
'x-msw-bypass': 'anything',
}),
})
const handlers: Array<RequestHandler> = [
rest.get('/user', (req, res, ctx) => {
return res(ctx.text('hello world'))
}),
]
const result = await handleRequest(
request,
handlers,
options,
emitter,
callbacks,
)
expect(result).not.toBeUndefined()
expect(options.onUnhandledRequest).not.toHaveBeenCalled()
expect(callbacks.onMockedResponse).toHaveBeenCalledTimes(1)
})
test('reports request as unhandled when it has no matching request handlers', async () => {
const { emitter, events } = setup()
const request = new MockedRequest(new URL('http://localhost/user'))
const handlers: Array<RequestHandler> = []
const result = await handleRequest(
request,
handlers,
options,
emitter,
callbacks,
)
expect(result).toBeUndefined()
expect(events).toEqual([
['request:start', request],
['request:unhandled', request],
['request:end', request],
])
expect(options.onUnhandledRequest).toHaveBeenNthCalledWith(1, request, {
warning: expect.any(Function),
error: expect.any(Function),
})
expect(callbacks.onPassthroughResponse).toHaveBeenNthCalledWith(1, request)
expect(callbacks.onMockedResponse).not.toHaveBeenCalled()
})
test('returns undefined and warns on a request handler that returns no response', async () => {
const { emitter, events } = setup()
const request = new MockedRequest(new URL('http://localhost/user'))
const handlers: Array<RequestHandler> = [
rest.get('/user', () => {
// Intentionally blank response resolver.
return
}),
]
const result = await handleRequest(
request,
handlers,
options,
emitter,
callbacks,
)
expect(result).toBeUndefined()
expect(events).toEqual([
['request:start', request],
['request:end', request],
])
expect(options.onUnhandledRequest).not.toHaveBeenCalled()
expect(callbacks.onPassthroughResponse).toHaveBeenNthCalledWith(1, request)
expect(callbacks.onMockedResponse).not.toHaveBeenCalled()
expect(console.warn).toHaveBeenCalledTimes(1)
const warning = (console.warn as unknown as jest.SpyInstance).mock.calls[0][0]
expect(warning).toContain(
'[MSW] Expected response resolver to return a mocked response Object, but got undefined. The original response is going to be used instead.',
)
expect(warning).toContain('GET /user')
expect(warning).toMatch(/\d+:\d+/)
})
test('returns the mocked response for a request with a matching request handler', async () => {
const { emitter, events } = setup()
const request = new MockedRequest(new URL('http://localhost/user'))
const mockedResponse = await response(context.json({ firstName: 'John' }))
const handlers: Array<RequestHandler> = [
rest.get('/user', () => {
return mockedResponse
}),
]
const lookupResult = {
handler: handlers[0],
response: mockedResponse,
publicRequest: { ...request, params: {} },
parsedRequest: { matches: true, params: {} },
}
const result = await handleRequest(
request,
handlers,
options,
emitter,
callbacks,
)
expect(result).toEqual(mockedResponse)
expect(events).toEqual([
['request:start', request],
['request:match', request],
['request:end', request],
])
expect(callbacks.onPassthroughResponse).not.toHaveBeenCalled()
expect(callbacks.onMockedResponse).toHaveBeenNthCalledWith(
1,
mockedResponse,
lookupResult,
)
})
test('returns a transformed response if the "transformResponse" option is provided', async () => {
const { emitter, events } = setup()
const request = new MockedRequest(new URL('http://localhost/user'))
const mockedResponse = await response(context.json({ firstName: 'John' }))
const handlers: Array<RequestHandler> = [
rest.get('/user', () => {
return mockedResponse
}),
]
const transformResponse = jest.fn().mockImplementation((response) => ({
body: response.body,
}))
const finalResponse = transformResponse(mockedResponse)
const lookupResult = {
handler: handlers[0],
response: mockedResponse,
publicRequest: { ...request, params: {} },
parsedRequest: { matches: true, params: {} },
}
const result = await handleRequest(request, handlers, options, emitter, {
...callbacks,
transformResponse,
})
expect(result).toEqual(finalResponse)
expect(events).toEqual([
['request:start', request],
['request:match', request],
['request:end', request],
])
expect(callbacks.onPassthroughResponse).not.toHaveBeenCalled()
expect(transformResponse).toHaveBeenNthCalledWith(1, mockedResponse)
expect(callbacks.onMockedResponse).toHaveBeenNthCalledWith(
1,
finalResponse,
lookupResult,
)
})
it('returns undefined without warning on a passthrough request', async () => {
const { emitter, events } = setup()
const request = new MockedRequest(new URL('http://localhost/user'))
const handlers: Array<RequestHandler> = [
rest.get('/user', (req) => {
return req.passthrough()
}),
]
const result = await handleRequest(
request,
handlers,
options,
emitter,
callbacks,
)
expect(result).toBeUndefined()
expect(events).toEqual([
['request:start', request],
['request:end', request],
])
expect(options.onUnhandledRequest).not.toHaveBeenCalled()
expect(callbacks.onPassthroughResponse).toHaveBeenNthCalledWith(1, request)
expect(callbacks.onMockedResponse).not.toHaveBeenCalled()
})