compound keys

src/drivers/DynamoDbConnection.php

@@ -12,6 +12,8 @@
 use Yii;
 use yii\base\Component;
 use yii\base\InvalidArgumentException;
+use yii\base\InvalidCallException;
+use yii\base\InvalidConfigException;
 
 /**
  *
@@ -21,9 +23,11 @@
 class DynamoDbConnection extends Component
 {
     public string $tableName;
-    public string $partitionKey = 'id';
+    public string $partitionKeyAttribute = 'id';
+    public ?string $sortKeyAttribute = null;
     public ?string $partitionKeyPrefix = null;
-    public ?string $sortKey = null;
+    // public $defaultPartitionKey = null;
+    public $defaultSortKey = null;
     public bool $consistentRead = true;
     public array $batchConfig = [];
     public ?DynamoDbClient $client = null;
@@ -52,66 +56,47 @@ public function init(): void
 
     public function getItem($key): ?array
     {
-        try {
-            $result = $this->client->getItem([
-                'TableName'      => $this->tableName,
-                'Key'            => $this->formatKey($key),
-                'ConsistentRead' => $this->consistentRead,
-            ]);
-        } catch (DynamoDbException $e) {
-            Yii::error("Unable to get item: {$e->getMessage()}");
-            return null;
-        }
+        $result = $this->client->getItem([
+            'TableName'      => $this->tableName,
+            'Key'            => $this->formatKey($key),
+            'ConsistentRead' => $this->consistentRead,
+        ]);
 
         $item = $result['Item'] ?? null;
 
         return $item ? $this->marshaler->unmarshalItem($item) : null;
     }
 
-    public function updateItem($key, $data = null): bool
+    public function updateItem($key, array $attributes = []): bool
     {
-        $attributes = [];
-
-        if ($data) {
-            $attributes += $data;
-        }
-
-        if ($this->ttl) {
-            $attributes += [
-                $this->ttlAttribute => time() + $this->ttl,
-            ];
-        }
+        return (bool) $this->client->updateItem([
+            'TableName'        => $this->tableName,
+            'Key'              => $this->formatKey($key),
+            'AttributeUpdates' => $this->_marshalAttributeValues($this->_addTtl($attributes)),
+        ]);
+    }
 
-        try {
-            return (bool) $this->client->updateItem([
-                'TableName'        => $this->tableName,
-                'Key'              => $this->formatKey($key),
-                'AttributeUpdates' => $this->_marshalAttributeValues($attributes),
-            ]);
-        } catch (DynamoDbException $e) {
-            Yii::error("Unable to update item: {$e->getMessage()}");
-            return false;
-        }
+    public function putItem(array $item): bool
+    {
+        return (bool) $this->client->updateItem([
+            'TableName' => $this->tableName,
+            'Item' => $this->_marshalAttributeValues($this->_addTtl($item)),
+        ]);
     }
 
     public function deleteItem($key): bool
     {
-        try {
-            return (bool) $this->client->deleteItem([
-                'TableName' => $this->tableName,
-                'Key'       => $this->formatKey($key),
-            ]);
-        } catch (DynamoDbException $e) {
-            Yii::error("Unable to delete item: {$e->getMessage()}");
-            return false;
-        }
+        return (bool) $this->client->deleteItem([
+            'TableName' => $this->tableName,
+            'Key'       => $this->formatKey($key),
+        ]);
     }
 
     public function deleteExpired(): void
     {
         $scan = $this->client->getPaginator('Scan', [
             'TableName' => $this->tableName,
-            'AttributesToGet' => [$this->partitionKey],
+            'AttributesToGet' => [$this->partitionKeyAttribute],
             'ScanFilter' => [
                 $this->ttlAttribute => [
                     'ComparisonOperator' => 'LT',
@@ -128,7 +113,7 @@ public function deleteExpired(): void
         // Perform Scan and BatchWriteItem (delete) operations as needed
         foreach ($scan->search('Items') as $item) {
             $batch->delete(
-                [$this->partitionKey => $item[$this->partitionKey]],
+                [$this->partitionKeyAttribute => $item[$this->partitionKeyAttribute]],
                 $this->tableName,
             );
         }
@@ -139,13 +124,9 @@ public function deleteExpired(): void
 
     protected function formatKey($key): array
     {
-        $sortKey = null;
+        $sortKey = $this->defaultSortKey;
 
         if (is_array($key)) {
-            if (!$this->sortKey) {
-                throw new InvalidArgumentException('A sort key must be provided to use compound keys.');
-            }
-
             if (count($key) !== 2) {
                 throw new InvalidArgumentException('Compound keys must be an array with exactly 2 elements.');
             }
@@ -155,16 +136,23 @@ protected function formatKey($key): array
             $partitionKey = $key;
         }
 
+        if ($sortKey && !$this->sortKeyAttribute) {
+            throw new InvalidArgumentException('A sort key attribute must be defined to use compound keys.');
+        }
+
         $partitionKey = "{$this->partitionKeyPrefix}$partitionKey";
-        $keyValue = [
-            $this->partitionKey => $partitionKey,
+        $key = [
+            $this->partitionKeyAttribute => $partitionKey,
         ];
 
-        if ($sortKey && $this->sortKey) {
-            $keyValue[$this->sortKey] = $sortKey;
+        if ($this->sortKeyAttribute) {
+            if (!$sortKey) {
+                throw new InvalidArgumentException('A sort key attribute was specified, but no value was found.');
+            }
+            $key[$this->sortKeyAttribute] = $sortKey;
         }
 
-        return $this->marshaler->marshalItem($keyValue);
+        return $this->marshaler->marshalItem($key);
     }
 
     protected function getClient(): DynamoDbClient
@@ -225,4 +213,15 @@ private function _marshalAttributeValues(array $values): array
             'Value' => $this->marshaler->marshalValue($value),
         ], $values);
     }
+
+    private function _addTtl(array $attributes): array
+    {
+        if ($this->ttl) {
+            $attributes += [
+                $this->ttlAttribute => time() + $this->ttl,
+            ];
+        }
+
+        return $attributes;
+    }
 }

src/drivers/DynamoDbSession.php

@@ -15,6 +15,7 @@ class DynamoDbSession extends Session
      * with a DynamoDB [[Connection]] object.
      */
     public DynamoDBConnection|string|array $dynamoDb = 'dynamoDb';
+    public string $dataAttribute = 'data';
 
     /**
      * @inheritDoc
@@ -36,48 +37,39 @@ public function getUseCustomStorage(): bool
     /**
      * @inheritDoc
      */
-    public function openSession(string $savePath, string $sessionName): bool
+    public function readSession($id): string
     {
+        $item = $this->dynamoDb->getItem($id);
 
+        return $item[$this->dataAttribute] ?? '';
     }
 
     /**
      * @inheritDoc
      */
-    public function closeSession(): bool
+    public function writeSession($id, $data): bool
     {
+        $data = [
+            $this->dataAttribute => $data,
+            $this->dynamoDb->ttlAttribute => $this->dynamoDb->ttl,
+        ];
 
+        return $this->dynamoDb->updateItem($id, $data);
     }
 
     /**
      * @inheritDoc
      */
-    public function readSession(string $id): string
+    public function destroySession($id): bool
     {
-
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function writeSession(string $id, string $data): bool
-    {
-
+        return $this->dynamoDb->deleteItem($id);
     }
 
     /**
      * @inheritDoc
      */
-    public function destroySession(string $id): bool
+    public function gcSession($maxLifetime): bool
     {
-
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function gcSession(int $maxLifetime): bool
-    {
-
+        return $this->dynamoDb->deleteExpired();
     }
 }