Share
Embed
Flutterアプリで可用性を向上させたFeatureFlagの運用戦略とその方法
Kakeru Nakabachi
November 21, 2024
Transcript
104 slides
-
Flutterリプレイス後のFeatureFlag運用 FeatureFlagを使ったトランクベース開発 01 main(trunk) Release 1.0 Release 1.1 branch-A branch-B
未完成の機能実装 FeatureFlag OFF 🚩FeatureFlag ON 機能の完成 -
Flutterリプレイス後のFeatureFlag運用 前提知識2/2:アプリのレイヤー構成 • Clean Architectureに寄せたData、 Domain、State、UIのレイヤーで構 成 • RiverpodでDIと状態管理 01
Connected Screen Stateless Screen Widget Selector State UseCase Persistence Service UI State Domain Data -
Flutterリプレイス後のFeatureFlag運用 前提知識2/2:アプリのレイヤー構成 Domain 01 Connected Screen Stateless Screen Widget Selector
State UseCase Persistence Service UI State Domain Data -
Flutterリプレイス後のFeatureFlag運用 前提知識2/2:アプリのレイヤー構成 State 01 Connected Screen Stateless Screen Widget Selector
State UseCase Persistence Service UI State Domain Data -
Flutterリプレイス後のFeatureFlag運用 前提知識2/2:アプリのレイヤー構成 UI Stateの参照はConnected Screenでの み行う Connected ScreenでStateを束ねる Stateless ScreenはConnected
Screen から値を受け取り、直接Stateの参照はし ない 01 Connected Screen Stateless Screen Widget Selector State UseCase Persistence Service UI State Domain Data -
Flutterリプレイス後のFeatureFlag運用 FeatureFlagの使用用途 • 開発中の機能を細かいPRに分けてトランクにマージしてPRのリードタイ ムを短縮したい • コンフリクトを発生しにくくしたい • リリース時に不具合があったときに切り戻したい ➢
新機能開発、大規模なリファクタリング • 機能の効果検証をしたい ➢ 新機能開発の ABテスト 01 -
Flutterリプレイス後のFeatureFlag運用 FeatureFlag実装 内製のFeatureFlagクライアントを使用 2つのタイプの実装 • workInProgress ◦ SharedPreferencesでいつでも手元でFeatureFlagの切り替えが可能 ◦ 開発中に使用
• ops ◦ Firebase RemoteConfigでリリース無しでFeatureFlagの切り替えが可能 ◦ 機能リリース時に使用 01 -
Flutterリプレイス後のFeatureFlag運用 FeatureFlagのカテゴリ分類 • どれくらい切り替わる頻度が多い か? • どれくらい生存期間が長いか? Feature Toggles (aka
Feature Flags) 01 https://martinfowler.com/articles/feature-toggles.html -
Flutterリプレイス後のFeatureFlag運用 FeatureFlag実装 内製のFeatureFlagクライアントを使用 2つのタイプの実装 • workInProgress ◦ SharedPreferencesでいつでも手元でFeatureFlagの切り替えが可能 ◦ 開発中に使用
• ops ◦ Firebase RemoteConfigでリリース無しでFeatureFlagの切り替えが可能 ◦ 機能リリース時に使用 01 -
Flutterリプレイス後のFeatureFlag運用 FeatureFlag導入原則 できるだけデータフローの根源で絶つ 01 Connected Screen Stateless Screen Widget Selector
State UseCase Persistence Service UI State Domain Data -
Domain Flutterリプレイス後のFeatureFlag運用 FeatureFlag導入原則 できるだけデータフローの根源で絶つ • サーバーAPIの変更があったときは UseCaseでFeatureFlag制御 01 Connected Screen
Stateless Screen Widget Selector State UseCase Persistence Service 🚩 GET v1→v2 UI State Data -
Flutterリプレイス後のFeatureFlag運用 FeatureFlag導入原則 できるだけデータフローの根源で絶つ • UIの変更があったときはUIで FeatureFlag制御 01 Connected Screen Stateless
Screen Widget Selector State UseCase Persistence Service 🚩 Button Red→Blue UI State Domain Data -
従来のFeatureFlagを使用した開発 従来の開発フロー • 実装方針レビューを30分MTGで実施 • 記載内容 ◦ 実装概要 ◦
具体的な実装手順 ◦ 過去起きた不具合の考慮チェック 02 設計 実装 動作確認 QC リリース flag削除 -
従来のFeatureFlagを使用した開発 従来の開発フロー workInProgressのタイプでFeatureFlagの追加 実装要件に沿ってFeatureFlagClientを使用して実装 E2Eテストで基本FeatureFlagがOFFのテストをCIで実施 02 設計 実装 動作確認
QC リリース flag削除 https://developers.cyberagent.co.jp/blog/archives/41308/ -
従来のFeatureFlagを使用した開発 よくある実装要件 UI • 新機能追加 ◦ 投票履歴画面を新しく追加 • 既存機能の改修
◦ トップ画面を新デザインにリニューアルしたい 02 -
従来のFeatureFlagを使用した開発 よくある実装要件 Domain • 新機能追加 ◦ トップで情報を表示するために新規でサーバー APIリクエストしたい •
既存機能の改修 ◦ サーバーAPIのリクエストをv1からv2にしたい 02 -
発生した不具合の分析と整理 実際の不具合発生ケース 発生ケースパターン 03 Domain UI 不具合発生頻度 新規追加 新規追加
低 既存改修 新規追加 低 新規追加 既存改修 中 既存改修 既存改修 高 発生しやすいケース -
発生した不具合の分析と整理 実際の不具合発生ケース 発生ケースパターン 03 Domain UI 不具合発生頻度 新規追加 新規追加
低 既存改修 新規追加 低 新規追加 既存改修 中 既存改修 既存改修 高 発生しやすいケース -
発生した不具合の分析と整理 実際の不具合発生ケース 03 UI ①:イベント購読 ④:③がきたらDomain呼び出し Domain ③:イベント購読 ②:Domain呼び出し
既存のデータフローを削除して 実 質同じ挙動 になるように変更 Domain UI -
発生した不具合の分析と整理 実際の不具合発生ケース 03 Domain UI ①:イベント購読 ④:③がきたらDomain呼び出し Domain ③:イベント購読
②:Domain呼び出し 購読のやりかたにミス ④が実行されない UI -
発生した不具合の分析と整理 実際の不具合発生ケース 03 Domain UI ①:イベント購読 ④:③がきたらDomain呼び出し Domain ③:イベント購読
②:Domain呼び出し 購読のやりかたにミス ④が実行されない 不具合発生 🚨 UI -
発生した不具合の分析と整理 実際の不具合発生ケース 03 Domain UI ①:イベント購読 ④:③がきたらDomain呼び出し Domain ③:イベント購読
②:Domain呼び出し 既存のデータフローも無いので 切り戻しできない UI -
発生した不具合の分析と整理 実際の不具合発生ケース 03 Domain UI ①:イベント購読 ④:③がきたらDomain呼び出し Domain ③:イベント購読
②:Domain呼び出し 理想は既存には手を触れずに改修 どちらのデータフローも実行で きるようにフラグ分岐 🚩 UI -
発生した不具合の分析と整理 実際の不具合発生ケース 発生ケースパターン 03 Domain UI 不具合発生頻度 新規追加 新規追加
低 既存改修 新規追加 低 新規追加 既存改修 中 既存改修 既存改修 高 発生しやすいケース -
発生した不具合の分析と整理 実際の不具合発生ケース まとめ • 既存改修が複数レイヤーで起こると 不具合が発生しやすい • 既存は変更をしないように改修した い
03 Domain UI 不具合発生頻度 新規追加 新規追加 低 既存改修 新規追加 低 新規追加 既存改修 中 既存改修 既存改修 高 -
発生した不具合の分析と整理 コードベース以外の考慮 • 若手が多いチーム構成 • 組織拡大時期で人の流動性が高い • 他の横軸並行タスクが多く、ヒューマンエラーが起こりやすい 中堅メンバーの能力に頼らず、いつでも誰でも安全に
FeatureFlag制御でき るような実装制限をかけたい 03 -
発生した不具合の分析と整理 解決したいことの整理 • アプローチ ◦ 既存は触れずに残しながら改修できるようにする ◦ 制御忘れに機械的に気付けるようする ➢
若手から中堅まで誰でも同じレベルで可用性を向上させられる実装制限 をかけたい 03 -
可用性向上のための運用戦略とその方法 実際の不具合から考える運用戦略 • 既存は触れずに残しながら改修できるようにする • 若手から中堅まで誰でも同じレベルで可用性を向上させられる実装制限 をかけたい • 制御忘れに機械的に気付けるようする
シンプルな真偽値(bool)制御を禁止して、既存の実装には全く手をつけない実 装制限をかける 04 -
可用性向上のための運用戦略とその方法 運用戦略 - 制御レイヤーの制限 できるだけデータフローの根本のDomainだけで分岐が完結できると、UIと Domainでのデータフローでミスが起こりにくくなる 04 UI State
Domain Data Source ON:文字列 OFF:空文字 UIは文字列があるかど うかで表示を制御 FeatureFlagは意識しな い データフロー 🛠FeatureFlag分岐 -
可用性向上のための運用戦略とその方法 運用戦略 - 制御レイヤーの制限 UIのみの改修の場合はUIでしかFeatureFlag分岐はできない • 例 ◦ ボタンの文言の切り替えで
ABテストしたい ◦ ボタン押下したときの遷移先を変更したい 04 UI State Domain Data Source -
可用性向上のための運用戦略とその方法 運用戦略 - 制御レイヤーの制限 従来通り、制御レイヤーは基本 UI・Domainレイヤーのみにする これ以外の特殊な例外は一部Stateも 許容する 04
Connected Screen Stateless Screen Widget Selector State UseCase Persistence Service 🚩 🚩 UI State Domain Data -
可用性向上のための運用戦略とその方法 運用戦略 - 分岐制御の制限 • FeatureFlagをbool値で扱うと自由度が高すぎて簡単に複雑なロジック制 御が可能になる • 既存のif文に組み合わせたり、三項演算子に混ぜたり
Domainでは不具合が発生した例はなかったのでUIのみ制限をかける 04 -
可用性向上のための運用戦略とその方法 開発フローから見る戦略 04 設計 実装 動作確認 QC リリース flag削除
レビュー方法 ドキュメント作成 BEFORE 30分MTGでレビュー ドキュメント管理ツール AFTER PullRequest上でコードレビューと同 じ方法でレビュー PullRequest(MarkDown) -
可用性向上のための運用戦略とその方法 検討して採用しなかったこと 04 • 課題に対する大きな変更 ◦ Gitflowな開発 ◦ プロジェクトコード全体のリアーキテクチャ
◦ 理想形の追求 • 課題が起きていない箇所への変更 • FeatureFlagの利用方針 ◦ UIに近いところで分岐 -
対応した結果と今後の展望 可用性と利便性のトレードオフ 05 可用性 高 利便性 高 利便性 低
可用性 低 理 想 現 実 -
対応した結果と今後の展望 今後の展望 可用性以外の利便性の向上 • 自動でRemoteConfigに追加 • RemoteConfigでFeatureFlagが変更されたら通知 • 可用性を考慮した迷いがないFeatureFlag実装
• ABテスト設定の自動化 • DangerからCustomLintへの置き換え 05