feature: Emit Identifiable conformance on SelectionSets

apollographql · Nov 26, 2024 · b7ef378 · b7ef378
1 parent 2d5365a
commit b7ef378
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 11 deletions.
diff --git a/.../ApolloCodegenTests/CodeGeneration/Templates/SelectionSet/SelectionSetTemplateTests.swift b/.../ApolloCodegenTests/CodeGeneration/Templates/SelectionSet/SelectionSetTemplateTests.swift
@@ -837,6 +837,49 @@ class SelectionSetTemplateTests: XCTestCase {
     // then
     expect(actual).to(equalLineByLine(expected, atLine: 7, ignoringExtraLines: true))
   }
+
+  func test__render_selections__givenFieldWithNonScalarID_doesNotAddIdentifiableConformance() async throws {
+    // given
+    schemaSDL = """
+    type Query {
+      allAnimals: [Animal!]
+    }
+    
+    type ComplexID {
+      first: String!
+      second: String!
+    }
+
+    type Animal {
+      id: ComplexID!
+      name: String
+    }
+    """
+
+    document = """
+    query TestOperation {
+      allAnimals {
+        id { first }
+        name
+      }
+    }
+    """
+
+    let expected = """
+    public struct AllAnimal: TestSchema.SelectionSet {
+    """
+
+    // when
+    try await buildSubjectAndOperation()
+    let allAnimals = try XCTUnwrap(
+      operation[field: "query"]?[field: "allAnimals"]?.selectionSet
+    )
+
+    let actual = subject.test_render(childEntity: allAnimals.computed)
+
+    // then
+    expect(actual).to(equalLineByLine(expected, atLine: 2, ignoringExtraLines: true))
+  }
 
   func test__render_selections__givenEntityFieldWithNameNotMatchingType_rendersFieldSelections() async throws {
     // given
@@ -10601,7 +10644,7 @@ class SelectionSetTemplateTests: XCTestCase {
       public var comments: [Comment]? { __data["comments"] }
 
       /// AllAuthor.PostsInfoById.Awarding.Comment
-      public struct Comment: TestSchema.SelectionSet {
+      public struct Comment: TestSchema.SelectionSet, Identifiable {
     """
 
     let expectedTypeAlias = """
@@ -10697,7 +10740,7 @@ class SelectionSetTemplateTests: XCTestCase {
     public var comments: [Comment]? { __data["comments"] }
 
     /// AllAuthor.PostsInfoById.Awarding.Comment
-    public struct Comment: TestSchema.SelectionSet {
+    public struct Comment: TestSchema.SelectionSet, Identifiable {
       public let __data: DataDict
       public init(_dataDict: DataDict) { __data = _dataDict }
 
@@ -11761,7 +11804,7 @@ class SelectionSetTemplateTests: XCTestCase {
     expect(rendered_allAnimals_deferredAsRoot).to(equalLineByLine(
       """
       /// AllAnimal.Root
-      public struct Root: TestSchema.InlineFragment {
+      public struct Root: TestSchema.InlineFragment, Identifiable {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 
@@ -11813,7 +11856,7 @@ class SelectionSetTemplateTests: XCTestCase {
     expect(rendered_allAnimals_deferredAsRoot).to(equalLineByLine(
       """
       /// AllAnimal.Root
-      public struct Root: TestSchema.InlineFragment {
+      public struct Root: TestSchema.InlineFragment, Identifiable {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 
@@ -11870,7 +11913,7 @@ class SelectionSetTemplateTests: XCTestCase {
     expect(rendered_allAnimals_asDog_deferredAsRoot).to(equalLineByLine(
       """
       /// AllAnimal.AsDog.Root
-      public struct Root: TestSchema.InlineFragment {
+      public struct Root: TestSchema.InlineFragment, Identifiable {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 
@@ -11935,7 +11978,7 @@ class SelectionSetTemplateTests: XCTestCase {
     expect(rendered_allAnimals_asDog_deferredAsOne).to(equalLineByLine(
       """
       /// AllAnimal.AsDog.One
-      public struct One: TestSchema.InlineFragment {
+      public struct One: TestSchema.InlineFragment, Identifiable {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 
@@ -11949,7 +11992,7 @@ class SelectionSetTemplateTests: XCTestCase {
     expect(rendered_allAnimals_asDog_deferredAsTwo).to(equalLineByLine(
       """
       /// AllAnimal.AsDog.Two
-      public struct Two: TestSchema.InlineFragment {
+      public struct Two: TestSchema.InlineFragment, Identifiable {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 
@@ -12021,7 +12064,7 @@ class SelectionSetTemplateTests: XCTestCase {
     expect(rendered_allAnimals_asDog_deferredAsOne).to(equalLineByLine(
       """
       /// AllAnimal.AsDog.One
-      public struct One: TestSchema.InlineFragment {
+      public struct One: TestSchema.InlineFragment, Identifiable {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 
@@ -12035,7 +12078,7 @@ class SelectionSetTemplateTests: XCTestCase {
     expect(rendered_allAnimals_asCat_deferredAsTwo).to(equalLineByLine(
       """
       /// AllAnimal.AsCat.Two
-      public struct Two: TestSchema.InlineFragment {
+      public struct Two: TestSchema.InlineFragment, Identifiable {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 
@@ -12114,7 +12157,7 @@ class SelectionSetTemplateTests: XCTestCase {
     expect(rendered_allAnimals_asDog_deferredAsOuter).to(equalLineByLine(
       """
       /// AllAnimal.AsDog.Outer
-      public struct Outer: TestSchema.InlineFragment {
+      public struct Outer: TestSchema.InlineFragment, Identifiable {
         public let __data: DataDict
         public init(_dataDict: DataDict) { __data = _dataDict }
 

diff --git a/apollo-ios-codegen/Sources/ApolloCodegenLib/Templates/SelectionSetTemplate.swift b/apollo-ios-codegen/Sources/ApolloCodegenLib/Templates/SelectionSetTemplate.swift
@@ -102,7 +102,9 @@ struct SelectionSetTemplate {
       """
       \(SelectionSetNameDocumentation(selectionSet))
       \(renderAccessControl())\
-      struct \(fieldSelectionSetName): \(SelectionSetType()) {
+      struct \(fieldSelectionSetName): \(SelectionSetType())\
+      \(if: selectionSet.isIdentifiable, ", Identifiable")\
+       {
         \(BodyTemplate(context))
       }
       """
@@ -118,6 +120,7 @@ struct SelectionSetTemplate {
       \(renderAccessControl())\
       struct \(inlineFragment.renderedTypeName): \(SelectionSetType(asInlineFragment: true))\
       \(if: inlineFragment.isCompositeInlineFragment, ", \(config.ApolloAPITargetName).CompositeInlineFragment")\
+      \(if: inlineFragment.isIdentifiable, ", Identifiable")\
        {
         \(BodyTemplate(context))
       }

diff --git a/apollo-ios-codegen/Sources/IR/IR+ComputedSelectionSet.swift b/apollo-ios-codegen/Sources/IR/IR+ComputedSelectionSet.swift
@@ -18,6 +18,15 @@ public struct ComputedSelectionSet {
 
   /// The `TypeInfo` for the selection set of the computed selections
   public let typeInfo: IR.SelectionSet.TypeInfo
+
+  /// Indicates if an `id` field is present with a scalar type.
+  public var isIdentifiable: Bool {
+    let idField = direct?.fields["id"] ?? merged.fields["id"]
+    if let type = idField?.type.innerType, case .scalar = type {
+      return true
+    }
+    return false
+  }
 
   // MARK: Dynamic Member Subscript