Extract messaging to NPM package

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

packages/technical-features/messaging/renderer/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "extends": "@k8slens/eslint-config/eslint",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  }
+}

packages/technical-features/messaging/renderer/.prettierrc

@@ -0,0 +1 @@
+"@k8slens/eslint-config/prettier"

packages/technical-features/messaging/renderer/index.ts

@@ -0,0 +1 @@
+export { messagingFeatureForRenderer } from "./src/feature";

packages/technical-features/messaging/renderer/jest.config.js

@@ -0,0 +1,2 @@
+module.exports =
+  require("@k8slens/jest").monorepoPackageConfig(__dirname).configForNode;

packages/technical-features/messaging/renderer/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@k8slens/messaging-for-renderer",
+  "private": false,
+  "version": "1.0.0-alpha.1",
+  "description": "Implementations for 'messaging' in Electron renderer",
+  "type": "commonjs",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lensapp/lens.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": {
+    "name": "OpenLens Authors",
+    "email": "info@k8slens.dev"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/lensapp/lens",
+  "scripts": {
+    "build": "webpack",
+    "dev": "webpack --mode=development --watch",
+    "test:unit": "jest --coverage --runInBand",
+    "lint": "lens-lint",
+    "lint:fix": "lens-lint --fix"
+  },
+  "peerDependencies": {
+    "@k8slens/application": "^6.5.0-alpha.0",
+    "@k8slens/messaging": "^1.0.0-alpha.1",
+    "@k8slens/run-many": "^1.0.0-alpha.1",
+    "@k8slens/startable-stoppable": "^1.0.0-alpha.1",
+    "@ogre-tools/injectable": "^15.1.2",
+    "@ogre-tools/injectable-extension-for-auto-registration": "^15.1.2",
+    "electron": "^19.1.8",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@k8slens/eslint-config": "^6.5.0-alpha.1"
+  }
+}

packages/technical-features/messaging/renderer/src/feature.ts

@@ -0,0 +1,17 @@
+import { autoRegister } from "@ogre-tools/injectable-extension-for-auto-registration";
+import { getFeature } from "@k8slens/feature-core";
+
+export const messagingFeatureForRenderer = getFeature({
+  id: "messaging-for-renderer",
+
+  register: (di) => {
+    autoRegister({
+      di,
+      targetModule: module,
+
+      getRequireContexts: () => [
+        require.context("./", true, /\.injectable\.(ts|tsx)$/),
+      ],
+    });
+  },
+});

packages/technical-features/messaging/renderer/src/ipc/ipc-renderer.injectable.ts

@@ -0,0 +1,10 @@
+import { getInjectable } from "@ogre-tools/injectable";
+import { ipcRenderer } from "electron";
+
+const ipcRendererInjectable = getInjectable({
+  id: "ipc-renderer",
+  instantiate: () => ipcRenderer,
+  causesSideEffects: true,
+});
+
+export default ipcRendererInjectable;

packages/technical-features/messaging/renderer/src/ipc/ipc-renderer.test.ts

@@ -0,0 +1,27 @@
+import { createContainer, DiContainer } from "@ogre-tools/injectable";
+import { registerFeature } from "@k8slens/feature-core";
+import ipcRendererInjectable from "./ipc-renderer.injectable";
+import { feature } from "../feature";
+import { ipcRenderer } from "electron";
+
+describe("ipc-renderer", () => {
+  let di: DiContainer;
+
+  beforeEach(() => {
+    di = createContainer("irrelevant");
+
+    registerFeature(di, feature);
+  });
+
+  it("is not undefined", () => {
+    const actual = di.inject(ipcRendererInjectable);
+
+    expect(actual).not.toBeUndefined();
+  });
+
+  it("is IPC-renderer of Electron", () => {
+    const actual = di.inject(ipcRendererInjectable);
+
+    expect(actual).toBe(ipcRenderer);
+  });
+});

packages/technical-features/messaging/renderer/src/listening-of-messages/enlist-message-channel-listener.injectable.ts

@@ -0,0 +1,28 @@
+import ipcRendererInjectable from "../ipc/ipc-renderer.injectable";
+import { getInjectable } from "@ogre-tools/injectable";
+import type { IpcRendererEvent } from "electron";
+import { enlistMessageChannelListenerInjectionToken } from "@k8slens/messaging";
+
+const enlistMessageChannelListenerInjectable = getInjectable({
+  id: "enlist-message-channel-listener-for-renderer",
+
+  instantiate: (di) => {
+    const ipcRenderer = di.inject(ipcRendererInjectable);
+
+    return ({ channel, handler }) => {
+      const nativeCallback = (_: IpcRendererEvent, message: unknown) => {
+        handler(message);
+      };
+
+      ipcRenderer.on(channel.id, nativeCallback);
+
+      return () => {
+        ipcRenderer.off(channel.id, nativeCallback);
+      };
+    };
+  },
+
+  injectionToken: enlistMessageChannelListenerInjectionToken,
+});
+
+export default enlistMessageChannelListenerInjectable;

packages/technical-features/messaging/renderer/src/listening-of-messages/enlist-message-channel-listener.test.ts

@@ -0,0 +1,103 @@
+import type { IpcRendererEvent, IpcRenderer } from "electron";
+import ipcRendererInjectable from "../ipc/ipc-renderer.injectable";
+import {
+  EnlistMessageChannelListener,
+  enlistMessageChannelListenerInjectionToken,
+} from "@k8slens/messaging";
+import { createContainer } from "@ogre-tools/injectable";
+import { registerFeature } from "@k8slens/feature-core";
+import { feature } from "../feature";
+
+describe("enlist message channel listener in renderer", () => {
+  let enlistMessageChannelListener: EnlistMessageChannelListener;
+  let ipcRendererStub: IpcRenderer;
+  let onMock: jest.Mock;
+  let offMock: jest.Mock;
+
+  beforeEach(() => {
+    const di = createContainer("irrelevant");
+
+    registerFeature(di, feature);
+
+    onMock = jest.fn();
+    offMock = jest.fn();
+
+    ipcRendererStub = {
+      on: onMock,
+      off: offMock,
+    } as unknown as IpcRenderer;
+
+    di.override(ipcRendererInjectable, () => ipcRendererStub);
+
+    enlistMessageChannelListener = di.inject(
+      enlistMessageChannelListenerInjectionToken
+    );
+  });
+
+  describe("when called", () => {
+    let handlerMock: jest.Mock;
+    let disposer: () => void;
+
+    beforeEach(() => {
+      handlerMock = jest.fn();
+
+      disposer = enlistMessageChannelListener({
+        id: "some-listener",
+        channel: { id: "some-channel-id" },
+        handler: handlerMock,
+      });
+    });
+
+    it("does not call handler yet", () => {
+      expect(handlerMock).not.toHaveBeenCalled();
+    });
+
+    it("registers the listener", () => {
+      expect(onMock).toHaveBeenCalledWith(
+        "some-channel-id",
+        expect.any(Function)
+      );
+    });
+
+    it("does not de-register the listener yet", () => {
+      expect(offMock).not.toHaveBeenCalled();
+    });
+
+    describe("when message arrives", () => {
+      beforeEach(() => {
+        onMock.mock.calls[0][1]({} as IpcRendererEvent, "some-message");
+      });
+
+      it("calls the handler with the message", () => {
+        expect(handlerMock).toHaveBeenCalledWith("some-message");
+      });
+
+      it("when disposing the listener, de-registers the listener", () => {
+        disposer();
+
+        expect(offMock).toHaveBeenCalledWith(
+          "some-channel-id",
+          expect.any(Function)
+        );
+      });
+    });
+
+    it("given number as message, when message arrives, calls the handler with the message", () => {
+      onMock.mock.calls[0][1]({} as IpcRendererEvent, 42);
+
+      expect(handlerMock).toHaveBeenCalledWith(42);
+    });
+
+    it("given boolean as message, when message arrives, calls the handler with the message", () => {
+      onMock.mock.calls[0][1]({} as IpcRendererEvent, true);
+
+      expect(handlerMock).toHaveBeenCalledWith(true);
+    });
+
+    it("given object as message, when message arrives, calls the handler with the message", () => {
+      onMock.mock.calls[0][1]({} as IpcRendererEvent, { some: "object" });
+
+      expect(handlerMock).toHaveBeenCalledWith({ some: "object" });
+    });
+  });
+});

packages/technical-features/messaging/renderer/src/listening-of-messages/listening-of-channels.test.ts

@@ -0,0 +1,38 @@
+import { createContainer, getInjectable } from "@ogre-tools/injectable";
+import { registerFeature } from "@k8slens/feature-core";
+import { messagingFeatureForRenderer } from "../feature";
+import { listeningOfChannelsInjectionToken } from "@k8slens/messaging";
+import { getStartableStoppable } from "@k8slens/startable-stoppable";
+import { runManyFor } from "@k8slens/run-many";
+import { onLoadOfApplicationInjectionToken } from "@k8slens/application";
+
+describe("listening-of-channels", () => {
+  it("when before frame starts, starts listening of channels", async () => {
+    const di = createContainer("irrelevant");
+
+    registerFeature(di, messagingFeatureForRenderer);
+
+    const listeningOfChannelsMock = jest.fn(() => () => {});
+
+    const listeningOfChannelsInjectableStub = getInjectable({
+      id: "some-runnable",
+
+      instantiate: () =>
+        getStartableStoppable("some-listening-of-channels-implementation", () =>
+          listeningOfChannelsMock()
+        ),
+
+      injectionToken: listeningOfChannelsInjectionToken,
+    });
+
+    di.register(listeningOfChannelsInjectableStub);
+
+    const onLoadOfApplication = runManyFor(di)(
+      onLoadOfApplicationInjectionToken
+    );
+
+    await onLoadOfApplication();
+
+    expect(listeningOfChannelsMock).toHaveBeenCalled();
+  });
+});

packages/technical-features/messaging/renderer/src/requesting-of-requests/invoke-ipc.injectable.ts

@@ -0,0 +1,10 @@
+import { getInjectable } from "@ogre-tools/injectable";
+import ipcRendererInjectable from "../ipc/ipc-renderer.injectable";
+
+const invokeIpcInjectable = getInjectable({
+  id: "invoke-ipc",
+
+  instantiate: (di) => di.inject(ipcRendererInjectable).invoke,
+});
+
+export default invokeIpcInjectable;

packages/technical-features/messaging/renderer/src/requesting-of-requests/invoke-ipc.test.ts

@@ -0,0 +1,21 @@
+import { createContainer, DiContainer } from "@ogre-tools/injectable";
+import { registerFeature } from "@k8slens/feature-core";
+import { messagingFeatureForRenderer } from "../feature";
+import { ipcRenderer } from "electron";
+import invokeIpcInjectable from "./invoke-ipc.injectable";
+
+describe("ipc-renderer", () => {
+  let di: DiContainer;
+
+  beforeEach(() => {
+    di = createContainer("irrelevant");
+
+    registerFeature(di, messagingFeatureForRenderer);
+  });
+
+  it("is IPC-renderer invoke of Electron", () => {
+    const actual = di.inject(invokeIpcInjectable);
+
+    expect(actual).toBe(ipcRenderer.invoke);
+  });
+});

packages/technical-features/messaging/renderer/src/requesting-of-requests/request-from-channel.injectable.ts

@@ -0,0 +1,19 @@
+import { getInjectable } from "@ogre-tools/injectable";
+import type { RequestFromChannel } from "@k8slens/messaging";
+import { requestFromChannelInjectionToken } from "@k8slens/messaging";
+import invokeIpcInjectable from "./invoke-ipc.injectable";
+
+const requestFromChannelInjectable = getInjectable({
+  id: "request-from-channel",
+
+  instantiate: (di) => {
+    const invokeIpc = di.inject(invokeIpcInjectable);
+
+    return ((channel, request) =>
+      invokeIpc(channel.id, request)) as RequestFromChannel;
+  },
+
+  injectionToken: requestFromChannelInjectionToken,
+});
+
+export default requestFromChannelInjectable;

packages/technical-features/messaging/renderer/src/requesting-of-requests/request-from-channel.test.ts

@@ -0,0 +1,49 @@
+import { createContainer, DiContainer } from "@ogre-tools/injectable";
+import { registerFeature } from "@k8slens/feature-core";
+import { requestFromChannelInjectionToken } from "@k8slens/messaging";
+import { messagingFeatureForRenderer } from "../feature";
+import type { RequestChannel } from "@k8slens/messaging";
+import invokeIpcInjectable from "./invoke-ipc.injectable";
+import type { AsyncFnMock } from "@async-fn/jest";
+import asyncFn from "@async-fn/jest";
+
+describe("request-from-channel", () => {
+  let di: DiContainer;
+  let invokeIpcMock: AsyncFnMock<() => Promise<number>>;
+
+  beforeEach(() => {
+    di = createContainer("irrelevant");
+
+    registerFeature(di, messagingFeatureForRenderer);
+
+    invokeIpcMock = asyncFn();
+    di.override(invokeIpcInjectable, () => invokeIpcMock);
+  });
+
+  describe("when called", () => {
+    let actualPromise: Promise<number>;
+
+    beforeEach(() => {
+      const requestFromChannel = di.inject(requestFromChannelInjectionToken);
+
+      const someChannel: RequestChannel<string, number> = {
+        id: "some-channel-id",
+      };
+
+      actualPromise = requestFromChannel(someChannel, "some-request-payload");
+    });
+
+    it("invokes ipcRenderer of Electron", () => {
+      expect(invokeIpcMock).toHaveBeenCalledWith(
+        "some-channel-id",
+        "some-request-payload"
+      );
+    });
+
+    it("when invoke resolves with response, resolves with said response", async () => {
+      await invokeIpcMock.resolve(42);
+
+      expect(await actualPromise).toBe(42);
+    });
+  });
+});

packages/technical-features/messaging/renderer/src/sending-of-messages/message-to-channel.injectable.ts

@@ -0,0 +1,22 @@
+import { getInjectable } from "@ogre-tools/injectable";
+import sendToIpcInjectable from "./send-to-ipc.injectable";
+import {
+  SendMessageToChannel,
+  sendMessageToChannelInjectionToken,
+} from "@k8slens/messaging";
+
+const messageToChannelInjectable = getInjectable({
+  id: "message-to-channel",
+
+  instantiate: (di) => {
+    const sendToIpc = di.inject(sendToIpcInjectable);
+
+    return ((channel, message) => {
+      sendToIpc(channel.id, message);
+    }) as SendMessageToChannel;
+  },
+
+  injectionToken: sendMessageToChannelInjectionToken,
+});
+
+export default messageToChannelInjectable;

packages/technical-features/messaging/renderer/src/sending-of-messages/message-to-channel.test.ts

@@ -0,0 +1,40 @@
+import { createContainer, DiContainer } from "@ogre-tools/injectable";
+import { registerFeature } from "@k8slens/feature-core";
+import { sendMessageToChannelInjectionToken } from "@k8slens/messaging";
+import { messagingFeatureForRenderer } from "../feature";
+import type { MessageChannel } from "@k8slens/messaging";
+import sendToIpcInjectable from "./send-to-ipc.injectable";
+import type { AsyncFnMock } from "@async-fn/jest";
+import asyncFn from "@async-fn/jest";
+
+describe("message-from-channel", () => {
+  let di: DiContainer;
+  let sendToIpcMock: AsyncFnMock<() => Promise<number>>;
+
+  beforeEach(() => {
+    di = createContainer("irrelevant");
+
+    registerFeature(di, messagingFeatureForRenderer);
+
+    sendToIpcMock = asyncFn();
+    di.override(sendToIpcInjectable, () => sendToIpcMock);
+  });
+
+  describe("when called", () => {
+    beforeEach(() => {
+      const sendMessageToChannel = di.inject(
+        sendMessageToChannelInjectionToken
+      );
+
+      const someChannel: MessageChannel<number> = {
+        id: "some-channel-id",
+      };
+
+      sendMessageToChannel(someChannel, 42);
+    });
+
+    it("sends to ipcRenderer of Electron", () => {
+      expect(sendToIpcMock).toHaveBeenCalledWith("some-channel-id", 42);
+    });
+  });
+});

packages/technical-features/messaging/renderer/src/sending-of-messages/send-to-ipc.injectable.ts

@@ -0,0 +1,10 @@
+import { getInjectable } from "@ogre-tools/injectable";
+import ipcRendererInjectable from "../ipc/ipc-renderer.injectable";
+
+const sendToIpcInjectable = getInjectable({
+  id: "send-to-ipc",
+
+  instantiate: (di) => di.inject(ipcRendererInjectable).send,
+});
+
+export default sendToIpcInjectable;

packages/technical-features/messaging/renderer/src/sending-of-messages/send-to-ipc.test.ts

@@ -0,0 +1,21 @@
+import { createContainer, DiContainer } from "@ogre-tools/injectable";
+import { registerFeature } from "@k8slens/feature-core";
+import { messagingFeatureForRenderer } from "../feature";
+import { ipcRenderer } from "electron";
+import sendToIpcInjectable from "./send-to-ipc.injectable";
+
+describe("ipc-renderer", () => {
+  let di: DiContainer;
+
+  beforeEach(() => {
+    di = createContainer("irrelevant");
+
+    registerFeature(di, messagingFeatureForRenderer);
+  });
+
+  it("is IPC-renderer send of Electron", () => {
+    const actual = di.inject(sendToIpcInjectable);
+
+    expect(actual).toBe(ipcRenderer.send);
+  });
+});

packages/technical-features/messaging/renderer/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@k8slens/typescript/config/base.json",
+  "include": ["**/*.ts"]
+}

packages/technical-features/messaging/renderer/webpack.config.js

@@ -0,0 +1 @@
+module.exports = require("@k8slens/webpack").configForNode;