Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(webSocketRoute): allow no trailing slash in route matching #2687

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion playwright/_impl/_helper.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
Union,
cast,
)
from urllib.parse import urljoin
from urllib.parse import urljoin, urlparse

from playwright._impl._api_structures import NameValue
from playwright._impl._errors import (
Expand Down Expand Up @@ -157,6 +157,10 @@ def url_matches(
base_url = re.sub(r"^http", "ws", base_url)
if base_url:
match = urljoin(base_url, match)
parsed = urlparse(match)
if parsed.path == "":
parsed = parsed._replace(path="/")
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_replace seems to be the recommendation as per here.

match = parsed.geturl()
if isinstance(match, str):
match = glob_to_regex(match)
if isinstance(match, Pattern):
Expand Down
33 changes: 33 additions & 0 deletions tests/async/test_route_web_socket.py
Original file line number Diff line number Diff line change
Expand Up @@ -346,3 +346,36 @@ async def _handle_ws(ws: WebSocketRoute) -> None:
f"message: data=echo origin=ws://localhost:{server.PORT} lastEventId=",
],
)


async 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
await page.route_web_socket(f"ws://localhost:{server.PORT}", handle_ws)

await page.goto("about:blank")
await 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},
)

await assert_equal(
lambda: page.evaluate("window.ws.readyState"), 1 # WebSocket.OPEN
)
await page.evaluate("window.ws.send('query')")
await assert_equal(lambda: log, ["query"])
await assert_equal(lambda: page.evaluate("window.log"), ["response"])
31 changes: 31 additions & 0 deletions tests/sync/test_route_web_socket.py
Original file line number Diff line number Diff line change
Expand Up @@ -340,3 +340,34 @@ def _handle_ws(ws: WebSocketRoute) -> None:
f"message: data=echo origin=ws://localhost:{server.PORT} lastEventId=",
],
)


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"])
Loading