Revert "Renderer file logging through IPC" (#7393)

This reverts commit 48db54ec9e.
This commit is contained in:
Sebastian Malton authored and GitHub committed 2023-03-21 16:13:27 -04:00
1 parent 48db54ec9e
commit 5409324236
24 files changed
+72 -832

No files matched your search

@@ -1,56 +0,0 @@
/**
* 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 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";
describe("close renderer file logging", () => {
let di: DiContainer;
let sendIpcMock: SendMessageToChannel;
let winstonMock: winston.Logger;
let ipcTransportMock: IpcLogTransport;
beforeEach(() => {
di = getDiForUnitTesting();
sendIpcMock = jest.fn();
winstonMock = {
remove: jest.fn(),
} as any as winston.Logger;
ipcTransportMock = { name: "ipc-renderer-transport" } as IpcLogTransport;
di.override(winstonLoggerInjectable, () => winstonMock);
di.override(sendMessageToChannelInjectionToken, () => sendIpcMock);
di.override(rendererLogFileIdInjectable, () => "some-log-id");
di.override(ipcLogTransportInjectable, () => ipcTransportMock);
});
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",
);
});
it("removes the transport to prevent further logging to closed file", () => {
const closeLog = di.inject(closeRendererLogFileInjectable);
closeLog();
expect(winstonMock.remove).toHaveBeenCalledWith({
name: "ipc-renderer-transport",
});
});
});
@@ -1,28 +0,0 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import winstonLoggerInjectable from "../../common/winston-logger.injectable";
import { closeIpcFileLoggerChannel } from "../../common/logger/ipc-file-logger-channel";
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";
const closeRendererLogFileInjectable = getInjectable({
id: "close-renderer-log-file",
instantiate: (di) => {
const winstonLogger = di.inject(winstonLoggerInjectable);
const ipcLogTransport = di.inject(ipcLogTransportInjectable);
const messageToChannel = di.inject(sendMessageToChannelInjectionToken);
const fileId = di.inject(rendererLogFileIdInjectable);
return () => {
messageToChannel(closeIpcFileLoggerChannel, fileId);
winstonLogger.remove(ipcLogTransport);
};
},
});
export default closeRendererLogFileInjectable;
@@ -1,60 +0,0 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import { loggerTransportInjectionToken } from "../../common/logger/transports";
import type winston from "winston";
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,
} from "../../common/logger/ipc-file-logger-channel";
import rendererLogFileIdInjectable from "./renderer-log-file-id.injectable";
/**
* Winston uses symbol property for the actual message.
*
* For that to get through IPC, use the internalMessage property instead
*/
function serializeLogForIpc(
fileId: string,
entry: winston.LogEntry,
): IpcFileLogObject {
return {
fileId,
entry: {
level: entry.level,
message: entry.message,
internalMessage: Object.getOwnPropertyDescriptor(entry, MESSAGE)?.value,
},
};
}
const ipcLogTransportInjectable = getInjectable({
id: "renderer-file-logger-transport",
instantiate: (di) => {
const messageToChannel = di.inject(sendMessageToChannelInjectionToken);
const fileId = di.inject(rendererLogFileIdInjectable);
return new IpcLogTransport({
sendIpcLogMessage: (entry) =>
messageToChannel(
ipcFileLoggerChannel,
serializeLogForIpc(fileId, entry),
),
closeIpcLogging: () =>
messageToChannel(closeIpcFileLoggerChannel, fileId),
handleExceptions: false,
level: "info",
});
},
injectionToken: loggerTransportInjectionToken,
});
export default ipcLogTransportInjectable;
@@ -1,48 +0,0 @@
/**
* 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 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";
import { MESSAGE } from "triple-beam";
describe("renderer log transport through ipc", () => {
let di: DiContainer;
let sendIpcMock: SendMessageToChannel;
beforeEach(() => {
sendIpcMock = jest.fn();
di = getDiForUnitTesting();
di.override(sendMessageToChannelInjectionToken, () => sendIpcMock);
di.override(rendererLogFileIdInjectable, () => "some-log-id");
});
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(
{ id: "ipc-file-logger-channel" },
{
entry: {
level: "info",
message: "some log text",
internalMessage: "actual winston log text",
},
fileId: "some-log-id",
},
);
});
});
@@ -1,41 +0,0 @@
/**
* 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 type { TransportStreamOptions } from "winston-transport";
import TransportStream from "winston-transport";
interface IpcLogTransportOptions extends TransportStreamOptions {
sendIpcLogMessage: (entry: LogEntry) => void;
closeIpcLogging: () => void;
}
class IpcLogTransport extends TransportStream {
sendIpcLogMessage: (entry: LogEntry) => void;
closeIpcLogging: () => void;
name = "ipc-renderer-transport";
constructor(options: IpcLogTransportOptions) {
const { sendIpcLogMessage, closeIpcLogging, ...winstonOptions } = options;
super(winstonOptions);
this.sendIpcLogMessage = sendIpcLogMessage;
this.closeIpcLogging = closeIpcLogging;
}
log(logEntry: LogEntry, next: () => void) {
setImmediate(() => {
this.emit("logged", logEntry);
});
this.sendIpcLogMessage(logEntry);
next();
}
close() {
this.closeIpcLogging();
}
}
export default IpcLogTransport;
@@ -1,29 +0,0 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import windowLocationInjectable from "../../common/k8s-api/window-location.injectable";
import currentlyInClusterFrameInjectable from "../routes/currently-in-cluster-frame.injectable";
import { getClusterIdFromHost } from "../../common/utils";
const rendererLogFileIdInjectable = getInjectable({
id: "renderer-log-file-id",
instantiate: (di) => {
let frameId: string;
const currentlyInClusterFrame = di.inject(currentlyInClusterFrameInjectable);
if (currentlyInClusterFrame) {
const { host } = di.inject(windowLocationInjectable);
const clusterId = getClusterIdFromHost(host);
frameId = `cluster-${clusterId}`;
} else {
frameId = "main";
}
return `renderer-${frameId}`;
},
});
export default rendererLogFileIdInjectable;
@@ -1,34 +0,0 @@
/**
* 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";
import rendererLogFileIdInjectable from "./renderer-log-file-id.injectable";
describe("renderer log file id", () => {
it("clearly names log for renderer main frame", () => {
const di = getDiForUnitTesting();
di.override(currentlyInClusterFrameInjectable, () => false);
const mainFileId = di.inject(rendererLogFileIdInjectable);
expect(mainFileId).toBe("renderer-main");
});
it("includes cluster id in renderer log file names", () => {
const di = getDiForUnitTesting();
di.override(currentlyInClusterFrameInjectable, () => true);
di.override(windowLocationInjectable, () => ({
host: "some-cluster.lens.app",
port: "irrelevant",
}));
const clusterFileId = di.inject(rendererLogFileIdInjectable);
expect(clusterFileId).toBe("renderer-cluster-some-cluster");
});
});