Restructure to monorepo (#6907)

* wip: restructure to monorepo

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* refactor create-release-pr to a package

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* build fixes

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* github workflow fixes

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix typo

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* add webpack-env types to core

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix github workflows

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* refactor/fix integration tests

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* lint fix

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* yarn run dev

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* eslint settings for vscode

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* move templates to right package

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* open-lens build fixes

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* integration test fix

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix nx task dependencies

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* use bash shell for unit tests in test workflow

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix test:unit for windows

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix win-ca webpack error in open-lens

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix win-ca webpack error in open-lens

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix build:app on windows

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* remove ELECTRON_BUILDER_EXTRA_ARGS

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* sync src/ from master

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* remove Makefile from core

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

packages/core/src/common/ipc/broadcast-message.global-override-for-injectable.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverrideForFunction } from "../test-utils/get-global-override-for-function";
+import broadcastMessageInjectable from "./broadcast-message.injectable";
+
+export default getGlobalOverrideForFunction(broadcastMessageInjectable);

packages/core/src/common/ipc/broadcast-message.injectable.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 { broadcastMessage } from "./ipc";
+
+export type BroadcastMessage = (channel: string, ...args: any[]) => Promise<void>;
+
+const broadcastMessageInjectable = getInjectable({
+  id: "broadcast-message",
+  instantiate: (): BroadcastMessage => broadcastMessage,
+  causesSideEffects: true,
+});
+
+export default broadcastMessageInjectable;

packages/core/src/common/ipc/catalog.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+/**
+ * This is used to activate a specific entity in the renderer main frame
+ */
+export const catalogEntityRunListener = "catalog-entity:run";
+
+/**
+ * This is broadcast on whenever there is an update to any catalog item
+ */
+export const catalogItemsChannel = "catalog:items";
+
+/**
+ * This can be sent from renderer to main to initialize a broadcast of ITEMS
+ */
+export const catalogInitChannel = "catalog:init";

packages/core/src/common/ipc/cluster.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+export const clusterActivateHandler = "cluster:activate";
+export const clusterSetFrameIdHandler = "cluster:set-frame-id";
+export const clusterVisibilityHandler = "cluster:visibility";
+export const clusterDisconnectHandler = "cluster:disconnect";
+export const clusterStates = "cluster:states";
+
+/**
+ * This channel is broadcast on whenever the cluster fails to list namespaces
+ * during a refresh and no `accessibleNamespaces` have been set.
+ */
+export const clusterListNamespaceForbiddenChannel = "cluster:list-namespace-forbidden";
+
+export type ListNamespaceForbiddenArgs = [clusterId: string];
+
+export function isListNamespaceForbiddenArgs(args: unknown[]): args is ListNamespaceForbiddenArgs {
+  return args.length === 1 && typeof args[0] === "string";
+}

packages/core/src/common/ipc/extension-handling.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+export const extensionDiscoveryStateChannel = "extension-discovery:state";
+export const bundledExtensionsLoaded = "extension-loader:bundled-extensions-loaded";
+export const extensionLoaderFromMainChannel = "extension-loader:main:state";
+export const extensionLoaderFromRendererChannel = "extension-loader:renderer:state";

packages/core/src/common/ipc/hotbar.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+export const hotbarTooManyItemsChannel = "hotbar:too-many-items";

packages/core/src/common/ipc/index.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+export * from "./ipc";
+export * from "./invalid-kubeconfig";

packages/core/src/common/ipc/invalid-kubeconfig/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+export const InvalidKubeconfigChannel = "invalid-kubeconfig";
+
+export type InvalidKubeConfigArgs = [clusterId: string];

packages/core/src/common/ipc/ipc-main-injection-token.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectionToken } from "@ogre-tools/injectable";
+import type { IpcMain } from "electron";
+
+const ipcMainInjectionToken = getInjectionToken<IpcMain>({
+  id: "ipc-main-injection-token",
+});
+
+export default ipcMainInjectionToken;

packages/core/src/common/ipc/ipc.ts

@@ -0,0 +1,116 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+// Inter-process communications (main <-> renderer)
+// https://www.electronjs.org/docs/api/ipc-main
+// https://www.electronjs.org/docs/api/ipc-renderer
+
+import { ipcMain, ipcRenderer, webContents } from "electron";
+import { toJS } from "../utils/toJS";
+import type { ClusterFrameInfo } from "../cluster-frames";
+import { clusterFrameMap } from "../cluster-frames";
+import type { Disposer } from "../utils";
+import { getLegacyGlobalDiForExtensionApi } from "../../extensions/as-legacy-globals-for-extension-api/legacy-global-di-for-extension-api";
+import ipcRendererInjectable from "../../renderer/utils/channel/ipc-renderer.injectable";
+import loggerInjectable from "../logger.injectable";
+import ipcMainInjectionToken from "./ipc-main-injection-token";
+
+export const broadcastMainChannel = "ipc:broadcast-main";
+
+export function ipcMainHandle(channel: string, listener: (event: Electron.IpcMainInvokeEvent, ...args: any[]) => any) {
+  const di = getLegacyGlobalDiForExtensionApi();
+
+  const ipcMain = di.inject(ipcMainInjectionToken);
+
+  ipcMain.handle(channel, async (event, ...args) => {
+    return sanitizePayload(await listener(event, ...args));
+  });
+}
+
+function getSubFrames(): ClusterFrameInfo[] {
+  return Array.from(clusterFrameMap.values());
+}
+
+export async function broadcastMessage(channel: string, ...args: any[]): Promise<void> {
+  if (ipcRenderer) {
+    return ipcRenderer.invoke(broadcastMainChannel, channel, ...args.map(sanitizePayload));
+  }
+
+  if (!webContents) {
+    return;
+  }
+
+  const di = getLegacyGlobalDiForExtensionApi();
+  const logger = di.inject(loggerInjectable);
+
+  ipcMain.listeners(channel).forEach((func) => func({
+    processId: undefined, frameId: undefined, sender: undefined, senderFrame: undefined,
+  }, ...args));
+
+  const subFrames = getSubFrames();
+  const views = webContents.getAllWebContents();
+
+  if (!views || !Array.isArray(views) || views.length === 0) return;
+
+  args = args.map(sanitizePayload);
+
+  for (const view of views) {
+    let viewType = "unknown";
+
+    // There will be a uncaught exception if the view is destroyed.
+    try {
+      viewType = view.getType();
+    } catch {
+      // We can ignore the view destroyed exception as viewType is only used for logging.
+    }
+
+    // Send message to views.
+    try {
+      logger.silly(`[IPC]: broadcasting "${channel}" to ${viewType}=${view.id}`, { args });
+      view.send(channel, ...args);
+    } catch (error) {
+      logger.error(`[IPC]: failed to send IPC message "${channel}" to view "${viewType}=${view.id}"`, { error });
+    }
+
+    // Send message to subFrames of views.
+    for (const frameInfo of subFrames) {
+      logger.silly(`[IPC]: broadcasting "${channel}" to subframe "frameInfo.processId"=${frameInfo.processId} "frameInfo.frameId"=${frameInfo.frameId}`, { args });
+
+      try {
+        view.sendToFrame([frameInfo.processId, frameInfo.frameId], channel, ...args);
+      } catch (error) {
+        logger.error(`[IPC]: failed to send IPC message "${channel}" to view "${viewType}=${view.id}"'s subframe "frameInfo.processId"=${frameInfo.processId} "frameInfo.frameId"=${frameInfo.frameId}`, { error: String(error) });
+      }
+    }
+  }
+}
+
+export function ipcMainOn(channel: string, listener: (event: Electron.IpcMainEvent, ...args: any[]) => any): Disposer {
+  const di = getLegacyGlobalDiForExtensionApi();
+
+  const ipcMain = di.inject(ipcMainInjectionToken);
+
+  ipcMain.on(channel, listener);
+
+  return () => ipcMain.off(channel, listener);
+}
+
+export function ipcRendererOn(channel: string, listener: (event: Electron.IpcRendererEvent, ...args: any[]) => any): Disposer {
+  const di = getLegacyGlobalDiForExtensionApi();
+
+  const ipcRenderer = di.inject(ipcRendererInjectable);
+
+  ipcRenderer.on(channel, listener);
+
+  return () => ipcRenderer.off(channel, listener);
+}
+
+/**
+ * Sanitizing data for IPC-messaging before send.
+ * Removes possible observable values to avoid exceptions like "can't clone object".
+ */
+function sanitizePayload<T>(data: any): T {
+  return toJS(data);
+}

packages/core/src/common/ipc/navigation-events.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+//
+export const enum IpcRendererNavigationEvents {
+  NAVIGATE_IN_APP = "renderer:navigate",
+  NAVIGATE_IN_CLUSTER = "renderer:navigate-in-cluster",
+  LOADED = "renderer:loaded",
+}

packages/core/src/common/ipc/window.ts

@@ -0,0 +1,39 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+export const windowActionHandleChannel = "window:window-action";
+export const windowOpenAppMenuAsContextMenuChannel = "window:open-app-context-menu";
+export const windowLocationChangedChannel = "window:location-changed";
+
+/**
+ * The supported actions on the current window. The argument for `windowActionHandleChannel`
+ */
+export enum WindowAction {
+  /**
+   * Request that the current window goes back one step of browser history
+   */
+  GO_BACK = "back",
+
+  /**
+   * Request that the current window goes forward one step of browser history
+   */
+  GO_FORWARD = "forward",
+
+  /**
+   * Request that the current window is minimized
+   */
+  MINIMIZE = "minimize",
+
+  /**
+   * Request that the current window is maximized if it isn't, or unmaximized
+   * if it is
+   */
+  TOGGLE_MAXIMIZE = "toggle-maximize",
+
+  /**
+   * Request that the current window is closed
+   */
+  CLOSE = "close",
+}