GraphQL Hive Workshop

Transcript

1. GraphQL Hive Workshop Laurin Quast Safely Evolve your Federated GraphQL Schema @n1rual Tuesday, Sep 19 2023 @n1ru4l Kamil Kisiela @kamilkisiela @kamilkisiela
2. 1. (Intro) Evolving GraphQL can be Hard 2. Schema Registry 3. Breaking Change Detection 4. Usage Reporting 5. Conditional Breaking Changes 6. Q&A Workshop Agenda
3. Workshop Material https://github.com/n1ru4l/hive-workshop
4. Evolving GraphQL Can Be Hard
5. A Single Pull Request GraphQL can be easy The simple Setup Update GraphQL Schema Update GraphQL Operations Deploy • Rolling out changes is simple • Breaking clients does not happen (?)
6. Internal External GraphQL can be hard The Complex Setup • Many teams/products/developers • GraphQL API and Client(s) owned by different Teams • Code is spread across different repositories or even companies GraphQL Client GraphQL Client GraphQL Client GraphQL API GraphQL Client
7. Breaking Changes 💣
8. Laurin lives in undefined.
9. {user.name} lives in {user.hometown}
10. REST Style API Breaking Change Deploy
11. GraphQL Schema and Operations
12. Schema Change: Example 1
13. Schema Change: Example 2
14. Schema Change: Example 3
15. Schema Change: Example 4
18. Schema Changes Are Dangerous And Can Break Clients
19. Git Workflow Develop Iterate on code according to CI feedback CI (GitHub Action) CD (GitHub Action) Check if code works Deploy code to production
20. Git Workflow Develop iterate on code according to CI feedback CI (GitHub Action) CD (GitHub Action) • Validate Schema • Detect Breaking Changes • Report CI Status GraphQL Inspector
21. Federated / Composite Schemas The Complex Setup • Composition should not fail in production (Gateway must be reliable) • Schema changes should be trackable • Subgraphs might not be within the same Git Repository GraphQL API GraphQL API GraphQL API Supergraph GraphQL API
22. Schema Registry
23. Schema Registry • Centralised repository for managing and validating GraphQL schemas • Validate and subgraph schemas • Schema history (Version control for GraphQL) • Categorisation of schema changes (breaking, safe, conditional breaking)
24. Workflow Develop iterate on code according to CI feedback CI (GitHub Action) CD (GitHub Action) GraphQL Hive Schema Registry GraphQL Hive Schema Registry • Verify schema integrity • Compose Supergraph (if needed) • Detect breaking changes • Report CI status • Persist schema history • Write supergraph to CDN (if needed)
25. Git Workflow Develop iterate on code according to CI feedback CI (GitHub Action) CD (GitHub Action) GraphQL Hive Schema Registry GraphQL Hive Schema Registry • Verify schema integrity • Compose Supergraph • Detect breaking changes • Report CI status • Persist schema history • Write supergraph to CDN
26. Git Workflow Develop iterate on code according to CI feedback CI (GitHub Action) CD (GitHub Action) GraphQL Hive Schema Registry GraphQL Hive Schema Registry • Verify schema integrity • Compose Supergraph • Detect breaking changes • Report CI status • Persist schema history • Write supergraph to CDN
27. GitHub Workflow Develop iterate on code according to CI feedback hive check • verify schema integrity • no breaking changes • enforce best practices hive publish • publish new schema • inform gateways • inform consumers CI (GitHub Action) CD (GitHub Action) GraphQL Hive Schema Registry GraphQL Hive Schema Registry
28. GitHub Workflow Develop iterate on code according to CI feedback hive check • verify schema integrity • no breaking changes • enforce best practices hive publish • publish new schema • inform gateways • inform consumers CI (GitHub Action) CD (GitHub Action) GraphQL Hive Schema Registry GraphQL Hive Schema Registry
29. Git Workflow Develop iterate on code according to CI feedback hive check • verify schema integrity • no breaking changes • enforce best practices hive publish • publish new schema • inform gateways • inform consumers CI (GitHub Action) CD (GitHub Action) GraphQL Hive Schema Registry GraphQL Hive Schema Registry
38. Deployment Flow Continious Deployment GraphQL Hive Schema Registry GraphQL Gateway Apollo Router Poll super graph from registry Deploy Subgraph Subgraph 1 Subgraph 2 Subgraph 3 Publish subgraph schema to registry Query subgraphs
39. Usage Reporting
43. Usage Reporting SDK GraphQL API Hive SDK • JavaScript • Ruby • Java • Custom GraphQL Hive Report schema usage
44. Usage Reporting SDK GraphQL API Hive SDK • JavaScript • Ruby • Java • Custom GraphQL Hive Report schema usage
45. Apollo Router Apollo Router Hive Apollo Router Plugin GraphQL Hive Report schema usage
46. Conditional Breaking Changes
47. Conditional Breaking Changes • Mark breaking changes as safe changes based on schema usage • If a fi eld is not used for N days, it is safe to remove it
49. Other Features • SSO (Okta, Auth0, etc.) built-in • All Cloud Features are available on Self-Hosted
50. Q&A Laurin Quast @n1rual @n1ru4l Kamil Kisiela @kamilkisiela @kamilkisiela Workshop Material https://github.com/n1ru4l/hive-workshop