-
Notifications
You must be signed in to change notification settings - Fork 4k
/
preloading.js
291 lines (248 loc) · 7.11 KB
/
preloading.js
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
287
288
289
290
291
/**
* Internal dependencies
*/
import createPreloadingMiddleware from '../preloading';
describe( 'Preloading Middleware', () => {
describe( 'given preloaded data', () => {
describe( 'when data is requested from a preloaded endpoint', () => {
describe( 'and it is requested for the first time', () => {
it( 'should return the preloaded data', () => {
const body = {
status: 'this is the preloaded response',
};
const preloadedData = {
'wp/v2/posts': {
body,
},
};
const preloadingMiddleware =
createPreloadingMiddleware( preloadedData );
const requestOptions = {
method: 'GET',
path: 'wp/v2/posts',
};
const response = preloadingMiddleware( requestOptions );
return response.then( ( value ) => {
expect( value ).toEqual( body );
} );
} );
} );
describe( 'and it has already been requested', () => {
it( 'should not return the preloaded data', () => {
const body = {
status: 'this is the preloaded response',
};
const preloadedData = {
'wp/v2/posts': {
body,
},
};
const preloadingMiddleware =
createPreloadingMiddleware( preloadedData );
const requestOptions = {
method: 'GET',
path: 'wp/v2/posts',
};
const nextSpy = jest.fn();
preloadingMiddleware( requestOptions, nextSpy );
expect( nextSpy ).not.toHaveBeenCalled();
preloadingMiddleware( requestOptions, nextSpy );
expect( nextSpy ).toHaveBeenCalled();
} );
} );
describe( 'and the OPTIONS request has a parse flag', () => {
it( 'should return the full response if parse: false', () => {
const noResponseMock =
'undefined' === typeof window.Response;
if ( noResponseMock ) {
window.Response = class {
constructor( body, options ) {
this.body = JSON.parse( body );
this.headers = options.headers;
}
};
}
const data = {
body: {
status: 'this is the preloaded response',
},
headers: {
Allow: 'GET, POST',
},
};
const preloadedData = {
OPTIONS: {
'wp/v2/posts': data,
},
};
const preloadingMiddleware =
createPreloadingMiddleware( preloadedData );
const requestOptions = {
method: 'OPTIONS',
path: 'wp/v2/posts',
parse: false,
};
const response = preloadingMiddleware( requestOptions );
if ( noResponseMock ) {
delete window.Response;
}
return response.then( ( value ) => {
expect( value ).toEqual( data );
} );
} );
it( 'should return only the response body if parse: true', () => {
const body = {
status: 'this is the preloaded response',
};
const preloadedData = {
OPTIONS: {
'wp/v2/posts': {
body,
headers: {
Allow: 'GET, POST',
},
},
},
};
const preloadingMiddleware =
createPreloadingMiddleware( preloadedData );
const requestOptions = {
method: 'OPTIONS',
path: 'wp/v2/posts',
parse: true,
};
const response = preloadingMiddleware( requestOptions );
return response.then( ( value ) => {
expect( value ).toEqual( body );
} );
} );
} );
} );
describe( 'when the requested data is not from a preloaded endpoint', () => {
it( 'should not return preloaded data', () => {
const body = {
status: 'this is the preloaded response',
};
const preloadedData = {
'wp/v2/posts': {
body,
},
};
const preloadingMiddleware =
createPreloadingMiddleware( preloadedData );
const requestOptions = {
method: 'GET',
path: 'wp/v2/fake_resource',
};
const nextSpy = jest.fn();
preloadingMiddleware( requestOptions, nextSpy );
expect( nextSpy ).toHaveBeenCalled();
} );
} );
} );
it( 'should normalize on stable path', async () => {
const body = { content: 'example' };
const preloadedData = {
'wp/v2/demo-reverse-alphabetical?foo=bar&baz=quux': { body },
'wp/v2/demo-alphabetical?baz=quux&foo=bar': { body },
};
const preloadingMiddleware =
createPreloadingMiddleware( preloadedData );
let requestOptions = {
method: 'GET',
path: 'wp/v2/demo-reverse-alphabetical?baz=quux&foo=bar',
};
let value = await preloadingMiddleware( requestOptions, () => {} );
expect( value ).toEqual( body );
requestOptions = {
method: 'GET',
path: 'wp/v2/demo-alphabetical?foo=bar&baz=quux',
};
value = await preloadingMiddleware( requestOptions, () => {} );
expect( value ).toEqual( body );
} );
it( 'should recognize an urlencoded query param', async () => {
const body = { foo: 'foo', bar: 'bar' };
const preloadingMiddleware = createPreloadingMiddleware( {
'/?_fields=foo,bar': { body },
} );
const response = await preloadingMiddleware(
{
method: 'GET',
path: '/?_fields=foo%2Cbar',
},
() => {}
);
expect( response ).toEqual( body );
} );
it( 'should recognize rest_route query param as path', async () => {
const body = { foo: 'foo' };
const preloadingMiddleware = createPreloadingMiddleware( {
'/': { body },
} );
const response = await preloadingMiddleware(
{
method: 'GET',
url: '/index.php?rest_route=%2F',
},
() => {}
);
expect( response ).toEqual( body );
} );
it( 'should recognize additional query params after rest_route', async () => {
const body = { foo: 'foo', bar: 'bar' };
const preloadingMiddleware = createPreloadingMiddleware( {
'/?_fields=foo,bar': { body },
} );
const response = await preloadingMiddleware(
{
method: 'GET',
url: '/index.php?rest_route=%2F&_fields=foo%2Cbar',
},
() => {}
);
expect( response ).toEqual( body );
} );
it( 'should remove OPTIONS type requests from the cache after the first hit', async () => {
const body = { content: 'example' };
const preloadedData = {
OPTIONS: {
'wp/v2/demo': { body },
},
};
const preloadingMiddleware =
createPreloadingMiddleware( preloadedData );
const requestOptions = {
method: 'OPTIONS',
path: 'wp/v2/demo',
};
const firstMiddleware = jest.fn();
preloadingMiddleware( requestOptions, firstMiddleware );
expect( firstMiddleware ).not.toHaveBeenCalled();
await preloadingMiddleware( requestOptions, firstMiddleware );
const secondMiddleware = jest.fn();
await preloadingMiddleware( requestOptions, secondMiddleware );
expect( secondMiddleware ).toHaveBeenCalledTimes( 1 );
} );
describe.each( [ [ 'GET' ], [ 'OPTIONS' ] ] )( '%s', ( method ) => {
describe.each( [
[ 'all empty', {} ],
[ 'method empty', { [ method ]: {} } ],
] )( '%s', ( label, preloadedData ) => {
it( 'should move to the next middleware if no preloaded data', () => {
const preloadingMiddleware =
createPreloadingMiddleware( preloadedData );
const requestOptions = {
method,
path: 'wp/v2/posts',
};
const callback = ( options ) => {
expect( options ).toBe( requestOptions );
return true;
};
const ret = preloadingMiddleware( requestOptions, callback );
expect( ret ).toBe( true );
} );
} );
} );
} );