Reduce verbosity of relationship resolution errors (#8842)

keystonejs · Sep 29, 2023 · 60357b7 · 60357b7
1 parent 98c9591
commit 60357b7
Show file tree

Hide file tree

Showing 4 changed files with 265 additions and 171 deletions.
diff --git a/packages/core/src/fields/types/relationship/index.ts b/packages/core/src/fields/types/relationship/index.ts
@@ -92,9 +92,7 @@ export const relationship =
     const [foreignListKey, foreignFieldKey] = ref.split('.');
     const foreignList = lists[foreignListKey];
     if (!foreignList) {
-      throw new Error(
-        `Unable to resolve list '${foreignListKey}' for field ${listKey}.${fieldKey}`
-      );
+      throw new Error(`${listKey}.${fieldKey} points to ${ref}, but ${ref} doesn't exist`);
     }
     const foreignListTypes = foreignList.types;
 

diff --git a/packages/core/src/lib/core/resolve-relationships.ts b/packages/core/src/lib/core/resolve-relationships.ts
@@ -129,32 +129,21 @@ export function resolveRelationships(
         alreadyResolvedTwoSidedRelationships.add(foreignRef);
         const foreignField = foreignUnresolvedList.fields[field.field]?.dbField;
         if (!foreignField) {
-          throw new Error(
-            `The relationship field at ${localRef} points to ${foreignRef} but no field at ${foreignRef} exists`
-          );
+          throw new Error(`${localRef} points to ${foreignRef}, but ${foreignRef} doesn't exist`);
         }
 
         if (foreignField.kind !== 'relation') {
           throw new Error(
-            `The relationship field at ${localRef} points to ${foreignRef} but ${foreignRef} is not a relationship field`
-          );
-        }
-
-        if (foreignField.list !== listKey) {
-          throw new Error(
-            `The relationship field at ${localRef} points to ${foreignRef} but ${foreignRef} points to the list ${foreignField.list} rather than ${listKey}`
-          );
-        }
-
-        if (foreignField.field === undefined) {
-          throw new Error(
-            `The relationship field at ${localRef} points to ${foreignRef}, ${localRef} points to ${listKey} correctly but does not point to the ${fieldPath} field when it should`
+            `${localRef} points to ${foreignRef}, but ${foreignRef} is not a relationship field`
           );
         }
 
-        if (foreignField.field !== fieldPath) {
+        const actualRef = foreignField.field
+          ? `${foreignField.list}.${foreignField.field}`
+          : foreignField.list;
+        if (actualRef !== localRef) {
           throw new Error(
-            `The relationship field at ${localRef} points to ${foreignRef}, ${localRef} points to ${listKey} correctly but points to the ${foreignField.field} field instead of ${fieldPath}`
+            `${localRef} points to ${foreignRef}, ${foreignRef} points to ${actualRef}, expected ${foreignRef} to point to ${localRef}`
           );
         }
 

diff --git a/tests/api-tests/fields/types/fixtures/relationship/implementation.test.ts b/tests/api-tests/fields/types/fixtures/relationship/implementation.test.ts