Async generator entrypoint keeps running after the client disconnects (follow-up to #482)

Aberta Para iniciantes
#752 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
72/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
python
Domínio
backend

Direção de pesquisa

Comece no módulo de aplicação de runtime onde o entrypoint ramifica para StreamingResponse(self._sync_stream_with_error_handling(result), media_type="text/event-stream"), e leia _async_gen_to_sync_gen e seu finally para ver por que ele nunca é executado. Reproduza com o gerador async de 12 etapas e o cliente que se desconecta fornecidos aqui, depois envolva o stream sync em um iterador async que fecha tanto o stream quanto o gerador de origem em finally. Adicione test_handler_is_closed_after_disconnect a tests/integration/runtime/test_streaming_disconnect_integration.py e execute-o junto com test_app.py; concluído significa que o handler registra CancelledError ao redor do próximo yield após a desconexão em vez de ser executado até a conclusão.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

bug high-severity

Describe the bug

When an async def generator entrypoint is streamed and the client disconnects, the handler is never closed. It keeps running to the end, and if more than 100 events remain, the producer task stays parked in _offer() forever (polling every 10 ms) for the life of the process.

#563 added cleanup for this in the finally of _async_gen_to_sync_gen (stop.set() + task.cancel()), but that finally never runs. Starlette's iterate_in_threadpool never calls close() on the sync generator it iterates, so no GeneratorExit reaches it. The unit test for #563 calls sync_gen.close() by hand (test_app.py, _abandon_after), and the integration test only checks that /ping and a fresh session still work, so this was not caught.

To Reproduce

bedrock-agentcore 1.27.0 (main @ 8467c9a), starlette 1.10.0, uvicorn 0.54.0, Python 3.12, macOS.

# server.py
import asyncio, time
from bedrock_agentcore.runtime import BedrockAgentCoreApp

app = BedrockAgentCoreApp()

@app.entrypoint
async def invoke(payload):
    try:
        for i in range(12):
            await asyncio.sleep(1)
            print(f"{time.time():.1f} step {i + 1}/12", flush=True)
            yield {"step": i + 1}
        print("finished all steps", flush=True)
    except BaseException as e:
        print(f"{time.time():.1f} closed: {type(e).__name__}", flush=True)
        raise

app.run(port=8080)
# client.py: read for 3 seconds, then disconnect
import time, httpx
start = time.time()
with httpx.Client(timeout=30) as c, c.stream("POST", "http://127.0.0.1:8080/invocations", json={}) as r:
    for _ in r.iter_raw():
        if time.time() - start >= 3:
            break
print(f"{time.time():.1f} client disconnected")

The client disconnects after step 3. The server prints steps 4 to 12 and then finished all steps.

With range(500) and asyncio.sleep(0.01), the server stops around step 103/500 and never prints anything again. That is 100 queued events plus a few in flight, with the producer parked in _offer().

Expected behavior

The handler is closed shortly after the disconnect, as the _async_gen_to_sync_gen docstring describes.

Possible fix

Iterate the sync generator ourselves and close it in finally:

-                return StreamingResponse(self._sync_stream_with_error_handling(result), media_type="text/event-stream")
+                return StreamingResponse(self._iterate_sync_stream(result), media_type="text/event-stream")
...
+    async def _iterate_sync_stream(self, generator):
+        stream = self._sync_stream_with_error_handling(generator)
+        try:
+            async for chunk in iterate_in_threadpool(stream):
+                yield chunk
+        finally:
+            stream.close()
+            generator.close()

With this change, the repro above logs closed: CancelledError at step 4, and the 500-step case stops at step 2. I added an integration test, test_handler_is_closed_after_disconnect, to test_streaming_disconnect_integration.py. It fails on main and passes with the change (5/5 runs). test_app.py passes (148).

Integration test (added to tests/integration/runtime/test_streaming_disconnect_integration.py)

The live_server handler records how it exits ("completed" or "closed") per sessionId in a module-level _handler_exits dict, cleared by the fixture.

def test_handler_is_closed_after_disconnect(live_server):
    """A mid-stream client disconnect closes the handler instead of leaving its producer parked."""
    base = live_server

    with httpx.Client(timeout=30.0) as c:
        with c.stream("POST", f"{base}/invocations", json={"sessionId": "A", "chunks": 5000}) as r:
            for i, _ in enumerate(r.iter_lines()):
                if i >= 3:
                    break

    deadline = time.time() + 5
    while "A" not in _handler_exits and time.time() < deadline:
        time.sleep(0.1)
    assert _handler_exits.get("A") == "closed"

Notes

  • Cleanup can be delayed. uvicorn reports ASGI spec 2.3, so Starlette cancels the response through a task group. That cancel waits for the in-flight next() in the thread pool, so cleanup happens when the handler yields its next event. A handler parked in a long call is closed only after that call returns.
  • Sync generator handlers change too. They go through the same path, so they also get closed on disconnect now.
  • Scope. I only checked this locally with uvicorn, not on AgentCore Runtime.
Linguagem predominante
Python
Estrelas
786
Forks
163
Merge médio
4h
PRs com merge (30d)
22

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de aws/bedrock-agentcore-sdk-python

Todas as issues de aws/bedrock-agentcore-sdk-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.