Experiment with real /internal/shared dir

Author: brandonpayton

packages/php-wasm/compile/php/phpwasm-emscripten-library.js

@@ -10,7 +10,7 @@
 const LibraryExample = {
 	// Emscripten dependencies:
 	$PHPWASM__deps: ['$allocateUTF8OnStack'],
-	$PHPWASM__postset: 'PHPWASM.init();',
+	$PHPWASM__postset: 'PHPWASM.init(PHPLoader?.phpWasmInitOptions);',
 
 	// Functions not exposed to C but available in the generated
 	// JavaScript library under the PHPWASM object:
@@ -28,7 +28,7 @@ const LibraryExample = {
 		// emscripten_O_NDELAY |
 		// emscripten_O_DIRECT |
 		// emscripten_O_NOATIME
-		init: function () {
+		init: function (phpWasmInitOptions) {
 			Module['ENV'] = Module['ENV'] || {};
 			// Ensure a platform-level bin directory for a fallback `php` binary.
 			Module['ENV']['PATH'] = [
@@ -42,9 +42,18 @@ const LibraryExample = {
 			// stdout, stderr, and headers information are written for the JavaScript
 			// code to read later on.
 			FS.mkdir('/internal');
-			// The files from the shared directory are shared between all the
+			// The files from the shared directory are shared between all th
 			// PHP processes managed by PHPProcessManager.
 			FS.mkdir('/internal/shared');
+
+			if (phpWasmInitOptions?.nativeInternalDirPath) {
+				FS.mount(
+					FS.filesystems.NODEFS,
+					{ root: phpWasmInitOptions.nativeInternalDirPath },
+					'/internal/shared'
+				);
+			}
+
 			// The files from the preload directory are preloaded using the
 			// auto_prepend_file php.ini directive.
 			FS.mkdir('/internal/shared/preload');

packages/php-wasm/node/src/lib/load-runtime.ts

@@ -56,6 +56,18 @@ type PHPLoaderOptionsForNode = PHPLoaderOptions & {
 		 * @param args - Arguments to the format string.
 		 */
 		trace?: (processId: number, format: string, ...args: any[]) => void;
+
+		/**
+		 * An optional object to pass to the PHP-WASM library's `init` function.
+		 *
+		 * phpWasmInitOptions.nativeInternalDirPath is used to mount a
+		 * real, native directory as the php-wasm /internal directory.
+		 *
+		 * @see https://github.com/php-wasm/php-wasm/blob/main/compile/php/phpwasm-emscripten-library.js#L100
+		 */
+		phpWasmInitOptions?: {
+			nativeInternalDirPath?: string;
+		};
 	};
 };
 

packages/playground/cli/src/blueprints-v1/blueprints-v1-handler.ts

@@ -55,7 +55,8 @@ export class BlueprintsV1Handler {
 
 	async bootPrimaryWorker(
 		phpPort: NodeMessagePort,
-		fileLockManagerPort: NodeMessagePort
+		fileLockManagerPort: NodeMessagePort,
+		nativeInternalDirPath: string
 	) {
 		const compiledBlueprint = await this.compileInputBlueprint(
 			this.args['additional-blueprint-steps'] || []
@@ -149,6 +150,7 @@ export class BlueprintsV1Handler {
 			trace,
 			internalCookieStore: this.args.internalCookieStore,
 			withXdebug: this.args.xdebug,
+			nativeInternalDirPath,
 		});
 
 		if (
@@ -171,10 +173,12 @@ export class BlueprintsV1Handler {
 		worker,
 		fileLockManagerPort,
 		firstProcessId,
+		nativeInternalDirPath,
 	}: {
 		worker: SpawnedWorker;
 		fileLockManagerPort: NodeMessagePort;
 		firstProcessId: number;
+		nativeInternalDirPath: string;
 	}) {
 		const additionalPlayground = consumeAPI<PlaygroundCliBlueprintV1Worker>(
 			worker.phpPort
@@ -202,6 +206,7 @@ export class BlueprintsV1Handler {
 			//        will have a separate cookie store.
 			internalCookieStore: this.args.internalCookieStore,
 			withXdebug: this.args.xdebug,
+			nativeInternalDirPath,
 		});
 		await additionalPlayground.isReady();
 		return additionalPlayground;

packages/playground/cli/src/blueprints-v1/worker-thread-v1.ts

@@ -44,6 +44,7 @@ export type WorkerBootOptions = {
 	 */
 	internalCookieStore?: boolean;
 	withXdebug?: boolean;
+	nativeInternalDirPath?: string;
 };
 
 /**
@@ -117,6 +118,7 @@ export class PlaygroundCliBlueprintV1Worker extends PHPWorker {
 		trace,
 		internalCookieStore,
 		withXdebug,
+		nativeInternalDirPath,
 	}: WorkerBootOptions) {
 		if (this.booted) {
 			throw new Error('Playground already booted');
@@ -151,6 +153,9 @@ export class PlaygroundCliBlueprintV1Worker extends PHPWorker {
 							fileLockManager: this.fileLockManager!,
 							processId,
 							trace: trace ? tracePhpWasm : undefined,
+							phpWasmInitOptions: {
+								nativeInternalDirPath,
+							},
 						},
 						followSymlinks,
 						withXdebug,

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

@@ -48,6 +48,7 @@ import { resolveBlueprint } from './resolve-blueprint';
 import { BlueprintsV2Handler } from './blueprints-v2/blueprints-v2-handler';
 import { BlueprintsV1Handler } from './blueprints-v1/blueprints-v1-handler';
 import { startBridge } from '@php-wasm/xdebug-bridge';
+import { dir as tmpDir } from 'tmp-promise';
 
 export async function parseOptionsAndRunCLI() {
 	try {
@@ -444,10 +445,13 @@ export async function runCLI(args: RunCLIArgs): Promise<RunCLIServer> {
 					fileLockManager
 				);
 
+				const nativeInternalDirPath = (await tmpDir()).path;
+
 				// Boot the primary worker using the handler
 				playground = await handler.bootPrimaryWorker(
 					initialWorker.phpPort,
-					fileLockManagerPort
+					fileLockManagerPort,
+					nativeInternalDirPath
 				);
 				playgroundsToCleanUp.push({
 					playground,
@@ -489,17 +493,18 @@ export async function runCLI(args: RunCLIArgs): Promise<RunCLIServer> {
 				) {
 					logger.log(`Preparing additional workers...`);
 
-					// Save /internal directory from initial worker so we can replicate it
-					// in each additional worker.
-					const internalZip = await zipDirectory(
-						playground,
-						'/internal'
-					);
+					// // Save /internal directory from initial worker so we can replicate it
+					// // in each additional worker.
+					// const internalZip = await zipDirectory(
+					// 	playground,
+					// 	'/internal'
+					// );
 
 					// Boot additional workers using the handler
 					const initialWorkerProcessIdSpace = processIdSpaceLength;
 					await Promise.all(
 						additionalWorkers.map(async (worker, index) => {
+							console.error('worker', index);
 							const firstProcessId =
 								initialWorkerProcessIdSpace +
 								index * processIdSpaceLength;
@@ -512,26 +517,27 @@ export async function runCLI(args: RunCLIArgs): Promise<RunCLIServer> {
 									worker,
 									fileLockManagerPort,
 									firstProcessId,
+									nativeInternalDirPath,
 								});
 
 							playgroundsToCleanUp.push({
 								playground: additionalPlayground,
 								worker: worker.worker,
 							});
 
-							// Replicate the Blueprint-initialized /internal directory
-							await additionalPlayground.writeFile(
-								'/tmp/internal.zip',
-								internalZip
-							);
-							await unzipFile(
-								additionalPlayground,
-								'/tmp/internal.zip',
-								'/internal'
-							);
-							await additionalPlayground.unlink(
-								'/tmp/internal.zip'
-							);
+							// // Replicate the Blueprint-initialized /internal directory
+							// await additionalPlayground.writeFile(
+							// 	'/tmp/internal.zip',
+							// 	internalZip
+							// );
+							// await unzipFile(
+							// 	additionalPlayground,
+							// 	'/tmp/internal.zip',
+							// 	'/internal'
+							// );
+							// await additionalPlayground.unlink(
+							// 	'/tmp/internal.zip'
+							// );
 
 							loadBalancer.addWorker(additionalPlayground);
 						})