feat: add ipc framework

.eslintrc.js

@@ -19,13 +19,13 @@ module.exports = {
 
     'arrow-body-style': 'off', // warn
     'arrow-parens': 'off', // warn
-
+    'class-methods-use-this': 'off',
     'comma-dangle': 'off',
     'consistent-return': 'off', // warn. Look at api calls closely before enabling this. api.ts.
 
     'default-param-last': 'off',
     'dot-notation': 'off', // required for our env variables currently
-
+    'no-await-in-loop': 'off',
     'import/no-named-as-default': 'off',
     'import/no-cycle': 'off',
     'import/no-extraneous-dependencies': 'off',

electron/app/services/cluster/handlers/index.ts

@@ -0,0 +1 @@
+export * from './ping';

electron/app/services/cluster/handlers/ping.ts

@@ -0,0 +1,7 @@
+import type {PingParams, PingResult} from '@shared/ipc';
+
+export async function ping({context, kubeconfig}: PingParams): Promise<PingResult> {
+  // eslint-disable-next-line no-console
+  console.log('fake ping for', context, kubeconfig);
+  return {ok: false};
+}

electron/app/services/cluster/ipc.ts

@@ -0,0 +1,4 @@
+import {handleIpc} from '../../utils/ipc';
+import {ping} from './handlers/ping';
+
+handleIpc('cluster:ping', ping);

electron/app/utils/ipc.ts

@@ -0,0 +1,15 @@
+import {ipcMain} from 'electron';
+
+import {IpcResult} from '@shared/ipc';
+
+export async function handleIpc<Params, Result>(channel: string, handler: (params: Params) => Result) {
+  ipcMain.handle(channel, async (_, params: Params): Promise<IpcResult> => {
+    try {
+      const payload = await handler(params);
+      return {success: true, payload};
+    } catch (err) {
+      const msg = err instanceof Error ? err.message : 'error_unknown';
+      return {success: false, reason: msg};
+    }
+  });
+}

src/redux/cluster/service/ping.ts

@@ -0,0 +1,16 @@
+import {invokeIpc} from '@utils/ipc';
+
+import type {PingParams, PingResult} from '@shared/ipc';
+
+/**
+ * Example usage:
+ *
+ * ```
+ * try {
+ *   const { ok } = await ping({ context: "minikube" })
+ * } catch (err) {
+ *   console.log(err);
+ * }
+ * ```
+ */
+export const ping = invokeIpc<PingParams, PingResult>('cluster:ping');

src/shared/ipc/cluster.ts

@@ -0,0 +1,8 @@
+export type PingParams = {
+  context: string;
+  kubeconfig?: string;
+};
+
+export type PingResult = {
+  ok: boolean;
+};

src/shared/ipc/core.ts

@@ -0,0 +1,3 @@
+export type IpcResult = IpcSuccess | IpcFailure;
+export type IpcSuccess = {success: true; payload: any};
+export type IpcFailure = {success: false; reason: string};

src/shared/ipc/index.ts

@@ -0,0 +1,2 @@
+export * from './cluster';
+export * from './core';

src/utils/ipc.ts

@@ -1,3 +1,6 @@
+import {ipcRenderer} from 'electron';
+
+import type {IpcResult} from '@shared/ipc';
 import {StartupFlags} from '@shared/models/startupFlag';
 
 import {StartupFlag} from './startupFlag';
@@ -9,3 +12,16 @@ export function getChannelName(name: string, hasAutomationFlag = StartupFlag.get
 
   return name;
 }
+
+export function invokeIpc<Params, Result>(channel: string) {
+  return async (params: Params): Promise<Result> => {
+    try {
+      const result: IpcResult = await ipcRenderer.invoke(channel, params);
+      if (!result.success) throw new Error(result.reason);
+      return result.payload;
+    } catch (err) {
+      const msg = err instanceof Error ? err.message : 'error_unknown';
+      throw new Error(msg);
+    }
+  };
+}