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
@@ -1,4 +1,3 @@
|
||||
// eslint-disable-next-line max-classes-per-file
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { BrowserOsDetector } from '@/infrastructure/RuntimeEnvironment/Browser/BrowserOs/BrowserOsDetector';
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
@@ -42,31 +41,32 @@ describe('BrowserRuntimeEnvironment', () => {
|
||||
expect(actualTouchSupport).to.equal(expectedTouchSupport);
|
||||
});
|
||||
});
|
||||
describe('isDesktop', () => {
|
||||
it('returns true when window property isDesktop is true', () => {
|
||||
describe('isRunningAsDesktopApplication', () => {
|
||||
it('returns true when window property `isRunningAsDesktopApplication` is true', () => {
|
||||
// arrange
|
||||
const desktopWindow = {
|
||||
isDesktop: true,
|
||||
const expectedValue = true;
|
||||
const desktopWindow: Partial<Window> = {
|
||||
isRunningAsDesktopApplication: true,
|
||||
};
|
||||
// act
|
||||
const sut = new BrowserRuntimeEnvironmentBuilder()
|
||||
.withWindow(desktopWindow)
|
||||
.build();
|
||||
// assert
|
||||
expect(sut.isDesktop).to.equal(true);
|
||||
expect(sut.isRunningAsDesktopApplication).to.equal(expectedValue);
|
||||
});
|
||||
it('returns false when window property isDesktop is false', () => {
|
||||
it('returns false when window property `isRunningAsDesktopApplication` is undefined', () => {
|
||||
// arrange
|
||||
const expectedValue = false;
|
||||
const browserWindow = {
|
||||
isDesktop: false,
|
||||
const browserWindow: Partial<Window> = {
|
||||
isRunningAsDesktopApplication: undefined,
|
||||
};
|
||||
// act
|
||||
const sut = new BrowserRuntimeEnvironmentBuilder()
|
||||
.withWindow(browserWindow)
|
||||
.build();
|
||||
// assert
|
||||
expect(sut.isDesktop).to.equal(expectedValue);
|
||||
expect(sut.isRunningAsDesktopApplication).to.equal(expectedValue);
|
||||
});
|
||||
});
|
||||
describe('os', () => {
|
||||
@@ -112,47 +112,6 @@ describe('BrowserRuntimeEnvironment', () => {
|
||||
// assert
|
||||
expect(actual).to.equal(expected);
|
||||
});
|
||||
describe('desktop os', () => {
|
||||
describe('returns from window property `os`', () => {
|
||||
const testValues = [
|
||||
OperatingSystem.macOS,
|
||||
OperatingSystem.Windows,
|
||||
OperatingSystem.Linux,
|
||||
];
|
||||
testValues.forEach((testValue) => {
|
||||
it(`given ${OperatingSystem[testValue]}`, () => {
|
||||
// arrange
|
||||
const expectedOs = testValue;
|
||||
const desktopWindowWithOs = {
|
||||
isDesktop: true,
|
||||
os: expectedOs,
|
||||
};
|
||||
// act
|
||||
const sut = new BrowserRuntimeEnvironmentBuilder()
|
||||
.withWindow(desktopWindowWithOs)
|
||||
.build();
|
||||
// assert
|
||||
const actualOs = sut.os;
|
||||
expect(actualOs).to.equal(expectedOs);
|
||||
});
|
||||
});
|
||||
});
|
||||
describe('returns undefined when window property `os` is absent', () => {
|
||||
itEachAbsentObjectValue((absentValue) => {
|
||||
// arrange
|
||||
const expectedValue = undefined;
|
||||
const windowWithAbsentOs = {
|
||||
os: absentValue as never,
|
||||
};
|
||||
// act
|
||||
const sut = new BrowserRuntimeEnvironmentBuilder()
|
||||
.withWindow(windowWithAbsentOs)
|
||||
.build();
|
||||
// assert
|
||||
expect(sut.os).to.equal(expectedValue);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
describe('isNonProduction', () => {
|
||||
[true, false].forEach((value) => {
|
||||
|
||||
@@ -62,14 +62,14 @@ describe('NodeRuntimeEnvironment', () => {
|
||||
expect(environment.os).to.equal(expectedOs);
|
||||
});
|
||||
});
|
||||
describe('isDesktop', () => {
|
||||
describe('isRunningAsDesktopApplication', () => {
|
||||
it('is always true', () => {
|
||||
// arrange
|
||||
const expectedDesktopCondition = true;
|
||||
// act
|
||||
const environment = new NodeRuntimeEnvironment();
|
||||
/// assert
|
||||
expect(environment.isDesktop).to.equal(expectedDesktopCondition);
|
||||
expect(environment.isRunningAsDesktopApplication).to.equal(expectedDesktopCondition);
|
||||
});
|
||||
});
|
||||
describe('isNonProduction', () => {
|
||||
|
||||
@@ -1,73 +1,95 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import {
|
||||
BrowserRuntimeEnvironmentFactory, NodeRuntimeEnvironmentFactory,
|
||||
GlobalAccessor as GlobalPropertiesAccessor, determineAndCreateRuntimeEnvironment,
|
||||
BrowserRuntimeEnvironmentFactory, GlobalPropertiesAccessor, NodeRuntimeEnvironmentFactory,
|
||||
determineAndCreateRuntimeEnvironment,
|
||||
} from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
||||
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
|
||||
|
||||
describe('RuntimeEnvironmentFactory', () => {
|
||||
describe('determineAndCreateRuntimeEnvironment', () => {
|
||||
it('uses browser environment when window exists', () => {
|
||||
// arrange
|
||||
const expectedEnvironment = new RuntimeEnvironmentStub();
|
||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||
.withWindowAccessor(() => createWindowStub())
|
||||
.withBrowserEnvironmentFactory(() => expectedEnvironment);
|
||||
// act
|
||||
const actualEnvironment = context.buildEnvironment();
|
||||
// assert
|
||||
expect(actualEnvironment).to.equal(expectedEnvironment);
|
||||
describe('Node environment creation', () => {
|
||||
it('selects Node environment if Electron main process detected', () => {
|
||||
// arrange
|
||||
const processStub = createProcessStub({
|
||||
versions: {
|
||||
electron: '28.1.3',
|
||||
} as NodeJS.ProcessVersions,
|
||||
});
|
||||
const expectedEnvironment = new RuntimeEnvironmentStub();
|
||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||
.withGlobalProcess(processStub)
|
||||
.withNodeEnvironmentFactory(() => expectedEnvironment);
|
||||
// act
|
||||
const actualEnvironment = context.buildEnvironment();
|
||||
// assert
|
||||
expect(actualEnvironment).to.equal(expectedEnvironment);
|
||||
});
|
||||
it('passes correct process to Node environment factory', () => {
|
||||
// arrange
|
||||
const expectedProcess = createProcessStub({
|
||||
versions: {
|
||||
electron: '28.1.3',
|
||||
} as NodeJS.ProcessVersions,
|
||||
});
|
||||
let actualProcess: GlobalProcess;
|
||||
const nodeEnvironmentFactoryMock: NodeRuntimeEnvironmentFactory = (providedProcess) => {
|
||||
actualProcess = providedProcess;
|
||||
return new RuntimeEnvironmentStub();
|
||||
};
|
||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||
.withGlobalProcess(expectedProcess)
|
||||
.withNodeEnvironmentFactory(nodeEnvironmentFactoryMock);
|
||||
// act
|
||||
context.buildEnvironment();
|
||||
// assert
|
||||
expect(actualProcess).to.equal(expectedProcess);
|
||||
});
|
||||
});
|
||||
|
||||
it('passes correct window to browser environment', () => {
|
||||
// arrange
|
||||
const expectedWindow = createWindowStub();
|
||||
let actualWindow: Window | undefined;
|
||||
const browserEnvironmentFactoryMock: BrowserRuntimeEnvironmentFactory = (providedWindow) => {
|
||||
actualWindow = providedWindow;
|
||||
return new RuntimeEnvironmentStub();
|
||||
};
|
||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||
.withWindowAccessor(() => expectedWindow)
|
||||
.withBrowserEnvironmentFactory(browserEnvironmentFactoryMock);
|
||||
// act
|
||||
context.buildEnvironment();
|
||||
// assert
|
||||
expect(actualWindow).to.equal(expectedWindow);
|
||||
describe('browser environment creation', () => {
|
||||
it('selects browser environment if Electron main process not detected', () => {
|
||||
// arrange
|
||||
const expectedEnvironment = new RuntimeEnvironmentStub();
|
||||
const undefinedProcess: GlobalProcess = undefined;
|
||||
const windowStub = createWindowStub();
|
||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||
.withGlobalProcess(undefinedProcess)
|
||||
.withGlobalWindow(windowStub)
|
||||
.withBrowserEnvironmentFactory(() => expectedEnvironment);
|
||||
// act
|
||||
const actualEnvironment = context.buildEnvironment();
|
||||
// assert
|
||||
expect(actualEnvironment).to.equal(expectedEnvironment);
|
||||
});
|
||||
it('passes correct window to browser environment factory', () => {
|
||||
// arrange
|
||||
const expectedWindow = createWindowStub({
|
||||
isRunningAsDesktopApplication: undefined,
|
||||
});
|
||||
let actualWindow: GlobalWindow;
|
||||
const browserEnvironmentFactoryMock
|
||||
: BrowserRuntimeEnvironmentFactory = (providedWindow) => {
|
||||
actualWindow = providedWindow;
|
||||
return new RuntimeEnvironmentStub();
|
||||
};
|
||||
const undefinedProcess: GlobalProcess = undefined;
|
||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||
.withGlobalWindow(expectedWindow)
|
||||
.withGlobalProcess(undefinedProcess)
|
||||
.withBrowserEnvironmentFactory(browserEnvironmentFactoryMock);
|
||||
// act
|
||||
context.buildEnvironment();
|
||||
// assert
|
||||
expect(actualWindow).to.equal(expectedWindow);
|
||||
});
|
||||
});
|
||||
|
||||
it('uses node environment when window is absent', () => {
|
||||
it('throws error when both window and process are undefined', () => {
|
||||
// arrange
|
||||
const expectedEnvironment = new RuntimeEnvironmentStub();
|
||||
const undefinedWindow: GlobalWindow = undefined;
|
||||
const undefinedProcess: GlobalProcess = undefined;
|
||||
const expectedError = 'Unsupported runtime environment: The current context is neither a recognized browser nor a desktop environment.';
|
||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||
.withWindowAccessor(() => undefined)
|
||||
.withProcessAccessor(() => createProcessStub())
|
||||
.withNodeEnvironmentFactory(() => expectedEnvironment);
|
||||
// act
|
||||
const actualEnvironment = context.buildEnvironment();
|
||||
// assert
|
||||
expect(actualEnvironment).to.equal(expectedEnvironment);
|
||||
});
|
||||
|
||||
it('uses node environment when window is present too', () => { // This allows running integration tests
|
||||
// arrange
|
||||
const expectedEnvironment = new RuntimeEnvironmentStub();
|
||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||
.withWindowAccessor(() => createWindowStub())
|
||||
.withProcessAccessor(() => createProcessStub())
|
||||
.withNodeEnvironmentFactory(() => expectedEnvironment);
|
||||
// act
|
||||
const actualEnvironment = context.buildEnvironment();
|
||||
// assert
|
||||
expect(actualEnvironment).to.equal(expectedEnvironment);
|
||||
});
|
||||
|
||||
it('throws if both node and window are missing', () => {
|
||||
// arrange
|
||||
const expectedError = 'Unsupported runtime environment: The current context is neither a recognized browser nor a Node.js environment.';
|
||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||
.withWindowAccessor(() => undefined)
|
||||
.withProcessAccessor(() => undefined);
|
||||
.withGlobalProcess(undefinedProcess)
|
||||
.withGlobalWindow(undefinedWindow);
|
||||
// act
|
||||
const act = () => context.buildEnvironment();
|
||||
// assert
|
||||
@@ -76,22 +98,22 @@ describe('RuntimeEnvironmentFactory', () => {
|
||||
});
|
||||
});
|
||||
|
||||
function createWindowStub(): Window {
|
||||
return {} as Window;
|
||||
function createWindowStub(partialWindowProperties?: Partial<Window>): Window {
|
||||
return {
|
||||
...partialWindowProperties,
|
||||
} as Window;
|
||||
}
|
||||
|
||||
function createProcessStub(): NodeJS.Process {
|
||||
return {} as NodeJS.Process;
|
||||
function createProcessStub(partialProcessProperties?: Partial<NodeJS.Process>): NodeJS.Process {
|
||||
return {
|
||||
...partialProcessProperties,
|
||||
} as NodeJS.Process;
|
||||
}
|
||||
|
||||
type WindowAccessor = GlobalPropertiesAccessor['getGlobalWindow'];
|
||||
|
||||
type ProcessAccessor = GlobalPropertiesAccessor['getGlobalProcess'];
|
||||
|
||||
export class RuntimeEnvironmentFactoryTestSetup {
|
||||
private windowAccessor: WindowAccessor = () => undefined;
|
||||
private globalWindow: GlobalWindow = createWindowStub();
|
||||
|
||||
private processAccessor: ProcessAccessor = () => undefined;
|
||||
private globalProcess: GlobalProcess = createProcessStub();
|
||||
|
||||
private browserEnvironmentFactory
|
||||
: BrowserRuntimeEnvironmentFactory = () => new RuntimeEnvironmentStub();
|
||||
@@ -99,13 +121,13 @@ export class RuntimeEnvironmentFactoryTestSetup {
|
||||
private nodeEnvironmentFactory
|
||||
: NodeRuntimeEnvironmentFactory = () => new RuntimeEnvironmentStub();
|
||||
|
||||
public withWindowAccessor(windowAccessor: WindowAccessor): this {
|
||||
this.windowAccessor = windowAccessor;
|
||||
public withGlobalWindow(globalWindow: GlobalWindow): this {
|
||||
this.globalWindow = globalWindow;
|
||||
return this;
|
||||
}
|
||||
|
||||
public withProcessAccessor(processAccessor: ProcessAccessor): this {
|
||||
this.processAccessor = processAccessor;
|
||||
public withGlobalProcess(globalProcess: GlobalProcess): this {
|
||||
this.globalProcess = globalProcess;
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -126,11 +148,15 @@ export class RuntimeEnvironmentFactoryTestSetup {
|
||||
public buildEnvironment(): ReturnType<typeof determineAndCreateRuntimeEnvironment> {
|
||||
return determineAndCreateRuntimeEnvironment(
|
||||
{
|
||||
getGlobalProcess: this.processAccessor,
|
||||
getGlobalWindow: this.windowAccessor,
|
||||
window: this.globalWindow,
|
||||
process: this.globalProcess,
|
||||
},
|
||||
this.browserEnvironmentFactory,
|
||||
this.nodeEnvironmentFactory,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
type GlobalWindow = GlobalPropertiesAccessor['window'];
|
||||
|
||||
type GlobalProcess = GlobalPropertiesAccessor['process'];
|
||||
|
||||
@@ -5,6 +5,9 @@ import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import { getAbsentObjectTestCases, itEachAbsentObjectValue } from '@tests/unit/shared/TestCases/AbsentTests';
|
||||
import { WindowVariablesStub } from '@tests/unit/shared/Stubs/WindowVariablesStub';
|
||||
import { CodeRunnerStub } from '@tests/unit/shared/Stubs/CodeRunnerStub';
|
||||
import { PropertyKeys } from '@/TypeHelpers';
|
||||
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
||||
import { DialogStub } from '@tests/unit/shared/Stubs/DialogStub';
|
||||
|
||||
describe('WindowVariablesValidator', () => {
|
||||
describe('validateWindowVariables', () => {
|
||||
@@ -24,20 +27,20 @@ describe('WindowVariablesValidator', () => {
|
||||
it('throws an error with a description of all invalid properties', () => {
|
||||
// arrange
|
||||
const invalidOs = 'invalid' as unknown as OperatingSystem;
|
||||
const invalidIsDesktop = 'not a boolean' as unknown as boolean;
|
||||
const invalidIsRunningAsDesktopApplication = 'not a boolean' as never;
|
||||
const expectedError = getExpectedError(
|
||||
{
|
||||
name: 'os',
|
||||
object: invalidOs,
|
||||
},
|
||||
{
|
||||
name: 'isDesktop',
|
||||
object: invalidIsDesktop,
|
||||
name: 'isRunningAsDesktopApplication',
|
||||
object: invalidIsRunningAsDesktopApplication,
|
||||
},
|
||||
);
|
||||
const input = new WindowVariablesStub()
|
||||
.withOs(invalidOs)
|
||||
.withIsDesktop(invalidIsDesktop);
|
||||
.withIsRunningAsDesktopApplication(invalidIsRunningAsDesktopApplication);
|
||||
// act
|
||||
const act = () => validateWindowVariables(input);
|
||||
// assert
|
||||
@@ -82,7 +85,7 @@ describe('WindowVariablesValidator', () => {
|
||||
it('does not throw for a missing os value', () => {
|
||||
// arrange
|
||||
const input = new WindowVariablesStub()
|
||||
.withIsDesktop(true)
|
||||
.withIsRunningAsDesktopApplication(true)
|
||||
.withOs(undefined);
|
||||
// act
|
||||
const act = () => validateWindowVariables(input);
|
||||
@@ -91,15 +94,24 @@ describe('WindowVariablesValidator', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('`isDesktop` property', () => {
|
||||
describe('`isRunningAsDesktopApplication` property', () => {
|
||||
it('does not throw when true with valid services', () => {
|
||||
// arrange
|
||||
const validCodeRunner = new CodeRunnerStub();
|
||||
const input = new WindowVariablesStub()
|
||||
.withIsDesktop(true)
|
||||
.withCodeRunner(validCodeRunner);
|
||||
const windowVariables = new WindowVariablesStub();
|
||||
const windowVariableConfigurators: Record< // Ensure types match for compile-time checking
|
||||
PropertyKeys<Required<WindowVariables>>,
|
||||
(stub: WindowVariablesStub) => WindowVariablesStub> = {
|
||||
isRunningAsDesktopApplication: (s) => s.withIsRunningAsDesktopApplication(true),
|
||||
codeRunner: (s) => s.withCodeRunner(new CodeRunnerStub()),
|
||||
os: (s) => s.withOs(OperatingSystem.Windows),
|
||||
log: (s) => s.withLog(new LoggerStub()),
|
||||
dialog: (s) => s.withDialog(new DialogStub()),
|
||||
};
|
||||
Object
|
||||
.values(windowVariableConfigurators)
|
||||
.forEach((configure) => configure(windowVariables));
|
||||
// act
|
||||
const act = () => validateWindowVariables(input);
|
||||
const act = () => validateWindowVariables(windowVariables);
|
||||
// assert
|
||||
expect(act).to.not.throw();
|
||||
});
|
||||
@@ -109,7 +121,7 @@ describe('WindowVariablesValidator', () => {
|
||||
// arrange
|
||||
const absentCodeRunner = absentValue;
|
||||
const input = new WindowVariablesStub()
|
||||
.withIsDesktop(false)
|
||||
.withIsRunningAsDesktopApplication(undefined)
|
||||
.withCodeRunner(absentCodeRunner);
|
||||
// act
|
||||
const act = () => validateWindowVariables(input);
|
||||
@@ -150,7 +162,7 @@ function expectObjectOnDesktop<T>(key: keyof WindowVariables) {
|
||||
});
|
||||
const input: WindowVariables = {
|
||||
...new WindowVariablesStub(),
|
||||
isDesktop: isOnDesktop,
|
||||
isRunningAsDesktopApplication: isOnDesktop,
|
||||
[key]: invalidObject,
|
||||
};
|
||||
// act
|
||||
@@ -159,14 +171,13 @@ function expectObjectOnDesktop<T>(key: keyof WindowVariables) {
|
||||
expect(act).to.throw(expectedError);
|
||||
});
|
||||
});
|
||||
describe('does not object type when not on desktop', () => {
|
||||
describe('does not validate object type when not on desktop', () => {
|
||||
itEachInvalidObjectValue((invalidObjectValue) => {
|
||||
// arrange
|
||||
const isOnDesktop = false;
|
||||
const invalidObject = invalidObjectValue as T;
|
||||
const input: WindowVariables = {
|
||||
...new WindowVariablesStub(),
|
||||
isDesktop: isOnDesktop,
|
||||
isRunningAsDesktopApplication: undefined,
|
||||
[key]: invalidObject,
|
||||
};
|
||||
// act
|
||||
|
||||
Reference in New Issue
Block a user