feat(logging): support logger instances #5941
Merged
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
This comment was marked as resolved.
This comment was marked as resolved.
jpinkney-aws
approved these changes
Nov 7, 2024
Problem:
`getLogger('foo')` returns a global singleton, so the "current topic"
only is stored until the next `getLogger` call.
Solution:
Modify `getLogger('foo')` to return a wrapper which stores its topic.
This allows modules to declare their own module-local shared logger:
const logger = getLogger('foo')
justinmk3
force-pushed
the
logtopic
branch
2 times, most recently
from
9925427 to
11f8839
Compare
justinmk3
commented
Nov 13, 2024
Comment on lines
-199
to
+197
| ) | ||
| assert.strictEqual(loggerErrorStub.calledOnce, true) | ||
| assert.strictEqual(loggerErrorStub.firstCall.args[0], 'readFileSync: Failed to read file at path %s %O') | ||
| assert.strictEqual(loggerErrorStub.firstCall.args[1], fileUri.fsPath) | ||
| assert(loggerErrorStub.firstCall.args[2] instanceof Error) | ||
| } finally { | ||
| loggerErrorStub.restore() | ||
| } | ||
| await assert.rejects( | ||
| async () => await remoteInvokeWebview.promptFile(), | ||
| new Error('Failed to read selected file') | ||
| ) | ||
| assertLogsContain('readFileSync: Failed to read file at path %s %O', true, 'error') |
There was a problem hiding this comment.
Test actual state instead of mocks. Saves lots of code, finds actual bugs, and gives meaningful tests instead of tests that break for no reason.
justinmk3
commented
Nov 13, 2024
|
|
||
| it('logs the provided error, but is wrapped in ToolkitErrors for more context', function () { | ||
| // The method is being tested due to its fragile implementation. This test | ||
| // protects against changes in the underlying logAndShowError() implementation. | ||
|
|
||
| const inputError = new Error('Random Error') | ||
|
|
||
| handleWebviewError(inputError, myWebviewId, myCommand) | ||
| const err = handleWebviewError(inputError, myWebviewId, myCommand) |
There was a problem hiding this comment.
Test the actual state! No mocks needed.
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.
Problem
getLogger('foo')returns a global singleton, so the "current topic" only is stored until the nextgetLoggercall.Solution
Modify
getLogger('foo')to return a wrapper which stores its topic. This allows modules to declare their own module-local shared logger:License: I confirm that my contribution is made under the terms of the Apache 2.0 license.