Read files from VFS when a PHP instance is provided

Author: mho22

packages/php-wasm/xdebug-bridge/src/lib/start-bridge.ts

@@ -1,5 +1,5 @@
 import { logger } from '@php-wasm/logger';
-import type { PHP } from '@php-wasm/universal';
+import type { PHP, PHPWorker, RemoteAPI } from '@php-wasm/universal';
 import { readdirSync, readFileSync, lstatSync } from 'fs';
 import path from 'path';
 import { CDPServer } from './cdp-server';
@@ -11,7 +11,7 @@ export type StartBridgeConfig = {
 	cdpHost?: string;
 	dbgpPort?: number;
 	phpRoot?: string;
-	phpInstance?: PHP;
+	phpInstance?: PHP | RemoteAPI<PHPWorker>;
 	getPHPFile?: (path: string) => string | Promise<string>;
 	breakOnFirstLine?: boolean;
 };
@@ -44,17 +44,25 @@ export async function startBridge(config: StartBridgeConfig) {
 	logger.log('Running a PHP script with Xdebug enabled...');
 
 	// Recursively get a list of .php files in phpRoot
-	function getPhpFiles(dir: string): string[] {
+	async function getPhpFiles(dir: string): Promise<string[]> {
 		const results: string[] = [];
-		const list = readdirSync(dir);
+		const list = config.phpInstance
+			? await config.phpInstance!.listFiles(dir)
+			: readdirSync(dir);
 		for (const file of list) {
 			const filePath = path.join(dir, file);
-			// lstat avoids crashes when encountering symlinks
-			const stat = lstatSync(filePath);
-			if (stat && stat.isDirectory()) {
-				results.push(...getPhpFiles(filePath));
-			} else if (file.endsWith('.php')) {
-				results.push(filePath);
+			try {
+				// lstat avoids crashes when encountering symlinks
+				const stat = config.phpInstance
+					? await config.phpInstance!.isDir(filePath)
+					: lstatSync(filePath).isDirectory();
+				if (stat) {
+					results.push(...(await getPhpFiles(filePath)));
+				} else if (file.endsWith('.php')) {
+					results.push(filePath);
+				}
+			} catch {
+				// Skip this entry if we can't read it
 			}
 		}
 		return results;
@@ -66,7 +74,7 @@ export async function startBridge(config: StartBridgeConfig) {
 		? config.getPHPFile
 		: (path: string) => readFileSync(path, 'utf-8');
 
-	const phpFiles = getPhpFiles(phpRoot);
+	const phpFiles = await getPhpFiles(phpRoot);
 	return new XdebugCDPBridge(dbgpSession, cdpServer, {
 		knownScriptUrls: phpFiles,
 		phpRoot,

packages/php-wasm/xdebug-bridge/src/lib/xdebug-cdp-bridge.ts

@@ -71,8 +71,7 @@ export class XdebugCDPBridge {
 		// Xdebug connected
 		this.dbgp.on('connected', () => {
 			this.xdebugConnected = true;
-			this.sendDbgpCommand('stdout', '-c 1'); // copies PHP stdout to IDE
-			this.sendDbgpCommand('stderr', '-c 1'); // copies PHP stderr to IDE
+			this.sendDbgpCommand('stderr', '-c 1'); // copies PHP stderr to console
 		});
 		// Xdebug messages
 		this.dbgp.on('message', async (xml: string) => {

packages/php-wasm/xdebug-bridge/src/tests/start-bridge.spec.ts

@@ -1,7 +1,7 @@
 import './mocker';
 import { type MockInstance, vi } from 'vitest';
 import { WebSocket } from 'ws';
-import type { PHP } from '@php-wasm/universal';
+import { type PHP } from '@php-wasm/universal';
 import { EventEmitter } from 'events';
 import { CDPServer } from '../lib/cdp-server';
 import { DbgpSession } from '../lib/dbgp-session';
@@ -89,6 +89,7 @@ describe('Bridge', () => {
 
 		it('uses phpInstance readFileAsText when provided', async () => {
 			const php = {
+				listFiles: vi.fn(() => []),
 				readFileAsText: vi
 					.fn()
 					.mockResolvedValue('<?php echo "Hello World";'),
@@ -114,6 +115,37 @@ describe('Bridge', () => {
 			expect(getPHPFile).toHaveBeenCalledWith('file:///custom.php');
 			expect(result).toBe('<?php echo "Hello World";');
 		});
+
+		it('reads PHP files from the filesystem when no phpInstance is provided', async () => {
+			await startBridge({ phpRoot: '/foo/bar' });
+
+			const args = (XdebugCDPBridge as any).mock.calls[0][2];
+
+			expect(args.knownScriptUrls).toEqual(['/foo/bar/baz.php']);
+		});
+
+		it('reads files from the virtual filesystem when a PHP instance is provided', async () => {
+			const filesystem: Record<string, string[]> = {
+				'/foo': ['bar.php', 'baz'],
+				'/foo/baz': ['qux.php', 'quux.txt'],
+			};
+
+			const php: Partial<PHP> = {
+				listFiles: vi.fn(
+					(directory: string) => filesystem[directory] || []
+				),
+				isDir: vi.fn((path: string) => path in filesystem),
+			};
+
+			await startBridge({ phpInstance: php as PHP, phpRoot: '/foo' });
+
+			const args = (XdebugCDPBridge as any).mock.calls[0][2];
+
+			expect(args.knownScriptUrls).toEqual([
+				'/foo/bar.php',
+				'/foo/baz/qux.php',
+			]);
+		});
 	});
 
 	describe('Log', () => {

packages/playground/cli/src/run-cli.ts

@@ -745,8 +745,8 @@ export async function runCLI(args: RunCLIArgs): Promise<RunCLIServer> {
 
 				if (args.experimentalDevtools && args.xdebug) {
 					const bridge = await startBridge({
-						getPHPFile: async (path: string) =>
-							await playground!.readFileAsText(path),
+						phpInstance: playground,
+						phpRoot: '/wordpress',
 					});
 
 					bridge.start();