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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
|
# Copyright (c) Microsoft Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import asyncio
from typing import Any, Callable, Coroutine, cast
import pytest
from playwright.async_api import Error, Page, Request, Route
from tests.server import Server
async def test_should_work(page: Page, server: Server) -> None:
await page.route("**/*", lambda route: asyncio.create_task(route.fallback()))
await page.goto(server.EMPTY_PAGE)
async def test_should_fall_back(page: Page, server: Server) -> None:
intercepted = []
def _handler1(route: Route) -> None:
intercepted.append(1)
asyncio.create_task(route.fallback())
await page.route("**/empty.html", _handler1)
def _handler2(route: Route) -> None:
intercepted.append(2)
asyncio.create_task(route.fallback())
await page.route("**/empty.html", _handler2)
def _handler3(route: Route) -> None:
intercepted.append(3)
asyncio.create_task(route.fallback())
await page.route("**/empty.html", _handler3)
await page.goto(server.EMPTY_PAGE)
assert intercepted == [3, 2, 1]
async def test_should_fall_back_async_delayed(page: Page, server: Server) -> None:
intercepted = []
def create_handler(i: int) -> Callable[[Route], Coroutine]:
async def handler(route: Route) -> None:
intercepted.append(i)
await asyncio.sleep(0.1)
await route.fallback()
return handler
await page.route("**/empty.html", create_handler(1))
await page.route("**/empty.html", create_handler(2))
await page.route("**/empty.html", create_handler(3))
await page.goto(server.EMPTY_PAGE)
assert intercepted == [3, 2, 1]
async def test_should_chain_once(page: Page, server: Server) -> None:
await page.route(
"**/madeup.txt",
lambda route: asyncio.create_task(
route.fulfill(status=200, body="fulfilled one")
),
times=1,
)
await page.route(
"**/madeup.txt", lambda route: asyncio.create_task(route.fallback()), times=1
)
resp = await page.goto(server.PREFIX + "/madeup.txt")
assert resp
body = await resp.body()
assert body == b"fulfilled one"
async def test_should_not_chain_fulfill(page: Page, server: Server) -> None:
failed = [False]
def handler(route: Route) -> None:
failed[0] = True
await page.route("**/empty.html", handler)
await page.route(
"**/empty.html",
lambda route: asyncio.create_task(route.fulfill(status=200, body="fulfilled")),
)
await page.route(
"**/empty.html", lambda route: asyncio.create_task(route.fallback())
)
response = await page.goto(server.EMPTY_PAGE)
assert response
body = await response.body()
assert body == b"fulfilled"
assert not failed[0]
async def test_should_not_chain_abort(
page: Page, server: Server, is_webkit: bool, is_firefox: bool
) -> None:
failed = [False]
def handler(route: Route) -> None:
failed[0] = True
await page.route("**/empty.html", handler)
await page.route("**/empty.html", lambda route: asyncio.create_task(route.abort()))
await page.route(
"**/empty.html", lambda route: asyncio.create_task(route.fallback())
)
with pytest.raises(Error) as excinfo:
await page.goto(server.EMPTY_PAGE)
if is_webkit:
assert "Blocked by Web Inspector" in excinfo.value.message
elif is_firefox:
assert "NS_ERROR_FAILURE" in excinfo.value.message
else:
assert "net::ERR_FAILED" in excinfo.value.message
assert not failed[0]
async def test_should_fall_back_after_exception(page: Page, server: Server) -> None:
await page.route("**/empty.html", lambda route: route.continue_())
async def handler(route: Route) -> None:
try:
await route.fulfill(response=cast(Any, {}))
except Exception:
await route.fallback()
await page.route("**/empty.html", handler)
await page.goto(server.EMPTY_PAGE)
async def test_should_amend_http_headers(page: Page, server: Server) -> None:
values = []
async def handler(route: Route) -> None:
values.append(route.request.headers.get("foo"))
values.append(await route.request.header_value("FOO"))
await route.continue_()
await page.route("**/sleep.zzz", handler)
async def handler_with_header_mods(route: Route) -> None:
await route.fallback(headers={**route.request.headers, "FOO": "bar"})
await page.route("**/*", handler_with_header_mods)
await page.goto(server.EMPTY_PAGE)
with server.expect_request("/sleep.zzz") as server_request_info:
await page.evaluate("() => fetch('/sleep.zzz')")
values.append(server_request_info.value.getHeader("foo"))
assert values == ["bar", "bar", "bar"]
async def test_should_delete_header_with_undefined_value(
page: Page, server: Server
) -> None:
await page.goto(server.EMPTY_PAGE)
server.set_route(
"/something",
lambda r: (
r.setHeader("Acces-Control-Allow-Origin", "*"),
r.write(b"done"),
r.finish(),
),
)
intercepted_request = []
async def capture_and_continue(route: Route, request: Request) -> None:
intercepted_request.append(request)
await route.continue_()
await page.route("**/*", capture_and_continue)
async def delete_foo_header(route: Route, request: Request) -> None:
headers = await request.all_headers()
del headers["foo"]
await route.fallback(headers=headers)
await page.route(server.PREFIX + "/something", delete_foo_header)
[server_req, text] = await asyncio.gather(
server.wait_for_request("/something"),
page.evaluate(
"""
async url => {
const data = await fetch(url, {
headers: {
foo: 'a',
bar: 'b',
}
});
return data.text();
}
""",
server.PREFIX + "/something",
),
)
assert text == "done"
assert not intercepted_request[0].headers.get("foo")
assert intercepted_request[0].headers.get("bar") == "b"
assert not server_req.getHeader("foo")
assert server_req.getHeader("bar") == "b"
async def test_should_amend_method(page: Page, server: Server) -> None:
await page.goto(server.EMPTY_PAGE)
method = []
def _handler(route: Route) -> None:
method.append(route.request.method)
asyncio.create_task(route.continue_())
await page.route("**/*", _handler)
await page.route(
"**/*", lambda route: asyncio.create_task(route.fallback(method="POST"))
)
[request, _] = await asyncio.gather(
server.wait_for_request("/sleep.zzz"),
page.evaluate("() => fetch('/sleep.zzz')"),
)
assert method == ["POST"]
assert request.method == b"POST"
async def test_should_override_request_url(page: Page, server: Server) -> None:
url = []
def _handler1(route: Route) -> None:
url.append(route.request.url)
asyncio.create_task(route.continue_())
await page.route("**/global-var.html", _handler1)
def _handler2(route: Route) -> None:
asyncio.create_task(route.fallback(url=server.PREFIX + "/global-var.html"))
await page.route("**/foo", _handler2)
[server_request, response, _] = await asyncio.gather(
server.wait_for_request("/global-var.html"),
page.wait_for_event("response"),
page.goto(server.PREFIX + "/foo"),
)
assert url == [server.PREFIX + "/global-var.html"]
assert response.url == server.PREFIX + "/global-var.html"
assert response.request.url == server.PREFIX + "/global-var.html"
assert await page.evaluate("() => window['globalVar']") == 123
assert server_request.uri == b"/global-var.html"
assert server_request.method == b"GET"
async def test_should_amend_post_data(page: Page, server: Server) -> None:
await page.goto(server.EMPTY_PAGE)
post_data = []
def _handler(route: Route) -> None:
post_data.append(route.request.post_data)
asyncio.create_task(route.continue_())
await page.route("**/*", _handler)
await page.route(
"**/*", lambda route: asyncio.create_task(route.fallback(post_data="doggo"))
)
[server_request, _] = await asyncio.gather(
server.wait_for_request("/sleep.zzz"),
page.evaluate("() => fetch('/sleep.zzz', { method: 'POST', body: 'birdy' })"),
)
assert post_data == ["doggo"]
assert server_request.post_body == b"doggo"
async def test_should_amend_binary_post_data(page: Page, server: Server) -> None:
await page.goto(server.EMPTY_PAGE)
post_data_buffer = []
def _handler1(route: Route) -> None:
post_data_buffer.append(route.request.post_data)
asyncio.create_task(route.continue_())
await page.route("**/*", _handler1)
async def _handler2(route: Route) -> None:
await route.fallback(post_data=b"\x00\x01\x02\x03\x04")
await page.route("**/*", _handler2)
[server_request, result] = await asyncio.gather(
server.wait_for_request("/sleep.zzz"),
page.evaluate("fetch('/sleep.zzz', { method: 'POST', body: 'birdy' })"),
)
# FIXME: should this be bytes?
assert post_data_buffer == ["\x00\x01\x02\x03\x04"]
assert server_request.method == b"POST"
assert server_request.post_body == b"\x00\x01\x02\x03\x04"
async def test_should_chain_fallback_with_dynamic_url(
server: Server, page: Page
) -> None:
intercepted = []
def _handler1(route: Route) -> None:
intercepted.append(1)
asyncio.create_task(route.fallback(url=server.EMPTY_PAGE))
await page.route("**/bar", _handler1)
def _handler2(route: Route, request: Request) -> None:
intercepted.append(2)
asyncio.create_task(route.fallback(url="http://localhost/bar"))
await page.route("**/foo", _handler2)
def _handler3(route: Route, request: Request) -> None:
intercepted.append(3)
asyncio.create_task(route.fallback(url="http://localhost/foo"))
await page.route("**/empty.html", _handler3)
await page.goto(server.EMPTY_PAGE)
assert intercepted == [3, 2, 1]
async def test_should_amend_json_post_data(server: Server, page: Page) -> None:
await page.goto(server.EMPTY_PAGE)
post_data = []
def _handle1(route: Route, request: Request) -> None:
post_data.append(route.request.post_data)
asyncio.create_task(route.continue_())
await page.route("**/*", _handle1)
await page.route(
"**/*",
lambda route: asyncio.create_task(route.fallback(post_data={"foo": "bar"})),
)
[server_request, _] = await asyncio.gather(
server.wait_for_request("/sleep.zzz"),
page.evaluate("() => fetch('/sleep.zzz', { method: 'POST', body: 'birdy' })"),
)
assert post_data == ['{"foo": "bar"}']
assert server_request.post_body == b'{"foo": "bar"}'
|
