Squashed 'apollo-ios-codegen/' changes from 163d398c..d689a45f

d689a45f feature: Reduce Generated Schema Types (#601)

git-subtree-dir: apollo-ios-codegen
git-subtree-split: d689a45f6ddd527fc77d8f62a7f2f0ad66b8d2f7

Author: gh-action-runner

Sources/ApolloCodegenLib/ApolloCodegen.swift

@@ -191,6 +191,7 @@ public class ApolloCodegen {
       document: operationsDocument,
       experimentalLegacySafelistingCompatibleOperations:
         config.experimentalFeatures.legacySafelistingCompatibleOperations,
+      reduceGeneratedSchemaTypes: config.options.reduceGeneratedSchemaTypes,
       validationOptions: validationOptions
     )
   }

Sources/ApolloCodegenLib/CodegenConfiguration/ApolloCodegenConfiguration.swift

@@ -652,6 +652,8 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {
     public let operationDocumentFormat: OperationDocumentFormat
     /// Customization options to be applied to the schema during code generation.
     public let schemaCustomization: SchemaCustomization
+    /// Whether to reduce the number of schema types that are generated to only those that are referenced in an operation.
+    public let reduceGeneratedSchemaTypes: Bool
     /// Generate import statements that are compatible with including `Apollo` via Cocoapods.
     ///
     /// Cocoapods bundles all files from subspecs into the main target for a pod. This means that
@@ -703,6 +705,7 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {
       public static let fieldMerging: FieldMerging = [.all]
       public static let operationDocumentFormat: OperationDocumentFormat = .definition
       public static let schemaCustomization: SchemaCustomization = .init()
+      public static let reduceGeneratedSchemaTypes: Bool = false
       public static let cocoapodsCompatibleImportStatements: Bool = false
       public static let warningsOnDeprecatedUsage: Composition = .include
       public static let conversionStrategies: ConversionStrategies = .init()
@@ -721,6 +724,8 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {
     ///   - selectionSetInitializers: Which generated selection sets should include
     ///     generated initializers.
     ///   - operationDocumentFormat: How to generate the operation documents for your generated operations.
+    ///   - schemaCustomization: Customization options to be applied to the schema during code generation.
+    ///   - reduceGeneratedSchemaTypes: Whether to reduce the number of schema types that are generated to only those that are referenced in an operation.
     ///   - cocoapodsCompatibleImportStatements: Generate import statements that are compatible with
     ///     including `Apollo` via Cocoapods.
     ///   - warningsOnDeprecatedUsage: Annotate generated Swift code with the Swift `available`
@@ -741,6 +746,7 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {
       selectionSetInitializers: SelectionSetInitializers = Default.selectionSetInitializers,
       operationDocumentFormat: OperationDocumentFormat = Default.operationDocumentFormat,
       schemaCustomization: SchemaCustomization = Default.schemaCustomization,
+      reduceGeneratedSchemaTypes: Bool = Default.reduceGeneratedSchemaTypes,
       cocoapodsCompatibleImportStatements: Bool = Default.cocoapodsCompatibleImportStatements,
       warningsOnDeprecatedUsage: Composition = Default.warningsOnDeprecatedUsage,
       conversionStrategies: ConversionStrategies = Default.conversionStrategies,
@@ -754,6 +760,7 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {
       self.selectionSetInitializers = selectionSetInitializers
       self.operationDocumentFormat = operationDocumentFormat
       self.schemaCustomization = schemaCustomization
+      self.reduceGeneratedSchemaTypes = reduceGeneratedSchemaTypes
       self.cocoapodsCompatibleImportStatements = cocoapodsCompatibleImportStatements
       self.warningsOnDeprecatedUsage = warningsOnDeprecatedUsage
       self.conversionStrategies = conversionStrategies
@@ -773,6 +780,7 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {
       case apqs
       case operationDocumentFormat
       case schemaCustomization
+      case reduceGeneratedSchemaTypes
       case cocoapodsCompatibleImportStatements
       case warningsOnDeprecatedUsage
       case conversionStrategies
@@ -819,6 +827,11 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {
         SchemaCustomization.self,
         forKey: .schemaCustomization
       ) ?? Default.schemaCustomization
+      
+      reduceGeneratedSchemaTypes = try values.decodeIfPresent(
+        Bool.self,
+        forKey: .reduceGeneratedSchemaTypes
+      ) ?? Default.reduceGeneratedSchemaTypes
 
       cocoapodsCompatibleImportStatements = try values.decodeIfPresent(
         Bool.self,
@@ -860,6 +873,7 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {
       try container.encode(self.selectionSetInitializers, forKey: .selectionSetInitializers)
       try container.encode(self.operationDocumentFormat, forKey: .operationDocumentFormat)
       try container.encode(self.schemaCustomization, forKey: .schemaCustomization)
+      try container.encode(self.reduceGeneratedSchemaTypes, forKey: .reduceGeneratedSchemaTypes)
       try container.encode(self.cocoapodsCompatibleImportStatements, forKey: .cocoapodsCompatibleImportStatements)
       try container.encode(self.warningsOnDeprecatedUsage, forKey: .warningsOnDeprecatedUsage)
       try container.encode(self.conversionStrategies, forKey: .conversionStrategies)
@@ -1697,6 +1711,62 @@ extension ApolloCodegenConfiguration.FileOutput {
 }
 
 extension ApolloCodegenConfiguration.OutputOptions {
+  /// Deprecated initializer.
+  ///
+  /// - Parameters:
+  ///   - additionalInflectionRules: Any non-default rules for pluralization or singularization
+  ///   you wish to include.
+  ///   - deprecatedEnumCases: How deprecated enum cases from the schema should be handled.
+  ///   - schemaDocumentation: Whether schema documentation is added to the generated files.
+  ///   - selectionSetInitializers: Which generated selection sets should include
+  ///     generated initializers.
+  ///   - operationDocumentFormat: How to generate the operation documents for your generated operations.
+  ///   - cocoapodsCompatibleImportStatements: Generate import statements that are compatible with
+  ///     including `Apollo` via Cocoapods.
+  ///   - warningsOnDeprecatedUsage: Annotate generated Swift code with the Swift `available`
+  ///     attribute and `deprecated` argument for parts of the GraphQL schema annotated with the
+  ///     built-in `@deprecated` directive.
+  ///   - conversionStrategies: Rules for how to convert the names of values from the schema in
+  ///     generated code.
+  ///   - pruneGeneratedFiles: Whether unused generated files will be automatically deleted.
+  ///   - markOperationDefinitionsAsFinal: Whether generated GraphQL operation and local cache mutation
+  ///     class types will be marked as `final`.
+  ///   - appendSchemaTypeFilenameSuffix: `true` will add a filename suffix matching the schema type, the
+  ///     default is `false`. This can be used to avoid filename conflicts when operation type names match
+  ///     schema type names.
+  ///
+  @available(*, deprecated,
+              renamed: "init(additionalInflectionRules:queryStringLiteralFormat:deprecatedEnumCases:schemaDocumentation:selectionSetInitializers:operationDocumentFormat:schemaCustomization:reduceGeneratedSchemaTypes:cocoapodsCompatibleImportStatements:warningsOnDeprecatedUsage:conversionStrategies:pruneGeneratedFiles:markOperationDefinitionsAsFinal:appendSchemaTypeFilenameSuffix:)"
+  )
+  public init(
+    additionalInflectionRules: [InflectionRule] = Default.additionalInflectionRules,
+    deprecatedEnumCases: ApolloCodegenConfiguration.Composition = Default.deprecatedEnumCases,
+    schemaDocumentation: ApolloCodegenConfiguration.Composition = Default.schemaDocumentation,
+    selectionSetInitializers: ApolloCodegenConfiguration.SelectionSetInitializers = Default.selectionSetInitializers,
+    operationDocumentFormat: ApolloCodegenConfiguration.OperationDocumentFormat = Default.operationDocumentFormat,
+    schemaCustomization: ApolloCodegenConfiguration.SchemaCustomization = Default.schemaCustomization,
+    cocoapodsCompatibleImportStatements: Bool = Default.cocoapodsCompatibleImportStatements,
+    warningsOnDeprecatedUsage: ApolloCodegenConfiguration.Composition = Default.warningsOnDeprecatedUsage,
+    conversionStrategies: ApolloCodegenConfiguration.ConversionStrategies = Default.conversionStrategies,
+    pruneGeneratedFiles: Bool = Default.pruneGeneratedFiles,
+    markOperationDefinitionsAsFinal: Bool = Default.markOperationDefinitionsAsFinal,
+    appendSchemaTypeFilenameSuffix: Bool = Default.appendSchemaTypeFilenameSuffix
+  ) {
+    self.additionalInflectionRules = additionalInflectionRules
+    self.deprecatedEnumCases = deprecatedEnumCases
+    self.schemaDocumentation = schemaDocumentation
+    self.selectionSetInitializers = selectionSetInitializers
+    self.operationDocumentFormat = operationDocumentFormat
+    self.schemaCustomization = schemaCustomization
+    self.reduceGeneratedSchemaTypes = Default.reduceGeneratedSchemaTypes
+    self.cocoapodsCompatibleImportStatements = cocoapodsCompatibleImportStatements
+    self.warningsOnDeprecatedUsage = warningsOnDeprecatedUsage
+    self.conversionStrategies = conversionStrategies
+    self.pruneGeneratedFiles = pruneGeneratedFiles
+    self.markOperationDefinitionsAsFinal = markOperationDefinitionsAsFinal
+    self.appendSchemaTypeFilenameSuffix = appendSchemaTypeFilenameSuffix
+  }
+  
   /// Deprecated initializer.
   ///
   /// - Parameters:
@@ -1746,6 +1816,7 @@ extension ApolloCodegenConfiguration.OutputOptions {
     self.markOperationDefinitionsAsFinal = markOperationDefinitionsAsFinal
     self.schemaCustomization = Default.schemaCustomization
     self.appendSchemaTypeFilenameSuffix = Default.appendSchemaTypeFilenameSuffix
+    self.reduceGeneratedSchemaTypes = Default.reduceGeneratedSchemaTypes
   }
 
   /// Deprecated initializer.
@@ -1797,6 +1868,7 @@ extension ApolloCodegenConfiguration.OutputOptions {
     self.markOperationDefinitionsAsFinal = markOperationDefinitionsAsFinal
     self.schemaCustomization = Default.schemaCustomization
     self.appendSchemaTypeFilenameSuffix = Default.appendSchemaTypeFilenameSuffix
+    self.reduceGeneratedSchemaTypes = Default.reduceGeneratedSchemaTypes
   }
 
   /// Whether the generated operations should use Automatic Persisted Queries.

Sources/ApolloCodegenLib/Templates/InterfaceTemplate.swift

@@ -18,7 +18,11 @@ struct InterfaceTemplate: TemplateRenderer {
     """
     \(documentation: graphqlInterface.documentation, config: config)
     \(graphqlInterface.name.typeNameDocumentation)
-    static let \(graphqlInterface.render(as: .typename)) = \(config.ApolloAPITargetName).Interface(name: "\(graphqlInterface.name.schemaName)", keyFields: \(KeyFieldsTemplate()))
+    static let \(graphqlInterface.render(as: .typename)) = \(config.ApolloAPITargetName).Interface(
+      name: "\(graphqlInterface.name.schemaName)",
+      keyFields: \(KeyFieldsTemplate()),
+      implementingObjects: \(ImplementingObjectsTemplate())
+    )
     """
   }
 
@@ -29,4 +33,14 @@ struct InterfaceTemplate: TemplateRenderer {
     [\(list: fields.map { "\"\($0)\"" })]
     """
   }
+  
+  private func ImplementingObjectsTemplate() -> TemplateString {
+    return """
+    [\(list: graphqlInterface.implementingObjects.map({ object in
+          TemplateString("""
+          "\(object.render(as: .typename))"
+          """)
+      }))]
+    """
+  }
 }

Sources/GraphQLCompiler/ApolloCodegenFrontendBundle.swift

@@ -91,13 +91,15 @@ public final class GraphQLJSFrontend {
     schema: GraphQLSchema,
     document: GraphQLDocument,
     experimentalLegacySafelistingCompatibleOperations: Bool = false,
+    reduceGeneratedSchemaTypes: Bool,
     validationOptions: ValidationOptions
   ) async throws -> CompilationResult {
     return try await library.call(
       "compileDocument",
       with: schema,
       document,
       experimentalLegacySafelistingCompatibleOperations,
+      reduceGeneratedSchemaTypes,
       ValidationOptions.Bridged(from: validationOptions, bridge: self.bridge)
     )
   }

Sources/GraphQLCompiler/GraphQLJSFrontend.swift

@@ -281,18 +281,22 @@ public final class GraphQLInterfaceType: GraphQLAbstractType, GraphQLInterfaceIm
   public private(set) var interfaces: [GraphQLInterfaceType]!
 
   public private(set) var keyFields: [String]!
+  
+  public private(set) var implementingObjects: [GraphQLObjectType]!
 
   /// Initializer to be used for creating mock objects in tests only.
   init(
     name: GraphQLName,
     documentation: String?,
     fields: [String: GraphQLField],
     interfaces: [GraphQLInterfaceType],
-    keyFields: [String]
+    keyFields: [String],
+    implementingObjects: [GraphQLObjectType]
   ) {
     self.fields = fields
     self.interfaces = interfaces
     self.keyFields = keyFields
+    self.implementingObjects = implementingObjects
     super.init(name: name, documentation: documentation)
   }
 
@@ -304,6 +308,7 @@ public final class GraphQLInterfaceType: GraphQLAbstractType, GraphQLInterfaceIm
     self.fields = try! bridge.invokeMethod("getFields", on: jsValue)
     self.interfaces = try! bridge.invokeMethod("getInterfaces", on: jsValue)
     self.keyFields = jsValue["_apolloKeyFields"]
+    self.implementingObjects = jsValue["_implementingObjects"].isUndefined ? [] :  Array<GraphQLObjectType>.fromJSValue(jsValue["_implementingObjects"], bridge: bridge)
   }
 
   public override var debugDescription: String {

Sources/GraphQLCompiler/GraphQLSchema.swift

@@ -210,7 +210,7 @@ describe("given SDL with valid defer directive", () => {
     );
 
     it("should compile inline fragment with directive", () => {
-      const compilationResult: CompilationResult = compileDocument(schema, document, false, emptyValidationOptions);
+      const compilationResult: CompilationResult = compileDocument(schema, document, false, false, emptyValidationOptions);
       const operation = compilationResult.operations[0];
       const allAnimals = operation.selectionSet.selections[0] as Field;
       const inlineFragment = allAnimals?.selectionSet?.selections?.[0] as InlineFragment;
@@ -237,7 +237,7 @@ describe("given SDL with valid defer directive", () => {
     );
 
     it("should compile inline fragment with directive and arguments", () => {
-      const compilationResult: CompilationResult = compileDocument(schema, document, false, emptyValidationOptions);
+      const compilationResult: CompilationResult = compileDocument(schema, document, false, false, emptyValidationOptions);
       const operation = compilationResult.operations[0];
       const allAnimals = operation.selectionSet.selections[0] as Field;
       const inlineFragment = allAnimals?.selectionSet?.selections?.[0] as InlineFragment;
@@ -270,7 +270,7 @@ describe("given SDL with valid defer directive", () => {
     );
 
     it("should compile fragment spread with directive", () => {
-      const compilationResult: CompilationResult = compileDocument(schema, document, false, emptyValidationOptions);
+      const compilationResult: CompilationResult = compileDocument(schema, document, false, false, emptyValidationOptions);
       const operation = compilationResult.operations[0];
       const allAnimals = operation.selectionSet.selections[0] as Field;
       const inlineFragment = allAnimals?.selectionSet?.selections?.[0] as FragmentSpread;
@@ -299,7 +299,7 @@ describe("given SDL with valid defer directive", () => {
     );
 
     it("should compile fragment spread with directive and arguments", () => {
-      const compilationResult: CompilationResult = compileDocument(schema, document, false, emptyValidationOptions);
+      const compilationResult: CompilationResult = compileDocument(schema, document, false, false,  emptyValidationOptions);
       const operation = compilationResult.operations[0];
       const allAnimals = operation.selectionSet.selections[0] as Field;
       const inlineFragment = allAnimals?.selectionSet?.selections?.[0] as FragmentSpread;

Sources/GraphQLCompiler/JavaScript/src/__tests__/deferDirectiveTests.ts

@@ -49,7 +49,7 @@ describe("given schema", () => {
     );
 
     it("should compile enum values with deprecation reason", () => {
-      const compilationResult: CompilationResult = compileDocument(schema, document, false, emptyValidationOptions);
+      const compilationResult: CompilationResult = compileDocument(schema, document, false, false, emptyValidationOptions);
       const speciesEnum: GraphQLEnumType = compilationResult.referencedTypes.find(function(element) {
         return element.name == 'Species'
       }) as GraphQLEnumType

Sources/GraphQLCompiler/JavaScript/src/__tests__/deprecatedEnumCasesCompilationTests.ts

@@ -48,7 +48,7 @@ describe("given schema", () => {
     );
 
     it("should compile inline fragment with inclusion condition", () => {
-      const compilationResult: CompilationResult = compileDocument(schema, document, false, emptyValidationOptions);
+      const compilationResult: CompilationResult = compileDocument(schema, document, false, false, emptyValidationOptions);
       const operation = compilationResult.operations[0];
       const allAnimals = operation.selectionSet.selections[0] as Field;
       const inlineFragment = allAnimals?.selectionSet?.selections?.[0] as InlineFragment;

Sources/GraphQLCompiler/JavaScript/src/__tests__/inclusionConditionCompilationTests.ts

@@ -68,7 +68,7 @@ describe("operation with referencedFragments", () => {
     fragmentBDocument,
     fragmentCDocument])
 
-  const compilationResult: CompilationResult = compileDocument(schema, document, false, emptyValidationOptions);
+  const compilationResult: CompilationResult = compileDocument(schema, document, false, false, emptyValidationOptions);
 
   const operationA: OperationDefinition = compilationResult.operations.find(function(element) {
     return element.name == 'OperationA'
@@ -157,7 +157,7 @@ describe("operation with referencedFragments on child entity selection sets", ()
     fragmentBDocument,
     fragmentCDocument])
 
-  const compilationResult: CompilationResult = compileDocument(schema, document, false, emptyValidationOptions);
+  const compilationResult: CompilationResult = compileDocument(schema, document, false, false, emptyValidationOptions);
 
   const operationA: OperationDefinition = compilationResult.operations.find(function(element) {
     return element.name == 'OperationA'