Refactor result normalizer to convert selection set data to json when…

… creating RecordSet
apollographql · Jan 13, 2023 · 596eb46 · 596eb46
1 parent 17d6073
commit 596eb46
Show file tree

Hide file tree

Showing 9 changed files with 144 additions and 17 deletions.
diff --git a/Sources/Apollo/ApolloStore.swift b/Sources/Apollo/ApolloStore.swift
@@ -306,7 +306,7 @@ public class ApolloStore {
       withKey key: CacheKey,
       variables: GraphQLOperation.Variables? = nil
     ) throws {
-      let normalizer = GraphQLResultNormalizer()
+      let normalizer = ResultNormalizerFactory.selectionSetDataNormalizer()
       let executor = GraphQLExecutor { object, info in
         return object[info.responseKeyForField]
       }

diff --git a/Sources/Apollo/GraphQLDependencyTracker.swift b/Sources/Apollo/GraphQLDependencyTracker.swift
@@ -9,6 +9,10 @@ final class GraphQLDependencyTracker: GraphQLResultAccumulator {
     dependentKeys.insert(info.cachePath.joined)
   }
 
+  func accept(customScalar: JSONValue, info: FieldExecutionInfo) {
+    dependentKeys.insert(info.cachePath.joined)
+  }
+
   func acceptNullValue(info: FieldExecutionInfo) {
     dependentKeys.insert(info.cachePath.joined)
   }

diff --git a/Sources/Apollo/GraphQLExecutor.swift b/Sources/Apollo/GraphQLExecutor.swift
@@ -362,9 +362,12 @@ final class GraphQLExecutor {
                       asType: innerType,
                       accumulator: accumulator)
 
-    case .scalar, .customScalar:
+    case .scalar:
       return PossiblyDeferred { try accumulator.accept(scalar: value, info: fieldInfo) }
 
+    case .customScalar:
+      return PossiblyDeferred { try accumulator.accept(customScalar: value, info: fieldInfo) }
+
     case .list(let innerType):
       guard let array = value as? [JSONValue] else {
         return .immediate(.failure(JSONDecodingError.wrongType))

diff --git a/Sources/Apollo/GraphQLResponse.swift b/Sources/Apollo/GraphQLResponse.swift
@@ -23,7 +23,7 @@ public final class GraphQLResponse<Data: RootSelectionSet> {
   public func parseResult() throws -> (GraphQLResult<Data>, RecordSet?) {
     let accumulator = zip(
       GraphQLSelectionSetMapper<Data>(),
-      GraphQLResultNormalizer(),
+      ResultNormalizerFactory.networkResponseDataNormalizer(),
       GraphQLDependencyTracker()
     )
 

diff --git a/Sources/Apollo/GraphQLResultAccumulator.swift b/Sources/Apollo/GraphQLResultAccumulator.swift
@@ -9,6 +9,7 @@ protocol GraphQLResultAccumulator: AnyObject {
   associatedtype FinalResult
 
   func accept(scalar: JSONValue, info: FieldExecutionInfo) throws -> PartialResult
+  func accept(customScalar: JSONValue, info: FieldExecutionInfo) throws -> PartialResult
   func acceptNullValue(info: FieldExecutionInfo) throws -> PartialResult
   func acceptMissingValue(info: FieldExecutionInfo) throws -> PartialResult
   func accept(list: [PartialResult], info: FieldExecutionInfo) throws -> PartialResult
@@ -47,6 +48,11 @@ final class Zip2Accumulator<Accumulator1: GraphQLResultAccumulator, Accumulator2
             try accumulator2.accept(scalar: scalar, info: info))
   }
 
+  func accept(customScalar: JSONValue, info: FieldExecutionInfo) throws -> PartialResult {
+    return (try accumulator1.accept(customScalar: customScalar, info: info),
+            try accumulator2.accept(customScalar: customScalar, info: info))
+  }
+
   func acceptNullValue(info: FieldExecutionInfo) throws -> PartialResult {
     return (try accumulator1.acceptNullValue(info: info),
             try accumulator2.acceptNullValue(info: info))
@@ -110,6 +116,12 @@ final class Zip3Accumulator<Accumulator1: GraphQLResultAccumulator, Accumulator2
             try accumulator3.accept(scalar: scalar, info: info))
   }
 
+  func accept(customScalar: JSONValue, info: FieldExecutionInfo) throws -> PartialResult {
+    return (try accumulator1.accept(customScalar: customScalar, info: info),
+            try accumulator2.accept(customScalar: customScalar, info: info),
+            try accumulator3.accept(customScalar: customScalar, info: info))
+  }
+
   func acceptNullValue(info: FieldExecutionInfo) throws -> PartialResult {
     return (try accumulator1.acceptNullValue(info: info),
             try accumulator2.acceptNullValue(info: info),

diff --git a/Sources/Apollo/GraphQLResultNormalizer.swift b/Sources/Apollo/GraphQLResultNormalizer.swift
@@ -3,47 +3,76 @@ import Foundation
 import ApolloAPI
 #endif
 
-final class GraphQLResultNormalizer: GraphQLResultAccumulator {
+struct ResultNormalizerFactory {
+  private init() {}
+
+  static func selectionSetDataNormalizer() -> SelectionSetDataResultNormalizer {
+    SelectionSetDataResultNormalizer()
+  }
+
+  static func networkResponseDataNormalizer() -> RawJSONResultNormalizer {
+    RawJSONResultNormalizer()
+  }
+}
+
+class BaseGraphQLResultNormalizer: GraphQLResultAccumulator {
   private var records: RecordSet = [:]
 
-  func accept(scalar: JSONValue, info: FieldExecutionInfo) -> JSONValue? {
+  fileprivate init() {}
+
+  final func accept(scalar: JSONValue, info: FieldExecutionInfo) -> JSONValue? {
     return scalar
   }
 
-  func acceptNullValue(info: FieldExecutionInfo) -> JSONValue? {
+  func accept(customScalar: JSONValue, info: FieldExecutionInfo) -> JSONValue? {
+    return customScalar
+  }
+
+  final func acceptNullValue(info: FieldExecutionInfo) -> JSONValue? {
     return NSNull()
   }
 
-  func acceptMissingValue(info: FieldExecutionInfo) -> JSONValue? {
+  final func acceptMissingValue(info: FieldExecutionInfo) -> JSONValue? {
     return nil
   }
 
-  func accept(list: [JSONValue?], info: FieldExecutionInfo) -> JSONValue? {
+  final func accept(list: [JSONValue?], info: FieldExecutionInfo) -> JSONValue? {
     return list
   }
 
-  func accept(childObject: CacheReference, info: FieldExecutionInfo) -> JSONValue? {
+  final func accept(childObject: CacheReference, info: FieldExecutionInfo) -> JSONValue? {
     return childObject
   }
 
-  func accept(fieldEntry: JSONValue?, info: FieldExecutionInfo) -> (key: String, value: JSONValue)? {
+  final func accept(fieldEntry: JSONValue?, info: FieldExecutionInfo) -> (key: String, value: JSONValue)? {
     guard let fieldEntry else { return nil }
     return (info.cacheKeyForField, fieldEntry)
   }
 
-  func accept(
+  final func accept(
     fieldEntries: [(key: String, value: JSONValue)],
     info: ObjectExecutionInfo
   ) throws -> CacheReference {
     let cachePath = info.cachePath.joined
 
     let object = JSONObject(fieldEntries, uniquingKeysWith: { (_, last) in last })
     records.merge(record: Record(key: cachePath, object))
-    
+
     return CacheReference(cachePath)
   }
 
-  func finish(rootValue: CacheReference, info: ObjectExecutionInfo) throws -> RecordSet {
+  final func finish(rootValue: CacheReference, info: ObjectExecutionInfo) throws -> RecordSet {
     return records
   }
 }
+
+final class RawJSONResultNormalizer: BaseGraphQLResultNormalizer {}
+
+final class SelectionSetDataResultNormalizer: BaseGraphQLResultNormalizer {
+  override final func accept(customScalar: JSONValue, info: FieldExecutionInfo) -> JSONValue? {
+    if let customScalar = customScalar as? JSONEncodable {
+      return customScalar._jsonValue
+    }
+    return customScalar
+  }
+}
diff --git a/Sources/Apollo/GraphQLSelectionSetMapper.swift b/Sources/Apollo/GraphQLSelectionSetMapper.swift
@@ -20,8 +20,7 @@ final class GraphQLSelectionSetMapper<SelectionSet: AnySelectionSet>: GraphQLRes
 
   func accept(scalar: JSONValue, info: FieldExecutionInfo) throws -> JSONValue? {
     switch info.field.type.namedType {
-    case let .scalar(decodable as any JSONDecodable.Type),
-      let .customScalar(decodable as any JSONDecodable.Type):
+    case let .scalar(decodable as any JSONDecodable.Type):
       // This will convert a JSON value to the expected value type,
       // which could be a custom scalar or an enum.
       return try decodable.init(_jsonValue: scalar)._asAnyHashable
@@ -30,6 +29,17 @@ final class GraphQLSelectionSetMapper<SelectionSet: AnySelectionSet>: GraphQLRes
     }
   }
 
+  func accept(customScalar: JSONValue, info: FieldExecutionInfo) throws -> JSONValue? {
+    switch info.field.type.namedType {
+    case let .customScalar(decodable as any JSONDecodable.Type):
+      // This will convert a JSON value to the expected value type,
+      // which could be a custom scalar or an enum.
+      return try decodable.init(_jsonValue: customScalar)._asAnyHashable
+    default:
+      preconditionFailure()
+    }
+  }
+
   func acceptNullValue(info: FieldExecutionInfo) -> JSONValue? {
     return stripNullValues ? nil : NSNull()
   }

diff --git a/Tests/ApolloTests/Cache/ReadWriteFromStoreTests.swift b/Tests/ApolloTests/Cache/ReadWriteFromStoreTests.swift
@@ -484,7 +484,7 @@ class ReadWriteFromStoreTests: XCTestCase, CacheDependentTesting, StoreLoading {
           data.hero.name = "Artoo"
         }
       }, completion: { result in
-        defer { updateCompletedExpectation.fulfill() }        
+        defer { updateCompletedExpectation.fulfill() }
         XCTAssertSuccessResult(result)
       })
 
@@ -1294,6 +1294,75 @@ class ReadWriteFromStoreTests: XCTestCase, CacheDependentTesting, StoreLoading {
     }
   }
 
+  func test_updateCacheMutation_givenEnumField_enumFieldIsSerializedAndCanBeRead() throws {
+    // given
+    enum HeroType: String, EnumType {
+      case droid
+    }
+
+    struct GivenSelectionSet: MockMutableRootSelectionSet {
+      public var __data: DataDict = DataDict([:], variables: nil)
+      init(data: DataDict) { __data = data }
+
+      static var __selections: [Selection] { [
+        .field("hero", Hero.self)
+      ]}
+
+      var hero: Hero {
+        get { __data["hero"] }
+        set { __data["hero"] = newValue }
+      }
+
+      struct Hero: MockMutableRootSelectionSet {
+        public var __data: DataDict = DataDict([:], variables: nil)
+        init(data: DataDict) { __data = data }
+
+        static var __selections: [Selection] { [
+          .field("type", GraphQLEnum<HeroType>.self)
+        ]}
+
+        var type: GraphQLEnum<HeroType> {
+          get { __data["type"] }
+          set { __data["type"] = newValue }
+        }
+      }
+    }
+
+    let cacheMutation = MockLocalCacheMutation<GivenSelectionSet>()
+
+    mergeRecordsIntoCache([
+      "QUERY_ROOT": ["hero": CacheReference("QUERY_ROOT.hero")],
+      "QUERY_ROOT.hero": ["__typename": "Droid", "type": "droid"]
+    ])
+
+    runActivity("update mutation") { _ in
+      let updateCompletedExpectation = expectation(description: "Update completed")
+
+      store.withinReadWriteTransaction({ transaction in
+        try transaction.update(cacheMutation) { data in
+          // noop
+        }
+      }, completion: { result in
+        defer { updateCompletedExpectation.fulfill() }
+        XCTAssertSuccessResult(result)
+      })
+
+      self.wait(for: [updateCompletedExpectation], timeout: Self.defaultWaitTimeout)
+    }
+
+    let query = MockQuery<GivenSelectionSet>()
+
+    loadFromStore(operation: query) { result in
+      try XCTAssertSuccessResult(result) { graphQLResult in
+        XCTAssertEqual(graphQLResult.source, .cache)
+        XCTAssertNil(graphQLResult.errors)
+
+        let data = try XCTUnwrap(graphQLResult.data)
+        XCTAssertEqual(data.hero.type, .case(.droid))
+      }
+    }
+  }
+
   func test_writeDataForCacheMutation_givenMutationOperation_updateNestedField_updatesObjectAtMutationRoot() throws {
     // given
     struct GivenSelectionSet: MockMutableRootSelectionSet {

diff --git a/Tests/ApolloTests/GraphQLExecutor_ResultNormalizer_FromResponse_Tests.swift b/Tests/ApolloTests/GraphQLExecutor_ResultNormalizer_FromResponse_Tests.swift
@@ -26,7 +26,7 @@ class GraphQLExecutor_ResultNormalizer_FromResponse_Tests: XCTestCase {
       on: object,
       withRootCacheReference: CacheReference.RootQuery,
       variables: variables,
-      accumulator: GraphQLResultNormalizer()
+      accumulator: ResultNormalizerFactory.networkResponseDataNormalizer()
     )
   }