feat(NODE-4848): Add runtime error handling to logging #3971
Conversation
This file contains hidden or 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
aditi-khare-mongoDB
changed the title
aditi-khare-mongoDB
changed the title
nbbeeken
added
the
Primary Review
nbbeeken
suggested changes
Jan 19, 2024
nbbeeken
suggested changes
Jan 22, 2024
nbbeeken
suggested changes
Jan 22, 2024
5 tasks
addaleax
reviewed
Jan 23, 2024
src/mongo_logger.ts
Outdated
| ? value.name | ||
| : 'anonymous function'; | ||
| } catch (e) { | ||
| strToTruncate = `... ESJON failed : Error ${e.message}`; |
There was a problem hiding this comment.
There's a typo here (EJSON) but it might be worth wording this a bit more explicitly anyway:
Suggested change
| strToTruncate = `... ESJON failed : Error ${e.message}`; | |
| strToTruncate = `Extended JSON serialization failed with: ${e.message}`; |
There was a problem hiding this comment.
Sounds good to me!
nbbeeken
suggested changes
Jan 23, 2024
nbbeeken
previously approved these changes
Jan 23, 2024
nbbeeken
added
Team Review
addaleax
previously approved these changes
Jan 24, 2024
src/utils.ts
Outdated
| @@ -171,8 +171,13 @@ export function applyRetryableWrites<T extends HasRetryableWrites>(target: T, db | |||
| * @param value - An object that could be a promise | |||
| * @returns true if the provided value is a Promise | |||
| */ | |||
| export function isPromiseLike<T = any>(value?: PromiseLike<T> | void): value is Promise<T> { | |||
| return !!value && typeof value.then === 'function'; | |||
| export function isPromiseLike<T = any>(value?: unknown): value is PromiseLike<T> { | |||
There was a problem hiding this comment.
It's a obviously a tradeoff, but I'd consider doing
Suggested change
| export function isPromiseLike<T = any>(value?: unknown): value is PromiseLike<T> { | |
| export function isPromiseLike<T = unknown>(value?: unknown): value is PromiseLike<T> { |
instead so one doesn't potentially introduce a hidden any by default each time they're using this function
There was a problem hiding this comment.
Sounds good, changed it :)
aditi-khare-mongoDB
dismissed stale reviews from addaleax and nbbeeken
via
d9eb4e8
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.
Note for Reviewers
Look at changes commit by commit to easily separate async and sync changes
Description
This ticket is a subtask of NODE-4816 (Add Error Handling to the Logger).
Essentially, these changes ensure that the logger does not crash the user's application at runtime, at any point after options are parsed.
What is changing?
Add support for runtime error handling (ensure no constructors for loggers throw unless given type errors, log.write, stringifyWithMaxLen, defaultLogTransform).
Add async support for log.write function
See all unit tests defined under runtime error handling in Kickoff Document, and under mongodbLogPath stream handling (since some of this must be done at runtime).
Note: There are no changes to any of the constructors of
LoggableEventclasses or calls to emitAndLog / variants because noLoggableEventconstructors have any explicit errors thrown. In addition, no arguments toLoggableEventconstructors are ever invalid at the time of construction.Is there new documentation needed for these changes?
After NODE-5672 (Release Logger)
What is the motivation for this change?
To ensure we don't crash the user's application through the logger.
Double check the following
npm run check:lintscripttype(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript