Switch to using messaging and startable stoppable from NPM package (#7368)

* Add custom jest resolver to fix requiring "uuid" module Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Update dependencies Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Introduce test utils for rendering and running with thrown mobx reactions Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Extract startable-stoppable to NPM package Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Extract messaging to NPM package Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Switch to using startable-stoppable from NPM package Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Switch to using messaging from the Feature Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove old implementation of messaging Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make setupping app paths happen earlier in renderer Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix typo Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add kludge to make testing-library work properly from test-utils package Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix code style Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add lint:fix -root script Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix unrelated failing unit tests Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Turn of no-floating-promises from typescript linting for being broken Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make linting not happen for dist -directories Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make linting failures appear as failure Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Stop running prettier twice It already gets ran as eslint-plugin. Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make CI run unit tests for all packages by consolidating name of NPM script Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add missing unit tests for coverage Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Skip coverage for test utils Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove check for coverage in packages which are not ready for it Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Stop collecting coverage from index.ts files them being indirections to the implementation Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Implement sending message to channel in main Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add missing feature dependencies Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add dummy implementations for requesting in main from renderer Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Re-enable communicating from main to cluster frames Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Ignore trivial files from coverage Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Update package-lock Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Extract message-bridge to separate NPM package to prevent dev dependencies being in the production bundle Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Extract computed channel to own NPM package for clear dependencies Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Consolidate electron related stuff to a directory Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add missing publish configurations Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Ignore test implementation from coverage being not interesting Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> --------- Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>
2025-05-20 05:10:56 +00:00 · 2023-03-21 11:38:43 +02:00
1 parent df49ff9b96
commit 0f1f030a06
@@ -0,0 +1,21 @@
+import { getMessageChannel, getMessageChannelListenerInjectable } from "@k8slens/messaging";
+import frameIdsInjectable from "./frameIds.injectable";
+
+const frameCommunicationAdminChannel = getMessageChannel<undefined>(
+  "frame-communication-admin-channel",
+);
+
+const allowCommunicationListenerInjectable = getMessageChannelListenerInjectable({
+  id: "allow-communication",
+  channel: frameCommunicationAdminChannel,
+
+  getHandler: (di) => {
+    const frameIds = di.inject(frameIdsInjectable);
+
+    return (_, { frameId, processId }) => {
+      frameIds.add({ frameId, processId });
+    };
+  },
+});
+
+export default allowCommunicationListenerInjectable;
@@ -0,0 +1,8 @@
+import { getInjectable } from "@ogre-tools/injectable";
+
+const frameIdsInjectable = getInjectable({
+  id: "frame-ids",
+  instantiate: () => new Set<{ frameId: number; processId: number }>(),
+});
+
+export default frameIdsInjectable;
@@ -0,0 +1,12 @@
+/* c8 ignore start */
+import { getInjectable } from "@ogre-tools/injectable";
+import { webContents } from "electron";
+
+const getWebContentsInjectable = getInjectable({
+  id: "web-contents",
+  instantiate: () => () => webContents.getAllWebContents(),
+  causesSideEffects: true,
+});
+
+export default getWebContentsInjectable;
+/* c8 ignore stop */
@@ -0,0 +1,121 @@
+import { registerFeature } from "@k8slens/feature-core";
+import { createContainer, DiContainer } from "@ogre-tools/injectable";
+import { messagingFeatureForMain } from "../feature";
+import { getMessageChannel, sendMessageToChannelInjectionToken } from "@k8slens/messaging";
+import getWebContentsInjectable from "./get-web-contents.injectable";
+import type { WebContents } from "electron";
+import allowCommunicationListenerInjectable from "./allow-communication-listener.injectable";
+
+const someChannel = getMessageChannel<string>("some-channel");
+
+describe("send-message-to-channel", () => {
+  let di: DiContainer;
+
+  beforeEach(() => {
+    di = createContainer("irrelevant");
+
+    registerFeature(di, messagingFeatureForMain);
+  });
+
+  it("given no web contents, when sending a message, does not do anything", () => {
+    di.override(getWebContentsInjectable, () => () => []);
+
+    const sendMessageToChannel = di.inject(sendMessageToChannelInjectionToken);
+
+    expect(() => sendMessageToChannel(someChannel, "some-message")).not.toThrow();
+  });
+
+  describe("given web content that is alive", () => {
+    let sendToFrameMock: jest.Mock;
+    let sendMessageMock: jest.Mock;
+
+    beforeEach(() => {
+      sendToFrameMock = jest.fn();
+      sendMessageMock = jest.fn();
+
+      di.override(getWebContentsInjectable, () => () => [
+        {
+          send: (...args: any[]) => sendMessageMock("first", ...args),
+          sendToFrame: (...args: any[]) => sendToFrameMock("first", ...args),
+          isDestroyed: () => false,
+          isCrashed: () => false,
+        } as unknown as WebContents,
+        {
+          send: (...args: any[]) => sendMessageMock("second", ...args),
+          sendToFrame: (...args: any[]) => sendToFrameMock("second", ...args),
+          isDestroyed: () => false,
+          isCrashed: () => false,
+        } as unknown as WebContents,
+      ]);
+    });
+
+    it("when sending message, sends the message to webcontents", () => {
+      const sendMessageToChannel = di.inject(sendMessageToChannelInjectionToken);
+
+      sendMessageToChannel(someChannel, "some-message");
+
+      expect(sendMessageMock.mock.calls).toEqual([
+        ["first", "some-channel", "some-message"],
+        ["second", "some-channel", "some-message"],
+      ]);
+    });
+
+    describe("when multiple renderers inform that they are ready to listen messages", () => {
+      beforeEach(() => {
+        const allowCommunicationListener = di.inject(allowCommunicationListenerInjectable);
+
+        allowCommunicationListener.handler(undefined, { frameId: 42, processId: 126 });
+        allowCommunicationListener.handler(undefined, { frameId: 84, processId: 168 });
+      });
+
+      describe("when sending a message", () => {
+        beforeEach(() => {
+          const sendMessageToChannel = di.inject(sendMessageToChannelInjectionToken);
+
+          sendMessageToChannel(someChannel, "some-message");
+        });
+
+        it("sends the message to webcontents", () => {
+          expect(sendMessageMock.mock.calls).toEqual([
+            ["first", "some-channel", "some-message"],
+            ["second", "some-channel", "some-message"],
+          ]);
+        });
+
+        it("sends the message to individual frames in webcontents", () => {
+          expect(sendToFrameMock.mock.calls).toEqual([
+            ["first", [42, 126], "some-channel", "some-message"],
+            ["first", [84, 168], "some-channel", "some-message"],
+
+            ["second", [42, 126], "some-channel", "some-message"],
+            ["second", [84, 168], "some-channel", "some-message"],
+          ]);
+        });
+      });
+    });
+  });
+
+  it("given non alive web contents, when sending a message, does not send messages", () => {
+    const sendToWebContentsMock = jest.fn();
+
+    di.override(getWebContentsInjectable, () => () => [
+      {
+        send: sendToWebContentsMock,
+        isDestroyed: () => true,
+        isCrashed: () => false,
+      } as unknown as WebContents,
+
+      {
+        send: sendToWebContentsMock,
+        isDestroyed: () => false,
+        isCrashed: () => true,
+      } as unknown as WebContents,
+    ]);
+
+    const sendMessageToChannel = di.inject(sendMessageToChannelInjectionToken);
+
+    sendMessageToChannel(someChannel, "irrelevant");
+
+    expect(sendToWebContentsMock).not.toHaveBeenCalled();
+  });
+});
@@ -0,0 +1,48 @@
+import { getInjectable } from "@ogre-tools/injectable";
+import { pipeline } from "@ogre-tools/fp";
+import { SendMessageToChannel, sendMessageToChannelInjectionToken } from "@k8slens/messaging";
+import getWebContentsInjectable from "./get-web-contents.injectable";
+import { flatMap, reject } from "lodash/fp";
+import type { WebContents } from "electron";
+import frameIdsInjectable from "./frameIds.injectable";
+
+const isDestroyed = (webContent: WebContents) => webContent.isDestroyed();
+const isCrashed = (webContent: WebContents) => webContent.isCrashed();
+
+const forEach =
+  <T>(predicate: (item: T) => void) =>
+  (items: T[]) =>
+    items.forEach(predicate);
+
+const sendMessageToChannelInjectable = getInjectable({
+  id: "send-message-to-channel",
+
+  instantiate: (di) => {
+    const getWebContents = di.inject(getWebContentsInjectable);
+    const frameIds = di.inject(frameIdsInjectable);
+
+    return ((channel, message) => {
+      pipeline(
+        getWebContents(),
+        reject(isDestroyed),
+        reject(isCrashed),
+
+        flatMap((webContent) => [
+          (channelId: string, ...args: any[]) => webContent.send(channelId, ...args),
+
+          ...[...frameIds].map(({ frameId, processId }) => (channelId: string, ...args: any[]) => {
+            webContent.sendToFrame([frameId, processId], channelId, ...args);
+          }),
+        ]),
+
+        forEach((send) => {
+          send(channel.id, message);
+        }),
+      );
+    }) as SendMessageToChannel;
+  },
+
+  injectionToken: sendMessageToChannelInjectionToken,
+});
+
+export default sendMessageToChannelInjectable;