feature(defer): Partial and Incremental Parsing

Tests/ApolloCodegenTests/CodeGenIR/IRRootFieldBuilderTests.swift

@@ -40,6 +40,8 @@
   // MARK: - Helpers
 
   func buildSubjectRootField(operationName: String? = nil) async throws {
+    addDeferDirective()
+
     ir = try await IRBuilderTestWrapper(.mock(schema: schemaSDL, document: document))
     if let operationName {
       operation = try XCTUnwrap(ir.compilationResult.operations.first(
@@ -52,6 +54,19 @@
     subject = result.rootField
   }
 
+  // This function will only be needed until @defer is merged into the GraphQL spec and is
+  // considered a first-class directive in graphql-js. Right now it is a valid directive but must
+  // be 'enabled' through explicit declaration in the schema.
+  fileprivate func addDeferDirective() {
+    guard let schemaSDL = self.schemaSDL else { return }
+
+    self.schemaSDL = """
+    directive @defer(label: String, if: Boolean! = true) on FRAGMENT_SPREAD | INLINE_FRAGMENT
+
+    \(schemaSDL)
+    """
+  }
+
   // MARK: - Children Computation
 
   // MARK: Children - Fragment Type
@@ -4384,9 +4399,11 @@
     expect(Array(self.computedReferencedFragments)).to(equal(expected))
   }
 
-  // MARK: - Deferred Fragments - hasDeferredFragments property
+  // MARK: - Deferred Fragments - containsDeferredFragment property
+
+  #warning("Need tests for deferredFragments property")
 
-  func test__deferredFragments__givenNoDeferredFragment_hasDeferredFragmentsFalse() async throws {
+  func test__deferredFragments__givenNoDeferredFragment_containsDeferredFragmentFalse() async throws {
     // given
     schemaSDL = """
     type Query {
@@ -4426,9 +4443,7 @@
     expect(self.result.containsDeferredFragment).to(beFalse())
   }
 
-  func test__deferredFragments__givenDeferredInlineFragment_hasDeferredFragmentsTrue() async throws {
-    throw XCTSkip("Skipped in PR #235 - must be reverted when the feature/defer-execution-networking branch is merged into main!")
-
+  func test__deferredFragments__givenDeferredInlineFragment_containsDeferredFragmentTrue() async throws {
     // given
     schemaSDL = """
     type Query {
@@ -4468,9 +4483,7 @@
     expect(self.result.containsDeferredFragment).to(beTrue())
   }
 
-  func test__deferredFragments__givenDeferredInlineFragmentWithCondition_hasDeferredFragmentsTrue() async throws {
-    throw XCTSkip("Skipped in PR #235 - must be reverted when the feature/defer-execution-networking branch is merged into main!")
-
+  func test__deferredFragments__givenDeferredInlineFragmentWithCondition_containsDeferredFragmentTrue() async throws {
     // given
     schemaSDL = """
     type Query {
@@ -4510,9 +4523,7 @@
     expect(self.result.containsDeferredFragment).to(beTrue())
   }
 
-  func test__deferredFragments__givenDeferredInlineFragmentWithConditionFalse_hasDeferredFragmentsFalse() async throws {
-    throw XCTSkip("Skipped in PR #235 - must be reverted when the feature/defer-execution-networking branch is merged into main!")
-
+  func test__deferredFragments__givenDeferredInlineFragmentWithConditionFalse_containsDeferredFragmentFalse() async throws {
     // given
     schemaSDL = """
     type Query {
@@ -4552,9 +4563,7 @@
     expect(self.result.containsDeferredFragment).to(beFalse())
   }
 
-  func test__deferredFragments__givenDeferredNamedFragment_onDifferentTypeCase_hasDeferredFragmentsTrue() async throws {
-    throw XCTSkip("Skipped in PR #235 - must be reverted when the feature/defer-execution-networking branch is merged into main!")
-
+  func test__deferredFragments__givenDeferredNamedFragment_onDifferentTypeCase_containsDeferredFragmentTrue() async throws {
     // given
     schemaSDL = """
     type Query {
@@ -4593,9 +4602,7 @@
     expect(self.result.containsDeferredFragment).to(beTrue())
   }
 
-  func test__deferredFragments__givenDeferredInlineFragment_withinNamedFragment_hasDeferredFragmentsTrue() async throws {
-    throw XCTSkip("Skipped in PR #235 - must be reverted when the feature/defer-execution-networking branch is merged into main!")
-
+  func test__deferredFragments__givenDeferredInlineFragment_withinNamedFragment_containsDeferredFragmentTrue() async throws {
     // given
     schemaSDL = """
     type Query {
@@ -4639,9 +4646,7 @@
     expect(self.result.containsDeferredFragment).to(beTrue())
   }
 
-  func test__deferredFragments__givenDeferredNamedFragment_withSelectionOnDifferentTypeCase_hasDeferredFragmentsTrue() async throws {
-    throw XCTSkip("Skipped in PR #235 - must be reverted when the feature/defer-execution-networking branch is merged into main!")
-
+  func test__deferredFragments__givenDeferredNamedFragment_withSelectionOnDifferentTypeCase_containsDeferredFragmentTrue() async throws {
     // given
     schemaSDL = """
     type Query {

Tests/ApolloCodegenTests/CodeGeneration/Templates/OperationDefinitionTemplateTests.swift

@@ -308,131 +308,7 @@
 
   // MARK: - Defer Properties
 
-  func test__generate__givenQueryWithDeferredInlineFragment_generatesDeferredPropertyTrue() async throws {
-    throw XCTSkip("Skipped in PR #235 - must be reverted when the feature/defer-execution-networking branch is merged into main!")
-
-    // given
-    schemaSDL = """
-    type Query {
-      allAnimals: [Animal!]
-    }
-
-    interface Animal {
-      species: String!
-    }
-
-    type Dog implements Animal {
-      species: String!
-    }
-    """
-
-    document = """
-    query TestOperation {
-      allAnimals {
-        ... on Dog @defer(label: "root") {
-          species
-        }
-      }
-    }
-    """
-
-    let expected = """
-      public static let hasDeferredFragments: Bool = true
-    """
-
-    // when
-    try await buildSubjectAndOperation()
-    let actual = renderSubject()
-
-    // then
-    expect(actual).to(equalLineByLine(expected, atLine: 8, ignoringExtraLines: true))
-  }
-
-  func test__generate__givenQueryWithDeferredNamedFragment_generatesDeferredPropertyTrue() async throws {
-    throw XCTSkip("Skipped in PR #235 - must be reverted when the feature/defer-execution-networking branch is merged into main!")
-
-    // given
-    schemaSDL = """
-    type Query {
-      allAnimals: [Animal!]
-    }
-
-    interface Animal {
-      species: String!
-    }
-
-    type Dog implements Animal {
-      species: String!
-    }
-    """
-
-    document = """
-    query TestOperation {
-      allAnimals {
-        ... DogFragment @defer(label: "root")
-      }
-    }
-
-    fragment DogFragment on Dog {
-      species
-    }
-    """
-
-    let expected = """
-      public static let hasDeferredFragments: Bool = true
-    """
-
-    // when
-    try await buildSubjectAndOperation()
-    let actual = renderSubject()
-
-    // then
-    expect(actual).to(equalLineByLine(expected, atLine: 9, ignoringExtraLines: true))
-  }
-
-  func test__generate__givenQueryWithNamedFragment_withDeferredTypeCase_generatesDeferredPropertyTrue() async throws {
-    throw XCTSkip("Skipped in PR #235 - must be reverted when the feature/defer-execution-networking branch is merged into main!")
-
-    // given
-    schemaSDL = """
-    type Query {
-      allAnimals: [Animal!]
-    }
-
-    interface Animal {
-      species: String!
-    }
-
-    type Dog implements Animal {
-      species: String!
-    }
-    """
-
-    document = """
-    query TestOperation {
-      allAnimals {
-        ... DogFragment
-      }
-    }
-
-    fragment DogFragment on Animal {
-      ... on Dog @defer(label: "root") {
-        species
-      }
-    }
-    """
-
-    let expected = """
-      public static let hasDeferredFragments: Bool = true
-    """
-
-    // when
-    try await buildSubjectAndOperation()
-    let actual = renderSubject()
-
-    // then
-    expect(actual).to(equalLineByLine(expected, atLine: 9, ignoringExtraLines: true))
-  }
+  #warning("Need tests for deferredFragments property")
 
   // MARK: - Selection Set Declaration
 

Tests/ApolloCodegenTests/CodeGeneration/Templates/SelectionSet/SelectionSetTemplateTests.swift

@@ -1716,11 +1716,11 @@
     ))
   }
 
   #warning("need more tests here - same test cases as IRRootFieldBuilderTests")
 
   // MARK: Selections - Deferred Named Fragment
 
   #warning("need more tests here - same test cases as IRRootFieldBuilderTests")
 
   // MARK: Selections - Include/Skip
 
@@ -4664,11 +4664,11 @@
     ))
   }
 
   #warning("need more tests here - same test cases as IRRootFieldBuilderTests")
 
   // MARK: Field Accessors - Deferred Named Fragments
 
   #warning("need more tests here - same test cases as IRRootFieldBuilderTests")
 
   // MARK: - Inline Fragment Accessors
 
@@ -5522,11 +5522,11 @@
     ))
   }
 
   #warning("need more tests here - same test cases as IRRootFieldBuilderTests")
 
   // MARK: Fragment Accessors - Deferred Named Fragment
 
   #warning("need more tests here - same test cases as IRRootFieldBuilderTests")
 
   // MARK: - Nested Selection Sets
 
@@ -7407,7 +7407,7 @@
     expect(rendered_allAnimals_deferredAsRoot).to(equalLineByLine(
       """
       /// AllAnimal.Root
-      public struct Root: TestSchema.InlineFragment, ApolloAPI.Deferrable {
+      public struct Root: TestSchema.InlineFragment {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 
@@ -7461,7 +7461,7 @@
     expect(rendered_allAnimals_deferredAsRoot).to(equalLineByLine(
       """
       /// AllAnimal.Root
-      public struct Root: TestSchema.InlineFragment, ApolloAPI.Deferrable {
+      public struct Root: TestSchema.InlineFragment {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 
@@ -7520,7 +7520,7 @@
     expect(rendered_allAnimals_asDog_deferredAsRoot).to(equalLineByLine(
       """
       /// AllAnimal.AsDog.Root
-      public struct Root: TestSchema.InlineFragment, ApolloAPI.Deferrable {
+      public struct Root: TestSchema.InlineFragment {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 

Tests/ApolloInternalTestHelpers/InterceptorTester.swift

@@ -1,4 +1,5 @@
 import Apollo
+import ApolloAPI
 import Foundation
 
 /// Use this interceptor tester to isolate a single `ApolloInterceptor` vs. having to create an
@@ -14,9 +15,9 @@ public class InterceptorTester {
   public func intercept<Operation>(
     request: Apollo.HTTPRequest<Operation>,
     response: Apollo.HTTPResponse<Operation>? = nil,
-    completion: @escaping (Result<Data?, Error>) -> Void
+    completion: @escaping (Result<HTTPResponse<Operation>?, Error>) -> Void
   ) {
-    let requestChain = ResponseCaptureRequestChain({ result in
+    let requestChain = ResponseCaptureRequestChain<Operation>({ result in
       completion(result)
     })
 
@@ -27,11 +28,11 @@ public class InterceptorTester {
   }
 }
 
-fileprivate class ResponseCaptureRequestChain: RequestChain {
+fileprivate class ResponseCaptureRequestChain<T: GraphQLOperation>: RequestChain {
   var isCancelled: Bool = false
-  let completion: (Result<Data?, Error>) -> Void
+  let completion: (Result<HTTPResponse<T>?, Error>) -> Void
 
-  init(_ completion: @escaping (Result<Data?, Error>) -> Void) {
+  init(_ completion: @escaping (Result<HTTPResponse<T>?, Error>) -> Void) {
     self.completion = completion
   }
 
@@ -45,7 +46,7 @@ fileprivate class ResponseCaptureRequestChain: RequestChain {
     response: Apollo.HTTPResponse<Operation>?,
     completion: @escaping (Result<Apollo.GraphQLResult<Operation.Data>, Error>) -> Void
   ) {
-    self.completion(.success(response?.rawData))
+    self.completion(.success(response as? HTTPResponse<T>))
   }
 
   func proceedAsync<Operation>(
@@ -54,7 +55,7 @@ fileprivate class ResponseCaptureRequestChain: RequestChain {
     interceptor: any ApolloInterceptor,
     completion: @escaping (Result<GraphQLResult<Operation.Data>, Error>) -> Void
   ) {
-    self.completion(.success(response?.rawData))
+    self.completion(.success(response as? HTTPResponse<T>))
   }
 
   func cancel() {}

Tests/ApolloInternalTestHelpers/MockOperation.swift

@@ -5,8 +5,6 @@ open class MockOperation<SelectionSet: RootSelectionSet>: GraphQLOperation {
 
   open class var operationType: GraphQLOperationType { .query }
 
-  open class var hasDeferredFragments: Bool { false }
-
   open class var operationName: String { "MockOperationName" }
 
   open class var operationDocument: OperationDocument {
@@ -17,6 +15,8 @@ open class MockOperation<SelectionSet: RootSelectionSet>: GraphQLOperation {
 
   public init() {}
 
+  open class var deferredFragments: [DeferredFragmentIdentifier : any ApolloAPI.SelectionSet.Type]? { return nil }
+
 }
 
 open class MockQuery<SelectionSet: RootSelectionSet>: MockOperation<SelectionSet>, GraphQLQuery {

Tests/ApolloPerformanceTests/ParsingPerformanceTests.swift

@@ -79,7 +79,7 @@ class ParsingPerformanceTests: XCTestCase {
     measure {
       subject.intercept(request: request, response: response) { result in
         XCTAssertSuccessResult(result)
-        XCTAssertEqual(try! result.get(), expectedData)
+        XCTAssertEqual(try! result.get()?.rawData, expectedData)
       }
     }
   }