mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Lint fix
Signed-off-by: Sami Tiilikainen <97873007+samitiilikainen@users.noreply.github.com>
This commit is contained in:
parent
22bcbadee6
commit
c25b24d41d
@ -1,13 +1,17 @@
|
||||
/**
|
||||
* Copyright (c) OpenLens Authors. All rights reserved.
|
||||
* Licensed under MIT License. See LICENSE in root directory for more information.
|
||||
*/
|
||||
import type { MessageChannel } from "../utils/channel/message-channel-listener-injection-token";
|
||||
|
||||
export type IpcFileLogObject = {
|
||||
export interface IpcFileLogObject {
|
||||
fileId: string;
|
||||
entry: {
|
||||
level: string;
|
||||
message: string;
|
||||
internalMessage: string;
|
||||
};
|
||||
};
|
||||
}
|
||||
|
||||
export type IpcFileLoggerChannel = MessageChannel<IpcFileLogObject>;
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ const ipcFileLoggerInjectable = getInjectable({
|
||||
maxFiles: 2,
|
||||
tailable: true,
|
||||
},
|
||||
(options: transports.FileTransportOptions) => new transports.File(options)
|
||||
(options: transports.FileTransportOptions) => new transports.File(options),
|
||||
),
|
||||
});
|
||||
|
||||
|
||||
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* Copyright (c) OpenLens Authors. All rights reserved.
|
||||
* Licensed under MIT License. See LICENSE in root directory for more information.
|
||||
*/
|
||||
import IpcFileLogger from "./ipc-file-logger";
|
||||
|
||||
describe("ipc file logger in main", () => {
|
||||
@ -19,7 +23,7 @@ describe("ipc file logger in main", () => {
|
||||
maxFiles: 1,
|
||||
tailable: true,
|
||||
},
|
||||
createFileTransportMock
|
||||
createFileTransportMock,
|
||||
);
|
||||
});
|
||||
|
||||
@ -122,9 +126,11 @@ describe("ipc file logger in main", () => {
|
||||
if (options.filename === "lens-some-log-file.log") {
|
||||
return { log: someLogMock };
|
||||
}
|
||||
|
||||
if (options.filename === "lens-some-other-log-file.log") {
|
||||
return { log: someOthertLogMock };
|
||||
}
|
||||
|
||||
return null;
|
||||
});
|
||||
|
||||
|
||||
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* Copyright (c) OpenLens Authors. All rights reserved.
|
||||
* Licensed under MIT License. See LICENSE in root directory for more information.
|
||||
*/
|
||||
import type { LogEntry, transports } from "winston";
|
||||
|
||||
type IpcFileLoggerOptions = Omit<transports.FileTransportOptions, "filename">;
|
||||
@ -9,7 +13,7 @@ class IpcFileLogger {
|
||||
private options: IpcFileLoggerOptions,
|
||||
private createNewFileTransport: (
|
||||
options: transports.FileTransportOptions
|
||||
) => transports.FileTransportInstance
|
||||
) => transports.FileTransportInstance,
|
||||
) {}
|
||||
|
||||
log({ fileId, entry }: { fileId: string; entry: LogEntry }) {
|
||||
@ -20,6 +24,7 @@ class IpcFileLogger {
|
||||
|
||||
close(fileId: string) {
|
||||
const transport = this.fileTransports.get(fileId);
|
||||
|
||||
if (transport) {
|
||||
transport.close?.();
|
||||
this.fileTransports.delete(fileId);
|
||||
|
||||
@ -4,9 +4,10 @@
|
||||
*/
|
||||
import ipcFileLoggerInjectable from "./ipc-file-logger.injectable";
|
||||
import { getMessageChannelListenerInjectable } from "../../common/utils/channel/message-channel-listener-injection-token";
|
||||
import type {
|
||||
IpcFileLogObject } from "../../common/logger/ipc-file-logger-channel";
|
||||
import {
|
||||
ipcFileLoggerChannel,
|
||||
IpcFileLogObject,
|
||||
} from "../../common/logger/ipc-file-logger-channel";
|
||||
import { MESSAGE } from "triple-beam";
|
||||
|
||||
@ -17,6 +18,7 @@ import { MESSAGE } from "triple-beam";
|
||||
*/
|
||||
export function deserializeLogFromIpc(ipcFileLogObject: IpcFileLogObject) {
|
||||
const { internalMessage, ...standardEntry } = ipcFileLogObject.entry;
|
||||
|
||||
return {
|
||||
...ipcFileLogObject,
|
||||
entry: {
|
||||
|
||||
@ -34,50 +34,50 @@ export const initClusterFrame =
|
||||
showErrorNotification,
|
||||
closeFileLogging,
|
||||
}: Dependencies) =>
|
||||
async (unmountRoot: () => void) => {
|
||||
async (unmountRoot: () => void) => {
|
||||
// TODO: Make catalogEntityRegistry already initialized when passed as dependency
|
||||
catalogEntityRegistry.init();
|
||||
catalogEntityRegistry.init();
|
||||
|
||||
logger.info(
|
||||
`${logPrefix} Init dashboard, clusterId=${hostedCluster.id}, frameId=${frameRoutingId}`,
|
||||
);
|
||||
|
||||
await requestSetClusterFrameId(hostedCluster.id);
|
||||
await when(() => hostedCluster.ready.get()); // cluster.activate() is done at this point
|
||||
|
||||
catalogEntityRegistry.activeEntity = hostedCluster.id;
|
||||
|
||||
// Only load the extensions once the catalog has been populated.
|
||||
// Note that the Catalog might still have unprocessed entities until the extensions are fully loaded.
|
||||
when(
|
||||
() => catalogEntityRegistry.items.get().length > 0,
|
||||
() => loadExtensions(),
|
||||
{
|
||||
timeout: 15_000,
|
||||
onError: (error) => {
|
||||
logger.warn("[CLUSTER-FRAME]: error from activeEntity when()", error);
|
||||
|
||||
showErrorNotification("Failed to get KubernetesCluster for this view. Extensions will not be loaded.");
|
||||
},
|
||||
},
|
||||
);
|
||||
|
||||
setTimeout(() => {
|
||||
emitAppEvent({
|
||||
name: "cluster",
|
||||
action: "open",
|
||||
params: {
|
||||
clusterId: hostedCluster.id,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
window.onbeforeunload = () => {
|
||||
logger.info(
|
||||
`${logPrefix} Unload dashboard, clusterId=${hostedCluster.id}, frameId=${frameRoutingId}`
|
||||
`${logPrefix} Init dashboard, clusterId=${hostedCluster.id}, frameId=${frameRoutingId}`,
|
||||
);
|
||||
|
||||
unmountRoot();
|
||||
closeFileLogging();
|
||||
await requestSetClusterFrameId(hostedCluster.id);
|
||||
await when(() => hostedCluster.ready.get()); // cluster.activate() is done at this point
|
||||
|
||||
catalogEntityRegistry.activeEntity = hostedCluster.id;
|
||||
|
||||
// Only load the extensions once the catalog has been populated.
|
||||
// Note that the Catalog might still have unprocessed entities until the extensions are fully loaded.
|
||||
when(
|
||||
() => catalogEntityRegistry.items.get().length > 0,
|
||||
() => loadExtensions(),
|
||||
{
|
||||
timeout: 15_000,
|
||||
onError: (error) => {
|
||||
logger.warn("[CLUSTER-FRAME]: error from activeEntity when()", error);
|
||||
|
||||
showErrorNotification("Failed to get KubernetesCluster for this view. Extensions will not be loaded.");
|
||||
},
|
||||
},
|
||||
);
|
||||
|
||||
setTimeout(() => {
|
||||
emitAppEvent({
|
||||
name: "cluster",
|
||||
action: "open",
|
||||
params: {
|
||||
clusterId: hostedCluster.id,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
window.onbeforeunload = () => {
|
||||
logger.info(
|
||||
`${logPrefix} Unload dashboard, clusterId=${hostedCluster.id}, frameId=${frameRoutingId}`,
|
||||
);
|
||||
|
||||
unmountRoot();
|
||||
closeFileLogging();
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
@ -1,9 +1,14 @@
|
||||
/**
|
||||
* Copyright (c) OpenLens Authors. All rights reserved.
|
||||
* Licensed under MIT License. See LICENSE in root directory for more information.
|
||||
*/
|
||||
import winstonLoggerInjectable from "../../common/winston-logger.injectable";
|
||||
import { getDiForUnitTesting } from "../getDiForUnitTesting";
|
||||
import closeRendererLogFileInjectable from "./close-renderer-log-file.injectable";
|
||||
import type { DiContainer } from "@ogre-tools/injectable";
|
||||
import type winston from "winston";
|
||||
import { SendMessageToChannel, sendMessageToChannelInjectionToken } from "../../common/utils/channel/message-to-channel-injection-token";
|
||||
import type { SendMessageToChannel } from "../../common/utils/channel/message-to-channel-injection-token";
|
||||
import { sendMessageToChannelInjectionToken } from "../../common/utils/channel/message-to-channel-injection-token";
|
||||
import rendererLogFileIdInjectable from "./renderer-log-file-id.injectable";
|
||||
import ipcLogTransportInjectable from "./ipc-transport.injectable";
|
||||
import type IpcLogTransport from "./ipc-transport";
|
||||
@ -30,16 +35,18 @@ describe("close renderer file logging", () => {
|
||||
|
||||
it("sends the ipc close message with correct log id", () => {
|
||||
const closeLog = di.inject(closeRendererLogFileInjectable);
|
||||
|
||||
closeLog();
|
||||
|
||||
expect(sendIpcMock).toHaveBeenCalledWith(
|
||||
{ id: "close-ipc-file-logger-channel" },
|
||||
"some-log-id"
|
||||
"some-log-id",
|
||||
);
|
||||
});
|
||||
|
||||
it("removes the transport to prevent further logging to closed file", () => {
|
||||
const closeLog = di.inject(closeRendererLogFileInjectable);
|
||||
|
||||
closeLog();
|
||||
|
||||
expect(winstonMock.remove).toHaveBeenCalledWith({
|
||||
|
||||
@ -9,10 +9,11 @@ import { MESSAGE } from "triple-beam";
|
||||
|
||||
import IpcLogTransport from "./ipc-transport";
|
||||
import { sendMessageToChannelInjectionToken } from "../../common/utils/channel/message-to-channel-injection-token";
|
||||
import type {
|
||||
IpcFileLogObject } from "../../common/logger/ipc-file-logger-channel";
|
||||
import {
|
||||
closeIpcFileLoggerChannel,
|
||||
ipcFileLoggerChannel,
|
||||
IpcFileLogObject,
|
||||
} from "../../common/logger/ipc-file-logger-channel";
|
||||
import rendererLogFileIdInjectable from "./renderer-log-file-id.injectable";
|
||||
|
||||
@ -23,7 +24,7 @@ import rendererLogFileIdInjectable from "./renderer-log-file-id.injectable";
|
||||
*/
|
||||
function serializeLogForIpc(
|
||||
fileId: string,
|
||||
entry: winston.LogEntry
|
||||
entry: winston.LogEntry,
|
||||
): IpcFileLogObject {
|
||||
return {
|
||||
fileId,
|
||||
@ -45,7 +46,7 @@ const ipcLogTransportInjectable = getInjectable({
|
||||
sendIpcLogMessage: (entry) =>
|
||||
messageToChannel(
|
||||
ipcFileLoggerChannel,
|
||||
serializeLogForIpc(fileId, entry)
|
||||
serializeLogForIpc(fileId, entry),
|
||||
),
|
||||
closeIpcLogging: () =>
|
||||
messageToChannel(closeIpcFileLoggerChannel, fileId),
|
||||
|
||||
@ -1,5 +1,10 @@
|
||||
/**
|
||||
* Copyright (c) OpenLens Authors. All rights reserved.
|
||||
* Licensed under MIT License. See LICENSE in root directory for more information.
|
||||
*/
|
||||
import type { DiContainer } from "@ogre-tools/injectable";
|
||||
import { SendMessageToChannel, sendMessageToChannelInjectionToken } from "../../common/utils/channel/message-to-channel-injection-token";
|
||||
import type { SendMessageToChannel } from "../../common/utils/channel/message-to-channel-injection-token";
|
||||
import { sendMessageToChannelInjectionToken } from "../../common/utils/channel/message-to-channel-injection-token";
|
||||
import { getDiForUnitTesting } from "../getDiForUnitTesting";
|
||||
import rendererLogFileIdInjectable from "./renderer-log-file-id.injectable";
|
||||
import ipcLogTransportInjectable from "./ipc-transport.injectable";
|
||||
@ -18,13 +23,14 @@ describe("renderer log transport through ipc", () => {
|
||||
|
||||
it("send serialized ipc messages on log", () => {
|
||||
const logTransport = di.inject(ipcLogTransportInjectable);
|
||||
|
||||
logTransport.log(
|
||||
{
|
||||
level: "info",
|
||||
message: "some log text",
|
||||
[MESSAGE]: "actual winston log text",
|
||||
},
|
||||
() => {}
|
||||
() => {},
|
||||
);
|
||||
|
||||
expect(sendIpcMock).toHaveBeenCalledWith(
|
||||
@ -36,7 +42,7 @@ describe("renderer log transport through ipc", () => {
|
||||
internalMessage: "actual winston log text",
|
||||
},
|
||||
fileId: "some-log-id",
|
||||
}
|
||||
},
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
@ -1,5 +1,10 @@
|
||||
/**
|
||||
* Copyright (c) OpenLens Authors. All rights reserved.
|
||||
* Licensed under MIT License. See LICENSE in root directory for more information.
|
||||
*/
|
||||
import type { LogEntry } from "winston";
|
||||
import TransportStream, { TransportStreamOptions } from "winston-transport";
|
||||
import type { TransportStreamOptions } from "winston-transport";
|
||||
import TransportStream from "winston-transport";
|
||||
|
||||
interface IpcLogTransportOptions extends TransportStreamOptions {
|
||||
sendIpcLogMessage: (entry: LogEntry) => void;
|
||||
@ -13,6 +18,7 @@ class IpcLogTransport extends TransportStream {
|
||||
|
||||
constructor(options: IpcLogTransportOptions) {
|
||||
const { sendIpcLogMessage, closeIpcLogging, ...winstonOptions } = options;
|
||||
|
||||
super(winstonOptions);
|
||||
|
||||
this.sendIpcLogMessage = sendIpcLogMessage;
|
||||
|
||||
@ -17,6 +17,7 @@ const rendererLogFileIdInjectable = getInjectable({
|
||||
if (currentlyInClusterFrame) {
|
||||
const { host } = di.inject(windowLocationInjectable);
|
||||
const clusterId = getClusterIdFromHost(host);
|
||||
|
||||
frameId = clusterId ? `cluster-${clusterId}` : "cluster";
|
||||
} else {
|
||||
frameId = "main";
|
||||
|
||||
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* Copyright (c) OpenLens Authors. All rights reserved.
|
||||
* Licensed under MIT License. See LICENSE in root directory for more information.
|
||||
*/
|
||||
import windowLocationInjectable from "../../common/k8s-api/window-location.injectable";
|
||||
import { getDiForUnitTesting } from "../getDiForUnitTesting";
|
||||
import currentlyInClusterFrameInjectable from "../routes/currently-in-cluster-frame.injectable";
|
||||
@ -7,9 +11,11 @@ describe("renderer log file id", () => {
|
||||
|
||||
it("clearly names log for renderer main frame", () => {
|
||||
const di = getDiForUnitTesting({ doGeneralOverrides: false });
|
||||
|
||||
di.override(currentlyInClusterFrameInjectable, () => false);
|
||||
|
||||
const mainFileId = di.inject(rendererLogFileIdInjectable);
|
||||
|
||||
expect(mainFileId).toBe("renderer-main");
|
||||
});
|
||||
|
||||
@ -22,6 +28,7 @@ describe("renderer log file id", () => {
|
||||
port: "irrelevant",
|
||||
}));
|
||||
const clusterFileId = di.inject(rendererLogFileIdInjectable);
|
||||
|
||||
expect(clusterFileId).toBe("renderer-cluster-some-cluster");
|
||||
});
|
||||
});
|
||||
|
||||
Loading…
Reference in New Issue
Block a user