fix(modelgen-js): use optional fields for FK in manyToMany (#462)

Author: AaronZyLee

packages/appsync-modelgen-plugin/src/__tests__/visitors/__snapshots__/appsync-javascript-visitor.test.ts.snap

@@ -114,3 +114,58 @@ export declare class Team {
   static copyOf(source: Team, mutator: (draft: MutableModel<Team>) => MutableModel<Team> | void): Team;
 }"
 `;
+
+exports[`Javascript visitor with connected models of custom pk manyToMany relation should generate correct declaration for manyToMany model when custom pk is enabled 1`] = `
+"import { ModelInit, MutableModel, __modelMeta__, CompositeIdentifier, ManagedIdentifier } from \\"@aws-amplify/datastore\\";
+
+
+
+
+
+export declare class Post {
+  readonly [__modelMeta__]: {
+    identifier: CompositeIdentifier<Post, ['customPostId', 'title']>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly customPostId: string;
+  readonly title: string;
+  readonly content?: string | null;
+  readonly tags?: (PostTags | null)[] | null;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+  constructor(init: ModelInit<Post>);
+  static copyOf(source: Post, mutator: (draft: MutableModel<Post>) => MutableModel<Post> | void): Post;
+}
+
+export declare class Tag {
+  readonly [__modelMeta__]: {
+    identifier: CompositeIdentifier<Tag, ['customTagId', 'label']>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly customTagId: string;
+  readonly label: string;
+  readonly posts?: (PostTags | null)[] | null;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+  constructor(init: ModelInit<Tag>);
+  static copyOf(source: Tag, mutator: (draft: MutableModel<Tag>) => MutableModel<Tag> | void): Tag;
+}
+
+export declare class PostTags {
+  readonly [__modelMeta__]: {
+    identifier: ManagedIdentifier<PostTags, 'id'>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly id: string;
+  readonly postCustomPostId?: string | null;
+  readonly posttitle?: string | null;
+  readonly tagCustomTagId?: string | null;
+  readonly taglabel?: string | null;
+  readonly post: Post;
+  readonly tag: Tag;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+  constructor(init: ModelInit<PostTags>);
+  static copyOf(source: PostTags, mutator: (draft: MutableModel<PostTags>) => MutableModel<PostTags> | void): PostTags;
+}"
+`;

packages/appsync-modelgen-plugin/src/__tests__/visitors/appsync-javascript-visitor.test.ts

@@ -885,4 +885,30 @@ describe('Javascript visitor with connected models of custom pk', () => {
       expect(declarations).toMatchSnapshot();
     });
   });
+  describe('manyToMany relation', () => {
+    it('should generate correct declaration for manyToMany model when custom pk is enabled', () => {
+      const schema = /* GraphQL */ `
+        type Post @model {
+          customPostId: ID! @primaryKey(sortKeyFields: ["title"])
+          title: String!
+          content: String
+          tags: [Tag] @manyToMany(relationName: "PostTags")
+        }
+        type Tag @model {
+          customTagId: ID! @primaryKey(sortKeyFields: ["label"])
+          label: String!
+          posts: [Post] @manyToMany(relationName: "PostTags")
+        }
+      `;
+      const visitor = getVisitor(schema, {
+        isDeclaration: true,
+        isTimestampFieldsAdded: true,
+        respectPrimaryKeyAttributesOnConnectionField: true,
+        transformerVersion: 2,
+      });
+      const declarations = visitor.generate();
+      validateTs(declarations);
+      expect(declarations).toMatchSnapshot();
+    });
+  });
 });

packages/appsync-modelgen-plugin/src/__tests__/visitors/appsync-visitor.test.ts

@@ -953,11 +953,11 @@ describe('AppSyncModelVisitor', () => {
       const modelASortKeyField = ModelAModelB.fields.find(f => f.name === 'modelAsortId')!;
       expect(modelASortKeyField).toBeDefined();
       expect(modelASortKeyField.type).toEqual('ID');
-      expect(modelASortKeyField.isNullable).toBe(false);
+      expect(modelASortKeyField.isNullable).toBe(true);
       const modelBSortKeyField = ModelAModelB.fields.find(f => f.name === 'modelBsortId')!;
       expect(modelBSortKeyField).toBeDefined();
       expect(modelBSortKeyField.type).toEqual('ID');
-      expect(modelBSortKeyField.isNullable).toBe(false);
+      expect(modelBSortKeyField.isNullable).toBe(true);
       const modelAIndexDirective = ModelAModelB.directives.find(d => d.name === 'key' && d.arguments.name === 'byModelA')!;
       expect(modelAIndexDirective).toBeDefined();
       expect(modelAIndexDirective.arguments.fields).toEqual(['modelACustomId', 'modelAsortId']);

packages/appsync-modelgen-plugin/src/visitors/appsync-visitor.ts

@@ -682,7 +682,7 @@ export class AppSyncModelVisitor<
         },
         {
           type: 'ID',
-          isNullable: false,
+          isNullable: true,
           isList: false,
           name: firstModelKeyFieldName,
           directives: [
@@ -698,15 +698,15 @@ export class AppSyncModelVisitor<
         ...firstModelSortKeyFields.map(field => {
           return {
             type: field.type,
-            isNullable: false,
+            isNullable: true,
             isList: field.isList,
             name: this.generateIntermediateModelSortKeyFieldName(firstModel, field),
             directives: [],
           };
         }),
         {
           type: 'ID',
-          isNullable: false,
+          isNullable: true,
           isList: false,
           name: secondModelKeyFieldName,
           directives: [
@@ -722,7 +722,7 @@ export class AppSyncModelVisitor<
         ...secondModelSortKeyFields.map(field => {
           return {
             type: field.type,
-            isNullable: false,
+            isNullable: true,
             isList: field.isList,
             name: this.generateIntermediateModelSortKeyFieldName(secondModel, field),
             directives: [],