feat(NODE-5820): Add async support for createStdioLogger #3972
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
addaleax
reviewed
Jan 22, 2024
durran
added
the
Primary Review
durran
reviewed
Jan 23, 2024
| @@ -217,10 +217,10 @@ export function createStdioLogger(stream: { | |||
| write: NodeJS.WriteStream['write']; | |||
| }): MongoDBLogWritable { | |||
| return { | |||
| write: (log: Log): unknown => { | |||
| stream.write(inspect(log, { compact: true, breakLength: Infinity }), 'utf-8'); | |||
| write: promisify((log: Log, cb: () => void): unknown => { | |||
There was a problem hiding this comment.
Is there a reason for using promisify here and not just making this an async function?
There was a problem hiding this comment.
The Node.js streams interface expects a callback, right?
|
I saw you requested re-review, just checking, I assume we're also adding a test for this? |
|
@durran @addaleax will move functionality of this PR into NODE-4848 feat(NODE-4848): Add runtime error handling to logging #3971, per tech chat discussion - so tests are in the same code changes. |
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.
Description
This ticket is a subtask of NODE-4816 (Add error handling to logging). Its testing is contained within the other subtask (NODE-4848), and I ran those tests on this code to ensure they pass separately.
Promisify
createStdioLoggerso it supports async std i/o (see here to see more information on async stdio).What is changing?
Change write signature (repeat of async write PR)
Wrap write method in createStdioLogger in promisify function
Is there new documentation needed for these changes?
After logging is released
What is the motivation for this change?
Async behavior stdio on certain environments.
Double check the following
npm run check:lintscripttype(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript