GraphQL Schema Design Principles adopted by NEWT

Agenda:

1) NEWT Stack
2) One Graph
3) Demand Oriented Schema Design

Transcript

1. © 2023 Reiwa Travel, Inc.
 NEWT + GraphQL GraphQL Schema Design Principles adopted by NEWT
2. © 2023 Reiwa Travel, Inc.
 Profile • Nationality: Argentinian • Language: Spanish, English, Japanese • Full Stack Developer (+10y) Career • 󰎆 2006~: Freelance • 󰎆 2008~: PowerSite ( CEO/CTO ) ◦ Email Marketing SaaS • 󰏦 2015~: Travelience ( CTO ) ◦ Tour Guide Marketplace • 󰏦 2021~: ReiwaTravel ( Senior Engineer ) ◦ Backend → Frontend → Backend Senior Engineer / Product-Dev Rodrigo Ramirez
3. © 2023 Reiwa Travel, Inc.
 NEWT + GraphQL GraphQL Schema Design Principles adopted by NEWT
4. AGENDA
 © 2023 Reiwa Travel, Inc.
 1. NEWT Stack 2. One Graph 3. Demand Oriented Schema Design
5. © 2023 Reiwa Travel, Inc.
 NEWT Stack
6. © 2023 Reiwa Travel, Inc.
 NEWT Stack
7. © 2023 Reiwa Travel, Inc.
 NEWT Stack
8. © 2023 Reiwa Travel, Inc.
 NEWT Stack
9. © 2023 Reiwa Travel, Inc.
 NEWT Stack
10. © 2023 Reiwa Travel, Inc.
 NEWT Stack
11. © 2023 Reiwa Travel, Inc.
 NEWT Stack
12. © 2023 Reiwa Travel, Inc.
 NEWT Stack
13. © 2023 Reiwa Travel, Inc.
 NEWT Stack NEWT + GraphQL
14. © 2023 Reiwa Travel, Inc.
 NEWT + GraphQL NEWT Stack
15. © 2023 Reiwa Travel, Inc.
 NEWT + GraphQL NEWT Stack
16. © 2023 Reiwa Travel, Inc.
 NEWT + GraphQL NEWT Stack
17. © 2023 Reiwa Travel, Inc.
 NEWT + GraphQL NEWT Stack
18. © 2023 Reiwa Travel, Inc.
 One Graph
19. © 2023 Reiwa Travel, Inc.
 One Graph • Single Endpoint • Central Data Catalog • Portability Across Teams • Unified Access Control
20. © 2023 Reiwa Travel, Inc.
 One Graph Extending the Graph Apollo Federation, Schema Stitching, Schema Merging, …
21. © 2023 Reiwa Travel, Inc.
 One Graph Extending the Graph Apollo Federation, Schema Stitching, Schema Merging, …
22. © 2023 Reiwa Travel, Inc.
 One Graph Apollo Federation, Schema Stitching, Schema Merging, … Extending the Graph
23. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
24. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Key Points: ① Design Schema around client-specific use cases ② Move business logic to the Backend ③ Close collaboration with Client side engineers Benefits: • Simplified Schema • Reduce Over-fetching • Improved Developer Experience • Easier to Understand and Maintain • Reduce QA cost
25. © 2023 Reiwa Travel, Inc.
 ① Design Schema around client-specific use cases Demand Oriented Schema Design
26. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
27. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
28. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
29. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
30. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
31. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
32. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
33. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
34. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
35. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
36. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
37. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design
38. © 2023 Reiwa Travel, Inc.
 ② Move Business Logic to the Backend Demand Oriented Schema Design
39. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card
40. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Spoken Languages
41. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Spoken Languages
42. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design • Logic needs to be handled on each client (Web, iOS, Android) • More data than needed is requested from the API • QA cost increase to confirm implementation on each client Hotel Card / Spoken Languages
43. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Spoken Languages
44. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Spoken Languages
45. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design • Logic is hidden on the backend • Client implementation is simplified • API tests can be written to confirm use cases • QA cost decrease Hotel Card / Spoken Languages
46. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Spoken Languages
47. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card
48. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Price
49. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Price
50. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design • The client depend on 2 fields to display the price • The format needed to be coordinated between clients and places • QA cost increase Hotel Card / Price
51. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Price
52. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Price
53. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design • Only one field is needed to display the price • The format is controlled by the Backend, and consistency between apps is simple • QA cost decrease Hotel Card / Price
54. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Price
55. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card
56. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Wishlist
57. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Wishlist
58. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design • To know if a Hotel is included inside the authenticated user Wishlist, a different query is needed • The client needs to control the logic • QA cost increase • … Hotel Card / Wishlist
59. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Wishlist
60. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Wishlist
61. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design • Things that always need to be displayed together are together • Client logic is simplified, and business logic is hidden on the backend • QA cost decreases • … Hotel Card / Wishlist
62. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Hotel Card / Wishlist
63. © 2023 Reiwa Travel, Inc.
 ③ Close collaboration with Client side engineers Demand Oriented Schema Design
64. © 2023 Reiwa Travel, Inc.
 Demand Oriented Schema Design Close collaboration with Client side engineers • Prioritize client needs, but not just one client's needs • Client teams should be consulted early on in the API design process. • Schema should be approved by client teams before implementation Spec Check Schema Proposal Mock Implementation Final Implementation Backend + Client engineers involved in all process
65. © 2023 Reiwa Travel, Inc.
 1) One Graph: • 1 schema / 1 endpoint 2) Demand Oriented Schema Design: • Schema Design based on Client use cases • Reduce client-side complexity by moving Business Logic to the backend • Close collaboration with Client side engineers Summary
66. Thank you!
 © 2023 Reiwa Travel, Inc.
 @xpromx engineering.reiwatravel.co.jp