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:
@@ -137,6 +137,7 @@ For a detailed comparison of features between the desktop and web versions of pr
|
|||||||
- **Transparent**. Have full visibility into what the tweaks do as you enable them.
|
- **Transparent**. Have full visibility into what the tweaks do as you enable them.
|
||||||
- **Reversible**. Revert if something feels wrong.
|
- **Reversible**. Revert if something feels wrong.
|
||||||
- **Accessible**. No need to run any compiled software on your computer with web version.
|
- **Accessible**. No need to run any compiled software on your computer with web version.
|
||||||
|
- **Secure**: Security is a top priority at privacy.sexy with comprehensive safeguards in place. [Learn more](./SECURITY.md).
|
||||||
- **Open**. What you see as code in this repository is what you get. The application itself, its infrastructure and deployments are open-source and automated thanks to [bump-everywhere](https://github.com/undergroundwires/bump-everywhere).
|
- **Open**. What you see as code in this repository is what you get. The application itself, its infrastructure and deployments are open-source and automated thanks to [bump-everywhere](https://github.com/undergroundwires/bump-everywhere).
|
||||||
- **Tested**. A lot of tests. Automated and manual. Community-testing and verification. Stability improvements comes before new features.
|
- **Tested**. A lot of tests. Automated and manual. Community-testing and verification. Stability improvements comes before new features.
|
||||||
- **Extensible**. Effortlessly [extend scripts](./CONTRIBUTING.md#extend-scripts) with a custom designed [templating language](./docs/templating.md).
|
- **Extensible**. Effortlessly [extend scripts](./CONTRIBUTING.md#extend-scripts) with a custom designed [templating language](./docs/templating.md).
|
||||||
|
|||||||
@@ -53,9 +53,16 @@ Log file locations vary by operating system:
|
|||||||
The desktop version of privacy.sexy enables direct script execution, providing a seamless and integrated experience.
|
The desktop version of privacy.sexy enables direct script execution, providing a seamless and integrated experience.
|
||||||
This direct execution capability isn't available in the web version due to inherent browser restrictions.
|
This direct execution capability isn't available in the web version due to inherent browser restrictions.
|
||||||
|
|
||||||
|
**Logging and storage:**
|
||||||
|
|
||||||
For enhanced auditability and easier troubleshooting, the desktop version keeps a record of executed scripts in designated directories.
|
For enhanced auditability and easier troubleshooting, the desktop version keeps a record of executed scripts in designated directories.
|
||||||
These locations vary based on the operating system:
|
These locations vary based on the operating system:
|
||||||
|
|
||||||
- macOS: `$HOME/Library/Application Support/privacy.sexy/runs`
|
- macOS: `$HOME/Library/Application Support/privacy.sexy/runs`
|
||||||
- Linux: `$HOME/.config/privacy.sexy/runs`
|
- Linux: `$HOME/.config/privacy.sexy/runs`
|
||||||
- Windows: `%APPDATA%\privacy.sexy\runs`
|
- Windows: `%APPDATA%\privacy.sexy\runs`
|
||||||
|
|
||||||
|
**Native file system dialogs:**
|
||||||
|
|
||||||
|
The desktop version uses native system file save dialogs, offering more features and reliability compared to the browser's file system dialogs.
|
||||||
|
These native dialogs provide a more integrated and user-friendly experience, aligning with the operating system's standard interface and functionalities.
|
||||||
|
|||||||
19
src/infrastructure/Dialog/Browser/BrowserDialog.ts
Normal file
19
src/infrastructure/Dialog/Browser/BrowserDialog.ts
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
import { Dialog, FileType } from '@/presentation/common/Dialog';
|
||||||
|
import { FileSaverDialog } from './FileSaverDialog';
|
||||||
|
import { BrowserSaveFileDialog } from './BrowserSaveFileDialog';
|
||||||
|
|
||||||
|
export class BrowserDialog implements Dialog {
|
||||||
|
constructor(private readonly saveFileDialog: BrowserSaveFileDialog = new FileSaverDialog()) {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
public saveFile(
|
||||||
|
fileContents: string,
|
||||||
|
fileName: string,
|
||||||
|
type: FileType,
|
||||||
|
): Promise<void> {
|
||||||
|
return Promise.resolve(
|
||||||
|
this.saveFileDialog.saveFile(fileContents, fileName, type),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { FileType } from '@/presentation/common/Dialog';
|
||||||
|
|
||||||
|
export interface BrowserSaveFileDialog {
|
||||||
|
saveFile(
|
||||||
|
fileContents: string,
|
||||||
|
fileName: string,
|
||||||
|
fileType: FileType,
|
||||||
|
): void;
|
||||||
|
}
|
||||||
39
src/infrastructure/Dialog/Browser/FileSaverDialog.ts
Normal file
39
src/infrastructure/Dialog/Browser/FileSaverDialog.ts
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
import fileSaver from 'file-saver';
|
||||||
|
import { FileType } from '@/presentation/common/Dialog';
|
||||||
|
import { BrowserSaveFileDialog } from './BrowserSaveFileDialog';
|
||||||
|
|
||||||
|
export type SaveAsFunction = (data: Blob, filename?: string) => void;
|
||||||
|
|
||||||
|
export type WindowOpenFunction = (url: string, target: string, features: string) => void;
|
||||||
|
|
||||||
|
export class FileSaverDialog implements BrowserSaveFileDialog {
|
||||||
|
constructor(
|
||||||
|
private readonly fileSaverSaveAs: SaveAsFunction = fileSaver.saveAs,
|
||||||
|
private readonly windowOpen: WindowOpenFunction = window.open.bind(window),
|
||||||
|
) { }
|
||||||
|
|
||||||
|
public saveFile(
|
||||||
|
fileContents: string,
|
||||||
|
fileName: string,
|
||||||
|
fileType: FileType,
|
||||||
|
): void {
|
||||||
|
const mimeType = MimeTypes[fileType];
|
||||||
|
this.saveBlob(fileContents, mimeType, fileName);
|
||||||
|
}
|
||||||
|
|
||||||
|
private saveBlob(file: BlobPart, mimeType: string, fileName: string): void {
|
||||||
|
try {
|
||||||
|
const blob = new Blob([file], { type: mimeType });
|
||||||
|
this.fileSaverSaveAs(blob, fileName);
|
||||||
|
} catch (e) {
|
||||||
|
this.windowOpen(`data:${mimeType},${encodeURIComponent(file.toString())}`, '_blank', '');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const MimeTypes: Record<FileType, string> = {
|
||||||
|
// Some browsers (including firefox + IE) require right mime type
|
||||||
|
// otherwise they ignore extension and save the file as text.
|
||||||
|
[FileType.BatchFile]: 'application/bat', // https://en.wikipedia.org/wiki/Batch_file
|
||||||
|
[FileType.ShellScript]: 'text/x-shellscript', // https://de.wikipedia.org/wiki/Shellskript#MIME-Typ
|
||||||
|
} as const;
|
||||||
17
src/infrastructure/Dialog/Electron/ElectronDialog.ts
Normal file
17
src/infrastructure/Dialog/Electron/ElectronDialog.ts
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
import { Dialog, FileType } from '@/presentation/common/Dialog';
|
||||||
|
import { NodeElectronSaveFileDialog } from './NodeElectronSaveFileDialog';
|
||||||
|
import { ElectronSaveFileDialog } from './ElectronSaveFileDialog';
|
||||||
|
|
||||||
|
export class ElectronDialog implements Dialog {
|
||||||
|
constructor(
|
||||||
|
private readonly fileSaveDialog: ElectronSaveFileDialog = new NodeElectronSaveFileDialog(),
|
||||||
|
) { }
|
||||||
|
|
||||||
|
public async saveFile(
|
||||||
|
fileContents: string,
|
||||||
|
fileName: string,
|
||||||
|
type: FileType,
|
||||||
|
): Promise<void> {
|
||||||
|
await this.fileSaveDialog.saveFile(fileContents, fileName, type);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { FileType } from '@/presentation/common/Dialog';
|
||||||
|
|
||||||
|
export interface ElectronSaveFileDialog {
|
||||||
|
saveFile(
|
||||||
|
fileContents: string,
|
||||||
|
fileName: string,
|
||||||
|
type: FileType,
|
||||||
|
): Promise<void>;
|
||||||
|
}
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
import { join } from 'node:path';
|
||||||
|
import { writeFile } from 'node:fs/promises';
|
||||||
|
import { app, dialog } from 'electron/main';
|
||||||
|
import { Logger } from '@/application/Common/Log/Logger';
|
||||||
|
import { ElectronLogger } from '@/infrastructure/Log/ElectronLogger';
|
||||||
|
import { FileType } from '@/presentation/common/Dialog';
|
||||||
|
import { ElectronSaveFileDialog } from './ElectronSaveFileDialog';
|
||||||
|
|
||||||
|
export interface ElectronFileDialogOperations {
|
||||||
|
getUserDownloadsPath(): string;
|
||||||
|
showSaveDialog(options: Electron.SaveDialogOptions): Promise<Electron.SaveDialogReturnValue>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface NodeFileOperations {
|
||||||
|
readonly join: typeof join;
|
||||||
|
writeFile(file: string, data: string): Promise<void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class NodeElectronSaveFileDialog implements ElectronSaveFileDialog {
|
||||||
|
constructor(
|
||||||
|
private readonly logger: Logger = ElectronLogger,
|
||||||
|
private readonly electron: ElectronFileDialogOperations = {
|
||||||
|
getUserDownloadsPath: () => app.getPath('downloads'),
|
||||||
|
showSaveDialog: dialog.showSaveDialog.bind(dialog),
|
||||||
|
},
|
||||||
|
private readonly node: NodeFileOperations = {
|
||||||
|
join,
|
||||||
|
writeFile,
|
||||||
|
},
|
||||||
|
) { }
|
||||||
|
|
||||||
|
public async saveFile(
|
||||||
|
fileContents: string,
|
||||||
|
fileName: string,
|
||||||
|
type: FileType,
|
||||||
|
): Promise<void> {
|
||||||
|
const userSelectedFilePath = await this.showSaveFileDialog(fileName, type);
|
||||||
|
if (!userSelectedFilePath) {
|
||||||
|
this.logger.info(`File save cancelled by user: ${fileName}`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await this.writeFile(userSelectedFilePath, fileContents);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async writeFile(filePath: string, fileContents: string): Promise<void> {
|
||||||
|
try {
|
||||||
|
this.logger.info(`Saving file: ${filePath}`);
|
||||||
|
await this.node.writeFile(filePath, fileContents);
|
||||||
|
this.logger.info(`File saved: ${filePath}`);
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error(`Error saving file: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private async showSaveFileDialog(fileName: string, type: FileType): Promise<string | undefined> {
|
||||||
|
const downloadsFolder = this.electron.getUserDownloadsPath();
|
||||||
|
const defaultFilePath = this.node.join(downloadsFolder, fileName);
|
||||||
|
const dialogResult = await this.electron.showSaveDialog({
|
||||||
|
title: fileName,
|
||||||
|
defaultPath: defaultFilePath,
|
||||||
|
filters: getDialogFileFilters(type),
|
||||||
|
properties: [
|
||||||
|
'createDirectory', // Enables directory creation on macOS.
|
||||||
|
'showOverwriteConfirmation', // Shows overwrite confirmation on Linux.
|
||||||
|
],
|
||||||
|
});
|
||||||
|
if (dialogResult.canceled) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
return dialogResult.filePath;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function getDialogFileFilters(fileType: FileType): Electron.FileFilter[] {
|
||||||
|
const filters = FileTypeSpecificFilters[fileType];
|
||||||
|
return [
|
||||||
|
...filters,
|
||||||
|
{
|
||||||
|
name: 'All Files',
|
||||||
|
extensions: ['*'],
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
const FileTypeSpecificFilters: Record<FileType, Electron.FileFilter[]> = {
|
||||||
|
[FileType.BatchFile]: [
|
||||||
|
{
|
||||||
|
name: 'Batch Files',
|
||||||
|
extensions: ['bat', 'cmd'],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
[FileType.ShellScript]: [
|
||||||
|
{
|
||||||
|
name: 'Shell Scripts',
|
||||||
|
extensions: ['sh', 'bash', 'zsh'],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
@@ -84,4 +84,23 @@ export const BrowserConditions: readonly BrowserCondition[] = [
|
|||||||
notExistingPartsInUserAgent: ['like Mac OS X'], // Eliminate iOS and iPadOS for Safari
|
notExistingPartsInUserAgent: ['like Mac OS X'], // Eliminate iOS and iPadOS for Safari
|
||||||
touchSupport: TouchSupportExpectation.MustNotExist, // Distinguish from iPadOS for Safari
|
touchSupport: TouchSupportExpectation.MustNotExist, // Distinguish from iPadOS for Safari
|
||||||
},
|
},
|
||||||
|
...generateJsdomBrowserConditions(),
|
||||||
] as const;
|
] as const;
|
||||||
|
|
||||||
|
function generateJsdomBrowserConditions(): readonly BrowserCondition[] {
|
||||||
|
// jsdom user agent format: `Mozilla/5.0 (${process.platform || "unknown OS"}) ...` (https://archive.ph/2023.02.14-193200/https://github.com/jsdom/jsdom#advanced-configuration)
|
||||||
|
const operatingSystemPlatformMap: Partial<Record<
|
||||||
|
OperatingSystem,
|
||||||
|
NodeJS.Platform> // Enforce right platform constants at compile time
|
||||||
|
> = {
|
||||||
|
[OperatingSystem.Linux]: 'linux',
|
||||||
|
[OperatingSystem.Windows]: 'win32',
|
||||||
|
[OperatingSystem.macOS]: 'darwin',
|
||||||
|
} as const;
|
||||||
|
return Object
|
||||||
|
.entries(operatingSystemPlatformMap)
|
||||||
|
.map(([operatingSystemKey, platformString]): BrowserCondition => ({
|
||||||
|
operatingSystem: Number(operatingSystemKey),
|
||||||
|
existingPartsInSameUserAgent: ['jsdom', platformString],
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
import { WindowVariables } from '@/infrastructure/WindowVariables/WindowVariables';
|
|
||||||
import { IEnvironmentVariables } from '@/infrastructure/EnvironmentVariables/IEnvironmentVariables';
|
import { IEnvironmentVariables } from '@/infrastructure/EnvironmentVariables/IEnvironmentVariables';
|
||||||
import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
|
import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
|
||||||
import { RuntimeEnvironment } from '../RuntimeEnvironment';
|
import { RuntimeEnvironment } from '../RuntimeEnvironment';
|
||||||
@@ -8,7 +7,7 @@ import { BrowserEnvironment, BrowserOsDetector } from './BrowserOs/BrowserOsDete
|
|||||||
import { isTouchEnabledDevice } from './TouchSupportDetection';
|
import { isTouchEnabledDevice } from './TouchSupportDetection';
|
||||||
|
|
||||||
export class BrowserRuntimeEnvironment implements RuntimeEnvironment {
|
export class BrowserRuntimeEnvironment implements RuntimeEnvironment {
|
||||||
public readonly isDesktop: boolean;
|
public readonly isRunningAsDesktopApplication: boolean;
|
||||||
|
|
||||||
public readonly os: OperatingSystem | undefined;
|
public readonly os: OperatingSystem | undefined;
|
||||||
|
|
||||||
@@ -18,31 +17,34 @@ export class BrowserRuntimeEnvironment implements RuntimeEnvironment {
|
|||||||
window: Partial<Window>,
|
window: Partial<Window>,
|
||||||
environmentVariables: IEnvironmentVariables = EnvironmentVariablesFactory.Current.instance,
|
environmentVariables: IEnvironmentVariables = EnvironmentVariablesFactory.Current.instance,
|
||||||
browserOsDetector: BrowserOsDetector = new ConditionBasedOsDetector(),
|
browserOsDetector: BrowserOsDetector = new ConditionBasedOsDetector(),
|
||||||
touchDetector = isTouchEnabledDevice,
|
touchDetector: TouchDetector = isTouchEnabledDevice,
|
||||||
) {
|
) {
|
||||||
if (!window) { throw new Error('missing window'); } // do not trust strictNullChecks for global objects
|
if (!window) { throw new Error('missing window'); } // do not trust strictNullChecks for global objects
|
||||||
this.isNonProduction = environmentVariables.isNonProduction;
|
this.isNonProduction = environmentVariables.isNonProduction;
|
||||||
this.isDesktop = isDesktop(window);
|
this.isRunningAsDesktopApplication = isElectronRendererProcess(window);
|
||||||
if (this.isDesktop) {
|
this.os = determineOperatingSystem(window, touchDetector, browserOsDetector);
|
||||||
this.os = window?.os;
|
}
|
||||||
} else {
|
}
|
||||||
this.os = undefined;
|
|
||||||
const userAgent = getUserAgent(window);
|
function isElectronRendererProcess(globalWindow: Partial<Window>): boolean {
|
||||||
if (userAgent) {
|
return globalWindow.isRunningAsDesktopApplication === true; // Preloader injects this
|
||||||
|
// We could also do `globalWindow?.navigator?.userAgent?.includes('Electron') === true;`
|
||||||
|
}
|
||||||
|
|
||||||
|
function determineOperatingSystem(
|
||||||
|
globalWindow: Partial<Window>,
|
||||||
|
touchDetector: TouchDetector,
|
||||||
|
browserOsDetector: BrowserOsDetector,
|
||||||
|
): OperatingSystem | undefined {
|
||||||
|
const userAgent = globalWindow?.navigator?.userAgent;
|
||||||
|
if (!userAgent) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
const browserEnvironment: BrowserEnvironment = {
|
const browserEnvironment: BrowserEnvironment = {
|
||||||
userAgent,
|
userAgent,
|
||||||
isTouchSupported: touchDetector(),
|
isTouchSupported: touchDetector(),
|
||||||
};
|
};
|
||||||
this.os = browserOsDetector.detect(browserEnvironment);
|
return browserOsDetector.detect(browserEnvironment);
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function getUserAgent(window: Partial<Window>): string | undefined {
|
type TouchDetector = () => boolean;
|
||||||
return window?.navigator?.userAgent;
|
|
||||||
}
|
|
||||||
|
|
||||||
function isDesktop(window: Partial<WindowVariables>): boolean {
|
|
||||||
return window?.isDesktop === true;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import { RuntimeEnvironment } from '../RuntimeEnvironment';
|
|||||||
import { convertPlatformToOs } from './NodeOsMapper';
|
import { convertPlatformToOs } from './NodeOsMapper';
|
||||||
|
|
||||||
export class NodeRuntimeEnvironment implements RuntimeEnvironment {
|
export class NodeRuntimeEnvironment implements RuntimeEnvironment {
|
||||||
public readonly isDesktop: boolean;
|
public readonly isRunningAsDesktopApplication: boolean;
|
||||||
|
|
||||||
public readonly os: OperatingSystem | undefined;
|
public readonly os: OperatingSystem | undefined;
|
||||||
|
|
||||||
@@ -14,7 +14,7 @@ export class NodeRuntimeEnvironment implements RuntimeEnvironment {
|
|||||||
convertToOs: PlatformToOperatingSystemConverter = convertPlatformToOs,
|
convertToOs: PlatformToOperatingSystemConverter = convertPlatformToOs,
|
||||||
) {
|
) {
|
||||||
if (!nodeProcess) { throw new Error('missing process'); } // do not trust strictNullChecks for global objects
|
if (!nodeProcess) { throw new Error('missing process'); } // do not trust strictNullChecks for global objects
|
||||||
this.isDesktop = true;
|
this.isRunningAsDesktopApplication = true;
|
||||||
this.os = convertToOs(nodeProcess.platform);
|
this.os = convertToOs(nodeProcess.platform);
|
||||||
this.isNonProduction = nodeProcess.env.NODE_ENV !== 'production'; // populated by Vite
|
this.isNonProduction = nodeProcess.env.NODE_ENV !== 'production'; // populated by Vite
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
|
||||||
export interface RuntimeEnvironment {
|
export interface RuntimeEnvironment {
|
||||||
readonly isDesktop: boolean;
|
readonly isRunningAsDesktopApplication: boolean;
|
||||||
readonly os: OperatingSystem | undefined;
|
readonly os: OperatingSystem | undefined;
|
||||||
readonly isNonProduction: boolean;
|
readonly isNonProduction: boolean;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,32 +3,47 @@ import { NodeRuntimeEnvironment } from './Node/NodeRuntimeEnvironment';
|
|||||||
import { RuntimeEnvironment } from './RuntimeEnvironment';
|
import { RuntimeEnvironment } from './RuntimeEnvironment';
|
||||||
|
|
||||||
export const CurrentEnvironment = determineAndCreateRuntimeEnvironment({
|
export const CurrentEnvironment = determineAndCreateRuntimeEnvironment({
|
||||||
getGlobalWindow: () => globalThis.window,
|
window: globalThis.window,
|
||||||
getGlobalProcess: () => globalThis.process,
|
process: globalThis.process,
|
||||||
});
|
});
|
||||||
|
|
||||||
export function determineAndCreateRuntimeEnvironment(
|
export function determineAndCreateRuntimeEnvironment(
|
||||||
globalAccessor: GlobalAccessor,
|
globalAccessor: GlobalPropertiesAccessor,
|
||||||
browserEnvironmentFactory: BrowserRuntimeEnvironmentFactory = (
|
browserEnvironmentFactory: BrowserRuntimeEnvironmentFactory = (
|
||||||
window,
|
window,
|
||||||
) => new BrowserRuntimeEnvironment(window),
|
) => new BrowserRuntimeEnvironment(window),
|
||||||
nodeEnvironmentFactory: NodeRuntimeEnvironmentFactory = () => new NodeRuntimeEnvironment(),
|
nodeEnvironmentFactory: NodeRuntimeEnvironmentFactory = (
|
||||||
|
process: NodeJS.Process,
|
||||||
|
) => new NodeRuntimeEnvironment(process),
|
||||||
): RuntimeEnvironment {
|
): RuntimeEnvironment {
|
||||||
if (globalAccessor.getGlobalProcess()) {
|
if (isElectronMainProcess(globalAccessor.process)) {
|
||||||
return nodeEnvironmentFactory();
|
return nodeEnvironmentFactory(globalAccessor.process);
|
||||||
|
}
|
||||||
|
const { window } = globalAccessor;
|
||||||
|
if (!window) {
|
||||||
|
throw new Error('Unsupported runtime environment: The current context is neither a recognized browser nor a desktop environment.');
|
||||||
}
|
}
|
||||||
const window = globalAccessor.getGlobalWindow();
|
|
||||||
if (window) {
|
|
||||||
return browserEnvironmentFactory(window);
|
return browserEnvironmentFactory(window);
|
||||||
}
|
}
|
||||||
throw new Error('Unsupported runtime environment: The current context is neither a recognized browser nor a Node.js environment.');
|
|
||||||
|
function isElectronMainProcess(
|
||||||
|
nodeProcess: NodeJS.Process | undefined,
|
||||||
|
): nodeProcess is NodeJS.Process {
|
||||||
|
// Electron populates `nodeProcess.versions.electron` with its version, see https://web.archive.org/web/20240113162837/https://www.electronjs.org/docs/latest/api/process#processversionselectron-readonly.
|
||||||
|
if (!nodeProcess) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (nodeProcess.versions.electron) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type BrowserRuntimeEnvironmentFactory = (window: Window) => RuntimeEnvironment;
|
export type BrowserRuntimeEnvironmentFactory = (window: Window) => RuntimeEnvironment;
|
||||||
|
|
||||||
export type NodeRuntimeEnvironmentFactory = () => NodeRuntimeEnvironment;
|
export type NodeRuntimeEnvironmentFactory = (process: NodeJS.Process) => NodeRuntimeEnvironment;
|
||||||
|
|
||||||
export interface GlobalAccessor {
|
export interface GlobalPropertiesAccessor {
|
||||||
getGlobalWindow(): Window | undefined;
|
readonly window: Window | undefined;
|
||||||
getGlobalProcess(): NodeJS.Process | undefined;
|
readonly process: NodeJS.Process | undefined;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,33 +0,0 @@
|
|||||||
import fileSaver from 'file-saver';
|
|
||||||
|
|
||||||
export enum FileType {
|
|
||||||
BatchFile,
|
|
||||||
ShellScript,
|
|
||||||
}
|
|
||||||
|
|
||||||
export class SaveFileDialog {
|
|
||||||
public static saveFile(
|
|
||||||
text: string,
|
|
||||||
fileName: string,
|
|
||||||
type: FileType,
|
|
||||||
): void {
|
|
||||||
const mimeType = this.mimeTypes[type];
|
|
||||||
this.saveBlob(text, mimeType, fileName);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static readonly mimeTypes: Record<FileType, string> = {
|
|
||||||
// Some browsers (including firefox + IE) require right mime type
|
|
||||||
// otherwise they ignore extension and save the file as text.
|
|
||||||
[FileType.BatchFile]: 'application/bat', // https://en.wikipedia.org/wiki/Batch_file
|
|
||||||
[FileType.ShellScript]: 'text/x-shellscript', // https://de.wikipedia.org/wiki/Shellskript#MIME-Typ
|
|
||||||
};
|
|
||||||
|
|
||||||
private static saveBlob(file: BlobPart, fileType: string, fileName: string): void {
|
|
||||||
try {
|
|
||||||
const blob = new Blob([file], { type: fileType });
|
|
||||||
fileSaver.saveAs(blob, fileName);
|
|
||||||
} catch (e) {
|
|
||||||
window.open(`data:${fileType},${encodeURIComponent(file.toString())}`, '_blank', '');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +1,13 @@
|
|||||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
import { Logger } from '@/application/Common/Log/Logger';
|
import { Logger } from '@/application/Common/Log/Logger';
|
||||||
import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
|
import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
|
||||||
|
import { Dialog } from '@/presentation/common/Dialog';
|
||||||
|
|
||||||
/* Primary entry point for platform-specific injections */
|
/* Primary entry point for platform-specific injections */
|
||||||
export interface WindowVariables {
|
export interface WindowVariables {
|
||||||
readonly isDesktop: boolean;
|
readonly isRunningAsDesktopApplication?: true;
|
||||||
readonly codeRunner?: CodeRunner;
|
readonly codeRunner?: CodeRunner;
|
||||||
readonly os?: OperatingSystem;
|
readonly os?: OperatingSystem;
|
||||||
readonly log: Logger;
|
readonly log?: Logger;
|
||||||
|
readonly dialog?: Dialog;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -18,13 +18,14 @@ export function validateWindowVariables(variables: Partial<WindowVariables>) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function* testEveryProperty(variables: Partial<WindowVariables>): Iterable<string> {
|
function* testEveryProperty(variables: Partial<WindowVariables>): Iterable<string> {
|
||||||
const tests: {
|
const tests: Record<PropertyKeys<Required<WindowVariables>>, boolean> = {
|
||||||
[K in PropertyKeys<Required<WindowVariables>>]: boolean;
|
|
||||||
} = {
|
|
||||||
os: testOperatingSystem(variables.os),
|
os: testOperatingSystem(variables.os),
|
||||||
isDesktop: testIsDesktop(variables.isDesktop),
|
isRunningAsDesktopApplication: testIsRunningAsDesktopApplication(
|
||||||
|
variables.isRunningAsDesktopApplication,
|
||||||
|
),
|
||||||
codeRunner: testCodeRunner(variables),
|
codeRunner: testCodeRunner(variables),
|
||||||
log: testLogger(variables),
|
log: testLogger(variables),
|
||||||
|
dialog: testDialog(variables),
|
||||||
};
|
};
|
||||||
|
|
||||||
for (const [propertyName, testResult] of Object.entries(tests)) {
|
for (const [propertyName, testResult] of Object.entries(tests)) {
|
||||||
@@ -48,23 +49,30 @@ function testOperatingSystem(os: unknown): boolean {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function testLogger(variables: Partial<WindowVariables>): boolean {
|
function testLogger(variables: Partial<WindowVariables>): boolean {
|
||||||
if (!variables.isDesktop) {
|
if (!variables.isRunningAsDesktopApplication) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
return isPlainObject(variables.log);
|
return isPlainObject(variables.log);
|
||||||
}
|
}
|
||||||
|
|
||||||
function testCodeRunner(variables: Partial<WindowVariables>): boolean {
|
function testCodeRunner(variables: Partial<WindowVariables>): boolean {
|
||||||
if (!variables.isDesktop) {
|
if (!variables.isRunningAsDesktopApplication) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
return isPlainObject(variables.codeRunner)
|
return isPlainObject(variables.codeRunner)
|
||||||
&& isFunction(variables.codeRunner.runCode);
|
&& isFunction(variables.codeRunner.runCode);
|
||||||
}
|
}
|
||||||
|
|
||||||
function testIsDesktop(isDesktop: unknown): boolean {
|
function testIsRunningAsDesktopApplication(isRunningAsDesktopApplication: unknown): boolean {
|
||||||
if (isDesktop === undefined) {
|
if (isRunningAsDesktopApplication === undefined) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
return isBoolean(isDesktop);
|
return isBoolean(isRunningAsDesktopApplication);
|
||||||
|
}
|
||||||
|
|
||||||
|
function testDialog(variables: Partial<WindowVariables>): boolean {
|
||||||
|
if (!variables.isRunningAsDesktopApplication) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return isPlainObject(variables.dialog);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -11,9 +11,10 @@ import {
|
|||||||
} from '@/presentation/injectionSymbols';
|
} from '@/presentation/injectionSymbols';
|
||||||
import { PropertyKeys } from '@/TypeHelpers';
|
import { PropertyKeys } from '@/TypeHelpers';
|
||||||
import { useUserSelectionState } from '@/presentation/components/Shared/Hooks/UseUserSelectionState';
|
import { useUserSelectionState } from '@/presentation/components/Shared/Hooks/UseUserSelectionState';
|
||||||
import { useLogger } from '@/presentation/components/Shared/Hooks/UseLogger';
|
import { useLogger } from '@/presentation/components/Shared/Hooks/Log/UseLogger';
|
||||||
import { useCodeRunner } from '@/presentation/components/Shared/Hooks/UseCodeRunner';
|
import { useCodeRunner } from '@/presentation/components/Shared/Hooks/UseCodeRunner';
|
||||||
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
||||||
|
import { useDialog } from '@/presentation/components/Shared/Hooks/Dialog/UseDialog';
|
||||||
|
|
||||||
export function provideDependencies(
|
export function provideDependencies(
|
||||||
context: IApplicationContext,
|
context: IApplicationContext,
|
||||||
@@ -67,6 +68,10 @@ export function provideDependencies(
|
|||||||
InjectionKeys.useCodeRunner,
|
InjectionKeys.useCodeRunner,
|
||||||
useCodeRunner,
|
useCodeRunner,
|
||||||
),
|
),
|
||||||
|
useDialog: (di) => di.provide(
|
||||||
|
InjectionKeys.useDialog,
|
||||||
|
useDialog,
|
||||||
|
),
|
||||||
};
|
};
|
||||||
registerAll(Object.values(resolvers), api);
|
registerAll(Object.values(resolvers), api);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { Logger } from '@/application/Common/Log/Logger';
|
import { Logger } from '@/application/Common/Log/Logger';
|
||||||
|
import { ClientLoggerFactory } from '@/presentation/components/Shared/Hooks/Log/ClientLoggerFactory';
|
||||||
import { Bootstrapper } from '../Bootstrapper';
|
import { Bootstrapper } from '../Bootstrapper';
|
||||||
import { ClientLoggerFactory } from '../ClientLoggerFactory';
|
|
||||||
|
|
||||||
export class AppInitializationLogger implements Bootstrapper {
|
export class AppInitializationLogger implements Bootstrapper {
|
||||||
constructor(
|
constructor(
|
||||||
|
|||||||
8
src/presentation/common/Dialog.ts
Normal file
8
src/presentation/common/Dialog.ts
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
export interface Dialog {
|
||||||
|
saveFile(fileContents: string, fileName: string, type: FileType): Promise<void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum FileType {
|
||||||
|
BatchFile,
|
||||||
|
ShellScript,
|
||||||
|
}
|
||||||
@@ -19,10 +19,14 @@ export default defineComponent({
|
|||||||
},
|
},
|
||||||
setup() {
|
setup() {
|
||||||
const { currentState, currentContext } = injectKey((keys) => keys.useCollectionState);
|
const { currentState, currentContext } = injectKey((keys) => keys.useCollectionState);
|
||||||
const { os, isDesktop } = injectKey((keys) => keys.useRuntimeEnvironment);
|
const { os, isRunningAsDesktopApplication } = injectKey((keys) => keys.useRuntimeEnvironment);
|
||||||
const { codeRunner } = injectKey((keys) => keys.useCodeRunner);
|
const { codeRunner } = injectKey((keys) => keys.useCodeRunner);
|
||||||
|
|
||||||
const canRun = computed<boolean>(() => getCanRunState(currentState.value.os, isDesktop, os));
|
const canRun = computed<boolean>(() => getCanRunState(
|
||||||
|
currentState.value.os,
|
||||||
|
isRunningAsDesktopApplication,
|
||||||
|
os,
|
||||||
|
));
|
||||||
|
|
||||||
async function executeCode() {
|
async function executeCode() {
|
||||||
if (!codeRunner) { throw new Error('missing code runner'); }
|
if (!codeRunner) { throw new Error('missing code runner'); }
|
||||||
@@ -33,7 +37,6 @@ export default defineComponent({
|
|||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
isDesktopVersion: isDesktop,
|
|
||||||
canRun,
|
canRun,
|
||||||
executeCode,
|
executeCode,
|
||||||
};
|
};
|
||||||
@@ -42,10 +45,10 @@ export default defineComponent({
|
|||||||
|
|
||||||
function getCanRunState(
|
function getCanRunState(
|
||||||
selectedOs: OperatingSystem,
|
selectedOs: OperatingSystem,
|
||||||
isDesktopVersion: boolean,
|
isRunningAsDesktopApplication: boolean,
|
||||||
hostOs: OperatingSystem | undefined,
|
hostOs: OperatingSystem | undefined,
|
||||||
): boolean {
|
): boolean {
|
||||||
const isRunningOnSelectedOs = selectedOs === hostOs;
|
const isRunningOnSelectedOs = selectedOs === hostOs;
|
||||||
return isDesktopVersion && isRunningOnSelectedOs;
|
return isRunningAsDesktopApplication && isRunningOnSelectedOs;
|
||||||
}
|
}
|
||||||
</script>
|
</script>
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
<template>
|
<template>
|
||||||
<div>
|
<div>
|
||||||
<IconButton
|
<IconButton
|
||||||
:text="isDesktopVersion ? 'Save' : 'Download'"
|
:text="isRunningAsDesktopApplication ? 'Save' : 'Download'"
|
||||||
:icon-name="isDesktopVersion ? 'floppy-disk' : 'file-arrow-down'"
|
:icon-name="isRunningAsDesktopApplication ? 'floppy-disk' : 'file-arrow-down'"
|
||||||
@click="saveCode"
|
@click="saveCode"
|
||||||
/>
|
/>
|
||||||
<ModalDialog v-if="instructions" v-model="areInstructionsVisible">
|
<ModalDialog v-if="instructions" v-model="areInstructionsVisible">
|
||||||
@@ -16,12 +16,11 @@ import {
|
|||||||
defineComponent, ref, computed,
|
defineComponent, ref, computed,
|
||||||
} from 'vue';
|
} from 'vue';
|
||||||
import { injectKey } from '@/presentation/injectionSymbols';
|
import { injectKey } from '@/presentation/injectionSymbols';
|
||||||
import { SaveFileDialog, FileType } from '@/infrastructure/SaveFileDialog';
|
|
||||||
import ModalDialog from '@/presentation/components/Shared/Modal/ModalDialog.vue';
|
import ModalDialog from '@/presentation/components/Shared/Modal/ModalDialog.vue';
|
||||||
import { IReadOnlyCategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState';
|
|
||||||
import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
|
import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
|
||||||
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
||||||
import { ScriptFileName } from '@/application/CodeRunner/ScriptFileName';
|
import { ScriptFileName } from '@/application/CodeRunner/ScriptFileName';
|
||||||
|
import { FileType } from '@/presentation/common/Dialog';
|
||||||
import IconButton from '../IconButton.vue';
|
import IconButton from '../IconButton.vue';
|
||||||
import InstructionList from './Instructions/InstructionList.vue';
|
import InstructionList from './Instructions/InstructionList.vue';
|
||||||
import { IInstructionListData } from './Instructions/InstructionListData';
|
import { IInstructionListData } from './Instructions/InstructionListData';
|
||||||
@@ -35,7 +34,8 @@ export default defineComponent({
|
|||||||
},
|
},
|
||||||
setup() {
|
setup() {
|
||||||
const { currentState } = injectKey((keys) => keys.useCollectionState);
|
const { currentState } = injectKey((keys) => keys.useCollectionState);
|
||||||
const { isDesktop } = injectKey((keys) => keys.useRuntimeEnvironment);
|
const { isRunningAsDesktopApplication } = injectKey((keys) => keys.useRuntimeEnvironment);
|
||||||
|
const { dialog } = injectKey((keys) => keys.useDialog);
|
||||||
|
|
||||||
const areInstructionsVisible = ref(false);
|
const areInstructionsVisible = ref(false);
|
||||||
const fileName = computed<string>(() => buildFileName(currentState.value.collection.scripting));
|
const fileName = computed<string>(() => buildFileName(currentState.value.collection.scripting));
|
||||||
@@ -44,13 +44,17 @@ export default defineComponent({
|
|||||||
fileName.value,
|
fileName.value,
|
||||||
));
|
));
|
||||||
|
|
||||||
function saveCode() {
|
async function saveCode() {
|
||||||
saveCodeToDisk(fileName.value, currentState.value);
|
await dialog.saveFile(
|
||||||
|
currentState.value.code.current,
|
||||||
|
fileName.value,
|
||||||
|
getType(currentState.value.collection.scripting.language),
|
||||||
|
);
|
||||||
areInstructionsVisible.value = true;
|
areInstructionsVisible.value = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
isDesktopVersion: isDesktop,
|
isRunningAsDesktopApplication,
|
||||||
instructions,
|
instructions,
|
||||||
fileName,
|
fileName,
|
||||||
areInstructionsVisible,
|
areInstructionsVisible,
|
||||||
@@ -59,12 +63,6 @@ export default defineComponent({
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
function saveCodeToDisk(fileName: string, state: IReadOnlyCategoryCollectionState) {
|
|
||||||
const content = state.code.current;
|
|
||||||
const type = getType(state.collection.scripting.language);
|
|
||||||
SaveFileDialog.saveFile(content, fileName, type);
|
|
||||||
}
|
|
||||||
|
|
||||||
function getType(language: ScriptingLanguage) {
|
function getType(language: ScriptingLanguage) {
|
||||||
switch (language) {
|
switch (language) {
|
||||||
case ScriptingLanguage.batchfile:
|
case ScriptingLanguage.batchfile:
|
||||||
|
|||||||
@@ -188,6 +188,7 @@ function getDefaultCode(language: ScriptingLanguage): string {
|
|||||||
.appendCommentLine(' ✔️ No need to run any compiled software on your system, just run the generated scripts.')
|
.appendCommentLine(' ✔️ No need to run any compiled software on your system, just run the generated scripts.')
|
||||||
.appendCommentLine(' ✔️ Have full visibility into what the tweaks do as you enable them.')
|
.appendCommentLine(' ✔️ Have full visibility into what the tweaks do as you enable them.')
|
||||||
.appendCommentLine(' ✔️ Open-source and free (both free as in beer and free as in speech).')
|
.appendCommentLine(' ✔️ Open-source and free (both free as in beer and free as in speech).')
|
||||||
|
.appendCommentLine(' ✔️ Committed to your safety with strong security measures.')
|
||||||
.toString();
|
.toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,25 @@
|
|||||||
|
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
||||||
|
import { Dialog } from '@/presentation/common/Dialog';
|
||||||
|
import { BrowserDialog } from '@/infrastructure/Dialog/Browser/BrowserDialog';
|
||||||
|
|
||||||
|
export function determineDialogBasedOnEnvironment(
|
||||||
|
environment: RuntimeEnvironment,
|
||||||
|
windowInjectedDialogFactory: WindowDialogCreationFunction = () => globalThis.window.dialog,
|
||||||
|
browserDialogFactory: BrowserDialogCreationFunction = () => new BrowserDialog(),
|
||||||
|
): Dialog {
|
||||||
|
if (!environment.isRunningAsDesktopApplication) {
|
||||||
|
return browserDialogFactory();
|
||||||
|
}
|
||||||
|
const dialog = windowInjectedDialogFactory();
|
||||||
|
if (!dialog) {
|
||||||
|
throw new Error([
|
||||||
|
'The Dialog API could not be retrieved from the window object.',
|
||||||
|
'This may indicate that the Dialog API is either not implemented or not correctly exposed in the current desktop environment.',
|
||||||
|
].join('\n'));
|
||||||
|
}
|
||||||
|
return dialog;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type WindowDialogCreationFunction = () => Dialog | undefined;
|
||||||
|
|
||||||
|
export type BrowserDialogCreationFunction = () => Dialog;
|
||||||
14
src/presentation/components/Shared/Hooks/Dialog/UseDialog.ts
Normal file
14
src/presentation/components/Shared/Hooks/Dialog/UseDialog.ts
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
import { Dialog } from '@/presentation/common/Dialog';
|
||||||
|
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
||||||
|
import { determineDialogBasedOnEnvironment } from './ClientDialogFactory';
|
||||||
|
|
||||||
|
export function useDialog(
|
||||||
|
factory: DialogFactory = () => determineDialogBasedOnEnvironment(CurrentEnvironment),
|
||||||
|
) {
|
||||||
|
const dialog = factory();
|
||||||
|
return {
|
||||||
|
dialog,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export type DialogFactory = () => Dialog;
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
||||||
import { ConsoleLogger } from '@/infrastructure/Log/ConsoleLogger';
|
import { ConsoleLogger } from '@/infrastructure/Log/ConsoleLogger';
|
||||||
import { Logger } from '@/application/Common/Log/Logger';
|
import { Logger } from '@/application/Common/Log/Logger';
|
||||||
import { LoggerFactory } from '@/application/Common/Log/LoggerFactory';
|
|
||||||
import { NoopLogger } from '@/infrastructure/Log/NoopLogger';
|
import { NoopLogger } from '@/infrastructure/Log/NoopLogger';
|
||||||
import { WindowInjectedLogger } from '@/infrastructure/Log/WindowInjectedLogger';
|
import { WindowInjectedLogger } from '@/infrastructure/Log/WindowInjectedLogger';
|
||||||
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
||||||
|
import { LoggerFactory } from './LoggerFactory';
|
||||||
|
|
||||||
export class ClientLoggerFactory implements LoggerFactory {
|
export class ClientLoggerFactory implements LoggerFactory {
|
||||||
public static readonly Current: LoggerFactory = new ClientLoggerFactory();
|
public static readonly Current: LoggerFactory = new ClientLoggerFactory();
|
||||||
@@ -22,7 +22,7 @@ export class ClientLoggerFactory implements LoggerFactory {
|
|||||||
this.logger = noopLoggerFactory(); // keep the test outputs clean
|
this.logger = noopLoggerFactory(); // keep the test outputs clean
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (environment.isDesktop) {
|
if (environment.isRunningAsDesktopApplication) {
|
||||||
this.logger = windowInjectedLoggerFactory();
|
this.logger = windowInjectedLoggerFactory();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -49,5 +49,5 @@ function isUnitOrIntegrationTests(
|
|||||||
the global window object. If we're in a desktop (Node) environment and the logger isn't
|
the global window object. If we're in a desktop (Node) environment and the logger isn't
|
||||||
injected, it indicates a testing environment.
|
injected, it indicates a testing environment.
|
||||||
*/
|
*/
|
||||||
return environment.isDesktop && !windowAccessor()?.log;
|
return environment.isRunningAsDesktopApplication && !windowAccessor()?.log;
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
import { ClientLoggerFactory } from './ClientLoggerFactory';
|
||||||
|
import { LoggerFactory } from './LoggerFactory';
|
||||||
|
|
||||||
|
export function useLogger(factory: LoggerFactory = ClientLoggerFactory.Current) {
|
||||||
|
return {
|
||||||
|
log: factory.logger,
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
import { LoggerFactory } from '@/application/Common/Log/LoggerFactory';
|
|
||||||
import { ClientLoggerFactory } from '@/presentation/bootstrapping/ClientLoggerFactory';
|
|
||||||
|
|
||||||
export function useLogger(factory: LoggerFactory = ClientLoggerFactory.Current) {
|
|
||||||
return {
|
|
||||||
log: factory.logger,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,12 +1,12 @@
|
|||||||
<template>
|
<template>
|
||||||
<div class="privacy-policy">
|
<div class="privacy-policy">
|
||||||
<div v-if="!isDesktop" class="line">
|
<div v-if="!isRunningAsDesktopApplication" class="line">
|
||||||
<div class="line__emoji">
|
<div class="line__emoji">
|
||||||
🚫🍪
|
🚫🍪
|
||||||
</div>
|
</div>
|
||||||
<div>No cookies!</div>
|
<div>No cookies!</div>
|
||||||
</div>
|
</div>
|
||||||
<div v-if="isDesktop" class="line">
|
<div v-if="isRunningAsDesktopApplication" class="line">
|
||||||
<div class="line__emoji">
|
<div class="line__emoji">
|
||||||
🚫🌐
|
🚫🌐
|
||||||
</div>
|
</div>
|
||||||
@@ -30,7 +30,7 @@
|
|||||||
of the <a :href="repositoryUrl" target="_blank" rel="noopener noreferrer">source code</a> with no changes.
|
of the <a :href="repositoryUrl" target="_blank" rel="noopener noreferrer">source code</a> with no changes.
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div v-if="!isDesktop" class="line">
|
<div v-if="!isRunningAsDesktopApplication" class="line">
|
||||||
<div class="line__emoji">
|
<div class="line__emoji">
|
||||||
📈
|
📈
|
||||||
</div>
|
</div>
|
||||||
@@ -60,7 +60,7 @@ import { injectKey } from '@/presentation/injectionSymbols';
|
|||||||
export default defineComponent({
|
export default defineComponent({
|
||||||
setup() {
|
setup() {
|
||||||
const { info } = injectKey((keys) => keys.useApplication);
|
const { info } = injectKey((keys) => keys.useApplication);
|
||||||
const { isDesktop } = injectKey((keys) => keys.useRuntimeEnvironment);
|
const { isRunningAsDesktopApplication } = injectKey((keys) => keys.useRuntimeEnvironment);
|
||||||
|
|
||||||
const repositoryUrl = computed<string>(() => info.repositoryUrl);
|
const repositoryUrl = computed<string>(() => info.repositoryUrl);
|
||||||
const feedbackUrl = computed<string>(() => info.feedbackUrl);
|
const feedbackUrl = computed<string>(() => info.feedbackUrl);
|
||||||
@@ -68,7 +68,7 @@ export default defineComponent({
|
|||||||
return {
|
return {
|
||||||
repositoryUrl,
|
repositoryUrl,
|
||||||
feedbackUrl,
|
feedbackUrl,
|
||||||
isDesktop,
|
isRunningAsDesktopApplication,
|
||||||
};
|
};
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
<div>
|
<div>
|
||||||
<div class="footer">
|
<div class="footer">
|
||||||
<div class="footer__section">
|
<div class="footer__section">
|
||||||
<span v-if="isDesktop" class="footer__section__item">
|
<span v-if="isRunningAsDesktopApplication" class="footer__section__item">
|
||||||
<AppIcon class="icon" icon="globe" />
|
<AppIcon class="icon" icon="globe" />
|
||||||
<span>
|
<span>
|
||||||
Online version at <a :href="homepageUrl" target="_blank" rel="noopener noreferrer">{{ homepageUrl }}</a>
|
Online version at <a :href="homepageUrl" target="_blank" rel="noopener noreferrer">{{ homepageUrl }}</a>
|
||||||
@@ -68,7 +68,7 @@ export default defineComponent({
|
|||||||
},
|
},
|
||||||
setup() {
|
setup() {
|
||||||
const { info } = injectKey((keys) => keys.useApplication);
|
const { info } = injectKey((keys) => keys.useApplication);
|
||||||
const { isDesktop } = injectKey((keys) => keys.useRuntimeEnvironment);
|
const { isRunningAsDesktopApplication } = injectKey((keys) => keys.useRuntimeEnvironment);
|
||||||
|
|
||||||
const isPrivacyDialogVisible = ref(false);
|
const isPrivacyDialogVisible = ref(false);
|
||||||
|
|
||||||
@@ -87,7 +87,7 @@ export default defineComponent({
|
|||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
isDesktop,
|
isRunningAsDesktopApplication,
|
||||||
isPrivacyDialogVisible,
|
isPrivacyDialogVisible,
|
||||||
showPrivacyDialog,
|
showPrivacyDialog,
|
||||||
version,
|
version,
|
||||||
|
|||||||
@@ -1,24 +1,37 @@
|
|||||||
import { ScriptFileCodeRunner } from '@/infrastructure/CodeRunner/ScriptFileCodeRunner';
|
import { ScriptFileCodeRunner } from '@/infrastructure/CodeRunner/ScriptFileCodeRunner';
|
||||||
import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
|
import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
|
||||||
|
import { Dialog } from '@/presentation/common/Dialog';
|
||||||
|
import { ElectronDialog } from '@/infrastructure/Dialog/Electron/ElectronDialog';
|
||||||
|
import { IpcChannel } from '@/presentation/electron/shared/IpcBridging/IpcChannel';
|
||||||
import { registerIpcChannel } from '../shared/IpcBridging/IpcProxy';
|
import { registerIpcChannel } from '../shared/IpcBridging/IpcProxy';
|
||||||
import { IpcChannelDefinitions } from '../shared/IpcBridging/IpcChannelDefinitions';
|
import { ChannelDefinitionKey, IpcChannelDefinitions } from '../shared/IpcBridging/IpcChannelDefinitions';
|
||||||
|
|
||||||
export function registerAllIpcChannels(
|
export function registerAllIpcChannels(
|
||||||
createCodeRunner: CodeRunnerFactory = () => new ScriptFileCodeRunner(),
|
createCodeRunner: CodeRunnerFactory = () => new ScriptFileCodeRunner(),
|
||||||
registrar: IpcRegistrar = registerIpcChannel,
|
createDialog: DialogFactory = () => new ElectronDialog(),
|
||||||
|
registrar: IpcChannelRegistrar = registerIpcChannel,
|
||||||
) {
|
) {
|
||||||
const registrars: Record<keyof typeof IpcChannelDefinitions, () => void> = {
|
const ipcInstanceCreators: IpcChannelRegistrars = {
|
||||||
CodeRunner: () => registrar(IpcChannelDefinitions.CodeRunner, createCodeRunner()),
|
CodeRunner: () => createCodeRunner(),
|
||||||
|
Dialog: () => createDialog(),
|
||||||
};
|
};
|
||||||
Object.entries(registrars).forEach(([name, register]) => {
|
Object.entries(ipcInstanceCreators).forEach(([name, instanceFactory]) => {
|
||||||
try {
|
try {
|
||||||
register();
|
const definition = IpcChannelDefinitions[name];
|
||||||
|
const instance = instanceFactory();
|
||||||
|
registrar(definition, instance);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
throw new AggregateError(`main: Failed to register IPC channel "${name}"`, err);
|
throw new AggregateError([err], `main: Failed to register IPC channel "${name}":\n${err.message}`);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
export type CodeRunnerFactory = () => CodeRunner;
|
export type CodeRunnerFactory = () => CodeRunner;
|
||||||
|
export type DialogFactory = () => Dialog;
|
||||||
|
export type IpcChannelRegistrar = typeof registerIpcChannel;
|
||||||
|
|
||||||
export type IpcRegistrar = typeof registerIpcChannel;
|
type RegistrationChannel<T extends ChannelDefinitionKey> = (typeof IpcChannelDefinitions)[T];
|
||||||
|
type ExtractChannelServiceType<T> = T extends IpcChannel<infer U> ? U : never;
|
||||||
|
type IpcChannelRegistrars = {
|
||||||
|
[K in ChannelDefinitionKey]: () => ExtractChannelServiceType<RegistrationChannel<K>>;
|
||||||
|
};
|
||||||
|
|||||||
@@ -12,14 +12,20 @@ export function provideWindowVariables(
|
|||||||
createApiFacade: ApiFacadeFactory = createSecureFacade,
|
createApiFacade: ApiFacadeFactory = createSecureFacade,
|
||||||
ipcConsumerCreator: IpcConsumerProxyCreator = createIpcConsumerProxy,
|
ipcConsumerCreator: IpcConsumerProxyCreator = createIpcConsumerProxy,
|
||||||
): WindowVariables {
|
): WindowVariables {
|
||||||
return {
|
// Enforces mandatory variable availability at compile time
|
||||||
isDesktop: true,
|
const variables: RequiredWindowVariables = {
|
||||||
|
isRunningAsDesktopApplication: true,
|
||||||
log: createApiFacade(createLogger(), ['info', 'debug', 'warn', 'error']),
|
log: createApiFacade(createLogger(), ['info', 'debug', 'warn', 'error']),
|
||||||
os: convertToOs(process.platform),
|
os: convertToOs(process.platform),
|
||||||
codeRunner: ipcConsumerCreator(IpcChannelDefinitions.CodeRunner),
|
codeRunner: ipcConsumerCreator(IpcChannelDefinitions.CodeRunner),
|
||||||
|
dialog: ipcConsumerCreator(IpcChannelDefinitions.Dialog),
|
||||||
};
|
};
|
||||||
|
return variables;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type RequiredWindowVariables = PartiallyRequired<WindowVariables, 'os' /* | 'anotherOptionalKey'.. */>;
|
||||||
|
type PartiallyRequired<T, K extends keyof T> = Required<Omit<T, K>> & Pick<T, K>;
|
||||||
|
|
||||||
export type LoggerFactory = () => Logger;
|
export type LoggerFactory = () => Logger;
|
||||||
|
|
||||||
export type ApiFacadeFactory = typeof createSecureFacade;
|
export type ApiFacadeFactory = typeof createSecureFacade;
|
||||||
|
|||||||
@@ -1,11 +1,15 @@
|
|||||||
import { FunctionKeys } from '@/TypeHelpers';
|
import { FunctionKeys } from '@/TypeHelpers';
|
||||||
import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
|
import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
|
||||||
|
import { Dialog } from '@/presentation/common/Dialog';
|
||||||
import { IpcChannel } from './IpcChannel';
|
import { IpcChannel } from './IpcChannel';
|
||||||
|
|
||||||
export const IpcChannelDefinitions = {
|
export const IpcChannelDefinitions = {
|
||||||
CodeRunner: defineElectronIpcChannel<CodeRunner>('code-run', ['runCode']),
|
CodeRunner: defineElectronIpcChannel<CodeRunner>('code-run', ['runCode']),
|
||||||
|
Dialog: defineElectronIpcChannel<Dialog>('dialogs', ['saveFile']),
|
||||||
} as const;
|
} as const;
|
||||||
|
|
||||||
|
export type ChannelDefinitionKey = keyof typeof IpcChannelDefinitions;
|
||||||
|
|
||||||
function defineElectronIpcChannel<T>(
|
function defineElectronIpcChannel<T>(
|
||||||
name: string,
|
name: string,
|
||||||
functionNames: readonly FunctionKeys<T>[],
|
functionNames: readonly FunctionKeys<T>[],
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { ipcMain } from 'electron/main';
|
import { ipcMain } from 'electron/main';
|
||||||
import { ipcRenderer } from 'electron/renderer';
|
import { ipcRenderer } from 'electron/renderer';
|
||||||
import { isFunction } from '@/TypeHelpers';
|
import { FunctionKeys, isFunction } from '@/TypeHelpers';
|
||||||
import { IpcChannel } from './IpcChannel';
|
import { IpcChannel } from './IpcChannel';
|
||||||
|
|
||||||
export function createIpcConsumerProxy<T>(
|
export function createIpcConsumerProxy<T>(
|
||||||
@@ -25,9 +25,7 @@ export function registerIpcChannel<T>(
|
|||||||
) {
|
) {
|
||||||
channel.accessibleMembers.forEach((functionKey) => {
|
channel.accessibleMembers.forEach((functionKey) => {
|
||||||
const originalFunction = originalObject[functionKey];
|
const originalFunction = originalObject[functionKey];
|
||||||
if (!isFunction(originalFunction)) {
|
validateIpcFunction(functionKey, originalFunction, channel);
|
||||||
throw new Error('Non-function members are not yet supported');
|
|
||||||
}
|
|
||||||
const ipcChannel = getIpcChannelIdentifier(channel.namespace, functionKey as string);
|
const ipcChannel = getIpcChannelIdentifier(channel.namespace, functionKey as string);
|
||||||
electronIpcMain.handle(ipcChannel, (_event, ...args: unknown[]) => {
|
electronIpcMain.handle(ipcChannel, (_event, ...args: unknown[]) => {
|
||||||
return originalFunction.apply(originalObject, args);
|
return originalFunction.apply(originalObject, args);
|
||||||
@@ -35,6 +33,28 @@ export function registerIpcChannel<T>(
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function validateIpcFunction<T>(
|
||||||
|
functionKey: FunctionKeys<T>,
|
||||||
|
functionValue: T[FunctionKeys<T>],
|
||||||
|
channel: IpcChannel<T>,
|
||||||
|
): asserts functionValue is T[FunctionKeys<T>] & ((...args: unknown[]) => unknown) {
|
||||||
|
const functionName = functionKey.toString();
|
||||||
|
if (functionValue === undefined) {
|
||||||
|
throwErrorWithContext(`The function "${functionName}" is not found on the target object.`);
|
||||||
|
}
|
||||||
|
if (!isFunction(functionValue)) {
|
||||||
|
throwErrorWithContext('Non-function members are not yet supported.');
|
||||||
|
}
|
||||||
|
function throwErrorWithContext(message: string): never {
|
||||||
|
throw new Error([
|
||||||
|
message,
|
||||||
|
`Channel: ${JSON.stringify(channel)}.`,
|
||||||
|
`Function key: ${functionName}.`,
|
||||||
|
`Value: ${JSON.stringify(functionValue)}`,
|
||||||
|
].join('\n'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
function getIpcChannelIdentifier(namespace: string, key: string) {
|
function getIpcChannelIdentifier(namespace: string, key: string) {
|
||||||
return `proxy:${namespace}:${key}`;
|
return `proxy:${namespace}:${key}`;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,8 +6,9 @@ import type { useClipboard } from '@/presentation/components/Shared/Hooks/Clipbo
|
|||||||
import type { useCurrentCode } from '@/presentation/components/Shared/Hooks/UseCurrentCode';
|
import type { useCurrentCode } from '@/presentation/components/Shared/Hooks/UseCurrentCode';
|
||||||
import type { useAutoUnsubscribedEvents } from '@/presentation/components/Shared/Hooks/UseAutoUnsubscribedEvents';
|
import type { useAutoUnsubscribedEvents } from '@/presentation/components/Shared/Hooks/UseAutoUnsubscribedEvents';
|
||||||
import type { useUserSelectionState } from '@/presentation/components/Shared/Hooks/UseUserSelectionState';
|
import type { useUserSelectionState } from '@/presentation/components/Shared/Hooks/UseUserSelectionState';
|
||||||
import type { useLogger } from '@/presentation/components/Shared/Hooks/UseLogger';
|
import type { useLogger } from '@/presentation/components/Shared/Hooks/Log/UseLogger';
|
||||||
import type { useCodeRunner } from './components/Shared/Hooks/UseCodeRunner';
|
import type { useCodeRunner } from './components/Shared/Hooks/UseCodeRunner';
|
||||||
|
import type { useDialog } from './components/Shared/Hooks/Dialog/UseDialog';
|
||||||
|
|
||||||
export const InjectionKeys = {
|
export const InjectionKeys = {
|
||||||
useCollectionState: defineTransientKey<ReturnType<typeof useCollectionState>>('useCollectionState'),
|
useCollectionState: defineTransientKey<ReturnType<typeof useCollectionState>>('useCollectionState'),
|
||||||
@@ -19,6 +20,7 @@ export const InjectionKeys = {
|
|||||||
useUserSelectionState: defineTransientKey<ReturnType<typeof useUserSelectionState>>('useUserSelectionState'),
|
useUserSelectionState: defineTransientKey<ReturnType<typeof useUserSelectionState>>('useUserSelectionState'),
|
||||||
useLogger: defineTransientKey<ReturnType<typeof useLogger>>('useLogger'),
|
useLogger: defineTransientKey<ReturnType<typeof useLogger>>('useLogger'),
|
||||||
useCodeRunner: defineTransientKey<ReturnType<typeof useCodeRunner>>('useCodeRunner'),
|
useCodeRunner: defineTransientKey<ReturnType<typeof useCodeRunner>>('useCodeRunner'),
|
||||||
|
useDialog: defineTransientKey<ReturnType<typeof useDialog>>('useDialog'),
|
||||||
};
|
};
|
||||||
|
|
||||||
export interface InjectionKeyWithLifetime<T> {
|
export interface InjectionKeyWithLifetime<T> {
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ describe('ScriptFileCodeRunner', () => {
|
|||||||
const currentOperatingSystem = CurrentEnvironment.os;
|
const currentOperatingSystem = CurrentEnvironment.os;
|
||||||
if (await shouldSkipTest(currentOperatingSystem)) {
|
if (await shouldSkipTest(currentOperatingSystem)) {
|
||||||
skip();
|
skip();
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
const temporaryDirectoryProvider = createTemporaryDirectoryProvider();
|
const temporaryDirectoryProvider = createTemporaryDirectoryProvider();
|
||||||
const codeRunner = createCodeRunner(temporaryDirectoryProvider);
|
const codeRunner = createCodeRunner(temporaryDirectoryProvider);
|
||||||
@@ -61,10 +62,14 @@ function getPlatformSpecificArguments(
|
|||||||
function shouldSkipTest(
|
function shouldSkipTest(
|
||||||
os: OperatingSystem | undefined,
|
os: OperatingSystem | undefined,
|
||||||
): Promise<boolean> {
|
): Promise<boolean> {
|
||||||
return new Promise((resolve) => {
|
|
||||||
if (os !== OperatingSystem.Linux) {
|
if (os !== OperatingSystem.Linux) {
|
||||||
resolve(false);
|
return Promise.resolve(false);
|
||||||
}
|
}
|
||||||
|
return isLinuxTerminalEmulatorSupported();
|
||||||
|
}
|
||||||
|
|
||||||
|
function isLinuxTerminalEmulatorSupported(): Promise<boolean> {
|
||||||
|
return new Promise((resolve) => {
|
||||||
exec(`which ${LinuxTerminalEmulator}`).on('close', (exitCode) => {
|
exec(`which ${LinuxTerminalEmulator}`).on('close', (exitCode) => {
|
||||||
resolve(exitCode !== 0);
|
resolve(exitCode !== 0);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -39,6 +39,8 @@ export const BrowserOsTestCases: ReadonlyArray<BrowserOsTestCase> = [
|
|||||||
'Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.102 UBrowser/6.0.1308.1016 Safari/537.36',
|
'Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.102 UBrowser/6.0.1308.1016 Safari/537.36',
|
||||||
// Electron:
|
// Electron:
|
||||||
'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.5993.54 Electron/27.0.0 Safari/537.36',
|
'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.5993.54 Electron/27.0.0 Safari/537.36',
|
||||||
|
// jsdom:
|
||||||
|
'Mozilla/5.0 (Windows) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/22.1.0',
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
...createTests({
|
...createTests({
|
||||||
@@ -60,6 +62,8 @@ export const BrowserOsTestCases: ReadonlyArray<BrowserOsTestCase> = [
|
|||||||
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36 Edg/119.0.0.0',
|
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36 Edg/119.0.0.0',
|
||||||
// Electron:
|
// Electron:
|
||||||
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.5993.54 Electron/27.0.0 Safari/537.36',
|
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.5993.54 Electron/27.0.0 Safari/537.36',
|
||||||
|
// jsdom:
|
||||||
|
'Mozilla/5.0 (darwin) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/22.1.0',
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
...createTests({
|
...createTests({
|
||||||
@@ -74,6 +78,8 @@ export const BrowserOsTestCases: ReadonlyArray<BrowserOsTestCase> = [
|
|||||||
'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36 Edg/115.0.1901.188',
|
'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36 Edg/115.0.1901.188',
|
||||||
// Electron:
|
// Electron:
|
||||||
'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.5993.54 Electron/27.0.0 Safari/537.36',
|
'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.5993.54 Electron/27.0.0 Safari/537.36',
|
||||||
|
// jsdom:
|
||||||
|
'Mozilla/5.0 (linux) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/22.1.0',
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
...createTests({
|
...createTests({
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
import { describe, it, expect } from 'vitest';
|
||||||
|
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
||||||
|
|
||||||
|
describe('RuntimeEnvironmentFactory', () => {
|
||||||
|
describe('CurrentEnvironment', () => {
|
||||||
|
it('identifies as browser in test environment', () => { // Ensures test independence from Electron IPC
|
||||||
|
// arrange
|
||||||
|
const expectedDesktopAppState = false;
|
||||||
|
// act
|
||||||
|
const isRunningAsDesktop = CurrentEnvironment.isRunningAsDesktopApplication;
|
||||||
|
// assert
|
||||||
|
expect(isRunningAsDesktop).to.equal(expectedDesktopAppState);
|
||||||
|
});
|
||||||
|
it('identifies as non-production in test environment', () => {
|
||||||
|
// arrange
|
||||||
|
const expectedNonProductionState = true;
|
||||||
|
// act
|
||||||
|
const isNonProductionEnvironment = CurrentEnvironment.isNonProduction;
|
||||||
|
// assert
|
||||||
|
expect(isNonProductionEnvironment).to.equal(expectedNonProductionState);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -29,7 +29,7 @@ describe('MobileSafariActivePseudoClassEnabler', () => {
|
|||||||
`User agent\t\t: ${navigator.userAgent}`,
|
`User agent\t\t: ${navigator.userAgent}`,
|
||||||
`Touch supported\t\t: ${supportsTouch}`,
|
`Touch supported\t\t: ${supportsTouch}`,
|
||||||
`Current OS\t\t: ${patchedEnvironment.os === undefined ? 'unknown' : OperatingSystem[patchedEnvironment.os]}`,
|
`Current OS\t\t: ${patchedEnvironment.os === undefined ? 'unknown' : OperatingSystem[patchedEnvironment.os]}`,
|
||||||
`Is desktop?\t\t: ${patchedEnvironment.isDesktop ? 'Yes (Desktop app)' : 'No (Browser)'}`,
|
`Is desktop?\t\t: ${patchedEnvironment.isRunningAsDesktopApplication ? 'Yes (Desktop app)' : 'No (Browser)'}`,
|
||||||
`Listeners (${currentListeners.length})\t\t: ${JSON.stringify(currentListeners)}`,
|
`Listeners (${currentListeners.length})\t\t: ${JSON.stringify(currentListeners)}`,
|
||||||
]));
|
]));
|
||||||
});
|
});
|
||||||
|
|||||||
7
tests/shared/bootstrap/BlobPolyfill.ts
Normal file
7
tests/shared/bootstrap/BlobPolyfill.ts
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
import { Blob as BlobPolyfill } from 'node:buffer';
|
||||||
|
|
||||||
|
export function polyfillBlob() {
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||||
|
global.Blob = BlobPolyfill as any;
|
||||||
|
// Workaround as `blob.text()` is not available in jsdom (https://github.com/jsdom/jsdom/issues/2555)
|
||||||
|
}
|
||||||
@@ -1,4 +1,6 @@
|
|||||||
import { afterEach } from 'vitest';
|
import { afterEach } from 'vitest';
|
||||||
import { enableAutoUnmount } from '@vue/test-utils';
|
import { enableAutoUnmount } from '@vue/test-utils';
|
||||||
|
import { polyfillBlob } from './BlobPolyfill';
|
||||||
|
|
||||||
enableAutoUnmount(afterEach);
|
enableAutoUnmount(afterEach);
|
||||||
|
polyfillBlob();
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
import { describe, it, expect } from 'vitest';
|
||||||
|
import { FileType } from '@/presentation/common/Dialog';
|
||||||
|
import { BrowserDialog } from '@/infrastructure/Dialog/Browser/BrowserDialog';
|
||||||
|
import { BrowserSaveFileDialog } from '@/infrastructure/Dialog/Browser/BrowserSaveFileDialog';
|
||||||
|
|
||||||
|
describe('BrowserDialog', () => {
|
||||||
|
describe('saveFile', () => {
|
||||||
|
it('passes correct arguments', () => {
|
||||||
|
// arrange
|
||||||
|
const expectedFileContents = 'test content';
|
||||||
|
const expectedFileName = 'test.sh';
|
||||||
|
const expectedFileType = FileType.ShellScript;
|
||||||
|
let actualSaveFileArgs: Parameters<BrowserSaveFileDialog['saveFile']> | undefined;
|
||||||
|
const fileSaverDialogSpy: BrowserSaveFileDialog = {
|
||||||
|
saveFile: (...args) => {
|
||||||
|
actualSaveFileArgs = args;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
const browserDialog = new BrowserDialog(fileSaverDialogSpy);
|
||||||
|
|
||||||
|
// act
|
||||||
|
browserDialog.saveFile(expectedFileContents, expectedFileName, expectedFileType);
|
||||||
|
|
||||||
|
// assert
|
||||||
|
expect(actualSaveFileArgs)
|
||||||
|
.to
|
||||||
|
.deep
|
||||||
|
.equal([expectedFileContents, expectedFileName, expectedFileType]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
126
tests/unit/infrastructure/Dialog/Browser/FileSaverDialog.spec.ts
Normal file
126
tests/unit/infrastructure/Dialog/Browser/FileSaverDialog.spec.ts
Normal file
@@ -0,0 +1,126 @@
|
|||||||
|
import { describe, it, expect } from 'vitest';
|
||||||
|
import { FileSaverDialog, SaveAsFunction, WindowOpenFunction } from '@/infrastructure/Dialog/Browser/FileSaverDialog';
|
||||||
|
import { FileType } from '@/presentation/common/Dialog';
|
||||||
|
import { expectExists } from '@tests/shared/Assertions/ExpectExists';
|
||||||
|
|
||||||
|
describe('FileSaverDialog', () => {
|
||||||
|
describe('saveFile', () => {
|
||||||
|
describe('saving file with correct mime type', () => {
|
||||||
|
const testCases: ReadonlyArray<{
|
||||||
|
readonly fileType: FileType;
|
||||||
|
readonly expectedMimeType: string;
|
||||||
|
}> = [
|
||||||
|
{ fileType: FileType.BatchFile, expectedMimeType: 'application/bat' },
|
||||||
|
{ fileType: FileType.ShellScript, expectedMimeType: 'text/x-shellscript' },
|
||||||
|
];
|
||||||
|
testCases.forEach(({ fileType, expectedMimeType }) => {
|
||||||
|
it(`correct mimeType for ${FileType[fileType]}`, () => {
|
||||||
|
// arrange
|
||||||
|
let actualMimeType: string | undefined;
|
||||||
|
const saveAsSpy: SaveAsFunction = (blob) => {
|
||||||
|
actualMimeType = blob.type;
|
||||||
|
};
|
||||||
|
|
||||||
|
// act
|
||||||
|
new SaveFileTestSetup()
|
||||||
|
.withFileType(fileType)
|
||||||
|
.withSaveAs(saveAsSpy)
|
||||||
|
.saveFile();
|
||||||
|
|
||||||
|
// assert
|
||||||
|
expect(actualMimeType).to.equal(expectedMimeType);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
it('blob contains correct file contents', async () => {
|
||||||
|
// arrange
|
||||||
|
const expectedFileContents = 'expected file contents';
|
||||||
|
let actualBlob: Blob | undefined;
|
||||||
|
const saveAsSpy: SaveAsFunction = (blob) => {
|
||||||
|
actualBlob = blob;
|
||||||
|
};
|
||||||
|
|
||||||
|
// act
|
||||||
|
new SaveFileTestSetup()
|
||||||
|
.withSaveAs(saveAsSpy)
|
||||||
|
.withFileContents(expectedFileContents)
|
||||||
|
.saveFile();
|
||||||
|
|
||||||
|
// assert
|
||||||
|
expectExists(actualBlob);
|
||||||
|
const actualFileContents = await actualBlob.text();
|
||||||
|
expect(actualFileContents).to.equal(expectedFileContents);
|
||||||
|
});
|
||||||
|
it('opens new window on save failure', () => {
|
||||||
|
// arrange
|
||||||
|
const fileContents = 'test file contents';
|
||||||
|
const failingSaveAs: SaveAsFunction = () => {
|
||||||
|
throw new Error('injected fail');
|
||||||
|
};
|
||||||
|
let calledArgs: Parameters<WindowOpenFunction> | undefined;
|
||||||
|
const windowOpenSpy: WindowOpenFunction = (...args) => {
|
||||||
|
calledArgs = args;
|
||||||
|
};
|
||||||
|
|
||||||
|
// act
|
||||||
|
new SaveFileTestSetup()
|
||||||
|
.withSaveAs(failingSaveAs)
|
||||||
|
.withFileType(FileType.BatchFile)
|
||||||
|
.withFileContents(fileContents)
|
||||||
|
.withWindowOpen(windowOpenSpy)
|
||||||
|
.saveFile();
|
||||||
|
|
||||||
|
// assert
|
||||||
|
expectExists(calledArgs);
|
||||||
|
const [url, target, features] = calledArgs;
|
||||||
|
const mimeType = 'application/bat';
|
||||||
|
expect(url).to.equal(`data:${mimeType},${encodeURIComponent(fileContents)}`);
|
||||||
|
expect(target).to.equal('_blank');
|
||||||
|
expect(features).to.equal('');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
class SaveFileTestSetup {
|
||||||
|
private saveAs: SaveAsFunction = () => {};
|
||||||
|
|
||||||
|
private windowOpen: WindowOpenFunction = () => {};
|
||||||
|
|
||||||
|
private fileContents: string = `${SaveFileTestSetup.name} file contents`;
|
||||||
|
|
||||||
|
private fileName: string = `${SaveFileTestSetup.name} file name`;
|
||||||
|
|
||||||
|
private fileType: FileType = FileType.BatchFile;
|
||||||
|
|
||||||
|
public withSaveAs(saveAs: SaveAsFunction): this {
|
||||||
|
this.saveAs = saveAs;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withFileContents(fileContents: string): this {
|
||||||
|
this.fileContents = fileContents;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withFileType(fileType: FileType): this {
|
||||||
|
this.fileType = fileType;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withWindowOpen(windowOpen: WindowOpenFunction): this {
|
||||||
|
this.windowOpen = windowOpen;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public saveFile() {
|
||||||
|
const dialog = new FileSaverDialog(
|
||||||
|
this.saveAs,
|
||||||
|
this.windowOpen,
|
||||||
|
);
|
||||||
|
return dialog.saveFile(
|
||||||
|
this.fileContents,
|
||||||
|
this.fileName,
|
||||||
|
this.fileType,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import { describe, it, expect } from 'vitest';
|
||||||
|
import { FileType } from '@/presentation/common/Dialog';
|
||||||
|
import { BrowserDialog } from '@/infrastructure/Dialog/Browser/BrowserDialog';
|
||||||
|
import { ElectronSaveFileDialog } from '@/infrastructure/Dialog/Electron/ElectronSaveFileDialog';
|
||||||
|
|
||||||
|
describe('BrowserDialog', () => {
|
||||||
|
describe('saveFile', () => {
|
||||||
|
it('passes correct arguments', async () => {
|
||||||
|
// arrange
|
||||||
|
const expectedFileContents = 'test content';
|
||||||
|
const expectedFileName = 'test.sh';
|
||||||
|
const expectedFileType = FileType.ShellScript;
|
||||||
|
let actualSaveFileArgs: Parameters<ElectronSaveFileDialog['saveFile']> | undefined;
|
||||||
|
const fileSaverDialogSpy: ElectronSaveFileDialog = {
|
||||||
|
saveFile: (...args) => {
|
||||||
|
actualSaveFileArgs = args;
|
||||||
|
return Promise.resolve();
|
||||||
|
},
|
||||||
|
};
|
||||||
|
const browserDialog = new BrowserDialog(fileSaverDialogSpy);
|
||||||
|
|
||||||
|
// act
|
||||||
|
await browserDialog.saveFile(expectedFileContents, expectedFileName, expectedFileType);
|
||||||
|
|
||||||
|
// assert
|
||||||
|
expect(actualSaveFileArgs)
|
||||||
|
.to
|
||||||
|
.deep
|
||||||
|
.equal([expectedFileContents, expectedFileName, expectedFileType]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -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);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,268 @@
|
|||||||
|
import { describe, it, expect } from 'vitest';
|
||||||
|
import { FileType } from '@/presentation/common/Dialog';
|
||||||
|
import { ElectronFileDialogOperations, NodeElectronSaveFileDialog, NodeFileOperations } from '@/infrastructure/Dialog/Electron/NodeElectronSaveFileDialog';
|
||||||
|
import { Logger } from '@/application/Common/Log/Logger';
|
||||||
|
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
||||||
|
import { expectExists } from '@tests/shared/Assertions/ExpectExists';
|
||||||
|
import { ElectronFileDialogOperationsStub } from './ElectronFileDialogOperationsStub';
|
||||||
|
import { NodeFileOperationsStub } from './NodeFileOperationsStub';
|
||||||
|
|
||||||
|
describe('NodeElectronSaveFileDialog', () => {
|
||||||
|
describe('shows dialog with correct options', () => {
|
||||||
|
it('correct title', async () => {
|
||||||
|
// arrange
|
||||||
|
const expectedFileName = 'expected-file-name';
|
||||||
|
const electronMock = new ElectronFileDialogOperationsStub();
|
||||||
|
const context = new SaveFileDialogTestSetup()
|
||||||
|
.withElectron(electronMock)
|
||||||
|
.withFileName(expectedFileName);
|
||||||
|
// act
|
||||||
|
await context.saveFile();
|
||||||
|
// assert
|
||||||
|
assertDialogOptionMatchesExpectedValue(expectedFileName, (opts) => opts.title, electronMock);
|
||||||
|
});
|
||||||
|
it('correct properties', async () => {
|
||||||
|
// arrange
|
||||||
|
const expectedProperties = [
|
||||||
|
'createDirectory',
|
||||||
|
'showOverwriteConfirmation',
|
||||||
|
];
|
||||||
|
const electronMock = new ElectronFileDialogOperationsStub();
|
||||||
|
const context = new SaveFileDialogTestSetup()
|
||||||
|
.withElectron(electronMock);
|
||||||
|
// act
|
||||||
|
await context.saveFile();
|
||||||
|
// assert
|
||||||
|
assertDialogOptionMatchesExpectedValue(
|
||||||
|
expectedProperties,
|
||||||
|
(opts) => opts.properties,
|
||||||
|
electronMock,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
it('correct default path', async () => {
|
||||||
|
// arrange
|
||||||
|
const pathSegmentSeparator = '_{test-separator}_';
|
||||||
|
const expectedFileName = 'expected-file-name';
|
||||||
|
const expectedParentDirectory = 'expected-downloads-path';
|
||||||
|
const expectedFilePath = [
|
||||||
|
expectedParentDirectory,
|
||||||
|
expectedFileName,
|
||||||
|
].join(pathSegmentSeparator);
|
||||||
|
const electronMock = new ElectronFileDialogOperationsStub()
|
||||||
|
.withUserDownloadsPath(expectedParentDirectory);
|
||||||
|
const context = new SaveFileDialogTestSetup()
|
||||||
|
.withElectron(electronMock)
|
||||||
|
.withFileName(expectedFileName)
|
||||||
|
.withNode(new NodeFileOperationsStub().withPathSegmentSeparator(pathSegmentSeparator));
|
||||||
|
// act
|
||||||
|
await context.saveFile();
|
||||||
|
// assert
|
||||||
|
assertDialogOptionMatchesExpectedValue(
|
||||||
|
expectedFilePath,
|
||||||
|
(opts) => opts.defaultPath,
|
||||||
|
electronMock,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
describe('correct filters', () => {
|
||||||
|
const defaultFilter: Electron.FileFilter = {
|
||||||
|
name: 'All Files',
|
||||||
|
extensions: ['*'],
|
||||||
|
};
|
||||||
|
const testScenarios: Record<FileType, Electron.FileFilter[]> = {
|
||||||
|
[FileType.BatchFile]: [
|
||||||
|
defaultFilter,
|
||||||
|
{
|
||||||
|
name: 'Batch Files',
|
||||||
|
extensions: ['bat', 'cmd'],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
[FileType.ShellScript]: [
|
||||||
|
defaultFilter,
|
||||||
|
{
|
||||||
|
name: 'Shell Scripts',
|
||||||
|
extensions: ['sh', 'bash', 'zsh'],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
Object.entries(testScenarios).forEach(([fileTypeKey, expectedFilters]) => {
|
||||||
|
const fileType = Number(fileTypeKey) as FileType;
|
||||||
|
it(`applies correct filters for ${FileType[fileType]}`, async () => {
|
||||||
|
// arrange
|
||||||
|
const electronMock = new ElectronFileDialogOperationsStub();
|
||||||
|
const context = new SaveFileDialogTestSetup()
|
||||||
|
.withFileType(fileType)
|
||||||
|
.withElectron(electronMock);
|
||||||
|
// act
|
||||||
|
await context.saveFile();
|
||||||
|
// assert
|
||||||
|
const sortFilters = (
|
||||||
|
filters: Electron.FileFilter[],
|
||||||
|
) => filters.sort((a, b) => a.name.localeCompare(b.name));
|
||||||
|
const expectedSortedFilters = sortFilters(expectedFilters);
|
||||||
|
assertDialogOptionMatchesExpectedValue(
|
||||||
|
expectedSortedFilters,
|
||||||
|
(opts) => sortFilters(opts.filters ?? []),
|
||||||
|
electronMock,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('saves the file when the dialog is not canceled', () => {
|
||||||
|
it('writes to the selected file path', async () => {
|
||||||
|
// arrange
|
||||||
|
const expectedFilePath = 'expected-file-path';
|
||||||
|
const isCancelled = false;
|
||||||
|
const electronMock = new ElectronFileDialogOperationsStub()
|
||||||
|
.withMimicUserCancel(isCancelled)
|
||||||
|
.withUserSelectedFilePath(expectedFilePath);
|
||||||
|
const nodeMock = new NodeFileOperationsStub();
|
||||||
|
const context = new SaveFileDialogTestSetup()
|
||||||
|
.withElectron(electronMock)
|
||||||
|
.withNode(nodeMock);
|
||||||
|
|
||||||
|
// act
|
||||||
|
await context.saveFile();
|
||||||
|
|
||||||
|
// assert
|
||||||
|
const saveFileCalls = nodeMock.callHistory.filter((c) => c.methodName === 'writeFile');
|
||||||
|
expect(saveFileCalls).to.have.lengthOf(1);
|
||||||
|
const [actualFilePath] = saveFileCalls[0].args;
|
||||||
|
expect(actualFilePath).to.equal(expectedFilePath);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('writes the correct file contents', async () => {
|
||||||
|
// arrange
|
||||||
|
const expectedFileContents = 'expected-file-contents';
|
||||||
|
const isCancelled = false;
|
||||||
|
const electronMock = new ElectronFileDialogOperationsStub()
|
||||||
|
.withMimicUserCancel(isCancelled);
|
||||||
|
const nodeMock = new NodeFileOperationsStub();
|
||||||
|
const context = new SaveFileDialogTestSetup()
|
||||||
|
.withElectron(electronMock)
|
||||||
|
.withFileContents(expectedFileContents)
|
||||||
|
.withNode(nodeMock);
|
||||||
|
|
||||||
|
// act
|
||||||
|
await context.saveFile();
|
||||||
|
|
||||||
|
// assert
|
||||||
|
const saveFileCalls = nodeMock.callHistory.filter((c) => c.methodName === 'writeFile');
|
||||||
|
expect(saveFileCalls).to.have.lengthOf(1);
|
||||||
|
const [,actualFileContents] = saveFileCalls[0].args;
|
||||||
|
expect(actualFileContents).to.equal(expectedFileContents);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not save file when dialog is canceled', async () => {
|
||||||
|
// arrange
|
||||||
|
const isCancelled = true;
|
||||||
|
const electronMock = new ElectronFileDialogOperationsStub()
|
||||||
|
.withMimicUserCancel(isCancelled);
|
||||||
|
const nodeMock = new NodeFileOperationsStub();
|
||||||
|
const context = new SaveFileDialogTestSetup()
|
||||||
|
.withElectron(electronMock)
|
||||||
|
.withNode(nodeMock);
|
||||||
|
|
||||||
|
// act
|
||||||
|
await context.saveFile();
|
||||||
|
|
||||||
|
// assert
|
||||||
|
const saveFileCall = nodeMock.callHistory.find((c) => c.methodName === 'writeFile');
|
||||||
|
expect(saveFileCall).to.equal(undefined);
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('logging', () => {
|
||||||
|
it('logs an error if writing the file fails', async () => {
|
||||||
|
// arrange
|
||||||
|
const expectedErrorMessage = 'Injected write error';
|
||||||
|
const electronMock = new ElectronFileDialogOperationsStub().withMimicUserCancel(false);
|
||||||
|
const nodeMock = new NodeFileOperationsStub();
|
||||||
|
nodeMock.writeFile = () => Promise.reject(new Error(expectedErrorMessage));
|
||||||
|
const loggerStub = new LoggerStub();
|
||||||
|
const context = new SaveFileDialogTestSetup()
|
||||||
|
.withElectron(electronMock)
|
||||||
|
.withNode(nodeMock)
|
||||||
|
.withLogger(loggerStub);
|
||||||
|
|
||||||
|
// act
|
||||||
|
await context.saveFile();
|
||||||
|
|
||||||
|
// assert
|
||||||
|
const errorCalls = loggerStub.callHistory.filter((c) => c.methodName === 'error');
|
||||||
|
expect(errorCalls.length).to.equal(1);
|
||||||
|
const errorCall = errorCalls[0];
|
||||||
|
const [errorMessage] = errorCall.args;
|
||||||
|
expect(errorMessage).to.include(expectedErrorMessage);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
class SaveFileDialogTestSetup {
|
||||||
|
private fileContents = `${SaveFileDialogTestSetup.name} file contents`;
|
||||||
|
|
||||||
|
private fileName = `${SaveFileDialogTestSetup.name} file name`;
|
||||||
|
|
||||||
|
private fileType = FileType.BatchFile;
|
||||||
|
|
||||||
|
private logger: Logger = new LoggerStub();
|
||||||
|
|
||||||
|
private electron: ElectronFileDialogOperations = new ElectronFileDialogOperationsStub();
|
||||||
|
|
||||||
|
private node: NodeFileOperations = new NodeFileOperationsStub();
|
||||||
|
|
||||||
|
public withElectron(electron: ElectronFileDialogOperations): this {
|
||||||
|
this.electron = electron;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withNode(node: NodeFileOperations): this {
|
||||||
|
this.node = node;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withLogger(logger: Logger): this {
|
||||||
|
this.logger = logger;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withFileName(fileName: string): this {
|
||||||
|
this.fileName = fileName;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withFileContents(fileContents: string): this {
|
||||||
|
this.fileContents = fileContents;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withFileType(fileType: FileType): this {
|
||||||
|
this.fileType = fileType;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public saveFile() {
|
||||||
|
const dialog = new NodeElectronSaveFileDialog(this.logger, this.electron, this.node);
|
||||||
|
return dialog.saveFile(
|
||||||
|
this.fileContents,
|
||||||
|
this.fileName,
|
||||||
|
this.fileType,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function assertDialogOptionMatchesExpectedValue<T>(
|
||||||
|
expectedValue: T,
|
||||||
|
getActualOption: (opts: Electron.SaveDialogOptions) => T | undefined,
|
||||||
|
electronMock: ElectronFileDialogOperationsStub,
|
||||||
|
): void {
|
||||||
|
const showDialogCalls = electronMock.callHistory.filter((c) => c.methodName === 'showSaveDialog');
|
||||||
|
expect(showDialogCalls).to.have.lengthOf(1);
|
||||||
|
const showDialogCall = showDialogCalls[0];
|
||||||
|
expectExists(showDialogCall);
|
||||||
|
const [options] = showDialogCall.args;
|
||||||
|
expectExists(options);
|
||||||
|
const actualValue = getActualOption(options);
|
||||||
|
expect(actualValue).to.deep.equal(expectedValue);
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
import { NodeFileOperations } from '@/infrastructure/Dialog/Electron/NodeElectronSaveFileDialog';
|
||||||
|
import { StubWithObservableMethodCalls } from '@tests/unit/shared/Stubs/StubWithObservableMethodCalls';
|
||||||
|
|
||||||
|
export class NodeFileOperationsStub
|
||||||
|
extends StubWithObservableMethodCalls<NodeFileOperations>
|
||||||
|
implements NodeFileOperations {
|
||||||
|
private pathSegmentSeparator = `[${NodeFileOperationsStub.name} path segment separator]`;
|
||||||
|
|
||||||
|
public join(...paths: string[]): string {
|
||||||
|
this.registerMethodCall({
|
||||||
|
methodName: 'join',
|
||||||
|
args: [...paths],
|
||||||
|
});
|
||||||
|
return paths.join(this.pathSegmentSeparator);
|
||||||
|
}
|
||||||
|
|
||||||
|
public writeFile(file: string, data: string): Promise<void> {
|
||||||
|
this.registerMethodCall({
|
||||||
|
methodName: 'writeFile',
|
||||||
|
args: [file, data],
|
||||||
|
});
|
||||||
|
return Promise.resolve();
|
||||||
|
}
|
||||||
|
|
||||||
|
public withPathSegmentSeparator(pathSegmentSeparator: string): this {
|
||||||
|
this.pathSegmentSeparator = pathSegmentSeparator;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,4 +1,3 @@
|
|||||||
// eslint-disable-next-line max-classes-per-file
|
|
||||||
import { describe, it, expect } from 'vitest';
|
import { describe, it, expect } from 'vitest';
|
||||||
import { BrowserOsDetector } from '@/infrastructure/RuntimeEnvironment/Browser/BrowserOs/BrowserOsDetector';
|
import { BrowserOsDetector } from '@/infrastructure/RuntimeEnvironment/Browser/BrowserOs/BrowserOsDetector';
|
||||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
@@ -42,31 +41,32 @@ describe('BrowserRuntimeEnvironment', () => {
|
|||||||
expect(actualTouchSupport).to.equal(expectedTouchSupport);
|
expect(actualTouchSupport).to.equal(expectedTouchSupport);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('isDesktop', () => {
|
describe('isRunningAsDesktopApplication', () => {
|
||||||
it('returns true when window property isDesktop is true', () => {
|
it('returns true when window property `isRunningAsDesktopApplication` is true', () => {
|
||||||
// arrange
|
// arrange
|
||||||
const desktopWindow = {
|
const expectedValue = true;
|
||||||
isDesktop: true,
|
const desktopWindow: Partial<Window> = {
|
||||||
|
isRunningAsDesktopApplication: true,
|
||||||
};
|
};
|
||||||
// act
|
// act
|
||||||
const sut = new BrowserRuntimeEnvironmentBuilder()
|
const sut = new BrowserRuntimeEnvironmentBuilder()
|
||||||
.withWindow(desktopWindow)
|
.withWindow(desktopWindow)
|
||||||
.build();
|
.build();
|
||||||
// assert
|
// 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
|
// arrange
|
||||||
const expectedValue = false;
|
const expectedValue = false;
|
||||||
const browserWindow = {
|
const browserWindow: Partial<Window> = {
|
||||||
isDesktop: false,
|
isRunningAsDesktopApplication: undefined,
|
||||||
};
|
};
|
||||||
// act
|
// act
|
||||||
const sut = new BrowserRuntimeEnvironmentBuilder()
|
const sut = new BrowserRuntimeEnvironmentBuilder()
|
||||||
.withWindow(browserWindow)
|
.withWindow(browserWindow)
|
||||||
.build();
|
.build();
|
||||||
// assert
|
// assert
|
||||||
expect(sut.isDesktop).to.equal(expectedValue);
|
expect(sut.isRunningAsDesktopApplication).to.equal(expectedValue);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('os', () => {
|
describe('os', () => {
|
||||||
@@ -112,47 +112,6 @@ describe('BrowserRuntimeEnvironment', () => {
|
|||||||
// assert
|
// assert
|
||||||
expect(actual).to.equal(expected);
|
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', () => {
|
describe('isNonProduction', () => {
|
||||||
[true, false].forEach((value) => {
|
[true, false].forEach((value) => {
|
||||||
|
|||||||
@@ -62,14 +62,14 @@ describe('NodeRuntimeEnvironment', () => {
|
|||||||
expect(environment.os).to.equal(expectedOs);
|
expect(environment.os).to.equal(expectedOs);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('isDesktop', () => {
|
describe('isRunningAsDesktopApplication', () => {
|
||||||
it('is always true', () => {
|
it('is always true', () => {
|
||||||
// arrange
|
// arrange
|
||||||
const expectedDesktopCondition = true;
|
const expectedDesktopCondition = true;
|
||||||
// act
|
// act
|
||||||
const environment = new NodeRuntimeEnvironment();
|
const environment = new NodeRuntimeEnvironment();
|
||||||
/// assert
|
/// assert
|
||||||
expect(environment.isDesktop).to.equal(expectedDesktopCondition);
|
expect(environment.isRunningAsDesktopApplication).to.equal(expectedDesktopCondition);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('isNonProduction', () => {
|
describe('isNonProduction', () => {
|
||||||
|
|||||||
@@ -1,73 +1,95 @@
|
|||||||
import { describe, it, expect } from 'vitest';
|
import { describe, it, expect } from 'vitest';
|
||||||
import {
|
import {
|
||||||
BrowserRuntimeEnvironmentFactory, NodeRuntimeEnvironmentFactory,
|
BrowserRuntimeEnvironmentFactory, GlobalPropertiesAccessor, NodeRuntimeEnvironmentFactory,
|
||||||
GlobalAccessor as GlobalPropertiesAccessor, determineAndCreateRuntimeEnvironment,
|
determineAndCreateRuntimeEnvironment,
|
||||||
} from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
} from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
|
||||||
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
|
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
|
||||||
|
|
||||||
describe('RuntimeEnvironmentFactory', () => {
|
describe('RuntimeEnvironmentFactory', () => {
|
||||||
describe('determineAndCreateRuntimeEnvironment', () => {
|
describe('determineAndCreateRuntimeEnvironment', () => {
|
||||||
it('uses browser environment when window exists', () => {
|
describe('Node environment creation', () => {
|
||||||
|
it('selects Node environment if Electron main process detected', () => {
|
||||||
// arrange
|
// arrange
|
||||||
|
const processStub = createProcessStub({
|
||||||
|
versions: {
|
||||||
|
electron: '28.1.3',
|
||||||
|
} as NodeJS.ProcessVersions,
|
||||||
|
});
|
||||||
const expectedEnvironment = new RuntimeEnvironmentStub();
|
const expectedEnvironment = new RuntimeEnvironmentStub();
|
||||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||||
.withWindowAccessor(() => createWindowStub())
|
.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);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
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);
|
.withBrowserEnvironmentFactory(() => expectedEnvironment);
|
||||||
// act
|
// act
|
||||||
const actualEnvironment = context.buildEnvironment();
|
const actualEnvironment = context.buildEnvironment();
|
||||||
// assert
|
// assert
|
||||||
expect(actualEnvironment).to.equal(expectedEnvironment);
|
expect(actualEnvironment).to.equal(expectedEnvironment);
|
||||||
});
|
});
|
||||||
|
it('passes correct window to browser environment factory', () => {
|
||||||
it('passes correct window to browser environment', () => {
|
|
||||||
// arrange
|
// arrange
|
||||||
const expectedWindow = createWindowStub();
|
const expectedWindow = createWindowStub({
|
||||||
let actualWindow: Window | undefined;
|
isRunningAsDesktopApplication: undefined,
|
||||||
const browserEnvironmentFactoryMock: BrowserRuntimeEnvironmentFactory = (providedWindow) => {
|
});
|
||||||
|
let actualWindow: GlobalWindow;
|
||||||
|
const browserEnvironmentFactoryMock
|
||||||
|
: BrowserRuntimeEnvironmentFactory = (providedWindow) => {
|
||||||
actualWindow = providedWindow;
|
actualWindow = providedWindow;
|
||||||
return new RuntimeEnvironmentStub();
|
return new RuntimeEnvironmentStub();
|
||||||
};
|
};
|
||||||
|
const undefinedProcess: GlobalProcess = undefined;
|
||||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||||
.withWindowAccessor(() => expectedWindow)
|
.withGlobalWindow(expectedWindow)
|
||||||
|
.withGlobalProcess(undefinedProcess)
|
||||||
.withBrowserEnvironmentFactory(browserEnvironmentFactoryMock);
|
.withBrowserEnvironmentFactory(browserEnvironmentFactoryMock);
|
||||||
// act
|
// act
|
||||||
context.buildEnvironment();
|
context.buildEnvironment();
|
||||||
// assert
|
// assert
|
||||||
expect(actualWindow).to.equal(expectedWindow);
|
expect(actualWindow).to.equal(expectedWindow);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('uses node environment when window is absent', () => {
|
|
||||||
// arrange
|
|
||||||
const expectedEnvironment = new RuntimeEnvironmentStub();
|
|
||||||
const context = new RuntimeEnvironmentFactoryTestSetup()
|
|
||||||
.withWindowAccessor(() => undefined)
|
|
||||||
.withProcessAccessor(() => createProcessStub())
|
|
||||||
.withNodeEnvironmentFactory(() => expectedEnvironment);
|
|
||||||
// act
|
|
||||||
const actualEnvironment = context.buildEnvironment();
|
|
||||||
// assert
|
|
||||||
expect(actualEnvironment).to.equal(expectedEnvironment);
|
|
||||||
});
|
});
|
||||||
|
it('throws error when both window and process are undefined', () => {
|
||||||
it('uses node environment when window is present too', () => { // This allows running integration tests
|
|
||||||
// arrange
|
// 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()
|
const context = new RuntimeEnvironmentFactoryTestSetup()
|
||||||
.withWindowAccessor(() => createWindowStub())
|
.withGlobalProcess(undefinedProcess)
|
||||||
.withProcessAccessor(() => createProcessStub())
|
.withGlobalWindow(undefinedWindow);
|
||||||
.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);
|
|
||||||
// act
|
// act
|
||||||
const act = () => context.buildEnvironment();
|
const act = () => context.buildEnvironment();
|
||||||
// assert
|
// assert
|
||||||
@@ -76,22 +98,22 @@ describe('RuntimeEnvironmentFactory', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
function createWindowStub(): Window {
|
function createWindowStub(partialWindowProperties?: Partial<Window>): Window {
|
||||||
return {} as Window;
|
return {
|
||||||
|
...partialWindowProperties,
|
||||||
|
} as Window;
|
||||||
}
|
}
|
||||||
|
|
||||||
function createProcessStub(): NodeJS.Process {
|
function createProcessStub(partialProcessProperties?: Partial<NodeJS.Process>): NodeJS.Process {
|
||||||
return {} as NodeJS.Process;
|
return {
|
||||||
|
...partialProcessProperties,
|
||||||
|
} as NodeJS.Process;
|
||||||
}
|
}
|
||||||
|
|
||||||
type WindowAccessor = GlobalPropertiesAccessor['getGlobalWindow'];
|
|
||||||
|
|
||||||
type ProcessAccessor = GlobalPropertiesAccessor['getGlobalProcess'];
|
|
||||||
|
|
||||||
export class RuntimeEnvironmentFactoryTestSetup {
|
export class RuntimeEnvironmentFactoryTestSetup {
|
||||||
private windowAccessor: WindowAccessor = () => undefined;
|
private globalWindow: GlobalWindow = createWindowStub();
|
||||||
|
|
||||||
private processAccessor: ProcessAccessor = () => undefined;
|
private globalProcess: GlobalProcess = createProcessStub();
|
||||||
|
|
||||||
private browserEnvironmentFactory
|
private browserEnvironmentFactory
|
||||||
: BrowserRuntimeEnvironmentFactory = () => new RuntimeEnvironmentStub();
|
: BrowserRuntimeEnvironmentFactory = () => new RuntimeEnvironmentStub();
|
||||||
@@ -99,13 +121,13 @@ export class RuntimeEnvironmentFactoryTestSetup {
|
|||||||
private nodeEnvironmentFactory
|
private nodeEnvironmentFactory
|
||||||
: NodeRuntimeEnvironmentFactory = () => new RuntimeEnvironmentStub();
|
: NodeRuntimeEnvironmentFactory = () => new RuntimeEnvironmentStub();
|
||||||
|
|
||||||
public withWindowAccessor(windowAccessor: WindowAccessor): this {
|
public withGlobalWindow(globalWindow: GlobalWindow): this {
|
||||||
this.windowAccessor = windowAccessor;
|
this.globalWindow = globalWindow;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
public withProcessAccessor(processAccessor: ProcessAccessor): this {
|
public withGlobalProcess(globalProcess: GlobalProcess): this {
|
||||||
this.processAccessor = processAccessor;
|
this.globalProcess = globalProcess;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -126,11 +148,15 @@ export class RuntimeEnvironmentFactoryTestSetup {
|
|||||||
public buildEnvironment(): ReturnType<typeof determineAndCreateRuntimeEnvironment> {
|
public buildEnvironment(): ReturnType<typeof determineAndCreateRuntimeEnvironment> {
|
||||||
return determineAndCreateRuntimeEnvironment(
|
return determineAndCreateRuntimeEnvironment(
|
||||||
{
|
{
|
||||||
getGlobalProcess: this.processAccessor,
|
window: this.globalWindow,
|
||||||
getGlobalWindow: this.windowAccessor,
|
process: this.globalProcess,
|
||||||
},
|
},
|
||||||
this.browserEnvironmentFactory,
|
this.browserEnvironmentFactory,
|
||||||
this.nodeEnvironmentFactory,
|
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 { getAbsentObjectTestCases, itEachAbsentObjectValue } from '@tests/unit/shared/TestCases/AbsentTests';
|
||||||
import { WindowVariablesStub } from '@tests/unit/shared/Stubs/WindowVariablesStub';
|
import { WindowVariablesStub } from '@tests/unit/shared/Stubs/WindowVariablesStub';
|
||||||
import { CodeRunnerStub } from '@tests/unit/shared/Stubs/CodeRunnerStub';
|
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('WindowVariablesValidator', () => {
|
||||||
describe('validateWindowVariables', () => {
|
describe('validateWindowVariables', () => {
|
||||||
@@ -24,20 +27,20 @@ describe('WindowVariablesValidator', () => {
|
|||||||
it('throws an error with a description of all invalid properties', () => {
|
it('throws an error with a description of all invalid properties', () => {
|
||||||
// arrange
|
// arrange
|
||||||
const invalidOs = 'invalid' as unknown as OperatingSystem;
|
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(
|
const expectedError = getExpectedError(
|
||||||
{
|
{
|
||||||
name: 'os',
|
name: 'os',
|
||||||
object: invalidOs,
|
object: invalidOs,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'isDesktop',
|
name: 'isRunningAsDesktopApplication',
|
||||||
object: invalidIsDesktop,
|
object: invalidIsRunningAsDesktopApplication,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
const input = new WindowVariablesStub()
|
const input = new WindowVariablesStub()
|
||||||
.withOs(invalidOs)
|
.withOs(invalidOs)
|
||||||
.withIsDesktop(invalidIsDesktop);
|
.withIsRunningAsDesktopApplication(invalidIsRunningAsDesktopApplication);
|
||||||
// act
|
// act
|
||||||
const act = () => validateWindowVariables(input);
|
const act = () => validateWindowVariables(input);
|
||||||
// assert
|
// assert
|
||||||
@@ -82,7 +85,7 @@ describe('WindowVariablesValidator', () => {
|
|||||||
it('does not throw for a missing os value', () => {
|
it('does not throw for a missing os value', () => {
|
||||||
// arrange
|
// arrange
|
||||||
const input = new WindowVariablesStub()
|
const input = new WindowVariablesStub()
|
||||||
.withIsDesktop(true)
|
.withIsRunningAsDesktopApplication(true)
|
||||||
.withOs(undefined);
|
.withOs(undefined);
|
||||||
// act
|
// act
|
||||||
const act = () => validateWindowVariables(input);
|
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', () => {
|
it('does not throw when true with valid services', () => {
|
||||||
// arrange
|
// arrange
|
||||||
const validCodeRunner = new CodeRunnerStub();
|
const windowVariables = new WindowVariablesStub();
|
||||||
const input = new WindowVariablesStub()
|
const windowVariableConfigurators: Record< // Ensure types match for compile-time checking
|
||||||
.withIsDesktop(true)
|
PropertyKeys<Required<WindowVariables>>,
|
||||||
.withCodeRunner(validCodeRunner);
|
(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
|
// act
|
||||||
const act = () => validateWindowVariables(input);
|
const act = () => validateWindowVariables(windowVariables);
|
||||||
// assert
|
// assert
|
||||||
expect(act).to.not.throw();
|
expect(act).to.not.throw();
|
||||||
});
|
});
|
||||||
@@ -109,7 +121,7 @@ describe('WindowVariablesValidator', () => {
|
|||||||
// arrange
|
// arrange
|
||||||
const absentCodeRunner = absentValue;
|
const absentCodeRunner = absentValue;
|
||||||
const input = new WindowVariablesStub()
|
const input = new WindowVariablesStub()
|
||||||
.withIsDesktop(false)
|
.withIsRunningAsDesktopApplication(undefined)
|
||||||
.withCodeRunner(absentCodeRunner);
|
.withCodeRunner(absentCodeRunner);
|
||||||
// act
|
// act
|
||||||
const act = () => validateWindowVariables(input);
|
const act = () => validateWindowVariables(input);
|
||||||
@@ -150,7 +162,7 @@ function expectObjectOnDesktop<T>(key: keyof WindowVariables) {
|
|||||||
});
|
});
|
||||||
const input: WindowVariables = {
|
const input: WindowVariables = {
|
||||||
...new WindowVariablesStub(),
|
...new WindowVariablesStub(),
|
||||||
isDesktop: isOnDesktop,
|
isRunningAsDesktopApplication: isOnDesktop,
|
||||||
[key]: invalidObject,
|
[key]: invalidObject,
|
||||||
};
|
};
|
||||||
// act
|
// act
|
||||||
@@ -159,14 +171,13 @@ function expectObjectOnDesktop<T>(key: keyof WindowVariables) {
|
|||||||
expect(act).to.throw(expectedError);
|
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) => {
|
itEachInvalidObjectValue((invalidObjectValue) => {
|
||||||
// arrange
|
// arrange
|
||||||
const isOnDesktop = false;
|
|
||||||
const invalidObject = invalidObjectValue as T;
|
const invalidObject = invalidObjectValue as T;
|
||||||
const input: WindowVariables = {
|
const input: WindowVariables = {
|
||||||
...new WindowVariablesStub(),
|
...new WindowVariablesStub(),
|
||||||
isDesktop: isOnDesktop,
|
isRunningAsDesktopApplication: undefined,
|
||||||
[key]: invalidObject,
|
[key]: invalidObject,
|
||||||
};
|
};
|
||||||
// act
|
// act
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ describe('DependencyProvider', () => {
|
|||||||
useUserSelectionState: createTransientTests(),
|
useUserSelectionState: createTransientTests(),
|
||||||
useLogger: createTransientTests(),
|
useLogger: createTransientTests(),
|
||||||
useCodeRunner: createTransientTests(),
|
useCodeRunner: createTransientTests(),
|
||||||
|
useDialog: createTransientTests(),
|
||||||
};
|
};
|
||||||
Object.entries(testCases).forEach(([key, runTests]) => {
|
Object.entries(testCases).forEach(([key, runTests]) => {
|
||||||
const registeredKey = InjectionKeys[key].key;
|
const registeredKey = InjectionKeys[key].key;
|
||||||
|
|||||||
@@ -245,7 +245,7 @@ function initializeDragHandlerWithMocks(mocks?: {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function createMockPointerEvent(...args: ConstructorArguments<typeof PointerEvent>): PointerEvent {
|
function createMockPointerEvent(...args: ConstructorArguments<typeof PointerEvent>): PointerEvent {
|
||||||
return new MouseEvent(...args) as PointerEvent; // JSDom does not support `PointerEvent` constructor, https://github.com/jsdom/jsdom/issues/2527
|
return new MouseEvent(...args) as PointerEvent; // jsdom does not support `PointerEvent` constructor, https://github.com/jsdom/jsdom/issues/2527
|
||||||
}
|
}
|
||||||
|
|
||||||
class DragDomModifierMock implements DragDomModifier {
|
class DragDomModifierMock implements DragDomModifier {
|
||||||
|
|||||||
@@ -0,0 +1,88 @@
|
|||||||
|
import { describe, it, expect } from 'vitest';
|
||||||
|
import { determineDialogBasedOnEnvironment, WindowDialogCreationFunction, BrowserDialogCreationFunction } from '@/presentation/components/Shared/Hooks/Dialog/ClientDialogFactory';
|
||||||
|
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
||||||
|
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
|
||||||
|
import { DialogStub } from '@tests/unit/shared/Stubs/DialogStub';
|
||||||
|
import { collectExceptionMessage } from '@tests/unit/shared/ExceptionCollector';
|
||||||
|
|
||||||
|
describe('ClientDialogFactory', () => {
|
||||||
|
describe('determineDialogBasedOnEnvironment', () => {
|
||||||
|
describe('non-desktop environment', () => {
|
||||||
|
it('returns browser dialog', () => {
|
||||||
|
// arrange
|
||||||
|
const expectedDialog = new DialogStub();
|
||||||
|
const context = new DialogCreationTestSetup()
|
||||||
|
.withEnvironment(new RuntimeEnvironmentStub().withIsRunningAsDesktopApplication(false))
|
||||||
|
.withBrowserDialogFactory(() => expectedDialog);
|
||||||
|
|
||||||
|
// act
|
||||||
|
const actualDialog = context.createDialogForTest();
|
||||||
|
|
||||||
|
// assert
|
||||||
|
expect(expectedDialog).to.equal(actualDialog);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
describe('desktop environment', () => {
|
||||||
|
it('returns window-injected dialog', () => {
|
||||||
|
// arrange
|
||||||
|
const expectedDialog = new DialogStub();
|
||||||
|
const context = new DialogCreationTestSetup()
|
||||||
|
.withEnvironment(new RuntimeEnvironmentStub().withIsRunningAsDesktopApplication(true))
|
||||||
|
.withWindowInjectedDialogFactory(() => expectedDialog);
|
||||||
|
|
||||||
|
// act
|
||||||
|
const actualDialog = context.createDialogForTest();
|
||||||
|
|
||||||
|
// assert
|
||||||
|
expect(expectedDialog).to.equal(actualDialog);
|
||||||
|
});
|
||||||
|
it('throws error when window-injected dialog is unavailable', () => {
|
||||||
|
// arrange
|
||||||
|
const expectedError = 'The Dialog API could not be retrieved from the window object.';
|
||||||
|
const context = new DialogCreationTestSetup()
|
||||||
|
.withEnvironment(new RuntimeEnvironmentStub().withIsRunningAsDesktopApplication(true))
|
||||||
|
.withWindowInjectedDialogFactory(() => undefined);
|
||||||
|
|
||||||
|
// act
|
||||||
|
const act = () => context.createDialogForTest();
|
||||||
|
|
||||||
|
// assert
|
||||||
|
const actualError = collectExceptionMessage(act);
|
||||||
|
expect(actualError).to.include(expectedError);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
class DialogCreationTestSetup {
|
||||||
|
private environment: RuntimeEnvironment = new RuntimeEnvironmentStub();
|
||||||
|
|
||||||
|
private browserDialogFactory: BrowserDialogCreationFunction = () => new DialogStub();
|
||||||
|
|
||||||
|
private windowInjectedDialogFactory: WindowDialogCreationFunction = () => new DialogStub();
|
||||||
|
|
||||||
|
public withEnvironment(environment: RuntimeEnvironment): this {
|
||||||
|
this.environment = environment;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withBrowserDialogFactory(browserDialogFactory: BrowserDialogCreationFunction): this {
|
||||||
|
this.browserDialogFactory = browserDialogFactory;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withWindowInjectedDialogFactory(
|
||||||
|
windowInjectedDialogFactory: WindowDialogCreationFunction,
|
||||||
|
): this {
|
||||||
|
this.windowInjectedDialogFactory = windowInjectedDialogFactory;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public createDialogForTest() {
|
||||||
|
return determineDialogBasedOnEnvironment(
|
||||||
|
this.environment,
|
||||||
|
this.windowInjectedDialogFactory,
|
||||||
|
this.browserDialogFactory,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
import { describe, it, expect } from 'vitest';
|
||||||
|
import { DialogFactory, useDialog } from '@/presentation/components/Shared/Hooks/Dialog/UseDialog';
|
||||||
|
import { DialogStub } from '@tests/unit/shared/Stubs/DialogStub';
|
||||||
|
|
||||||
|
describe('UseDialog', () => {
|
||||||
|
describe('useDialog', () => {
|
||||||
|
it('returns provided dialog instance', () => {
|
||||||
|
// arrange
|
||||||
|
const expectedDialog = new DialogStub();
|
||||||
|
const factoryMock: DialogFactory = () => expectedDialog;
|
||||||
|
|
||||||
|
// act
|
||||||
|
const { dialog } = useDialog(factoryMock);
|
||||||
|
|
||||||
|
// assert
|
||||||
|
expect(dialog).to.equal(expectedDialog);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
// eslint-disable-next-line max-classes-per-file
|
// eslint-disable-next-line max-classes-per-file
|
||||||
import { describe, it } from 'vitest';
|
import { describe, it } from 'vitest';
|
||||||
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
|
||||||
import { ClientLoggerFactory, LoggerCreationFunction, WindowAccessor } from '@/presentation/bootstrapping/ClientLoggerFactory';
|
|
||||||
import { Logger } from '@/application/Common/Log/Logger';
|
import { Logger } from '@/application/Common/Log/Logger';
|
||||||
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
|
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
|
||||||
import { itIsSingleton } from '@tests/unit/shared/TestCases/SingletonTests';
|
import { itIsSingleton } from '@tests/unit/shared/TestCases/SingletonTests';
|
||||||
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
||||||
|
import { ClientLoggerFactory, LoggerCreationFunction, WindowAccessor } from '@/presentation/components/Shared/Hooks/Log/ClientLoggerFactory';
|
||||||
|
|
||||||
describe('ClientLoggerFactory', () => {
|
describe('ClientLoggerFactory', () => {
|
||||||
describe('Current', () => {
|
describe('Current', () => {
|
||||||
@@ -29,7 +29,7 @@ describe('ClientLoggerFactory', () => {
|
|||||||
build: (b, expectedLogger) => b
|
build: (b, expectedLogger) => b
|
||||||
.withWindowInjectedLoggerFactory(() => expectedLogger)
|
.withWindowInjectedLoggerFactory(() => expectedLogger)
|
||||||
.withEnvironment(new RuntimeEnvironmentStub()
|
.withEnvironment(new RuntimeEnvironmentStub()
|
||||||
.withIsDesktop(true)
|
.withIsRunningAsDesktopApplication(true)
|
||||||
.withIsNonProduction(false))
|
.withIsNonProduction(false))
|
||||||
.withWindowAccessor(() => createWindowWithLogger())
|
.withWindowAccessor(() => createWindowWithLogger())
|
||||||
.build(),
|
.build(),
|
||||||
@@ -39,7 +39,7 @@ describe('ClientLoggerFactory', () => {
|
|||||||
build: (b, expectedLogger) => b
|
build: (b, expectedLogger) => b
|
||||||
.withWindowInjectedLoggerFactory(() => expectedLogger)
|
.withWindowInjectedLoggerFactory(() => expectedLogger)
|
||||||
.withEnvironment(new RuntimeEnvironmentStub()
|
.withEnvironment(new RuntimeEnvironmentStub()
|
||||||
.withIsDesktop(true)
|
.withIsRunningAsDesktopApplication(true)
|
||||||
.withIsNonProduction(true))
|
.withIsNonProduction(true))
|
||||||
.withWindowAccessor(() => createWindowWithLogger())
|
.withWindowAccessor(() => createWindowWithLogger())
|
||||||
.build(),
|
.build(),
|
||||||
@@ -49,7 +49,7 @@ describe('ClientLoggerFactory', () => {
|
|||||||
build: (b, expectedLogger) => b
|
build: (b, expectedLogger) => b
|
||||||
.withConsoleLoggerFactory(() => expectedLogger)
|
.withConsoleLoggerFactory(() => expectedLogger)
|
||||||
.withEnvironment(new RuntimeEnvironmentStub()
|
.withEnvironment(new RuntimeEnvironmentStub()
|
||||||
.withIsDesktop(false)
|
.withIsRunningAsDesktopApplication(false)
|
||||||
.withIsNonProduction(true))
|
.withIsNonProduction(true))
|
||||||
.withWindowAccessor(() => createWindowWithLogger())
|
.withWindowAccessor(() => createWindowWithLogger())
|
||||||
.build(),
|
.build(),
|
||||||
@@ -59,7 +59,7 @@ describe('ClientLoggerFactory', () => {
|
|||||||
build: (b, expectedLogger) => b
|
build: (b, expectedLogger) => b
|
||||||
.withNoopLoggerFactory(() => expectedLogger)
|
.withNoopLoggerFactory(() => expectedLogger)
|
||||||
.withEnvironment(new RuntimeEnvironmentStub()
|
.withEnvironment(new RuntimeEnvironmentStub()
|
||||||
.withIsDesktop(false)
|
.withIsRunningAsDesktopApplication(false)
|
||||||
.withIsNonProduction(false))
|
.withIsNonProduction(false))
|
||||||
.withWindowAccessor(() => createWindowWithLogger())
|
.withWindowAccessor(() => createWindowWithLogger())
|
||||||
.build(),
|
.build(),
|
||||||
@@ -68,7 +68,7 @@ describe('ClientLoggerFactory', () => {
|
|||||||
description: 'unit/integration tests environment',
|
description: 'unit/integration tests environment',
|
||||||
build: (b, expectedLogger) => b
|
build: (b, expectedLogger) => b
|
||||||
.withNoopLoggerFactory(() => expectedLogger)
|
.withNoopLoggerFactory(() => expectedLogger)
|
||||||
.withEnvironment(new RuntimeEnvironmentStub().withIsDesktop(true))
|
.withEnvironment(new RuntimeEnvironmentStub().withIsRunningAsDesktopApplication(true))
|
||||||
.withWindowAccessor(() => createWindowWithLogger(null))
|
.withWindowAccessor(() => createWindowWithLogger(null))
|
||||||
.build(),
|
.build(),
|
||||||
},
|
},
|
||||||
@@ -1,16 +1,17 @@
|
|||||||
import { describe, it, expect } from 'vitest';
|
import { describe, it, expect } from 'vitest';
|
||||||
import { useLogger } from '@/presentation/components/Shared/Hooks/UseLogger';
|
|
||||||
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
||||||
import { LoggerFactoryStub } from '@tests/unit/shared/Stubs/LoggerFactoryStub';
|
import { useLogger } from '@/presentation/components/Shared/Hooks/Log/UseLogger';
|
||||||
|
import { LoggerFactory } from '@/presentation/components/Shared/Hooks/Log/LoggerFactory';
|
||||||
|
|
||||||
describe('UseLogger', () => {
|
describe('UseLogger', () => {
|
||||||
it('returns expected logger from factory', () => {
|
it('returns expected logger from factory', () => {
|
||||||
// arrange
|
// arrange
|
||||||
const expectedLogger = new LoggerStub();
|
const expectedLogger = new LoggerStub();
|
||||||
const factory = new LoggerFactoryStub()
|
const factoryMock: LoggerFactory = {
|
||||||
.withLogger(expectedLogger);
|
logger: expectedLogger,
|
||||||
|
};
|
||||||
// act
|
// act
|
||||||
const { log: actualLogger } = useLogger(factory);
|
const { log: actualLogger } = useLogger(factoryMock);
|
||||||
// assert
|
// assert
|
||||||
expect(actualLogger).to.equal(expectedLogger);
|
expect(actualLogger).to.equal(expectedLogger);
|
||||||
});
|
});
|
||||||
@@ -1,10 +1,13 @@
|
|||||||
import { describe, it, expect } from 'vitest';
|
import { describe, it, expect } from 'vitest';
|
||||||
import { CodeRunnerStub } from '@tests/unit/shared/Stubs/CodeRunnerStub';
|
import { CodeRunnerStub } from '@tests/unit/shared/Stubs/CodeRunnerStub';
|
||||||
import { IpcChannelDefinitions } from '@/presentation/electron/shared/IpcBridging/IpcChannelDefinitions';
|
import { ChannelDefinitionKey, IpcChannelDefinitions } from '@/presentation/electron/shared/IpcBridging/IpcChannelDefinitions';
|
||||||
import { CodeRunnerFactory, IpcRegistrar, registerAllIpcChannels } from '@/presentation/electron/main/IpcRegistration';
|
import {
|
||||||
|
CodeRunnerFactory, DialogFactory, IpcChannelRegistrar, registerAllIpcChannels,
|
||||||
|
} from '@/presentation/electron/main/IpcRegistration';
|
||||||
import { IpcChannel } from '@/presentation/electron/shared/IpcBridging/IpcChannel';
|
import { IpcChannel } from '@/presentation/electron/shared/IpcBridging/IpcChannel';
|
||||||
import { expectExists } from '@tests/shared/Assertions/ExpectExists';
|
import { expectExists } from '@tests/shared/Assertions/ExpectExists';
|
||||||
import { collectExceptionMessage } from '@tests/unit/shared/ExceptionCollector';
|
import { collectExceptionMessage } from '@tests/unit/shared/ExceptionCollector';
|
||||||
|
import { DialogStub } from '@tests/unit/shared/Stubs/DialogStub';
|
||||||
|
|
||||||
describe('IpcRegistration', () => {
|
describe('IpcRegistration', () => {
|
||||||
describe('registerAllIpcChannels', () => {
|
describe('registerAllIpcChannels', () => {
|
||||||
@@ -23,7 +26,7 @@ describe('IpcRegistration', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
describe('registers expected instances', () => {
|
describe('registers expected instances', () => {
|
||||||
const testScenarios: Record<keyof typeof IpcChannelDefinitions, {
|
const testScenarios: Record<ChannelDefinitionKey, {
|
||||||
buildContext: (context: IpcRegistrationTestSetup) => IpcRegistrationTestSetup,
|
buildContext: (context: IpcRegistrationTestSetup) => IpcRegistrationTestSetup,
|
||||||
expectedInstance: object,
|
expectedInstance: object,
|
||||||
}> = {
|
}> = {
|
||||||
@@ -34,6 +37,13 @@ describe('IpcRegistration', () => {
|
|||||||
expectedInstance,
|
expectedInstance,
|
||||||
};
|
};
|
||||||
})(),
|
})(),
|
||||||
|
Dialog: (() => {
|
||||||
|
const expectedInstance = new DialogStub();
|
||||||
|
return {
|
||||||
|
buildContext: (c) => c.withDialogFactory(() => expectedInstance),
|
||||||
|
expectedInstance,
|
||||||
|
};
|
||||||
|
})(),
|
||||||
};
|
};
|
||||||
Object.entries(testScenarios).forEach(([
|
Object.entries(testScenarios).forEach(([
|
||||||
key, { buildContext, expectedInstance },
|
key, { buildContext, expectedInstance },
|
||||||
@@ -46,7 +56,8 @@ describe('IpcRegistration', () => {
|
|||||||
// act
|
// act
|
||||||
context.run();
|
context.run();
|
||||||
// assert
|
// assert
|
||||||
const actualInstance = getRegisteredInstance(IpcChannelDefinitions.CodeRunner);
|
const channel = IpcChannelDefinitions[key];
|
||||||
|
const actualInstance = getRegisteredInstance(channel);
|
||||||
expect(actualInstance).to.equal(expectedInstance);
|
expect(actualInstance).to.equal(expectedInstance);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -54,7 +65,7 @@ describe('IpcRegistration', () => {
|
|||||||
it('throws an error if registration fails', () => {
|
it('throws an error if registration fails', () => {
|
||||||
// arrange
|
// arrange
|
||||||
const expectedError = 'registrar error';
|
const expectedError = 'registrar error';
|
||||||
const registrarMock: IpcRegistrar = () => {
|
const registrarMock: IpcChannelRegistrar = () => {
|
||||||
throw new Error(expectedError);
|
throw new Error(expectedError);
|
||||||
};
|
};
|
||||||
const context = new IpcRegistrationTestSetup()
|
const context = new IpcRegistrationTestSetup()
|
||||||
@@ -70,9 +81,11 @@ describe('IpcRegistration', () => {
|
|||||||
class IpcRegistrationTestSetup {
|
class IpcRegistrationTestSetup {
|
||||||
private codeRunnerFactory: CodeRunnerFactory = () => new CodeRunnerStub();
|
private codeRunnerFactory: CodeRunnerFactory = () => new CodeRunnerStub();
|
||||||
|
|
||||||
private registrar: IpcRegistrar = () => { /* NOOP */ };
|
private dialogFactory: DialogFactory = () => new DialogStub();
|
||||||
|
|
||||||
public withRegistrar(registrar: IpcRegistrar): this {
|
private registrar: IpcChannelRegistrar = () => { /* NOOP */ };
|
||||||
|
|
||||||
|
public withRegistrar(registrar: IpcChannelRegistrar): this {
|
||||||
this.registrar = registrar;
|
this.registrar = registrar;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -82,26 +95,37 @@ class IpcRegistrationTestSetup {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public withDialogFactory(dialogFactory: DialogFactory): this {
|
||||||
|
this.dialogFactory = dialogFactory;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
public run() {
|
public run() {
|
||||||
registerAllIpcChannels(
|
registerAllIpcChannels(
|
||||||
this.codeRunnerFactory,
|
this.codeRunnerFactory,
|
||||||
|
this.dialogFactory,
|
||||||
this.registrar,
|
this.registrar,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type DefinedIpcChannelTypes = {
|
||||||
|
[K in ChannelDefinitionKey]: (typeof IpcChannelDefinitions)[K]
|
||||||
|
}[ChannelDefinitionKey];
|
||||||
|
|
||||||
function createIpcRegistrarMock() {
|
function createIpcRegistrarMock() {
|
||||||
const registeredChannels = new Array<Parameters<IpcRegistrar>>();
|
const registeredChannels = new Array<Parameters<IpcChannelRegistrar>>();
|
||||||
const registrarMock: IpcRegistrar = <T>(channel: IpcChannel<T>, obj: T) => {
|
const registrarMock: IpcChannelRegistrar = <T>(channel: IpcChannel<T>, obj: T) => {
|
||||||
registeredChannels.push([channel as IpcChannel<unknown>, obj]);
|
registeredChannels.push([channel as IpcChannel<unknown>, obj]);
|
||||||
};
|
};
|
||||||
const isChannelRegistered = <T>(channel: IpcChannel<T>): boolean => {
|
const isChannelRegistered = (channel: DefinedIpcChannelTypes): boolean => {
|
||||||
return registeredChannels.some((i) => i[0] === channel);
|
return registeredChannels.some((i) => i[0] === channel);
|
||||||
};
|
};
|
||||||
const getRegisteredInstance = <T>(channel: IpcChannel<T>): unknown => {
|
const getRegisteredInstance = <T>(channel: IpcChannel<T>): T => {
|
||||||
const registration = registeredChannels.find((i) => i[0] === channel);
|
const registration = registeredChannels.find((i) => i[0] === channel);
|
||||||
expectExists(registration);
|
expectExists(registration);
|
||||||
return registration[1];
|
const [, registeredInstance] = registration;
|
||||||
|
return registeredInstance as T;
|
||||||
};
|
};
|
||||||
return {
|
return {
|
||||||
registrarMock,
|
registrarMock,
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ describe('RendererApiProvider', () => {
|
|||||||
readonly expectedValue: unknown;
|
readonly expectedValue: unknown;
|
||||||
}
|
}
|
||||||
const testScenarios: Record<PropertyKeys<Required<WindowVariables>>, WindowVariableTestCase> = {
|
const testScenarios: Record<PropertyKeys<Required<WindowVariables>>, WindowVariableTestCase> = {
|
||||||
isDesktop: {
|
isRunningAsDesktopApplication: {
|
||||||
description: 'returns true',
|
description: 'returns true',
|
||||||
setupContext: (context) => context,
|
setupContext: (context) => context,
|
||||||
expectedValue: true,
|
expectedValue: true,
|
||||||
@@ -34,6 +34,7 @@ describe('RendererApiProvider', () => {
|
|||||||
instance: new LoggerStub(),
|
instance: new LoggerStub(),
|
||||||
setupContext: (c, logger) => c.withLogger(logger),
|
setupContext: (c, logger) => c.withLogger(logger),
|
||||||
}),
|
}),
|
||||||
|
dialog: expectIpcConsumer(IpcChannelDefinitions.Dialog),
|
||||||
};
|
};
|
||||||
Object.entries(testScenarios).forEach((
|
Object.entries(testScenarios).forEach((
|
||||||
[property, { description, setupContext, expectedValue }],
|
[property, { description, setupContext, expectedValue }],
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
import { describe, it, expect } from 'vitest';
|
import { describe, it, expect } from 'vitest';
|
||||||
import { IpcChannel } from '@/presentation/electron/shared/IpcBridging/IpcChannel';
|
import { IpcChannel } from '@/presentation/electron/shared/IpcBridging/IpcChannel';
|
||||||
import { IpcChannelDefinitions } from '@/presentation/electron/shared/IpcBridging/IpcChannelDefinitions';
|
import { ChannelDefinitionKey, IpcChannelDefinitions } from '@/presentation/electron/shared/IpcBridging/IpcChannelDefinitions';
|
||||||
|
|
||||||
describe('IpcChannelDefinitions', () => {
|
describe('IpcChannelDefinitions', () => {
|
||||||
it('defines IPC channels correctly', () => {
|
it('defines IPC channels correctly', () => {
|
||||||
const testScenarios: Record<keyof typeof IpcChannelDefinitions, {
|
const testScenarios: Record<ChannelDefinitionKey, {
|
||||||
readonly expectedNamespace: string;
|
readonly expectedNamespace: string;
|
||||||
readonly expectedAccessibleMembers: readonly string[];
|
readonly expectedAccessibleMembers: readonly string[];
|
||||||
}> = {
|
}> = {
|
||||||
@@ -12,6 +12,10 @@ describe('IpcChannelDefinitions', () => {
|
|||||||
expectedNamespace: 'code-run',
|
expectedNamespace: 'code-run',
|
||||||
expectedAccessibleMembers: ['runCode'],
|
expectedAccessibleMembers: ['runCode'],
|
||||||
},
|
},
|
||||||
|
Dialog: {
|
||||||
|
expectedNamespace: 'dialogs',
|
||||||
|
expectedAccessibleMembers: ['saveFile'],
|
||||||
|
},
|
||||||
};
|
};
|
||||||
Object.entries(testScenarios).forEach((
|
Object.entries(testScenarios).forEach((
|
||||||
[definitionKey, { expectedNamespace, expectedAccessibleMembers }],
|
[definitionKey, { expectedNamespace, expectedAccessibleMembers }],
|
||||||
@@ -49,7 +53,7 @@ describe('IpcChannelDefinitions', () => {
|
|||||||
it('has unique accessible members within each channel', () => {
|
it('has unique accessible members within each channel', () => {
|
||||||
Object.values(IpcChannelDefinitions).forEach((channel) => {
|
Object.values(IpcChannelDefinitions).forEach((channel) => {
|
||||||
// arrange
|
// arrange
|
||||||
const { accessibleMembers: accessibleMembersOfChannel } = channel;
|
const accessibleMembersOfChannel = channel.accessibleMembers as string[];
|
||||||
// act
|
// act
|
||||||
const repeatedAccessibleMembersInChannel = accessibleMembersOfChannel
|
const repeatedAccessibleMembersInChannel = accessibleMembersOfChannel
|
||||||
.filter((item, index) => accessibleMembersOfChannel.indexOf(item) !== index);
|
.filter((item, index) => accessibleMembersOfChannel.indexOf(item) !== index);
|
||||||
|
|||||||
@@ -215,6 +215,7 @@ describe('IpcProxy', () => {
|
|||||||
expect(actualChannelNames).to.have.lengthOf(expectedChannelNames.length);
|
expect(actualChannelNames).to.have.lengthOf(expectedChannelNames.length);
|
||||||
expect(actualChannelNames).to.have.members(expectedChannelNames);
|
expect(actualChannelNames).to.have.members(expectedChannelNames);
|
||||||
});
|
});
|
||||||
|
describe('validation', () => {
|
||||||
it('throws error for non-function members', () => {
|
it('throws error for non-function members', () => {
|
||||||
// arrange
|
// arrange
|
||||||
const expectedError = 'Non-function members are not yet supported';
|
const expectedError = 'Non-function members are not yet supported';
|
||||||
@@ -229,6 +230,21 @@ describe('IpcProxy', () => {
|
|||||||
// assert
|
// assert
|
||||||
expect(act).to.throw(expectedError);
|
expect(act).to.throw(expectedError);
|
||||||
});
|
});
|
||||||
|
it('throws error for undefined members', () => {
|
||||||
|
// arrange
|
||||||
|
const nonExistingFunctionName = 'nonExistingFunction';
|
||||||
|
const expectedError = `The function "${nonExistingFunctionName}" is not found on the target object.`;
|
||||||
|
const testObject = { };
|
||||||
|
const testIpcChannel: IpcChannel<typeof testObject> = {
|
||||||
|
namespace: 'testNamespace',
|
||||||
|
accessibleMembers: [nonExistingFunctionName] as never,
|
||||||
|
};
|
||||||
|
// act
|
||||||
|
const act = () => registerIpcChannel(testIpcChannel, testObject, mockIpcMain().ipcMainMock);
|
||||||
|
// assert
|
||||||
|
expect(act).to.throw(expectedError);
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
7
tests/unit/shared/Stubs/DialogStub.ts
Normal file
7
tests/unit/shared/Stubs/DialogStub.ts
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
import { Dialog } from '@/presentation/common/Dialog';
|
||||||
|
|
||||||
|
export class DialogStub implements Dialog {
|
||||||
|
public saveFile(): Promise<void> {
|
||||||
|
return Promise.resolve();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -4,7 +4,7 @@ import { OperatingSystem } from '@/domain/OperatingSystem';
|
|||||||
export class RuntimeEnvironmentStub implements RuntimeEnvironment {
|
export class RuntimeEnvironmentStub implements RuntimeEnvironment {
|
||||||
public isNonProduction = true;
|
public isNonProduction = true;
|
||||||
|
|
||||||
public isDesktop = true;
|
public isRunningAsDesktopApplication = false;
|
||||||
|
|
||||||
public os: OperatingSystem | undefined = OperatingSystem.Windows;
|
public os: OperatingSystem | undefined = OperatingSystem.Windows;
|
||||||
|
|
||||||
@@ -13,8 +13,8 @@ export class RuntimeEnvironmentStub implements RuntimeEnvironment {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
public withIsDesktop(isDesktop: boolean): this {
|
public withIsRunningAsDesktopApplication(isRunningAsDesktopApplication: boolean): this {
|
||||||
this.isDesktop = isDesktop;
|
this.isRunningAsDesktopApplication = isRunningAsDesktopApplication;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,25 +2,34 @@ import { OperatingSystem } from '@/domain/OperatingSystem';
|
|||||||
import { Logger } from '@/application/Common/Log/Logger';
|
import { Logger } from '@/application/Common/Log/Logger';
|
||||||
import { WindowVariables } from '@/infrastructure/WindowVariables/WindowVariables';
|
import { WindowVariables } from '@/infrastructure/WindowVariables/WindowVariables';
|
||||||
import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
|
import { CodeRunner } from '@/application/CodeRunner/CodeRunner';
|
||||||
|
import { Dialog } from '@/presentation/common/Dialog';
|
||||||
import { LoggerStub } from './LoggerStub';
|
import { LoggerStub } from './LoggerStub';
|
||||||
import { CodeRunnerStub } from './CodeRunnerStub';
|
import { CodeRunnerStub } from './CodeRunnerStub';
|
||||||
|
import { DialogStub } from './DialogStub';
|
||||||
|
|
||||||
export class WindowVariablesStub implements WindowVariables {
|
export class WindowVariablesStub implements WindowVariables {
|
||||||
public codeRunner?: CodeRunner = new CodeRunnerStub();
|
public codeRunner?: CodeRunner = new CodeRunnerStub();
|
||||||
|
|
||||||
public isDesktop = false;
|
public isRunningAsDesktopApplication: true | undefined = true;
|
||||||
|
|
||||||
public os?: OperatingSystem = OperatingSystem.BlackBerryOS;
|
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 {
|
public withLog(log: Logger): this {
|
||||||
this.log = log;
|
this.log = log;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
public withIsDesktop(value: boolean): this {
|
public withDialog(dialog: Dialog): this {
|
||||||
this.isDesktop = value;
|
this.dialog = dialog;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public withIsRunningAsDesktopApplication(isRunningAsDesktopApplication: true | undefined): this {
|
||||||
|
this.isRunningAsDesktopApplication = isRunningAsDesktopApplication;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user