feat(idempotency): support for Redis as idempotency backend

packages/idempotency/package.json

@@ -52,6 +52,14 @@
       "import": "./lib/esm/types/DynamoDBPersistence.js",
       "require": "./lib/cjs/types/DynamoDBPersistence.js"
     },
+    "./redis": {
+      "import": "./lib/esm/persistence/RedisPersistenceLayer.js",
+      "require": "./lib/cjs/persistence/RedisPersistenceLayer.js"
+    },
+    "./redis/types": {
+      "import": "./lib/esm/types/RedisPersistence.js",
+      "require": "./lib/cjs/types/RedisPersistence.js"
+    },
     "./middleware": {
       "import": "./lib/esm/middleware/makeHandlerIdempotent.js",
       "require": "./lib/cjs/middleware/makeHandlerIdempotent.js"
@@ -75,6 +83,14 @@
         "lib/cjs/types/DynamoDBPersistence.d.ts",
         "lib/esm/types/DynamoDBPersistence.d.ts"
       ],
+      "redis": [
+        "lib/cjs/persistence/RedisPersistenceLayer.d.ts",
+        "lib/esm/persistence/RedisPersistenceLayer.d.ts"
+      ],
+      "redis/types": [
+        "lib/cjs/types/RedisPersistence.d.ts",
+        "lib/esm/types/RedisPersistence.d.ts"
+      ],
       "middleware": [
         "lib/cjs/middleware/makeHandlerIdempotent.d.ts",
         "lib/esm/middleware/makeHandlerIdempotent.d.ts"
@@ -104,7 +120,9 @@
   "peerDependencies": {
     "@aws-sdk/client-dynamodb": ">=3.x",
     "@aws-sdk/lib-dynamodb": ">=3.x",
-    "@middy/core": "4.x || 5.x || 6.x"
+    "@middy/core": "4.x || 5.x || 6.x",
+    "@redis/client": "^5.0.1",
+    "@valkey/valkey-glide": "^1.3.4"
   },
   "peerDependenciesMeta": {
     "@aws-sdk/client-dynamodb": {
@@ -115,6 +133,12 @@
     },
     "@middy/core": {
       "optional": true
+    },
+    "@redis/client": {
+      "optional": true
+    },
+    "@valkey/valkey-glide": {
+      "optional": true
     }
   },
   "keywords": [

packages/idempotency/src/constants.ts

@@ -1,3 +1,4 @@
+import type { BasePersistenceAttributes } from './types/BasePersistenceLayer.js';
 /**
  * Number of times to retry a request in case of `IdempotencyInconsistentStateError`
  *
@@ -20,4 +21,22 @@ const IdempotencyRecordStatus = {
   EXPIRED: 'EXPIRED',
 } as const;
 
-export { IdempotencyRecordStatus, MAX_RETRIES };
+/**
+ * Base persistence attribute key names for persistence layers
+ */
+const PERSISTENCE_ATTRIBUTE_KEY_MAPPINGS: Record<
+  keyof Required<BasePersistenceAttributes>,
+  string
+> = {
+  statusAttr: 'status',
+  expiryAttr: 'expiration',
+  inProgressExpiryAttr: 'in_progress_expiration',
+  dataAttr: 'data',
+  validationKeyAttr: 'validation',
+} as const;
+
+export {
+  IdempotencyRecordStatus,
+  MAX_RETRIES,
+  PERSISTENCE_ATTRIBUTE_KEY_MAPPINGS,
+};

packages/idempotency/src/errors.ts

@@ -113,6 +113,16 @@ class IdempotencyKeyError extends IdempotencyUnknownError {
   }
 }
 
+/**
+ * Error with the persistence layer's consistency, needs to be removed
+ */
+class IdempotencyPersistenceConsistencyError extends IdempotencyUnknownError {
+  public constructor(message: string, options?: ErrorOptions) {
+    super(message, options);
+    this.name = 'IdempotencyPersistenceConsistencyError';
+  }
+}
+
 export {
   IdempotencyUnknownError,
   IdempotencyItemAlreadyExistsError,
@@ -122,5 +132,6 @@ export {
   IdempotencyValidationError,
   IdempotencyInconsistentStateError,
   IdempotencyPersistenceLayerError,
+  IdempotencyPersistenceConsistencyError,
   IdempotencyKeyError,
 };

packages/idempotency/src/index.ts

@@ -12,4 +12,7 @@ export {
 export { IdempotencyConfig } from './IdempotencyConfig.js';
 export { makeIdempotent } from './makeIdempotent.js';
 export { idempotent } from './idempotencyDecorator.js';
-export { IdempotencyRecordStatus } from './constants.js';
+export {
+  IdempotencyRecordStatus,
+  PERSISTENCE_ATTRIBUTE_KEY_MAPPINGS,
+} from './constants.js';

packages/idempotency/src/persistence/BasePersistenceLayer.ts

@@ -30,7 +30,7 @@ abstract class BasePersistenceLayer implements BasePersistenceLayerInterface {
   // envVarsService is always initialized in the constructor
   private envVarsService!: EnvironmentVariablesService;
   private eventKeyJmesPath?: string;
-  private expiresAfterSeconds: number = 60 * 60; // 1 hour default
+  protected expiresAfterSeconds: number = 60 * 60; // 1 hour default
   private hashFunction = 'md5';
   private payloadValidationEnabled = false;
   private throwOnNoIdempotencyKey = false;

packages/idempotency/src/persistence/DynamoDBPersistenceLayer.ts

@@ -7,13 +7,15 @@ import {
   ConditionalCheckFailedException,
   DeleteItemCommand,
   DynamoDBClient,
-  type DynamoDBClientConfig,
   GetItemCommand,
   PutItemCommand,
   UpdateItemCommand,
 } from '@aws-sdk/client-dynamodb';
 import { marshall, unmarshall } from '@aws-sdk/util-dynamodb';
-import { IdempotencyRecordStatus } from '../constants.js';
+import {
+  IdempotencyRecordStatus,
+  PERSISTENCE_ATTRIBUTE_KEY_MAPPINGS,
+} from '../constants.js';
 import {
   IdempotencyItemAlreadyExistsError,
   IdempotencyItemNotFoundError,
@@ -49,7 +51,6 @@ import { IdempotencyRecord } from './IdempotencyRecord.js';
  */
 class DynamoDBPersistenceLayer extends BasePersistenceLayer {
   private client: DynamoDBClient;
-  private clientConfig: DynamoDBClientConfig = {};
   private dataAttr: string;
   private expiryAttr: string;
   private inProgressExpiryAttr: string;
@@ -65,12 +66,18 @@ class DynamoDBPersistenceLayer extends BasePersistenceLayer {
 
     this.tableName = config.tableName;
     this.keyAttr = config.keyAttr ?? 'id';
-    this.statusAttr = config.statusAttr ?? 'status';
-    this.expiryAttr = config.expiryAttr ?? 'expiration';
+    this.statusAttr =
+      config.statusAttr ?? PERSISTENCE_ATTRIBUTE_KEY_MAPPINGS.statusAttr;
+    this.expiryAttr =
+      config.expiryAttr ?? PERSISTENCE_ATTRIBUTE_KEY_MAPPINGS.expiryAttr;
     this.inProgressExpiryAttr =
-      config.inProgressExpiryAttr ?? 'in_progress_expiration';
-    this.dataAttr = config.dataAttr ?? 'data';
-    this.validationKeyAttr = config.validationKeyAttr ?? 'validation';
+      config.inProgressExpiryAttr ??
+      PERSISTENCE_ATTRIBUTE_KEY_MAPPINGS.inProgressExpiryAttr;
+    this.dataAttr =
+      config.dataAttr ?? PERSISTENCE_ATTRIBUTE_KEY_MAPPINGS.dataAttr;
+    this.validationKeyAttr =
+      config.validationKeyAttr ??
+      PERSISTENCE_ATTRIBUTE_KEY_MAPPINGS.validationKeyAttr;
     if (config.sortKeyAttr === this.keyAttr) {
       throw new Error(
         `keyAttr [${this.keyAttr}] and sortKeyAttr [${config.sortKeyAttr}] cannot be the same!`

packages/idempotency/src/persistence/IdempotencyRecord.ts

@@ -13,7 +13,7 @@ import type { DynamoDBPersistenceLayer } from './DynamoDBPersistenceLayer.js';
  */
 class IdempotencyRecord {
   /**
-   * The expiry timestamp of the record in milliseconds UTC.
+   * The expiry timestamp of the record in seconds UTC.
    */
   public expiryTimestamp?: number;
   /**