[Session] SpotifyとRelaymが正しく同期を取れているかチェックする機構を追加

[p1ass]

概要

Spotify側のアプリを操作されると同期が取れなくなるので、それをキャッチできるようにする

要件

• PRD を参照

API仕様 (あれば)

https://github.com/camphor-/relaym-server/blob/master/docs/api.md#interrupt

タスク

• 何をもって同期が取れてないとみなすか決める
• チェックの間隔を決める
• サーバが死んだときに復帰できる / スケールアウトに対応できる設計を考える [Session] サーバを再起動したときにセッションのタイマーがちゃんと復活されるか確認  #73 へ移行
  • めんどくさそうなら一旦なしでも良いかも

[p1ass]

同期処理

前提となる考え

Relaym側を完全に正として扱うのは技術的に極めて難しいので、Spotify側で操作されたら同期をとるのは諦める。

また、Webサイトのスクロールをハックするのと一緒であまりUXが良くない（個人的考え）

方針

• 同期のチェックは現在再生している曲とされる曲の終了時間 + 5秒後に行う。
  • 次の曲が存在する場合、Spotify側の「次に再生する曲」に曲が詰まれていてそれがこのタイミングで再生されているはず。
  • ここで違う曲が流れていたらSpotify側で操作されたとみなす。
  • 想定される曲が流れていた場合、現在の再生時間から次のチェック時間を計算してタイマーをセットする 。

プロセスが死ぬときの対処

状況

• デプロイやスケールイン時にプロセスにSIGTERMなどが飛んできてwebサーバがgraceful shutdownされるとタイマー処理の完了を待たずしてプロセスが死ぬ。
• 一度タイマーの更新が途切れると一生そのセッションの同期判定がなされなくなる。

対応策

1. DBやジョブキューにジョブを積んでwebサーバ側がポーリングで取得
   • 必ず同期判定はされるがポーリングの実装がしんどい
2. 指定時間後にWebhookを叩いてくれるサービスを使う
   • これが一番まともそう
   • コンテナなので別プロセスを起動するのはだめ。 sleep 10;curl ... とやってもコンテナごと死んだら意味がない。
   • これをうまくできるクラウドサービスを知らない
3. WebSocketの接続が開始されたときに、タイマーが存在しない場合は再度作り直す

• タイマー処理はWSのコネクションが貼られているときだけ必要なので、このタイミングで復帰させれば良さそう
• スケールアウトしたらだめだが、一旦の方法としてはあり