From 3867d5581b6b12fde0108f55af78ad443dfb3876 Mon Sep 17 00:00:00 2001
From: Playwright Service <89237858+playwrightmachine@users.noreply.github.com>
Date: Wed, 15 May 2024 09:46:48 -0700
Subject: [PATCH] cherry-pick(#30820): fix(electron): allow launching with
 spaces in path (#30830)

This PR cherry-picks the following commits:

- 90765a226f2e86757beb8b0bc7d168c8237a7db0

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
---
 .../src/server/electron/electron.ts              | 16 ++++++++++++----
 .../playwright-electron-should-work.spec.ts      | 15 +++++++++++++++
 2 files changed, 27 insertions(+), 4 deletions(-)

diff --git a/packages/playwright-core/src/server/electron/electron.ts b/packages/playwright-core/src/server/electron/electron.ts
index c55257510ce61..9b934ca2f7009 100644
--- a/packages/playwright-core/src/server/electron/electron.ts
+++ b/packages/playwright-core/src/server/electron/electron.ts
@@ -161,7 +161,7 @@ export class Electron extends SdkObject {
     return controller.run(async progress => {
       let app: ElectronApplication | undefined = undefined;
       // --remote-debugging-port=0 must be the last playwright's argument, loader.ts relies on it.
-      const electronArguments = ['--inspect=0', '--remote-debugging-port=0', ...args];
+      let electronArguments = ['--inspect=0', '--remote-debugging-port=0', ...args];
 
       if (os.platform() === 'linux') {
         const runningAsRoot = process.geteuid && process.geteuid() === 0;
@@ -195,6 +195,16 @@ export class Electron extends SdkObject {
         // Packaged apps might have their own command line handling.
         electronArguments.unshift('-r', require.resolve('./loader'));
       }
+      let shell = false;
+      if (process.platform === 'win32') {
+        // On Windows in order to run .cmd files, shell: true is required.
+        // https://github.com/nodejs/node/issues/52554
+        shell = true;
+        // On Windows, we need to quote the executable path due to shell: true.
+        command = `"${command}"`;
+        // On Windows, we need to quote the arguments due to shell: true.
+        electronArguments = electronArguments.map(arg => `"${arg}"`);
+      }
 
       // When debugging Playwright test that runs Electron, NODE_OPTIONS
       // will make the debugger attach to Electron's Node. But Playwright
@@ -208,9 +218,7 @@ export class Electron extends SdkObject {
           progress.log(message);
           browserLogsCollector.log(message);
         },
-        // On Windows in order to run .cmd files, shell: true is required.
-        // https://github.com/nodejs/node/issues/52554
-        shell: process.platform === 'win32',
+        shell,
         stdio: 'pipe',
         cwd: options.cwd,
         tempDirectories: [artifactsDir],
diff --git a/tests/installation/playwright-electron-should-work.spec.ts b/tests/installation/playwright-electron-should-work.spec.ts
index 76cad12ec7604..4de28e8b54109 100755
--- a/tests/installation/playwright-electron-should-work.spec.ts
+++ b/tests/installation/playwright-electron-should-work.spec.ts
@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 import { test } from './npmTest';
+import fs from 'fs';
+import path from 'path';
 
 test('electron should work', async ({ exec, tsc, writeFiles }) => {
   await exec('npm i playwright electron@19.0.11');
@@ -24,3 +26,16 @@ test('electron should work', async ({ exec, tsc, writeFiles }) => {
   });
   await tsc('test.ts');
 });
+
+test('electron should work with special characters in path', async ({ exec, tmpWorkspace }) => {
+  test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/30755' });
+  const folderName = path.join(tmpWorkspace, '!@#$% тест with spaces and 😊');
+
+  await exec('npm i playwright electron@19.0.11');
+  await fs.promises.mkdir(folderName);
+  for (const file of ['electron-app.js', 'sanity-electron.js'])
+    await fs.promises.copyFile(path.join(tmpWorkspace, file), path.join(folderName, file));
+  await exec('node sanity-electron.js', {
+    cwd: path.join(folderName)
+  });
+});