本文へスキップ

失敗談

Seed v1で何を間違えたか:SaaSボイラープレートの過剰設計

公開日:· 1分で読めます·

Seed の機能:デプロイ →

他の言語:العربية、Deutsch、English、Español、Français、Português (Brasil)、Русский、简体中文

鉢植えの小さな苗のまわりに組まれた背の高い紫色の足場と、その隣で大きな植物がひとりでに育つ素朴な鉢。

要点

  • Seed v1(2019〜2022年)はロードマップ66項目のうち33項目を達成。ただしWebクライアント、管理画面、PWA、ファイルアップロードの17項目は一つも完成しませんでした。
  • データベースのテーブルはたった3つなのに、Nxプロジェクトが31、CQRSのメッセージクラスが23、クラウドサービスが9つありました。
  • 過剰設計とは、機能を必要以上に複雑な作りにすることです。機能を作りすぎることではありません。
  • 今のSeedは、一つの型をコピーして機能を端から端まで作り、サーバー1台で動き、v1が計画だけで終えたプロダクト機能をすべて備えています。

Seed v1で何を間違えたのか。過剰設計です。プロダクトより先に、大きなプロダクトのための足場を組んでしまいました。それはv1自身のロードマップに表れています。66項目のうち完了の印がついたのは33項目で、その半分はほとんどが開発ツールとバックエンドの配管でした。モノレポ、厳しいlintルール、pre-commitフック、CQRSの基底クラス、Google Cloudへのデプロイ。残りの半分には、人が実際に使うものがほぼすべて残っていました。グループ、決済、リアルタイム更新、オフライン、ファイルアップロード、管理画面です。

この記事は、自分のSaaSボイラープレートや最初のSaaSを作っていて、「家具を作らずに工房ばかり磨いているのでは」と感じている開発者のためのものです。以下の数字はすべてコードから取りました。v1は今もリポジトリにタグv1-finalとして残っていて、数えるのに使ったコマンドはこの記事を追加したプルリクエストにあります。記憶には頼っていません。数えただけです。

Seed v1とは何だったのか?

READMEの言葉では「full-stack startup monorepo template」で、初日からベストプラクティスを、とうたっていました。フロントエンドはAngular、バックエンドはNest.jsとPrismaとPostgreSQL、ログインはFirebase、実行環境はGoogle Cloud、全体をまとめるのがNx、インストールはYarn。最初のコミットは2019年6月16日、最後は2022年12月23日で、3年半で134コミットです。

少しずつ消えていったのではなく、止まりました。134のうち55コミットは最後の2か月に集中し、その後は何もありません。Seedが新しい履歴で作り直されたのは2026年1月26日です。

ロードマップは何を約束し、何が作られたのか?

READMEのロードマップは、各項目に完了か予定かの印をつけていました。最後の更新は2022年11月25日です。

ロードマップの区分 完了 予定
開発環境とコード構成 8 7
バックエンド 14 5
データベース 3 1
共通フロントエンド(ログイン、状態、テスト) 6 3
スタイル 2 0
PWA(オフライン、プッシュ、インストール) 0 4
ファイルアップロード 0 4
管理画面 0 3
Webクライアント(グループ、リアルタイム、アカウント) 0 6
合計 33 33

Stripeのサブスクリプションはバックエンドの区分で「予定」のままでした。管理画面のユーザー一覧は、ロードマップの最終更新のあと、2022年12月に入りました。これはv1の成果に数えておきます。

33の完了のうち3つは、自動バックアップ、バックアップからの復元、読み取りレプリカでした。どれもGoogle Cloud SQLのドキュメントへのリンクで、インフラの説明書きにはレプリケーションは「not yet used」とありました。Googleがやった宿題に、私が丸をつけていたわけです。

作業はどこへ行ったのか?

工房へ行きました。コミットメッセージには種類が書いてあり、私より正直に経緯を語ってくれます。

  • 134コミットのうち52がenvかenvironment:設定、ツール、CI、アップデート、名前の変更です。featは31でした。
  • 人が何かをできるようになった最初のコミット(登録、自分の情報の取得と更新ができる簡単なユーザーAPI)は38番目で、2021年5月31日。最初のコミットからほぼ2年後です。最初の37コミットのうち28がenvironmentでした。
  • CIは3回作り直しました:2019年7月にGitLab CI、2021年3月にGitHub Actions、2021年6月にGoogle Cloud Build。それでも最後のロードマップでは、CI/CDはまだ「予定」でした。
  • 2021年2月には2日間でアプリとフォルダの名前を4回変更し、その1年後には「massive refactoring」というコミットがあります。

データの少なさに対して、構造はどれだけあったのか?

v1のデータベーススキーマのモデルはUser、UserDevice、Notificationの3つだけです。そのまわりに、次のものがありました。

  • Nxプロジェクトが31:アプリが3つ、E2Eテスト用のアプリが2つ、ライブラリが26。フロントエンドの共通ログインだけでcontainer、guards、state、UIの4ライブラリでした。
  • index.tsが65ファイル。そのうち63個は他のファイルを再エクスポートしているだけです。
  • 独自の基底クラスを持つCQRS層がコマンド、クエリ、イベントのバスの上にあり、コマンド11、クエリ5、イベント7、ハンドラー19。
  • クラウドサービスが9つ(Cloud Run、Cloud SQL、Cloud Tasks、Cloud Logging、Cloud IAM、Firebase Authentication、Hosting、Storage、それにSentry)。セットアップ手順書には「WIP」と書かれ、手作業から始まっていました。
  • npmパッケージが104個。ルートのpackage.jsonにあり、そのうち50個が実行時の依存です。

比べると、今のSeedはテーブル73個に対してworkspaceのパッケージが34個です。構造はデータより先回りせず、データと一緒に育つようになりました。

問題は機能が多すぎたことか?

違います。ここはきちんと分けておきたいところです。過剰設計とは、機能を必要以上に複雑な作りにすることです。余計な層、めったに起きないタイミングへの備え、誰も動かさない自動化。「この機能はいらない」という意味ではありません。v1のやりたいことリスト自体は間違っていませんでした。今のSeedには、v1が計画だけで終えたプロダクト機能がすべてあり、さらにその先もあります。パスキーと二要素認証、ロールと招待のあるグループ、メンバー単位のStripe課金、リアルタイム更新、オフラインで動くアプリ、ファイルストレージ、専用ホストの管理画面、そして日本語を含む9言語です(README)。

しかも今もCQRSを使っています。コマンド、クエリ、イベントはそれぞれのバスを通り、グループの変更はどれもイベントをoutboxに書き込み、それをワーカーが処理します。パターンが悪かったのではありません。グループが一つも存在しないうちに、ログイン用のライブラリを4つも書いたことが悪かったのです。

今のSeedは何を変えたのか?

  • すべての機能に一つの型。 新しい機能は、ノート機能をファイルごとに、決まった順番でコピーして作ります:ノート集約のすべてのファイル。ガイドにははっきり「Do not invent a second shape」(二つ目の型を発明しない)とあります。
  • 9つのサービスではなくサーバー1台。 Docker Composeが、アプリ、Postgres、プロキシ、監視を、あなたが管理するサーバー上で動かします:git cloneからHetznerのサーバー1台で本番運用まで(英語)。
  • 「やらない」と言える原則。 Seedの原則には「Ship small, safe slices」「Avoid speculative complexity」「Add deps only with clear ROI」があります。小さく安全な単位で出す、念のための複雑さは作らない、依存は明らかに元が取れるときだけ足す、という意味です。
  • フレームワークよりWeb標準。 サーバーは特定のプラットフォームの独自APIではなく、Fetch、Web Crypto、WebSocketで話します:SeedがWeb標準の上に作られている理由(英語)。

コミットの種類も変わりました。作り直してからのSeedの531コミットのうち、featが194、chore、ci、buildが合わせて46です。ほとんどはスカッシュマージしたプルリクエストなので、v1のコミットと大きさは同じではありませんが、向きははっきりしています。

あなたのボイラープレートも同じことをしていないか?

v1の数字から引いた、すぐできるチェックを三つ。

  1. フォルダとテーブルを数える。ライブラリがテーブルより多ければ黄色信号です。
  2. ロードマップの「予定」側を読む。ユーザーが触るものが全部そこにあるなら、あなたは工房を作っています。
  3. 人が初めて何かをできるようになったコミットを探す。それが38番目なら、こんにちは、それは私です。

あるいは足場づくりは飛ばしましょう。Seedは無料でMITライセンス、土台はもうできています。クローンして、今週中に最初の機能を出してください(英語)。

次の記事をメールで受け取る

新しい記事が出たときや何かをリリースしたときに、短いメールをお届けします。メールで一度確認するだけで登録でき、購読解除もワンクリックです。

すべての記事