GraphQLサーバの構成要素を整理する #ハッカー鮨 #tsukijigraphql / graphql server technology selection

Transcript

1. tsukiji.graphql GraphQLサーバの構成要素を整理する 2024-04-18 @izumin5210 Photo by Zaini Izzuddin on Unsplash

2. @izumin5210 ▶ バックエンドや Web フロントエンドを書きます - Go, TypeScript, React, GraphQL,

   Protobuf, Connect, … ▶ API スキーマが好き ▶ ISUCON に出るのが得意 ▶ eddeee888/gcg-typescript-resolver-files と github.com/99designs/gqlgen が好き LayerX, ex-Wantedly

3. GraphQL Server、 何で作ってますか？ …って聞かれたら、なにを答えますか？ ※ Node.js での例が中心となりますが、他の言語でも通じる話をします。多分。

4. GraphQL サーバ、何で作ってますか？ ▶ TypeScript, Go, Ruby, … ▶ NestJS, Apollo

   Server, gqlgen, … ▶ graphql-yoga, graphql-ruby, … ▶ スキーマファースト, コードファースト ▶ … GraphQL Server を構成する技術にもいろいろある

5. そもそも「GraphQL サーバを実装する」とは ▶ GraphQL の仕様はトランスポート層に依存しない - HTTP の上で GraphQL を扱う仕様は

   GraphQL over HTTP - 仕様としてはまだ Draft だが、大体の実装がこれに従っているはず ▶ なので、技術選定としてもいくつかのレイヤに分けて考えることができる - 「HTTP リクエストを受けていい感じの処理を挟みつつ GraphQL に橋渡 しをする実装」 - 「GraphQL クエリ（Operation）を受けて結果を吐き出す実装」 - …

6. GraphQL サーバの構成要素をレイヤに分けてみた ※ @izumin5210 が独自に分類・命名したものです。 一般的な定義が存在していたら教えてください。

7. ▶ Schema Definition - Code-First か Schema-First か - GraphQL

   スキーマを定義するのがどういう開発者かな どで、相性がいい方法が変わる ▶ Resolver - スキーマ定義手法によって Resolver 実装手法は概ね定 まる - スキーマ上の型と TypeScript 上の型がちゃんと整合す るかも重要ポイント

8. ▶ Dependency Container - graphql-js の contextValue が実質 Dependency container

   として機能する - 独自の DI 機構を持つ場合もある ▶ Execution Engine - JavaScript では基本的に graphql-js が利用される - スキーマ定義・resolver 実装・Context から GraphQLSchema インスタンスを作り、それもとにクエリ を実行する というのがどのライブラリでも共通

9. ▶ Execution Middlwware - Persisted Query など、GraphQL の仕様の外側での 追加処理 -

   Envelop は Babel 的にパーサ等の挙動を上書きする ことも可能 ▶ Transport Adapter - Transport (HTTP Server) と GraphQLSchema の 橋渡し ▶ Transport - HTTP server

10. この構造を理解しておくことで… ▶ 適切な技術選定の助けになるかも - e.g. いま Apollo Server は必要なのか -

    e.g. 僕らのアーキテクチャに NestJS は適してるのか ▶ より良いアーキテクチャを見つける助けになるかも - e.g. GraphQLSchema が処理の本体ってことは、 これを React Server Component から呼べる…？ ここでは Node.js について取り上げたが、 他の言語でも似たような分類はできるはず。たぶん。

11. 他にも GraphQL サーバ技術選定時に考えること ▶ BFF ▶ Gateway ▶ 普通にドメインロジックめっちゃ持ってるサーバ アーキテクチャ上の立ち位置は？

12. 他にも GraphQL サーバ技術選定時に考えること ▶ 誰が・どうやってスキーマを定義する？ - 特定の言語に縛られないほうが、みんなに開かれたスキーマになる（かも） - プログラムでスキーマにメタ情報を仕込めると便利（かも） -

    どういうグラフを目指すのか ▶ 安全に resolver を実装できる？ - スキーマと実装の型がズレないか 開発フローは？

13. 他にも GraphQL サーバ技術選定時に考えること ▶ （そもそも GraphQL が適するか？） ▶ … 技術選定に影響を与える要素はたくさんある。

    「なぜそれなのか」に答えられるようにしておく。

14. おまけ: @izumin5210 は何を選ぶ？ ▶ Go なら gqlgen - Schema-First +

    超優秀な scaffolding ▶ Node.js なら - The Guid スタックに乗りたいので、graphql-yoga - 最近は graphql-codegen の Server Preset がいい感じ - JS にも gqlgen に負けない scaffolding が来た！？ - Transport はよしなに - プロダクト立ち上げタイミングなら Next.js から配信もアリ （アーキテクチャ・言語は適切に検討したうえで…）

15. みなさんの最強の GraphQL サーバ技術選定を教えてください