Skip to content

プロジェクトのイベント

タスクの変更を同じプロジェクトの画面へ SSE で伝える仕組みと、認可・発行の契機

概要

同じプロジェクトを開いている別の画面へ「タスクが変わった」ことを SSE で伝え、再読み込みせずに表示を更新する。

エンドポイント

GET /v1/tenants/{tenant_id}/projects/{project_id}/events(text/event-stream)

event: tasks
data: {"kind":"tasks_changed"}
  • 5 秒ごとにキープアライブのコメントを流す。本番の /api を中継する Bun が無通信 10 秒で接続を切るため
  • サーバーの停止時にはストリームを閉じる。閉じないと graceful shutdown が完了しない

認可

GET .../tasks と同じ(ReadTask スコープとプロジェクトへのアクセス)。未ログインは 401、非メンバーは 403、他テナントのプロジェクトは 404。

検査は接続時だけ行う。接続中にメンバーから外された人にも、切断するまで合図は届く。合図に内容が無いので許容している。

発行の契機

/{project_id}/tasks 配下の GET / HEAD / OPTIONS 以外が 2xx を返したとき、この配下に付けたミドルウェアが発行する(コメントや時間記録も含む)。発行に失敗しても応答は失敗させず、警告ログだけを残す。

次の変更では発行しない。

  • 配下の外の API(スプリントへの割り当て、マージ後の作用の確定、ステータスやラベルの削除など)
  • GitHub 連携ジョブ

Redis

チャンネルは project-events:{project_id}。pub/sub なので保存されず、切断中の合図は届かない。/events の接続ごとに Redis の接続を 1 本使う。

載せない情報

タスクの内容・ID・操作者は載せない。受け手は権限のある API で取り直す。

フロントエンド

useProjectEvents がプロジェクト配下のレイアウト(pages/@tenant/projects/@projectKey/+Layout.vue)で 1 本だけ接続し、合図を 300ms でまとめてタスク関連のクエリを無効化する。接続できたとき(初回も含む)は、購読成立前の変更を埋めるため同じ無効化を 1 回行う。

ブラウザが再接続を諦める非 200 の応答(デプロイ中の 502 など)の後は、30 秒ごとに開き直す。テナント全体の画面(カレンダー、ガント、マイタスク)は接続しない。

Type to search…

↑↓ navigate↵ selectEsc close