Repository navigation
fix: abandon uncancellable handler instead of holding lock #32
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
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| """Test that handler timeout doesn't hang the event bus. | ||
|
|
||
| Option C: when a handler can't be cancelled (blocked in sync code), abandon | ||
| it with a warning instead of holding the global lock indefinitely. | ||
| """ | ||
|
|
||
| import asyncio | ||
| import logging | ||
| import threading | ||
| import time | ||
|
neubig marked this conversation as resolved.
|
||
|
|
||
| import pytest | ||
|
|
||
| from bubus import BaseEvent, EventBus | ||
|
|
||
|
|
||
| class BlockEvent(BaseEvent[str]): | ||
| pass | ||
|
|
||
|
|
||
| @pytest.mark.asyncio | ||
| async def test_timeout_does_not_hang_on_blocking_handler(caplog): | ||
| """A handler blocked in sync code must not hang the event bus. | ||
|
|
||
| The timeout fires after 1s. The fix: the finally block abandons the | ||
| task after a short grace period and logs a warning, releasing the global | ||
| lock so other events can proceed. | ||
| """ | ||
| thread_started = threading.Event() | ||
| thread_should_stop = threading.Event() | ||
|
|
||
| def _block_sync(): | ||
| thread_started.set() | ||
| thread_should_stop.wait(timeout=30) | ||
| return "done" | ||
|
|
||
| async def blocking_handler(event: BlockEvent) -> str: | ||
| loop = asyncio.get_event_loop() | ||
| return await loop.run_in_executor(None, _block_sync) | ||
|
|
||
| bus = EventBus(name="test_zombie") | ||
| bus.on(BlockEvent, blocking_handler) | ||
| bus._start() | ||
|
|
||
| bus.dispatch(BlockEvent(event_timeout=1.0)) | ||
|
|
||
| # step() must return within 5s — without the fix it hangs for 30s | ||
| # because the global lock is held waiting for the uncancellable task. | ||
| try: | ||
| await asyncio.wait_for(bus.step(timeout=1.0), timeout=5.0) | ||
| except (asyncio.TimeoutError, TimeoutError, Exception): | ||
| pass # Expected — the handler timed out | ||
|
neubig marked this conversation as resolved.
|
||
|
|
||
| # The warning about the abandoned thread should have been logged | ||
|
neubig marked this conversation as resolved.
|
||
| thread_should_stop.set() | ||
| await bus.stop(timeout=1, clear=True) | ||
|
|
||
| assert thread_started.is_set(), "Handler thread should have started" | ||
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.
Uh oh!
There was an error while loading. Please reload this page.