fix: report route handler errors to the user after they completed #2321
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Issue: Exceptions which will get thrown in route handlers after route.{fulfill,continue,abort} got called,
won't get surfaced to the user in the sync and async version of Playwright for Python.
Scope: Event handlers which use asyncio.create_task
- {BrowserContext,Page}.on("route")
- {Page}.on({"route", "locatorHandlerTriggered"})
There were multiple issues in the implementation:
1. `playwright/_impl/_helper.py` (sync only): we were only waiting until a handler's {continue,fulfill,abort} got called, and did not wait until the actual callback completed. Fix: Wait until the handler completed.
2. `playwright/_impl/_connection.py:423` (sync only): We call event listeners manually, this means that `pyee`'s `"error"` event is not working there. Fix: attach a done callback manually, like pyee is doing inside their library.
3. `playwright/_impl/_connection.py:56` (async): attach an `"error"` event handler for the async error reporting
4. `playwright/_impl/_connection.py:90` if we report an error to the user, we should cancel the underlying future otherwise a warning gets emitted, that there was a future exception never received.
mxschmitt
force-pushed
the
fix-route-error-reporting
branch
from
1256fba to
516e753
Compare
dgozman
approved these changes
Feb 26, 2024
| if exc: | ||
| self._on_event_listener_error(exc) | ||
|
|
||
| def _listener_with_error_handler_attached(params: Any) -> None: |
There was a problem hiding this comment.
Let's make sure we have test coverage for this.
Co-authored-by: Dmitry Gozman <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: Exceptions which will get thrown in route handlers after route.{fulfill,continue,abort} got called,
won't get surfaced to the user in the sync and async version of Playwright for Python.
Scope: Event handlers which use asyncio.create_task
There were multiple issues in the implementation:
playwright/_impl/_helper.py(sync only): we were only waiting until a handler's {continue,fulfill,abort} got called, and did not wait until the actual callback completed. Fix: Wait until the handler completed.playwright/_impl/_connection.py:423(sync only): We call event listeners manually, this means thatpyee's"error"event is not working there. Fix: attach a done callback manually, like pyee is doing inside their library.playwright/_impl/_connection.py:56(async): attach an"error"event handler for the async error reportingplaywright/_impl/_connection.py:90if we report an error to the user, we should cancel the underlying future otherwise a warning gets emitted, that there was a future exception never received.This should resolve #2136.