feat(logger): flush buffer on uncaught error decorator #3676
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boring-cyborg
bot
added
logger
pull-request-size
bot
added
the
size/XL
dreamorosi
requested review from
Copilot and
am29d
and removed request for
am29d
github-actions
bot
added
the
feature
There was a problem hiding this comment.
PR Overview
This PR introduces the ability to flush the log buffer when an uncaught error occurs in a Lambda handler decorated with injectLambdaContext. Key changes include:
- Adding the flushBufferOnUncaughtError option to the injectLambdaContext decorator.
- Updating docstrings to reflect the new functionality and improve clarity.
- Extending unit tests to cover buffer flushing behavior on uncaught errors.
- Introducing a new constant, UncaughtErrorLogMessage, to standardize the error message logged on uncaught errors.
Reviewed Changes
| File | Description |
|---|---|
| packages/logger/src/Logger.ts | Enhancements in the injectLambdaContext decorator and docstrings |
| packages/logger/tests/unit/logBuffer.test.ts | Additional tests covering buffer flushing on uncaught errors |
| packages/logger/src/constants.ts | New constant for uncaught error log messages |
| packages/logger/src/types/Logger.ts | Update to InjectLambdaContextOptions to include flushBufferOnUncaughtError |
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
|
am29d
approved these changes
Feb 28, 2025
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
This PR adds a new parameter to the
injectLambdaContext()class method decorator that allows customers to optionally flush a log buffer whenever their function handler throws an error.The PR also makes slight updates to some of the docstrings in the Logger class that were added during previous PRs, and updates the unit tests for the feature to reduce nesting.
Issue number: closes #3635
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.