Feature request: idempotent function wrapper

[saragerion]

Use Case

Users who can't or don't use class-based decorators or Middy should be able to make arbitrary functions idempotent by using a function wrapper. This wrapper, also known in the industry as higher-order function should take the function to be made idempotent as first argument and an object with options and configs as second one.

Solution/User Experience

import { 
  makeFunctionIdempotent, 
  DynamoDBPersistenceLayer,
  IdempotencyConfig
} from '@aws-lambda-powertools/idempotency';

const config = new IdempotencyConfig({...});
const ddbPersistenceLayer = new DynamoDBPersistenceLayer({...});

 /**
 * Function to process a single record
 */
function processRecord(record: any) {
  /* ...Function logic here... */
  return result;
} 

/**
 * Higher-order function wrapper to process a single record
 */
const processIdempotently = makeFunctionIdempotent(
  processRecord, 
 {
    persistenceStore: ddbPersistenceLayer,
    dataArgument: 'record', 
    config,
 }  
);

export const handler = async (_event: any, _context: any): Promise<void> => {
    
  const records = /*..Extract SQS/DDB stream record, etc..*/

  const results = [];
  for (const record of records) {
    results.push(processIdempotently(record));
  }
  /* ...Format and return result... */
}

The makeFunctionIdempotent function wrapper should be able wrap both async and sync functions. It should accept the wrapped function (aka the function to be made idempotent) as first argument, and an object with mandatory persistenceStore and dataArgument, as well as an optional config one. The former should be an instance of any class that extends BasePersistenceLayer, the second should be a string that represents the argument to be used for idempotency (in the wrapped function), while the latter should be an instance of the class IdempotencyConfig.

Following the Powertools for Python implementation, the wrapper should:

• return early if the POWERTOOLS_IDEMPOTENCY_DISABLED env variable has a truthy value (using EnvironmentVariableService)
• use the provided config object or instantiate a new one if none is passed
• register the Lambda context into the config object (used to manage timeouts)
• instantiate an IdempotencyHandler
• call & return the IdempotencyHandler.handle() method

This last step will ensure that the IdempotencyHandler will perform all the actions needed to make the function idempotent.

Alternative solutions

No response

Acknowledgment

• This feature request meets Lambda Powertools Tenets
• Should this be considered in other Lambda Powertools languages? i.e. Python, Java

[dreamorosi]

As far as I can tell with #1540 we completed the feature.

Closing this for the time being.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.