feat(idempotency): preserve original error when wrapping into IdempotencyPersistenceLayerError (#1552)

* add cause field to persistance error

* rename to error, to align with parameters package

* add error cause to middleware

Author: Alexander Schueren

packages/idempotency/src/IdempotencyHandler.ts

@@ -5,7 +5,7 @@ import {
   IdempotencyInconsistentStateError,
   IdempotencyItemAlreadyExistsError,
   IdempotencyPersistenceLayerError,
-} from './Exceptions';
+} from './errors';
 import { BasePersistenceLayer, IdempotencyRecord } from './persistence';
 import { IdempotencyConfig } from './IdempotencyConfig';
 import { MAX_RETRIES } from './constants';
@@ -80,7 +80,8 @@ export class IdempotencyHandler<U> {
         );
       } catch (e) {
         throw new IdempotencyPersistenceLayerError(
-          'Failed to delete record from idempotency store'
+          'Failed to delete record from idempotency store',
+          e as Error
         );
       }
       throw e;
@@ -92,7 +93,8 @@ export class IdempotencyHandler<U> {
       );
     } catch (e) {
       throw new IdempotencyPersistenceLayerError(
-        'Failed to update success record to idempotency store'
+        'Failed to update success record to idempotency store',
+        e as Error
       );
     }
 
@@ -153,7 +155,10 @@ export class IdempotencyHandler<U> {
           idempotencyRecord
         ) as U;
       } else {
-        throw new IdempotencyPersistenceLayerError();
+        throw new IdempotencyPersistenceLayerError(
+          'Failed to save record in progress',
+          e as Error
+        );
       }
     }
 

packages/idempotency/src/Exceptions.ts renamed to packages/idempotency/src/errors.ts

@@ -31,7 +31,17 @@ class IdempotencyInconsistentStateError extends Error {}
 /**
  * Unrecoverable error from the data store
  */
-class IdempotencyPersistenceLayerError extends Error {}
+class IdempotencyPersistenceLayerError extends Error {
+  public readonly cause: Error | undefined;
+
+  public constructor(message: string, cause?: Error) {
+    const errorMessage = cause
+      ? `${message}. This error was  caused by: ${cause.message}.`
+      : message;
+    super(errorMessage);
+    this.cause = cause;
+  }
+}
 
 /**
  * Payload does not contain an idempotent key

packages/idempotency/src/index.ts

@@ -1,4 +1,4 @@
-export * from './Exceptions';
+export * from './errors';
 export * from './IdempotencyConfig';
 export * from './idempotentDecorator';
 export * from './makeFunctionIdempotent';

packages/idempotency/src/middleware/makeHandlerIdempotent.ts

@@ -5,7 +5,7 @@ import {
   IdempotencyInconsistentStateError,
   IdempotencyItemAlreadyExistsError,
   IdempotencyPersistenceLayerError,
-} from '../Exceptions';
+} from '../errors';
 import { IdempotencyRecord } from '../persistence';
 import { MAX_RETRIES } from '../constants';
 import type {
@@ -124,7 +124,8 @@ const makeHandlerIdempotent = (
         }
       } else {
         throw new IdempotencyPersistenceLayerError(
-          'Failed to save in progress record to idempotency store'
+          'Failed to save in progress record to idempotency store',
+          error as Error
         );
       }
     }
@@ -149,7 +150,8 @@ const makeHandlerIdempotent = (
       );
     } catch (e) {
       throw new IdempotencyPersistenceLayerError(
-        'Failed to update success record to idempotency store'
+        'Failed to update success record to idempotency store',
+        e as Error
       );
     }
   };
@@ -172,7 +174,8 @@ const makeHandlerIdempotent = (
       );
     } catch (error) {
       throw new IdempotencyPersistenceLayerError(
-        'Failed to delete record from idempotency store'
+        'Failed to delete record from idempotency store',
+        error as Error
       );
     }
   };

packages/idempotency/src/persistence/BasePersistenceLayer.ts

@@ -8,7 +8,7 @@ import { BasePersistenceLayerInterface } from './BasePersistenceLayerInterface';
 import {
   IdempotencyItemAlreadyExistsError,
   IdempotencyValidationError,
-} from '../Exceptions';
+} from '../errors';
 import { LRUCache } from './LRUCache';
 
 /**

packages/idempotency/src/persistence/DynamoDBPersistenceLayer.ts

@@ -1,7 +1,7 @@
 import {
   IdempotencyItemAlreadyExistsError,
   IdempotencyItemNotFoundError,
-} from '../Exceptions';
+} from '../errors';
 import { IdempotencyRecordStatus } from '../types';
 import type { DynamoPersistenceOptions } from '../types';
 import {

packages/idempotency/src/persistence/IdempotencyRecord.ts

@@ -1,6 +1,6 @@
 import type { IdempotencyRecordOptions } from '../types';
 import { IdempotencyRecordStatus } from '../types';
-import { IdempotencyInvalidStatusError } from '../Exceptions';
+import { IdempotencyInvalidStatusError } from '../errors';
 
 /**
  * Class representing an idempotency record.

packages/idempotency/tests/unit/IdempotencyHandler.test.ts

@@ -8,7 +8,7 @@ import {
   IdempotencyInconsistentStateError,
   IdempotencyItemAlreadyExistsError,
   IdempotencyPersistenceLayerError,
-} from '../../src/Exceptions';
+} from '../../src/errors';
 import { IdempotencyRecordStatus } from '../../src/types';
 import { BasePersistenceLayer, IdempotencyRecord } from '../../src/persistence';
 import { IdempotencyHandler } from '../../src/IdempotencyHandler';
@@ -165,16 +165,20 @@ describe('Class IdempotencyHandler', () => {
     });
 
     test('when persistences store throws any error, it wraps the error to IdempotencyPersistencesLayerError', async () => {
+      const innerError = new Error('Some error');
       const mockSaveInProgress = jest
         .spyOn(mockIdempotencyOptions.persistenceStore, 'saveInProgress')
-        .mockRejectedValue(new Error('Some error'));
+        .mockRejectedValue(innerError);
       const mockDetermineResultFromIdempotencyRecord = jest
         .spyOn(IdempotencyHandler, 'determineResultFromIdempotencyRecord')
         .mockImplementation(() => 'result');
-
       await expect(idempotentHandler.processIdempotency()).rejects.toThrow(
-        IdempotencyPersistenceLayerError
+        new IdempotencyPersistenceLayerError(
+          'Failed to save record in progress',
+          innerError
+        )
       );
+
       expect(mockSaveInProgress).toHaveBeenCalledTimes(1);
       expect(mockDetermineResultFromIdempotencyRecord).toHaveBeenCalledTimes(0);
     });
@@ -323,7 +327,9 @@ describe('Class IdempotencyHandler', () => {
         .mockRejectedValue(new Error('Some error'));
 
       await expect(idempotentHandler.getFunctionResult()).rejects.toThrow(
-        IdempotencyPersistenceLayerError
+        new IdempotencyPersistenceLayerError(
+          'Failed to delete record from idempotency store. This error was  caused by: Some error.'
+        )
       );
       expect(mockDeleteInProgress).toHaveBeenCalledTimes(1);
     });

packages/idempotency/tests/unit/idempotentDecorator.test.ts

@@ -13,7 +13,7 @@ import {
   IdempotencyInconsistentStateError,
   IdempotencyItemAlreadyExistsError,
   IdempotencyPersistenceLayerError,
-} from '../../src/Exceptions';
+} from '../../src/errors';
 import { IdempotencyConfig } from '../../src';
 import { Context } from 'aws-lambda';
 import { helloworldContext } from '@aws-lambda-powertools/commons/lib/samples/resources/contexts';

packages/idempotency/tests/unit/makeFunctionIdempotent.test.ts

@@ -16,7 +16,7 @@ import {
   IdempotencyInconsistentStateError,
   IdempotencyItemAlreadyExistsError,
   IdempotencyPersistenceLayerError,
-} from '../../src/Exceptions';
+} from '../../src/errors';
 import { IdempotencyConfig } from '../../src';
 import { Context } from 'aws-lambda';