Skip to content

fix(logger): reset keys on error in middleware #4122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/logger/src/middleware/middy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,10 @@ const injectLambdaContext = (
} else {
logger.clearBuffer();
}

if (isResetStateEnabled) {
logger.resetKeys();
}
}
};

Expand Down
117 changes: 117 additions & 0 deletions packages/logger/tests/unit/injectLambdaContext.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -415,4 +415,121 @@ describe('Inject Lambda Context', () => {
})
);
});

it.each([
{
case: 'middleware',
getHandler: (logger: Logger) =>
middy(async (event: { id: number }) => {
logger.info('Processing event');
logger.appendKeys({ id: event.id });
throw new Error('Test error');
}).use(
injectLambdaContext(logger, {
resetKeys: true,
})
),
},
{
case: 'decorator',
getHandler: (logger: Logger) => {
class Lambda {
@logger.injectLambdaContext({
resetKeys: true,
})
public async handler(
event: { id: number },
_context: Context
): Promise<void> {
logger.info('Processing event');
logger.appendKeys({ id: event.id });
throw new Error('Test error');
}
}
const lambda = new Lambda();
return lambda.handler.bind(lambda);
},
},
])(
'resets keys when the handler throws an error $case',
async ({ getHandler }) => {
// Prepare
const logger = new Logger();
const handler = getHandler(logger);

// Act & Assess
await expect(handler({ id: 1 }, context)).rejects.toThrow('Test error');
await expect(handler({ id: 2 }, context)).rejects.toThrow('Test error');
expect(console.info).toHaveBeenCalledTimes(2);
expect(console.info).toHaveLoggedNth(
1,
expect.objectContaining({
message: 'Processing event',
})
);
expect(console.info).toHaveLoggedNth(
2,
expect.not.objectContaining({
message: 'Processing event',
id: 1,
})
);
}
);

it.each([
{
case: 'middleware',
getHandler: (logger: Logger) =>
middy(async (event: { id: number }) => {
logger.info('Processing event');
logger.appendKeys({ id: event.id });
return true;
}).use(
injectLambdaContext(logger, {
resetKeys: true,
})
),
},
{
case: 'decorator',
getHandler: (logger: Logger) => {
class Lambda {
@logger.injectLambdaContext({
resetKeys: true,
})
public async handler(event: { id: number }, _context: Context) {
logger.info('Processing event');
logger.appendKeys({ id: event.id });
return true;
}
}
const lambda = new Lambda();
return lambda.handler.bind(lambda);
},
},
])('resets keys when the handler returns $case', async ({ getHandler }) => {
// Prepare
const logger = new Logger();
const handler = getHandler(logger);
// Act
await handler({ id: 1 }, context);
await handler({ id: 2 }, context);

// Assess
expect(console.info).toHaveBeenCalledTimes(2);
expect(console.info).toHaveLoggedNth(
1,
expect.objectContaining({
message: 'Processing event',
})
);
expect(console.info).toHaveLoggedNth(
2,
expect.not.objectContaining({
message: 'Processing event',
id: 1,
})
);
});
});
Loading