feat(core): add improved error message for conflicting attribute names

typedorm · Jul 8, 2022 · 1031d40 · 1031d40
1 parent b562f3c
commit 1031d40
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 26 deletions.
diff --git a/packages/core/src/classes/connection/__test__/attributes-metadata-builder.spec.ts b/packages/core/src/classes/connection/__test__/attributes-metadata-builder.spec.ts
@@ -6,6 +6,7 @@ import {
   Attribute,
   AutoGenerateAttribute,
   AUTO_GENERATE_ATTRIBUTE_STRATEGY,
+  ConflictingAttributeNameError,
 } from '@typedorm/common';
 import {UserAutoGenerateAttributes} from '../../../../__mocks__/user-auto-generate-attributes';
 import {User} from '../../../../__mocks__/user';
@@ -269,6 +270,5 @@ test('throws an error when attribute name conflicts with a primary key or sort k
     attributesMetadataBuilder
       .build(mockTable, AdminTest, AdminTest)
       .map(obj => Object.assign({}, obj));
-
-  expect(metadata).toThrow('dasdasds');
+  expect(metadata).toThrow(ConflictingAttributeNameError);
 });
diff --git a/packages/core/src/classes/connection/attribute-metadata-builder.ts b/packages/core/src/classes/connection/attribute-metadata-builder.ts
@@ -29,25 +29,30 @@ export class AttributesMetadataBuilder {
         decoratedEntityClass
       );
 
+      // validate attribute names for primary key conflicts
+      if (
+        [
+          entityMetadata.table?.partitionKey,
+          entityMetadata.table?.usesCompositeKey() &&
+            entityMetadata.table?.sortKey,
+        ]
+          .filter(Boolean)
+          .includes(attr.name)
+      ) {
+        throw new ConflictingAttributeNameError({
+          attributeName: attr.name,
+          entity: entityMetadata.name,
+          tableName: entityMetadata.table?.name || '',
+        });
+      }
+
       if (IsAutoGenerateAttributeRawMetadataOptions(attr)) {
         return this.validateAndBuildAutoGeneratedAttributeMetadata(
           attr,
           entityMetadata
         );
       }
 
-      // if (
-      //   [entityMetadata.table?.partitionKey, entityMetadata.table?.sortKey]
-      //     .filter(Boolean)
-      //     .includes(attr.name)
-      // ) {
-      //   throw new ConflictingAttributeNameError({
-      //     attributeName: attr.name,
-      //     entity: entityMetadata.name,
-      //     tableName: entityMetadata.table?.name || '',
-      //   });
-      // }
-
       return new AttributeMetadata({
         table,
         // when working with entity with multiple inheritance, use class with @Entity() if available
@@ -69,18 +74,6 @@ export class AttributesMetadataBuilder {
       }
     }
 
-    if (
-      [entityMetadata.table?.partitionKey, entityMetadata.table?.sortKey]
-        .filter(Boolean)
-        .includes(attr.name)
-    ) {
-      throw new ConflictingAttributeNameError({
-        attributeName: attr.name,
-        entity: entityMetadata.name,
-        tableName: entityMetadata.table?.name || '',
-      });
-    }
-
     return new AutoGeneratedAttributeMetadata({
       ...attr,
     });