Run tests on Windows (#118)

Author: phenaproxima

.github/workflows/test.yml

@@ -21,8 +21,7 @@ jobs:
           - macos-latest
           # Testing on Linux is temporarily disabled until we can figure out the SUID sandboxing issue.
           # - ubuntu-latest
-          # Testing on Windows is temporarily disabled because it's broken.
-          # - windows-latest
+          - windows-latest
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4

README.md

@@ -76,10 +76,10 @@ Clone this repository, then `cd` into it and run:
 ```shell
 composer run assets --working-dir=build
 npm install
-npm run start
+npm start
 ```
 
-To run tests, run `npm run test`. To test the full app bundle, run `npx electron-builder` and look for the final binary in the `dist` directory.
+To run tests, run `npm test`. To test the full app bundle, run `npx electron-builder` and look for the final binary in the `dist` directory.
 
 ## Limitations and alternatives
 

src/main/installer.ts

@@ -8,6 +8,7 @@ import { access, appendFile, copyFile, type FileHandle, open } from 'node:fs/pro
 import path from 'node:path';
 import readline from 'node:readline';
 import { promisify as toPromise } from 'node:util';
+import { phpCommand } from './php';
 
 // Create an awaitable version of execFile that won't block the main process,
 // which would produce a disconcerting beach ball on macOS.
@@ -25,7 +26,7 @@ async function createProject (win?: WebContents): Promise<void>
         // @todo Remove EventEmitter from the intersection type when Node's type
         // definitions are updated to reflect the documentation.
         // @see https://nodejs.org/docs/latest/api/fs.html#class-filehandle
-        log = await open(installLog, 'w') as FileHandle&EventEmitter;
+        log = await open(installLog, 'a') as FileHandle&EventEmitter;
 
         // Invalidate the handle when the file is closed, so we don't try to write to
         // it accidentally.
@@ -37,33 +38,32 @@ async function createProject (win?: WebContents): Promise<void>
         log = null;
     }
 
-    const runComposer = (command: string[]) => {
-        log?.write('\n>>> ' + command.join(' ') + '\n');
+    // Always invoke Composer directly through the PHP interpreter, with a known set
+    // of options.
+    const _phpCommand = [
+        ...await phpCommand(),
+        // We use an unpacked version of Composer because the phar file has a shebang
+        // line that breaks us, due to GUI-launched Electron apps not inheriting the
+        // parent environment in macOS and Linux.
+        path.join('composer', 'bin', 'composer'),
+        // Disable ANSI output (i.e., colors) so the log is readable.
+        '--no-ansi',
+        // We don't want Composer to ask us any questions, since we have no way for
+        // the user to answer them.
+        '--no-interaction',
+    ];
 
+    const runComposer = (command: string[]) => {
         // Always direct Composer to the created project root, unless we're about to
         // create it initially.
         if (command[0] !== 'create-project') {
             command.push(`--working-dir=${projectRoot}`);
         }
-        command.push(
-            // Disable ANSI output (i.e., colors) so the log is readable.
-            '--no-ansi',
-            // We don't want Composer to ask us any questions, since we have no way for
-            // the user to answer them.
-            '--no-interaction',
-        );
-        command.unshift(
-            // Explicitly pass the cURL CA bundle so that HTTPS requests from Composer can
-            // succeed on Windows.
-            '-d',
-            'curl.cainfo=' + path.join(bin, 'cacert.pem'),
-            // We use an unpacked version of Composer because the phar file has a shebang
-            // line that breaks us, due to GUI-launched Electron apps not inheriting the
-            // parent environment in macOS and Linux.
-            path.join('composer', 'bin', 'composer'),
-        );
+        command.unshift(..._phpCommand);
+        // For forensic purposes, log the complete command we're about to execute.
+        log?.write('\n>>> ' + command.join(' ') + '\n');
 
-        const task = execFileAsPromise(path.join(bin, 'php'), command, {
+        const task = execFileAsPromise(command[0], command.slice(1), {
             // Run from the `bin` directory so we can use a relative path to Composer.
             cwd: bin,
             // Send a customized copy of the current environment variables to Composer.

src/main/main.ts

@@ -6,7 +6,7 @@ import { autoUpdater } from 'electron-updater';
 import install from './installer';
 import { readFile } from 'node:fs/promises';
 import path from 'node:path';
-import startServer from './php-server';
+import { startServer } from './php';
 import * as Sentry from "@sentry/electron/main";
 
 Sentry.init({

src/main/php-server.ts src/main/php.tssrc/main/php-server.ts renamed to src/main/php.ts

@@ -1,30 +1,40 @@
-import { projectRoot, bin, webRoot } from './config';
+import { bin, webRoot } from './config';
+import { app } from 'electron';
 import { default as getPort, portNumbers } from 'get-port';
 import { type ChildProcess, execFile } from 'node:child_process';
+import { realpath } from 'node:fs/promises';
 import path from 'node:path';
 import readline from 'node:readline';
+import process from "node:process";
 
-export default async (): Promise<{ url: string, serverProcess: ChildProcess }> => {
+export async function phpCommand (command: string[] = []): Promise<string[]>
+{
+    const phpBin = path.join(bin, process.platform === 'win32' ? 'php.exe' : 'php');
+    const caFile = path.join(bin, 'cacert.pem');
+
+    return [
+        app.isPackaged ? phpBin : await realpath(phpBin),
+        // Explicitly pass the cURL CA bundle so that HTTPS requests from Drupal can
+        // succeed on Windows.
+        '-d', `curl.cainfo="${caFile}"`,
+        ...command,
+    ];
+}
+
+export async function startServer (): Promise<{ url: string, serverProcess: ChildProcess }>
+{
     const port = await getPort({
         port: portNumbers(8888, 9999),
     });
     const url = `http://localhost:${port}`;
-    const caFile = path.join(bin, 'cacert.pem');
+
+    const command = await phpCommand([
+        '-S', url.substring(7),
+        '.ht.router.php',
+    ]);
 
     // Start the built-in PHP web server.
-    const serverProcess = execFile(
-        path.join(bin, 'php'),
-        [
-            // Explicitly pass the cURL CA bundle so that HTTPS requests from Drupal can
-            // succeed on Windows.
-            '-d', `curl.cainfo="${caFile}"`,
-            '-S', url.substring(7),
-            '.ht.router.php',
-        ],
-        {
-            cwd: webRoot,
-        },
-    );
+    const serverProcess = execFile(command[0], command.slice(1), { cwd: webRoot });
     const resolveWith = { url, serverProcess };
 
     return new Promise((resolve): void => {