Digging In To The Apollo iOS SDK - GraphQL Summit, San Francisco, October 2019

Learn about the what and why of recent updates to ApolloGraphQL’s Swift iOS SDK, including updates to code generation, get a few concepts on the iOS side more clearly explained, and learn about where we're going with the iOS SDK!

(Will link to video as soon as it's up!)

Transcript

1. ⚒ Digging in to the Apollo iOS SDK GraphQL Summit | San Francisco, CA | October 2019 by Ellen Shapiro | @DesignatedNerd | apollographql.com
2. !
3. !
4. !
5. !
6. !
7. !
8. !
9. ! "
10. !
11. !
13. ! ☠
14. ⚒
17. May 1, 2019
19. !
21. !
24. October 30, 2019
25. What Changed?
26. Getting Started
27. Adding an iOS library, normally 1. Install dependency using one of: → pod install → carthage checkout → swift build
28. Adding an iOS library, normally 1. Install dependency using one of: → pod install → carthage checkout → swift build 2. Use library.
29. Code Generation
30. schema + queries = code
31. schema + queries + = code
32. ! Type Safety through the whole stack
33. Codegen needs to know
34. Codegen needs to know → Where is the schema file?
35. Codegen needs to know → Where is the schema file? → Where are the query files?
36. Codegen needs to know → Where is the schema file? → Where are the query files? → Where should generated code be output?
37. Codegen needs to know → Where is the schema file? → Where are the query files? → Where should generated code be output? → Any other options which are available from the codegen library
38. Node + TypeScript
39. ! " !
40. Adding apollo-ios before
41. Adding apollo-ios before 1. Install dependency
42. Adding apollo-ios before 1. Install dependency 2. Add build script
43. Adding apollo-ios before 1. Install dependency 2. Add build script 3. npm install apollo
44. Adding apollo-ios before 1. Install dependency 2. Add build script 3. npm install apollo 4. brew install npm
45. Adding apollo-ios before 1. Install dependency 2. Add build script 3. npm install apollo 4. brew install npm 5. Google how to install Homebrew
46. Adding apollo-ios before 1. Install dependency 2. Add build script 3. npm install apollo 4. brew install npm 5. Google how to install Homebrew 6.
47. Adding apollo-ios before 1. Install dependency 2. Add build script 3. npm install apollo
48. Adding apollo-ios before 1. Install dependency 2. Add build script 3. npm install apollo 4. Wait, what version of the CLI is this?
49. Adding apollo-ios before 1. Install dependency 2. Add build script 3. npm install apollo 4. Wait, what version of the CLI is this? 5. How do I tell what's installed globally vs locally?
50. Adding apollo-ios before 1. Install dependency 2. Add build script 3. npm install apollo 4. Wait, what version of the CLI is this? 5. How do I tell what's installed globally vs locally? 6.
51. !
52. !
53. ! ⬇ npm
57. Adding apollo-ios now
58. Adding apollo-ios now 1. Install dependency
59. Adding apollo-ios now 1. Install dependency 2. Add build script that calls run-bundled-codegen.sh
60. Adding apollo-ios now 1. Install dependency 2. Add build script that calls run-bundled-codegen.sh 3. Apollo downloads and unzips the correct version of the CLI, all dependencies, and a node runtime.
61. Adding apollo-ios now 1. Install dependency 2. Add build script that calls run-bundled-codegen.sh 3. Apollo downloads and unzips the correct version of the CLI, all dependencies, and a node runtime. 4. Use library.
62. !
63. Difficult Concepts need better explanations
64. Double Optionals??
65. public struct ReviewInput: GraphQLMapConvertible { public init(stars: Int, commentary: Optional<String?> = nil, favoriteColor: Optional<ColorInput?> = nil) { // code } }
66. Optional<String?>
67. String??
68. Optional<Optional<String>>
69. Optional<Optional<String>> Outer optional: "Is a value even being included for this?"
70. Optional<Optional<String>> Inner optional: "A value was included. Is it nil or String?"
75. public struct ReviewInput: GraphQLMapConvertible { public init(stars: Int, commentary: Optional<String?> = nil, favoriteColor: Optional<ColorInput?> = nil) { // code } }
77. GraphQL fields are nullable by default
78. A nullable field can be absent
79. public struct ReviewInput: GraphQLMapConvertible { public init(stars: Int, commentary: Optional<String?> = nil, favoriteColor: Optional<ColorInput?> = nil) { // code } }
80. ReviewInput(stars: 5) // { "stars": 5 } ReviewInput(stars: 2, commentary: "Needs more ewoks") // { "stars": 2, "commentary": "Needs more ewoks" } ReviewInput(stars: 3, commentary: nil) // { "stars": 3 } ReviewInput(stars: 4, commentary: .some(nil)) // { "stars": 4, "commentary": null }
81. ReviewInput(stars: 5) // { "stars": 5 } ReviewInput(stars: 2, commentary: "Needs more ewoks") // { "stars": 2, "commentary": "Needs more ewoks" } ReviewInput(stars: 3, commentary: nil) // { "stars": 3 } ReviewInput(stars: 4, commentary: .some(nil)) // { "stars": 4, "commentary": null }
82. ReviewInput(stars: 5) // { "stars": 5 } ReviewInput(stars: 2, commentary: "Needs more ewoks") // { "stars": 2, "commentary": "Needs more ewoks" } ReviewInput(stars: 3, commentary: nil) // { "stars": 3 } ReviewInput(stars: 4, commentary: .some(nil)) // { "stars": 4, "commentary": null }
83. ReviewInput(stars: 5) // { "stars": 5 } ReviewInput(stars: 2, commentary: "Needs more ewoks") // { "stars": 2, "commentary": "Needs more ewoks" } ReviewInput(stars: 3, commentary: nil) // { "stars": 3 } ReviewInput(stars: 4, commentary: .some(nil)) // { "stars": 4, "commentary": null }
84. ReviewInput(stars: 5) // { "stars": 5 } ReviewInput(stars: 2, commentary: "Needs more ewoks") // { "stars": 2, "commentary": "Needs more ewoks" } ReviewInput(stars: 3, commentary: nil) // { "stars": 3 } ReviewInput(stars: 4, commentary: .some(nil)) // { "stars": 4, "commentary": null }
85. ReviewInput(stars: 5) // { "stars": 5 } ReviewInput(stars: 2, commentary: "Needs more ewoks") // { "stars": 2, "commentary": "Needs more ewoks" } ReviewInput(stars: 3, commentary: nil) // { "stars": 3 } ReviewInput(stars: 4, commentary: .some(nil)) // { "stars": 4, "commentary": null }
86. Caching
87. Caching NormalizedCache
88. With what shall we normalize it?
89. By default: The path of the query
97. GraphQLID
98. ISBN
99. ISBN + UUID
100. ¯\_(ϑ)_/¯
101. cacheKeyForObject
102. cacheKeyForObject (_ object: JSONObject) -> JSONValue?
103. apollo.cacheKeyForObject = { $0["id"] }
104. apollo.cacheKeyForObject = { guard let id = $0["id"], let typename = $0["__typename"] else { // Not enough info to uniquely identify the object return nil } return [id, typename] }
105. apollo.cacheKeyForObject = { guard let id = $0["id"], let typename = $0["__typename"] else { // Not enough info to uniquely identify the object return nil } return [id, typename] }
106. apollo.cacheKeyForObject = { guard let id = $0["id"] as? String, let typename = $0["__typename"] as? String else { // Not enough info to uniquely identify the object return nil } return id + typename }
107. apollo.cacheKeyForObject = { guard let isbn = $0["isbn"], let uuid = $0["uuid"] else { // Not enough info to uniquely identify the object return nil } return [isbn, uuid] }
108. In-memory Caching
109. In-memory Caching InMemoryNormalizedCache
110. Supplementary libraries
111. SQLite Caching
112. SQLite Caching ApolloSQLite
113. Subscriptions
114. Episode Stars Commentary Empire ̣̣̣̣̣ This movie rocks! New Hope ̣̣̣̣̤ This is the first movie, why is it episode 4?
115. Episode Stars Commentary Empire ̣̣̣̣̣ This movie rocks! New Hope ̣̣̣̣̤ This is the first movie, why is it episode 4? Jedi ̣̣̤̤̤ Needs more ewoks.
116. Subscriptions ApolloWebSocket
117. Subscriptions ApolloWebSocket (based on Starscream)
118. client.subscribe(subscription: ReviewAddedSubscription()) { result in switch result { case .success(let graphQLResult): if let review = graphQLResult.data?.reviewAdded { // Handle review being added. } if let errors = graphQLResult.errors { // Handle error from the server } case .failure(let error): // Handle networking error } }
119. client.subscribe(subscription: ReviewAddedSubscription()) { result in switch result { case .success(let graphQLResult): if let review = graphQLResult.data?.reviewAdded { // Handle review being added. } if let errors = graphQLResult.errors { // Handle error from the server } case .failure(let error): // Handle networking error } }
120. client.subscribe(subscription: ReviewAddedSubscription()) { result in switch result { case .success(let graphQLResult): if let review = graphQLResult.data?.reviewAdded { // Handle review being added. } if let errors = graphQLResult.errors { // Handle error from the server } case .failure(let error): // Handle networking error } }
121. client.subscribe(subscription: ReviewAddedSubscription()) { result in switch result { case .success(let graphQLResult): if let review = graphQLResult.data?.reviewAdded { // Handle review being added. } if let errors = graphQLResult.errors { // Handle error from the server } case .failure(let error): // Handle networking error } }
122. var subscription: Cancellable? self.subscription = client .subscribe(subscription: ReviewAddedSubscription()) { [weak self] result in guard let self = self else { return } switch result { case .success(let graphQLResult): if let review = graphQLResult.data?.reviewAdded { // Handle review being added. } if let errors = graphQLResult.errors { // Handle error from the server } case .failure(let error): // Handle networking error } } dealloc { self.subscription?.cancel() }
123. var subscription: Cancellable? self.subscription = client .subscribe(subscription: ReviewAddedSubscription()) { [weak self] result in guard let self = self else { return } switch result { case .success(let graphQLResult): if let review = graphQLResult.data?.reviewAdded { // Handle review being added. } if let errors = graphQLResult.errors { // Handle error from the server } case .failure(let error): // Handle networking error } } dealloc { self.subscription?.cancel() }
124. var subscription: Cancellable? self.subscription = client .subscribe(subscription: ReviewAddedSubscription()) { [weak self] result in guard let self = self else { return } switch result { case .success(let graphQLResult): if let review = graphQLResult.data?.reviewAdded { // Handle review being added. } if let errors = graphQLResult.errors { // Handle error from the server } case .failure(let error): // Handle networking error } } dealloc { self.subscription?.cancel() }
125. var subscription: Cancellable? self.subscription = client .subscribe(subscription: ReviewAddedSubscription()) { [weak self] result in guard let self = self else { return } switch result { case .success(let graphQLResult): if let review = graphQLResult.data?.reviewAdded { // Handle review being added. } if let errors = graphQLResult.errors { // Handle error from the server } case .failure(let error): // Handle networking error } } dealloc { self.subscription?.cancel() }
126. var subscription: Cancellable? self.subscription = client .subscribe(subscription: ReviewAddedSubscription()) { [weak self] result in guard let self = self else { return } switch result { case .success(let graphQLResult): if let review = graphQLResult.data?.reviewAdded { // Handle review being added. } if let errors = graphQLResult.errors { // Handle error from the server } case .failure(let error): // Handle networking error } } dealloc { self.subscription?.cancel() }
128. ! The Future
131. ! Free-form responses
132. → "Poor tutorial support"
133. → "Poor tutorial support" → "Better documentation."
134. → "Poor tutorial support" → "Better documentation." → "More documentation on uploading techniques, caching, and background communication."
135. → "Poor tutorial support" → "Better documentation." → "More documentation on uploading techniques, caching, and background communication." → "Expand documentation on SQLiteNormalizedCache"
136. Better Documentation
137. More Comprehensive Tutorial
138. I have IDEAS!
139. I have IDEAS! ...Are these good ideas?
140. I have IDEAS! ...Are these good ideas?
141. Use Codable instead of custom parsing to the extent that this is possible
142. Use Codable instead of custom parsing
143. Contributing to codegen when it's written in Typescript is hard
144. Swift Codegen
145. Swift Codegen (with parsing and validation still via TypeScript, probably)
146. Generating Swift Code in Swift
147. As part of Swift Codegen:
148. As part of Swift Codegen: → Codable conformance
149. As part of Swift Codegen: → Codable conformance → Equatable/Hashable conformance
150. As part of Swift Codegen: → Codable conformance → Equatable/Hashable conformance → xcfilelists of inputs and outputs
151. As part of Swift Codegen: → Codable conformance → Equatable/Hashable conformance → xcfilelists of inputs and outputs → Fragments as protocols
152. As part of Swift Codegen: → Codable conformance → Equatable/Hashable conformance → xcfilelists of inputs and outputs → Fragments as protocols → Get rid of double-optionals for clearer type*
153. As part of Swift Codegen: → Codable conformance → Equatable/Hashable conformance → xcfilelists of inputs and outputs → Fragments as protocols → Get rid of double-optionals for clearer type* → Identifiable auto-conformance*
154. As part of Swift Codegen: → Codable conformance → Equatable/Hashable conformance → xcfilelists of inputs and outputs → Fragments as protocols → Get rid of double-optionals for clearer type* → Identifiable auto-conformance* * - I hope
156. "Version x.y.z breaks on ________"
157. Dependency Manager Test Suite
158. "Version x.y.z breaks on NOTHING"
159. Better Caching
160. Moar ! Libraries!
161. Conucrrency is hard
162. Concurrency is hard
163. Wrappers for RxSwift, Combine, and PromiseKit
164. LIST SUBJECT TO CHANGE Combine, PromiseKit,
165. !
166. Stuff you contribute!
167. Stuff you contribute! (seriously though, I would love your help)
169. Obligatory Summary Slide
170. Obligatory Summary Slide → Check out updated build setup, it's way easier
171. Obligatory Summary Slide → Check out updated build setup, it's way easier → Docs have been significantly improved
172. Obligatory Summary Slide → Check out updated build setup, it's way easier → Docs have been significantly improved → New sample app and tutorial coming soon!
173. Obligatory Summary Slide → Check out updated build setup, it's way easier → Docs have been significantly improved → New sample app and tutorial coming soon! → Swift Codegen is coming
174. Obligatory Summary Slide → Check out updated build setup, it's way easier → Docs have been significantly improved → New sample app and tutorial coming soon! → Swift Codegen is coming → Check out the ROADMAP.md
175. Obligatory Summary Slide → Check out updated build setup, it's way easier → Docs have been significantly improved → New sample app and tutorial coming soon! → Swift Codegen is coming → Check out the ROADMAP.md → Contribute!
176. ! Thank you!
177. Links! → Main Repo: https://github.com/apollographql/apollo-ios → Prettily rendered documentation: https://apollographql.com/docs/ios/