hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Convert shell authentication IPC to injectable RequestChannel

Browse Source 
Signed-off-by: Sebastian Malton <sebastian@malton.name>
This commit is contained in:
Sebastian Malton 2022-06-03 13:18:54 -04:00
parent 78ead4f2b9
commit ea8c262d3c
20 changed files with 54 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/common/utils/channel/message-channel-injection-token.ts
View File

@ -4,9 +4,9 @@
*/
import { getInjectionToken } from "@ogre-tools/injectable";
import type { JsonValue } from "type-fest";
import type { IpcValue } from "./allowed-types";
export interface MessageChannel<Message extends JsonValue | void = void> {
export interface MessageChannel<Message extends IpcValue | void = void> {
id: string;
_messageSignature?: Message;
}

22
src/common/utils/channel/message-to-channel-injection-token.ts
View File

@ -4,20 +4,16 @@
*/
import { getInjectionToken } from "@ogre-tools/injectable";
import type { SetRequired } from "type-fest";
import type { IpcValue } from "./allowed-types";
import type { MessageChannel } from "./message-channel-injection-token";
export interface MessageToChannel {
<TChannel extends MessageChannel<TMessage>, TMessage extends void>(
channel: TChannel,
): void;
<TChannel extends MessageChannel<any>>(
channel: TChannel,
message: SetRequired<TChannel, "_messageSignature">["_messageSignature"],
): void;
<Channel extends MessageChannel<void>>(channel: Channel): void;
<
Channel extends MessageChannel<IpcValue>,
Message = SetRequired<Channel, "_messageSignature">["_messageSignature"],
>(channel: Channel, message: Message): void;
}
export const messageToChannelInjectionToken =
getInjectionToken<MessageToChannel>({
id: "message-to-message-channel",
});
export const messageToChannelInjectionToken = getInjectionToken<MessageToChannel>({
id: "message-to-message-channel",
});

1
src/common/utils/sync-box/sync-box-injection-token.ts
View File

@ -4,6 +4,7 @@
*/
import { getInjectionToken } from "@ogre-tools/injectable";
import type { IComputedValue } from "mobx";
export interface SyncBox<Value> {
id: string;
value: IComputedValue<Value>;

15
src/common/utils/tentative-parse-json.ts
View File

@ -1,15 +0,0 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { pipeline } from "@ogre-tools/fp";
import { defaultTo } from "lodash/fp";
import { withErrorSuppression } from "./with-error-suppression/with-error-suppression";
export const tentativeParseJson = (toBeParsed: any) => pipeline(
toBeParsed,
withErrorSuppression(JSON.parse),
defaultTo(toBeParsed),
);

15
src/common/utils/tentative-stringify-json.ts
View File

@ -1,15 +0,0 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { pipeline } from "@ogre-tools/fp";
import { defaultTo } from "lodash/fp";
import { withErrorSuppression } from "./with-error-suppression/with-error-suppression";
export const tentativeStringifyJson = (toBeParsed: any) => pipeline(
toBeParsed,
withErrorSuppression(JSON.stringify),
defaultTo(toBeParsed),
);

2
src/main/lens-proxy/lens-proxy-port.injectable.ts
View File

@ -22,7 +22,7 @@ const lensProxyPortInjectable = getInjectable({
},
set: (port: number) => {
if (port) {
if (portNumber) {
throw new Error(
"Tried to set port number for LensProxy when it has already been set.",
);

2
src/main/lens-proxy/lens-proxy.ts
View File

@ -86,7 +86,7 @@ export class LensProxy {
const reqHandler = isInternal ? dependencies.shellApiRequest : dependencies.kubeApiUpgradeRequest;
(async () => reqHandler({ req, socket, head, cluster }))()
.catch(error => logger.error("[LENS-PROXY]: failed to handle proxy upgrade", error));
.catch(error => logger.error(`[LENS-PROXY]: failed to handle proxy upgrade: ${error}`));
}
});
}

2
src/main/lens-proxy/proxy-functions/shell/api-request.injectable.ts
View File

@ -21,7 +21,7 @@ const shellApiRequestInjectable = getInjectable({
return ({ req, socket, head }) => {
const cluster = getClusterForRequest(req);
const { searchParams } = new URL(req.url);
const { searchParams } = new URL(req.url, "https://127.0.0.1");
const nodeName = searchParams.get("node") || undefined;
const shellToken = searchParams.get("shellToken");
const tabId = searchParams.get("id");

11
src/main/utils/channel/channel-listeners/enlist-message-channel-listener.injectable.ts
View File

@ -6,8 +6,7 @@ import { getInjectable } from "@ogre-tools/injectable";
import type { IpcMainEvent } from "electron";
import ipcMainInjectable from "../ipc-main/ipc-main.injectable";
import { enlistMessageChannelListenerInjectionToken } from "../../../../common/utils/channel/enlist-message-channel-listener-injection-token";
import { pipeline } from "@ogre-tools/fp";
import { tentativeParseJson } from "../../../../common/utils/tentative-parse-json";
import { toJS } from "../../../../renderer/utils";
const enlistMessageChannelListenerInjectable = getInjectable({
id: "enlist-message-channel-listener-for-main",
@ -16,13 +15,7 @@ const enlistMessageChannelListenerInjectable = getInjectable({
const ipcMain = di.inject(ipcMainInjectable);
return ({ channel, handler }) => {
const nativeOnCallback = (_: IpcMainEvent, message: unknown) => {
pipeline(
message,
tentativeParseJson,
handler,
);
};
const nativeOnCallback = (_: IpcMainEvent, message: unknown) => toJS(handler(message));
ipcMain.on(channel.id, nativeOnCallback);

7
src/main/utils/channel/channel-listeners/enlist-request-channel-listener.injectable.ts
View File

@ -6,9 +6,7 @@ import { getInjectable } from "@ogre-tools/injectable";
import type { IpcMainInvokeEvent } from "electron";
import ipcMainInjectable from "../ipc-main/ipc-main.injectable";
import { enlistRequestChannelListenerInjectionToken } from "../../../../common/utils/channel/enlist-request-channel-listener-injection-token";
import { pipeline } from "@ogre-tools/fp";
import { tentativeParseJson } from "../../../../common/utils/tentative-parse-json";
import { tentativeStringifyJson } from "../../../../common/utils/tentative-stringify-json";
import { toJS } from "../../../../renderer/utils";
const enlistRequestChannelListenerInjectable = getInjectable({
id: "enlist-request-channel-listener-for-main",
@ -17,8 +15,7 @@ const enlistRequestChannelListenerInjectable = getInjectable({
const ipcMain = di.inject(ipcMainInjectable);
return ({ channel, handler }) => {
const nativeHandleCallback = (_: IpcMainInvokeEvent, request: unknown) =>
pipeline(request, tentativeParseJson, handler, tentativeStringifyJson);
const nativeHandleCallback = (_: IpcMainInvokeEvent, request: unknown) => toJS(handler(request));
ipcMain.handle(channel.id, nativeHandleCallback);

20
src/main/utils/channel/message-to-channel.injectable.ts
View File

@ -4,9 +4,8 @@
*/
import { getInjectable } from "@ogre-tools/injectable";
import { messageToChannelInjectionToken } from "../../../common/utils/channel/message-to-channel-injection-token";
import type { MessageChannel } from "../../../common/utils/channel/message-channel-injection-token";
import { tentativeStringifyJson } from "../../../common/utils/tentative-stringify-json";
import getVisibleWindowsInjectable from "../../start-main-application/lens-window/get-visible-windows.injectable";
import type { MessageToChannel } from "../../../common/utils/channel/message-to-channel-injection-token";
const messageToChannelInjectable = getInjectable({
id: "message-to-channel",
@ -14,15 +13,14 @@ const messageToChannelInjectable = getInjectable({
instantiate: (di) => {
const getVisibleWindows = di.inject(getVisibleWindowsInjectable);
// TODO: Figure out way to improve typing in internals
// Notice that this should be injected using "messageToChannelInjectionToken" which is typed correctly.
return (channel: MessageChannel<any>, message?: unknown) => {
const stringifiedMessage = tentativeStringifyJson(message);
getVisibleWindows().forEach((lensWindow) =>
lensWindow.send({ channel: channel.id, data: stringifiedMessage ? [stringifiedMessage] : [] }),
);
};
return ((channel, message) => {
for (const window of getVisibleWindows()) {
window.send({
channel: channel.id,
data: message !== undefined ? [message] : [],
});
}
}) as MessageToChannel;
},
injectionToken: messageToChannelInjectionToken,

3
src/renderer/api/create-terminal-api.injectable.ts
View File

@ -5,6 +5,7 @@
import { getInjectable } from "@ogre-tools/injectable";
import assert from "assert";
import hostedClusterIdInjectable from "../cluster-frame-context/hosted-cluster-id.injectable";
import getShellAuthTokenInjectable from "../../common/shell-authentication/get-auth-token.injectable";
import type { TerminalApiQuery } from "./terminal-api";
import { TerminalApi } from "./terminal-api";
@ -14,12 +15,14 @@ const createTerminalApiInjectable = getInjectable({
id: "create-terminal-api",
instantiate: (di): CreateTerminalApi => {
const hostedClusterId = di.inject(hostedClusterIdInjectable);
const getShellAuthToken = di.inject(getShellAuthTokenInjectable);
return (query) => {
assert(hostedClusterId, "Can only create terminal APIs within a cluster frame");
return new TerminalApi({
hostedClusterId,
getShellAuthToken,
}, query);
};
},

2
src/renderer/api/terminal-api.ts
View File

@ -71,6 +71,8 @@ export class TerminalApi extends WebSocketApi<TerminalEvents> {
clusterId: this.dependencies.hostedClusterId,
tabId: this.query.id,
});
console.log("authTokenArray", authTokenArray);
const { hostname, protocol, port } = location;
const socketUrl = url.format({
protocol: protocol.includes("https") ? "wss" : "ws",

10
src/renderer/utils/channel/channel-listeners/enlist-message-channel-listener.injectable.ts
View File

@ -6,8 +6,6 @@ import ipcRendererInjectable from "../ipc-renderer.injectable";
import { getInjectable } from "@ogre-tools/injectable";
import type { IpcRendererEvent } from "electron";
import { enlistMessageChannelListenerInjectionToken } from "../../../../common/utils/channel/enlist-message-channel-listener-injection-token";
import { tentativeParseJson } from "../../../../common/utils/tentative-parse-json";
import { pipeline } from "@ogre-tools/fp";
const enlistMessageChannelListenerInjectable = getInjectable({
id: "enlist-message-channel-listener-for-renderer",
@ -16,13 +14,7 @@ const enlistMessageChannelListenerInjectable = getInjectable({
const ipcRenderer = di.inject(ipcRendererInjectable);
return ({ channel, handler }) => {
const nativeCallback = (_: IpcRendererEvent, message: unknown) => {
pipeline(
message,
tentativeParseJson,
handler,
);
};
const nativeCallback = (_: IpcRendererEvent, message: unknown) => handler(message);
ipcRenderer.on(channel.id, nativeCallback);

8
src/renderer/utils/channel/message-to-channel.injectable.ts
View File

@ -3,9 +3,9 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import type { MessageToChannel } from "../../../common/utils/channel/message-to-channel-injection-token";
import { messageToChannelInjectionToken } from "../../../common/utils/channel/message-to-channel-injection-token";
import sendToMainInjectable from "./send-to-main.injectable";
import type { MessageChannel } from "../../../common/utils/channel/message-channel-injection-token";
const messageToChannelInjectable = getInjectable({
id: "message-to-channel",
@ -13,11 +13,9 @@ const messageToChannelInjectable = getInjectable({
instantiate: (di) => {
const sendToMain = di.inject(sendToMainInjectable);
// TODO: Figure out way to improve typing in internals
// Notice that this should be injected using "messageToChannelInjectionToken" which is typed correctly.
return (channel: MessageChannel<any>, message?: unknown) => {
return ((channel, message) => {
sendToMain(channel.id, message);
};
}) as MessageToChannel;
},
injectionToken: messageToChannelInjectionToken,

16
src/renderer/utils/channel/request-from-channel.injectable.ts
View File

@ -5,9 +5,7 @@
import { getInjectable } from "@ogre-tools/injectable";
import ipcRendererInjectable from "./ipc-renderer.injectable";
import { requestFromChannelInjectionToken } from "../../../common/utils/channel/request-from-channel-injection-token";
import { pipeline } from "@ogre-tools/fp";
import { tentativeStringifyJson } from "../../../common/utils/tentative-stringify-json";
import { tentativeParseJson } from "../../../common/utils/tentative-parse-json";
import type { RequestChannel } from "../../../common/utils/channel/request-channel-injection-token";
const requestFromChannelInjectable = getInjectable({
id: "request-from-channel",
@ -15,13 +13,11 @@ const requestFromChannelInjectable = getInjectable({
instantiate: (di) => {
const ipcRenderer = di.inject(ipcRendererInjectable);
return async (channel, ...[request]) =>
await pipeline(
request,
tentativeStringifyJson,
(req) => ipcRenderer.invoke(channel.id, req),
tentativeParseJson,
);
return async (channel, ...[request]) => {
const { id } = channel as unknown as RequestChannel<any, any>;
return ipcRenderer.invoke(id, request);
};
},
injectionToken: requestFromChannelInjectionToken,

9
src/renderer/utils/channel/send-to-main.injectable.ts
View File

@ -3,9 +3,7 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import type { JsonValue } from "type-fest";
import ipcRendererInjectable from "./ipc-renderer.injectable";
import { tentativeStringifyJson } from "../../../common/utils/tentative-stringify-json";
const sendToMainInjectable = getInjectable({
id: "send-to-main",
@ -13,11 +11,8 @@ const sendToMainInjectable = getInjectable({
instantiate: (di) => {
const ipcRenderer = di.inject(ipcRendererInjectable);
// TODO: Figure out way to improve typing in internals
return <T>(channelId: string, message: JsonValue extends T ? T : never ) => {
const stringifiedMessage = tentativeStringifyJson(message);
ipcRenderer.send(channelId, ...(stringifiedMessage ? [stringifiedMessage] : []));
return (channelId: string, message: unknown) => {
ipcRenderer.send(channelId, message);
};
},
});

5
src/renderer/utils/sync-box/provide-initial-values-for-sync-boxes.injectable.ts
View File

@ -20,6 +20,11 @@ const provideInitialValuesForSyncBoxesInjectable = getInjectable({
run: async () => {
const initialValues = await requestFromChannel(syncBoxInitialValueChannel);
console.log({
initialValues,
type: typeof initialValues,
});
initialValues.forEach(({ id, value }) => {
setSyncBoxState(id, value);
});

5
src/test-utils/channel-fakes/override-messaging-from-main-to-window.ts
View File

@ -9,7 +9,6 @@ import type { SendToViewArgs } from "../../main/start-main-application/lens-wind
import enlistMessageChannelListenerInjectableInRenderer from "../../renderer/utils/channel/channel-listeners/enlist-message-channel-listener.injectable";
import type { DiContainer } from "@ogre-tools/injectable";
import assert from "assert";
import { tentativeParseJson } from "../../common/utils/tentative-parse-json";
export const overrideMessagingFromMainToWindow = (mainDi: DiContainer) => {
const messageChannelListenerFakesForRenderer = new Map<
@ -48,9 +47,7 @@ export const overrideMessagingFromMainToWindow = (mainDi: DiContainer) => {
);
}
const message = tentativeParseJson(data[0]);
listeners.forEach((listener) => listener.handler(message));
listeners.forEach((listener) => listener.handler(data[0]));
},
);

5
src/test-utils/channel-fakes/override-requesting-from-window-to-main.ts
View File

@ -44,11 +44,12 @@ export const overrideRequestingFromWindowToMain = (mainDi: DiContainer) => {
requestFromChannelInjectable,
() => async (channel, ...[request]) => {
const requestListener = requestChannelListenerFakesForMain.get(channel.id);
const { id } = channel as unknown as RequestChannel<any, any>;
const requestListener = requestChannelListenerFakesForMain.get(id);
if (!requestListener) {
throw new Error(
`Tried to get value from channel "${channel.id}", but no listeners were registered`,
`Tried to get value from channel "${id}", but no listeners were registered`,
);
}