feat(idempotency): add custom idempotency key support with keyPrefix option

Author: shdq

packages/idempotency/src/IdempotencyHandler.ts

@@ -51,6 +51,10 @@ export class IdempotencyHandler<Func extends AnyFunction> {
    * Idempotency configuration options.
    */
   readonly #idempotencyConfig: IdempotencyConfig;
+  /**
+   * Custom prefix to be used when generating the idempotency key.
+   */
+  readonly #keyPrefix: string | undefined;
   /**
    * Persistence layer used to store the idempotency records.
    */
@@ -69,18 +73,21 @@ export class IdempotencyHandler<Func extends AnyFunction> {
       idempotencyConfig,
       functionArguments,
       persistenceStore,
+      keyPrefix,
       thisArg,
     } = options;
     this.#functionToMakeIdempotent = functionToMakeIdempotent;
     this.#functionPayloadToBeHashed = functionPayloadToBeHashed;
     this.#idempotencyConfig = idempotencyConfig;
+    this.#keyPrefix = keyPrefix;
     this.#functionArguments = functionArguments;
     this.#thisArg = thisArg;
 
     this.#persistenceStore = persistenceStore;
 
     this.#persistenceStore.configure({
       config: this.#idempotencyConfig,
+      keyPrefix: this.#keyPrefix,
     });
   }
 

packages/idempotency/src/makeIdempotent.ts

@@ -79,7 +79,7 @@ function makeIdempotent<Func extends AnyFunction>(
   fn: Func,
   options: ItempotentFunctionOptions<Parameters<Func>>
 ): (...args: Parameters<Func>) => ReturnType<Func> {
-  const { persistenceStore, config } = options;
+  const { persistenceStore, config, keyPrefix } = options;
   const idempotencyConfig = config ? config : new IdempotencyConfig({});
 
   if (!idempotencyConfig.isEnabled()) return fn;
@@ -102,6 +102,7 @@ function makeIdempotent<Func extends AnyFunction>(
       functionToMakeIdempotent: fn,
       idempotencyConfig: idempotencyConfig,
       persistenceStore: persistenceStore,
+      keyPrefix: keyPrefix,
       functionArguments: args,
       functionPayloadToBeHashed,
       thisArg: this,

packages/idempotency/src/persistence/BasePersistenceLayer.ts

@@ -48,13 +48,15 @@ abstract class BasePersistenceLayer implements BasePersistenceLayerInterface {
    *
    * @param {BasePersistenceLayerConfigureOptions} options - configuration object for the persistence layer
    */
-    public configure(options: BasePersistenceLayerOptions): void {
-      // Extracting the idempotency config from the config object for easier access
-      const { config: idempotencyConfig } = options;
-  
-      if (options?.functionName && options.functionName.trim() !== '') {
-        this.idempotencyKeyPrefix = `${this.idempotencyKeyPrefix}.${options.functionName}`;
-      }
+  public configure(options: BasePersistenceLayerOptions): void {
+    // Extracting the idempotency configuration from the options for easier access
+    const { config: idempotencyConfig, keyPrefix, functionName } = options;
+
+    if (keyPrefix?.trim()) {
+      this.idempotencyKeyPrefix = keyPrefix.trim();
+    } else if (functionName?.trim()) {
+      this.idempotencyKeyPrefix = `${this.idempotencyKeyPrefix}.${functionName.trim()}`;
+    }
 
     // Prevent reconfiguration
     if (this.configured) {

packages/idempotency/src/types/IdempotencyOptions.ts

@@ -19,6 +19,7 @@ import type { IdempotencyRecord } from '../persistence/IdempotencyRecord.js';
 type IdempotencyLambdaHandlerOptions = {
   persistenceStore: BasePersistenceLayer;
   config?: IdempotencyConfig;
+  keyPrefix?: string;
 };
 
 /**
@@ -137,6 +138,10 @@ type IdempotencyHandlerOptions = {
    * Idempotency configuration options.
    */
   idempotencyConfig: IdempotencyConfig;
+  /**
+   * The custom idempotency key prefix.
+   */
+  keyPrefix?: string;
   /**
    * Persistence layer used to store the idempotency records.
    */