Added ability to directly update the Apollo cache using write methods (#413)

Author: Nickersoft

Cartfile

@@ -1,2 +1,2 @@
 github "stephencelis/SQLite.swift" ~> 0.11.5
-github "daltoniam/Starscream" ~> 3.0.5
+github "daltoniam/Starscream" ~> 3.0.6

Cartfile.resolved

@@ -1,2 +1,2 @@
-github "daltoniam/Starscream" "3.0.5"
+github "daltoniam/Starscream" "3.0.6"
 github "stephencelis/SQLite.swift" "0.11.5"

Carthage/Checkouts/Starscream

@@ -29,7 +29,9 @@ public typealias OperationResultHandler<Operation: GraphQLOperation> = (_ result
 /// The `ApolloClient` class provides the core API for Apollo. This API provides methods to fetch and watch queries, and to perform mutations.
 public class ApolloClient {
   let networkTransport: NetworkTransport
-  let store: ApolloStore
+    
+  public let store: ApolloStore
+    
   public var cacheKeyForObject: CacheKeyForObject? {
     get {
       return store.cacheKeyForObject
@@ -39,7 +41,7 @@ public class ApolloClient {
       store.cacheKeyForObject = newValue
     }
   }
-  
+    
   private let queue: DispatchQueue
   private let operationQueue: OperationQueue
 

Sources/Apollo/ApolloClient.swift

@@ -118,7 +118,7 @@ public final class ApolloStore {
     }
   }
 
-  func load<Query: GraphQLQuery>(query: Query) -> Promise<GraphQLResult<Query.Data>> {
+  public func load<Query: GraphQLQuery>(query: Query) -> Promise<GraphQLResult<Query.Data>> {
     return withinReadTransaction { transaction in
       let mapper = GraphQLSelectionSetMapper<Query.Data>()
       let dependencyTracker = GraphQLDependencyTracker()
@@ -129,7 +129,7 @@ public final class ApolloStore {
     }
   }
 
-  func load<Query: GraphQLQuery>(query: Query, resultHandler: @escaping OperationResultHandler<Query>) {
+  public func load<Query: GraphQLQuery>(query: Query, resultHandler: @escaping OperationResultHandler<Query>) {
     load(query: query).andThen { result in
       resultHandler(result, nil)
     }.catch { error in
@@ -143,17 +143,6 @@ public final class ApolloStore {
 
     fileprivate lazy var loader: DataLoader<CacheKey, Record?> = DataLoader(self.cache.loadRecords)
 
-    fileprivate func makeExecutor() -> GraphQLExecutor {
-      let executor = GraphQLExecutor { object, info in
-        let value = object[info.cacheKeyForField]
-        return self.complete(value: value)
-      }
-
-      executor.dispatchDataLoads = self.loader.dispatch
-      executor.cacheKeyForObject = self.cacheKeyForObject
-      return executor
-    }
-
     init(cache: NormalizedCache, cacheKeyForObject: CacheKeyForObject?) {
       self.cache = cache
       self.cacheKeyForObject = cacheKeyForObject
@@ -187,7 +176,16 @@ public final class ApolloStore {
 
     final func execute<Accumulator: GraphQLResultAccumulator>(selections: [GraphQLSelection], onObjectWithKey key: CacheKey, variables: GraphQLMap?, accumulator: Accumulator) throws -> Promise<Accumulator.FinalResult> {
       return loadObject(forKey: key).flatMap { object in
-        try self.makeExecutor().execute(selections: selections, on: object, withKey: key, variables: variables, accumulator: accumulator)
+        let executor = GraphQLExecutor { object, info in
+          let value = object[info.cacheKeyForField]
+          return self.complete(value: value)
+        }
+        
+        
+        executor.dispatchDataLoads = self.loader.dispatch
+        executor.cacheKeyForObject = self.cacheKeyForObject
+        
+        return try executor.execute(selections: selections, on: object, withKey: key, variables: variables, accumulator: accumulator)
       }
     }
 
@@ -206,8 +204,8 @@ public final class ApolloStore {
     fileprivate var updateChangedKeysFunc: DidChangeKeysFunc?
 
     init(cache: NormalizedCache, cacheKeyForObject: CacheKeyForObject?, updateChangedKeysFunc: @escaping DidChangeKeysFunc) {
-        self.updateChangedKeysFunc = updateChangedKeysFunc
-        super.init(cache: cache, cacheKeyForObject: cacheKeyForObject)
+      self.updateChangedKeysFunc = updateChangedKeysFunc
+      super.init(cache: cache, cacheKeyForObject: cacheKeyForObject)
     }
 
     public func update<Query: GraphQLQuery>(query: Query, _ body: (inout Query.Data) throws -> Void) throws {
@@ -232,12 +230,18 @@ public final class ApolloStore {
 
     private func write(object: JSONObject, forSelections selections: [GraphQLSelection], withKey key: CacheKey, variables: GraphQLMap?) throws {
       let normalizer = GraphQLResultNormalizer()
-      try self.makeExecutor().execute(selections: selections, on: object, withKey: key, variables: variables, accumulator: normalizer)
+      let executor = GraphQLExecutor { object, info in
+        return .result(.success(object[info.responseKeyForField]))
+      }
+      
+      executor.cacheKeyForObject = self.cacheKeyForObject
+      
+      try executor.execute(selections: selections, on: object, withKey: key, variables: variables, accumulator: normalizer)
       .flatMap {
         self.cache.merge(records: $0)
       }.andThen { changedKeys in
         if let didChangeKeysFunc = self.updateChangedKeysFunc {
-            didChangeKeysFunc(changedKeys, nil)
+          didChangeKeysFunc(changedKeys, nil)
         }
       }.wait()
     }

Sources/Apollo/ApolloStore.swift

@@ -43,7 +43,7 @@ class ReadWriteFromStoreTests: XCTestCase {
       })
     }
   }
-  
+
   func testReadHeroNameQueryWithMissingName() throws {
     let initialRecords: RecordSet = [
       "QUERY_ROOT": ["hero": Reference(key: "hero")],
@@ -160,7 +160,44 @@ class ReadWriteFromStoreTests: XCTestCase {
       XCTAssertEqual(friendsNames, ["Luke Skywalker", "Han Solo", "Leia Organa", "C-3PO"])
     }
   }
-  
+    
+  func testUpdateHeroAndFriendsNamesQueryWithVariable() throws {
+    let initialRecords: RecordSet = [
+      "QUERY_ROOT": ["hero(episode:NEWHOPE)": Reference(key: "2001")],
+      "2001": [
+        "name": "R2-D2",
+        "__typename": "Droid",
+        "friends": [
+          Reference(key: "1000"),
+          Reference(key: "1002"),
+          Reference(key: "1003")
+        ]
+      ],
+      "1000": ["__typename": "Human", "name": "Luke Skywalker"],
+      "1002": ["__typename": "Human", "name": "Han Solo"],
+      "1003": ["__typename": "Human", "name": "Leia Organa"],
+      ]
+
+    try withCache(initialRecords: initialRecords) { (cache) in
+      let store = ApolloStore(cache: cache)
+
+      let query = HeroAndFriendsNamesQuery(episode: Episode.newhope)
+
+      try await(store.withinReadWriteTransaction { transaction in
+        try transaction.update(query: query) { (data: inout HeroAndFriendsNamesQuery.Data) in
+          data.hero?.friends?.append(.makeDroid(name: "C-3PO"))
+        }
+      })
+
+      let result = try await(store.load(query: query))
+      guard let data = result.data else { XCTFail(); return }
+
+      XCTAssertEqual(data.hero?.name, "R2-D2")
+      let friendsNames = data.hero?.friends?.compactMap { $0?.name }
+      XCTAssertEqual(friendsNames, ["Luke Skywalker", "Han Solo", "Leia Organa", "C-3PO"])
+    }
+  }
+
   func testReadHeroDetailsFragmentWithTypeSpecificProperty() throws {
     let initialRecords: RecordSet = [
       "2001": ["name": "R2-D2", "__typename": "Droid", "primaryFunction": "Protocol"]

Tests/ApolloCacheDependentTests/ReadWriteFromStoreTests.swift

@@ -3,12 +3,22 @@ import XCTest
 import StarWarsAPI
 
 private final class MockBatchedNormalizedCache: NormalizedCache {
+  
   private var records: RecordSet
 
   init(records: RecordSet) {
     self.records = records
   }
 
+  func clear() -> Promise<Void> {
+    return Promise { fulfill, reject in
+      DispatchQueue.global().asyncAfter(deadline: .now() + .milliseconds(100)) {
+        self.records.clear()
+        fulfill(())
+      }
+    }
+  }
+  
   func loadRecords(forKeys keys: [CacheKey]) -> Promise<[Record?]> {
     return Promise { fulfill, reject in
       DispatchQueue.global().asyncAfter(deadline: .now() + .milliseconds(100)) {

Tests/ApolloPerformanceTests/NormalizedCachingTests.swift

@@ -2,6 +2,10 @@ import Starscream
 @testable import ApolloWebSocket
 
 class MockWebSocket: ApolloWebSocketClient {
+  var pongDelegate: WebSocketPongDelegate?
+  
+  var sslClientCertificate: SSLClientCertificate?
+  
   required init(request: URLRequest, protocols: [String]?) {
   }