🦑

tRPCを導入したら爆速でWebサービスをリリースできた話

sushidesu2022/12/08に公開

この記事は 「個人開発Advent Calendar 2022」 8日目の記事です。

はじめに

https://twitter.com/splarate/status/1592819779882156032?s=20&t=vPwLumuT_MAqBtK43JMWjA

先日リリースされた、SplarateというWebサービスの開発をお手伝いしています。そこで導入したtRPCが驚くほど便利だったので、実際の体験を交えてその使いやすさを紹介します。

tRPCとは?

tRPC allows you to easily build & consume fully typesafe APIs without schemas or code generation.

https://trpc.io/docs/

tRPCは、スキーマやコード生成なしで型安全なAPIを簡単に構築し、呼び出すことのできるライブラリです。

tRPC is for full-stack TypeScript developers. と謳われているように、TypeScriptに特化して作られており、TypeScript環境であれば大きな導入の手間なく使えるようになっています。

なぜ導入したのか

Splarateは2人体制での開発でした。元々、バックエンドをGo言語で書こうとしていたこともあり、REST + APIスキーマの共有のために言語を問わず使用できるOpenAPIを導入していました。しかし、以下のような問題がありました。

  • スキーマを書くのが大変
  • スキーマを書くのが大変
  • スキーマが守られている保証がない (これについては、使い方が間違っていたと思います)
  • スキーマを書くのが大変

どの問題もOpenAPIに慣れていない、使い方が間違っているということに起因するものであり、OpenAPIは正しく使用すればとても良い技術です。しかしOpenAPIは正しく使用できるような環境を整えるための手間が多く、2人体制の個人開発にはオーバースペックだと感じました。現状の、「なんちゃってOpenAPI」では、スキーマと実装が乖離しているのではないか?という不安が常にあり、安心して開発できない状態でした。

そんなとき、ちょうどtRPCが話題になっており、直感的にtRPCは今抱えている問題を解決してくれそうだと感じました。すでにRESTでいくつかのAPIを開発していましたがそれを一旦止め、tRPCを導入してフルTypeScriptで書き換える方向に舵を切ることにしました。(本音: かっこよさそうだったので使ってみたかった)

9/12にsushiが「tRPCを使います」と発言しているチャットのスクリーンショット
決意の瞬間

はじめの導入こそつまずきましたが、とてもTypeScriptと相性がよく、TypeScriptに慣れている筆者としてはかなり直感的に使うことができました。APIとクライアントのつなぎこみやリクエストのバリデーションにかかる労力が最小限になり、重要な機能の開発に注力できたため、無事リリースまでたどり着くことができました。導入してよかったです。

よかったところ

たくさんあるのですが、実際に使用して特にによかった感じるところを3つ紹介します。

型安全性 (zodによるバリデーション)

これが一番大きいです。サーバーのコードを書くと、コード生成などのステップを挟むことなくリクエスト/レスポンスの型定義、クライアントのコードにまで型推論が行われます。クライアントとサーバーの間で型を直接共有できるので、「スムーズに実装できて快適/型情報が信頼できるので安心」です。

リクエストの定義にzod[1]を使用することも、とても体験が良いです。zodはTypeScriptによるスキーマの定義と、それをもとにバリデーションができるライブラリなのですが、tRPCではそのスキーマを使用してリクエストを定義します。型が一致しているかはもちろん、詳細なバリデーションもスキーマファーストで行えるため、バリデーションを忘れていないか?変な値がリクエストされてないか?と不安にならずにすみます。

とにかくわかりやすく、書きやすかったです。

trpc
  .router()
  .query("hello", {
    input: z.object({
      name: z.string().min(1).max(30),
    }),
    resolve: async ({ input }) => {
      // `input.name` は 1文字以上30文字以内のstring であることが保証されている!
      return `hello: ${input.name} !!`
    }
  })

シリアライズ/デシリアライズ

一般的に、多くのWeb APIからのレスポンスはJSONで返されることが多いですが、JSONは DateMap などのJavaScriptの組み込みオブジェクトや、 undefined を使用することができません。しかしtRPCはそのような値をシリアライズするためのData Transformersという機能があるので、その設定さえしてしまえば特に意識することなく Dateundefined も使用できます。

個人的には、コード内に nullundefined が混在していると辛いため undefined に寄せたいと考えており、それを簡単に行えるのはとてもありがたかったです。

インクリメンタルな開発

少人数で行う個人開発では、先にある程度スキーマを固めてから機能を開発するより、機能ごとに少しずつ開発していく方がやりやすかったです。

スキーマ駆動開発の、事前にインターフェースを決めて合意するみたいなフェーズは少人数の個人開発だとかなり無駄が多いと感じました。共有相手が1人しかいないので、事後報告でここ変えといたよ!と伝えれば良いだけなんですよね。

開発者の人数が2人と少ないことに加え、お互いがフロントエンド/バックエンドの両方を書くのもあって、1機能をフロントエンド/バックエンドまとめて1人で実装する方が、実装待ちで手持ち無沙汰になったり、手戻りになることも少なく、効率が良かったと感じています。

工夫したところ

tRPCとNext.jsを組み合わせるにあたって、困ったことや工夫したことをいくつか紹介します。

SWRと組み合わせる

データ取得にSWRを使用したかったので、 tRPCとnext.jsの組み合わせで、withTRPCを使うほどでもない時のライトに使う方法 の記事を参考に、tRPCのクライアントにはVanilla clientを採用しました。

最小限の設定で済むのと、普段通りのSWRの使い方ができるためこれで十分だなあという感想です。

key生成を関数に切り出す

これは余談なのですが、SWRでただデータを取得したいだけのときは、 useSWR をラップした関数を作らずに key の生成部分のみを関数に切り出して使用するのが良いかな〜と思っています。

SWRのキャッシュの単位は key であり、データ取得を行わないページで key を指定してキャッシュを更新したい、などのユースケースも考慮すると最小単位は key なのではないかという考えです。それと、 useSWR をラップした関数をあまり作りたくないんですよね。 useSWR がせっかく error だったり isValidatingmutate (KeyedMutator) を返してくれているでそのまま使いたい。

このあたり、やっている方がいたら意見を聞いてみたいです。

// keyGenerator.ts
export type KeyGenerator<T extends string, U = undefined> = U extends undefined
  ? () => { key: T }
  : (query: U) => { key: T } & U


// getUserKey.ts
type GetUserQuery = {
  userId: string
}

const getUserKey: KeyGenerator<"getUser", GetUserQuery> = (query) => ({
  key: "getUser",
  userId: query.userId,
})

// App.tsx
const App = (): JSX.Element => {
  const userId = "user_01"
  const user = useSWR(getUserKey({ userId }), ({ userId }) =>
    trpc.query("usersGet", { userId })
  )
  return (
    <div>
      {user.error && <p>{user.error}</p>}
      <p>{user.data.name}</p>
    </div>
  )
}

型情報の共有のしすぎに注意

tRPCではクライアントから簡単にバックエンドのコードを呼び出すことができるのですが、それがあまりにも簡単すぎるため注意が必要です。サーバーのコードで return したデータがそのままレスポンスの型になり、クライアントに返ってくるため、知らないうちにクライアントに見せてはいけない機密情報などがレスポンスに含まれてしまう可能性があります。

Splarateでは、サーバーとやり取りする用のモデルの型を置くための dto/[2] ディレクトリを切り出して、サーバーから返す値はそれを守るようにしてみました。お手軽で良かったです。

おわりに

手戻りも発生するため、かなり迷った結果のtRPCの導入だったのですが、本当に導入してよかったな〜と思います。かなり直感的に使用でき、開発も爆速になるのでぜひ使ってみてください。そしてSplarateの方もよろしくお願いします。

最後に、 ChatGPT が考えてくれたtRPCのアスキーアートを紹介して終わります。ありがとうございました。

chatGPTに「アスキーアートでtRPCを書いてください」と質問した結果のスクリーンショット。耳のある動物っぽいものがAAで描かれている。
かわいいですね

脚注
  1. zodに限らず、yup、superstructなども使用可能です。 (https://trpc.io/docs/procedures#input-validation) ↩︎ ↩︎

  2. DTO(Data Transfer Object) から取りました。データ参照用のオブジェクト、くらいの意味で使用しています。 ↩︎

GitHubで編集を提案
プラハのブログ

株式会社プラハでは自社サービス「アガルートアカデミー」の開発、自社サービス「PrAha Challenge」の運営、スタートアップに特化したデザインと受託開発を行なっています。一緒に働いてくれる方を血眼になって探しています。

Discussion

ログインするとコメントできます