Consolidate logging and introduce auto-prefix #7731
There are no files selected for viewing
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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,6 @@ | |
| "rimraf": "^4.4.1" | ||
| }, | ||
| "peerDependencies": { | ||
| "@ogre-tools/injectable": "^16.1.0" | ||
| } | ||
| } | ||
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 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 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 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 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 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 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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| import { createContainer, getInjectable } from "@ogre-tools/injectable"; | ||
| import { registerFeature } from "@k8slens/feature-core"; | ||
| import { loggerFeature } from "./feature"; | ||
| import { winstonLoggerInjectable } from "./winston-logger.injectable"; | ||
|
|
||
| import { | ||
| logDebugInjectionToken, | ||
| logErrorInjectionToken, | ||
| logInfoInjectionToken, | ||
| logSillyInjectionToken, | ||
| logWarningInjectionToken, | ||
| } from "./logger.injectable"; | ||
|
|
||
| import { getFeature } from "@k8slens/feature-core/src/feature"; | ||
|
|
||
| describe("logger", () => { | ||
| [ | ||
| { scenario: "debug", injectionToken: logDebugInjectionToken }, | ||
| { scenario: "info", injectionToken: logInfoInjectionToken }, | ||
| { scenario: "warn", injectionToken: logWarningInjectionToken }, | ||
| { scenario: "error", injectionToken: logErrorInjectionToken }, | ||
| { scenario: "silly", injectionToken: logSillyInjectionToken }, | ||
| ].forEach(({ scenario, injectionToken }) => { | ||
| it(`given not inside a Feature, when logging "${scenario}", does so without a prefix`, () => { | ||
| const di = createContainer("irrelevant"); | ||
|
|
||
| registerFeature(di, loggerFeature); | ||
|
|
||
| const winstonLoggerStub = { [scenario]: jest.fn() } as any; | ||
|
|
||
| di.override(winstonLoggerInjectable, () => winstonLoggerStub); | ||
|
|
||
| const logScenario = di.inject(injectionToken); | ||
|
|
||
| logScenario("some-message", "some-data"); | ||
|
|
||
| expect(winstonLoggerStub[scenario]).toHaveBeenCalledWith( | ||
| "some-message", | ||
| "some-data" | ||
| ); | ||
| }); | ||
|
|
||
| it(`given inside a Feature, when logging "${scenario}", does so with Feature's id as prefix`, () => { | ||
| const di = createContainer("irrelevant"); | ||
|
|
||
| const logScenarioInFeature = getInjectable({ | ||
| id: "some-functionality", | ||
| instantiate: (di) => di.inject(injectionToken), | ||
| }); | ||
|
|
||
|
|
||
| const someFeature = getFeature({ | ||
| id: "some-feature", | ||
|
|
||
| register: (di) => { | ||
| di.register(logScenarioInFeature); | ||
| }, | ||
|
|
||
| dependencies: [loggerFeature], | ||
| }); | ||
|
|
||
| registerFeature(di, someFeature); | ||
|
|
||
| const winstonLoggerStub = { [scenario]: jest.fn() } as any; | ||
|
|
||
| di.override(winstonLoggerInjectable, () => winstonLoggerStub); | ||
|
|
||
| const logScenario = di.inject(logScenarioInFeature); | ||
|
|
||
| logScenario("some-message", "some-data"); | ||
|
|
||
| expect(winstonLoggerStub[scenario]).toHaveBeenCalledWith( | ||
| "[SOME-FEATURE]: some-message", | ||
| "some-data" | ||
| ); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also why are these categorically better?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Depending from something that you don't use completely is considered as bad practice. (Interface segregation principle) E.g. if you depend from
loggerwhich is object containing multiple methods, you'll likely use only one of them. This means that e.g. in the unit tests you have to override stuff that you are not interested.