-
-
Notifications
You must be signed in to change notification settings - Fork 472
/
RequestHandler.ts
286 lines (247 loc) · 7.25 KB
/
RequestHandler.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
277
278
279
280
281
282
283
284
285
286
import { Headers } from 'headers-polyfill'
import {
MaybePromise,
MockedResponse,
response,
ResponseComposition,
} from '../response'
import { getCallFrame } from '../utils/internal/getCallFrame'
import { isIterable } from '../utils/internal/isIterable'
import { status } from '../context/status'
import { set } from '../context/set'
import { delay } from '../context/delay'
import { fetch } from '../context/fetch'
import { ResponseResolutionContext } from '../utils/getResponse'
import { SerializedResponse } from '../setupWorker/glossary'
import { MockedRequest } from '../utils/request/MockedRequest'
export type DefaultContext = {
status: typeof status
set: typeof set
delay: typeof delay
fetch: typeof fetch
}
export const defaultContext: DefaultContext = {
status,
set,
delay,
fetch,
}
export type DefaultRequestMultipartBody = Record<
string,
string | File | (string | File)[]
>
export type DefaultBodyType =
| Record<string, any>
| DefaultRequestMultipartBody
| string
| number
| boolean
| null
| undefined
export interface RequestHandlerDefaultInfo {
header: string
}
export interface RequestHandlerInternalInfo {
callFrame?: string
}
type ContextMap = Record<string, (...args: any[]) => any>
export type ResponseResolverReturnType<ReturnType> =
| ReturnType
| undefined
| void
export type MaybeAsyncResponseResolverReturnType<ReturnType> = MaybePromise<
ResponseResolverReturnType<ReturnType>
>
export type AsyncResponseResolverReturnType<ReturnType> =
| MaybeAsyncResponseResolverReturnType<ReturnType>
| Generator<
MaybeAsyncResponseResolverReturnType<ReturnType>,
MaybeAsyncResponseResolverReturnType<ReturnType>,
MaybeAsyncResponseResolverReturnType<ReturnType>
>
export type ResponseResolver<
RequestType = MockedRequest,
ContextType = typeof defaultContext,
BodyType extends DefaultBodyType = any,
> = (
req: RequestType,
res: ResponseComposition<BodyType>,
context: ContextType,
) => AsyncResponseResolverReturnType<MockedResponse<BodyType>>
export interface RequestHandlerOptions<HandlerInfo> {
info: HandlerInfo
resolver: ResponseResolver<any, any>
ctx?: ContextMap
}
export interface RequestHandlerExecutionResult<PublicRequestType> {
handler: RequestHandler
parsedResult: any
request: PublicRequestType
response?: MockedResponse
}
export abstract class RequestHandler<
HandlerInfo extends RequestHandlerDefaultInfo = RequestHandlerDefaultInfo,
Request extends MockedRequest = MockedRequest,
ParsedResult = any,
PublicRequest extends MockedRequest = Request,
> {
public info: HandlerInfo & RequestHandlerInternalInfo
public shouldSkip: boolean
private ctx: ContextMap
private resolverGenerator?: Generator<
MaybeAsyncResponseResolverReturnType<any>,
MaybeAsyncResponseResolverReturnType<any>,
MaybeAsyncResponseResolverReturnType<any>
>
private resolverGeneratorResult?: MaybeAsyncResponseResolverReturnType<any>
protected resolver: ResponseResolver<any, any>
constructor(options: RequestHandlerOptions<HandlerInfo>) {
this.shouldSkip = false
this.ctx = options.ctx || defaultContext
this.resolver = options.resolver
const callFrame = getCallFrame(new Error())
this.info = {
...options.info,
callFrame,
}
}
/**
* Determine if the captured request should be mocked.
*/
abstract predicate(
request: MockedRequest,
parsedResult: ParsedResult,
resolutionContext?: ResponseResolutionContext,
): boolean
/**
* Print out the successfully handled request.
*/
abstract log(
request: Request,
response: SerializedResponse<any>,
parsedResult: ParsedResult,
): void
/**
* Parse the captured request to extract additional information from it.
* Parsed result is then exposed to other methods of this request handler.
*/
parse(
_request: MockedRequest,
_resolutionContext?: ResponseResolutionContext,
): ParsedResult {
return null as any
}
/**
* Test if this handler matches the given request.
*/
public test(
request: MockedRequest,
resolutionContext?: ResponseResolutionContext,
): boolean {
return this.predicate(
request,
this.parse(request, resolutionContext),
resolutionContext,
)
}
/**
* Derive the publicly exposed request (`req`) instance of the response resolver
* from the captured request and its parsed result.
*/
protected getPublicRequest(
request: MockedRequest,
_parsedResult: ParsedResult,
) {
return request as PublicRequest
}
public markAsSkipped(shouldSkip = true) {
this.shouldSkip = shouldSkip
}
/**
* Execute this request handler and produce a mocked response
* using the given resolver function.
*/
public async run(
request: MockedRequest,
resolutionContext?: ResponseResolutionContext,
): Promise<RequestHandlerExecutionResult<PublicRequest> | null> {
if (this.shouldSkip) {
return null
}
const parsedResult = this.parse(request, resolutionContext)
const shouldIntercept = this.predicate(
request,
parsedResult,
resolutionContext,
)
if (!shouldIntercept) {
return null
}
const publicRequest = this.getPublicRequest(request, parsedResult)
// Create a response extraction wrapper around the resolver
// since it can be both an async function and a generator.
const executeResolver = this.wrapResolver(this.resolver)
const mockedResponse = await executeResolver(
publicRequest,
response,
this.ctx,
)
return this.createExecutionResult(
parsedResult,
publicRequest,
mockedResponse,
)
}
private wrapResolver(
resolver: ResponseResolver<any, any>,
): ResponseResolver<AsyncResponseResolverReturnType<any>, any> {
return async (req, res, ctx) => {
const result = this.resolverGenerator || (await resolver(req, res, ctx))
if (isIterable<AsyncResponseResolverReturnType<any>>(result)) {
const { value, done } = result[Symbol.iterator]().next()
const nextResponse = await value
// If the generator is done and there is no next value,
// return the previous generator's value.
if (!nextResponse && done) {
return this.resolverGeneratorResult
}
if (!this.resolverGenerator) {
this.resolverGenerator = result
}
this.resolverGeneratorResult = nextResponse
return nextResponse
}
return result
}
}
private createExecutionResult(
parsedResult: ParsedResult,
request: PublicRequest,
response: any,
): RequestHandlerExecutionResult<PublicRequest> {
return {
handler: this,
parsedResult: parsedResult || null,
request,
response: response || null,
}
}
}
/**
* Bypass this intercepted request.
* This will make a call to the actual endpoint requested.
*/
export function passthrough(): MockedResponse<null> {
// Constructing a dummy "101 Continue" mocked response
// to keep the return type of the resolver consistent.
return {
status: 101,
statusText: 'Continue',
headers: new Headers(),
body: null,
// Setting "passthrough" to true will signal the response pipeline
// to perform this intercepted request as-is.
passthrough: true,
once: false,
}
}