feat(appsync-modelgen-plugin): Many to many directive (#238)

marcvberg · web-flow · commit cf95f9ce77e5 · 2021-09-24T13:09:31.000-07:00
* Feature: Add new @PrimaryKey and @index directives Added support for the java visitor, swift and process-connection up next * Feature: swift visitor processes @PrimaryKey and @index Fix the location of the java visitor primaryKey/index tests to sit next to key * Feature: Adding @key replacement support to process-connections WIP * Feature: Adding @key replacement support to process-connections primaryKey and index are supported directives for connections unit tests are added We'll need to remove the side by side support for the v1 and v2 transformers post-release * Fix: add feature flags mocking to other unit tests * Fix: Update the way version is calculated for vNext transformer * Feature: WIP addition of hasOne directive * Fix: Get feature flag according to codegen pattern * Feature: WIP addition of hasOne directive * primaryKey/index directives (#217) * Feature: Add new @PrimaryKey and @index directives Added support for the java visitor, swift and process-connection up next * Feature: swift visitor processes @PrimaryKey and @index Fix the location of the java visitor primaryKey/index tests to sit next to key * Feature: Adding @key replacement support to process-connections WIP * Feature: Adding @key replacement support to process-connections primaryKey and index are supported directives for connections unit tests are added We'll need to remove the side by side support for the v1 and v2 transformers post-release * Fix: add feature flags mocking to other unit tests * Fix: Update the way version is calculated for vNext transformer * Fix: Get feature flag according to codegen pattern * WIP Feature: V2 connection directive replacements hasOne, hasMany, belongsTo manyToMany is to come in a future branch * Fix: Purge FeatureFlags cli core usage, update tests * Add another unit test for hasOne * Fix all the merge conflicts I already resolved but git re-broke * Fix: Process connections test suite Match the scenarios in the design doc, cover another case * WIP Change: process manyToMany directive into composing hasMany and belongsTo * Fix: Remove or update some outdated code in connections processing * Fix: Code quality changes for LGTM bot * WIP Change: process manyToMany directive into composing hasMany and belongsTo * Fix: swift visitor index directive, unit test compare metadata * Revert "Fix: swift visitor index directive, unit test compare metadata" This reverts commit dd45b45. * Fix: remove unused import * Fix: Remove unreachable code and add some error checking belongsTo * Feature: Add new @PrimaryKey and @index directives Added support for the java visitor, swift and process-connection up next * Feature: swift visitor processes @PrimaryKey and @index Fix the location of the java visitor primaryKey/index tests to sit next to key * Fix: add feature flags mocking to other unit tests * Feature: WIP addition of hasOne directive * WIP Feature: V2 connection directive replacements hasOne, hasMany, belongsTo manyToMany is to come in a future branch * Feature: WIP addition of hasOne directive * Fix: Purge FeatureFlags cli core usage, update tests * Fix all the merge conflicts I already resolved but git re-broke * Feature: Add manyToMany directive and tests * Feature: Add manyToMany directive and tests remake a few changes that somehow got blown away * Fix: move a visitor test to a visitor test file * Fix: Reuse some variables instead of remaking the value * Fix: case on generated field names manyToMany
diff --git a/packages/appsync-modelgen-plugin/src/__tests__/utils/process-connections.test.ts b/packages/appsync-modelgen-plugin/src/__tests__/utils/process-connections.test.ts
@@ -1,13 +1,12 @@
 import {
   processConnections,
   CodeGenConnectionType,
-  CodeGenFieldConnection,
   CodeGenFieldConnectionHasMany,
   CodeGenFieldConnectionBelongsTo,
   CodeGenFieldConnectionHasOne,
   getConnectedField,
 } from '../../utils/process-connections';
-import { CodeGenModelMap, CodeGenModel } from '../../visitors/appsync-visitor';
+import { CodeGenModelMap } from '../../visitors/appsync-visitor';
 import { processConnectionsV2 } from '../../utils/process-connections-v2';
 
 describe('process connection', () => {
@@ -772,5 +771,6 @@ describe('process connection', () => {
         expect(connectionInfo.isConnectingFieldAutoCreated).toEqual(false);
       });
     });
+
   });
 });
diff --git a/packages/appsync-modelgen-plugin/src/__tests__/visitors/appsync-visitor.test.ts b/packages/appsync-modelgen-plugin/src/__tests__/visitors/appsync-visitor.test.ts
@@ -1,25 +1,31 @@
 import { buildSchema, parse, visit } from 'graphql';
 import { directives, scalars } from '../../scalars/supported-directives';
 import { CodeGenConnectionType, CodeGenFieldConnectionBelongsTo, CodeGenFieldConnectionHasMany } from '../../utils/process-connections';
-import { AppSyncModelVisitor, CodeGenField, CodeGenGenerateEnum } from '../../visitors/appsync-visitor';
+import { AppSyncModelVisitor, CodeGenGenerateEnum } from '../../visitors/appsync-visitor';
 
 const buildSchemaWithDirectives = (schema: String) => {
   return buildSchema([schema, directives, scalars].join('\n'));
 };
 
-const createAndGenerateVisitor = (schema: string) => {
+const createAndGenerateVisitor = (schema: string, usePipelinedTransformer: boolean = false) => {
   const ast = parse(schema);
   const builtSchema = buildSchemaWithDirectives(schema);
   const visitor = new AppSyncModelVisitor(
     builtSchema,
-    { directives, target: 'general', isTimestampFieldsAdded: true },
+    { directives, target: 'general', isTimestampFieldsAdded: true, usePipelinedTransformer: usePipelinedTransformer },
     { generate: CodeGenGenerateEnum.code },
   );
   visit(ast, { leave: visitor });
   visitor.generate();
   return visitor;
 };
 
+const createAndGeneratePipelinedTransformerVisitor = (
+  schema: string
+) => {
+  return createAndGenerateVisitor(schema, true);
+};
+
 describe('AppSyncModelVisitor', () => {
 
   it('should support schema with id', () => {
@@ -563,4 +569,178 @@ describe('AppSyncModelVisitor', () => {
       expect(updatedAtField).toMatchObject(updatedAtFieldObj);
     });
   });
+
+  describe('manyToMany testing', () => {
+    let simpleManyToManySchema;
+    let simpleManyModelMap;
+    let transformedSimpleManyModelMap;
+
+    beforeEach(() => {
+      simpleManyToManySchema = /* GraphQL */ `
+          type Human @model {
+            governmentID: ID! @primaryKey
+            pets: [Animal] @manyToMany(relationName: "PetFriend")
+          }
+          
+          type Animal @model {
+            animalTag: ID!
+            humanFriend: [Human] @manyToMany(relationName: "PetFriend")
+          }
+        `;
+
+      simpleManyModelMap = {
+        Human: {
+          name: 'Human',
+          type: 'model',
+          directives: [],
+          fields: [
+            {
+              type: 'ID',
+              isNullable: false,
+              isList: false,
+              name: 'governmentID',
+              directives: [{ name: 'primaryKey', arguments: {} }]
+            },
+            {
+              type: 'Animal',
+              isNullable: true,
+              isList: true,
+              name: 'pets',
+              directives: [{ name: 'manyToMany', arguments: { relationName: 'PetFriend' } }]
+            }
+          ]
+        },
+        Animal: {
+          name: 'Animal',
+          type: 'model',
+          directives: [],
+          fields: [
+            {
+              type: 'ID',
+              isNullable: false,
+              isList: false,
+              name: 'animalTag',
+              directives: [],
+            },
+            {
+              type: 'Human',
+              isNullable: true,
+              isList: true,
+              name: 'postID',
+              directives: [{ name: 'manyToMany', arguments: { relationName: 'PetFriend' } }]
+            }
+          ],
+        }
+      };
+    });
+
+    transformedSimpleManyModelMap = {
+      Human: {
+        name: 'Human',
+        type: 'model',
+        directives: [{name: 'model', arguments: {}}],
+        fields: [
+          {
+            type: 'ID',
+            isNullable: false,
+            isList: false,
+            name: 'governmentID',
+            directives: [{ name: 'primaryKey', arguments: {} }]
+          },
+          {
+            type: 'PetFriend',
+            isNullable: true,
+            isList: true,
+            name: 'pets',
+            directives: [{ name: 'hasMany', arguments: { fields: ['governmentID'] } }]
+          }
+        ]
+      },
+      Animal: {
+        name: 'Animal',
+        type: 'model',
+        directives: [{name: 'model', arguments: {}}],
+        fields: [
+          {
+            type: 'ID',
+            isNullable: false,
+            isList: false,
+            name: 'animalTag',
+            directives: [],
+          },
+          {
+            type: 'PetFriend',
+            isNullable: true,
+            isList: true,
+            name: 'postID',
+            directives: [{ name: 'hasMany', arguments: { fields: ['id'] } }]
+          }
+        ],
+      },
+      PetFriend: {
+        name: 'PetFriend',
+        type: 'model',
+        directives: [{name: 'model', arguments: {}}],
+        fields: [
+          {
+            type: 'ID',
+            isNullable: false,
+            isList: false,
+            name: 'id',
+            directives: []
+          },
+          {
+            type: 'ID',
+            isNullable: false,
+            isList: false,
+            name: 'humanID',
+            directives: [{ name: 'index', arguments: { name: 'byHuman', sortKeyFields: ['animalID'] } }]
+          },
+          {
+            type: 'ID',
+            isNullable: false,
+            isList: false,
+            name: 'animalID',
+            directives: [{ name: 'index', arguments: { name: 'byAnimal', sortKeyFields: ['humanID'] } }]
+          },
+          {
+            type: 'Human',
+            isNullable: false,
+            isList: false,
+            name: 'human',
+            directives: [{ name: 'belongsTo', arguments: { fields: ['humanID'] } }]
+          },
+          {
+            type: 'Animal',
+            isNullable: false,
+            isList: false,
+            name: 'animal',
+            directives: [{ name: 'belongsTo', arguments: { fields: ['humanID'] } }]
+          }
+        ]
+      }
+    };
+
+    it('Should correctly convert the model map of a simple manyToMany', () => {
+      const visitor = createAndGeneratePipelinedTransformerVisitor(simpleManyToManySchema);
+
+      expect(visitor.models.Human.fields.length).toEqual(5);
+      expect(visitor.models.Human.fields[2].directives[0].name).toEqual('hasMany')
+      expect(visitor.models.Human.fields[2].directives[0].arguments.fields.length).toEqual(1)
+      expect(visitor.models.Human.fields[2].directives[0].arguments.fields[0]).toEqual('governmentID')
+      expect(visitor.models.Human.fields[2].directives[0].arguments.indexName).toEqual('byHuman')
+      expect(visitor.models.PetFriend).toBeDefined();
+      expect(visitor.models.PetFriend.fields.length).toEqual(5);
+      expect(visitor.models.PetFriend.fields[2].directives[0].name).toEqual('belongsTo')
+      expect(visitor.models.PetFriend.fields[2].directives[0].arguments.fields.length).toEqual(1)
+      expect(visitor.models.PetFriend.fields[2].directives[0].arguments.fields[0]).toEqual('animalID')
+      expect(visitor.models.Animal.fields.length).toEqual(5);
+      expect(visitor.models.Animal.fields[2].type).toEqual('PetFriend');
+      expect(visitor.models.Animal.fields[2].directives.length).toEqual(1);
+      expect(visitor.models.Animal.fields[2].directives[0].name).toEqual('hasMany');
+      expect(visitor.models.Animal.fields[2].directives[0].arguments.fields.length).toEqual(1)
+      expect(visitor.models.Animal.fields[2].directives[0].arguments.fields[0]).toEqual('id')
+      expect(visitor.models.Animal.fields[2].directives[0].arguments.indexName).toEqual('byAnimal')
+    });
+  });
 });
diff --git a/packages/appsync-modelgen-plugin/src/utils/process-connections-v2.ts b/packages/appsync-modelgen-plugin/src/utils/process-connections-v2.ts
@@ -1,4 +1,4 @@
-import { CodeGenField, CodeGenFieldDirective, CodeGenModel, CodeGenModelMap } from '../visitors/appsync-visitor';
+import { CodeGenDirective, CodeGenField, CodeGenFieldDirective, CodeGenModel, CodeGenModelMap } from '../visitors/appsync-visitor';
 import {
   CodeGenFieldConnection, DEFAULT_HASH_KEY_FIELD, flattenFieldDirectives,
   getDirective,
@@ -10,12 +10,41 @@ import { processHasManyConnection } from './process-has-many';
 
 // TODO: This file holds several references to utility functions in the v1 process connections file, those functions need to go here before that file is removed
 
+function getBelongsToConnectedField(field: CodeGenField, model: CodeGenModel, connectedModel: CodeGenModel, connectionInfo: CodeGenDirective): CodeGenField | undefined {
+  if(connectionInfo.arguments.fields) {
+    let indexDirective = flattenFieldDirectives(model).find(dir => {
+      return dir.name === 'index' && dir.fieldName === connectionInfo.arguments.fields[0];
+    });
+
+    if(indexDirective) {
+      let theIndex = indexDirective;
+      let otherSideConnected = flattenFieldDirectives(connectedModel).find(dir => {
+        return (dir.name === 'hasOne' || dir.name === 'hasMany') && dir.arguments.indexName === theIndex.arguments.name;
+      });
+      if(otherSideConnected) {
+        for(let connField of connectedModel.fields) {
+          if (connField.name === otherSideConnected?.fieldName) {
+            return connField;
+          }
+        }
+      }
+    }
+  }
+}
+
 export function getConnectedFieldV2(field: CodeGenField, model: CodeGenModel, connectedModel: CodeGenModel, directiveName: string): CodeGenField {
   const connectionInfo = getDirective(field)(directiveName);
   if (!connectionInfo) {
     throw new Error(`The ${field.name} on model ${model.name} is not connected`);
   }
 
+  if(connectionInfo.name === 'belongsTo') {
+    let connectedFieldBelongsTo = getBelongsToConnectedField(field, model, connectedModel, connectionInfo);
+    if (connectedFieldBelongsTo) {
+      return connectedFieldBelongsTo;
+    }
+  }
+
   const indexName = connectionInfo.arguments.indexName;
   const connectionFields = connectionInfo.arguments.fields;
   if (connectionFields) {
diff --git a/packages/appsync-modelgen-plugin/src/visitors/appsync-swift-visitor.ts b/packages/appsync-modelgen-plugin/src/visitors/appsync-swift-visitor.ts
@@ -41,7 +41,7 @@ export interface ParsedAppSyncModelSwiftConfig extends ParsedAppSyncModelConfig
 export class AppSyncSwiftVisitor<
   TRawConfig extends RawAppSyncModelSwiftConfig = RawAppSyncModelSwiftConfig,
   TPluginConfig extends ParsedAppSyncModelSwiftConfig = ParsedAppSyncModelSwiftConfig
-> extends AppSyncModelVisitor<TRawConfig, TPluginConfig> {
+  > extends AppSyncModelVisitor<TRawConfig, TPluginConfig> {
   protected modelExtensionImports: string[] = ['import Amplify', 'import Foundation'];
   protected imports: string[] = ['import Amplify', 'import Foundation'];
 
diff --git a/packages/appsync-modelgen-plugin/src/visitors/appsync-visitor.ts b/packages/appsync-modelgen-plugin/src/visitors/appsync-visitor.ts
