目次 (7)
【ブログ紹介】無中断配信でDB・バックエンド・フロント・アプリ互換性
前の記事では、 blueとgreenコンテナを交互にして、バックエンド展開中に502エラーを排除しました。
ところで、以降の機能を追加および修正してみると、異なるバージョンがしばらく共存する瞬間、この問題でした。このブログは、DB・バックエンド(GCP Blue/Green)・Webフロント・モバイルアプリがそれぞれ異なる時点で配布されます。
greenこのDBスキーマの変更中にまだ浮いているblueが壊れないようにするには?フロントとバックエンドは配布タイミングが同じに合わないのに、古いフロントと新規バックエンド(またはその逆)が出会えば?
アプリストアを更新しなかった旧バージョンのアプリユーザーが新しくデプロイされたWeb画面に入ったら?
今回の記事では、どこまでコードで互換性を保証し、どこは配布順で解いたのかを整理しようとしています。
1. 共有DB ↔ Blue/Green バックエンド: Expand & Contract
バックエンドにはスキーマバージョニングのためにFlywayを貼り付けておき、新しいコンテナ( green )が浮かんだときにマイグレーションが自動実行されます。問題は、DBは1つだけですが、 greenがトラフィックを受信する前にDBを先に変更するということです。
sequenceDiagram
autonumber
participant User as "Visitor"
participant Caddy as "Caddy"
participant Blue as "Blue (Old)"
participant Green as "Green (New)"
participant DB as "Cloud SQL (Shared)"
%% 1. 展開前の通常サイクル
User->>Caddy: リアルタイムリクエスト
Caddy->>Blue: リクエストの転送
Blue->>DB: 従来の方法で読む/書く
DB-->>Blue: 結果を返す
Blue-->>Caddy: 応答を返す
Caddy-->>User: 応答完了
%% 2. Green 起動と DB スキーマの変更
Green->>DB: 起動時に移行を実行する (DB 変更)
%% 3. トランジェントサイクル(青が終わるまで処理)
Note over Blue,DB: Green ヘルスチェック待機(~25 秒、失敗時永久)の間、<br/>Blue は変わった DB 上で引き続き動作しなければならない
User->>Caddy: リアルタイムリクエスト (移行前)
Caddy->>Blue: リクエストの転送
Blue->>DB: 既存のクエリの実行 (下位互換必須!)
DB-->>Blue: 正常な結果を返す
Blue-->>Caddy: 応答を返す
Caddy-->>User: 応答完了 (Blue最後まで処理)
%% 4. ヘルスチェックの通過とトラフィックの切り替え
Green-->>Caddy: Healthcheck 200
Note over Caddy,Green: ルーティングターゲットの切り替え (Blue ➔ Green)
%% 5. 移行後の新しいリクエストサイクル(グリーンが処理)
User->>Caddy: 新しいリアルタイムリクエスト (切り替え後)
Caddy->>Green: リクエストの転送
Green->>DB: 新しいクエリの実行
DB-->>Green: 結果を返す
Green-->>Caddy: 応答を返す
Caddy-->>User: 応答完了
%% 6. 旧バージョン終了
Caddy--xBlue: 終了Blue/Green 配備中に共有 DB が最初に変わる区間
greenがヘルスチェックを通過するまで(そしてgreenが起動に失敗し、デプロイがキャンセルされた後も引き続き)、 blueは変更されたDBの上で既存の方法でデータを読み込んで積み重ねなければなりません。
それで、DB構造を変えるときは、一度に乗り換えずにExpand & Contract(拡張・縮小)順に配布を分けましょう。既存のサーバーが完全に降りる前は、古いスキーマを消去したり名前を変更したりしない原則です。
flowchart LR
S1["1. Expand (新しいスキーマを追加)"] --> S2["2. Dual-Write & Backfill (両記録)"]
S2 --> S3["3. Switch (旧バージョン完全終了)"]
S3 --> S4["4. Contract(次の展開で旧スキーマを整理)"]Expand & Contract 無中断スキーマの切り替え
ケース。投稿テーブル→多言語テーブル切り替え(Expand + Dual-Write)
元の記事のタイトル、本文、要約はすべてarticle_mstにありましたが、4つの言語をサポートするにはarticle_translationテーブルに移動する必要がありました。既存の列をすぐに消去して移動した場合は、デプロイメントの瞬間にblueクエリがすぐに壊れ、ロールバックもできませんでした。
だから互換性のために2つの処理をしました。
Expand + Backfill (
V2) :article_mstの既存のカラムはそのままにしてarticle_translationだけを新しく作成した後、既存の韓国語文をON CONFLICT DO NOTHINGで大等バックフィルしました。Dual-Write (
ArticleService) : 新しいサーバー (green) は文を作成・修正・公開するときarticle_mstとarticle_translation(ko)両方に同時に記録します。
// 新しいサーバーが表示されている間は、古いテーブルと新しいテーブルの両方に一緒に書き込むArticle saved = articleRepository.save(article); // 既存のarticle_mstarticleTranslationRepository.save(buildKoTranslation(saved, published)); // 新しい article_translationおかげで移行中blueは新しいテーブルをまったく知らないまま既存のやり方で働き、 greenにバグが生じてblueに戻しても、その書いた文がarticle_mstのように残っており、データを失うことなくロールバックできます。フロント切り替えが完全に終わった後、次の配布で旧カラムを整理(Contract)すればいいです。
2. バックエンド ↔ Web フロントエンド: 下位互換 + 展開順序 + コアフォールバック
バックエンドとフロントは異なるリポジトリ・パイプラインで配布されるため、正確なタイミングで配布されません。それで起こり得る問題は2つあります。
古いフロント - >新しいバックエンドを参照
新型フロント - >旧型バックエンドリファレンス
だから、それぞれの問題が発生しないように戦略を立てました。
バックエンドは常に古いフロントと下位互換性があります。
多言語
?lang=パラメータはすべてrequired = false(送信しない場合は従来と同じko応答)応答DTOの既存のフィールドは維持し、新しいフィールドのみを追加
プッシュ通知・カテゴリ名変更・翻訳管理はすべて新規エンドポイントに分離
すべての新しいAPIを双方向フォールバックするにはコストが高く、基本原則はバックエンド先配布→フロント後配布です。
上記の2つの戦略が最もコードを複雑にしない方法だと思いました。もちろんユーザーがほとんどいないブログサービスなので、事実上ちょっとチェック時間を置いて処理するのが一番すっきりしますよ!上記の方法が常に100%無中断で運営されるように食べられるとは思わない。でも個人ブログだから気持ちよく挑戦してみるから挑戦しました。
3. コード配布と機能開放分離: デフォルト値 OFF フィーチャーフラグ
外部APIキーや新しいインフラストラクチャを必要とする機能は、コードのデプロイ時と機能をオンにする時点を完全に分離しました。
スイッチがデフォルトのfalseであれば、スキーマとコードを最初に安全に配布できます。そして、フロントとバックエンドの両方が安全に配布されたら、それから機能をオンにします。
4. Webフロント↔モバイルアプリ:最長共存区間を扱う
バックエンドとWebフロントは配布の差が長くなければ数分ですが、モバイルアプリはストアの審査とユーザーアップデートの遅延により旧バージョンと新バージョンが数週間ずつ共存できることがわかりました。 (私もアプリを長く更新したことがないので...)
この問題について考えた状況は、プッシュ通知をつけるときにWebViewアプリはネイティブからFCMトークンを受け取り、Webに渡すブリッジが必要ですが、アップデートをしない旧バージョンのアプリにはそのブリッジがありません。
WebViewがページをロードする前にwindow.__carrotAppPush = {version: 1, platform}を植えます。 Webはこのオブジェクトを表示し、アプリプッシュブリッジにトークンを要求します。
window.ReactNativeWebViewはありますがwindow.__carrotAppPushはありません。 Webはこの状態を検出し、エラーの代わりに「アプリの更新が必要」の案内画面に安全に分岐します。
だからAppではなく、Web上でwindowに登録された変数を通じて解決できるようにしました。私は、WebがアプリのWebviewを介してロードされているかどうかを確認する方法で更新を誘導するように解決しました。
クリーンアップ:4層の互換性基準
境界 | 共存時間 | 解決策 |
|---|---|---|
DB ↔ Blue/Green バックエンド | ~25秒(失敗時永久) | Expand & Contract, Dual-Write, |
バックエンド ↔ Web フロント | 数分 | バックエンド下位互換(optionalパラメータ・既存フィールド維持)+バックエンド先配布 |
コード配布↔機能開放 | 設定完了まで | 機能フラグのデフォルト値 |
Webフロント↔モバイルアプリ | 数日〜受注またはそれ以上 |
|
前の記事がCaddy Blue/Greenがトラフィック切り替えを通じて無中断展開を実装したものであれば、今回は無中断展開で実際にサービス間にDB・バックエンド・フロント・アプリをそれぞれ別々に展開しても壊れないように実装する方法です。無中断展開の目的が既存のサービスが絶えず運営されることですが、実際にはバージョン間の整合性が合わなければ途切れるしかないでしょうか?
今回は初めて階層別に分けてバージョンが変わっても互換性があるように作ってみました。コードを書いたときにどのように互換性を考えるべきか、多くの悟りを与えました。
