fix: validate references on belongsTo when cpk is disabled

aws-amplify · Apr 25, 2024 · 1207492 · 1207492
1 parent b668fd2
commit 1207492
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 16 deletions.
diff --git a/...ppsync-modelgen-plugin/src/__tests__/visitors/appsync-model-introspection-visitor.test.ts b/...ppsync-modelgen-plugin/src/__tests__/visitors/appsync-model-introspection-visitor.test.ts
@@ -523,7 +523,7 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(visitor.generate()).toMatchSnapshot();
   });
 
@@ -543,7 +543,7 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(visitor.generate()).toMatchSnapshot();
   });
 
@@ -567,7 +567,7 @@ describe('custom references', () => {
         primary: Primary @belongsTo(references: ["primaryId"])
       }
     `;
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(visitor.generate()).toMatchSnapshot();
   });
 
@@ -588,7 +588,7 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(visitor.generate()).toMatchSnapshot();
   });
 
@@ -611,7 +611,7 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(visitor.generate()).toMatchSnapshot();
   });
 
@@ -633,7 +633,7 @@ describe('custom references', () => {
         primary: Primary @belongsTo(references: ["primaryTenantId", "primaryInstanceId", "primaryRecordId"])
       }
     `;
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(visitor.generate()).toMatchSnapshot();
   });
 
@@ -653,7 +653,7 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(() => visitor.generate())
       .toThrowError(`'fields' and 'references' cannot be used together.`);
   });
@@ -674,7 +674,7 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(() => visitor.generate())
       .toThrowError(`'fields' and 'references' cannot be used together.`);
   });
@@ -695,7 +695,7 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(() => visitor.generate())
       .toThrowError(`'fields' and 'references' cannot be used together.`);
   });
@@ -716,7 +716,7 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(() => visitor.generate())
       .toThrowError(`Error processing @hasOne directive on SqlPrimary.related. @belongsTo directive with references ["primaryId"] was not found in connected model SqlRelated`);
   });
@@ -737,11 +737,33 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(() => visitor.generate())
       .toThrowError(`Error processing @belongsTo directive on SqlRelated.primary. @hasOne or @hasMany directive with references ["primaryId"] was not found in connected model SqlPrimary`);
   });
 
+  test('throws error when missing references on hasMany related model when custom pk is disabled', () => {
+    const schema = /* GraphQL */ `
+      type SqlPrimary @refersTo(name: "sql_primary") @model {
+        id: Int! @primaryKey
+        content: String
+        related: [SqlRelated] @hasMany(references: ["primaryId"])
+      }
+
+      type SqlRelated @refersTo(name: "sql_related") @model {
+        id: Int! @primaryKey
+        content: String
+        primaryId: Int! @refersTo(name: "primary_id") @index(name: "primary_id")
+        primary: SqlPrimary @belongsTo
+      }
+    `;
+
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: false });
+    expect(() => visitor.generate())
+      .toThrowError(`Error processing @hasMany directive on SqlPrimary.related. @belongsTo directive with references ["primaryId"] was not found in connected model SqlRelated`);
+  });
+
+
   test('throws error when missing references on hasMany related model', () => {
     const schema = /* GraphQL */ `
       type SqlPrimary @refersTo(name: "sql_primary") @model {
@@ -758,7 +780,7 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(() => visitor.generate())
       .toThrowError(`Error processing @hasMany directive on SqlPrimary.related. @belongsTo directive with references ["primaryId"] was not found in connected model SqlRelated`);
   });
@@ -779,7 +801,7 @@ describe('custom references', () => {
       }
     `;
 
-    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema);
+    const visitor: AppSyncModelIntrospectionVisitor = getVisitor(schema, { respectPrimaryKeyAttributesOnConnectionField: true });
     expect(() => visitor.generate())
       .toThrowError(`Error processing @belongsTo directive on SqlRelated.primary. @hasOne or @hasMany directive with references ["primaryId"] was not found in connected model SqlPrimary`);
   });

diff --git a/packages/appsync-modelgen-plugin/src/utils/process-belongs-to.ts b/packages/appsync-modelgen-plugin/src/utils/process-belongs-to.ts
@@ -28,11 +28,16 @@ export function processBelongsToConnection(
       `A 'belongsTo' field should match to a corresponding 'hasMany' or 'hasOne' field`
     );
   }
+  const references = connectionDirective.arguments.references || [];
+  const isUsingReferences = references.length > 0;
+  if (isUsingReferences) {
+    // ensure there is a matching hasOne/hasMany field with references
+    getConnectedFieldV2(field, model, otherSide, connectionDirective.name)
+  }
+
   const otherSideField = isCustomPKEnabled ? otherSideConnectedFields[0] : getConnectedFieldV2(field, model, otherSide, connectionDirective.name);
   const connectionFields = connectionDirective.arguments.fields || [];
 
-  const references = connectionDirective.arguments.references || [];
-
   if (connectionFields.length > 0 && references.length > 0) {
     throw new Error(fieldsAndReferencesErrorMessage);
   }
@@ -41,7 +46,6 @@ export function processBelongsToConnection(
   // but if the field are connected using fields argument in connection directive
   // we are reusing the field and it should be preserved in selection set
   const otherSideHasMany = otherSideField.isList;
-  const isUsingReferences = references.length > 0;
   // New metada type introduced by custom PK v2 support
   let targetNames: string[] = [ ...connectionFields, ...references ];
   if (targetNames.length === 0) {