feat: added branch to handle conditional check failure

Author: vgphoenixcampos

packages/idempotency/src/persistence/DynamoDbPersistenceLayer.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-empty-function */
-import { DynamoDB } from '@aws-sdk/client-dynamodb';
+import { DynamoDB, DynamoDBServiceException } from '@aws-sdk/client-dynamodb';
 import { DynamoDBDocument, GetCommandOutput } from '@aws-sdk/lib-dynamodb';
-import { IdempotencyItemNotFoundError } from '../Exceptions';
+import { IdempotencyItemAlreadyExistsError, IdempotencyItemNotFoundError } from '../Exceptions';
 import { IdempotencyRecordStatus } from '../types/IdempotencyRecordStatus';
 import { IdempotencyRecord, PersistenceLayer } from './PersistenceLayer';
 
@@ -46,7 +46,15 @@ class DynamoDBPersistenceLayer extends PersistenceLayer {
     const idempotencyKeyExpired = '#expiry < :now';
     const notInProgress = 'NOT #status = :inprogress';
     const conditionalExpression = `${idempotencyKeyDoesNotExist} OR ${idempotencyKeyExpired} OR ${notInProgress}`;
-    await table.put({ TableName: this.tableName, Item: item, ExpressionAttributeNames: { '#id': this.key_attr, '#expiry': this.expiry_attr, '#status': this.status_attr }, ExpressionAttributeValues: { ':now': Date.now(), ':inprogress': IdempotencyRecordStatus.INPROGRESS }, ConditionExpression: conditionalExpression });
+    try {
+      await table.put({ TableName: this.tableName, Item: item, ExpressionAttributeNames: { '#id': this.key_attr, '#expiry': this.expiry_attr, '#status': this.status_attr }, ExpressionAttributeValues: { ':now': Date.now(), ':inprogress': IdempotencyRecordStatus.INPROGRESS }, ConditionExpression: conditionalExpression });
+    } catch (e){
+      if ((e as DynamoDBServiceException).name === 'ConditionalCheckFailedException'){
+        throw new IdempotencyItemAlreadyExistsError();
+      }
+
+      throw e;
+    }
   }
 
   protected async _updateRecord(record: IdempotencyRecord): Promise<void> {

packages/idempotency/tests/unit/persistence/DynamoDbPersistenceLayer.test.ts

@@ -1,7 +1,7 @@
 import { DeleteCommand, DynamoDBDocument, GetCommand, PutCommand, UpdateCommand } from '@aws-sdk/lib-dynamodb';
 import { mockClient } from 'aws-sdk-client-mock';
 import 'aws-sdk-client-mock-jest';
-import { IdempotencyItemNotFoundError } from '../../../src/Exceptions';
+import { IdempotencyItemAlreadyExistsError, IdempotencyItemNotFoundError } from '../../../src/Exceptions';
 import { DynamoDBPersistenceLayer } from '../../../src/persistence/DynamoDbPersistenceLayer';
 import { IdempotencyRecord } from '../../../src/persistence/IdempotencyRecord';
 import { IdempotencyRecordStatus } from '../../../src/types/IdempotencyRecordStatus';
@@ -36,7 +36,7 @@ describe('Class: DynamoDbPersistenceLayer', () => {
   });
 
   describe('Method: _putRecord', () => {
-    test('when called with a record that succeeds condition, it puts record in dynamo table', () => {
+    test('when called with a record that succeeds condition, it puts record in dynamo table', async () => {
       // Prepare
       const tableName = 'tableName';
       const persistenceLayer = new TestDynamoPersistenceLayer(tableName);
@@ -53,7 +53,7 @@ describe('Class: DynamoDbPersistenceLayer', () => {
       const dynamoClient = mockClient(DynamoDBDocument).on(PutCommand).resolves({});
 
       // Act
-      persistenceLayer._putRecord(record);
+      await persistenceLayer._putRecord(record);
 
       // Assess
       expect(dynamoClient).toReceiveCommandWith(PutCommand, {
@@ -64,6 +64,76 @@ describe('Class: DynamoDbPersistenceLayer', () => {
         ConditionExpression: 'attribute_not_exists(#id) OR #expiry < :now OR NOT #status = :inprogress'
       });
     });
+
+    test('when called with a record that fails condition, it throws IdempotencyItemAlreadyExistsError', async () => {
+      // Prepare
+      const tableName = 'tableName';
+      const persistenceLayer = new TestDynamoPersistenceLayer(tableName);
+
+      const key = 'key';
+      const status = IdempotencyRecordStatus.EXPIRED;
+      const expiryTimestamp = 0;
+      const inProgressExpiryTimestamp = 0;
+      const record = new IdempotencyRecord(key, status, expiryTimestamp, inProgressExpiryTimestamp, undefined, undefined);
+
+      const currentDate = 1;
+      jest.spyOn(Date, 'now').mockReturnValue(currentDate);
+
+      const dynamoClient = mockClient(DynamoDBDocument).on(PutCommand).rejects({ name: 'ConditionalCheckFailedException' });
+
+      // Act
+      let error: unknown;
+      try {
+        await persistenceLayer._putRecord(record);
+      } catch (e){
+        error = e;
+      }
+
+      // Assess
+      expect(dynamoClient).toReceiveCommandWith(PutCommand, {
+        TableName: tableName,
+        Item: { 'id': key, 'expiration': expiryTimestamp, status: status },
+        ExpressionAttributeNames: { '#id': 'id', '#expiry': 'expiration', '#status': 'status' },
+        ExpressionAttributeValues: { ':now': currentDate, ':inprogress': IdempotencyRecordStatus.INPROGRESS },
+        ConditionExpression: 'attribute_not_exists(#id) OR #expiry < :now OR NOT #status = :inprogress'
+      });
+      expect(error).toBeInstanceOf(IdempotencyItemAlreadyExistsError);
+    });
+
+    test('when encountering an unknown error, it throws the causing error', async () => {
+      // Prepare
+      const tableName = 'tableName';
+      const persistenceLayer = new TestDynamoPersistenceLayer(tableName);
+
+      const key = 'key';
+      const status = IdempotencyRecordStatus.EXPIRED;
+      const expiryTimestamp = 0;
+      const inProgressExpiryTimestamp = 0;
+      const record = new IdempotencyRecord(key, status, expiryTimestamp, inProgressExpiryTimestamp, undefined, undefined);
+
+      const currentDate = 1;
+      jest.spyOn(Date, 'now').mockReturnValue(currentDate);
+
+      const dynamoClient = mockClient(DynamoDBDocument).on(PutCommand).rejects(new Error());
+
+      // Act
+      let error: unknown;
+      try {
+        await persistenceLayer._putRecord(record);
+      } catch (e){
+        error = e;
+      }
+
+      // Assess
+      expect(dynamoClient).toReceiveCommandWith(PutCommand, {
+        TableName: tableName,
+        Item: { 'id': key, 'expiration': expiryTimestamp, status: status },
+        ExpressionAttributeNames: { '#id': 'id', '#expiry': 'expiration', '#status': 'status' },
+        ExpressionAttributeValues: { ':now': currentDate, ':inprogress': IdempotencyRecordStatus.INPROGRESS },
+        ConditionExpression: 'attribute_not_exists(#id) OR #expiry < :now OR NOT #status = :inprogress'
+      });
+      expect(error).toBe(error);
+    });
   });
 
   describe('Method: _getRecord', () => {