@php-wasm/node 3.1.2 → 3.1.4

package/index.cjs

@@ -430,7 +430,7 @@ var import_universal12 = require("@php-wasm/universal");
 var import_promises = require("dns/promises");
 function bindUserSpace({ fileLockManager }, {
   pid,
-  memory: { HEAP16, HEAP64, HEAP32 },
+  memory,
   constants: {
     F_RDLCK,
     F_WRLCK,
@@ -470,7 +470,7 @@ function bindUserSpace({ fileLockManager }, {
     }
     getNextAsInt() {
       const fourByteOffset = this.argsAddr >> 2;
-      const value = HEAP32[fourByteOffset];
+      const value = memory.HEAP32.get(fourByteOffset);
       this.argsAddr += 4;
       return value;
     }
@@ -578,58 +578,63 @@ function bindUserSpace({ fileLockManager }, {
   const emscripten_flock_l_pid_offset = 24;
   function readFlockStruct(flockStructAddress) {
     return {
-      l_type: HEAP16[
+      l_type: memory.HEAP16.get(
         // Shift right by 1 to divide by 2^1.
         flockStructAddress + emscripten_flock_l_type_offset >> 1
-      ],
-      l_whence: HEAP16[
+      ),
+      l_whence: memory.HEAP16.get(
         // Shift right by 1 to divide by 2^1.
         flockStructAddress + emscripten_flock_l_whence_offset >> 1
-      ],
-      l_start: HEAP64[
+      ),
+      l_start: memory.HEAP64.get(
         // Shift right by 3 to divide by 2^3.
         flockStructAddress + emscripten_flock_l_start_offset >> 3
-      ],
-      l_len: HEAP64[
+      ),
+      l_len: memory.HEAP64.get(
         // Shift right by 3 to divide by 2^3.
         flockStructAddress + emscripten_flock_l_len_offset >> 3
-      ],
-      l_pid: HEAP32[
+      ),
+      l_pid: memory.HEAP32.get(
         // Shift right by 2 to divide by 2^2.
         flockStructAddress + emscripten_flock_l_pid_offset >> 2
-      ]
+      )
     };
   }
   function updateFlockStruct(flockStructAddress, fields) {
     if (fields.l_type !== void 0) {
-      HEAP16[
+      memory.HEAP16.set(
         // Shift right by 1 to divide by 2^1.
-        flockStructAddress + emscripten_flock_l_type_offset >> 1
-      ] = fields.l_type;
+        flockStructAddress + emscripten_flock_l_type_offset >> 1,
+        fields.l_type
+      );
     }
     if (fields.l_whence !== void 0) {
-      HEAP16[
+      memory.HEAP16.set(
         // Shift right by 1 to divide by 2^1.
-        flockStructAddress + emscripten_flock_l_whence_offset >> 1
-      ] = fields.l_whence;
+        flockStructAddress + emscripten_flock_l_whence_offset >> 1,
+        fields.l_whence
+      );
     }
     if (fields.l_start !== void 0) {
-      HEAP64[
+      memory.HEAP64.set(
         // Shift right by 3 to divide by 2^3.
-        flockStructAddress + emscripten_flock_l_start_offset >> 3
-      ] = fields.l_start;
+        flockStructAddress + emscripten_flock_l_start_offset >> 3,
+        fields.l_start
+      );
     }
     if (fields.l_len !== void 0) {
-      HEAP64[
+      memory.HEAP64.set(
         // Shift right by 3 to divide by 2^3.
-        flockStructAddress + emscripten_flock_l_len_offset >> 3
-      ] = fields.l_len;
+        flockStructAddress + emscripten_flock_l_len_offset >> 3,
+        fields.l_len
+      );
     }
     if (fields.l_pid !== void 0) {
-      HEAP32[
+      memory.HEAP32.set(
         // Shift right by 2 to divide by 2^2.
-        flockStructAddress + emscripten_flock_l_pid_offset >> 2
-      ] = fields.l_pid;
+        flockStructAddress + emscripten_flock_l_pid_offset >> 2,
+        fields.l_pid
+      );
     }
   }
   function getBaseAddress(fd, whence, startOffset) {
@@ -1564,6 +1569,7 @@ var FileLockManagerForWindows = class {
 };
 
 // packages/php-wasm/node/src/lib/extensions/xdebug/with-xdebug.ts
+var import_cli_util = require("@php-wasm/cli-util");
 var import_universal5 = require("@php-wasm/universal");
 var import_fs = __toESM(require("fs"), 1);
 
@@ -1623,26 +1629,39 @@ async function withXdebug(version = import_universal5.LatestSupportedPHPVersion,
         phpRuntime.FS,
         "/internal/shared/extensions/xdebug.ini"
       )) {
-        const ideKey = xdebugOptions?.ideKey || "PLAYGROUNDCLI";
+        const ideKey = xdebugOptions.ideKey || import_cli_util.DEFAULT_IDE_KEY;
         phpRuntime.FS.writeFile(
           "/internal/shared/extensions/xdebug.ini",
           [
             "zend_extension=/internal/shared/extensions/xdebug.so",
             "xdebug.mode=debug,develop",
             "xdebug.start_with_request=yes",
-            `xdebug.idekey="${ideKey}"`
+            `xdebug.idekey="${ideKey}"`,
+            // Path mapping is only available starting
+            // from Xdebug 3.5, which is used by PHP 8.5+
+            // Previous versions will ignore this entry.
+            "xdebug.path_mapping=yes"
           ].join("\n")
         );
       }
-      const cwd = process.cwd();
-      if (cwd && cwd !== "/") {
-        phpRuntime.FS.mkdirTree(cwd);
-        phpRuntime.FS.mount(
-          phpRuntime.FS.filesystems["NODEFS"],
-          { root: cwd },
-          cwd
-        );
-        phpRuntime.FS.chdir(cwd);
+      const isPHP85orHigher = import_universal5.SupportedPHPVersionsList.indexOf(version) <= import_universal5.SupportedPHPVersions.indexOf("8.5");
+      if (isPHP85orHigher) {
+        const { pathMappings, pathSkippings } = xdebugOptions;
+        if (!pathMappings && !pathSkippings)
+          return;
+        phpRuntime.FS.mkdir("/.xdebug");
+        if (pathMappings) {
+          phpRuntime.FS.writeFile(
+            "/.xdebug/path.map",
+            pathMappings.map((map) => `${map.vfsPath} = ${map.hostPath}`).join("\n")
+          );
+        }
+        if (pathSkippings) {
+          phpRuntime.FS.writeFile(
+            "/.xdebug/skip.map",
+            pathSkippings.map((path2) => `${path2} = SKIP`).join("\n")
+          );
+        }
       }
     }
   };
@@ -1881,7 +1900,12 @@ async function withMemcached(version = import_universal11.LatestSupportedPHPVers
 // packages/php-wasm/node/src/lib/load-runtime.ts
 var import_util = require("@php-wasm/util");
 var import_os = require("os");
+var dangerousDefaultProcessIdAllocator = process.env.VITEST ? new import_universal12.ProcessIdAllocator() : void 0;
 async function loadNodeRuntime(phpVersion, options = {}) {
+  const processId = options.emscriptenOptions?.processId ?? // !! Only assign a default process ID during test.
+  // Otherwise, multiple workers with duplicate process IDs
+  // could break file locking and lead to database corruption.
+  (process.env.VITEST ? dangerousDefaultProcessIdAllocator.claim() : void 0);
   let emscriptenOptions = {
     /**
      * Emscripten default behavior is to kill the process when
@@ -1900,6 +1924,7 @@ async function loadNodeRuntime(phpVersion, options = {}) {
       return bindUserSpace({ fileLockManager }, userSpaceContext);
     },
     ...options.emscriptenOptions || {},
+    processId,
     onRuntimeInitialized: (phpRuntime) => {
       if (options?.followSymlinks === true) {
         phpRuntime.FS.filesystems.NODEFS.node_ops.readlink = (node) => {
@@ -1952,11 +1977,11 @@ async function loadNodeRuntime(phpVersion, options = {}) {
       phpRuntime.FS.root.mount.opts.root = ".";
     }
   };
-  if (options?.withXdebug === true) {
+  if (options?.withXdebug) {
     emscriptenOptions = await withXdebug(
       phpVersion,
       emscriptenOptions,
-      options.xdebug
+      typeof options.withXdebug === "object" ? options.withXdebug : {}
     );
   }
   if (options?.withIntl === true) {

package/index.js

@@ -393,14 +393,15 @@ async function withNetworking(phpModuleArgs = {}) {
 import {
   loadPHPRuntime,
   FSHelpers as FSHelpers5,
-  FileLockManagerComposite
+  FileLockManagerComposite,
+  ProcessIdAllocator
 } from "@php-wasm/universal";
 
 // packages/php-wasm/node/src/lib/wasm-user-space.ts
 import { lookup as lookup2 } from "dns/promises";
 function bindUserSpace({ fileLockManager }, {
   pid,
-  memory: { HEAP16, HEAP64, HEAP32 },
+  memory,
   constants: {
     F_RDLCK,
     F_WRLCK,
@@ -440,7 +441,7 @@ function bindUserSpace({ fileLockManager }, {
     }
     getNextAsInt() {
       const fourByteOffset = this.argsAddr >> 2;
-      const value = HEAP32[fourByteOffset];
+      const value = memory.HEAP32.get(fourByteOffset);
       this.argsAddr += 4;
       return value;
     }
@@ -548,58 +549,63 @@ function bindUserSpace({ fileLockManager }, {
   const emscripten_flock_l_pid_offset = 24;
   function readFlockStruct(flockStructAddress) {
     return {
-      l_type: HEAP16[
+      l_type: memory.HEAP16.get(
         // Shift right by 1 to divide by 2^1.
         flockStructAddress + emscripten_flock_l_type_offset >> 1
-      ],
-      l_whence: HEAP16[
+      ),
+      l_whence: memory.HEAP16.get(
         // Shift right by 1 to divide by 2^1.
         flockStructAddress + emscripten_flock_l_whence_offset >> 1
-      ],
-      l_start: HEAP64[
+      ),
+      l_start: memory.HEAP64.get(
         // Shift right by 3 to divide by 2^3.
         flockStructAddress + emscripten_flock_l_start_offset >> 3
-      ],
-      l_len: HEAP64[
+      ),
+      l_len: memory.HEAP64.get(
         // Shift right by 3 to divide by 2^3.
         flockStructAddress + emscripten_flock_l_len_offset >> 3
-      ],
-      l_pid: HEAP32[
+      ),
+      l_pid: memory.HEAP32.get(
         // Shift right by 2 to divide by 2^2.
         flockStructAddress + emscripten_flock_l_pid_offset >> 2
-      ]
+      )
     };
   }
   function updateFlockStruct(flockStructAddress, fields) {
     if (fields.l_type !== void 0) {
-      HEAP16[
+      memory.HEAP16.set(
         // Shift right by 1 to divide by 2^1.
-        flockStructAddress + emscripten_flock_l_type_offset >> 1
-      ] = fields.l_type;
+        flockStructAddress + emscripten_flock_l_type_offset >> 1,
+        fields.l_type
+      );
     }
     if (fields.l_whence !== void 0) {
-      HEAP16[
+      memory.HEAP16.set(
         // Shift right by 1 to divide by 2^1.
-        flockStructAddress + emscripten_flock_l_whence_offset >> 1
-      ] = fields.l_whence;
+        flockStructAddress + emscripten_flock_l_whence_offset >> 1,
+        fields.l_whence
+      );
     }
     if (fields.l_start !== void 0) {
-      HEAP64[
+      memory.HEAP64.set(
         // Shift right by 3 to divide by 2^3.
-        flockStructAddress + emscripten_flock_l_start_offset >> 3
-      ] = fields.l_start;
+        flockStructAddress + emscripten_flock_l_start_offset >> 3,
+        fields.l_start
+      );
     }
     if (fields.l_len !== void 0) {
-      HEAP64[
+      memory.HEAP64.set(
         // Shift right by 3 to divide by 2^3.
-        flockStructAddress + emscripten_flock_l_len_offset >> 3
-      ] = fields.l_len;
+        flockStructAddress + emscripten_flock_l_len_offset >> 3,
+        fields.l_len
+      );
     }
     if (fields.l_pid !== void 0) {
-      HEAP32[
+      memory.HEAP32.set(
         // Shift right by 2 to divide by 2^2.
-        flockStructAddress + emscripten_flock_l_pid_offset >> 2
-      ] = fields.l_pid;
+        flockStructAddress + emscripten_flock_l_pid_offset >> 2,
+        fields.l_pid
+      );
     }
   }
   function getBaseAddress(fd, whence, startOffset) {
@@ -1541,7 +1547,13 @@ var FileLockManagerForWindows = class {
 };
 
 // packages/php-wasm/node/src/lib/extensions/xdebug/with-xdebug.ts
-import { LatestSupportedPHPVersion as LatestSupportedPHPVersion3, FSHelpers } from "@php-wasm/universal";
+import { DEFAULT_IDE_KEY } from "@php-wasm/cli-util";
+import {
+  FSHelpers,
+  LatestSupportedPHPVersion as LatestSupportedPHPVersion3,
+  SupportedPHPVersions,
+  SupportedPHPVersionsList
+} from "@php-wasm/universal";
 import fs from "fs";
 
 // packages/php-wasm/node/src/lib/extensions/xdebug/get-xdebug-extension-module.ts
@@ -1600,26 +1612,39 @@ async function withXdebug(version = LatestSupportedPHPVersion3, options, xdebugO
         phpRuntime.FS,
         "/internal/shared/extensions/xdebug.ini"
       )) {
-        const ideKey = xdebugOptions?.ideKey || "PLAYGROUNDCLI";
+        const ideKey = xdebugOptions.ideKey || DEFAULT_IDE_KEY;
         phpRuntime.FS.writeFile(
           "/internal/shared/extensions/xdebug.ini",
           [
             "zend_extension=/internal/shared/extensions/xdebug.so",
             "xdebug.mode=debug,develop",
             "xdebug.start_with_request=yes",
-            `xdebug.idekey="${ideKey}"`
+            `xdebug.idekey="${ideKey}"`,
+            // Path mapping is only available starting
+            // from Xdebug 3.5, which is used by PHP 8.5+
+            // Previous versions will ignore this entry.
+            "xdebug.path_mapping=yes"
           ].join("\n")
         );
       }
-      const cwd = process.cwd();
-      if (cwd && cwd !== "/") {
-        phpRuntime.FS.mkdirTree(cwd);
-        phpRuntime.FS.mount(
-          phpRuntime.FS.filesystems["NODEFS"],
-          { root: cwd },
-          cwd
-        );
-        phpRuntime.FS.chdir(cwd);
+      const isPHP85orHigher = SupportedPHPVersionsList.indexOf(version) <= SupportedPHPVersions.indexOf("8.5");
+      if (isPHP85orHigher) {
+        const { pathMappings, pathSkippings } = xdebugOptions;
+        if (!pathMappings && !pathSkippings)
+          return;
+        phpRuntime.FS.mkdir("/.xdebug");
+        if (pathMappings) {
+          phpRuntime.FS.writeFile(
+            "/.xdebug/path.map",
+            pathMappings.map((map) => `${map.vfsPath} = ${map.hostPath}`).join("\n")
+          );
+        }
+        if (pathSkippings) {
+          phpRuntime.FS.writeFile(
+            "/.xdebug/skip.map",
+            pathSkippings.map((path2) => `${path2} = SKIP`).join("\n")
+          );
+        }
       }
     }
   };
@@ -1857,7 +1882,12 @@ async function withMemcached(version = LatestSupportedPHPVersion9, options) {
 // packages/php-wasm/node/src/lib/load-runtime.ts
 import { dirname, joinPaths, toPosixPath } from "@php-wasm/util";
 import { platform } from "os";
+var dangerousDefaultProcessIdAllocator = process.env.VITEST ? new ProcessIdAllocator() : void 0;
 async function loadNodeRuntime(phpVersion, options = {}) {
+  const processId = options.emscriptenOptions?.processId ?? // !! Only assign a default process ID during test.
+  // Otherwise, multiple workers with duplicate process IDs
+  // could break file locking and lead to database corruption.
+  (process.env.VITEST ? dangerousDefaultProcessIdAllocator.claim() : void 0);
   let emscriptenOptions = {
     /**
      * Emscripten default behavior is to kill the process when
@@ -1876,6 +1906,7 @@ async function loadNodeRuntime(phpVersion, options = {}) {
       return bindUserSpace({ fileLockManager }, userSpaceContext);
     },
     ...options.emscriptenOptions || {},
+    processId,
     onRuntimeInitialized: (phpRuntime) => {
       if (options?.followSymlinks === true) {
         phpRuntime.FS.filesystems.NODEFS.node_ops.readlink = (node) => {
@@ -1928,11 +1959,11 @@ async function loadNodeRuntime(phpVersion, options = {}) {
       phpRuntime.FS.root.mount.opts.root = ".";
     }
   };
-  if (options?.withXdebug === true) {
+  if (options?.withXdebug) {
     emscriptenOptions = await withXdebug(
       phpVersion,
       emscriptenOptions,
-      options.xdebug
+      typeof options.withXdebug === "object" ? options.withXdebug : {}
     );
   }
   if (options?.withIntl === true) {

package/lib/extensions/xdebug/with-xdebug.d.ts

@@ -1,5 +1,11 @@
-import type { EmscriptenOptions } from '@php-wasm/universal';
+import { type EmscriptenOptions } from '@php-wasm/universal';
+export interface PathMapping {
+    hostPath: string;
+    vfsPath: string;
+}
 export interface XdebugOptions {
     ideKey?: string;
+    pathMappings?: PathMapping[];
+    pathSkippings?: string[];
 }
-export declare function withXdebug(version: "8.5" | "8.4" | "8.3" | "8.2" | "8.1" | "8.0" | "7.4" | undefined, options: EmscriptenOptions, xdebugOptions?: XdebugOptions): Promise<EmscriptenOptions>;
+export declare function withXdebug(version: "8.5" | "8.4" | "8.3" | "8.2" | "8.1" | "8.0" | "7.4" | undefined, options: EmscriptenOptions, xdebugOptions: XdebugOptions): Promise<EmscriptenOptions>;

package/lib/load-runtime.d.ts

@@ -3,8 +3,7 @@ import type { WasmUserSpaceAPI, WasmUserSpaceContext } from './wasm-user-space';
 import { type XdebugOptions } from './extensions/xdebug/with-xdebug';
 export interface PHPLoaderOptions {
     followSymlinks?: boolean;
-    withXdebug?: boolean;
-    xdebug?: XdebugOptions;
+    withXdebug?: boolean | XdebugOptions;
     withIntl?: boolean;
     withRedis?: boolean;
     withMemcached?: boolean;

package/lib/wasm-user-space.d.ts

@@ -7,6 +7,10 @@
 import type { Emscripten } from '@php-wasm/universal';
 import type { WasmKernelSpace } from './wasm-kernel-space';
 type FSNode = Emscripten.FS.FSNode;
+type HeapAccessor<T> = {
+    get(offset: number): T;
+    set(offset: number, value: T): void;
+};
 type NonZeroNumber = Exclude<number, 0>;
 export type WasmUserSpaceContext = {
     pid: number;
@@ -40,16 +44,16 @@ export type WasmUserSpaceContext = {
         EWOULDBLOCK: NonZeroNumber;
     };
     memory: {
-        HEAP8: Int8Array;
-        HEAPU8: Uint8Array;
-        HEAP16: Int16Array;
-        HEAPU16: Uint16Array;
-        HEAP32: Int32Array;
-        HEAPU32: Uint32Array;
-        HEAPF32: Float32Array;
-        HEAP64: BigInt64Array;
-        HEAPU64: BigUint64Array;
-        HEAPF64: Float64Array;
+        HEAP8: HeapAccessor<number>;
+        HEAPU8: HeapAccessor<number>;
+        HEAP16: HeapAccessor<number>;
+        HEAPU16: HeapAccessor<number>;
+        HEAP32: HeapAccessor<number>;
+        HEAPU32: HeapAccessor<number>;
+        HEAPF32: HeapAccessor<number>;
+        HEAP64: HeapAccessor<bigint>;
+        HEAPU64: HeapAccessor<bigint>;
+        HEAPF64: HeapAccessor<bigint>;
     };
     wasmImports: {
         builtin_fcntl64: (fd: number, cmd: number, varargs?: any) => number;
@@ -77,5 +81,5 @@ export type WasmUserSpaceAPI = {
     js_release_file_locks: () => void;
     gethostbyname: (hostname: string) => Promise<string>;
 };
-export declare function bindUserSpace({ fileLockManager }: WasmKernelSpace, { pid, memory: { HEAP16, HEAP64, HEAP32 }, constants: { F_RDLCK, F_WRLCK, F_UNLCK, F_GETFL, O_ACCMODE, O_RDONLY, O_WRONLY, O_APPEND, O_NONBLOCK, F_SETFL, F_GETLK, F_SETLK, F_SETLKW, SEEK_SET, SEEK_CUR, SEEK_END, LOCK_SH, LOCK_EX, LOCK_NB, LOCK_UN, }, errnoCodes: { EBADF, EINVAL, EAGAIN, EWOULDBLOCK }, wasmImports: { builtin_fcntl64, builtin_fd_close, js_wasm_trace }, wasmExports: { wasm_get_end_offset }, syscalls: { getStreamFromFD }, FS, PROXYFS, NODEFS, }: WasmUserSpaceContext): WasmUserSpaceAPI;
+export declare function bindUserSpace({ fileLockManager }: WasmKernelSpace, { pid, memory, constants: { F_RDLCK, F_WRLCK, F_UNLCK, F_GETFL, O_ACCMODE, O_RDONLY, O_WRONLY, O_APPEND, O_NONBLOCK, F_SETFL, F_GETLK, F_SETLK, F_SETLKW, SEEK_SET, SEEK_CUR, SEEK_END, LOCK_SH, LOCK_EX, LOCK_NB, LOCK_UN, }, errnoCodes: { EBADF, EINVAL, EAGAIN, EWOULDBLOCK }, wasmImports: { builtin_fcntl64, builtin_fd_close, js_wasm_trace }, wasmExports: { wasm_get_end_offset }, syscalls: { getStreamFromFD }, FS, PROXYFS, NODEFS, }: WasmUserSpaceContext): WasmUserSpaceAPI;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/node",
-  "version": "3.1.2",
+  "version": "3.1.4",
   "description": "PHP.wasm for Node.js",
   "repository": {
     "type": "git",
@@ -38,30 +38,33 @@
   },
   "license": "GPL-2.0-or-later",
   "types": "index.d.ts",
-  "gitHead": "4a2f8903e9d4a58e33382f8f888ef94d42d913dc",
+  "gitHead": "a7cde6f2a2d3cef27f51f24e9ddadbe5ca05344b",
   "engines": {
     "node": ">=20.10.0",
     "npm": ">=10.2.3"
   },
   "dependencies": {
     "express": "4.22.0",
+    "fast-xml-parser": "^5.3.4",
     "fs-ext-extra-prebuilt": "2.2.7",
     "ini": "4.1.2",
+    "jsonc-parser": "3.3.1",
     "wasm-feature-detect": "1.8.0",
     "ws": "8.18.3",
     "yargs": "17.7.2",
-    "@php-wasm/node-polyfills": "3.1.2",
-    "@php-wasm/universal": "3.1.2",
-    "@php-wasm/node-8-5": "3.1.2",
-    "@php-wasm/node-8-4": "3.1.2",
-    "@php-wasm/node-8-3": "3.1.2",
-    "@php-wasm/node-8-2": "3.1.2",
-    "@php-wasm/node-8-1": "3.1.2",
-    "@php-wasm/node-8-0": "3.1.2",
-    "@php-wasm/node-7-4": "3.1.2",
-    "@php-wasm/logger": "3.1.2",
-    "@php-wasm/util": "3.1.2",
-    "@wp-playground/common": "3.1.2"
+    "@php-wasm/node-polyfills": "3.1.4",
+    "@php-wasm/universal": "3.1.4",
+    "@php-wasm/node-8-5": "3.1.4",
+    "@php-wasm/node-8-4": "3.1.4",
+    "@php-wasm/node-8-3": "3.1.4",
+    "@php-wasm/node-8-2": "3.1.4",
+    "@php-wasm/node-8-1": "3.1.4",
+    "@php-wasm/node-8-0": "3.1.4",
+    "@php-wasm/node-7-4": "3.1.4",
+    "@php-wasm/cli-util": "3.1.4",
+    "@php-wasm/logger": "3.1.4",
+    "@php-wasm/util": "3.1.4",
+    "@wp-playground/common": "3.1.4"
   },
   "packageManager": "npm@10.9.2",
   "overrides": {