Fix script deletion during execution on desktop
This commit fixes an issue seen on certain Windows environments (Windows 10 22H2 and 11 23H2 Pro Azure VMs) where scripts were being deleted during execution due to temporary directory usage. To resolve this, scripts are now stored in a persistent directory, enhancing reliability for long-running scripts and improving auditability along with troubleshooting. Key changes: - Move script execution logic to the `main` process from `preloader` to utilize Electron's `app.getPath`. - Improve runtime environment detection for non-browser environments to allow its usage in Electron main process. - Introduce a secure module to expose IPC channels from the main process to the renderer via the preloader process. Supporting refactorings include: - Simplify `CodeRunner` interface by removing the `tempScriptFolderName` parameter. - Rename `NodeSystemOperations` to `NodeElectronSystemOperations` as it now wraps electron APIs too, and convert it to class for simplicity. - Rename `TemporaryFileCodeRunner` to `ScriptFileCodeRunner` to reflect its new functinoality. - Rename `SystemOperations` folder to `System` for simplicity. - Rename `HostRuntimeEnvironment` to `BrowserRuntimeEnvironment` for clarity. - Refactor main Electron process configuration to align with latest Electron documentation/recommendations. - Refactor unit tests `BrowserRuntimeEnvironment` to simplify singleton workaround. - Use alias imports like `electron/main` and `electron/common` for better clarity.
This commit is contained in:
@@ -0,0 +1,16 @@
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
|
||||
export enum TouchSupportExpectation {
|
||||
MustExist,
|
||||
MustNotExist,
|
||||
}
|
||||
|
||||
export interface BrowserCondition {
|
||||
readonly operatingSystem: OperatingSystem;
|
||||
|
||||
readonly existingPartsInSameUserAgent: readonly string[];
|
||||
|
||||
readonly notExistingPartsInUserAgent?: readonly string[];
|
||||
|
||||
readonly touchSupport?: TouchSupportExpectation;
|
||||
}
|
||||
@@ -0,0 +1,87 @@
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import { BrowserCondition, TouchSupportExpectation } from './BrowserCondition';
|
||||
|
||||
// They include "Android", "iPhone" in their user agents.
|
||||
const WindowsMobileIdentifiers: readonly string[] = [
|
||||
'Windows Phone',
|
||||
'Windows Mobile',
|
||||
] as const;
|
||||
|
||||
export const BrowserConditions: readonly BrowserCondition[] = [
|
||||
{
|
||||
operatingSystem: OperatingSystem.KaiOS,
|
||||
existingPartsInSameUserAgent: ['KAIOS'],
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.ChromeOS,
|
||||
existingPartsInSameUserAgent: ['CrOS'],
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.BlackBerryOS,
|
||||
existingPartsInSameUserAgent: ['BlackBerry'],
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.BlackBerryTabletOS,
|
||||
existingPartsInSameUserAgent: ['RIM Tablet OS'],
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.BlackBerry10,
|
||||
existingPartsInSameUserAgent: ['BB10'],
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.Android,
|
||||
existingPartsInSameUserAgent: ['Android'],
|
||||
notExistingPartsInUserAgent: [...WindowsMobileIdentifiers],
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.Android,
|
||||
existingPartsInSameUserAgent: ['Adr'],
|
||||
notExistingPartsInUserAgent: [...WindowsMobileIdentifiers],
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.iOS,
|
||||
existingPartsInSameUserAgent: ['iPhone'],
|
||||
notExistingPartsInUserAgent: [...WindowsMobileIdentifiers],
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.iOS,
|
||||
existingPartsInSameUserAgent: ['iPod'],
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.iPadOS,
|
||||
existingPartsInSameUserAgent: ['iPad'],
|
||||
// On Safari, only for older iPads running ≤ iOS 12 reports `iPad`
|
||||
// Other browsers report `iPad` both for older devices (≤ iOS 12) and newer (≥ iPadOS 13)
|
||||
// We detect all as `iPadOS` for simplicity.
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.iPadOS,
|
||||
existingPartsInSameUserAgent: ['Macintosh'], // Reported by Safari on iPads running ≥ iPadOS 13
|
||||
notExistingPartsInUserAgent: ['Electron'], // Electron supports only macOS, not iPadOS
|
||||
touchSupport: TouchSupportExpectation.MustExist, // Safari same user agent as desktop macOS
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.Linux,
|
||||
existingPartsInSameUserAgent: ['Linux'],
|
||||
notExistingPartsInUserAgent: ['Android', 'Adr'],
|
||||
},
|
||||
{
|
||||
operatingSystem: OperatingSystem.Windows,
|
||||
existingPartsInSameUserAgent: ['Windows'],
|
||||
notExistingPartsInUserAgent: [...WindowsMobileIdentifiers],
|
||||
},
|
||||
...['Windows Phone OS', 'Windows Phone 8'].map((userAgentPart) => ({
|
||||
operatingSystem: OperatingSystem.WindowsPhone,
|
||||
existingPartsInSameUserAgent: [userAgentPart],
|
||||
})),
|
||||
...['Windows Mobile', 'Windows Phone 10'].map((userAgentPart) => ({
|
||||
operatingSystem: OperatingSystem.Windows10Mobile,
|
||||
existingPartsInSameUserAgent: [userAgentPart],
|
||||
})),
|
||||
{
|
||||
operatingSystem: OperatingSystem.macOS,
|
||||
existingPartsInSameUserAgent: ['Macintosh'],
|
||||
notExistingPartsInUserAgent: ['like Mac OS X'], // Eliminate iOS and iPadOS for Safari
|
||||
touchSupport: TouchSupportExpectation.MustNotExist, // Distinguish from iPadOS for Safari
|
||||
},
|
||||
] as const;
|
||||
@@ -0,0 +1,10 @@
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
|
||||
export interface BrowserEnvironment {
|
||||
readonly isTouchSupported: boolean;
|
||||
readonly userAgent: string;
|
||||
}
|
||||
|
||||
export interface BrowserOsDetector {
|
||||
detect(environment: BrowserEnvironment): OperatingSystem | undefined;
|
||||
}
|
||||
@@ -0,0 +1,92 @@
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import { assertInRange } from '@/application/Common/Enum';
|
||||
import { BrowserEnvironment, BrowserOsDetector } from './BrowserOsDetector';
|
||||
import { BrowserCondition, TouchSupportExpectation } from './BrowserCondition';
|
||||
import { BrowserConditions } from './BrowserConditions';
|
||||
|
||||
export class ConditionBasedOsDetector implements BrowserOsDetector {
|
||||
constructor(private readonly conditions: readonly BrowserCondition[] = BrowserConditions) {
|
||||
validateConditions(conditions);
|
||||
}
|
||||
|
||||
public detect(environment: BrowserEnvironment): OperatingSystem | undefined {
|
||||
if (!environment.userAgent) {
|
||||
return undefined;
|
||||
}
|
||||
for (const condition of this.conditions) {
|
||||
if (satisfiesCondition(condition, environment)) {
|
||||
return condition.operatingSystem;
|
||||
}
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
|
||||
function satisfiesCondition(
|
||||
condition: BrowserCondition,
|
||||
browserEnvironment: BrowserEnvironment,
|
||||
): boolean {
|
||||
const { userAgent } = browserEnvironment;
|
||||
if (condition.touchSupport !== undefined) {
|
||||
if (!satisfiesTouchExpectation(condition.touchSupport, browserEnvironment)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
if (condition.existingPartsInSameUserAgent.some((part) => !userAgent.includes(part))) {
|
||||
return false;
|
||||
}
|
||||
if (condition.notExistingPartsInUserAgent?.some((part) => userAgent.includes(part))) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
function satisfiesTouchExpectation(
|
||||
expectation: TouchSupportExpectation,
|
||||
browserEnvironment: BrowserEnvironment,
|
||||
): boolean {
|
||||
switch (expectation) {
|
||||
case TouchSupportExpectation.MustExist:
|
||||
if (!browserEnvironment.isTouchSupported) {
|
||||
return false;
|
||||
}
|
||||
break;
|
||||
case TouchSupportExpectation.MustNotExist:
|
||||
if (browserEnvironment.isTouchSupported) {
|
||||
return false;
|
||||
}
|
||||
break;
|
||||
default:
|
||||
throw new Error(`Unsupported touch support expectation: ${TouchSupportExpectation[expectation]}`);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
function validateConditions(conditions: readonly BrowserCondition[]) {
|
||||
if (!conditions.length) {
|
||||
throw new Error('empty conditions');
|
||||
}
|
||||
for (const condition of conditions) {
|
||||
validateCondition(condition);
|
||||
}
|
||||
}
|
||||
|
||||
function validateCondition(condition: BrowserCondition) {
|
||||
if (!condition.existingPartsInSameUserAgent.length) {
|
||||
throw new Error('Each condition must include at least one identifiable part of the user agent string.');
|
||||
}
|
||||
const duplicates = getDuplicates([
|
||||
...condition.existingPartsInSameUserAgent,
|
||||
...(condition.notExistingPartsInUserAgent ?? []),
|
||||
]);
|
||||
if (duplicates.length > 0) {
|
||||
throw new Error(`Found duplicate entries in user agent parts: ${duplicates.join(', ')}. Each part should be unique.`);
|
||||
}
|
||||
if (condition.touchSupport !== undefined) {
|
||||
assertInRange(condition.touchSupport, TouchSupportExpectation);
|
||||
}
|
||||
}
|
||||
|
||||
function getDuplicates(texts: readonly string[]): string[] {
|
||||
return texts.filter((text, index) => texts.indexOf(text) !== index);
|
||||
}
|
||||
Reference in New Issue
Block a user