Repository navigation
Commit 58788bb
fix(server): propagate caller cancellation out of ActiveTask.subscribe (a2aproject#1402)
# Description
`ActiveTask.subscribe` catches `asyncio.CancelledError` together with
`QueueShutDown` and breaks out of its loop. So when the task that
iterates a subscription gets cancelled, the generator just finishes and
the cancellation is lost.
It shows up with a timeout around a blocking send. With an executor that
moves the task to WORKING and keeps going,
`asyncio.wait_for(handler.on_message_send(...), timeout=0.3)` returns
the task in TASK_STATE_WORKING instead of raising `TimeoutError`.
Calling `cancel()` on a task running `on_message_send` behaves the same
way. It ends normally with `cancelled() == False` and returns whatever
non-terminal state the task had at that moment. A cancelled consumer of
`on_message_send_stream` or `on_subscribe_to_task` sees its stream end
as if the task had finished.
The fix catches only `QueueShutDown`. The `finally` block already closes
the tap, drops the reference count and runs `_maybe_cleanup()`, so
cleanup happens the same way when the cancellation propagates. I
couldn't find anything other than the caller that would raise
`CancelledError` there. The producer and the consumer only put
`Exception` instances on the queue (the producer swallows its own
cancellation in `_run_producer`), and shutting the queue down raises
`QueueShutDown` for both `immediate=True` and `immediate=False`.
The existing `test_active_task_subscribe_cancelled_during_wait` accepted
either `CancelledError` or `StopAsyncIteration`, with a comment putting
the second one down to a Python 3.10 generator quirk. It was really this
`except` swallowing the cancel, and the test gets `StopAsyncIteration`
on 3.13 as well. With the fix both versions raise `CancelledError`, so
the test now requires it.
I also added three handler tests using the existing `_HangingAgent`. One
wraps `on_message_send` in `wait_for` and expects `TimeoutError`, one
cancels a task running `on_message_send`, and one cancels a task
consuming `on_message_send_stream`. With the `src` change stashed all
four fail on both 3.10 and 3.13 (the three new ones with "DID NOT
RAISE", the old one with `StopAsyncIteration`), and with it they pass.
On 3.10 at 43d1eff the full suite gives 2494 passed, 203 skipped, 4
xfailed, 1 xpassed, and the coverage run clears the 88% gate.
`./scripts/lint.sh` passes.
One related thing I left alone. The unary wrapper in `_plugin_hooks.py`
only calls `after_handler_run` from `except Exception`, so a cancelled
`send_message` now gets `before_handler_run` with no matching after
call. That already happened for a cancel at any other await, but the
subscribe wait is where a blocking send usually sits when a timeout or
disconnect hits, and before this change the after hook ran there with
the stale task. The stream wrapper calls it from `finally`. I'm happy to
make the unary side match in a separate PR if you want that.
- [x] Follow the [`CONTRIBUTING`
Guide](https://github.com/a2aproject/a2a-python/blob/main/CONTRIBUTING.md).
- [x] Make your Pull Request title in the
<https://www.conventionalcommits.org/> specification.
- [x] Ensure the tests and linter pass (Run `bash scripts/format.sh`
from the repository root to format)
- [x] Appropriate docs were updated (if necessary)
---------
Co-authored-by: Mateusz Iwaniuk <45974414+Iwaniukooo11@users.noreply.github.com>1 parent d830036 commit 58788bb
3 files changed
Lines changed: 187 additions & 5 deletions
File tree
- src/a2a/server/agent_execution
- tests/server
- agent_execution
- request_handlers
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
869 | 869 | | |
870 | 870 | | |
871 | 871 | | |
872 | | - | |
| 872 | + | |
873 | 873 | | |
874 | 874 | | |
875 | 875 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
701 | 701 | | |
702 | 702 | | |
703 | 703 | | |
704 | | - | |
705 | | - | |
706 | | - | |
| 704 | + | |
| 705 | + | |
| 706 | + | |
707 | 707 | | |
708 | 708 | | |
709 | 709 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
| 27 | + | |
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
| |||
2721 | 2721 | | |
2722 | 2722 | | |
2723 | 2723 | | |
| 2724 | + | |
| 2725 | + | |
| 2726 | + | |
| 2727 | + | |
| 2728 | + | |
| 2729 | + | |
| 2730 | + | |
| 2731 | + | |
| 2732 | + | |
| 2733 | + | |
| 2734 | + | |
| 2735 | + | |
| 2736 | + | |
| 2737 | + | |
| 2738 | + | |
| 2739 | + | |
| 2740 | + | |
| 2741 | + | |
| 2742 | + | |
| 2743 | + | |
| 2744 | + | |
| 2745 | + | |
| 2746 | + | |
| 2747 | + | |
| 2748 | + | |
| 2749 | + | |
| 2750 | + | |
| 2751 | + | |
| 2752 | + | |
| 2753 | + | |
| 2754 | + | |
| 2755 | + | |
| 2756 | + | |
| 2757 | + | |
| 2758 | + | |
| 2759 | + | |
| 2760 | + | |
| 2761 | + | |
| 2762 | + | |
| 2763 | + | |
| 2764 | + | |
| 2765 | + | |
| 2766 | + | |
| 2767 | + | |
| 2768 | + | |
| 2769 | + | |
| 2770 | + | |
| 2771 | + | |
| 2772 | + | |
| 2773 | + | |
| 2774 | + | |
| 2775 | + | |
| 2776 | + | |
| 2777 | + | |
| 2778 | + | |
| 2779 | + | |
| 2780 | + | |
| 2781 | + | |
| 2782 | + | |
| 2783 | + | |
| 2784 | + | |
| 2785 | + | |
| 2786 | + | |
| 2787 | + | |
| 2788 | + | |
| 2789 | + | |
| 2790 | + | |
| 2791 | + | |
| 2792 | + | |
| 2793 | + | |
| 2794 | + | |
| 2795 | + | |
| 2796 | + | |
| 2797 | + | |
| 2798 | + | |
| 2799 | + | |
| 2800 | + | |
| 2801 | + | |
| 2802 | + | |
| 2803 | + | |
| 2804 | + | |
| 2805 | + | |
| 2806 | + | |
| 2807 | + | |
| 2808 | + | |
| 2809 | + | |
| 2810 | + | |
| 2811 | + | |
| 2812 | + | |
| 2813 | + | |
| 2814 | + | |
| 2815 | + | |
| 2816 | + | |
| 2817 | + | |
| 2818 | + | |
| 2819 | + | |
| 2820 | + | |
| 2821 | + | |
| 2822 | + | |
| 2823 | + | |
| 2824 | + | |
| 2825 | + | |
| 2826 | + | |
| 2827 | + | |
| 2828 | + | |
| 2829 | + | |
| 2830 | + | |
| 2831 | + | |
| 2832 | + | |
| 2833 | + | |
| 2834 | + | |
| 2835 | + | |
| 2836 | + | |
| 2837 | + | |
| 2838 | + | |
| 2839 | + | |
| 2840 | + | |
| 2841 | + | |
| 2842 | + | |
| 2843 | + | |
| 2844 | + | |
| 2845 | + | |
| 2846 | + | |
| 2847 | + | |
| 2848 | + | |
| 2849 | + | |
| 2850 | + | |
| 2851 | + | |
| 2852 | + | |
| 2853 | + | |
| 2854 | + | |
| 2855 | + | |
| 2856 | + | |
| 2857 | + | |
| 2858 | + | |
| 2859 | + | |
| 2860 | + | |
| 2861 | + | |
| 2862 | + | |
| 2863 | + | |
| 2864 | + | |
| 2865 | + | |
| 2866 | + | |
| 2867 | + | |
| 2868 | + | |
| 2869 | + | |
| 2870 | + | |
| 2871 | + | |
| 2872 | + | |
| 2873 | + | |
| 2874 | + | |
| 2875 | + | |
| 2876 | + | |
| 2877 | + | |
| 2878 | + | |
| 2879 | + | |
| 2880 | + | |
| 2881 | + | |
| 2882 | + | |
| 2883 | + | |
| 2884 | + | |
| 2885 | + | |
| 2886 | + | |
| 2887 | + | |
| 2888 | + | |
| 2889 | + | |
| 2890 | + | |
| 2891 | + | |
| 2892 | + | |
| 2893 | + | |
| 2894 | + | |
| 2895 | + | |
| 2896 | + | |
| 2897 | + | |
| 2898 | + | |
| 2899 | + | |
| 2900 | + | |
| 2901 | + | |
| 2902 | + | |
| 2903 | + | |
| 2904 | + | |
| 2905 | + | |
2724 | 2906 | | |
2725 | 2907 | | |
2726 | 2908 | | |
| |||
0 commit comments