Bug: clearState not working when lambda throws error

[Crafoord]

Bug description

When using addPersistentLogAttributes :

logger.addPersistentLogAttributes({ memberId: 'test'  });

and using the middy to clearState:

export const handler = middy(lambdaHandler).use(
  injectLambdaContext(logger, { clearState: true })
);

and then exiting the lambda by throwing an error, the next invocation will still have the persistentLogAttributes present. My guess is that the middleware never runs because of the error.

Expected Behavior

When lambda crashes the middleware should still clearState.

Current Behavior

When lambda crashes the middleware does not clearState.

Possible Solution

I guess there could be a way of handling this by not using middleware but there is no documentation of how to clearState without it.

Steps to Reproduce

1. create handler like:

import { Handler } from 'aws-lambda';
import middy from '@middy/core';
import { injectLambdaContext, Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const lambdaHandler: Handler = async (event) => {
  logger.info('Before adding memberId');
  logger.addPersistentLogAttributes({ memberId: 'test'  });
  logger.info('After adding memberId');

  throw new Error();
};

export const handler = middy(lambdaHandler).use(
  injectLambdaContext(logger, { clearState: true })
);

2. invoce lambda
3. check logs, Before adding memberId will not have memberId property, After adding memberId will have memberId: test
4. invoce lambda again
5. check logs Before adding memberId will have memberId: test (which is not supposed to be there).

Environment

"@aws-lambda-powertools/logger": "^1.0.2",
"@middy/core": "^3.1.0"

Lambda runtime: nodejs16.x

[dreamorosi]

Hey @Crafoord thank you for reporting this and providing a reproduction example.

Please give us some time to look into it, we'll get back to you as soon as we can.

[saragerion]

Thanks again for reporting this bug @Crafoord.
I was able to reproduce this issue as well.

Source code:
https://github.com/saragerion/serverless-typescript-demo/blob/1027-bug-logger-clearstate-not-working-when-lambda-throws-error/src/api/get-products.ts#L20

CloudWatch Logs Insights query:

fields message, memberId, function_request_id, @timestamp
| filter service = 'serverless-typescript-demo'
| filter function_name LIKE /GetProducts/
| sort @timestamp desc
| limit 20

Logs output:

We will start working on a fix right away and adding this scenario to our E2E tests.

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

[saragerion]

This will be part of the next release. I am going to add the scenario in our E2E tests in a future PR (it requires some refactoring).