forked from microsoft/playwright-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_route_web_socket.py
More file actions
374 lines (322 loc) · 12 KB
/
test_route_web_socket.py
File metadata and controls
374 lines (322 loc) · 12 KB
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
369
370
371
372
373
374
# 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 re
import time
from typing import Any, Awaitable, Callable, Literal, Optional, Union
from playwright.sync_api import Browser, Frame, Page, WebSocketRoute
from tests.server import Server, WebSocketProtocol
def assert_equal(
actual_cb: Callable[[], Union[Any, Awaitable[Any]]], expected: Any
) -> None:
__tracebackhide__ = True
start_time = time.time()
attempts = 0
while True:
actual = actual_cb()
if actual == expected:
return
attempts += 1
if time.time() - start_time > 10:
raise TimeoutError(f"Timed out after 10 seconds. Last actual was: {actual}")
time.sleep(0.1)
def setup_ws(
target: Union[Page, Frame],
port: int,
protocol: Union[Literal["blob"], Literal["arraybuffer"]],
) -> None:
target.goto("about:blank")
target.evaluate(
"""({ port, binaryType }) => {
window.log = [];
window.ws = new WebSocket('ws://localhost:' + port + '/ws');
window.ws.binaryType = binaryType;
window.ws.addEventListener('open', () => window.log.push('open'));
window.ws.addEventListener('close', event => window.log.push(`close code=${event.code} reason=${event.reason} wasClean=${event.wasClean}`));
window.ws.addEventListener('error', event => window.log.push(`error`));
window.ws.addEventListener('message', async event => {
let data;
if (typeof event.data === 'string')
data = event.data;
else if (event.data instanceof Blob)
data = 'blob:' + event.data.text();
else
data = 'arraybuffer:' + (new Blob([event.data])).text();
window.log.push(`message: data=${data} origin=${event.origin} lastEventId=${event.lastEventId}`);
});
window.wsOpened = new Promise(f => window.ws.addEventListener('open', () => f()));
}""",
{"port": port, "binaryType": protocol},
)
def test_should_work_with_ws_close(page: Page, server: Server) -> None:
route: Optional["WebSocketRoute"] = None
def _handle_ws(ws: WebSocketRoute) -> None:
ws.connect_to_server()
nonlocal route
route = ws
page.route_web_socket(re.compile(".*"), _handle_ws)
with server.expect_websocket() as ws_task:
setup_ws(page, server.PORT, "blob")
page.evaluate("window.wsOpened")
ws = ws_task.value
assert route
route.send("hello")
assert_equal(
lambda: page.evaluate("window.log"),
[
"open",
f"message: data=hello origin=ws://localhost:{server.PORT} lastEventId=",
],
)
closed_event = []
ws.events.once("close", lambda code, reason: closed_event.append((code, reason)))
route.close(code=3009, reason="oops")
assert_equal(
lambda: page.evaluate("window.log"),
[
"open",
f"message: data=hello origin=ws://localhost:{server.PORT} lastEventId=",
"close code=3009 reason=oops wasClean=true",
],
)
assert_equal(lambda: closed_event, [(3009, "oops")])
def test_should_pattern_match(page: Page, server: Server) -> None:
page.route_web_socket(re.compile(r".*/ws$"), lambda ws: ws.connect_to_server())
page.route_web_socket(
"**/mock-ws", lambda ws: ws.on_message(lambda message: ws.send("mock-response"))
)
page.goto("about:blank")
with server.expect_websocket() as ws_info:
page.evaluate(
"""async ({ port }) => {
window.log = [];
window.ws1 = new WebSocket('ws://localhost:' + port + '/ws');
window.ws1.addEventListener('message', event => window.log.push(`ws1:${event.data}`));
window.ws2 = new WebSocket('ws://localhost:' + port + '/something/something/mock-ws');
window.ws2.addEventListener('message', event => window.log.push(`ws2:${event.data}`));
await Promise.all([
new Promise(f => window.ws1.addEventListener('open', f)),
new Promise(f => window.ws2.addEventListener('open', f)),
]);
}""",
{"port": server.PORT},
)
ws = ws_info.value
ws.events.on("message", lambda payload, isBinary: ws.sendMessage(b"response"))
page.evaluate("window.ws1.send('request')")
assert_equal(lambda: page.evaluate("window.log"), ["ws1:response"])
page.evaluate("window.ws2.send('request')")
assert_equal(
lambda: page.evaluate("window.log"), ["ws1:response", "ws2:mock-response"]
)
def test_should_work_with_server(page: Page, server: Server) -> None:
route = None
def _handle_ws(ws: WebSocketRoute) -> None:
server = ws.connect_to_server()
def _ws_on_message(message: Union[str, bytes]) -> None:
if message == "to-respond":
ws.send("response")
return
if message == "to-block":
return
if message == "to-modify":
server.send("modified")
return
server.send(message)
ws.on_message(_ws_on_message)
def _server_on_message(message: Union[str, bytes]) -> None:
if message == "to-block":
return
if message == "to-modify":
ws.send("modified")
return
ws.send(message)
server.on_message(_server_on_message)
server.send("fake")
nonlocal route
route = ws
page.route_web_socket(re.compile(".*"), _handle_ws)
log = []
def _once_web_socket_connection(ws: WebSocketProtocol) -> None:
ws.events.on(
"message", lambda data, is_binary: log.append(f"message: {data.decode()}")
)
ws.events.on(
"close",
lambda code, reason: log.append(f"close: code={code} reason={reason}"),
)
server.once_web_socket_connection(_once_web_socket_connection)
with server.expect_websocket() as ws_info:
setup_ws(page, server.PORT, "blob")
page.evaluate("window.wsOpened")
ws = ws_info.value
assert_equal(lambda: log, ["message: fake"])
ws.sendMessage(b"to-modify")
ws.sendMessage(b"to-block")
ws.sendMessage(b"pass-server")
assert_equal(
lambda: page.evaluate("window.log"),
[
"open",
f"message: data=modified origin=ws://localhost:{server.PORT} lastEventId=",
f"message: data=pass-server origin=ws://localhost:{server.PORT} lastEventId=",
],
)
page.evaluate(
"""() => {
window.ws.send('to-respond');
window.ws.send('to-modify');
window.ws.send('to-block');
window.ws.send('pass-client');
}"""
)
assert_equal(
lambda: log, ["message: fake", "message: modified", "message: pass-client"]
)
assert_equal(
lambda: page.evaluate("window.log"),
[
"open",
f"message: data=modified origin=ws://localhost:{server.PORT} lastEventId=",
f"message: data=pass-server origin=ws://localhost:{server.PORT} lastEventId=",
f"message: data=response origin=ws://localhost:{server.PORT} lastEventId=",
],
)
assert route
route.send("another")
assert_equal(
lambda: page.evaluate("window.log"),
[
"open",
f"message: data=modified origin=ws://localhost:{server.PORT} lastEventId=",
f"message: data=pass-server origin=ws://localhost:{server.PORT} lastEventId=",
f"message: data=response origin=ws://localhost:{server.PORT} lastEventId=",
f"message: data=another origin=ws://localhost:{server.PORT} lastEventId=",
],
)
page.evaluate(
"""() => {
window.ws.send('pass-client-2');
}"""
)
assert_equal(
lambda: log,
[
"message: fake",
"message: modified",
"message: pass-client",
"message: pass-client-2",
],
)
page.evaluate(
"""() => {
window.ws.close(3009, 'problem');
}"""
)
assert_equal(
lambda: log,
[
"message: fake",
"message: modified",
"message: pass-client",
"message: pass-client-2",
"close: code=3009 reason=problem",
],
)
def test_should_work_without_server(page: Page, server: Server) -> None:
route = None
def _handle_ws(ws: WebSocketRoute) -> None:
def _ws_on_message(message: Union[str, bytes]) -> None:
if message == "to-respond":
ws.send("response")
ws.on_message(_ws_on_message)
nonlocal route
route = ws
page.route_web_socket(re.compile(".*"), _handle_ws)
setup_ws(page, server.PORT, "blob")
page.evaluate(
"""async () => {
await window.wsOpened;
window.ws.send('to-respond');
window.ws.send('to-block');
window.ws.send('to-respond');
}"""
)
assert_equal(
lambda: page.evaluate("window.log"),
[
"open",
f"message: data=response origin=ws://localhost:{server.PORT} lastEventId=",
f"message: data=response origin=ws://localhost:{server.PORT} lastEventId=",
],
)
assert route
route.send("another")
# wait for the message to be processed
page.wait_for_timeout(100)
route.close(code=3008, reason="oops")
assert_equal(
lambda: page.evaluate("window.log"),
[
"open",
f"message: data=response origin=ws://localhost:{server.PORT} lastEventId=",
f"message: data=response origin=ws://localhost:{server.PORT} lastEventId=",
f"message: data=another origin=ws://localhost:{server.PORT} lastEventId=",
"close code=3008 reason=oops wasClean=true",
],
)
def test_should_work_with_base_url(browser: Browser, server: Server) -> None:
context = browser.new_context(base_url=f"http://localhost:{server.PORT}")
page = context.new_page()
def _handle_ws(ws: WebSocketRoute) -> None:
ws.on_message(lambda message: ws.send(message))
page.route_web_socket("/ws", _handle_ws)
setup_ws(page, server.PORT, "blob")
page.evaluate(
"""async () => {
await window.wsOpened;
window.ws.send('echo');
}"""
)
assert_equal(
lambda: page.evaluate("window.log"),
[
"open",
f"message: data=echo origin=ws://localhost:{server.PORT} lastEventId=",
],
)
context.close()
def test_should_work_with_no_trailing_slash(page: Page, server: Server) -> None:
log: list[str] = []
async def handle_ws(ws: WebSocketRoute) -> None:
def on_message(message: Union[str, bytes]) -> None:
assert isinstance(message, str)
log.append(message)
ws.send("response")
ws.on_message(on_message)
# No trailing slash in the route pattern
page.route_web_socket(f"ws://localhost:{server.PORT}", handle_ws)
page.goto("about:blank")
page.evaluate(
"""({ port }) => {
window.log = [];
// No trailing slash in WebSocket URL
window.ws = new WebSocket('ws://localhost:' + port);
window.ws.addEventListener('message', event => window.log.push(event.data));
}""",
{"port": server.PORT},
)
assert_equal(lambda: page.evaluate("window.ws.readyState"), 1) # WebSocket.OPEN
page.evaluate("window.ws.send('query')")
assert_equal(lambda: log, ["query"])
assert_equal(lambda: page.evaluate("window.log"), ["response"])