feature: Generated models support the @defer directive

Tests/ApolloCodegenInternalTestHelpers/IR+Mocking.swift

@@ -95,7 +95,8 @@ extension IR.Operation {
 
   public static func mock(
     definition: CompilationResult.OperationDefinition? = nil,
-    referencedFragments: OrderedSet<IR.NamedFragment> = []
+    referencedFragments: OrderedSet<IR.NamedFragment> = [],
+    hasDeferredFragments: Bool = false
   ) -> IR.Operation {
     let definition = definition ?? .mock()
     return IR.Operation.init(
@@ -114,7 +115,8 @@ extension IR.Operation {
             givenAllTypesInSchema: .init([]))
           ])
       ),
-      referencedFragments: referencedFragments
+      referencedFragments: referencedFragments,
+      hasDeferredFragments: hasDeferredFragments
     )
   }
 

Tests/ApolloCodegenTests/CodeGeneration/Templates/OperationDefinitionTemplateTests.swift

@@ -281,7 +281,129 @@ class OperationDefinitionTemplateTests: XCTestCase {
     expect(actual).to(equalLineByLine(expected, ignoringExtraLines: true))
   }
 
-  // MARK: Selection Set Declaration
+  // MARK: - Defer Properties
+
+  func test__generate__givenQueryWithDeferredInlineFragment_generatesDeferredPropertyTrue() throws {
+    // 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 buildSubjectAndOperation()
+    let actual = renderSubject()
+
+    // then
+    expect(actual).to(equalLineByLine(expected, atLine: 8, ignoringExtraLines: true))
+  }
+
+  func test__generate__givenQueryWithDeferredNamedFragment_generatesDeferredPropertyTrue() throws {
+    // 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 buildSubjectAndOperation()
+    let actual = renderSubject()
+
+    // then
+    expect(actual).to(equalLineByLine(expected, atLine: 9, ignoringExtraLines: true))
+  }
+
+  func test__generate__givenQueryWithNamedFragment_withDeferredTypeCase_generatesDeferredPropertyTrue() throws {
+    // 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 buildSubjectAndOperation()
+    let actual = renderSubject()
+
+    // then
+    expect(actual).to(equalLineByLine(expected, atLine: 9, ignoringExtraLines: true))
+  }
+
+  // MARK: - Selection Set Declaration
 
   func test__generate__givenOperationSelectionSet_rendersDeclaration() throws {
     // given

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

@@ -7071,4 +7071,4 @@ class SelectionSetTemplateTests: XCTestCase {
     expect(actual).to(equalLineByLine(expected, atLine: 6, ignoringExtraLines: true))
   }
 
-}
+}

apollo-ios-codegen/Sources/ApolloCodegenLib/Templates/OperationDefinitionTemplate.swift

@@ -27,6 +27,8 @@ struct OperationDefinitionTemplate: OperationTemplateRenderer {
         accessControlRenderer: { accessControlModifier(for: .member) }()
       ))
 
+      \(section: DeferredProperties(operation.hasDeferredFragments))
+
       \(section: VariableProperties(operation.definition.variables))
 
       \(Initializer(operation.definition.variables))

apollo-ios-codegen/Sources/ApolloCodegenLib/Templates/RenderingHelpers/OperationTemplateRenderer.swift

@@ -53,4 +53,14 @@ extension OperationTemplateRenderer {
       """
   }
 
+  func DeferredProperties(
+    _ hasDeferredFragments: Bool
+  ) -> TemplateString {
+    return """
+      \(if:  hasDeferredFragments, """
+      public static let hasDeferredFragments: Bool = true
+      """)
+      """
+  }
+
 }

apollo-ios-codegen/Sources/GraphQLCompiler/CompilationResult.swift

@@ -164,7 +164,7 @@ public class CompilationResult: JavaScriptObject {
 
     lazy var directives: [Directive]? = self["directives"]
 
-    lazy var isDeferred: IsDeferred = getIsDeferred()
+    public lazy var isDeferred: IsDeferred = getIsDeferred()
 
     public override var debugDescription: String {
       selectionSet.debugDescription

apollo-ios-codegen/Sources/GraphQLCompiler/JavaScript/src/__tests__/referencedFragmentsTests.ts

@@ -25,8 +25,7 @@ describe("operation with referencedFragments", () => {
       ...FragmentA
       ...FragmentC
     }
-    `, "OperationA", { line: 1, column: 1 }),
-    false
+    `, "OperationA", { line: 1, column: 1 })
   );
 
   const fragmentADocument: DocumentNode = parseOperationDocument(
@@ -35,26 +34,23 @@ describe("operation with referencedFragments", () => {
       a
       ...FragmentB
     }
-    `, "FragmentA", { line: 1, column: 1 }),
-    false
+    `, "FragmentA", { line: 1, column: 1 })
   );
 
   const fragmentBDocument: DocumentNode = parseOperationDocument(
     new Source( `
     fragment FragmentB on Query {
       b
     }
-    `, "FragmentB", { line: 1, column: 1 }),
-    false
+    `, "FragmentB", { line: 1, column: 1 })
   );
 
   const fragmentCDocument: DocumentNode = parseOperationDocument(
     new Source( `
     fragment FragmentC on Query {
       c
     }
-    `, "FragmentC", { line: 1, column: 1 }),
-    false
+    `, "FragmentC", { line: 1, column: 1 })
   );
 
   const schema: GraphQLSchema = loadSchemaFromSources([new Source(`
@@ -109,8 +105,7 @@ describe("operation with referencedFragments on child entity selection sets", ()
       }
       ...FragmentC
     }
-    `, "OperationA", { line: 1, column: 1 }),
-    false
+    `, "OperationA", { line: 1, column: 1 })
   );
 
   const fragmentADocument: DocumentNode = parseOperationDocument(
@@ -121,26 +116,23 @@ describe("operation with referencedFragments on child entity selection sets", ()
         ...FragmentB
       }
     }
-    `, "FragmentA", { line: 1, column: 1 }),
-    false
+    `, "FragmentA", { line: 1, column: 1 })
   );
 
   const fragmentBDocument: DocumentNode = parseOperationDocument(
     new Source( `
     fragment FragmentB on B {
       B
     }
-    `, "FragmentB", { line: 1, column: 1 }),
-    false
+    `, "FragmentB", { line: 1, column: 1 })
   );
 
   const fragmentCDocument: DocumentNode = parseOperationDocument(
     new Source( `
     fragment FragmentC on Query {
       c
     }
-    `, "FragmentC", { line: 1, column: 1 }),
-    false
+    `, "FragmentC", { line: 1, column: 1 })
   );
 
   const schema: GraphQLSchema = loadSchemaFromSources([new Source(`
@@ -191,4 +183,4 @@ describe("operation with referencedFragments on child entity selection sets", ()
     expect(fragmentA.referencedFragments).toEqual([fragmentB])
   });
 
-});
+});

apollo-ios-codegen/Sources/IR/IR+EntitySelectionTree.swift

@@ -256,8 +256,7 @@ class EntitySelectionTree {
     fileprivate func scopeConditionNode(for condition: ScopeCondition) -> EntityNode {
       let nodeCondition = ScopeCondition(
         type: condition.type == self.type ? nil : condition.type,
-        conditions: condition.conditions,
-        isDeferred: condition.isDeferred
+        conditions: condition.conditions
       )
 
       func createNode() -> EntityNode {
@@ -408,8 +407,7 @@ extension EntitySelectionTree.EntityNode {
       for conditionGroup in inclusionConditions.elements {
         let scope = ScopeCondition(
           type: rootTypesMatch ? nil : fragmentType,
-          conditions: conditionGroup,
-          isDeferred: fragment.isDeferred
+          conditions: conditionGroup
         )
         let nextNode = rootNodeToStartMerge.scopeConditionNode(for: scope)
 
@@ -424,7 +422,7 @@ extension EntitySelectionTree.EntityNode {
       let nextNode = rootTypesMatch ?
       rootNodeToStartMerge :
       rootNodeToStartMerge.scopeConditionNode(
-        for: ScopeCondition(type: fragmentType, isDeferred: fragment.isDeferred)
+        for: ScopeCondition(type: fragmentType)
       )
 
       nextNode.mergeIn(
@@ -516,8 +514,7 @@ extension EntitySelectionTree.EntityNode {
             entity: entity,
             scopePath: oldFragment.typeInfo.scopePath
           ),
-          inclusionConditions: oldFragment.inclusionConditions,
-          isDeferred: oldFragment.isDeferred
+          inclusionConditions: oldFragment.inclusionConditions
         )
       }
 

apollo-ios-codegen/Sources/IR/IR+InlineFragmentSpread.swift

@@ -5,38 +5,30 @@ public class InlineFragmentSpread: Hashable, CustomDebugStringConvertible {
   /// enclosing operation/fragment.
   public let selectionSet: SelectionSet
 
-  public let isDeferred: IsDeferred
-
   /// Indicates the location where the inline fragment has been "spread into" its enclosing
   /// operation/fragment.
   public var typeInfo: SelectionSet.TypeInfo { selectionSet.typeInfo }
 
   public var inclusionConditions: InclusionConditions? { selectionSet.inclusionConditions }
 
-  init(
-    selectionSet: SelectionSet,
-    isDeferred: IsDeferred
-  ) {
+  init(selectionSet: SelectionSet) {
     self.selectionSet = selectionSet
-    self.isDeferred = isDeferred
   }
 
   public static func == (lhs: InlineFragmentSpread, rhs: InlineFragmentSpread) -> Bool {
-    lhs.selectionSet == rhs.selectionSet &&
-    lhs.isDeferred == rhs.isDeferred
+    lhs.selectionSet == rhs.selectionSet
   }
 
   public func hash(into hasher: inout Hasher) {
     hasher.combine(selectionSet)
-    hasher.combine(isDeferred)
   }
 
   public var debugDescription: String {
     var string = typeInfo.parentType.debugDescription
     if let conditions = typeInfo.inclusionConditions {
       string += " \(conditions.debugDescription)"
     }
-    string += isDeferred.definitionDirectiveDescription
+
     return string
   }
 }

apollo-ios-codegen/Sources/IR/IR+IsDeferred.swift

@@ -1,3 +1,5 @@
+import GraphQLCompiler
+
 // TODO: Documentation for this to be completed in issue #3141
 public enum IsDeferred: Hashable, ExpressibleByBooleanLiteral {
   case value(Bool)
@@ -12,6 +14,16 @@ public enum IsDeferred: Hashable, ExpressibleByBooleanLiteral {
     }
   }
 
+  init(_ compilationResult: CompilationResult.IsDeferred) {
+    switch compilationResult {
+    case let .value(value):
+      self = .value(value)
+
+    case let .variable(variable):
+      self = .if(variable)
+    }
+  }
+
   var definitionDirectiveDescription: String {
     switch self {
     case .value(false): return ""