@php-wasm/node 1.1.1 → 1.1.3

package/jspi/php_8_0.js

@@ -3,26 +3,12 @@
 // this code in Node.js as an ES module.
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
-import { fileURLToPath } from 'url';
-
-/**
- * __filename and __dirname are not available in ES modules, so we need to
- * polyfill them to ensure the debug command (npx nx debug playground-cli)
- * works.
- *
- * @see https://nodejs.org/api/esm.html#no-__filename-or-__dirname
- */
+// Note: The path module is currently needed by code injected by the php-wasm Dockerfile.
 import path from 'path';
-if (typeof __filename === 'undefined') {
-	var __filename = fileURLToPath(import.meta.url);
-}
-if (typeof __dirname === 'undefined') {
-	var __dirname = path.dirname(__filename);
-}
 
 const dependencyFilename = path.join(__dirname, '8_0_30', 'php_8_0.wasm');
 export { dependencyFilename };
-export const dependenciesTotalSize = 17167385;
+export const dependenciesTotalSize = 17167885;
 export function init(RuntimeName, PHPLoader) {
 	// The rest of the code comes from the built php.js file and esm-suffix.js
 	// include: shell.js
@@ -6982,6 +6968,44 @@ export function init(RuntimeName, PHPLoader) {
 			// The files from the preload directory are preloaded using the
 			// auto_prepend_file php.ini directive.
 			FS.mkdir('/internal/shared/preload');
+			// Create stdout and stderr devices. We can't just use Emscripten's
+			// default stdout and stderr devices because they stop processing data
+			// on the first null byte. However, when dealing with binary data,
+			// null bytes are valid and common.
+			FS.registerDevice(FS.makedev(64, 0), {
+				open: () => {},
+				close: () => {},
+				read: () => 0,
+				write: (stream, buffer, offset, length, pos) => {
+					const chunk = buffer.subarray(offset, offset + length);
+					PHPWASM.onStdout(chunk);
+					return length;
+				},
+			});
+			FS.mkdev('/internal/stdout', FS.makedev(64, 0));
+			FS.registerDevice(FS.makedev(63, 0), {
+				open: () => {},
+				close: () => {},
+				read: () => 0,
+				write: (stream, buffer, offset, length, pos) => {
+					const chunk = buffer.subarray(offset, offset + length);
+					PHPWASM.onStderr(chunk);
+					return length;
+				},
+			});
+			FS.mkdev('/internal/stderr', FS.makedev(63, 0));
+			FS.registerDevice(FS.makedev(62, 0), {
+				open: () => {},
+				close: () => {},
+				read: () => 0,
+				write: (stream, buffer, offset, length, pos) => {
+					const chunk = buffer.subarray(offset, offset + length);
+					PHPWASM.onHeaders(chunk);
+					return length;
+				},
+			});
+			FS.mkdev('/internal/headers', FS.makedev(62, 0));
+			// Handle events.
 			PHPWASM.EventEmitter = ENVIRONMENT_IS_NODE
 				? require('events').EventEmitter
 				: class EventEmitter {
@@ -7022,9 +7046,71 @@ export function init(RuntimeName, PHPLoader) {
 							}
 						}
 				  };
+			// Clean up the fd -> childProcess mapping when the fd is closed:
+			const originalClose = FS.close;
+			FS.close = function (stream) {
+				originalClose(stream);
+				delete PHPWASM.child_proc_by_fd[stream.fd];
+			};
 			PHPWASM.child_proc_by_fd = {};
 			PHPWASM.child_proc_by_pid = {};
 			PHPWASM.input_devices = {};
+			const originalWrite = TTY.stream_ops.write;
+			TTY.stream_ops.write = function (stream, ...rest) {
+				const retval = originalWrite(stream, ...rest);
+				// Implicit flush since PHP's fflush() doesn't seem to trigger the fsync event
+				// @TODO: Fix this at the wasm level
+				stream.tty.ops.fsync(stream.tty);
+				return retval;
+			};
+			const originalPutChar = TTY.stream_ops.put_char;
+			TTY.stream_ops.put_char = function (tty, val) {
+				/**
+				 * Buffer newlines that Emscripten normally ignores.
+				 *
+				 * Emscripten doesn't do it by default because its default
+				 * print function is console.log that implicitly adds a newline. We are overwriting
+				 * it with an environment-specific function that outputs exaclty what it was given,
+				 * e.g. in Node.js it's process.stdout.write(). Therefore, we need to mak sure
+				 * all the newlines make it to the output buffer.
+				 */ if (val === 10) tty.output.push(val);
+				return originalPutChar(tty, val);
+			};
+		},
+		onHeaders: function (chunk) {
+			if (Module['onHeaders']) {
+				Module['onHeaders'](chunk);
+				return;
+			}
+			console.log('headers', {
+				chunk,
+			});
+		},
+		onStdout: function (chunk) {
+			if (Module['onStdout']) {
+				Module['onStdout'](chunk);
+				return;
+			}
+			if (ENVIRONMENT_IS_NODE) {
+				process.stdout.write(chunk);
+			} else {
+				console.log('stdout', {
+					chunk,
+				});
+			}
+		},
+		onStderr: function (chunk) {
+			if (Module['onStderr']) {
+				Module['onStderr'](chunk);
+				return;
+			}
+			if (ENVIRONMENT_IS_NODE) {
+				process.stderr.write(chunk);
+			} else {
+				console.warn('stderr', {
+					chunk,
+				});
+			}
 		},
 		getAllWebSockets: function (sock) {
 			const webSockets = new Set();
@@ -7206,7 +7292,7 @@ export function init(RuntimeName, PHPLoader) {
 				argsArray.push(UTF8ToString(HEAPU32[charPointer >> 2]));
 			}
 		}
-		const cwdstr = cwdPtr ? UTF8ToString(cwdPtr) : null;
+		const cwdstr = cwdPtr ? UTF8ToString(cwdPtr) : FS.cwd();
 		let envObject = null;
 		if (envLength) {
 			envObject = {};
@@ -7279,6 +7365,15 @@ export function init(RuntimeName, PHPLoader) {
 				PHPWASM.child_proc_by_fd[ProcInfo.stderrParentFd] = ProcInfo;
 			PHPWASM.child_proc_by_pid[ProcInfo.pid] = ProcInfo;
 			cp.on('exit', function (code) {
+				for (const fd of [
+					// The child process exited. Let's clean up its output streams:
+					ProcInfo.stdoutChildFd,
+					ProcInfo.stderrChildFd,
+				]) {
+					if (FS.streams[fd] && !FS.isClosed(FS.streams[fd])) {
+						FS.close(FS.streams[fd]);
+					}
+				}
 				ProcInfo.exitCode = code;
 				ProcInfo.exited = true;
 				// Emit events for the wasm_poll_socket function.
@@ -7329,12 +7424,52 @@ export function init(RuntimeName, PHPLoader) {
 			 * listen to the 'exit' event.
 			 */ try {
 				await new Promise((resolve, reject) => {
-					cp.on('spawn', resolve);
-					cp.on('error', reject);
+					/**
+					 * There was no `await` between the `spawnProcess` call
+					 * and the `await` below so the process haven't had a chance
+					 * to run any of the exit-related callbacks yet.
+					 *
+					 * Good.
+					 *
+					 * Let's listen to all the lifecycle events and resolve
+					 * the promise when the process starts or immediately crashes.
+					 */ let resolved = false;
+					cp.on('spawn', () => {
+						if (resolved) return;
+						resolved = true;
+						resolve();
+					});
+					cp.on('error', (e) => {
+						if (resolved) return;
+						resolved = true;
+						reject(e);
+					});
+					cp.on('exit', function (code) {
+						if (resolved) return;
+						resolved = true;
+						if (code === 0) {
+							resolve();
+						} else {
+							reject(
+								new Error(`Process exited with code ${code}`)
+							);
+						}
+					});
+					/**
+					 * If the process haven't even started after 5 seconds, something
+					 * is wrong. Perhaps we're missing an event listener, or perhaps
+					 * the `spawnProcess` implementation failed to dispatch the relevant
+					 * event. Either way, let's crash to avoid blocking the proc_open()
+					 * call indefinitely.
+					 */ setTimeout(() => {
+						if (resolved) return;
+						resolved = true;
+						reject(new Error('Process timed out'));
+					}, 5e3);
 				});
 			} catch (e) {
 				console.error(e);
-				wakeUp(1);
+				wakeUp(ProcInfo.pid);
 				return;
 			}
 			// Now we want to pass data from the STDIN source supplied by PHP
@@ -8044,14 +8179,7 @@ export function init(RuntimeName, PHPLoader) {
 			const POLLNVAL = 32;
 			return returnCallback((wakeUp) => {
 				const polls = [];
-				if (socketd in PHPWASM.child_proc_by_fd) {
-					const procInfo = PHPWASM.child_proc_by_fd[socketd];
-					if (procInfo.exited) {
-						wakeUp(0);
-						return;
-					}
-					polls.push(PHPWASM.awaitEvent(procInfo.stdout, 'data'));
-				} else if (FS.isSocket(FS.getStream(socketd)?.node.mode)) {
+				if (FS.isSocket(FS.getStream(socketd)?.node.mode)) {
 					const sock = getSocketFromFD(socketd);
 					if (!sock) {
 						wakeUp(0);
@@ -8085,7 +8213,12 @@ export function init(RuntimeName, PHPLoader) {
 							polls.push(PHPWASM.awaitConnection(ws));
 							lookingFor.add('POLLOUT');
 						}
-						if (events & POLLHUP) {
+						if (
+							events & POLLHUP ||
+							events & POLLIN ||
+							events & POLLOUT ||
+							events & POLLERR
+						) {
 							polls.push(PHPWASM.awaitClose(ws));
 							lookingFor.add('POLLHUP');
 						}
@@ -8094,6 +8227,13 @@ export function init(RuntimeName, PHPLoader) {
 							lookingFor.add('POLLERR');
 						}
 					}
+				} else if (socketd in PHPWASM.child_proc_by_fd) {
+					const procInfo = PHPWASM.child_proc_by_fd[socketd];
+					if (procInfo.exited) {
+						wakeUp(0);
+						return;
+					}
+					polls.push(PHPWASM.awaitEvent(procInfo.stdout, 'data'));
 				} else {
 					setTimeout(function () {
 						wakeUp(1);
@@ -8380,13 +8520,6 @@ export function init(RuntimeName, PHPLoader) {
 		(___wrap_select = Module['___wrap_select'] =
 			wasmExports['__wrap_select'])(a0, a1, a2, a3, a4));
 
-	var _wasm_add_cli_arg = (Module['_wasm_add_cli_arg'] = (a0) =>
-		(_wasm_add_cli_arg = Module['_wasm_add_cli_arg'] =
-			wasmExports['wasm_add_cli_arg'])(a0));
-
-	var _run_cli = (Module['_run_cli'] = () =>
-		(_run_cli = Module['_run_cli'] = wasmExports['run_cli'])());
-
 	var _wasm_set_sapi_name = (Module['_wasm_set_sapi_name'] = (a0) =>
 		(_wasm_set_sapi_name = Module['_wasm_set_sapi_name'] =
 			wasmExports['wasm_set_sapi_name'])(a0));
@@ -8395,6 +8528,13 @@ export function init(RuntimeName, PHPLoader) {
 		(_wasm_set_phpini_path = Module['_wasm_set_phpini_path'] =
 			wasmExports['wasm_set_phpini_path'])(a0));
 
+	var _wasm_add_cli_arg = (Module['_wasm_add_cli_arg'] = (a0) =>
+		(_wasm_add_cli_arg = Module['_wasm_add_cli_arg'] =
+			wasmExports['wasm_add_cli_arg'])(a0));
+
+	var _run_cli = (Module['_run_cli'] = () =>
+		(_run_cli = Module['_run_cli'] = wasmExports['run_cli'])());
+
 	var _wasm_add_SERVER_entry = (Module['_wasm_add_SERVER_entry'] = (a0, a1) =>
 		(_wasm_add_SERVER_entry = Module['_wasm_add_SERVER_entry'] =
 			wasmExports['wasm_add_SERVER_entry'])(a0, a1));

package/jspi/php_8_1.js

@@ -3,26 +3,12 @@
 // this code in Node.js as an ES module.
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
-import { fileURLToPath } from 'url';
-
-/**
- * __filename and __dirname are not available in ES modules, so we need to
- * polyfill them to ensure the debug command (npx nx debug playground-cli)
- * works.
- *
- * @see https://nodejs.org/api/esm.html#no-__filename-or-__dirname
- */
+// Note: The path module is currently needed by code injected by the php-wasm Dockerfile.
 import path from 'path';
-if (typeof __filename === 'undefined') {
-	var __filename = fileURLToPath(import.meta.url);
-}
-if (typeof __dirname === 'undefined') {
-	var __dirname = path.dirname(__filename);
-}
 
 const dependencyFilename = path.join(__dirname, '8_1_23', 'php_8_1.wasm');
 export { dependencyFilename };
-export const dependenciesTotalSize = 17182850;
+export const dependenciesTotalSize = 17183362;
 export function init(RuntimeName, PHPLoader) {
 	// The rest of the code comes from the built php.js file and esm-suffix.js
 	// include: shell.js
@@ -7010,6 +6996,44 @@ export function init(RuntimeName, PHPLoader) {
 			// The files from the preload directory are preloaded using the
 			// auto_prepend_file php.ini directive.
 			FS.mkdir('/internal/shared/preload');
+			// Create stdout and stderr devices. We can't just use Emscripten's
+			// default stdout and stderr devices because they stop processing data
+			// on the first null byte. However, when dealing with binary data,
+			// null bytes are valid and common.
+			FS.registerDevice(FS.makedev(64, 0), {
+				open: () => {},
+				close: () => {},
+				read: () => 0,
+				write: (stream, buffer, offset, length, pos) => {
+					const chunk = buffer.subarray(offset, offset + length);
+					PHPWASM.onStdout(chunk);
+					return length;
+				},
+			});
+			FS.mkdev('/internal/stdout', FS.makedev(64, 0));
+			FS.registerDevice(FS.makedev(63, 0), {
+				open: () => {},
+				close: () => {},
+				read: () => 0,
+				write: (stream, buffer, offset, length, pos) => {
+					const chunk = buffer.subarray(offset, offset + length);
+					PHPWASM.onStderr(chunk);
+					return length;
+				},
+			});
+			FS.mkdev('/internal/stderr', FS.makedev(63, 0));
+			FS.registerDevice(FS.makedev(62, 0), {
+				open: () => {},
+				close: () => {},
+				read: () => 0,
+				write: (stream, buffer, offset, length, pos) => {
+					const chunk = buffer.subarray(offset, offset + length);
+					PHPWASM.onHeaders(chunk);
+					return length;
+				},
+			});
+			FS.mkdev('/internal/headers', FS.makedev(62, 0));
+			// Handle events.
 			PHPWASM.EventEmitter = ENVIRONMENT_IS_NODE
 				? require('events').EventEmitter
 				: class EventEmitter {
@@ -7050,9 +7074,71 @@ export function init(RuntimeName, PHPLoader) {
 							}
 						}
 				  };
+			// Clean up the fd -> childProcess mapping when the fd is closed:
+			const originalClose = FS.close;
+			FS.close = function (stream) {
+				originalClose(stream);
+				delete PHPWASM.child_proc_by_fd[stream.fd];
+			};
 			PHPWASM.child_proc_by_fd = {};
 			PHPWASM.child_proc_by_pid = {};
 			PHPWASM.input_devices = {};
+			const originalWrite = TTY.stream_ops.write;
+			TTY.stream_ops.write = function (stream, ...rest) {
+				const retval = originalWrite(stream, ...rest);
+				// Implicit flush since PHP's fflush() doesn't seem to trigger the fsync event
+				// @TODO: Fix this at the wasm level
+				stream.tty.ops.fsync(stream.tty);
+				return retval;
+			};
+			const originalPutChar = TTY.stream_ops.put_char;
+			TTY.stream_ops.put_char = function (tty, val) {
+				/**
+				 * Buffer newlines that Emscripten normally ignores.
+				 *
+				 * Emscripten doesn't do it by default because its default
+				 * print function is console.log that implicitly adds a newline. We are overwriting
+				 * it with an environment-specific function that outputs exaclty what it was given,
+				 * e.g. in Node.js it's process.stdout.write(). Therefore, we need to mak sure
+				 * all the newlines make it to the output buffer.
+				 */ if (val === 10) tty.output.push(val);
+				return originalPutChar(tty, val);
+			};
+		},
+		onHeaders: function (chunk) {
+			if (Module['onHeaders']) {
+				Module['onHeaders'](chunk);
+				return;
+			}
+			console.log('headers', {
+				chunk,
+			});
+		},
+		onStdout: function (chunk) {
+			if (Module['onStdout']) {
+				Module['onStdout'](chunk);
+				return;
+			}
+			if (ENVIRONMENT_IS_NODE) {
+				process.stdout.write(chunk);
+			} else {
+				console.log('stdout', {
+					chunk,
+				});
+			}
+		},
+		onStderr: function (chunk) {
+			if (Module['onStderr']) {
+				Module['onStderr'](chunk);
+				return;
+			}
+			if (ENVIRONMENT_IS_NODE) {
+				process.stderr.write(chunk);
+			} else {
+				console.warn('stderr', {
+					chunk,
+				});
+			}
 		},
 		getAllWebSockets: function (sock) {
 			const webSockets = new Set();
@@ -7234,7 +7320,7 @@ export function init(RuntimeName, PHPLoader) {
 				argsArray.push(UTF8ToString(HEAPU32[charPointer >> 2]));
 			}
 		}
-		const cwdstr = cwdPtr ? UTF8ToString(cwdPtr) : null;
+		const cwdstr = cwdPtr ? UTF8ToString(cwdPtr) : FS.cwd();
 		let envObject = null;
 		if (envLength) {
 			envObject = {};
@@ -7307,6 +7393,15 @@ export function init(RuntimeName, PHPLoader) {
 				PHPWASM.child_proc_by_fd[ProcInfo.stderrParentFd] = ProcInfo;
 			PHPWASM.child_proc_by_pid[ProcInfo.pid] = ProcInfo;
 			cp.on('exit', function (code) {
+				for (const fd of [
+					// The child process exited. Let's clean up its output streams:
+					ProcInfo.stdoutChildFd,
+					ProcInfo.stderrChildFd,
+				]) {
+					if (FS.streams[fd] && !FS.isClosed(FS.streams[fd])) {
+						FS.close(FS.streams[fd]);
+					}
+				}
 				ProcInfo.exitCode = code;
 				ProcInfo.exited = true;
 				// Emit events for the wasm_poll_socket function.
@@ -7357,12 +7452,52 @@ export function init(RuntimeName, PHPLoader) {
 			 * listen to the 'exit' event.
 			 */ try {
 				await new Promise((resolve, reject) => {
-					cp.on('spawn', resolve);
-					cp.on('error', reject);
+					/**
+					 * There was no `await` between the `spawnProcess` call
+					 * and the `await` below so the process haven't had a chance
+					 * to run any of the exit-related callbacks yet.
+					 *
+					 * Good.
+					 *
+					 * Let's listen to all the lifecycle events and resolve
+					 * the promise when the process starts or immediately crashes.
+					 */ let resolved = false;
+					cp.on('spawn', () => {
+						if (resolved) return;
+						resolved = true;
+						resolve();
+					});
+					cp.on('error', (e) => {
+						if (resolved) return;
+						resolved = true;
+						reject(e);
+					});
+					cp.on('exit', function (code) {
+						if (resolved) return;
+						resolved = true;
+						if (code === 0) {
+							resolve();
+						} else {
+							reject(
+								new Error(`Process exited with code ${code}`)
+							);
+						}
+					});
+					/**
+					 * If the process haven't even started after 5 seconds, something
+					 * is wrong. Perhaps we're missing an event listener, or perhaps
+					 * the `spawnProcess` implementation failed to dispatch the relevant
+					 * event. Either way, let's crash to avoid blocking the proc_open()
+					 * call indefinitely.
+					 */ setTimeout(() => {
+						if (resolved) return;
+						resolved = true;
+						reject(new Error('Process timed out'));
+					}, 5e3);
 				});
 			} catch (e) {
 				console.error(e);
-				wakeUp(1);
+				wakeUp(ProcInfo.pid);
 				return;
 			}
 			// Now we want to pass data from the STDIN source supplied by PHP
@@ -8076,14 +8211,7 @@ export function init(RuntimeName, PHPLoader) {
 			const POLLNVAL = 32;
 			return returnCallback((wakeUp) => {
 				const polls = [];
-				if (socketd in PHPWASM.child_proc_by_fd) {
-					const procInfo = PHPWASM.child_proc_by_fd[socketd];
-					if (procInfo.exited) {
-						wakeUp(0);
-						return;
-					}
-					polls.push(PHPWASM.awaitEvent(procInfo.stdout, 'data'));
-				} else if (FS.isSocket(FS.getStream(socketd)?.node.mode)) {
+				if (FS.isSocket(FS.getStream(socketd)?.node.mode)) {
 					const sock = getSocketFromFD(socketd);
 					if (!sock) {
 						wakeUp(0);
@@ -8117,7 +8245,12 @@ export function init(RuntimeName, PHPLoader) {
 							polls.push(PHPWASM.awaitConnection(ws));
 							lookingFor.add('POLLOUT');
 						}
-						if (events & POLLHUP) {
+						if (
+							events & POLLHUP ||
+							events & POLLIN ||
+							events & POLLOUT ||
+							events & POLLERR
+						) {
 							polls.push(PHPWASM.awaitClose(ws));
 							lookingFor.add('POLLHUP');
 						}
@@ -8126,6 +8259,13 @@ export function init(RuntimeName, PHPLoader) {
 							lookingFor.add('POLLERR');
 						}
 					}
+				} else if (socketd in PHPWASM.child_proc_by_fd) {
+					const procInfo = PHPWASM.child_proc_by_fd[socketd];
+					if (procInfo.exited) {
+						wakeUp(0);
+						return;
+					}
+					polls.push(PHPWASM.awaitEvent(procInfo.stdout, 'data'));
 				} else {
 					setTimeout(function () {
 						wakeUp(1);
@@ -8416,13 +8556,6 @@ export function init(RuntimeName, PHPLoader) {
 		(___wrap_select = Module['___wrap_select'] =
 			wasmExports['__wrap_select'])(a0, a1, a2, a3, a4));
 
-	var _wasm_add_cli_arg = (Module['_wasm_add_cli_arg'] = (a0) =>
-		(_wasm_add_cli_arg = Module['_wasm_add_cli_arg'] =
-			wasmExports['wasm_add_cli_arg'])(a0));
-
-	var _run_cli = (Module['_run_cli'] = () =>
-		(_run_cli = Module['_run_cli'] = wasmExports['run_cli'])());
-
 	var _wasm_set_sapi_name = (Module['_wasm_set_sapi_name'] = (a0) =>
 		(_wasm_set_sapi_name = Module['_wasm_set_sapi_name'] =
 			wasmExports['wasm_set_sapi_name'])(a0));
@@ -8431,6 +8564,13 @@ export function init(RuntimeName, PHPLoader) {
 		(_wasm_set_phpini_path = Module['_wasm_set_phpini_path'] =
 			wasmExports['wasm_set_phpini_path'])(a0));
 
+	var _wasm_add_cli_arg = (Module['_wasm_add_cli_arg'] = (a0) =>
+		(_wasm_add_cli_arg = Module['_wasm_add_cli_arg'] =
+			wasmExports['wasm_add_cli_arg'])(a0));
+
+	var _run_cli = (Module['_run_cli'] = () =>
+		(_run_cli = Module['_run_cli'] = wasmExports['run_cli'])());
+
 	var _wasm_add_SERVER_entry = (Module['_wasm_add_SERVER_entry'] = (a0, a1) =>
 		(_wasm_add_SERVER_entry = Module['_wasm_add_SERVER_entry'] =
 			wasmExports['wasm_add_SERVER_entry'])(a0, a1));