代数的データ型を活用したGraphQLスキーマの設計

【3/24＠オンライン開催】エイチーム×レバレジーズ フロントエンド勉強会
https://ateam.connpass.com/event/276968/

での発表資料

# 技術

GraphQL, TypeScript, ADT, 代数的データ型, Union type, Apollo Client, エラーハンドリング

Transcript

1. 代数的データ型を活用した GraphQLスキーマの設計 レバレジーズ株式会社　野中柊 2023/03/21
2. GraphQLのエラーハンドリングでつらいところ
3. HTTPステータスコードが200 OKで返される
4. エラーがすべてerrors内に格納される
5. Requiredなフィールドでもエラーとなると nullで渡ってくる
6. クライアントライブラリによって挙動が違う
7. ApolloClient - ApolloErrorにラップされる - クエリに含まれるフィールドの一部がエラーを 起こすとクエリ全体が失敗する - errorPolicyで変更可能 https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies
8. Relay エラーにアクセスできない！ 公式がエラーにアクセスしたかったらフィールドの結 果にエラーを含めろと言及している https://relay.dev/docs/guided-tour/rendering/error-states/#accessing-errors-in-graphql-responses
9. urql - CombinedErrorにラップされる - ApolloErrorと同じような構造 - クエリに含まれるフィールドの一部がエラーを 起こしてもそれ以外のフィールドは値にアクセ スできる https://formidable.com/open-source/urql/docs/basics/errors/
10. スキーマからどんなエラーが 返されるのかが読み取れない
11. スキーマからどんなエラーが返されるのかが読み取れない - このスキーマで返されうるエラーは？
12. スキーマからどんなエラーが返されるのかが読み取れない - このスキーマで返されうるエラーは？ - ValidationFailed - EmailDuplicated - PasswordNotConfirmed
13. スキーマからどんなエラーが返されるのかが読み取れない - このスキーマで返されうるエラーは？ - ValidationFailed - EmailDuplicated - PasswordNotConfirmed 返されそうなだけで本当に返されるかは分からない （重複OKなシステムかもしれない）
14. 実装を自分の目で確かめるしかない
15. それ以外にも...
16. DatabaseConnectionClosed ConnectionTimeout SQLError OutOfMemory
17. じゃあどうするか？
18. 代数的データ型を活用して スキーマの表現力を強化しよう！
19. 代数的データ型とは？
20. 代数的データ型とは？ - データ型の一種で、既存のデータ型を組み合わせて新しいデータ型を定義する ための機能 - 大きく分けて直和型（sum type）と直積型（product type）からなる
24. DatabaseConnectionClosed ConnectionTimeout SQLError OutOfMemory
25. ハンドリングすべきアプリケーションエラーとシス テムエラーを区別する
26. - このスキーマで返されうるエラーは？ - ValidationFailed - EmailDuplicated - PasswordNotConfirmed ハンドリングすべきエラーを区別する → アプリケーションエラー。 ハンドリングしてユーザーに適切な アクションをとってもらうべき
27. DatabaseConnectionClosed ConnectionTimeout SQLError OutOfMemory →システムエラー。ユーザーにはどうしようもない
28. ハンドリングすべきアプリケーションエラーを スキーマで表現する
30. 型生成ライブラリを使うと__typenameを タグとしたタグ付きユニオン型が生成されるので 網羅性チェックがしやすくなる →実行時エラーを減らせる
32. __typenameはGraphQL specificationで 定義された標準のメタフィールドなので 依存しても問題無い
33. 是非快適なスキーマ設計を！
34. 参考文献 - Production Ready GraphQL - https://book.productionreadygraphql.com/ - GraphQL Specification - https://spec.graphql.org/June2018/ - GraphQLスキーマ設計の勘所 - https://speakerdeck.com/yukukotani/graphql-schema-design-practice