fix: Fix deadlock due to playwright used in a nested event loop #243
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.
Description
Playwright instance is not safe to be used across different event loops. The bad practice of using nested event loops causes deadlock if the playwright instance is used for further operations after the agent is done. (e.g. processing cookies, checking history, etc).
Example code to reproduce the deadlock:
Considering strands support of asyncio, we can now simply call Playwright APIs in the same event loop as agent's. The only exception is the
__del__
function which is itself a bad practice but kept it to avoid resource leakage in the consumers already using this tool. Ideally the consumers should switch to using provided async context manager that calls__aexit__
when block is finished.Type of Change
Bug fix
Testing
How have you tested the change? Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli
hatch run prepare
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.