テーブル定義変更のレビューを効率化するための仕組み作り / DBRE Summit 2023

DBRE Summit 2023で紹介した登壇資料です。
https://kinto-technologies.connpass.com/event/292402/

1. Copyright © 2020 Present ANDPAD Inc. This information is confidential and was prepared by ANDPAD Inc. for the use of our client. It is not to be relied on by and 3rd party. Proprietary & Confidential 無断転載・無断複製の禁止 2023.08.24 @DBRE Summit2023 ふくま（@fkm_y）/ 株式会社アンドパッド テーブル定義変更のレビューを 効率化するための仕組み作り
2. ANDPAD Inc. DBRE Who I am @fkm_y @fkmy Yuki Fukuma 好きな車種：アクア
3. Copyright © 2020 Present ANDPAD Inc. This information is confidential and was prepared by ANDPAD Inc. for the use of our client. It is not to be relied on by and 3rd party. 無断転載・無断複製の禁止 3 「建築・建設業に特化したクラウドサービス」 ANDPADは、現場の効率化から経営改善まで 一元管理できるシェアNo.1※クラウド型建設 プロジェクト管理サービスです。 ※「クラウド型施工管理サービスの市場動向とベンダーシェア （ミックITリポート2021年10月号）」（デロイト トーマツ ミック経済研究所調べ） 事業概要
4. 今日話すこと DBREとして 開発者の開発効率を最大化させるために テーブル定義変更のレビューへ焦点を当て仕組み化したこと を話します
5. • はじめに • 導線作成の自動化 • テーブル定義レビューの自動化 • まとめ アジェンダ
6. はじめに Copyright © 2020 Present ANDPAD Inc. This information is confidential and was prepared by ANDPAD Inc. for the use of our client. It is not to be relied on by and 3rd party. Proprietary & Confidential 無断転載・無断複製の禁止
7. 背景 プロダクトチームがテーブル定義変更をする場合、 DBREがレビューする運用 Product Team DBRE Team Pull Request
8. 課題 • DBREの工数の3割くらいがレビューで取られている • 全てのプロダクトのレビューはできていない • プロダクトはこれからも増えていく スケール可能なレビュー効率化の 仕組みを作ることが必要
9. 調査 DBREから開発者へのレビューコメントを分類すると… • データベース利用規約に記載されていないもの • データベース利用規約に記載されているもの ◦ かつ 機械的なチェックが難しそうなもの ◦ かつ 機械的にチェックできるもの
10. 進め方 DBREから開発者へのレビューコメントを分類すると… • データベース利用規約に記載されていないもの • データベース利用規約に記載されているもの ◦ かつ 機械的なチェックが難しそうなもの ◦ かつ 機械的にチェックできるもの 小さくリリースして早期に成果を得ながら進めたかったため 段階的に対応することにした ① ②
11. 導線作成の自動化 Copyright © 2020 Present ANDPAD Inc. This information is confidential and was prepared by ANDPAD Inc. for the use of our client. It is not to be relied on by and 3rd party. Proprietary & Confidential 無断転載・無断複製の禁止
12. DBREから開発者へのレビューコメントを分類すると… • データベース利用規約に記載されていないもの • データベース利用規約に記載されているもの ◦ かつ 機械的なチェックが難しそうなもの ◦ かつ 機械的にチェックできるもの 導線作成の自動化
13. 前提 データベース利用規約は既に作成されていましたが、 あまり読まれていないと感じていました 仮説 必要になるまで読まないし存在を忘れるので見られない 必要なタイミングで表示される導線を作る 導線作成の自動化
14. 開発者 PR作成 テーブル定義が変更されたらPRへコメント 導線作成の自動化
15. DBREから開発者へのレビューコメントを分類すると… • データベース利用規約に記載されていないもの • データベース利用規約に記載されているもの ◦ かつ 機械的なチェックが難しそうなもの ◦ かつ 機械的にチェックできるもの 既存資源への導線を作るコストのみで指摘頻度が減少した 導線作成の自動化
16. テーブル定義レビューの自動化 Copyright © 2020 Present ANDPAD Inc. This information is confidential and was prepared by ANDPAD Inc. for the use of our client. It is not to be relied on by and 3rd party. Proprietary & Confidential 無断転載・無断複製の禁止
17. DBREから開発者へのレビューコメントを分類すると… • データベース利用規約に記載されていないもの • データベース利用規約に記載されているもの ◦ かつ 機械的なチェックが難しそうなもの ◦ かつ 機械的にチェックできるもの テーブル定義レビューの自動化
18. DBREから開発者へのレビューコメントを分類すると… • データベース利用規約に記載されていないもの • データベース利用規約に記載されているもの ◦ かつ 機械的なチェックが難しそうなもの ◦ かつ 機械的にチェックできるもの 機械的にチェックできるなら機械に任せて自動化 テーブル定義レビューの自動化
19. PR作成 reviewdogとsemgrepを使った仕組み 開発者 テーブル定義を静的解析してPRへコメント
20. reviewdogとは？ 各種Linter解析の検出結果をGitHubなどのコードホスティングサービス へレビューコメントとして投稿してくれるツール https://github.com/reviewdog/reviewdog
21. semgrepとは？ 脆弱性の静的解析や、コード標準の適用などに使われる静的解析ツール 様々な言語に対応しており、構文木をベースに置換や検索ができ独自の ルールを作ることができます。 https://github.com/returntocorp/semgrep
22. PR作成 Semgrepへカスタムルールを追加 reviewdogとsemgrepを使った仕組み 開発者 テーブル定義を静的解析してPRへコメント
23. PR作成 reviewdogとsemgrepを使った仕組み 開発者 テーブル定義を静的解析してPRへコメント
24. 開発者 PR作成 reviewdogとsemgrepを使った仕組み テーブル定義を静的解析してPRへコメント
25. RubyにはRuboCopという静的解析ツールがあります 少し複雑な条件を解析できないか試してみました
26. RuboCopを使ったケース 開発者 PR作成 ローカル か CI にてテーブル定義を静的解析 冗長なインデックスであることを警告 静的解析 Rubocopへカスタムルールを追加
27. DBREから開発者へのレビューコメントを分類すると… • データベース利用規約に記載されていないもの • データベース利用規約に記載されているもの ◦ かつ 機械的なチェックが難しそうなもの ◦ かつ 機械的にチェックできるもの 自動化したものへ指摘することがなくなった テーブル定義レビューの自動化
28. まとめ Copyright © 2020 Present ANDPAD Inc. This information is confidential and was prepared by ANDPAD Inc. for the use of our client. It is not to be relied on by and 3rd party. Proprietary & Confidential 無断転載・無断複製の禁止
29. • 導線の設計次第で開発者のドキュメント利用率を向上できる • SemgrepやRuboCopのカスタムルールを書くことで DBのLinterとしても活用できる • スケールできる仕組みを作ったのでレビュー効率化だけでなく レビュー出来ていなかったプロダクトにも横展開できた まとめ DBREとしてテーブル定義レビューの自動化ができました
30. ご清聴ありがとうございました！ Copyright © 2020 Present ANDPAD Inc. This information is confidential and was prepared by ANDPAD Inc. for the use of our client. It is not to be relied on by and 3rd party. Proprietary & Confidential 無断転載・無断複製の禁止