fix(idempotency): include cause in idempotency persistence layer error

aws-powertools · Aug 12, 2024 · d4f18e7 · d4f18e7
1 parent 4a87213
commit d4f18e7
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 52 deletions.
diff --git a/packages/idempotency/src/errors.ts b/packages/idempotency/src/errors.ts
@@ -97,8 +97,6 @@ class IdempotencyInconsistentStateError extends IdempotencyUnknownError {
  * Unrecoverable error from the data store
  */
 class IdempotencyPersistenceLayerError extends IdempotencyUnknownError {
-  public readonly cause: Error | undefined;
-
   public constructor(message: string, options?: ErrorOptions) {
     super(message, options);
     this.name = 'IdempotencyPersistenceLayerError';

diff --git a/packages/idempotency/tests/unit/IdempotencyHandler.test.ts b/packages/idempotency/tests/unit/IdempotencyHandler.test.ts
@@ -1,18 +1,18 @@
-/**
- * Test Idempotency Handler
- *
- * @group unit/idempotency/IdempotencyHandler
- */
-import { IdempotencyRecord } from '../../src/persistence/index.js';
 import { IdempotencyHandler } from '../../src/IdempotencyHandler.js';
+import { IdempotencyRecordStatus, MAX_RETRIES } from '../../src/constants.js';
 import {
-  IdempotencyConfig,
   IdempotencyAlreadyInProgressError,
+  IdempotencyConfig,
   IdempotencyInconsistentStateError,
   IdempotencyItemAlreadyExistsError,
   IdempotencyPersistenceLayerError,
 } from '../../src/index.js';
-import { MAX_RETRIES, IdempotencyRecordStatus } from '../../src/constants.js';
+/**
+ * Test Idempotency Handler
+ *
+ * @group unit/idempotency/IdempotencyHandler
+ */
+import { IdempotencyRecord } from '../../src/persistence/index.js';
 import { PersistenceLayerTestClass } from '../helpers/idempotencyUtils.js';
 
 const mockFunctionToMakeIdempotent = jest.fn();
@@ -198,12 +198,11 @@ describe('Class IdempotencyHandler', () => {
         .mockRejectedValue(new Error('Some error'));
 
       // Act & Assess
-      await expect(idempotentHandler.getFunctionResult()).rejects.toThrow(
-        new IdempotencyPersistenceLayerError(
-          'Failed to delete record from idempotency store',
-          new Error('Some error')
-        )
-      );
+      await expect(idempotentHandler.getFunctionResult()).rejects.toThrow({
+        name: 'IdempotencyPersistenceLayerError',
+        message: 'Failed to delete record from idempotency store',
+        cause: new Error('Some error'),
+      });
       expect(mockDeleteInProgress).toHaveBeenCalledTimes(1);
     });
 

diff --git a/packages/idempotency/tests/unit/makeHandlerIdempotent.test.ts b/packages/idempotency/tests/unit/makeHandlerIdempotent.test.ts
@@ -112,12 +112,11 @@ describe('Middleware: makeHandlerIdempotent', () => {
       .mockRejectedValue(new Error('Something went wrong'));
 
     // Act && Assess
-    await expect(handler(event, context)).rejects.toThrowError(
-      new IdempotencyPersistenceLayerError(
-        'Failed to save in progress record to idempotency store',
-        new Error('Something went wrong')
-      )
-    );
+    await expect(handler(event, context)).rejects.toThrow({
+      name: 'IdempotencyPersistenceLayerError',
+      message: 'Failed to save in progress record to idempotency store',
+      cause: new Error('Something went wrong'),
+    });
   });
   it('thows an error if the persistence layer throws an error when saving a successful operation', async () => {
     // Prepare
@@ -129,12 +128,11 @@ describe('Middleware: makeHandlerIdempotent', () => {
       .mockRejectedValue(new Error('Something went wrong'));
 
     // Act && Assess
-    await expect(handler(event, context)).rejects.toThrowError(
-      new IdempotencyPersistenceLayerError(
-        'Failed to update success record to idempotency store',
-        new Error('Something went wrong')
-      )
-    );
+    await expect(handler(event, context)).rejects.toThrow({
+      name: 'IdempotencyPersistenceLayerError',
+      message: 'Failed to update success record to idempotency store',
+      cause: new Error('Something went wrong'),
+    });
   });
   it('thows an error if the persistence layer throws an error when deleting a record', async () => {
     // Prepare
@@ -148,12 +146,11 @@ describe('Middleware: makeHandlerIdempotent', () => {
       .mockRejectedValue(new Error('Something went wrong'));
 
     // Act && Assess
-    await expect(handler(event, context)).rejects.toThrow(
-      new IdempotencyPersistenceLayerError(
-        'Failed to delete record from idempotency store',
-        new Error('Something went wrong')
-      )
-    );
+    await expect(handler(event, context)).rejects.toThrow({
+      name: 'IdempotencyPersistenceLayerError',
+      message: 'Failed to delete record from idempotency store',
+      cause: new Error('Something went wrong'),
+    });
   });
   it('returns the stored response if the operation has already been executed', async () => {
     // Prepare

diff --git a/packages/idempotency/tests/unit/makeIdempotent.test.ts b/packages/idempotency/tests/unit/makeIdempotent.test.ts
@@ -118,12 +118,11 @@ describe('Function: makeIdempotent', () => {
       .mockRejectedValue(new Error('Something went wrong'));
 
     // Act && Assess
-    await expect(handler(event, context)).rejects.toThrowError(
-      new IdempotencyPersistenceLayerError(
-        'Failed to save in progress record to idempotency store',
-        new Error('Something went wrong')
-      )
-    );
+    await expect(handler(event, context)).rejects.toThrow({
+      name: 'IdempotencyPersistenceLayerError',
+      message: 'Failed to save in progress record to idempotency store',
+      cause: new Error('Something went wrong'),
+    });
   });
   it('thows an error if the persistence layer throws an error when saving a successful operation', async () => {
     // Prepare
@@ -139,12 +138,11 @@ describe('Function: makeIdempotent', () => {
       .mockRejectedValue(new Error('Something went wrong'));
 
     // Act && Assess
-    await expect(handler(event, context)).rejects.toThrowError(
-      new IdempotencyPersistenceLayerError(
-        'Failed to update success record to idempotency store',
-        new Error('Something went wrong')
-      )
-    );
+    await expect(handler(event, context)).rejects.toThrow({
+      name: 'IdempotencyPersistenceLayerError',
+      message: 'Failed to update success record to idempotency store',
+      cause: new Error('Something went wrong'),
+    });
   });
   it('thows an error if the persistence layer throws an error when deleting a record', async () => {
     // Prepare
@@ -162,12 +160,11 @@ describe('Function: makeIdempotent', () => {
       .mockRejectedValue(new Error('Something went wrong'));
 
     // Act && Assess
-    await expect(handler(event, context)).rejects.toThrow(
-      new IdempotencyPersistenceLayerError(
-        'Failed to delete record from idempotency store',
-        new Error('Something went wrong')
-      )
-    );
+    await expect(handler(event, context)).rejects.toThrow({
+      name: 'IdempotencyPersistenceLayerError',
+      message: 'Failed to delete record from idempotency store',
+      cause: new Error('Something went wrong'),
+    });
   });
   it('returns the stored response if the operation has already been executed', async () => {
     // Prepare