Show native save dialogs in desktop app #50, #264

This commit introduces native operating system file dialogs in the
desktop application replacing the existing web-based dialogs.

It lays the foundation for future enhancements such as:

- Providing error messages when saving or executing files, addressing
  #264.
- Creating system restore points, addressing #50.

Documentation updates:

- Update `desktop-vs-web-features.md` with added functionality.
- Update `README.md` with security feature highlights.
- Update home page documentation to emphasize security features.

Other supporting changes include:

- Integrate IPC communication channels for secure Electron dialog API
  interactions.
- Refactor `IpcRegistration` for more type-safety and simplicity.
- Introduce a Vue hook to encapsulate dialog functionality.
- Improve errors during IPC registration for easier troubleshooting.
- Move `ClientLoggerFactory` for consistency in hooks organization and
  remove `LoggerFactory` interface for simplicity.
- Add tests for the save file dialog in the browser context.
- Add `Blob` polyfill in tests to compensate for the missing
  `blob.text()` function in `jsdom` (see jsdom/jsdom#2555).

Improve environment detection logic:

- Treat test environment as browser environments to correctly activate
  features based on the environment. This resolves issues where the
  environment is misidentified as desktop, but Electron preloader APIs
  are missing.
- Rename `isDesktop` environment identification variable to
  `isRunningAsDesktopApplication` for better clarity and to avoid
  confusion with desktop environments in web/browser/test environments.
- Simplify `BrowserRuntimeEnvironment` to consistently detect
  non-desktop application environments.
- Improve environment detection for Electron main process
  (electron/electron#2288).
This commit is contained in:
undergroundwires
2024-01-13 18:04:23 +01:00
parent da4be500da
commit c546a33eff
65 changed files with 1384 additions and 345 deletions

View File

@@ -0,0 +1,45 @@
import { ElectronFileDialogOperations } from '@/infrastructure/Dialog/Electron/NodeElectronSaveFileDialog';
import { StubWithObservableMethodCalls } from '@tests/unit/shared/Stubs/StubWithObservableMethodCalls';
export class ElectronFileDialogOperationsStub
extends StubWithObservableMethodCalls<ElectronFileDialogOperations>
implements ElectronFileDialogOperations {
private mimicUserCancel = false;
private userDownloadsPath = `[${ElectronFileDialogOperationsStub.name}] downloads path`;
private userSelectedFilePath = `${ElectronFileDialogOperationsStub.name} user selected file path`;
public withMimicUserCancel(isCancelled: boolean): this {
this.mimicUserCancel = isCancelled;
return this;
}
public withUserDownloadsPath(userDownloadsPath: string): this {
this.userDownloadsPath = userDownloadsPath;
return this;
}
public withUserSelectedFilePath(userSelectedFilePath: string): this {
this.userSelectedFilePath = userSelectedFilePath;
return this;
}
public getUserDownloadsPath(): string {
return this.userDownloadsPath;
}
public showSaveDialog(
options: Electron.SaveDialogOptions,
): Promise<Electron.SaveDialogReturnValue> {
this.registerMethodCall({
methodName: 'showSaveDialog',
args: [options],
});
const returnValue: Electron.SaveDialogReturnValue = {
canceled: this.mimicUserCancel,
filePath: this.userSelectedFilePath,
};
return Promise.resolve(returnValue);
}
}