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
|
# 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 Union
import pytest
from playwright.async_api import Error, Page, WebSocket
from tests.server import Server, WebSocketProtocol
async def test_should_work(page: Page, server: Server) -> None:
server.send_on_web_socket_connection(b"incoming")
value = await page.evaluate(
"""port => {
let cb;
const result = new Promise(f => cb = f);
const ws = new WebSocket('ws://localhost:' + port + '/ws');
ws.addEventListener('message', data => { ws.close(); cb(data.data); });
return result;
}""",
server.PORT,
)
assert value == "incoming"
pass
async def test_should_emit_close_events(page: Page, server: Server) -> None:
await page.goto(server.EMPTY_PAGE)
close_future: asyncio.Future[None] = asyncio.Future()
async with page.expect_websocket() as ws_info:
await page.evaluate(
"""port => {
const ws = new WebSocket('ws://localhost:' + port + '/ws');
ws.addEventListener('open', data => ws.close());
}""",
server.PORT,
)
ws = await ws_info.value
ws.on("close", lambda ws: close_future.set_result(None))
assert ws.url == f"ws://localhost:{server.PORT}/ws"
assert repr(ws) == f"<WebSocket url={ws.url!r}>"
await close_future
assert ws.is_closed()
async def test_should_emit_frame_events(page: Page, server: Server) -> None:
def _handle_ws_connection(ws: WebSocketProtocol) -> None:
def _onMessage(payload: bytes, isBinary: bool) -> None:
ws.sendMessage(b"incoming", False)
ws.sendClose()
setattr(ws, "onMessage", _onMessage)
server.once_web_socket_connection(_handle_ws_connection)
log = []
socket_close_future: "asyncio.Future[None]" = asyncio.Future()
def on_web_socket(ws: WebSocket) -> None:
log.append("open")
def _on_framesent(payload: Union[bytes, str]) -> None:
assert isinstance(payload, str)
log.append(f"sent<{payload}>")
ws.on("framesent", _on_framesent)
def _on_framereceived(payload: Union[bytes, str]) -> None:
assert isinstance(payload, str)
log.append(f"received<{payload}>")
ws.on("framereceived", _on_framereceived)
def _handle_close(ws: WebSocket) -> None:
log.append("close")
socket_close_future.set_result(None)
ws.on("close", _handle_close)
page.on("websocket", on_web_socket)
async with page.expect_event("websocket"):
await page.evaluate(
"""port => {
const ws = new WebSocket('ws://localhost:' + port + '/ws');
ws.addEventListener('open', () => ws.send('outgoing'));
ws.addEventListener('message', () => ws.close())
}""",
server.PORT,
)
await socket_close_future
assert log[0] == "open"
assert log[3] == "close"
log.sort()
assert log == ["close", "open", "received<incoming>", "sent<outgoing>"]
async def test_should_emit_binary_frame_events(page: Page, server: Server) -> None:
def _handle_ws_connection(ws: WebSocketProtocol) -> None:
ws.sendMessage(b"incoming")
def _onMessage(payload: bytes, isBinary: bool) -> None:
if payload == b"echo-bin":
ws.sendMessage(b"\x04\x02", True)
ws.sendClose()
if payload == b"echo-text":
ws.sendMessage(b"text", False)
ws.sendClose()
setattr(ws, "onMessage", _onMessage)
server.once_web_socket_connection(_handle_ws_connection)
done_task: "asyncio.Future[None]" = asyncio.Future()
sent = []
received = []
def on_web_socket(ws: WebSocket) -> None:
ws.on("framesent", lambda payload: sent.append(payload))
ws.on("framereceived", lambda payload: received.append(payload))
ws.on("close", lambda _: done_task.set_result(None))
page.on("websocket", on_web_socket)
async with page.expect_event("websocket"):
await page.evaluate(
"""port => {
const ws = new WebSocket('ws://localhost:' + port + '/ws');
ws.addEventListener('open', () => {
const binary = new Uint8Array(5);
for (let i = 0; i < 5; ++i)
binary[i] = i;
ws.send(binary);
ws.send('echo-bin');
});
}""",
server.PORT,
)
await done_task
assert sent == [b"\x00\x01\x02\x03\x04", "echo-bin"]
assert received == ["incoming", b"\x04\x02"]
async def test_should_reject_wait_for_event_on_close_and_error(
page: Page, server: Server
) -> None:
server.send_on_web_socket_connection(b"incoming")
async with page.expect_event("websocket") as ws_info:
await page.evaluate(
"""port => {
window.ws = new WebSocket('ws://localhost:' + port + '/ws');
}""",
server.PORT,
)
ws = await ws_info.value
await ws.wait_for_event("framereceived")
with pytest.raises(Error) as exc_info:
async with ws.expect_event("framesent"):
await page.evaluate("window.ws.close()")
assert exc_info.value.message == "Socket closed"
async def test_should_emit_error_event(
page: Page, server: Server, browser_name: str, browser_channel: str
) -> None:
future: "asyncio.Future[str]" = asyncio.Future()
def _on_ws_socket_error(err: str) -> None:
future.set_result(err)
def _on_websocket(websocket: WebSocket) -> None:
websocket.on("socketerror", _on_ws_socket_error)
page.on(
"websocket",
_on_websocket,
)
await page.evaluate(
"""port => new WebSocket(`ws://localhost:${port}/bogus-ws`)""",
server.PORT,
)
err = await future
if browser_name == "firefox":
assert err == "CLOSE_ABNORMAL"
else:
assert ("" if browser_channel == "msedge" else ": 404") in err
|
