Files
privacy.sexy/src/presentation/electron/shared/IpcBridging/README.md
undergroundwires c84a1bb74c 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.
2024-01-06 18:47:58 +01:00

915 B

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.