Bug: Lambda context access in batch processing record handler

[erikayao93]

Expected Behaviour

Based on the Python implementation, the record handler should be defined to accept a Context object in order to access the Lambda context.

Current Behaviour

Currently, the processor will pass the entire BatchProcessingOptions object to the handler, so if a handler is defined matching a Python handler, expecting a context parameter of type Context, the Context attributes and methods will be inaccessible.

Code snippet

const recordHandler = (record: SQSRecord, lambdaContext?: Context): void => {
  const payload = record.body;
  if (payload) {
    const item = JSON.parse(payload);
    logger.info('Processed item', { item });
  }
  if (lambdaContext) {
    logger.info('Remaining time', {
      time: lambdaContext.getRemainingTimeInMillis(),
    });
  }
};

Steps to Reproduce

This code is from the documentation example. When running the example, there will be an error that getRemainingTimeInMillis() is not a function.

Possible Solution

In order to have the code work by redefining the handler, it has to be something like this:

const recordHandler = (record: SQSRecord, options?: BatchProcessingOptions): void => {
    const payload = record.body;
    if (payload) {
        const item = JSON.parse(payload);
        logger.info('Processed item', { item });
    }
    if (options) {
        logger.info('Remaining time', {
            time: options.context.getRemainingTimeInMillis(),
        });
    }
};

Otherwise, the processor should be redefined to pass a Context object to the handler instead of a BatchProcessingOptions type object.

Powertools for AWS Lambda (TypeScript) version

latest

AWS Lambda function runtime

16.x

Packaging format used

npm

Execution logs

"msg": "All records failed processing. 1 individual errors logged separately below.",
    "childErrors": [
        {
            "errorType": "TypeError",
            "errorMessage": "e.getRemainingTimeInMillis is not a function",
            "stack": [
                "TypeError: e.getRemainingTimeInMillis is not a function",
                "    at xe.Ys [as handler] (/var/task/index.js:7:24441)",
                "    at xe.processRecord (/var/task/index.js:4:3142)",
                "    at xe.process (/var/task/index.js:4:978)",
                "    at kr (/var/task/index.js:5:88)",
                "    at Runtime.$s [as handler] (/var/task/index.js:7:24514)",
                "    at Runtime.handleOnceNonStreaming (file:///var/runtime/index.mjs:1083:29)"
            ]
        }
    ],

[dreamorosi]

Hi Erika, thank you for opening this issue. From a first look in the codebase it seems that the issue is valid.

If you or anyone bumping into this is interested in proposing a PR, I'd be happy to help you get it merged. Otherwise we'll work on a fix before the next release later next week.

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

[github-actions]

This is now released under v1.13.0 version!