Squashed 'apollo-ios-codegen/' changes from 3537e4961..a4e90970f

gh-action-runner · gh-action-runner · commit 53e710207449 · 2025-10-09T20:19:06.000Z
a4e90970f Remove SPI from internal models (#796) git-subtree-dir: apollo-ios-codegen git-subtree-split: a4e90970fa0a1117dd505eaabb7f8265af49fe8f
diff --git a/Sources/ApolloCodegenLib/Templates/AccessControlRenderer.swift b/Sources/ApolloCodegenLib/Templates/AccessControlRenderer.swift
@@ -0,0 +1,115 @@
+import Foundation
+
+/// The @_spi values used by Apollo iOS
+enum SPI {
+  case Unsafe
+  case Internal
+  case Execution
+}
+
+struct AccessControlRenderer {
+
+  enum Scope {
+    case namespace
+    case parent
+    case member
+  }
+
+  private let accessModifier: ApolloCodegenConfiguration.AccessModifier?
+
+  init(
+    target: TemplateTarget,
+    config: ApolloCodegenConfiguration,
+    scope: Scope
+  ) {
+    self.accessModifier = Self.accessControlModifier(target: target, config: config, scope: scope)
+  }
+
+  func render(withSPIs spis: [SPI] = []) -> String {
+    var string = accessModifier?.swiftString ?? ""
+
+    guard shouldIncludeSPI else { return string }
+
+    for spi in spis.reversed() {
+      string = "@_spi(\(spi)) " + string
+    }
+    return string
+  }
+
+  /// SPI should only be used on public declarations. Internal declarations must omit them.
+  private var shouldIncludeSPI: Bool {
+    accessModifier == .public
+  }
+
+  private static func accessControlModifier(
+    target: TemplateTarget,
+    config: ApolloCodegenConfiguration,
+    scope: Scope
+  ) -> ApolloCodegenConfiguration.AccessModifier? {
+    switch target {
+    case .moduleFile, .schemaFile: return schemaAccessControlModifier(scope, config)
+    case .operationFile: return operationAccessControlModifier(scope, config)
+    case .testMockFile: return testMockAccessControlModifier(scope, config)
+    }
+  }
+
+  private static func schemaAccessControlModifier(
+    _ scope: Scope,
+    _ config: ApolloCodegenConfiguration,
+  ) -> ApolloCodegenConfiguration.AccessModifier? {
+    switch (config.output.schemaTypes.moduleType, scope) {
+    case (.embeddedInTarget, .parent):
+      return nil
+    case (.embeddedInTarget(_, .public), .namespace),
+      (.embeddedInTarget(_, .public), .member):
+      return .public
+    case (.embeddedInTarget(_, .internal), .namespace),
+      (.embeddedInTarget(_, .internal), .member):
+      return .internal
+    case (.swiftPackage, _),
+      (.other, _):
+      return .public
+    }
+  }
+
+  private static func operationAccessControlModifier(
+    _ scope: Scope,
+    _ config: ApolloCodegenConfiguration,
+  ) -> ApolloCodegenConfiguration.AccessModifier? {
+    switch (config.output.operations, scope) {
+    case (.inSchemaModule, _):
+      return schemaAccessControlModifier(scope, config)
+    case (.absolute(_, .public), _),
+      (.relative(_, .public), _):
+      return .public
+    case (.absolute(_, .internal), _),
+      (.relative(_, .internal), _):
+      return .internal
+    }
+  }
+
+  private static func testMockAccessControlModifier(
+    _ scope: Scope,
+    _ config: ApolloCodegenConfiguration,
+  ) -> ApolloCodegenConfiguration.AccessModifier? {
+    switch (config.output.testMocks, scope) {
+    case (.none, _):
+      return nil
+    case (.absolute(_, .internal), _):
+      return .internal
+    case (.swiftPackage, _),
+      (.absolute(_, .public), _):
+      return .public
+    }
+  }
+
+}
+
+fileprivate extension ApolloCodegenConfiguration.AccessModifier {
+  var swiftString: String {
+    switch self {
+    case .public: return "public "
+    case .internal: return ""
+    }
+  }
+}
diff --git a/Sources/ApolloCodegenLib/Templates/CustomScalarTemplate.swift b/Sources/ApolloCodegenLib/Templates/CustomScalarTemplate.swift
@@ -27,7 +27,7 @@ struct CustomScalarTemplate: TemplateRenderer {
     """
     \(documentation: documentationTemplate, config: config)
     \(graphqlScalar.name.typeNameDocumentation)
-    \(accessControlModifier(for: .parent))\
+    \(accessControlRenderer(for: .parent).render())\
     typealias \(graphqlScalar.render(as: .typename())) = String
     
     """
diff --git a/Sources/ApolloCodegenLib/Templates/EnumTemplate.swift b/Sources/ApolloCodegenLib/Templates/EnumTemplate.swift
@@ -19,7 +19,7 @@ struct EnumTemplate: TemplateRenderer {
     """
     \(documentation: graphqlEnum.documentation, config: config)
     \(graphqlEnum.name.typeNameDocumentation)
-    \(accessControlModifier(for: .parent))\
+    \(accessControlRenderer(for: .parent).render())\
     enum \(graphqlEnum.render(as: .typename())): String, EnumType {
       \(graphqlEnum.values.compactMap({
         enumCase(for: $0)
diff --git a/Sources/ApolloCodegenLib/Templates/FragmentTemplate.swift b/Sources/ApolloCodegenLib/Templates/FragmentTemplate.swift
@@ -18,16 +18,16 @@ struct FragmentTemplate: TemplateRenderer {
     nonFatalErrorRecorder: ApolloCodegen.NonFatalError.Recorder
   ) -> TemplateString {
     let includeDefinition = config.options.operationDocumentFormat.contains(.definition)
-    
+    let memberAccessControlRenderer = accessControlRenderer(for: .member)
     return TemplateString(
     """
-    \(accessControlModifier(for: .parent))\
+    \(accessControlRenderer(for: .parent).render())\
     struct \(fragment.generatedDefinitionName.asFragmentName): \
     \(fragment.renderedSelectionSetType(config)), Fragment\
     \(if: fragment.isIdentifiable, ", Identifiable")\
      {
     \(if: includeDefinition, """
-      \(accessControlModifier(for: .member))\
+      \(memberAccessControlRenderer.render())\
     static var fragmentDefinition: StaticString {
         #"\(fragment.definition.source.convertedToSingleLine())"#
       }
@@ -38,7 +38,7 @@ struct FragmentTemplate: TemplateRenderer {
         generateInitializers: config.config.shouldGenerateSelectionSetInitializers(for: fragment),
         config: config,
         nonFatalErrorRecorder: nonFatalErrorRecorder,
-        renderAccessControl: { accessControlModifier(for: .member) }()
+        accessControlRenderer: memberAccessControlRenderer
       ).renderBody())
     }
 
diff --git a/Sources/ApolloCodegenLib/Templates/InputObjectTemplate.swift b/Sources/ApolloCodegenLib/Templates/InputObjectTemplate.swift
@@ -16,22 +16,22 @@ struct InputObjectTemplate: TemplateRenderer {
     nonFatalErrorRecorder: ApolloCodegen.NonFatalError.Recorder
   ) -> TemplateString {
     let (validFields, deprecatedFields) = graphqlInputObject.fields.filterFields()
-    let memberAccessControl = accessControlModifier(for: .member)
+    let memberAccessControl = accessControlRenderer(for: .member)
 
     return TemplateString(
     """
     \(documentation: graphqlInputObject.documentation, config: config)
     \(graphqlInputObject.name.typeNameDocumentation)
-    \(accessControlModifier(for: .parent))\
+    \(accessControlRenderer(for: .parent).render())\
     struct \(graphqlInputObject.render(as: .typename())): InputObject {
-      @_spi(Unsafe) \(memberAccessControl)private(set) var __data: InputDict
+      \(memberAccessControl.render(withSPIs: [.Unsafe]))private(set) var __data: InputDict
     
-      @_spi(Unsafe) \(memberAccessControl)init(_ data: InputDict) {
+      \(memberAccessControl.render(withSPIs: [.Unsafe]))init(_ data: InputDict) {
         __data = data
       }
 
       \(if: !deprecatedFields.isEmpty && !validFields.isEmpty && shouldIncludeDeprecatedWarnings, """
-      \(memberAccessControl)init(
+      \(memberAccessControl.render())init(
         \(InitializerParametersTemplate(validFields))
       ) {
         __data = InputDict([
@@ -44,7 +44,7 @@ struct InputObjectTemplate: TemplateRenderer {
       \(if: !deprecatedFields.isEmpty && shouldIncludeDeprecatedWarnings, """
       @available(*, deprecated, message: "\(deprecatedMessage(for: deprecatedFields))")
       """)
-      \(memberAccessControl)init(
+      \(memberAccessControl.render())init(
         \(InitializerParametersTemplate(graphqlInputObject.fields))
       ) {
         __data = InputDict([
@@ -104,7 +104,7 @@ struct InputObjectTemplate: TemplateRenderer {
     \(documentation: field.documentation, config: config)
     \(deprecationReason: field.deprecationReason, config: config)
     \(field.name.typeNameDocumentation)
-    \(accessControlModifier(for: .member))\
+    \(accessControlRenderer(for: .member).render())\
     var \(field.render(config: config)): \(field.renderInputValueType(config: config.config)) {
       get { __data["\(field.name.schemaName)"] }
       set { __data["\(field.name.schemaName)"] = newValue }
diff --git a/Sources/ApolloCodegenLib/Templates/LocalCacheMutationDefinitionTemplate.swift b/Sources/ApolloCodegenLib/Templates/LocalCacheMutationDefinitionTemplate.swift
@@ -15,11 +15,12 @@ struct LocalCacheMutationDefinitionTemplate: OperationTemplateRenderer {
   func renderBodyTemplate(
     nonFatalErrorRecorder: ApolloCodegen.NonFatalError.Recorder
   ) -> TemplateString {
-    let memberAccessControl = accessControlModifier(for: .member)
+    let memberAccessControlRenderer = accessControlRenderer(for: .member)
+    let memberAccessControl = memberAccessControlRenderer.render()
 
     return TemplateString(
     """
-    \(accessControlModifier(for: .parent))\
+    \(accessControlRenderer(for: .parent).render())\
     struct \(operation.generatedDefinitionName): LocalCacheMutation {
       \(memberAccessControl)static let operationType: GraphQLOperationType = .\(operation.definition.operationType.rawValue)
 
@@ -35,7 +36,7 @@ struct LocalCacheMutationDefinitionTemplate: OperationTemplateRenderer {
             generateInitializers: config.config.shouldGenerateSelectionSetInitializers(for: operation),
             config: config,
             nonFatalErrorRecorder: nonFatalErrorRecorder,
-            renderAccessControl: { accessControlModifier(for: .member) }()
+            accessControlRenderer: memberAccessControlRenderer
         ).renderBody())
       }
     }
diff --git a/Sources/ApolloCodegenLib/Templates/MockInterfacesTemplate.swift b/Sources/ApolloCodegenLib/Templates/MockInterfacesTemplate.swift
@@ -15,7 +15,7 @@ struct MockInterfacesTemplate: TemplateRenderer {
     nonFatalErrorRecorder: ApolloCodegen.NonFatalError.Recorder
   ) -> TemplateString {
     TemplateString("""
-    \(accessControlModifier(for: .parent))extension MockObject {
+    \(accessControlRenderer(for: .parent).render())extension MockObject {
       \(graphqlInterfaces.map {
       "typealias \($0.render(as: .typename())) = Interface"
       }, separator: "\n")
diff --git a/Sources/ApolloCodegenLib/Templates/MockObjectTemplate.swift b/Sources/ApolloCodegenLib/Templates/MockObjectTemplate.swift
@@ -51,10 +51,11 @@ struct MockObjectTemplate: TemplateRenderer {
          )
       }
 
-    let memberAccessControl = accessControlModifier(for: .member)
+    let memberAccessControl = accessControlRenderer(for: .member).render()
+    let parentAccessControl = accessControlRenderer(for: .parent).render()
 
     return """
-    \(accessControlModifier(for: .parent))final class \(objectName): MockObject {
+    \(parentAccessControl)final class \(objectName): MockObject {
       \(memberAccessControl)static let objectType: \(TemplateConstants.ApolloAPITargetName).Object = \(config.schemaNamespace.firstUppercased).Objects.\(objectName)
       \(memberAccessControl)static let _mockFields = MockFields()
       \(memberAccessControl)typealias MockValueCollectionType = Array<Mock<\(objectName)>>
@@ -71,7 +72,7 @@ struct MockObjectTemplate: TemplateRenderer {
     \(!fields.isEmpty ?
       TemplateString("""
       
-      \(accessControlModifier(for: .parent))\
+      \(parentAccessControl)\
       extension Mock where O == \(objectName) {
         \(conflictingFieldNameProperties(fields))
         convenience init(
diff --git a/Sources/ApolloCodegenLib/Templates/MockUnionsTemplate.swift b/Sources/ApolloCodegenLib/Templates/MockUnionsTemplate.swift
@@ -15,7 +15,7 @@ struct MockUnionsTemplate: TemplateRenderer {
     nonFatalErrorRecorder: ApolloCodegen.NonFatalError.Recorder
   ) -> TemplateString {
     TemplateString("""
-    \(accessControlModifier(for: .parent))extension MockObject {
+    \(accessControlRenderer(for: .parent).render())extension MockObject {
       \(graphqlUnions.map {
       "typealias \($0.render(as: .typename())) = Union"
       }, separator: "\n")
diff --git a/Sources/ApolloCodegenLib/Templates/OneOfInputObjectTemplate.swift b/Sources/ApolloCodegenLib/Templates/OneOfInputObjectTemplate.swift
@@ -13,17 +13,17 @@ struct OneOfInputObjectTemplate: TemplateRenderer {
   func renderBodyTemplate(
     nonFatalErrorRecorder: ApolloCodegen.NonFatalError.Recorder
   ) -> TemplateString {
-    let memberAccessControl = accessControlModifier(for: .member)
+    let memberAccessControl = accessControlRenderer(for: .member)
     
     return TemplateString(
     """
     \(documentation: graphqlInputObject.documentation, config: config)
     \(graphqlInputObject.name.typeNameDocumentation)
-    \(accessControlModifier(for: .parent))\
+    \(accessControlRenderer(for: .parent).render())\
     enum \(graphqlInputObject.render(as: .typename())): OneOfInputObject {
       \(graphqlInputObject.fields.map({ "\(FieldCaseTemplate($1))" }), separator: "\n")
     
-      @_spi(Unsafe) \(memberAccessControl)var __data: InputDict {
+      \(memberAccessControl.render(withSPIs: [.Unsafe]))var __data: InputDict {
         switch self {
         \(graphqlInputObject.fields.map({ "\(FieldCaseDataTemplate($1))" }), separator: "\n")
         }
diff --git a/Sources/ApolloCodegenLib/Templates/OperationDefinitionTemplate.swift b/Sources/ApolloCodegenLib/Templates/OperationDefinitionTemplate.swift
@@ -18,6 +18,22 @@ struct OperationDefinitionTemplate: OperationTemplateRenderer {
     .operationFile(moduleImports: operation.definition.moduleImports)
   }
 
+  private var accessControl: (member: AccessControlRenderer, parent: AccessControlRenderer)!
+
+  init(
+    operation: IR.Operation,
+    operationIdentifier: String?,
+    config: ApolloCodegen.ConfigurationContext,
+  ) {
+    self.operation = operation
+    self.operationIdentifier = operationIdentifier
+    self.config = config
+    self.accessControl = (
+      member: accessControlRenderer(for: .member),
+      parent: accessControlRenderer(for: .parent)
+    )
+  }
+
   func renderBodyTemplate(
     nonFatalErrorRecorder: ApolloCodegen.NonFatalError.Recorder
   ) -> TemplateString {
@@ -32,20 +48,20 @@ struct OperationDefinitionTemplate: OperationTemplateRenderer {
 
       \(section: VariableAccessors(operation.definition.variables))
 
-      \(accessControlModifier(for: .member))struct Data: \(operation.renderedSelectionSetType(config)) {
+      \(accessControl.member.render())struct Data: \(operation.renderedSelectionSetType(config)) {
         \(SelectionSetTemplate(
             definition: operation,
             generateInitializers: config.config.shouldGenerateSelectionSetInitializers(for: operation),
             config: config,
             nonFatalErrorRecorder: nonFatalErrorRecorder,
-            renderAccessControl: { accessControlModifier(for: .member) }()
+            accessControlRenderer: accessControl.member
         ).renderBody())
       }
     
       \(section: DeferredFragmentsMetadataTemplate(
         operation: operation,
         config: config,
-        renderAccessControl: { accessControlModifier(for: .parent) }()
+        renderAccessControl: { accessControl.parent.render() }()
       ).render())
     }
 
@@ -54,10 +70,10 @@ struct OperationDefinitionTemplate: OperationTemplateRenderer {
     
   private func OperationDeclaration() -> TemplateString {
     return """
-    \(accessControlModifier(for: .parent))\
+    \(accessControl.parent.render())\
     struct \(operation.generatedDefinitionName): \
     \(operation.definition.operationType.renderedProtocolName) {
-      \(accessControlModifier(for: .member))\
+      \(accessControl.member.render())\
     static let operationName: String = "\(operation.definition.name)"
     """
   }
@@ -67,7 +83,7 @@ struct OperationDefinitionTemplate: OperationTemplateRenderer {
     let includeDefinition = config.options.operationDocumentFormat.contains(.definition)
 
     return TemplateString("""
-      \(accessControlModifier(for: .member))\
+      \(accessControl.member.render())\
       static let operationDocument: \(TemplateConstants.ApolloAPITargetName).OperationDocument = .init(
       \(if: config.options.operationDocumentFormat.contains(.operationId), {
         precondition(operationIdentifier != nil, "operationIdentifier is missing.")
diff --git a/Sources/ApolloCodegenLib/Templates/SchemaConfigurationTemplate.swift b/Sources/ApolloCodegenLib/Templates/SchemaConfigurationTemplate.swift
@@ -22,9 +22,9 @@ struct SchemaConfigurationTemplate: TemplateRenderer {
     nonFatalErrorRecorder: ApolloCodegen.NonFatalError.Recorder
   ) -> TemplateString {
     return """
-    \(accessControlModifier(for: .parent))enum SchemaConfiguration: \
+    \(accessControlRenderer(for: .parent).render())enum SchemaConfiguration: \
     \(TemplateConstants.ApolloAPITargetName).SchemaConfiguration {
-      \(accessControlModifier(for: .member))\
+      \(accessControlRenderer(for: .member).render())\
     static func cacheKeyInfo(for type: \(TemplateConstants.ApolloAPITargetName).Object, object: \(TemplateConstants.ApolloAPITargetName).ObjectData) -> CacheKeyInfo? {
         // Implement this function to configure cache key resolution for your schema types.
         return nil
diff --git a/Sources/ApolloCodegenLib/Templates/SchemaMetadataTemplate.swift b/Sources/ApolloCodegenLib/Templates/SchemaMetadataTemplate.swift
diff --git a/Sources/ApolloCodegenLib/Templates/SchemaModuleNamespaceTemplate.swift b/Sources/ApolloCodegenLib/Templates/SchemaModuleNamespaceTemplate.swift
diff --git a/Sources/ApolloCodegenLib/Templates/SelectionSetTemplate.swift b/Sources/ApolloCodegenLib/Templates/SelectionSetTemplate.swift
diff --git a/Sources/ApolloCodegenLib/Templates/TemplateRenderer.swift b/Sources/ApolloCodegenLib/Templates/TemplateRenderer.swift
