Fix script deletion during execution on desktop

This commit fixes an issue seen on certain Windows environments (Windows
10 22H2 and 11 23H2 Pro Azure VMs) where scripts were being deleted
during execution due to temporary directory usage. To resolve this,
scripts are now stored in a persistent directory, enhancing reliability
for long-running scripts and improving auditability along with
troubleshooting.

Key changes:

- Move script execution logic to the `main` process from `preloader` to
  utilize Electron's `app.getPath`.
- Improve runtime environment detection for non-browser environments to
  allow its usage in Electron main process.
- Introduce a secure module to expose IPC channels from the main process
  to the renderer via the preloader process.

Supporting refactorings include:

- Simplify `CodeRunner` interface by removing the `tempScriptFolderName`
  parameter.
- Rename `NodeSystemOperations` to `NodeElectronSystemOperations` as it
  now wraps electron APIs too, and convert it to class for simplicity.
- Rename `TemporaryFileCodeRunner` to `ScriptFileCodeRunner` to reflect
  its new functinoality.
- Rename `SystemOperations` folder to `System` for simplicity.
- Rename `HostRuntimeEnvironment` to `BrowserRuntimeEnvironment` for
  clarity.
- Refactor main Electron process configuration to align with latest
  Electron documentation/recommendations.
- Refactor unit tests `BrowserRuntimeEnvironment` to simplify singleton
  workaround.
- Use alias imports like `electron/main` and `electron/common` for
  better clarity.

src/presentation/electron/main/IpcRegistration.ts

@@ -0,0 +1,24 @@
+import { ScriptFileCodeRunner } from '@/infrastructure/CodeRunner/ScriptFileCodeRunner';
+import { CodeRunner } from '@/application/CodeRunner';
+import { registerIpcChannel } from '../shared/IpcBridging/IpcProxy';
+import { IpcChannelDefinitions } from '../shared/IpcBridging/IpcChannelDefinitions';
+
+export function registerAllIpcChannels(
+  createCodeRunner: CodeRunnerFactory = () => new ScriptFileCodeRunner(),
+  registrar: IpcRegistrar = registerIpcChannel,
+) {
+  const registrars: Record<keyof typeof IpcChannelDefinitions, () => void> = {
+    CodeRunner: () => registrar(IpcChannelDefinitions.CodeRunner, createCodeRunner()),
+  };
+  Object.entries(registrars).forEach(([name, register]) => {
+    try {
+      register();
+    } catch (err) {
+      throw new AggregateError(`main: Failed to register IPC channel "${name}"`, err);
+    }
+  });
+}
+
+export type CodeRunnerFactory = () => CodeRunner;
+
+export type IpcRegistrar = typeof registerIpcChannel;

src/presentation/electron/main/Update/AutomaticUpdateCoordinator.ts

@@ -1,4 +1,4 @@
-import { app, dialog } from 'electron';
+import { app, dialog } from 'electron/main';
 import { autoUpdater, UpdateInfo } from 'electron-updater';
 import { ProgressInfo } from 'electron-builder';
 import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';

src/presentation/electron/main/Update/ManualUpdater/Dialogs.ts

@@ -1,4 +1,4 @@
-import { dialog } from 'electron';
+import { dialog } from 'electron/main';
 
 export enum ManualUpdateChoice {
   NoAction = 0,

src/presentation/electron/main/Update/ManualUpdater/Downloader.ts

@@ -1,7 +1,7 @@
 import { existsSync, createWriteStream, type WriteStream } from 'node:fs';
 import { unlink, mkdir } from 'node:fs/promises';
 import path from 'node:path';
-import { app } from 'electron';
+import { app } from 'electron/main';
 import { UpdateInfo } from 'electron-updater';
 import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
 import { UpdateProgressBar } from '../UpdateProgressBar';

src/presentation/electron/main/Update/ManualUpdater/Installer.ts

@@ -1,4 +1,5 @@
-import { app, shell } from 'electron';
+import { app } from 'electron/main';
+import { shell } from 'electron/common';
 import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
 import { retryFileSystemAccess } from './RetryFileSystemAccess';
 

src/presentation/electron/main/Update/UpdateProgressBar.ts

@@ -1,6 +1,6 @@
 import ProgressBar from 'electron-progressbar';
 import { ProgressInfo } from 'electron-builder';
-import { app, BrowserWindow } from 'electron';
+import { app, BrowserWindow } from 'electron/main';
 import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
 
 export class UpdateProgressBar {

src/presentation/electron/main/index.ts

@@ -1,16 +1,19 @@
 // Initializes Electron's main process, always runs in the background, and manages the main window.
 
 import {
-  app, protocol, BrowserWindow, shell, screen,
-} from 'electron';
+  app, protocol, BrowserWindow, screen,
+} from 'electron/main';
+import { shell } from 'electron/common';
 import log from 'electron-log/main';
 import installExtension, { VUEJS_DEVTOOLS } from 'electron-devtools-installer';
 import { validateRuntimeSanity } from '@/infrastructure/RuntimeSanity/SanityChecks';
 import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
+import { name } from '@/../package.json' assert { type: 'json' };
 import { setupAutoUpdater } from './Update/UpdateInitializer';
 import {
   APP_ICON_PATH, PRELOADER_SCRIPT_PATH, RENDERER_HTML_PATH, RENDERER_URL,
 } from './ElectronConfig';
+import { registerAllIpcChannels } from './IpcRegistration';
 
 const isDevelopment = !app.isPackaged;
 
@@ -57,36 +60,11 @@ function createWindow() {
   });
 }
 
-let macOsQuit = false;
-// Quit when all windows are closed.
-app.on('window-all-closed', () => {
-  if (process.platform === 'darwin'
-    && !macOsQuit) {
-    // On macOS it is common for applications and their menu bar
-    // to stay active until the user quits explicitly with Cmd + Q
-    return;
-  }
-  app.quit();
-});
+configureAppQuitBehavior();
+registerAllIpcChannels();
+setAppName();
 
-if (process.platform === 'darwin') {
-  // On macOS we application quit is stopped if user does not Cmd + Q
-  // But we still want to be able to use app.quit() and quit the application
-  // on menu bar, after updates etc.
-  app.on('before-quit', () => {
-    macOsQuit = true;
-  });
-}
-
-app.on('activate', () => {
-  // On macOS it's common to re-create a window in the app when the
-  // dock icon is clicked and there are no other windows open.
-  if (win === null) {
-    createWindow();
-  }
-});
-
-app.on('ready', async () => {
+app.whenReady().then(async () => {
   if (isDevelopment) {
     try {
       await installExtension(VUEJS_DEVTOOLS);
@@ -95,6 +73,13 @@ app.on('ready', async () => {
     }
   }
   createWindow();
+  app.on('activate', () => {
+    if (BrowserWindow.getAllWindows().length === 0) {
+      // On macOS it's common to re-create a window in the app when the
+      // dock icon is clicked and there are no other windows open.
+      createWindow();
+    }
+  });
 });
 
 // Exit cleanly on request from parent process in development mode.
@@ -156,3 +141,39 @@ function setupLogger(): void {
   log.transports.file.level = 'silly';
   log.eventLogger.startLogging();
 }
+
+function configureAppQuitBehavior() {
+  let macOsQuit = false;
+  // Quit when all windows are closed.
+  app.on('window-all-closed', () => {
+    if (process.platform === 'darwin'
+      && !macOsQuit) {
+      /*
+        On macOS it is common for applications and their menu bar
+        to stay active until the user quits explicitly with Cmd + Q
+      */
+      return;
+    }
+    app.quit();
+  });
+  if (process.platform === 'darwin') {
+    /*
+      On macOS we application quit is stopped if user does not Cmd + Q
+      But we still want to be able to use app.quit() and quit the application
+      on menu bar, after updates etc.
+    */
+    app.on('before-quit', () => {
+      macOsQuit = true;
+    });
+  }
+}
+
+function setAppName() {
+  /*
+    Set the app name in development mode to ensure correct userData path.
+    Without this, `app.getPath('userData')` defaults to 'Electron'.
+  */
+  if (isDevelopment) {
+    app.setName(name); // Works only for Windows, unsolved for macOS.
+  }
+}

src/presentation/electron/preload/ContextBridging/ApiContextBridge.ts

@@ -1,4 +1,4 @@
-import { contextBridge } from 'electron';
+import { contextBridge } from 'electron/renderer';
 import { bindObjectMethods } from './MethodContextBinder';
 import { provideWindowVariables } from './RendererApiProvider';
 

src/presentation/electron/preload/ContextBridging/NodeOsMapper.ts

@@ -1,14 +0,0 @@
-import { OperatingSystem } from '@/domain/OperatingSystem';
-
-export function convertPlatformToOs(platform: NodeJS.Platform): OperatingSystem | undefined {
-  switch (platform) {
-    case 'darwin':
-      return OperatingSystem.macOS;
-    case 'win32':
-      return OperatingSystem.Windows;
-    case 'linux':
-      return OperatingSystem.Linux;
-    default:
-      return undefined;
-  }
-}

src/presentation/electron/preload/ContextBridging/README.md

@@ -0,0 +1,14 @@
+# Context Bridging Module
+
+This module establishes secure, maintainable, and efficient inter-process communication between the preloader
+and renderer processes.
+
+## Benefits
+
+- **Security**: Exposes intended parts of an object to the renderer process, safeguarding the application's
+  integrity and security.
+- **Type Safety and Maintainability**: Offers type-checked contracts for robust and easy-to-maintain code.
+- **Simplicity**: Streamlines the process of exposing APIs to the renderer process, minimizing the complexity
+  of context bindings.
+- **Scalability**: Enhances the scalability of API exposure and simplifies managing more complex API structures,
+  overcoming the limitations of ad-hoc approaches.

src/presentation/electron/preload/ContextBridging/RendererApiProvider.ts

@@ -1,27 +1,27 @@
 import { createElectronLogger } from '@/infrastructure/Log/ElectronLogger';
 import { Logger } from '@/application/Common/Log/Logger';
 import { WindowVariables } from '@/infrastructure/WindowVariables/WindowVariables';
-import { TemporaryFileCodeRunner } from '@/infrastructure/CodeRunner/TemporaryFileCodeRunner';
-import { CodeRunner } from '@/application/CodeRunner';
-import { convertPlatformToOs } from './NodeOsMapper';
+import { convertPlatformToOs } from '@/infrastructure/RuntimeEnvironment/Node/NodeOsMapper';
+import { createIpcConsumerProxy } from '../../shared/IpcBridging/IpcProxy';
+import { IpcChannelDefinitions } from '../../shared/IpcBridging/IpcChannelDefinitions';
 import { createSecureFacade } from './SecureFacadeCreator';
 
 export function provideWindowVariables(
-  createCodeRunner: CodeRunnerFactory = () => new TemporaryFileCodeRunner(),
   createLogger: LoggerFactory = () => createElectronLogger(),
   convertToOs = convertPlatformToOs,
   createApiFacade: ApiFacadeFactory = createSecureFacade,
+  ipcConsumerCreator: IpcConsumerProxyCreator = createIpcConsumerProxy,
 ): WindowVariables {
   return {
     isDesktop: true,
     log: createApiFacade(createLogger(), ['info', 'debug', 'warn', 'error']),
     os: convertToOs(process.platform),
-    codeRunner: createApiFacade(createCodeRunner(), ['runCode']),
+    codeRunner: ipcConsumerCreator(IpcChannelDefinitions.CodeRunner),
   };
 }
 
 export type LoggerFactory = () => Logger;
 
-export type CodeRunnerFactory = () => CodeRunner;
-
 export type ApiFacadeFactory = typeof createSecureFacade;
+
+export type IpcConsumerProxyCreator = typeof createIpcConsumerProxy;

src/presentation/electron/shared/IpcBridging/IpcChannel.ts

@@ -0,0 +1,6 @@
+import { FunctionKeys } from '@/TypeHelpers';
+
+export interface IpcChannel<T> {
+  readonly namespace: string;
+  readonly accessibleMembers: readonly FunctionKeys<T>[]; // Property keys are not yet supported
+}

src/presentation/electron/shared/IpcBridging/IpcChannelDefinitions.ts

@@ -0,0 +1,17 @@
+import { FunctionKeys } from '@/TypeHelpers';
+import { CodeRunner } from '@/application/CodeRunner';
+import { IpcChannel } from './IpcChannel';
+
+export const IpcChannelDefinitions = {
+  CodeRunner: defineElectronIpcChannel<CodeRunner>('code-run', ['runCode']),
+} as const;
+
+function defineElectronIpcChannel<T>(
+  name: string,
+  functionNames: readonly FunctionKeys<T>[],
+): IpcChannel<T> {
+  return {
+    namespace: name,
+    accessibleMembers: functionNames,
+  };
+}

src/presentation/electron/shared/IpcBridging/IpcProxy.ts

@@ -0,0 +1,48 @@
+import { ipcMain } from 'electron/main';
+import { ipcRenderer } from 'electron/renderer';
+import { isFunction } from '@/TypeHelpers';
+import { IpcChannel } from './IpcChannel';
+
+export function createIpcConsumerProxy<T>(
+  channel: IpcChannel<T>,
+  electronIpcRenderer: Electron.IpcRenderer = ipcRenderer,
+): AsyncMethods<T> {
+  const facade: Partial<T> = {};
+  channel.accessibleMembers.forEach((member) => {
+    const functionKey = member as string;
+    const ipcChannel = getIpcChannelIdentifier(channel.namespace, functionKey);
+    facade[functionKey] = ((...args: unknown[]) => {
+      return electronIpcRenderer.invoke(ipcChannel, ...args);
+    }) as AsyncMethods<T>[keyof T];
+  });
+  return facade as AsyncMethods<T>;
+}
+
+export function registerIpcChannel<T>(
+  channel: IpcChannel<T>,
+  originalObject: T,
+  electronIpcMain: Electron.IpcMain = ipcMain,
+) {
+  channel.accessibleMembers.forEach((functionKey) => {
+    const originalFunction = originalObject[functionKey];
+    if (!isFunction(originalFunction)) {
+      throw new Error('Non-function members are not yet supported');
+    }
+    const ipcChannel = getIpcChannelIdentifier(channel.namespace, functionKey as string);
+    electronIpcMain.handle(ipcChannel, (_event, ...args: unknown[]) => {
+      return originalFunction.apply(originalObject, args);
+    });
+  });
+}
+
+function getIpcChannelIdentifier(namespace: string, key: string) {
+  return `proxy:${namespace}:${key}`;
+}
+
+type AsyncMethods<T> = {
+  [P in keyof T]: T[P] extends (...args: infer Args) => infer R
+    ? R extends Promise<unknown>
+      ? (...args: Args) => R
+      : (...args: Args) => Promise<R>
+    : never;
+};

src/presentation/electron/shared/IpcBridging/README.md

@@ -0,0 +1,17 @@
+# IPC bridging
+
+This module introduces structured and type-safe inter-process communication (IPC) to Electron applications,
+enhancing the development and maintenance of complex features.
+
+## Benefits
+
+- **Type safety**: Ensures reliable data exchange between processes and prevents runtime errors through enforced
+  type checks in IPC communication.
+- **Maintainability**: Facilitates easy tracking and management of inter-process contracts using defined and clear
+  interfaces.
+- **Security**: Implements the least-privilege principle by defining which members are accessible in proxy objects,
+  enhancing the security of IPC interactions.
+- **Simplicity**: Simplifies IPC calls by abstracting the underlying complexity, providing a more straightforward
+  interface for developers.
+- **Scalability**: Structured IPC management supports effective scaling and reduces the challenges of ad-hoc
+  IPC implementations.