「Waiting for connections to close」となり一発で停止することができない。裏で処理が続いてしまっている？（Python）

Question

前提・実現したいこと

python(FastAPI)にてServer-Sent Eventsを行おうとしています。

プログラム自体は問題なく動作するのですが、ターミナル上から Control＋C で終了しようとすると、
「Waiting for connections to close.」とエラーメッセージが表示され一発で終了することができません。

一度で無事すべてのプロセスを終了させる方法をご教授いただきたいです。
コードの書き方が適切でないため、このメッセージが表示されるのではないかと思っているのですが、
どう直してあげればよいかがわからず、苦戦しております。

発生している問題・エラーメッセージ

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [23908] using watchgod
INFO:     Started server process [23910]
INFO:     Waiting for application startup.
　︙
INFO:     127.0.0.1:55249 - "GET /static/favicon.ico HTTP/1.1" 200 OK
INFO:     127.0.0.1:55249 - "POST /ajax HTTP/1.1" 200 OK
^CINFO:     Shutting down
INFO:     Waiting for connections to close. (CTRL+C to force quit)
^CINFO:     Finished server process [23910]
INFO:     Stopping reloader process [23908]

該当のソースコード

from fastapi import FastAPI, Request, WebSocket
from fastapi.staticfiles import StaticFiles
from fastapi.templating import Jinja2Templates
from fastapi.responses import StreamingResponse
import random
import asyncio
import queue

app = FastAPI()
app.mount("/static", StaticFiles(directory="static"), name="static")
templates = Jinja2Templates(directory="templates")

q = asyncio.Queue()

# EventStream
@app.get('/stream')
async def message_stream(request: Request):
    async def event_stream():
        while True:
            event = "test"
            data = await q.get()
            yield "event:{}\ndata:{}\n\n".format(event,data)
            await asyncio.sleep(5)
    return StreamingResponse(event_stream(), media_type="text/event-stream")

# index
@app.get("/")
async def index(request: Request):
    return templates.TemplateResponse("index.html", {"request": request})

# ajax
@app.post("/ajax")
def ajax(): 
    q.put_nowait("処理①")
    q.put_nowait("処理②")
    q.put_nowait("処理③")
    q.put_nowait("処理④")
    q.put_nowait("処理⑤")
    q.put_nowait("処理⑥")
    q.put_nowait("処理⑦")
    q.put_nowait("処理⑧")
    q.put_nowait("処理⑨")
    q.put_nowait("処理⑩")
    return "サーバーメッセージ"

$(function () {

  var evtSource = new EventSource("/stream");
  evtSource.addEventListener("test", function (e) {
    console.log(e.data);
  });

  $("#btn").click(function () {
    console.log(evtSource);

    $.ajax({
      url: "/ajax",
      type: "POST",
    })
      .done(function (data) {
        console.log(data);
      })
      .fail(function () {
        console.log("Error");
      });
  });
});

試したこと・メッセージが発生するパターン

（1）先に開いているブラウザのタブを閉じてから、ターミナル上でControl+Cで閉じると今回のメッセージは発生しません。（タブを開いている状態でターミナルから終了しようとすると、メッセージが発生してしまします。）
（2）エラーメッセージが表示されたあと、Control＋C を再度することで強制終了できることは確認済みです。
（3）Ajaxと連携しているボタンをクリックしない状態で、終了しようとした場合も同じメッセージが表示され変化なし。
（4）async関連が悪さをしているのかと睨んで、await asyncio.sleep をコメントアウトしてみたが変化なし。

補足情報（FW/ツールのバージョンなど）

・python3.9
・FastAPI
・Uvicorn

足りない部分がありましたら、再度調べ直し、記載いたしますのでコメント下さい。
何卒、お力添えのほどよろしくお願いいたします。

Answer 1

これはコード上正しい動作をしています。まず uvnicorn は Graceful shutdown といって、サーバーを終了する際、処理中のリクエストがすべて終わる（かタイムアウトする）のを待ってから終了するという挙動になっています。
Server Behavior - Uvicorn
uvicorn/server.py at master · encode/uvicorn

@app.post("/ajax") を呼び出すと 10 個の処理がキューに入ります。それを @app.get('/stream') 内で一つずつ取り出し配信しています。そこにタイムラグがあるためこのような挙動になるのです。

どうしても強制終了させたい場合は Ctrl + C を 2 回押しましょう。コードを見る限りそのような作りになっているようです。

Comments

[obon_t]

ご回答ありがとうございます。
Graceful shutdownという処理があるのですね。

コードを追記するなど、Ctrl + C を 2 回押す以外で終了させる方法は無いのでしょうか？
そのフラグを強制的に立たせないなど、もし可能でしたら使われる技術名などヒントになるキーワードを教えていただけると幸いです。

[A_kirisaki]

こればっかりはそういう作りになっているので自分で uvnicorn のソースコードを fork してそういうふうに書き換えるとか、ついでにそういうオプション作ったよって公式にプルリク送るとか、そういう手段しかありませんね。オープンソースのソフトウェアですので「文句があったら自分で実装しろ」ですので……。そうでなくても試しに GitHub の issue に書き込んでみれば実装される「かも」しれません。