fix: remove strict index naming rule

Author: edumarques

compose.yml

@@ -38,9 +38,9 @@ services:
       DYNAMODB_TABLE_ATTRIBUTE_DEFINITIONS: "AttributeName=PK,AttributeType=S AttributeName=SK,AttributeType=S"
       DYNAMODB_TABLE_INDEX_NAME: test-table-index
       DYNAMODB_TABLE_INDEX_KEY_SCHEMA: "AttributeName=PK,KeyType=HASH AttributeName=SK,KeyType=RANGE"
-      DYNAMODB_TABLE_INDEX_ATTRIBUTE_DEFINITIONS: 'AttributeName=PK,AttributeType=S AttributeName=SK,AttributeType=S AttributeName=GSI1_PK,AttributeType=S AttributeName=GSI1_SK,AttributeType=S AttributeName=LSI1_SK,AttributeType=S'
-      DYNAMODB_TABLE_INDEX_LSI_DEFINITIONS: '[{"IndexName":"LSI1","KeySchema":[{"AttributeName":"PK","KeyType":"HASH"}, {"AttributeName":"LSI1_SK","KeyType":"RANGE"}],"Projection":{"ProjectionType":"ALL"}}]'
-      DYNAMODB_TABLE_INDEX_GSI_DEFINITIONS: '[{"IndexName":"GSI1","KeySchema":[{"AttributeName":"GSI1_PK","KeyType":"HASH"}, {"AttributeName":"GSI1_SK","KeyType":"RANGE"}],"Projection":{"ProjectionType":"ALL"},"ProvisionedThroughput":{"ReadCapacityUnits":5,"WriteCapacityUnits":5}}]'
+      DYNAMODB_TABLE_INDEX_ATTRIBUTE_DEFINITIONS: 'AttributeName=PK,AttributeType=S AttributeName=SK,AttributeType=S AttributeName=name,AttributeType=S AttributeName=type,AttributeType=S AttributeName=creationDateId,AttributeType=S'
+      DYNAMODB_TABLE_INDEX_LSI_DEFINITIONS: '[{"IndexName":"LSI1","KeySchema":[{"AttributeName":"PK","KeyType":"HASH"}, {"AttributeName":"name","KeyType":"RANGE"}],"Projection":{"ProjectionType":"ALL"}}]'
+      DYNAMODB_TABLE_INDEX_GSI_DEFINITIONS: '[{"IndexName":"GSI1","KeySchema":[{"AttributeName":"type","KeyType":"HASH"}, {"AttributeName":"creationDateId","KeyType":"RANGE"}], "Projection":{"ProjectionType":"ALL"},"ProvisionedThroughput":{"ReadCapacityUnits":5,"WriteCapacityUnits":5}}, {"IndexName":"GSI2","KeySchema":[{"AttributeName":"type","KeyType":"HASH"}, {"AttributeName":"name","KeyType":"RANGE"}], "Projection":{"ProjectionType":"ALL"},"ProvisionedThroughput":{"ReadCapacityUnits":5,"WriteCapacityUnits":5}}]'
       DYNAMODB_SHARE_DB: 1
     volumes:
       - .docker/localstack/init-aws.sh:/etc/localstack/init/ready.d/init-aws.sh

src/Serializer/EntityNormalizer.php

@@ -36,23 +36,12 @@ public function __construct(
     public function normalize(object $entity, bool $includePrimaryKey = true): array
     {
         $primaryKey = $includePrimaryKey ? $this->normalizePrimaryKey($entity) : [];
-        $attributes = $this->normalizeAttributes($entity);
-        $indexes = $this->normalizeIndexesFromEntity($entity);
 
-        $item = [...$primaryKey, ...$attributes];
-
-        $overlappingIndexFields = array_intersect_key($indexes, $item);
-
-        if (false === empty($overlappingIndexFields)) {
-            throw new InvalidEntityException(
-                sprintf(
-                    'Index attributes cannot have overlap other item attributes: %s',
-                    json_encode(array_keys($overlappingIndexFields))
-                )
-            );
-        }
-
-        return [...$item, ...$indexes];
+        return [
+            ...$primaryKey,
+            ...$this->normalizeAttributes($entity),
+            ...$this->normalizeIndexesFromEntity($entity),
+        ];
     }
 
     /**
@@ -371,19 +360,10 @@ protected function normalizeIndexesFromEntity(object $entity): array
         $normalized = [];
 
         foreach ($indexes as $index) {
-            $currentNormalized = $this->normalizeIndexFromEntity($entity, $index);
-            $overlappingKeys = array_intersect_key($currentNormalized, $normalized);
-
-            if (false === empty($overlappingKeys)) {
-                throw new InvalidEntityException(
-                    sprintf(
-                        'Index attributes cannot overlap other index attributes: %s',
-                        json_encode(array_keys($overlappingKeys))
-                    )
-                );
-            }
-
-            $normalized = [...$normalized, ...$currentNormalized];
+            $normalized = [
+                ...$normalized,
+                ...$this->normalizeIndexFromEntity($entity, $index),
+            ];
         }
 
         return $normalized;

tests/Integration/ODM/EntityManagerTest.php

@@ -13,6 +13,7 @@
 use EduardoMarques\DynamoPHP\Tests\Integration\Stubs\EntityA;
 use EduardoMarques\DynamoPHP\Tests\Integration\Stubs\EntityB;
 use EduardoMarques\DynamoPHP\Tests\Integration\Stubs\EntityC;
+use EduardoMarques\DynamoPHP\Tests\Integration\Stubs\EnumA;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
@@ -169,10 +170,11 @@ public function itQueriesEntitiesOnLocalIndex(): void
 
         $queryArgs = (new QueryArgs())
             ->indexName('LSI1')
-            ->keyConditionExpression('PK = :pk AND begins_with(LSI1_SK, :sk)')
+            ->keyConditionExpression('PK = :pk AND begins_with(#name, :name)')
+            ->expressionAttributeNames(['#name' => 'name'])
             ->expressionAttributeValues([
                 ':pk' => $id1,
-                ':sk' => 'J',
+                ':name' => 'J',
             ]);
 
         $result = self::$entityManager->query(EntityC::class, $queryArgs);
@@ -195,10 +197,11 @@ public function itQueriesEntitiesOnGlobalIndex(): void
 
         $queryArgs = (new QueryArgs())
             ->indexName('GSI1')
-            ->keyConditionExpression('GSI1_PK = :pk AND begins_with(GSI1_SK, :sk)')
+            ->keyConditionExpression('#type = :type AND begins_with(creationDateId, :creationDateId)')
+            ->expressionAttributeNames(['#type' => 'type'])
             ->expressionAttributeValues([
-                ':pk' => 'John Doe',
-                ':sk' => '879',
+                ':type' => EnumA::TYPE_A,
+                ':creationDateId' => '2025',
             ]);
 
         $result = self::$entityManager->query(EntityC::class, $queryArgs);

tests/Integration/Stubs/EntityC.php

@@ -20,10 +20,15 @@
     indexes: [
         new GlobalIndex(
             name: 'GSI1',
-            partitionKey: new PartitionKey(fields: ['name'], name: 'GSI1_PK'),
-            sortKey: new SortKey(fields: ['id'], name: 'GSI1_SK')
+            partitionKey: new PartitionKey(fields: ['type'], name: 'type'),
+            sortKey: new SortKey(fields: ['creationDate', 'id'], name: 'creationDateId')
         ),
-        new LocalIndex(name: 'LSI1', sortKey: new SortKey(fields: ['name'], name: 'LSI1_SK')),
+        new GlobalIndex(
+            name: 'GSI2',
+            partitionKey: new PartitionKey(fields: ['type'], name: 'type'),
+            sortKey: new SortKey(fields: ['name'], name: 'name')
+        ),
+        new LocalIndex(name: 'LSI1', sortKey: new SortKey(fields: ['name'], name: 'name')),
     ]
 )]
 final class EntityC
@@ -32,8 +37,8 @@ final class EntityC
     #[SerializedName('fullName')]
     public string $name;
 
-    #[Attribute(name: 'type')]
-    public EnumA $enumA = EnumA::TYPE_A;
+    #[Attribute]
+    public EnumA $type = EnumA::TYPE_A;
 
     public EntityB $b;