10年モノのRailsアプリケーションにRuboCopの対応をした話

■イベント
Railsの伝統と革新をつなぐ各社の取り組み
https://sansan.connpass.com/event/315821/

■発表者
技術本部 Eight Engineering Unit Product Devグループ
大久保 滉太

■Sansan中途採用サイト
https://jp.corp-sansan.com/recruit/midcareer/

Transcript

1. Railsの伝統と⾰新をつなぐ各社の取り組み 10年モノのRailsアプリケーションに RuboCopの対応をした話 技術本部 Eight Engineering Unit ⼤久保 滉太
2. ⼤久保 滉太 Sansan株式会社 技術本部 Eight Engineering Unit 2022年 Sansanに新卒⼊社。 名刺アプリ「Eight」の開発組織に所属し、 主にバックエンド開発を担当。 @kotaohkubo
3. - RuboCopの対応の⽬的 - RuboCopの対応の結果 - Eightについて - RuboCop対応をどのように進めたか - 今後の⽅針 アジェンダ
4. 「RuboCop対応」とは？
5. RuboCopの違反を減らしていくこと
6. 対応の⽬的
7. - 開発スピードの向上 - コードの可読性 - AutoCorrectによるスムーズな編集 - プロダクトの品質の向上 - メンテナビリティーの向上 - バグを防ぎやすい - パフォーマンス改善 - セキュリティーの強化 RuboCop対応の目的
8. Copの違反を減らして⾼品質なプロダクトへ
9. Eightについて
10. 名刺アプリ「Eight」 タッチで交換。スマートに管理。 - タッチで素早く名刺交換 - 紙の名刺もデータ化して管理 - 企業向けサービスも多数
11. 主な技術スタック - React - TypeScript フロントエンド - Ruby - Ruby on Rails バックエンド - AWS（CodeBuild, S3, CloudFront, …） - CircleCI / GitHub Actions - Datadog インフラ / ツール
12. RuboCop対応の結果
13. - .rubocop_todo.ymlの⾏数 - 8645⾏ → 1495⾏ (82%削減) - 違反があるCopの数 - 285Cop → 56Cop (80%削減) - 残存Cop - UnsafeAutoCorrect：21Cop - AutoCorrectできない：35Cop RuboCop対応の結果
14. RuboCop対応の進め⽅
15. 事前準備
16. 事前準備 - RuboCop対応の事例を調査 - .rubocop_todo.ymlの作成 - 対応のフローを作成しチームへ共有
17. RuboCop対応の事例を調査
18. 1. 自動生成コマンドを使って .rubocop_todo.yml を生成する 2. .rubocop_todo.ymlから修正するCopを選択する 3. 実際に修正を行う 参考 - たまってしまった .rubocop_todo.yml をGitHub Actionsで継続的かつ⾃動的に倒す⽅法 - 1200⾏あったRuboCopのTodoを半年かけて（ほぼ）解消した話 - 9万件のRuboCop警告を60%削減した話 RuboCop対応の事例を調査サマリ
19. .rubocop_todo.yml?? 🤔
20. - Cop（ルール）を無効にできるYAMLファイル - 定義したCopは $ rubocop 実⾏時に無効にできる - 無効にしたCopを .rubocop_todo.yml から少しずつ消していき（有効化） 違反を修正することで、少しずつRuboCopの対応ができる .rubocop_todo.ymlとは
21. .rubocop_todo.ymlを作れば $ rubocop しても怒られなくなる
22. 1. 対応したいCopを .rubocop_todo.yml の中から選択する 2. 選んだCopを .rubocop_todo.ymlから削除する 3. rubocop -a を⾏い、AutoCorrectされた差分を確認する 4. Pull Requestを作成し、レビュー依頼する RuboCop対応のざっくり流れ
23. .rubocop_todo.ymlを⾃動⽣成する
24. - --auto-gen-config - .rubocop_todo.ymlを⾃動⽣成する - --no-exclude-limit - Excludeファイルの上限数をなくすことができ、ファイルをすべて列挙できる - --auto-gen-only-exclude - Metrics系の違反ファイルをMaxではなく、Excludeで無効にする .rubocop_todo.yml の⾃動⽣成
25. - 何をしてくれるか？ - Metrics系の違反ファイルをMaxではなく、Excludeで無効にする - なぜ必要なのか？ - .rubocop_todo.ymlのMetrics系の⾃動⽣成の仕様には、 プロジェクト内で違反しているCopのMax値を取る仕様の対策 - 例：Metrics/CyclomaticComplexity - Cop違反している箇所で最⼤値が300だったとしたら、他が低かったとしても .rubocop_todo.ymlには Max: 300と記載されてしまう → 通常の開発に影響が出てしまうのを防ぐ –auto-gen-only-exclude
26. .rubocop_todo.ymlを⾃動⽣成したので
27. $ rubocop を全体に実⾏する
28. が、
29. ⼀部のCopのエラーが消えない......
30. 原因：.rubocop_todo.ymlの⾃動⽣成がうまくできない - .rubocop_todo.ymlの⾃動⽣成がうまくいかず、 ExcludeできないCopが存在した ⾃動⽣成での出⼒ 本来期待する出⼒
31. どうにか $ rubocop で 怒られないようにしたい
32. 1. Copの分類をAutoCorrect可能と不可能なものに分類 2. AutoCorrect可能なCopは⼿動で.rubocop_todo.ymlに追記 3. AutoCorrect不可なCopはDisableする $ rubocop で怒られないようにするための対応
33. - ⾃動⽣成後の.rubocop_todo.ymlを修正し、 該当のCopでエラーが起きているファイルを⼿動でExcludeする - .rubocop_todo.ymlを⾃動⽣成すると、再び怒られてしまうので 該当のCopは優先的に対応する AutoCorrect可能なCopは⼿動で.rubocop_todo.ymlに追記 .rubocop_todo.yml .rubocop.yml
34. - $ rubocop -a --disable-uncorrectable を実⾏する - AutoCorrectできない違反に対して、ソースコードに⾃動的に コメントを挿⼊して、それらの違反を無視するようにするコマンド AutoCorrect不可なCopはDisableする ※rubocop:disableのエイリアスです
35. $ rubocop 全体を通してもエラーが出なくなった 🎉
36. 事前準備 - RuboCop対応の事例を調査 - .rubocop_todo.ymlの作成 - 対応のフローを作成しチームへ共有
37. 1. Cop対応表で⾃分の担当のCopを⼀つ選択する 2. .rubocop_todo.yml 対象のCopを削除し、$ rubocop -a を⾏う a. コード上で disableされていないかも確認する 3. 差分を確認しPullRequestを作成する a. AutoCorrectでバグることがあるので注意する b. 必要に応じて動作確認やテストコードを追加する 4. マージしてリリースする a. セルフレビュー + 1approve 5. Cop対応表のチェックをつける 対応のフローを作成しチームへ共有
38. Cop対応表？
39. Cop対応表 担 当 者 の 名 前 が ⼊ っ て い ま す
40. RuboCop対応の結果
41. - .rubocop_todo.ymlの⾏数 - 8645⾏ → 1495⾏ (82%削減) - 違反があるCopの数 - 285Cop → 56Cop (80%削減) - 残存Cop - UnsafeAutoCorrect：21Cop - AutoCorrectできない：35Cop RuboCop対応の結果
42. - 通常業務に影響がないように⼯夫した - 実施者が⾛りやすいように⼿順書などを⽤意した - 部内の⽬標（OKR）で扱えたので取り組みやすかった - （テンション上がるように盛り上げた） 対応中に気をつけたことや気づいたこと
43. - UnsafeAutoCorrectの対応完了 - 進捗：44 / 65 Copは修正対応済み（2024.3 〜 2024.4） - 完了⾒込み：2024.5 - AutoCorrectできないCopへの対応⽅針検討 今後の展望