c546a33eff
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).
66 lines
2.6 KiB
TypeScript
66 lines
2.6 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
|
import { IpcChannel } from '@/presentation/electron/shared/IpcBridging/IpcChannel';
|
|
import { ChannelDefinitionKey, IpcChannelDefinitions } from '@/presentation/electron/shared/IpcBridging/IpcChannelDefinitions';
|
|
|
|
describe('IpcChannelDefinitions', () => {
|
|
it('defines IPC channels correctly', () => {
|
|
const testScenarios: Record<ChannelDefinitionKey, {
|
|
readonly expectedNamespace: string;
|
|
readonly expectedAccessibleMembers: readonly string[];
|
|
}> = {
|
|
CodeRunner: {
|
|
expectedNamespace: 'code-run',
|
|
expectedAccessibleMembers: ['runCode'],
|
|
},
|
|
Dialog: {
|
|
expectedNamespace: 'dialogs',
|
|
expectedAccessibleMembers: ['saveFile'],
|
|
},
|
|
};
|
|
Object.entries(testScenarios).forEach((
|
|
[definitionKey, { expectedNamespace, expectedAccessibleMembers }],
|
|
) => {
|
|
describe(`channel: "${definitionKey}"`, () => {
|
|
const ipcChannelUnderTest = IpcChannelDefinitions[definitionKey] as IpcChannel<unknown>;
|
|
it('has expected namespace', () => {
|
|
// act
|
|
const actualNamespace = ipcChannelUnderTest.namespace;
|
|
// assert
|
|
expect(actualNamespace).to.equal(expectedNamespace);
|
|
});
|
|
it('has expected accessible members', () => {
|
|
// act
|
|
const actualAccessibleMembers = ipcChannelUnderTest.accessibleMembers;
|
|
// assert
|
|
expect(actualAccessibleMembers).to.have.lengthOf(expectedAccessibleMembers.length);
|
|
expect(actualAccessibleMembers).to.have.members(expectedAccessibleMembers);
|
|
});
|
|
});
|
|
});
|
|
});
|
|
describe('IPC channel uniqueness', () => {
|
|
it('has unique namespaces', () => {
|
|
// arrange
|
|
const extractedNamespacesFromDefinitions = Object
|
|
.values(IpcChannelDefinitions)
|
|
.map((channel) => channel.namespace);
|
|
// act
|
|
const duplicateNamespaceEntries = extractedNamespacesFromDefinitions
|
|
.filter((item, index) => extractedNamespacesFromDefinitions.indexOf(item) !== index);
|
|
// assert
|
|
expect(duplicateNamespaceEntries).to.have.lengthOf(0);
|
|
});
|
|
it('has unique accessible members within each channel', () => {
|
|
Object.values(IpcChannelDefinitions).forEach((channel) => {
|
|
// arrange
|
|
const accessibleMembersOfChannel = channel.accessibleMembers as string[];
|
|
// act
|
|
const repeatedAccessibleMembersInChannel = accessibleMembersOfChannel
|
|
.filter((item, index) => accessibleMembersOfChannel.indexOf(item) !== index);
|
|
// assert
|
|
expect(repeatedAccessibleMembersInChannel).to.have.lengthOf(0);
|
|
});
|
|
});
|
|
});
|
|
});
|