レガシーコード改善のために取り組んでいること

Hello LT world『みんなで語る！好きと学びのアウトプット LT Night』

https://findy.connpass.com/event/372581/

Transcript

1. レガシーコード改善のために取り組んでいること Hello LT world『みんなで語る！好きと学びのアウトプット LT Night』 2025/11/10 yussak 1
2. @yussak213 事業会社の Web エンジニア 最近はプロダクトマネジメントやチーム作 りに興味あり 自己紹介 2
3. 仕様が複雑だがドキュメントやテストコードが少ない コード品質に課題がある 責務が大きい、テストしづらい、使われてないコードがあるなど ロジックを持った SQL ファイルが 500 個以上ある → 機能追加に時間がかかる、バグが入りやすい、モチベーションの低下、変更への恐 怖など プロダクトの課題 3
4. 素早く安全に価値提供できるようにしたい 今後関わる人が楽になるようにしたい どうなりたい 4
5. タスクと同時に改善する タスクの合間に改善する チームで改善する 戦略 5
6. ボーイスカウトルールを意識 設計の改善 テストコードの追加・修正 Tidy First の実践 タスクと同時に改善する 6
7. ボーイスカウトルールを意識し、来たときよりもきれいに コメントアウトコードやデッドコードの削除、命名改善 関数やクラス分離 ストアドプロシージャの ORM 移行 タスクと同時に改善する 7
8. ボーイスカウトルールを意識し、来たときよりもきれいに コメントアウトコードやデッドコードの削除、命名改善 関数やクラス分離 ストアドプロシージャの ORM 移行 ← この例を紹介します タスクと同時に改善する 8
9. データベース上に保存された SQL と処理ロジックのまとまり。 アプリケーションから呼び出して実行する。 by Claude ストアドプロシージャとはなにか 9
10. DROP TYPE IF EXISTS xxx CASCADE; CREATE TYPE xxx AS ( xxx BIGINT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx BOOLEAN ,xxx BOOLEAN ,xxx TIMESTAMPTZ ,xxx TIMESTAMPTZ ,xxx TIMESTAMPTZ ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx BIGINT ,xxx TEXT ,xxx BIGINT ,xxx TEXT ,xxx BIGINT ,xxx TEXT ... 一部 ※ 一般化しています 10
11. IF xxx = TRUE THEN xxx := true; ELSIF xxx = FALSE THEN xxx := false; ELSE xxx := NULL; END IF; IF xxx IS NOT NULL THEN SELECT array_agg(xxx) FROM xxx where xxx = ( SELECT xxx FROM xxx WHERE xxx = xxx ) INTO xxx ; ELSIF xxx IS NOT NULL THEN ... ; END IF; xxx := $$ FROM xxx AS xxx LEFT OUTER JOIN xxx AS xxx ON xxx.xxx = xxx.xxx LEFT OUTER JOIN xxx AS xxx ON xxx.xxx = xxx.xxx 一部 ※ 一般化しています 11
12. ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx $$ || CASE WHEN xxx IS NOT NULL THEN ',xxx.xxx IS NOT NULL' ELSE ',NULL::BOOLEAN' END || CASE WHEN xxx IS NOT NULL THEN ',xxx.xxx IS NOT NULL' ELSE ',NULL::BOOLEAN' END || CASE WHEN xxx IS NOT NULL THEN ',xxx.xxx' ELSE ',NULL::BOOLEAN' END || CASE WHEN xxx IS NOT NULL THEN ',xxx.xxx IS NOT NULL' ELSE ',NULL::BOOLEAN' END || $$ ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,( SELECT count(*) FROM xxx AS xxx WHERE xxx.xxx = xxx.xxx ) AS xxx 一部 ※ 一般化しています 12
13. DROP TYPE IF EXISTS xxx CASCADE; CREATE TYPE xxx AS ( xxx BIGINT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx BOOLEAN ,xxx BOOLEAN ,xxx TIMESTAMPTZ ,xxx TIMESTAMPTZ ,xxx TIMESTAMPTZ ,xxx TIMESTAMPTZ ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx BIGINT ,xxx TEXT ,xxx BIGINT ,xxx TEXT ,xxx BIGINT ,xxx TEXT ,xxx BIGINT ,xxx TEXT ,xxx BIGINT ,xxx TEXT ,xxx BOOLEAN ,xxx BIGINT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx INT ,xxx INT ,xxx INT ,xxx INT ,xxx BOOLEAN ,xxx INT ,xxx INT ,xxx INT ,xxx INT ,xxx BOOLEAN ,xxx TEXT ,xxx BOOLEAN ,xxx TEXT ,xxx BOOLEAN ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx TEXT ,xxx TEXT ,xxx BOOLEAN ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx TEXT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx TEXT ,xxx BIGINT ,xxx BIGINT ,xxx BOOLEAN ,xxx BOOLEAN ,xxx BOOLEAN ,xxx BOOLEAN ,xxx TIMESTAMPTZ ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx TEXT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx TEXT[] ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx BIGINT ,xxx TEXT ,xxx TIMESTAMPTZ ,xxx TIMESTAMPTZ ,xxx BOOLEAN ,xxx BOOLEAN ,xxx TEXT ,xxx TEXT ,xxx BOOLEAN ,xxx BOOLEAN ,xxx TEXT[] ,xxx TEXT ,xxx TEXT ); CREATE OR REPLACE FUNCTION xxx( xxx BIGINT DEFAULT NULL ,xxx BIGINT DEFAULT NULL ,xxx BOOLEAN DEFAULT NULL ,xxx BOOLEAN DEFAULT NULL ,xxx BOOLEAN DEFAULT NULL ,xxx BOOLEAN DEFAULT NULL ,xxx BOOLEAN DEFAULT NULL ,xxx BOOLEAN DEFAULT NULL ,xxx BIGINT DEFAULT NULL ,xxx TIMESTAMPTZ DEFAULT NULL ,xxx TIMESTAMPTZ DEFAULT NULL ,xxx TEXT[] DEFAULT ARRAY['01'] ,xxx BOOL[] DEFAULT ARRAY[TRUE] ,xxx DATE DEFAULT NULL ,xxx DATE DEFAULT NULL ,xxx BOOLEAN DEFAULT FALSE ,xxx TEXT DEFAULT NULL ,xxx TIMESTAMPTZ DEFAULT NULL ,xxx BIGINT DEFAULT NULL ,xxx BOOLEAN DEFAULT NULL ) RETURNS SETOF xxx AS $FUNCTION$ DECLARE xxx TEXT; xxx TEXT; xxx TEXT[]; xxx TEXT; xxx TEXT; xxx TEXT[]; xxx BOOLEAN; xxx TEXT := 'a'; xxx TEXT := 'b'; xxx TEXT := 'c'; xxx TEXT := 'd'; xxx TEXT := 'e'; BEGIN IF xxx = TRUE THEN xxx := true; ELSIF xxx = FALSE THEN xxx := false; ELSE xxx := NULL; END IF; IF xxx IS NOT NULL THEN SELECT array_agg(xxx) FROM xxx where xxx = xxx INTO xxx ; ELSIF xxx IS NOT NULL THEN SELECT array_agg(xxx) FROM xxx where xxx = ( SELECT xxx FROM xxx WHERE xxx = xxx ) INTO xxx ; END IF; xxx := $$ FROM xxx AS xxx LEFT OUTER JOIN xxx AS xxx ON xxx.xxx = xxx.xxx LEFT OUTER JOIN xxx AS xxx ON xxx.xxx = xxx.xxx LEFT OUTER JOIN xxx AS xxx ON xxx.xxx = xxx.xxx LEFT OUTER JOIN xxx AS xxx ON xxx.xxx = xxx.xxx LEFT OUTER JOIN xxx AS xxx ON xxx.xxx = xxx.xxx LEFT OUTER JOIN xxx AS xxx ON xxx.xxx = xxx.xxx $$ ; IF xxx IS NOT NULL THEN xxx := xxx || $$ LEFT OUTER JOIN xxx AS xxx ON ( xxx.xxx = xxx.xxx AND $6 = xxx.xxx ) $$ ; END IF; xxx := xxx || $$ WHERE ($1 IS NULL OR xxx.xxx = $1) AND ($2 IS NULL OR (xxx.xxx = $2)) AND ($3 IS NULL OR xxx.xxx =$3) AND ($4 IS NULL OR xxx.xxx = $4) AND ($5 IS NULL OR xxx.xxx >= $5) AND ($7 IS NULL OR date_trunc('day', xxx.xxx) = date_trunc('day', $7)) AND ($8 IS NULL OR $8 = FALSE OR xxx.xxx < xxx.xxx OR xxx.xxx < xxx.xxx) AND ($9 IS NULL OR $9 = FALSE OR xxx.xxx < xxx.xxx) AND ($10 IS NULL OR $10 = FALSE OR xxx.xxx < xxx.xxx) AND ($12 IS NULL OR date_trunc('day', xxx.xxx) >= date_trunc('day', $12)) AND ($13 IS NULL OR date_trunc('day', xxx.xxx) <= date_trunc('day', $13)) AND ($18 IS NULL OR xxx.xxx = $18) AND ($19 IS NULL OR xxx.xxx >= $19) AND ( $20 IS NULL OR ( ( xxx.xxx IS TRUE AND xxx.xxx @> $20 ) OR xxx.xxx IS FALSE ) ) AND ($21 IS NULL OR (xxx.xxx = $21)) $$ ; IF xxx IS NOT NULL AND xxx !=1 AND xxx !=2 THEN SELECT xxx ,xxx FROM xxx AS xxx WHERE xxx.xxx = xxx INTO xxx ,xxx ; IF xxx IS TRUE THEN IF xxx = xxx THEN xxx := xxx || $$ AND xxx.xxx @> ARRAY[$14] AND xxx.xxx IN ($15,$17) AND xxx.xxx IS NULL AND xxx < xxx AND ($12 IS NULL OR xxx.xxx >= date_trunc('day', $12)) AND ($13 IS NULL OR xxx.xxx < date_trunc('day', $13)) $$ ; ELSE xxx := xxx || $$ AND xxx.xxx @> ARRAY[$14] AND xxx.xxx IN ($16,$17) AND xxx.xxx IS NULL AND xxx < xxx AND ($12 IS NULL OR xxx.xxx >= date_trunc('day', $12)) AND ($13 IS NULL OR xxx.xxx < date_trunc('day', $13)) $$ ; END IF; END IF; END IF; xxx := $$ SELECT xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx $$ || CASE WHEN xxx IS NOT NULL THEN ',xxx.xxx IS NOT NULL' ELSE ',NULL::BOOLEAN' END || CASE WHEN xxx IS NOT NULL THEN ',xxx.xxx IS NOT NULL' ELSE ',NULL::BOOLEAN' END || CASE WHEN xxx IS NOT NULL THEN ',xxx.xxx' ELSE ',NULL::BOOLEAN' END || CASE WHEN xxx IS NOT NULL THEN ',xxx.xxx IS NOT NULL' ELSE ',NULL::BOOLEAN' END || $$ ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,( SELECT count(*) FROM xxx AS xxx WHERE xxx.xxx = xxx.xxx AND xxx.xxx = '00101' AND xxx.xxx IS NOT NULL AND xxx.xxx = TRUE ) AS xxx ,( SELECT count(*) FROM xxx AS xxx WHERE xxx.xxx = xxx.xxx AND xxx.xxx = '00102' AND xxx.xxx IS NOT NULL AND xxx.xxx = TRUE ) AS xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx ,xxx.xxx $$ || xxx || dyn_order_by( '{01,02,03}' ,'{xxx.xxx,xxx.xxx,xxx.xxx}' ,xxx ,xxx ,0 ,xxx ) ; RETURN QUERY EXECUTE xxx USING xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ,xxx ; END; $FUNCTION$ LANGUAGE plpgsql; 全体像 ※ 一般化しています 13
14. 問題 縦に長過ぎてメンテがしづらすぎる！ 責務によって分離もされておらず一つの縦に長い関数になっている 変更が他の開発者や環境に即座に反映される 変更前後に報告が必要 ソースコードを印刷してデバッグする方法があることを知った ストアドの ORM 移行 14
15. class X < Y def all(params={}) query = search_query(params) query.all end def first(params={}) query = search_query(params) query.first end def count(params={}) query = search_query(params) query.count end private def search_query(params) ... 改善後 15
16. どう進めたか Cursor で ORM コードを作成 コードリーディングや画面操作、Rails console などで動作確認し、仕様を理解 生成コードの動作が正しいか徹底的に検証 コード自体はほぼ AI に作ってもらったが、そこから動作の正しさやコード自体の理解 に時間をかけた ストアドの ORM 移行 16
17. 成果 対応がしやすくなった！ 600 行近くあったのが 300 行ほどに減った 必要な部分だけ外部に公開し、必要な部分に集中しやすくなった 責務に沿って関数を分離できたり、使われていなかった処理を削除できた ローカルの変更を自分だけに反映可能になった 仕様理解が深まった → メンテナンスしやすくなった ストアドの ORM 移行 17
18. 新規テーブルを正規化して作る カラム追加時に既存のテーブル、新規テーブルどちらに追加するか検討して対 応 クラスを分離（新規実装、既存実装） 関数を小さくしていって、まとまりを新規クラスに分ける 設計の改善 18
19. 成果 徐々にコードがきれいになり、メンテナンス、テストしやすくなっている どうすれば将来的にメンテナンスしやすくなるかの意識を持てている 設計の改善 19
20. 仕様化テストの追加（既存実装に対して実施） 現状の動作を正として記録するテストコードを書く 例: 不正値のテストの時に、 「フィールド A だと Invalid Parameter となるが B だと成功する」のような違いをそのまま記録 新規実装は TDD で対応 Controller → model →DB まで一気にカバー Fat Controller の改善などの設計改善などもしやすくなる お手本となるテストケースを作る 他メンバーや AI がそれを参考にできる状態にする テストコードの追加・修正 20
21. 成果 カバレッジを上げられている 動作確認の手間が大幅に減っている AI が既存実装を壊しても気付ける状態になってきている 仕様がテストコードで表現できるようになってきている テストコードの追加・修正 21
22. 先にリファクタリング これから変更する場所が読みにくい、変更しづらい時に実施 基本 5 分程度、長くても 30 分までに留める テスト不要で安全にできる変更のみ実施 必要に応じて実装後のリファクタリングも実施 Tidy First の実践 22
23. 成果 対応時間が減らせている コード品質が徐々に向上していっている Tidy First の実践 23
24. テストコードの追加・修正 ERB などの React, TS への移行 調査的リファクタリング タスクの合間に改善する 24
25. 重要そうなクラスの仕様化テストを、カバレッジレポートを見ながら追加 処理がどこでどう呼ばれているかを読んで書く 既存のテストのテストケースやコードの修正 偽陰性のテストがあったりするので直すなど テストコードの追加・修正 25
26. 成果 カバレッジを上げられている それ自体を追いかけすぎるのでなく、理解や意識向上のために使うことを意 識 仕様の理解を深められている テストコードの追加・修正 26
27. よく使うファイルを書き換える Cursor などを使ってこまめに動作確認しながら書き換え 始めたばかりで手探り中 移行経験ある方いればアドバイスいただきたいです ERB などの React, TS への移行 27
28. 改善ではなく理解を目的として実施 関数を分割してみたり関数や変数を消してみたりする 理解できたら戻してもいい 調査的リファクタリング 28
29. 成果 複雑に見えても構成がシンプルだと気づけたりする あえてエラーを起こすことで使用箇所が明確になる 使われていないことにも気づけることがある 理解が深められ、いざタスクで対応するときにやりやすくなる 調査的リファクタリング 29
30. タスクとは別に改善したいことリストを作って共有 各々がどういう課題を持っているかを知れて手助けなどしたいのが狙い 勉強会の実施 レガシーコードの改善の仕方や生産性向上ツールの共有など 最近は Raycast を使ってみる会をしました リファクタリングをする会の実施 明らかに改善できる部分を集まって対応し、普段のタスクでもやっていこう という取り組み中 慣れてきたらもっと難しいものをテーマにしたい チームで改善する 30
31. 成果 まだ始めたばかりなのと試行錯誤中ですが、 「チームでやっていこう」の意識を強 め始められています チームで改善する 31
32. 個人＋空き時間でやっているものが多いのと始めたばかりの改善が多いので、継 続して成果を出したい 改善方法をチームに展開し、チームで取り組んでより大きな改善にも取り組みた い 今後やりたいこと 32
33. レガシーコードは小さな改善の積み重ねで着実に良くなる AI 時代だからこそ、テストや CI/CD など当たり前のことを当たり前にやる必要が ある AI を活用しながら理解に時間をかけることが大事 まとめ 33
34. ご清聴ありがとうございました！！ 34