@php-wasm/node 3.1.1 → 3.1.3

package/index.cjs

@@ -1564,6 +1564,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 +1624,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 +1895,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 +1919,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 +1972,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,7 +393,8 @@ 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
@@ -1541,7 +1542,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 +1607,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 +1877,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 +1901,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 +1954,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/node",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "description": "PHP.wasm for Node.js",
   "repository": {
     "type": "git",
@@ -38,30 +38,33 @@
   },
   "license": "GPL-2.0-or-later",
   "types": "index.d.ts",
-  "gitHead": "71560d81fcde96435d5730a0430abcafaa6f92b8",
+  "gitHead": "54bb87ba4c9624ec02f60194a2f1938b3f42477b",
   "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.1",
-    "@php-wasm/universal": "3.1.1",
-    "@php-wasm/node-8-5": "3.1.1",
-    "@php-wasm/node-8-4": "3.1.1",
-    "@php-wasm/node-8-3": "3.1.1",
-    "@php-wasm/node-8-2": "3.1.1",
-    "@php-wasm/node-8-1": "3.1.1",
-    "@php-wasm/node-8-0": "3.1.1",
-    "@php-wasm/node-7-4": "3.1.1",
-    "@php-wasm/logger": "3.1.1",
-    "@php-wasm/util": "3.1.1",
-    "@wp-playground/common": "3.1.1"
+    "@php-wasm/node-polyfills": "3.1.3",
+    "@php-wasm/universal": "3.1.3",
+    "@php-wasm/node-8-5": "3.1.3",
+    "@php-wasm/node-8-4": "3.1.3",
+    "@php-wasm/node-8-3": "3.1.3",
+    "@php-wasm/node-8-2": "3.1.3",
+    "@php-wasm/node-8-1": "3.1.3",
+    "@php-wasm/node-8-0": "3.1.3",
+    "@php-wasm/node-7-4": "3.1.3",
+    "@php-wasm/cli-util": "3.1.3",
+    "@php-wasm/logger": "3.1.3",
+    "@php-wasm/util": "3.1.3",
+    "@wp-playground/common": "3.1.3"
   },
   "packageManager": "npm@10.9.2",
   "overrides": {