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,7 @@
import { Dialog } from '@/presentation/common/Dialog';
export class DialogStub implements Dialog {
public saveFile(): Promise<void> {
return Promise.resolve();
}
}

View File

@@ -1,12 +0,0 @@
import { Logger } from '@/application/Common/Log/Logger';
import { LoggerFactory } from '@/application/Common/Log/LoggerFactory';
import { LoggerStub } from './LoggerStub';
export class LoggerFactoryStub implements LoggerFactory {
public logger: Logger = new LoggerStub();
public withLogger(logger: Logger): this {
this.logger = logger;
return this;
}
}

View File

@@ -4,7 +4,7 @@ import { OperatingSystem } from '@/domain/OperatingSystem';
export class RuntimeEnvironmentStub implements RuntimeEnvironment {
public isNonProduction = true;
public isDesktop = true;
public isRunningAsDesktopApplication = false;
public os: OperatingSystem | undefined = OperatingSystem.Windows;
@@ -13,8 +13,8 @@ export class RuntimeEnvironmentStub implements RuntimeEnvironment {
return this;
}
public withIsDesktop(isDesktop: boolean): this {
this.isDesktop = isDesktop;
public withIsRunningAsDesktopApplication(isRunningAsDesktopApplication: boolean): this {
this.isRunningAsDesktopApplication = isRunningAsDesktopApplication;
return this;
}

View File

@@ -2,25 +2,34 @@ import { OperatingSystem } from '@/domain/OperatingSystem';
import { Logger } from '@/application/Common/Log/Logger';
import { WindowVariables } from '@/infrastructure/WindowVariables/WindowVariables';
import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
import { Dialog } from '@/presentation/common/Dialog';
import { LoggerStub } from './LoggerStub';
import { CodeRunnerStub } from './CodeRunnerStub';
import { DialogStub } from './DialogStub';
export class WindowVariablesStub implements WindowVariables {
public codeRunner?: CodeRunner = new CodeRunnerStub();
public isDesktop = false;
public isRunningAsDesktopApplication: true | undefined = true;
public os?: OperatingSystem = OperatingSystem.BlackBerryOS;
public log: Logger = new LoggerStub();
public log?: Logger = new LoggerStub();
public dialog?: Dialog = new DialogStub();
public withLog(log: Logger): this {
this.log = log;
return this;
}
public withIsDesktop(value: boolean): this {
this.isDesktop = value;
public withDialog(dialog: Dialog): this {
this.dialog = dialog;
return this;
}
public withIsRunningAsDesktopApplication(isRunningAsDesktopApplication: true | undefined): this {
this.isRunningAsDesktopApplication = isRunningAsDesktopApplication;
return this;
}