-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
mockLink.ts
216 lines (191 loc) · 6.46 KB
/
mockLink.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
import { invariant } from '../../../utilities/globals';
import { equal } from '@wry/equality';
import type {
Operation,
GraphQLRequest,
FetchResult} from '../../../link/core';
import {
ApolloLink
} from '../../../link/core';
import {
Observable,
addTypenameToDocument,
removeClientSetsFromDocument,
removeConnectionDirectiveFromDocument,
cloneDeep,
stringifyForDisplay,
print
} from '../../../utilities';
export type ResultFunction<T> = () => T;
export interface MockedResponse<
TData = Record<string, any>,
TVariables = Record<string, any>
> {
request: GraphQLRequest<TVariables>;
result?: FetchResult<TData> | ResultFunction<FetchResult<TData>>;
error?: Error;
delay?: number;
newData?: ResultFunction<FetchResult>;
}
export interface MockLinkOptions {
showWarnings?: boolean;
}
function requestToKey(request: GraphQLRequest, addTypename: Boolean): string {
const queryString =
request.query &&
print(addTypename ? addTypenameToDocument(request.query) : request.query);
const requestKey = { query: queryString };
return JSON.stringify(requestKey);
}
export class MockLink extends ApolloLink {
public operation: Operation;
public addTypename: Boolean = true;
public showWarnings: boolean = true;
private mockedResponsesByKey: { [key: string]: MockedResponse[] } = {};
constructor(
mockedResponses: ReadonlyArray<MockedResponse>,
addTypename: Boolean = true,
options: MockLinkOptions = Object.create(null)
) {
super();
this.addTypename = addTypename;
this.showWarnings = options.showWarnings ?? true;
if (mockedResponses) {
mockedResponses.forEach(mockedResponse => {
this.addMockedResponse(mockedResponse);
});
}
}
public addMockedResponse(mockedResponse: MockedResponse) {
const normalizedMockedResponse = this.normalizeMockedResponse(
mockedResponse
);
const key = requestToKey(
normalizedMockedResponse.request,
this.addTypename
);
let mockedResponses = this.mockedResponsesByKey[key];
if (!mockedResponses) {
mockedResponses = [];
this.mockedResponsesByKey[key] = mockedResponses;
}
mockedResponses.push(normalizedMockedResponse);
}
public request(operation: Operation): Observable<FetchResult> | null {
this.operation = operation;
const key = requestToKey(operation, this.addTypename);
const unmatchedVars: Array<Record<string, any>> = [];
const requestVariables = operation.variables || {};
const mockedResponses = this.mockedResponsesByKey[key];
const responseIndex = mockedResponses ? mockedResponses.findIndex((res, index) => {
const mockedResponseVars = res.request.variables || {};
if (equal(requestVariables, mockedResponseVars)) {
return true;
}
unmatchedVars.push(mockedResponseVars);
return false;
}) : -1;
const response = responseIndex >= 0
? mockedResponses[responseIndex]
: void 0;
let configError: Error;
if (!response) {
configError = new Error(
`No more mocked responses for the query: ${print(operation.query)}
Expected variables: ${stringifyForDisplay(operation.variables)}
${unmatchedVars.length > 0 ? `
Failed to match ${unmatchedVars.length} mock${
unmatchedVars.length === 1 ? "" : "s"
} for this query. The mocked response had the following variables:
${unmatchedVars.map(d => ` ${stringifyForDisplay(d)}`).join('\n')}
` : ""}`);
if (this.showWarnings) {
console.warn(
configError.message +
'\nThis typically indicates a configuration error in your mocks ' +
'setup, usually due to a typo or mismatched variable.'
);
}
} else {
mockedResponses.splice(responseIndex, 1);
const { newData } = response;
if (newData) {
response.result = newData();
mockedResponses.push(response);
}
if (!response.result && !response.error) {
configError = new Error(
`Mocked response should contain either result or error: ${key}`
);
}
}
return new Observable(observer => {
const timer = setTimeout(() => {
if (configError) {
try {
// The onError function can return false to indicate that
// configError need not be passed to observer.error. For
// example, the default implementation of onError calls
// observer.error(configError) and then returns false to
// prevent this extra (harmless) observer.error call.
if (this.onError(configError, observer) !== false) {
throw configError;
}
} catch (error) {
observer.error(error);
}
} else if (response) {
if (response.error) {
observer.error(response.error);
} else {
if (response.result) {
observer.next(
typeof response.result === 'function'
? (response.result as ResultFunction<FetchResult>)()
: response.result
);
}
observer.complete();
}
}
}, response && response.delay || 0);
return () => {
clearTimeout(timer);
};
});
}
private normalizeMockedResponse(
mockedResponse: MockedResponse
): MockedResponse {
const newMockedResponse = cloneDeep(mockedResponse);
const queryWithoutConnection = removeConnectionDirectiveFromDocument(
newMockedResponse.request.query
);
invariant(queryWithoutConnection, "query is required");
newMockedResponse.request.query = queryWithoutConnection!;
const query = removeClientSetsFromDocument(newMockedResponse.request.query);
if (query) {
newMockedResponse.request.query = query;
}
return newMockedResponse;
}
}
export interface MockApolloLink extends ApolloLink {
operation?: Operation;
}
// Pass in multiple mocked responses, so that you can test flows that end up
// making multiple queries to the server.
// NOTE: The last arg can optionally be an `addTypename` arg.
export function mockSingleLink(
...mockedResponses: Array<any>
): MockApolloLink {
// To pull off the potential typename. If this isn't a boolean, we'll just
// set it true later.
let maybeTypename = mockedResponses[mockedResponses.length - 1];
let mocks = mockedResponses.slice(0, mockedResponses.length - 1);
if (typeof maybeTypename !== 'boolean') {
mocks = mockedResponses;
maybeTypename = true;
}
return new MockLink(mocks, maybeTypename);
}