Fix running playwright test with npm and electron. (#14764)

Fixes #14763

Contributed on behalf of STMicroelectronics

Author: tsmaeder

examples/playwright/src/theia-app-loader.ts

@@ -15,11 +15,8 @@
 // *****************************************************************************
 
 import { Page, PlaywrightWorkerArgs, _electron as electron } from '@playwright/test';
-import * as path from 'path';
-import * as fs from 'fs';
 import { TheiaApp } from './theia-app';
 import { TheiaWorkspace } from './theia-workspace';
-import { OSUtil } from './util';
 
 export interface TheiaAppFactory<T extends TheiaApp> {
     new(page: Page, initialWorkspace: TheiaWorkspace, isElectron?: boolean): T;
@@ -104,7 +101,7 @@ namespace TheiaElectronAppLoader {
         const appPath = electronConfig.electronAppPath!;
         const pluginsPath = electronConfig.pluginsPath;
         const launchOptions = electronConfig.launchOptions ?? {
-            additionalArgs: ['--no-cluster'],
+            additionalArgs: ['--no-sandbox', '--no-cluster'],
             electronAppPath: appPath,
             pluginsPath: pluginsPath
         };
@@ -122,14 +119,10 @@ namespace TheiaElectronAppLoader {
     export function toPlaywrightOptions(
         electronLaunchOptions: { additionalArgs: string[], electronAppPath: string, pluginsPath?: string } | object,
         workspace?: TheiaWorkspace
-    ): { executablePath: string, args: string[] } | object {
+    ): {
+        args: string[]
+    } | object {
         if ('additionalArgs' in electronLaunchOptions && 'electronAppPath' in electronLaunchOptions) {
-            const executablePath = path.normalize(path.join(electronLaunchOptions.electronAppPath, 'node_modules/.bin/electron')) + (OSUtil.isWindows ? '.cmd' : '');
-            if (!fs.existsSync(executablePath)) {
-                const errorMsg = `executablePath: ${executablePath} does not exist`;
-                console.log(errorMsg);
-                throw new Error(errorMsg);
-            }
             const args = [
                 electronLaunchOptions.electronAppPath,
                 ...electronLaunchOptions.additionalArgs,
@@ -142,7 +135,9 @@ namespace TheiaElectronAppLoader {
                 args.push(workspace.path);
             }
 
-            return { executablePath: executablePath, args: args };
+            return {
+                args: args
+            };
         }
         return electronLaunchOptions;
     }
@@ -159,6 +154,7 @@ export namespace TheiaAppLoader {
             // disable native elements and early window to avoid issues with the electron app
             process.env.THEIA_ELECTRON_DISABLE_NATIVE_ELEMENTS = '1';
             process.env.THEIA_ELECTRON_NO_EARLY_WINDOW = '1';
+            process.env.THEIA_NO_SPLASH = 'true';
             return TheiaElectronAppLoader.load(args, initialWorkspace, factory);
         }
         const page = await args.browser.newPage();

examples/playwright/src/theia-workspace.ts

@@ -47,12 +47,14 @@ export class TheiaWorkspace {
 
     get path(): string {
         let workspacePath = this.workspacePath;
-        if (!OSUtil.osStartsWithFileSeparator(this.workspacePath)) {
-            workspacePath = `${OSUtil.fileSeparator}${workspacePath}`;
-        }
+
         if (OSUtil.isWindows) {
             // Drive letters in windows paths have to be lower case
             workspacePath = workspacePath.replace(/.:/, matchedChar => matchedChar.toLowerCase());
+        } else {
+            if (!OSUtil.osStartsWithFileSeparator(this.workspacePath)) {
+                workspacePath = `${OSUtil.fileSeparator}${workspacePath}`;
+            }
         }
         return workspacePath;
     }

packages/core/src/electron-main/electron-main-application.ts

@@ -396,7 +396,7 @@ export class ElectronMainApplication {
     }
 
     protected isShowSplashScreen(): boolean {
-        return typeof this.config.electron.splashScreenOptions === 'object' && !!this.config.electron.splashScreenOptions.content;
+        return !process.env.THEIA_NO_SPLASH && typeof this.config.electron.splashScreenOptions === 'object' && !!this.config.electron.splashScreenOptions.content;
     }
 
     protected getSplashScreenOptions(): ElectronFrontendApplicationConfig.SplashScreenOptions | undefined {
@@ -522,21 +522,21 @@ export class ElectronMainApplication {
     }
 
     protected async handleMainCommand(options: ElectronMainCommandOptions): Promise<void> {
-        if (options.secondInstance === false) {
-            await this.openWindowWithWorkspace(''); // restore previous workspace.
-        } else if (options.file === undefined) {
-            await this.openDefaultWindow();
-        } else {
-            let workspacePath: string | undefined;
+        let workspacePath: string | undefined;
+        if (options.file) {
             try {
                 workspacePath = await fs.realpath(path.resolve(options.cwd, options.file));
             } catch {
                 console.error(`Could not resolve the workspace path. "${options.file}" is not a valid 'file' option. Falling back to the default workspace location.`);
             }
-            if (workspacePath === undefined) {
+        }
+        if (workspacePath !== undefined) {
+            await this.openWindowWithWorkspace(workspacePath);
+        } else {
+            if (options.secondInstance === false) {
+                await this.openWindowWithWorkspace(''); // restore previous workspace.
+            } else if (options.file === undefined) {
                 await this.openDefaultWindow();
-            } else {
-                await this.openWindowWithWorkspace(workspacePath);
             }
         }
     }