Show actual PHP error details for 500-level responses

Fixes #5

Author: sindresorhus

index.js

@@ -1,49 +1,67 @@
 import process from 'node:process';
 import path from 'node:path';
 import {spawn} from 'node:child_process';
-import http from 'node:http';
+import {setTimeout} from 'node:timers/promises';
 import open from 'open';
 import binaryVersionCheck from 'binary-version-check';
 import getPort from 'get-port';
 
 const isServerRunning = (hostname, port, pathname) => new Promise((resolve, reject) => {
-	const retryDelay = 50;
-	const maxRetries = 20; // Give up after 1 second
-
-	let retryCount = 0;
-
-	const checkServer = () => {
-		setTimeout(() => {
-			http.request({
-				method: 'HEAD',
-				hostname,
-				port,
-				path: pathname,
-			}, response => {
-				const statusCodeType = Number.parseInt(response.statusCode.toString()[0], 10);
+	(async () => {
+		const retryDelay = 50;
+		const maxRetries = 20; // Give up after 1 second
+		let retryCount = 0;
+
+		const fetchErrorDetails = async statusCode => {
+			try {
+				const response = await fetch(`http://${hostname}:${port}${pathname}`);
+				const body = await response.text();
+				// Extract the error message from the HTML response
+				// PHP errors are wrapped in <b> tags: "<b>Fatal error</b>: ..."
+				const errorMatch = body.match(/<b>(Fatal error|Parse error|Warning|Notice)<\/b>:\s*([^<\n]+)/);
+				if (errorMatch) {
+					return `Server returned ${statusCode} error: ${errorMatch[1]}: ${errorMatch[2]}`;
+				}
+
+				return `Server returned ${statusCode} error. Please check your PHP application for possible errors.`;
+			} catch {
+				return `Server returned ${statusCode} error. Could not fetch error details.`;
+			}
+		};
+
+		const checkServer = async () => {
+			try {
+				const response = await fetch(`http://${hostname}:${port}${pathname}`, {
+					method: 'HEAD',
+				});
+
+				const statusCodeType = Number.parseInt(response.status.toString()[0], 10);
 				if ([2, 3, 4].includes(statusCodeType)) {
 					resolve();
 					return;
 				}
 
 				if (statusCodeType === 5) {
-					reject(new Error('Server docroot returned 500-level response. Please check your configuration for possible errors.'));
+					const errorMessage = await fetchErrorDetails(response.status);
+					reject(new Error(errorMessage));
 					return;
 				}
 
-				checkServer();
-			}).on('error', error => {
+				await setTimeout(retryDelay);
+				await checkServer();
+			} catch (error) {
 				if (++retryCount > maxRetries) {
 					reject(new Error(`Could not start the PHP server: ${error.message}`));
 					return;
 				}
 
-				checkServer();
-			}).end();
-		}, retryDelay);
-	};
+				await setTimeout(retryDelay);
+				await checkServer();
+			}
+		};
 
-	checkServer();
+		await checkServer();
+	})();
 });
 
 export default async function phpServer(options) {
@@ -107,7 +125,12 @@ export default async function phpServer(options) {
 
 	// Check when the server is ready. Tried doing it by listening
 	// to the child process `data` event, but it's not triggered...
-	await isServerRunning(options.hostname, options.port, pathname);
+	try {
+		await isServerRunning(options.hostname, options.port, pathname);
+	} catch (error) {
+		subprocess.kill();
+		throw error;
+	}
 
 	if (options.open) {
 		await open(`${url}${pathname}`);

package.json

@@ -20,7 +20,7 @@
 		"node": ">=18"
 	},
 	"scripts": {
-		"test": "xo && ava && tsd"
+		"test": "xo && node --test test/test.js && tsd"
 	},
 	"files": [
 		"index.js",
@@ -42,12 +42,8 @@
 	},
 	"devDependencies": {
 		"@types/node": "^20.12.3",
-		"ava": "^6.1.2",
 		"got": "^14.2.1",
 		"tsd": "^0.31.0",
 		"xo": "^0.58.0"
-	},
-	"ava": {
-		"workerThreads": false
 	}
 }

test/fixtures/500/index.php

@@ -0,0 +1,6 @@
+<?php
+http_response_code(500);
+// This will trigger a fatal error (undefined function)
+undefined_function();
+echo "This should never be reached";
+?>

test/test.js

@@ -1,64 +1,101 @@
 import process from 'node:process';
 import {fileURLToPath} from 'node:url';
 import path from 'node:path';
-import test from 'ava';
+import {test, after} from 'node:test';
+import assert from 'node:assert/strict';
 import got from 'got';
 import phpServer from '../index.js';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 process.chdir(__dirname);
 
-test('start a PHP server', async t => {
+// Track all servers created during tests
+const activeServers = new Set();
+
+// Cleanup hook to ensure all servers are stopped
+after(() => {
+	for (const server of activeServers) {
+		server.stop();
+	}
+
+	activeServers.clear();
+});
+
+test('start a PHP server', async () => {
 	const server = await phpServer({base: 'fixtures/200'});
+	activeServers.add(server);
 	const {statusCode, body} = await got(server.url);
-	t.is(statusCode, 200);
-	t.is(body, 'Hello World');
+	assert.equal(statusCode, 200);
+	assert.equal(body, 'Hello World');
 	server.stop();
+	activeServers.delete(server);
 });
 
-test('start a PHP server when the status code is 301', async t => {
+test('start a PHP server when the status code is 301', async () => {
 	const server = await phpServer({base: 'fixtures/301'});
+	activeServers.add(server);
 	const {statusCode, body} = await got(server.url);
-	t.is(statusCode, 200);
-	t.is(body, '301 Redirected!');
+	assert.equal(statusCode, 200);
+	assert.equal(body, '301 Redirected!');
 	server.stop();
+	activeServers.delete(server);
 });
 
-test('start a PHP server when the status code is 400', async t => {
+test('start a PHP server when the status code is 400', async () => {
 	const server = await phpServer({base: 'fixtures/400'});
+	activeServers.add(server);
 	const {statusCode} = await got(server.url, {throwHttpErrors: false});
-	t.is(statusCode, 400);
+	assert.equal(statusCode, 400);
 	server.stop();
+	activeServers.delete(server);
 });
 
-test('start a PHP server when the status code is 404', async t => {
+test('start a PHP server when the status code is 404', async () => {
 	const server = await phpServer({base: 'fixtures/404'});
+	activeServers.add(server);
 	const {statusCode} = await got(server.url, {throwHttpErrors: false});
-	t.is(statusCode, 404);
+	assert.equal(statusCode, 404);
 	server.stop();
+	activeServers.delete(server);
 });
 
-test('expose environment variables', async t => {
+test('expose environment variables', async () => {
 	const server = await phpServer({
 		base: 'fixtures/env',
 		env: {
 			FOOBAR: 'foobar',
 		},
 	});
+	activeServers.add(server);
 	const {body} = await got(server.url);
-	t.is(body, 'foobar');
+	assert.equal(body, 'foobar');
 	server.stop();
+	activeServers.delete(server);
 });
 
-test('expose custom INI directive', async t => {
+test('expose custom INI directive', async () => {
 	const server = await phpServer({
 		base: 'fixtures/directives',
 		directives: {
 			error_log: 'foobar', // eslint-disable-line camelcase
 		},
 	});
+	activeServers.add(server);
 	const {body} = await got(server.url);
-	t.is(body, 'foobar');
+	assert.equal(body, 'foobar');
 	server.stop();
+	activeServers.delete(server);
+});
+
+test('show detailed error message when the status code is 500', async () => {
+	await assert.rejects(
+		phpServer({base: 'fixtures/500'}),
+		error => {
+			// Should contain "Fatal error" and "undefined_function"
+			assert.match(error.message, /500 error: Fatal error/);
+			assert.match(error.message, /undefined_function/);
+			return true;
+		},
+	);
 });