Squashed 'apollo-ios-codegen/' changes from 1b1661ba..b214a4ac

b214a4ac fix: Generate local cache mutation referenced fragments as mutable (#659)

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

Author: gh-action-runner

Sources/GraphQLCompiler/ApolloCodegenFrontendBundle.swift

@@ -230,11 +230,15 @@ public final class CompilationResult: JavaScriptObjectDecodable {
     public let filePath: String
 
     public var isLocalCacheMutation: Bool {
-      directives?.contains { $0.name == Constants.DirectiveNames.LocalCacheMutation } ?? false
+      overrideAsLocalCacheMutation || directives?.contains {
+        $0.name == Constants.DirectiveNames.LocalCacheMutation
+      } ?? false
     }
 
     public let moduleImports: OrderedSet<String>
 
+    public let overrideAsLocalCacheMutation: Bool
+
     init(_ jsValue: JSValue, bridge: isolated JavaScriptBridge) {
       self.name = jsValue["name"]
       self.directives = .fromJSValue(jsValue["directives"], bridge: bridge)
@@ -243,8 +247,11 @@ public final class CompilationResult: JavaScriptObjectDecodable {
       self.referencedFragments = .fromJSValue(jsValue["referencedFragments"], bridge: bridge)
       self.source = jsValue["source"]
       self.filePath = jsValue["filePath"]
-      self.moduleImports = FragmentDefinition.getImportModuleNames(directives: directives, 
-                                                                   referencedFragments: referencedFragments)
+      self.moduleImports = FragmentDefinition.getImportModuleNames(
+        directives: directives,
+        referencedFragments: referencedFragments
+      )
+      self.overrideAsLocalCacheMutation = jsValue["overrideAsLocalCacheMutation"]
     }
 
     /// Initializer to be used for creating mock objects in tests only.
@@ -255,7 +262,8 @@ public final class CompilationResult: JavaScriptObjectDecodable {
       directives: [Directive]?,
       referencedFragments: [FragmentDefinition],
       source: String,
-      filePath: String
+      filePath: String,
+      overrideAsLocalCacheMutation: Bool
     ) {
       self.name = name
       self.type = type
@@ -264,8 +272,11 @@ public final class CompilationResult: JavaScriptObjectDecodable {
       self.referencedFragments = referencedFragments
       self.source = source
       self.filePath = filePath
-      self.moduleImports = FragmentDefinition.getImportModuleNames(directives: directives,
-                                                                   referencedFragments: referencedFragments)
+      self.moduleImports = FragmentDefinition.getImportModuleNames(
+        directives: directives,
+        referencedFragments: referencedFragments
+      )
+      self.overrideAsLocalCacheMutation = overrideAsLocalCacheMutation
     }
 
     public var debugDescription: String {

Sources/GraphQLCompiler/CompilationResult.swift

@@ -184,3 +184,114 @@ describe("operation with referencedFragments on child entity selection sets", ()
   });
 
 });
+
+describe("local cache mutation operation with referenced fragments", () => {
+  const schemaSDL: string =
+`type Query {
+  allAnimals: [Animal!]
+}
+
+interface Animal {
+  species: String!
+  friend: Animal!
+}`;
+
+  const schema: GraphQLSchema = loadSchemaFromSources([new Source(schemaSDL, "Test Schema", { line: 1, column: 1 })]);
+
+  const documentString: string =
+`query Test @apollo_client_ios_localCacheMutation {
+  allAnimals {
+    ...SpeciesFragment
+  }
+}
+
+fragment SpeciesFragment on Animal {
+  species
+  ...FriendFragment
+}
+
+fragment FriendFragment on Animal {
+  friend {
+    species
+  }
+}`;
+
+  const document: DocumentNode = parseOperationDocument(
+    new Source(documentString, "Test Query", { line: 1, column: 1 })
+  );
+
+  it("should flag the referenced fragments as being local cache mutations too.", () => {
+    const compilationResult: CompilationResult = compileDocument(schema, document, false, false, emptyValidationOptions);
+
+    const speciesFragment: FragmentDefinition = compilationResult.fragments.find(function (element) {
+      return element.name == 'SpeciesFragment'
+    }) as FragmentDefinition
+    const friendFragment: FragmentDefinition = compilationResult.fragments.find(function (element) {
+      return element.name == 'FriendFragment'
+    }) as FragmentDefinition
+
+    expect(speciesFragment.overrideAsLocalCacheMutation).toBeTruthy();
+    expect(friendFragment.overrideAsLocalCacheMutation).toBeTruthy();
+  });
+});
+
+describe("local cache mutation fragment with referenced fragments", () => {
+  const schemaSDL: string =
+`type Query {
+  allAnimals: [Animal!]
+}
+
+interface Animal {
+  name: String!
+  species: String!
+  friend: Animal!
+}`;
+
+  const schema: GraphQLSchema = loadSchemaFromSources([new Source(schemaSDL, "Test Schema", { line: 1, column: 1 })]);
+
+  const documentString: string =
+`query Test {
+  allAnimals {
+    ...NameFragment
+    ...SpeciesFragment
+  }
+}
+
+fragment NameFragment on Animal {
+  name
+}
+
+fragment SpeciesFragment on Animal @apollo_client_ios_localCacheMutation {
+  species
+  ...FriendFragment
+}
+
+fragment FriendFragment on Animal {
+  friend {
+    species
+  }
+}`;
+
+  const document: DocumentNode = parseOperationDocument(
+    new Source(documentString, "Test Query", { line: 1, column: 1 })
+  );
+
+  it("should only flag the cache mutation referenced fragment as being local cache mutation.", () => {
+    const compilationResult: CompilationResult = compileDocument(schema, document, false, false, emptyValidationOptions);
+    
+    const nameFragment: FragmentDefinition = compilationResult.fragments.find(function (element) {
+      return element.name == 'NameFragment'
+    }) as FragmentDefinition
+    const speciesFragment: FragmentDefinition = compilationResult.fragments.find(function (element) {
+      return element.name == 'SpeciesFragment'
+    }) as FragmentDefinition
+    const friendFragment: FragmentDefinition = compilationResult.fragments.find(function (element) {
+      return element.name == 'FriendFragment'
+    }) as FragmentDefinition
+
+    expect(nameFragment.overrideAsLocalCacheMutation).toBeFalsy();
+    expect(speciesFragment.overrideAsLocalCacheMutation).toBeFalsy();
+
+    expect(friendFragment.overrideAsLocalCacheMutation).toBeTruthy();
+  });
+});

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

@@ -1,4 +1,5 @@
 import {
+  containsLocalCacheMutationDirective,
   getFieldDef,
   isMetaFieldName,
   isNotNullOrUndefined,
@@ -229,18 +230,21 @@ export function compileToIR(
 
     addReferencedType(rootType)
 
+    const selectionSet = compileSelectionSet(operationDefinition.selectionSet, rootType, referencedFragments)
+    const referencedFragmentsArray = Array.from(referencedFragments.values())
+
+    if (containsLocalCacheMutationDirective(operationDefinition.directives)) {
+      overrideAsLocalCacheMutation(referencedFragmentsArray);
+    }
+
     return {
       name,
       operationType,
       variables,
       rootType,
-      selectionSet: compileSelectionSet(
-        operationDefinition.selectionSet,
-        rootType,
-        referencedFragments
-      ),
+      selectionSet: selectionSet,
       directives: directives,
-      referencedFragments: Array.from(referencedFragments.values()),
+      referencedFragments: referencedFragmentsArray,
       source,
       filePath
     };
@@ -267,21 +271,34 @@ export function compileToIR(
 
     addReferencedType(getNamedType(typeCondition));
 
+    const selectionSet = compileSelectionSet(fragmentDefinition.selectionSet, typeCondition, referencedFragments)
+    const referencedFragmentsArray = Array.from(referencedFragments.values())
+
+    if (containsLocalCacheMutationDirective(fragmentDefinition.directives)) {
+      overrideAsLocalCacheMutation(referencedFragmentsArray);
+    }
+
     return {
       name,
       filePath,
       source,
       typeCondition,
-      selectionSet: compileSelectionSet(
-        fragmentDefinition.selectionSet,
-        typeCondition,
-        referencedFragments
-      ),
+      selectionSet: selectionSet,
       directives: directives,
-      referencedFragments: Array.from(referencedFragments.values()),
+      referencedFragments: referencedFragmentsArray,
+      overrideAsLocalCacheMutation: false
     };
   }
 
+  function overrideAsLocalCacheMutation(
+    fragments: ir.FragmentDefinition[]
+  ) {
+    fragments.forEach(element => {
+      element.overrideAsLocalCacheMutation = true
+      overrideAsLocalCacheMutation(element.referencedFragments)
+    });
+  }
+
   function compileSelectionSet(
     selectionSetNode: SelectionSetNode,
     parentType: GraphQLCompositeType,

Sources/GraphQLCompiler/JavaScript/src/compiler/index.ts

@@ -42,6 +42,7 @@ export interface FragmentDefinition {
   referencedFragments: FragmentDefinition[];
   source: string;
   filePath?: string;
+  overrideAsLocalCacheMutation: boolean;
 }
 
 export interface SelectionSet {

Sources/GraphQLCompiler/JavaScript/src/compiler/ir.ts

@@ -59,6 +59,18 @@ export function isMetaFieldName(name: string) {
   return name.startsWith("__");
 }
 
+export function containsLocalCacheMutationDirective(directives: readonly DirectiveNode[] | undefined): boolean {
+  if (!directives) return false
+
+  for (const directive of directives) {
+    if (directive.name.value == directive_apollo_client_ios_localCacheMutation.name.value) {
+      return true
+    }
+  }
+
+  return false
+}
+
 const typenameField: FieldNode = {
   kind: Kind.FIELD,
   name: { kind: Kind.NAME, value: "__typename" },