Change the LogSink interface to take an optional Context object #18
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
|
FYI, I will wait for review on this. (No rush, I know that there are a lot of things happening) |
arv
approved these changes
May 19, 2023
src/logger.ts
Outdated
Comment on lines
113
to
116
| console[level]( | ||
| ...this._format(level, ...stringified(context).concat(args)), | ||
| ); | ||
| } |
There was a problem hiding this comment.
Suggested change
| console[level]( | |
| ...this._format(level, ...stringified(context).concat(args)), | |
| ); | |
| } | |
| console[level]( | |
| ...this._format( | |
| level, | |
| ...stringified(context), | |
| ...args), | |
| ); | |
| } |
There was a problem hiding this comment.
Excellent, thank you!
src/logger.ts
Outdated
| log(level: LogLevel, context: Context | undefined, ...args: unknown[]): void { | ||
| console[level]( | ||
| logLevelPrefix[level], | ||
| ...stringified(context).concat(args).map(normalizeArgument), |
There was a problem hiding this comment.
I do not think you need to call normalizeArgument on the stringified context
There was a problem hiding this comment.
Good point, then I can unroll this one too.
src/logger.ts
Outdated
|
|
||
| constructor(level: LogLevel = 'info', logSink: LogSink = consoleLogSink) { | ||
| super(logSink, level); | ||
| private readonly _context?: Context; |
src/logger.test.ts
Outdated
| lc3.debug?.('f'); | ||
| expect(mockDebug.lastCall.args).to.deep.equal(['d=e', 'f']); | ||
| }); | ||
|
|
||
| class TestLogSink implements LogSink { | ||
| messages: [LogLevel, ...unknown[]][] = []; | ||
| // Note: Order in messages is different from log args order to verify |
There was a problem hiding this comment.
You could also have used:
messages: [LogLevel, Context | undefined, unknown[]][] = [];There was a problem hiding this comment.
Love it. Now my verification code reads as it should:
['info', {abc: 'is', easy: 'as'}, [1, 2, 3]],Thanks!
src/logger.test.ts
Outdated
| [undefined, 'info', 1, 2], | ||
| [{foo: {bar: 'baz'}}, 'debug', 3, 4], | ||
| [{boo: 'oof'}, 'info', 5, 6], | ||
| [{abc: 'is', easy: 'as'}, 'info', 1, 2, 3], |
|
LGTM |
darkgnotic
commented
May 19, 2023
src/logger.test.ts
Outdated
| lc3.debug?.('f'); | ||
| expect(mockDebug.lastCall.args).to.deep.equal(['d=e', 'f']); | ||
| }); | ||
|
|
||
| class TestLogSink implements LogSink { | ||
| messages: [LogLevel, ...unknown[]][] = []; | ||
| // Note: Order in messages is different from log args order to verify |
There was a problem hiding this comment.
Love it. Now my verification code reads as it should:
['info', {abc: 'is', easy: 'as'}, [1, 2, 3]],Thanks!
src/logger.test.ts
Outdated
| [undefined, 'info', 1, 2], | ||
| [{foo: {bar: 'baz'}}, 'debug', 3, 4], | ||
| [{boo: 'oof'}, 'info', 5, 6], | ||
| [{abc: 'is', easy: 'as'}, 'info', 1, 2, 3], |
src/logger.ts
Outdated
Comment on lines
113
to
116
| console[level]( | ||
| ...this._format(level, ...stringified(context).concat(args)), | ||
| ); | ||
| } |
There was a problem hiding this comment.
Excellent, thank you!
src/logger.ts
Outdated
| log(level: LogLevel, context: Context | undefined, ...args: unknown[]): void { | ||
| console[level]( | ||
| logLevelPrefix[level], | ||
| ...stringified(context).concat(args).map(normalizeArgument), |
There was a problem hiding this comment.
Good point, then I can unroll this one too.
src/logger.ts
Outdated
|
|
||
| constructor(level: LogLevel = 'info', logSink: LogSink = consoleLogSink) { | ||
| super(logSink, level); | ||
| private readonly _context?: Context; |
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.
Logger-side changes to support https://github.com/rocicorp/mono/issues/191
Also rename
LogContext.addContext()toLogContext.withContext()to better convey the immutability of the API.Note: breaking API change