mirror of
https://github.com/lensapp/lens.git
synced 2024-09-11 09:25:26 +03:00
feat: Implement automatic Feature-specific prefixing for logging
Co-authored-by: Janne Savolainen <janne.savolainen@live.fi> Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>
This commit is contained in:
parent
2e4aba735f
commit
f9e5f9bf43
@ -2,9 +2,16 @@
|
||||
* Copyright (c) OpenLens Authors. All rights reserved.
|
||||
* Licensed under MIT License. See LICENSE in root directory for more information.
|
||||
*/
|
||||
import { getInjectable, getInjectionToken } from "@ogre-tools/injectable";
|
||||
import { kebabCase, toUpper } from "lodash/fp";
|
||||
import {
|
||||
DiContainerForInjection,
|
||||
getInjectable,
|
||||
getInjectionToken,
|
||||
lifecycleEnum,
|
||||
} from "@ogre-tools/injectable";
|
||||
import type { Logger } from "./logger";
|
||||
import { winstonLoggerInjectable } from "./winston-logger.injectable";
|
||||
import { pipeline } from "@ogre-tools/fp";
|
||||
|
||||
export const loggerInjectionToken = getInjectionToken<Logger>({
|
||||
id: "logger-injection-token",
|
||||
@ -46,32 +53,64 @@ export const logSillyInjectionToken = getInjectionToken<LogFunction>({
|
||||
id: "log-silly-injection-token",
|
||||
});
|
||||
|
||||
const screamingKebabCase = (str: string) => pipeline(str, kebabCase, toUpper);
|
||||
|
||||
const getLogFunctionFor =
|
||||
(scenario: keyof Logger) =>
|
||||
(di: DiContainerForInjection): LogFunction => {
|
||||
const winstonLogger = di.inject(winstonLoggerInjectable);
|
||||
|
||||
return (message, ...data) => {
|
||||
winstonLogger[scenario](
|
||||
di.sourceNamespace
|
||||
? `[${screamingKebabCase(di.sourceNamespace)}]: ${message}`
|
||||
: message,
|
||||
...data
|
||||
);
|
||||
};
|
||||
};
|
||||
|
||||
export const logDebugInjectable = getInjectable({
|
||||
id: "log-debug",
|
||||
instantiate: (di): LogFunction => di.inject(winstonLoggerInjectable).debug,
|
||||
instantiate: getLogFunctionFor("debug"),
|
||||
injectionToken: logDebugInjectionToken,
|
||||
lifecycle: lifecycleEnum.keyedSingleton({
|
||||
getInstanceKey: (di) => di.sourceNamespace,
|
||||
}),
|
||||
});
|
||||
|
||||
export const logInfoInjectable = getInjectable({
|
||||
id: "log-info",
|
||||
instantiate: (di): LogFunction => di.inject(winstonLoggerInjectable).info,
|
||||
instantiate: getLogFunctionFor("info"),
|
||||
injectionToken: logInfoInjectionToken,
|
||||
lifecycle: lifecycleEnum.keyedSingleton({
|
||||
getInstanceKey: (di) => di.sourceNamespace,
|
||||
}),
|
||||
});
|
||||
|
||||
export const logWarningInjectable = getInjectable({
|
||||
id: "log-warning",
|
||||
instantiate: (di): LogFunction => di.inject(winstonLoggerInjectable).warn,
|
||||
instantiate: getLogFunctionFor("warn"),
|
||||
injectionToken: logWarningInjectionToken,
|
||||
lifecycle: lifecycleEnum.keyedSingleton({
|
||||
getInstanceKey: (di) => di.sourceNamespace,
|
||||
}),
|
||||
});
|
||||
|
||||
export const logErrorInjectable = getInjectable({
|
||||
id: "log-error",
|
||||
instantiate: (di): LogFunction => di.inject(winstonLoggerInjectable).error,
|
||||
instantiate: getLogFunctionFor("error"),
|
||||
injectionToken: logErrorInjectionToken,
|
||||
lifecycle: lifecycleEnum.keyedSingleton({
|
||||
getInstanceKey: (di) => di.sourceNamespace,
|
||||
}),
|
||||
});
|
||||
|
||||
export const logSillyInjectable = getInjectable({
|
||||
id: "log-silly",
|
||||
instantiate: (di): LogFunction => di.inject(winstonLoggerInjectable).silly,
|
||||
instantiate: getLogFunctionFor("silly"),
|
||||
injectionToken: logSillyInjectionToken,
|
||||
lifecycle: lifecycleEnum.keyedSingleton({
|
||||
getInstanceKey: (di) => di.sourceNamespace,
|
||||
}),
|
||||
});
|
||||
|
@ -1,13 +1,18 @@
|
||||
import { createContainer } from "@ogre-tools/injectable";
|
||||
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,
|
||||
logDebugInjectionToken,
|
||||
logErrorInjectionToken,
|
||||
logInfoInjectionToken,
|
||||
logSillyInjectionToken, logWarningInjectionToken,
|
||||
logSillyInjectionToken,
|
||||
logWarningInjectionToken,
|
||||
} from "./logger.injectable";
|
||||
|
||||
import { getFeature } from "@k8slens/feature-core/src/feature";
|
||||
|
||||
describe("logger", () => {
|
||||
[
|
||||
{ scenario: "debug", injectionToken: logDebugInjectionToken },
|
||||
@ -16,7 +21,7 @@ describe("logger", () => {
|
||||
{ scenario: "error", injectionToken: logErrorInjectionToken },
|
||||
{ scenario: "silly", injectionToken: logSillyInjectionToken },
|
||||
].forEach(({ scenario, injectionToken }) => {
|
||||
it(`when logging "${scenario}", does so`, () => {
|
||||
it(`given not inside a Feature, when logging "${scenario}", does so without a prefix`, () => {
|
||||
const di = createContainer("irrelevant");
|
||||
|
||||
registerFeature(di, loggerFeature);
|
||||
@ -34,5 +39,40 @@ describe("logger", () => {
|
||||
"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"
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
Loading…
Reference in New Issue
Block a user