緊急Ques 「食べログの品質ダッシュボード」-コードのメトリクスに基づくリファクタリング戦略

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

© Kakaku.com Inc. All Rights Reserved. 4 栗⼭友樹 (weakboson) マイクロサービス化チームリーダー兼テックリード⾷べログではサービス開発、DevOpsを経て2019年からマイクロサービス化チームマイクロサービス化チームの最近の公開活動 • ⾷べログのレストラン検索を⽀える Debezium と Apache Kafka ‒ Qiita • ⾷べログの内製Pub/Subメッセージング基盤をApache Kafkaにリプレイスした話 ‒ Qiita • Qiita Night〜モノリスからの脱却って実際どうなの？マイクロサービス化について⾚裸々に語る〜

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Slide 7

Slide 7 text

Slide 8

Slide 8 text

Slide 9

Slide 9 text

© Kakaku.com Inc. All Rights Reserved. 9 ⾷べログのシステム課題⾷べログは今年で16年⽬のサービスで、Railsになってからは14年が経過しています。 Windows OSがVistaから11まで4回代替わりする年⽉です。バージョン⽇本語版発売⽇ Windows XP 2001年9⽉6⽇ Windows Vista 2006年11⽉30⽇ Windows 7 2009年9⽉1⽇ Windows 8 2012年8⽉16⽇ Windows 10 2015年7⽉29⽇ Windows 11 2021年10⽉5⽇

Slide 10

Slide 10 text

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Slide 13

Slide 13 text

Slide 14

Slide 14 text

Slide 15

Slide 15 text

© Kakaku.com Inc. All Rights Reserved. 15 リファクタリングの前にお掃除が必要密結合で技術的負債が溜まったアプリケーションというのは散らかった部屋のようなものです。散らかった部屋を⾒て「よし、部屋を分けよう！」なんていきなり⾔いだす⼈はあまりいなくて、まずはいらないものを捨てたり、ホコリや汚れをキレイに掃除したり、収納グッズを買って⽤途ごとに置き場所を決めたりするなどして、部屋を整理しようと考えるのが⾃然です。

Slide 16

Slide 16 text

Slide 17

Slide 17 text

Slide 18

Slide 18 text

© Kakaku.com Inc. All Rights Reserved. 18 コードのメトリクスで品質を可視化する先⾏事例 • 堀⽥圭佑・佐野由希⼦・肥後芳樹・楠本真⼆: 修正頻度の⽐較に基づくソフトウェア修正作業量に対する重複コードの影響に関する調査, 情報処理学会論⽂誌 Vol.52 No. 9 2788‒2798 (Sep. 2011) • Aki Asahara (Sider): Siderに強⼒な新機能が追加。コード品質の可視化、リファクタリングすべきファイルの可視化が可能に, Sider社ブログ (Jun. 2021) お掃除の優先順位を考えるにあたりいくつかの先⾏事例を参考にした。

Slide 19

Slide 19 text

Slide 20

Slide 20 text

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

Slide 29

Slide 29 text

Slide 30

Slide 30 text

Slide 31

Slide 31 text

Slide 32

Slide 32 text

© Kakaku.com Inc. All Rights Reserved. 32 ICEスコアリング ICEスコア = 影響⼒ (Impact) x 信頼度 (Confidence) x 容易性 (Ease) • 影響⼒: 改善対象の成果やKPIに与える効果の量 • 信頼度: 成功する可能性や確率 • 容易性: 実⾏しやすさそれぞれ1~10の相対基準で付ける ICEスコア (ICE score) とは、改善案や着⼿すべき施策が多い際に優先すべきものを順序づける⼿法のこと。

Slide 33

Slide 33 text

© Kakaku.com Inc. All Rights Reserved. 33 ICEスコアリング ICEスコア = 影響⼒ (Impact) x 信頼度 (Confidence) x 容易性 (Ease) • 影響⼒: コードの更新回数、デッドコード量 (多いほど⾒通し改善効果⼤) • 信頼度: いまの段階で差異なし • 容易性: デッドコード量 (少ない程容易) ICEスコア (ICE score) とは、改善案や着⼿すべき施策が多い際に優先すべきものを順序づける⼿法のこと。

Slide 34

Slide 34 text

Slide 35

Slide 35 text

Slide 36

Slide 36 text

© Kakaku.com Inc. All Rights Reserved. 36 ICEスコアを算出優先順位サブシステム更新回数デッドコード影響⼒容易性 ICEスコア SP版 51 K 11.0 K 10 3 30 PC版レストラン機能 38 K 8.6 K 7 4 28 スマホアプリAPI 32 K 3.5 K 3 8 24 飲⾷店向け管理機能 31 K 4.2 K 3 6 18 ICEスコアは「SP版」が最⼤

Slide 37

Slide 37 text

© Kakaku.com Inc. All Rights Reserved. 37 ICEスコアを元に優先順位を決める優先順位サブシステム更新回数デッドコード影響⼒容易性 ICEスコア 2 SP版 51 K 11.0 K 10 3 30 3 PC版レストラン機能 38 K 8.6 K 7 4 28 1 スマホアプリAPI 32 K 3.5 K 3 8 24 4 飲⾷店向け管理機能 31 K 4.2 K 3 6 18 ⼩さく PoC をしたいので、ICEスコアは「SP版」が最⼤ですが「スマホアプリAPI」から取り掛かることにした。

Slide 38

Slide 38 text

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Slide 41

Slide 41 text

Slide 42

Slide 42 text

© Kakaku.com Inc. All Rights Reserved. 42 まとめできたこと • 2つのメトリクス「デッドコード」と「コードの更新回数」が計測できた • メトリクスからICEスコアを付け、スコアを元にお掃除の優先順位が決められたこれから • ソースコードと統計数値化する前のデッドコードをマッピングして、お掃除できるコードを可視化・削除 • デッドコードをお掃除した内部品質改善効果を計測して仮説を検証