fix: return reference behavior to main for all but introspection (#824)

Author: Dane Pilcher

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

@@ -15,6 +15,7 @@ export function processBelongsToConnection(
   modelMap: CodeGenModelMap,
   connectionDirective: CodeGenDirective,
   isCustomPKEnabled: boolean = false,
+  respectReferences: boolean = false, // remove when enabled references for all targets
 ): CodeGenFieldConnection | undefined {
   if (field.isList) {
     throw new Error(
@@ -28,7 +29,7 @@ export function processBelongsToConnection(
       `A 'belongsTo' field should match to a corresponding 'hasMany' or 'hasOne' field`
     );
   }
-  const otherSideField = isCustomPKEnabled ? otherSideConnectedFields[0] : getConnectedFieldV2(field, model, otherSide, connectionDirective.name);
+  const otherSideField = isCustomPKEnabled ? otherSideConnectedFields[0] : getConnectedFieldV2(field, model, otherSide, connectionDirective.name, false, respectReferences);
   const connectionFields = connectionDirective.arguments.fields || [];
 
   const references = connectionDirective.arguments.references || [];
@@ -41,9 +42,9 @@ 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;
+  const isUsingReferences = respectReferences && references.length > 0;
   // New metada type introduced by custom PK v2 support
-  let targetNames: string[] = [ ...connectionFields, ...references ];
+  let targetNames = isUsingReferences ? [ ...connectionFields, ...references ] : [ ...connectionFields ];
   if (targetNames.length === 0) {
     if (otherSideHasMany) {
       targetNames = isCustomPKEnabled

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

@@ -13,7 +13,8 @@ export function getConnectedFieldV2(
   model: CodeGenModel,
   connectedModel: CodeGenModel,
   directiveName: string,
-  shouldUseModelNameFieldInHasManyAndBelongsTo: boolean = false
+  shouldUseModelNameFieldInHasManyAndBelongsTo: boolean = false,
+  respectReferences: boolean = false,
 ): CodeGenField {
   const connectionInfo = getDirective(field)(directiveName);
   if (!connectionInfo) {
@@ -23,7 +24,7 @@ export function getConnectedFieldV2(
   const references = connectionInfo.arguments.references;
   if (connectionInfo.name === 'belongsTo') {
     let connectedFieldsBelongsTo = getBelongsToConnectedFields(model, connectedModel);
-    if (references) {
+    if (respectReferences && references) {
       const connectedField = connectedFieldsBelongsTo.find((field) => {
         return field.directives.some((dir) => {
           return (dir.name === 'hasOne' || dir.name === 'hasMany')
@@ -49,7 +50,7 @@ export function getConnectedFieldV2(
   }
   if (references || connectionFields || directiveName === 'hasOne') {
     let connectionDirective;
-    if (references) {
+    if (respectReferences && references) {
       if (connectionInfo) {
         connectionDirective = flattenFieldDirectives(connectedModel).find((dir) => {
           return dir.arguments.references
@@ -161,17 +162,18 @@ export function processConnectionsV2(
   shouldUseModelNameFieldInHasManyAndBelongsTo: boolean = false,
   isCustomPKEnabled: boolean = false,
   shouldUseFieldsInAssociatedWithInHasOne: boolean = false,
+  respectReferences: boolean = false, // remove when enabled references for all targets
 ): CodeGenFieldConnection | undefined {
   const connectionDirective = field.directives.find(d => d.name === 'hasOne' || d.name === 'hasMany' || d.name === 'belongsTo');
 
   if (connectionDirective) {
     switch (connectionDirective.name) {
       case 'hasOne':
-        return processHasOneConnection(field, model, modelMap, connectionDirective, isCustomPKEnabled, shouldUseFieldsInAssociatedWithInHasOne);
+        return processHasOneConnection(field, model, modelMap, connectionDirective, isCustomPKEnabled, shouldUseFieldsInAssociatedWithInHasOne, respectReferences);
       case 'belongsTo':
-        return processBelongsToConnection(field, model, modelMap, connectionDirective, isCustomPKEnabled);
+        return processBelongsToConnection(field, model, modelMap, connectionDirective, isCustomPKEnabled, respectReferences);
       case 'hasMany':
-        return processHasManyConnection(field, model, modelMap, connectionDirective, shouldUseModelNameFieldInHasManyAndBelongsTo, isCustomPKEnabled);
+        return processHasManyConnection(field, model, modelMap, connectionDirective, shouldUseModelNameFieldInHasManyAndBelongsTo, isCustomPKEnabled, respectReferences);
       default:
         break;
     }

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

@@ -19,6 +19,7 @@ export function processHasManyConnection(
   connectionDirective: CodeGenDirective,
   shouldUseModelNameFieldInHasManyAndBelongsTo: boolean,
   isCustomPKEnabled: boolean = false,
+  respectReferences: boolean = false, // remove when enabled references for all targets
 ): CodeGenFieldConnection | undefined {
   if (!field.isList) {
     throw new Error("A field with hasMany must be a list type");
@@ -31,9 +32,9 @@ export function processHasManyConnection(
     throw new Error(fieldsAndReferencesErrorMessage);
   }
 
-  if (references.length > 0) {
+  if (respectReferences && references.length > 0) {
     // ensure there is a matching belongsTo field with references
-    getConnectedFieldV2(field, model, otherSide, connectionDirective.name, shouldUseModelNameFieldInHasManyAndBelongsTo)
+    getConnectedFieldV2(field, model, otherSide, connectionDirective.name, shouldUseModelNameFieldInHasManyAndBelongsTo, respectReferences)
     const associatedWithFields = references.map((reference: string) => otherSide.fields.find((field) => reference === field.name))
     return {
       kind: CodeGenConnectionType.HAS_MANY,
@@ -46,7 +47,7 @@ export function processHasManyConnection(
 
   const otherSideFields = isCustomPKEnabled
     ? getConnectedFieldsForHasMany(field, model, otherSide, shouldUseModelNameFieldInHasManyAndBelongsTo)
-    : [getConnectedFieldV2(field, model, otherSide, connectionDirective.name, shouldUseModelNameFieldInHasManyAndBelongsTo)];
+    : [getConnectedFieldV2(field, model, otherSide, connectionDirective.name, shouldUseModelNameFieldInHasManyAndBelongsTo, respectReferences)];
   const otherSideField = otherSideFields[0];
 
   // if a type is connected using name, then graphql-connection-transformer adds a field to

packages/appsync-modelgen-plugin/src/utils/process-belongs-to.ts

@@ -14,7 +14,8 @@ export function processHasOneConnection(
   modelMap: CodeGenModelMap,
   connectionDirective: CodeGenDirective,
   isCustomPKEnabled: boolean = false,
-  shouldUseFieldsInAssociatedWithInHasOne:boolean = false
+  shouldUseFieldsInAssociatedWithInHasOne:boolean = false,
+  respectReferences: boolean = false, // remove when enabled references for all targets
 ): CodeGenFieldConnection | undefined {
   const otherSide = modelMap[field.type];
   // Find other side belongsTo field when in bi direction connection
@@ -31,9 +32,9 @@ export function processHasOneConnection(
   }
 
   let associatedWithFields;
-  if (references.length > 0) {
+  if (respectReferences && references.length > 0) {
     // ensure there is a matching belongsTo field with references
-    getConnectedFieldV2(field, model, otherSide, connectionDirective.name);
+    getConnectedFieldV2(field, model, otherSide, connectionDirective.name, false, respectReferences);
     associatedWithFields = references.map((reference: string) => otherSide.fields.find((field) => reference === field.name))
     return {
       kind: CodeGenConnectionType.HAS_ONE,
@@ -45,7 +46,7 @@ export function processHasOneConnection(
   } else if (isCustomPKEnabled) {
     associatedWithFields = getConnectedFieldsForHasOne(otherSideBelongsToField, otherSide, shouldUseFieldsInAssociatedWithInHasOne);
   } else {
-    const otherSideField = getConnectedFieldV2(field, model, otherSide, connectionDirective.name);
+    const otherSideField = getConnectedFieldV2(field, model, otherSide, connectionDirective.name, false, respectReferences);
     associatedWithFields = [otherSideField];
   }
 

packages/appsync-modelgen-plugin/src/utils/process-connections-v2.ts

@@ -1087,7 +1087,8 @@ export class AppSyncModelVisitor<
           this.modelMap,
           shouldUseModelNameFieldInHasManyAndBelongsTo,
           isCustomPKEnabled,
-          shouldUseFieldsInAssociatedWithInHasOne
+          shouldUseFieldsInAssociatedWithInHasOne,
+          this.config.target === 'introspection',
         );
         if (connectionInfo) {
           if (connectionInfo.kind === CodeGenConnectionType.HAS_MANY) {
@@ -1181,8 +1182,7 @@ export class AppSyncModelVisitor<
               connectionInfo.kind !== CodeGenConnectionType.HAS_MANY &&
               connectionInfo.kind !== CodeGenConnectionType.HAS_ONE &&
               connectionInfo.targetNames &&
-              connectionInfo.targetName !== 'id' &&
-              !connectionInfo.isUsingReferences
+              connectionInfo.targetName !== 'id'
             ) {
               // Need to remove the field that is targetName
               connectionInfo.targetNames.forEach(targetName => removeFieldFromModel(model, targetName));