サーバサイドTypeScriptモノレポを半年運用した結果/How to maintain server side typescript monorepo

サーバサイド TypeScript モノレポを半年運用した結果 Kanazawa.js #24 1

@tom-256 SRE/Backend 2

今日話すことモノレポのメリット現状の共有、工夫点課題点まとめ 3

モノレポのメリットコラボレーション... 意識しなくてもコード、PR 、会話が目に入る視認性... プロダクトコードはすべてここにある状態リポジトリ全体のコントール性が高い... 規約、ビルド、作業レバレッジ 4

機能面はGitHub の機能を使うとポリレポでもモノレポと近いメリットが得られる Template Repository( パッケージのテンプレート) GitHub Actions Reusable Workflow(CI
ワークフローの共通化) GitHub Actions Repository Dispatch( リポジトリ間のCI トリガー) npm package による設定ファイルの共通化 5

現状の共有 6

工夫点設定ファイルの共通化 Makefile ESLint コミット規約 CI 7

設定ファイルの共通化 jest tsconfig などディレクトリ構成 packages/config 利用側 "@tom-256/config": "*", 8

Makefile make init-service NAME='foo' アプリケーションディレクトリ作成各種設定ファイル追加要件が増えてきて手作業が出始めるので都度改修が必要 9

ESLint インポートに関する規約(import/no-restricted-paths) API サーバ間の相互依存を禁止共通package は許容アプリケーション設計の規約にも利用ファイル名、ディレクトリ名の規約 10

パフォーマンス調査方法をブログにまとめた ESLint のパフォーマンスを調査する tom-256.log 開発が進むに連れ増えていくのでCI などで定期的に計測して検知する仕組みが必要 11

コミット規約 Conventional Commits を採用 @commitlint/config-lerna-scopes を使用し、コミットメッセージにモノレポのパッケージ名を含めることで、フィルタが可能に 12

例: ディレクトリ構成 packages ├── hoge └── fuga コミットメッセージ feat(hoge): hogefuga
hogefuga 13

CI docker/build-push-action とmatrix strategy により動的なCI 構築変更があったパッケージのみCI 実施パッケージが増えてもCI 時間が増加しないように
unit test... キャッシュ未導入、テスト用パッケージが重い問題 docker build...multistage build,gha cache 14

actions/labeler でパッケージごとのラベルを作成 amannn/action-semantic-pull-request でPR タイトルを統一 ArtiomTr/jest-coverage-report-action でテストカバレッジ表示 15

課題点 Dockerfile コードジェネレーター Renovate フレームワーク可視化 16

Dockerfile 共通のイメージを使いたいという要件から現状1 つのDockerfile コンテキストを小さく保つためDockerfile を分割したい COPY 対象パイプラインのトリガー 17

. ├── Dockerfile └── apps ├── foo └── bar └──
apps ├── foo │ └── Dockerfile └── bar └── Dockerfile 18

コードジェネレーター要件が増えてきて手作業が出始めるので都度改修が必要パッケージの設定ファイルが各所に散らばってしまう 19

Renovate パッケージ更新を自動化 CODEOWNERS グルーピング 20

フレームワークフレームワークに依存するのを避けるため導入しなかったが結局必要な要件が出てきた初期構築コストが無駄になってしまった TypeScript に統一...Turborepo 多言語も考慮...Nx 21

可視化変化があったら知りたい実行時間 test lint build docker build npm ci
Docker イメージサイズ 22

開発体制開発体制はフィーチャーチーム DX 面にオーナーシップを持つメンバーが固定化ローカル開発環境 Test 、Lint 、Build ライブラリバージョンアップ CI
23

まとめ現状簡単に同じ設定のアプリケーションをセットアップできる TypeScript は初期構築コストが高い開発に関する規約を設定アプリケーションが増えてもCI の時間が増えないように実装 24

感想 ESLint やCommit Hook で規約を作りやすい Developer Experience 、CI 面の負債をまとめて返しやすい自分が触っていないコードが目に入りやすい
25

サーバサイドTypeScriptモノレポを半年運用した結果/How to maintain s...

サーバサイドTypeScriptモノレポを半年運用した結果/How to maintain server side typescript monorepo

tom-256

More Decks by tom-256

Other Decks in Programming

Featured

Transcript