Feature request: idempotent decorator for function methods

[saragerion]

Use case

Users who write their Lambda functions as classes should be able to make any calls method idempotent via decorator.

Solution/User Experience

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

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

class Lambda implements LambdaInterface {
  // Decorate your handler class method
  @idempotentMethod({
    persistenceStore: ddbPersistenceLayer,
    dataArgument: 'message',
    config
  })
  private myMethod(message: Record<string, unknown>, time: number): void {
    /* ...Function logic here... */
  }

  public async handler(_event: unknown, _context: unknown): Promise<void> {
    this.myMethod({ foo: 'bar' }, Date.now());
  }
}

export const handlerClass = new Lambda();
export const handler = handlerClass.handler.bind(handlerClass);

The idempotentMethod decorator should be able to decorate any class method of a LambdaInterface class, both async and sync. The decorator should accept an object with mandatory persistenceStore and dataArgument fields, 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 decorated method), while the latter should be an instance of the class IdempotencyConfig.

Following the Powertools for Python implementation, the decorator 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]

We have decided to hold back the decorator and not include it in the beta release.

Read more about why in #1375.

[dreamorosi]

Given that Powertools for AWS (Python) is deprecating decorator usage we have decided to not implement this feature in this version.

EDIT: In the previous edit of this message I mistakenly referred to the deprecation of the Batch Processing decorator in Powertools for AWS (Python), now marked as "legacy", and mixed it with the Idempotency utility which has no plans of deprecating decorator-based usage. I regret the mistake and apologize for the confusion it might have caused.

---

At the moment we are not planning on implementing the decorator for Idempotency in Powertools for AWS (TypeScript) but we are are open to reconsider this decision in the future if there's enough customer demand.

For now we will remove it from the backlog.

[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.