Build php-wasm with Emscripten 3.1.74 (#2)

Note: This work is continued from a PR started under the WordPress GH
org.

There are a couple of reasons for this upgrade:

1. I am having trouble rebuilding php-wasm on my current system.
References to older ubuntu images and emscripten versions [has given me
trouble](#2038 (comment)).
2. We want [this Emscripten
fix](emscripten-core/emscripten#22932) from
@jeroenpf and @bgrgicak which was first included in Emscripten 3.1.73.

This PR:
- Bumps the ubuntu docker image version due to build errors related to
missing image. Referencing a newer ubuntu image seemed to fix the
"missing image" errors.
- Bumps Emscripten version
- Adjusts Playground-specific patches to Emscripten output since the
latest breaks that patching.

- CI (once we can run GH actions on A8C's GHE instance)

---------

Co-authored-by: Brandon Payton <[email protected]>

Author: Brandon Payton

package-lock.json

@@ -23,6 +23,7 @@
 		"prepare": "husky install",
 		"reset": "nx reset",
 		"recompile:php": "npm run recompile:php:web && npm run recompile:php:node",
+		"recompile:php:web": "nx recompile-php:all php-wasm-web ",
 		"recompile:php:web:jspi:all": "nx recompile-php:jspi:all php-wasm-web",
 		"recompile:php:web:jspi:8.4": "nx recompile-php:jspi php-wasm-web -- --PHP_VERSION=8.4 ",
 		"recompile:php:web:jspi:8.3": "nx recompile-php:jspi php-wasm-web -- --PHP_VERSION=8.3 ",

package.json

@@ -1,7 +1,6 @@
 # Originally forked from https://github.com/seanmorris/php-wasm
-# ubuntu:lunar supports amd64 and arm64 (Apple Silicon) while
-# emscripten/emsdk:3.1.24 supports amd64 only.
-FROM ubuntu:lunar as emscripten
+# ubuntu:noble supports amd64 and arm64 (Apple Silicon)
+FROM ubuntu:noble as emscripten
 
 SHELL ["/bin/bash", "-c"]
 
@@ -50,8 +49,8 @@ RUN set -euxo pipefail;\
 # https://github.com/WordPress/wordpress-playground/tree/67d916b5eccfe78e26e9c953598cc1a81f316931/packages/php-wasm/compile
 RUN ln -s /usr/bin/python3 /usr/bin/python
 RUN git clone https://github.com/emscripten-core/emsdk.git && \
-    ./emsdk/emsdk install 3.1.61 && \
-    /root/emsdk/emsdk activate 3.1.61
+    ./emsdk/emsdk install 3.1.74 && \
+    /root/emsdk/emsdk activate 3.1.74
 
 RUN mkdir -p /root/lib/lib /root/lib/include /root/lib/share /root/lib/bin
 
@@ -62,9 +61,11 @@ for dir in $(ls $1); do \n\
     cp -r /root/$1/$dir/* /root/lib/$dir/ 2>/dev/null || :; \n\
     done ' > /root/copy-lib.sh
 RUN chmod a+x /root/copy-lib.sh
-# Script to replace strings in files and exit with a non-zero status if the string is not found.
+# Scripts to replace strings in files and exit with a non-zero status if the string is not found.
 COPY ./replace.sh /root/replace.sh
 RUN chmod a+x /root/replace.sh
+COPY ./replace-across-lines.sh /root/replace-across-lines.sh
+RUN chmod a+x /root/replace-across-lines.sh
 
 # Patch emcc to allow skipping flags and passing additional flags using environment variables.
 #

packages/php-wasm/compile/base-image/Dockerfile

@@ -0,0 +1,14 @@
+#!/bin/bash 
+
+# This script is used to replace strings in files and exit with a non-zero status if the string is not found.
+# This version of the script can do replacements across multiple lines.
+
+perl -0 -pi.bak -e "$1" "$2"
+if [ $? -ne 0 ]; then
+    echo "Failed to replace $1 in file $2 - exiting with non-zero status"
+    exit 1
+fi
+if cmp --silent -- "$2" "$2.bak"; then
+    echo "No matches found for $1 in file $2 - exiting with non-zero status"
+    exit 1
+fi

packages/php-wasm/compile/base-image/replace-across-lines.sh

@@ -1072,7 +1072,7 @@ RUN set -euxo pipefail; \
 		# This assumes the traffic is always forwarded to the same target.
 		# However, we want to support arbitrary targets, so we need to
 		# replace the hardcoded websocket target URL with a dynamic callback.
-		/root/replace.sh $'s/if\s*\(\s*["\']string["\']\s*===\s*typeof Module\[["\']websocket["\']\]\[["\']url["\']\]\s*\)/if("function"===typeof Module["websocket"]["url"]) {\nurl = Module["websocket"]["url"](...arguments);\n}else if ("string" === typeof Module["websocket"]["url"])/g' \
+		/root/replace.sh $'s/if\s*\(\s*SOCKFS\.websocketArgs\["url"\]\s*\)/if("function"===typeof SOCKFS.websocketArgs["url"]) {\nurl = SOCKFS.websocketArgs["url"](...arguments);\n}else if ("string" === typeof SOCKFS.websocketArgs["url"])/g' \
 			/root/output/php.js; \
 		# Enable custom WebSocket constructors to support socket options.
 		/root/replace.sh "s/ws\s*=\s*new WebSocketConstructor/if (Module['websocket']['decorator']) {WebSocketConstructor = Module['websocket']['decorator'](WebSocketConstructor);}ws = new WebSocketConstructor/g" /root/output/php.js && \
@@ -1110,6 +1110,26 @@ RUN set -euxo pipefail; \
 		# wrapper function.
 		/root/replace.sh $'s/ENVIRONMENT_IS_([A-Z]+)\s*=\s*(true|false)/ENVIRONMENT_IS_$1=RuntimeName==="$1"/g' /root/output/php.js; \
 		/root/replace.sh 's/var ENV\s*=\s*\{/var ENV = PHPLoader.ENV || {/g' /root/output/php.js; \
+	# Patch Emscripten exit status to include a stack trace
+		# Override Emscripten's default ExitStatus class which gets
+		# thrown on failure. Unfortunately, the default object is not
+		# a subclass of Error and does not provide any stack trace.
+		#
+		# This is a deliberate behavior on Emscripten's end to prevent
+		# memory leaks after the program exits. See:
+		#
+		# https://github.com/emscripten-core/emscripten/pull/9108
+		#
+		# In case of WordPress Playground, the worker in which the PHP
+		# runs will typically exit after the PHP program finishes, so
+		# we don't have to worry about memory leaks.
+		/root/replace-across-lines.sh 's/(class\s+ExitStatus\s*\{\s*name\s*=\s*"ExitStatus";\s*constructor\(\s*status\s*\)\s*\{\s*this\.message\s*=\s*`Program terminated with exit\(\$\{status\}\)`;\s*this.status\s*=\s*status;?\s*\}\s*\})/$1\nExitStatus = class PHPExitStatus extends Error {\nconstructor(status) {\n		super(status);\n		this.name = "ExitStatus";\n		this.message = "Program terminated with exit(" + status + ")";\n		this.status = status;\n	}\n};/' /root/output/php.js; \ 
+	# Restore quit handling to Emscripten
+		# Quit callback customization was removed from Emscripten by:
+		# https://github.com/emscripten-core/emscripten/pull/22371
+		# But the alternative `onExit()` handling is conditional and has different semantics.
+		# To avoid bugs due to this change, let's just restore support for quit callback customization.
+		/root/replace.sh 's/(if\s*\(Module\["thisProgram"\]\)\s*thisProgram\s*=\s*Module\["thisProgram"\];)/$1\nif (Module["quit"]) quit_=Module["quit"];/' /root/output/php.js; \
 	# Turn the php.js file into an ES module
 		# Manually turn the output into a esm module instead of relying on -s MODULARIZE=1.
 		# which pollutes the global namespace and does not play well with import() mechanics.

packages/php-wasm/compile/php/Dockerfile

@@ -1,37 +1,2 @@
 export function init(RuntimeName, PHPLoader) {
-    /**
-     * Overrides Emscripten's default ExitStatus object which gets
-     * thrown on failure. Unfortunately, the default object is not
-     * a subclass of Error and does not provide any stack trace.
-     *
-     * This is a deliberate behavior on Emscripten's end to prevent
-     * memory leaks after the program exits. See:
-     *
-     * https://github.com/emscripten-core/emscripten/pull/9108
-     *
-     * In case of WordPress Playground, the worker in which the PHP
-     * runs will typically exit after the PHP program finishes, so
-     * we don't have to worry about memory leaks.
-     *
-     * As for assigning to a previously undeclared ExitStatus variable here,
-     * the Emscripten module declares `ExitStatus` as `function ExitStatus`
-     * which means it gets hoisted to the top of the scope and can be
-     * reassigned here – before the actual declaration is reached.
-     *
-     * If that sounds weird, try this example:
-     *
-     * ExitStatus = () => { console.log("reassigned"); }
-     * function ExitStatus() {}
-     * ExitStatus();
-     * // logs "reassigned"
-     */
-    ExitStatus = class PHPExitStatus extends Error {
-        constructor(status) {
-            super(status);
-            this.name = "ExitStatus";
-            this.message = "Program terminated with exit(" + status + ")";
-            this.status = status;
-        }
-    }
-
     // The rest of the code comes from the built php.js file and esm-suffix.js