@php-wasm/web 0.6.7 → 0.6.8

package/index.d.ts

@@ -76,6 +76,13 @@ declare class PHPResponse implements PHPResponseData {
 export interface PHPRequestEndEvent {
 	type: "request.end";
 }
+/**
+ * Represents an error event related to the PHP request.
+ */
+export interface PHPRequestErrorEvent {
+	type: "request.error";
+	error: Error;
+}
 /**
  * Represents a PHP runtime initialization event.
  */
@@ -93,7 +100,7 @@ export interface PHPRuntimeBeforeDestroyEvent {
  * This is intentionally not an extension of CustomEvent
  * to make it isomorphic between different JavaScript runtimes.
  */
-export type PHPEvent = PHPRequestEndEvent | PHPRuntimeInitializedEvent | PHPRuntimeBeforeDestroyEvent;
+export type PHPEvent = PHPRequestEndEvent | PHPRequestErrorEvent | PHPRuntimeInitializedEvent | PHPRuntimeBeforeDestroyEvent;
 /**
  * A callback function that handles PHP events.
  */
@@ -570,6 +577,10 @@ declare const SupportedPHPVersions: readonly [
 	"7.0"
 ];
 export type SupportedPHPVersion = (typeof SupportedPHPVersions)[number];
+export type RewriteRule = {
+	match: RegExp;
+	replacement: string;
+};
 export interface PHPRequestHandlerConfiguration {
 	/**
 	 * The directory in the PHP filesystem where the server will look
@@ -580,9 +591,14 @@ export interface PHPRequestHandlerConfiguration {
 	 * Request Handler URL. Used to populate $_SERVER details like HTTP_HOST.
 	 */
 	absoluteUrl?: string;
+	/**
+	 * Rewrite rules
+	 */
+	rewriteRules?: RewriteRule[];
 }
 declare class PHPRequestHandler implements RequestHandler {
 	#private;
+	rewriteRules: RewriteRule[];
 	/**
 	 * The PHP instance
 	 */

package/index.js

@@ -6,7 +6,7 @@ var c = (e, t, r) => (K(e, t, "read from private field"), r ? r.call(e) : t.get(
   if (t.has(e))
     throw TypeError("Cannot add the same private member more than once");
   t instanceof WeakSet ? t.add(e) : t.set(e, r);
-}, p = (e, t, r, s) => (K(e, t, "write to private field"), s ? s.call(e, r) : t.set(e, r), r);
+}, h = (e, t, r, s) => (K(e, t, "write to private field"), s ? s.call(e, r) : t.set(e, r), r);
 var f = (e, t, r) => (K(e, t, "access private method"), r);
 const currentJsRuntime$1 = function() {
   var e;
@@ -254,6 +254,11 @@ class Semaphore {
     }
   }
 }
+class PhpWasmError extends Error {
+  constructor(t, r) {
+    super(t), this.userFriendlyMessage = r, this.userFriendlyMessage || (this.userFriendlyMessage = t);
+  }
+}
 function joinPaths(...e) {
   let t = e.join("/");
   const r = t[0] === "/", s = t.substring(t.length - 1) === "/";
@@ -417,16 +422,16 @@ const SupportedPHPVersions = [
   "7.1",
   "7.0"
 ], LatestSupportedPHPVersion = SupportedPHPVersions[0];
-var b, T;
+var R, T;
 class PHPBrowser {
   /**
    * @param  server - The PHP server to browse.
    * @param  config - The browser configuration.
    */
   constructor(t, r = {}) {
-    d(this, b, void 0);
+    d(this, R, void 0);
     d(this, T, void 0);
-    this.requestHandler = t, p(this, b, {}), p(this, T, {
+    this.requestHandler = t, h(this, R, {}), h(this, T, {
       handleRedirects: !1,
       maxRedirects: 4,
       ...r
@@ -492,19 +497,19 @@ class PHPBrowser {
         if (!r.includes("="))
           continue;
         const s = r.indexOf("="), n = r.substring(0, s), o = r.substring(s + 1).split(";")[0];
-        c(this, b)[n] = o;
+        c(this, R)[n] = o;
       } catch (s) {
         console.error(s);
       }
   }
   serializeCookies() {
     const t = [];
-    for (const r in c(this, b))
-      t.push(`${r}=${c(this, b)[r]}`);
+    for (const r in c(this, R))
+      t.push(`${r}=${c(this, R)[r]}`);
     return t.join("; ");
   }
 }
-b = new WeakMap(), T = new WeakMap();
+R = new WeakMap(), T = new WeakMap();
 const DEFAULT_BASE_URL = "http://example.com";
 function toRelativeUrl(e) {
   return e.toString().substring(e.origin.length);
@@ -543,7 +548,7 @@ function fileToUint8Array(e) {
     }, r.readAsArrayBuffer(e);
   });
 }
-var g, H, N, R, k, y, C, S, L, Z, O, X, U, ee;
+var g, H, N, b, k, y, C, S, O, Z, L, X, U, ee;
 class PHPRequestHandler {
   /**
    * @param  php    - The PHP instance.
@@ -556,7 +561,7 @@ class PHPRequestHandler {
      * @param  fsPath - Absolute path of the static file to serve.
      * @returns The response.
      */
-    d(this, L);
+    d(this, O);
     /**
      * Runs the requested PHP file with all the request and $_SERVER
      * superglobals populated.
@@ -564,7 +569,7 @@ class PHPRequestHandler {
      * @param  request - The request.
      * @returns The response.
      */
-    d(this, O);
+    d(this, L);
     /**
      * Resolve the requested path to the filesystem path of the requested PHP file.
      *
@@ -578,28 +583,29 @@ class PHPRequestHandler {
     d(this, g, void 0);
     d(this, H, void 0);
     d(this, N, void 0);
-    d(this, R, void 0);
+    d(this, b, void 0);
     d(this, k, void 0);
     d(this, y, void 0);
     d(this, C, void 0);
     d(this, S, void 0);
-    p(this, S, new Semaphore({ concurrency: 1 }));
+    h(this, S, new Semaphore({ concurrency: 1 }));
     const {
       documentRoot: s = "/www/",
-      absoluteUrl: n = typeof location == "object" ? location == null ? void 0 : location.href : ""
+      absoluteUrl: n = typeof location == "object" ? location == null ? void 0 : location.href : "",
+      rewriteRules: o = []
     } = r;
-    this.php = t, p(this, g, s);
-    const o = new URL(n);
-    p(this, N, o.hostname), p(this, R, o.port ? Number(o.port) : o.protocol === "https:" ? 443 : 80), p(this, H, (o.protocol || "").replace(":", ""));
-    const i = c(this, R) !== 443 && c(this, R) !== 80;
-    p(this, k, [
+    this.php = t, h(this, g, s);
+    const i = new URL(n);
+    h(this, N, i.hostname), h(this, b, i.port ? Number(i.port) : i.protocol === "https:" ? 443 : 80), h(this, H, (i.protocol || "").replace(":", ""));
+    const a = c(this, b) !== 443 && c(this, b) !== 80;
+    h(this, k, [
       c(this, N),
-      i ? `:${c(this, R)}` : ""
-    ].join("")), p(this, y, o.pathname.replace(/\/+$/, "")), p(this, C, [
+      a ? `:${c(this, b)}` : ""
+    ].join("")), h(this, y, i.pathname.replace(/\/+$/, "")), h(this, C, [
       `${c(this, H)}://`,
       c(this, k),
       c(this, y)
-    ].join(""));
+    ].join("")), this.rewriteRules = o;
   }
   /** @inheritDoc */
   pathToInternalUrl(t) {
@@ -626,14 +632,14 @@ class PHPRequestHandler {
     const r = t.url.startsWith("http://") || t.url.startsWith("https://"), s = new URL(
       t.url,
       r ? void 0 : DEFAULT_BASE_URL
-    ), n = removePathPrefix(
-      s.pathname,
-      c(this, y)
+    ), n = applyRewriteRules(
+      removePathPrefix(s.pathname, c(this, y)),
+      this.rewriteRules
     ), o = `${c(this, g)}${n}`;
-    return seemsLikeAPHPRequestHandlerPath(o) ? await f(this, O, X).call(this, t, s) : f(this, L, Z).call(this, o);
+    return seemsLikeAPHPRequestHandlerPath(o) ? await f(this, L, X).call(this, t, s) : f(this, O, Z).call(this, o);
   }
 }
-g = new WeakMap(), H = new WeakMap(), N = new WeakMap(), R = new WeakMap(), k = new WeakMap(), y = new WeakMap(), C = new WeakMap(), S = new WeakMap(), L = new WeakSet(), Z = function(t) {
+g = new WeakMap(), H = new WeakMap(), N = new WeakMap(), b = new WeakMap(), k = new WeakMap(), y = new WeakMap(), C = new WeakMap(), S = new WeakMap(), O = new WeakSet(), Z = function(t) {
   if (!this.php.fileExists(t))
     return new PHPResponse(
       404,
@@ -658,8 +664,8 @@ g = new WeakMap(), H = new WeakMap(), N = new WeakMap(), R = new WeakMap(), k =
     },
     r
   );
-}, O = new WeakSet(), X = async function(t, r) {
-  var n, o;
+}, L = new WeakSet(), X = async function(t, r) {
+  var n;
   if (c(this, S).running > 0 && ((n = t.headers) == null ? void 0 : n["x-request-issuer"]) === "php")
     return console.warn(
       "Possible deadlock: Called request() before the previous request() have finished. PHP likely issued an HTTP call to itself. Normally this would lead to infinite waiting as Request 1 holds the lock that the Request 2 is waiting to acquire. That's not useful, so PHPRequestHandler will return error 502 instead."
@@ -674,28 +680,20 @@ g = new WeakMap(), H = new WeakMap(), N = new WeakMap(), R = new WeakMap(), k =
       "HTTPS",
       c(this, C).startsWith("https://") ? "on" : ""
     );
-    let i = "GET";
-    const a = {
+    let o = "GET";
+    const i = {
       host: c(this, k),
       ...normalizeHeaders(t.headers || {})
     };
-    let l = t.body;
-    if (typeof l == "object" && !(l instanceof Uint8Array)) {
-      i = "POST";
-      const { bytes: h, contentType: m } = await encodeAsMultipart(l);
-      l = h, a["content-type"] = m;
+    let a = t.body;
+    if (typeof a == "object" && !(a instanceof Uint8Array)) {
+      o = "POST";
+      const { bytes: u, contentType: p } = await encodeAsMultipart(a);
+      a = u, i["content-type"] = p;
     }
-    let u;
+    let l;
     try {
-      let h = r.pathname;
-      if ((o = t.headers) != null && o["x-rewrite-url"])
-        try {
-          h = new URL(
-            t.headers["x-rewrite-url"]
-          ).pathname;
-        } catch {
-        }
-      u = f(this, U, ee).call(this, h);
+      l = f(this, U, ee).call(this, r.pathname);
     } catch {
       return new PHPResponse(
         404,
@@ -709,17 +707,17 @@ g = new WeakMap(), H = new WeakMap(), N = new WeakMap(), R = new WeakMap(), k =
         c(this, y)
       ),
       protocol: c(this, H),
-      method: t.method || i,
-      body: l,
-      scriptPath: u,
-      headers: a
+      method: t.method || o,
+      body: a,
+      scriptPath: l,
+      headers: i
     });
   } finally {
     s();
   }
 }, U = new WeakSet(), ee = function(t) {
   let r = removePathPrefix(t, c(this, y));
-  r.includes(".php") ? r = r.split(".php")[0] + ".php" : this.php.isDir(`${c(this, g)}${r}`) ? (r.endsWith("/") || (r = `${r}/`), r = `${r}index.php`) : r = "/index.php";
+  r = applyRewriteRules(r, this.rewriteRules), r.includes(".php") ? r = r.split(".php")[0] + ".php" : this.php.isDir(`${c(this, g)}${r}`) ? (r.endsWith("/") || (r = `${r}/`), r = `${r}index.php`) : r = "/index.php";
   const s = `${c(this, g)}${r}`;
   if (this.php.fileExists(s))
     return s;
@@ -774,6 +772,12 @@ function seemsLikeAPHPFile(e) {
 function seemsLikeADirectoryRoot(e) {
   return !e.split("/").pop().includes(".");
 }
+function applyRewriteRules(e, t) {
+  for (const r of t)
+    if (new RegExp(r.match).test(e))
+      return e.replace(r.match, r.replacement);
+  return e;
+}
 const FileErrorCodes = {
   0: "No error occurred. System call completed successfully.",
   1: "Argument list too long.",
@@ -867,8 +871,8 @@ function rethrowFileSystemError(e = "") {
       } catch (a) {
         const l = typeof a == "object" ? a == null ? void 0 : a.errno : null;
         if (l in FileErrorCodes) {
-          const u = FileErrorCodes[l], h = typeof i[0] == "string" ? i[0] : null, m = h !== null ? e.replaceAll("{path}", h) : e;
-          throw new Error(`${m}: ${u}`, {
+          const u = FileErrorCodes[l], p = typeof i[0] == "string" ? i[0] : null, _ = p !== null ? e.replaceAll("{path}", p) : e;
+          throw new Error(`${_}: ${u}`, {
             cause: a
           });
         }
@@ -949,7 +953,7 @@ class BasePHP {
     d(this, v, void 0);
     d(this, P, void 0);
     d(this, M, void 0);
-    p(this, x, []), p(this, w, !1), p(this, E, null), p(this, v, {}), p(this, P, /* @__PURE__ */ new Map()), p(this, M, []), this.semaphore = new Semaphore({ concurrency: 1 }), e !== void 0 && this.initializeRuntime(e), t && (this.requestHandler = new PHPBrowser(
+    h(this, x, []), h(this, w, !1), h(this, E, null), h(this, v, {}), h(this, P, /* @__PURE__ */ new Map()), h(this, M, []), this.semaphore = new Semaphore({ concurrency: 1 }), e !== void 0 && this.initializeRuntime(e), t && (this.requestHandler = new PHPBrowser(
       new PHPRequestHandler(this, t)
     ));
   }
@@ -1005,7 +1009,7 @@ class BasePHP {
           return n;
       }
       return "";
-    }, p(this, E, improveWASMErrorReporting(t)), this.dispatchEvent({
+    }, h(this, E, improveWASMErrorReporting(t)), this.dispatchEvent({
       type: "runtime.initialized"
     });
   }
@@ -1020,13 +1024,13 @@ class BasePHP {
       throw new Error(
         "Could not set SAPI name. This can only be done before the PHP WASM module is initialized.Did you already dispatch any requests?"
       );
-    p(this, A, e);
+    h(this, A, e);
   }
   /** @inheritDoc */
   setPhpIniPath(e) {
     if (c(this, w))
       throw new Error("Cannot set PHP ini path after calling run().");
-    p(this, F, e), this[__private__dont__use].ccall(
+    h(this, F, e), this[__private__dont__use].ccall(
       "wasm_set_phpini_path",
       null,
       ["string"],
@@ -1054,7 +1058,7 @@ class BasePHP {
     const t = await this.semaphore.acquire();
     let r;
     try {
-      if (c(this, w) || (f(this, W, te).call(this), p(this, w, !0)), e.scriptPath && !this.fileExists(e.scriptPath))
+      if (c(this, w) || (f(this, W, te).call(this), h(this, w, !0)), e.scriptPath && !this.fileExists(e.scriptPath))
         throw new Error(
           `The script path "${e.scriptPath}" does not exist.`
         );
@@ -1077,6 +1081,11 @@ class BasePHP {
         throw l.output = a, console.error(l), l;
       }
       return i;
+    } catch (s) {
+      throw this.dispatchEvent({
+        type: "request.error",
+        error: s
+      }), s;
     } finally {
       try {
         r && this[__private__dont__use].free(r);
@@ -1197,7 +1206,7 @@ class BasePHP {
       this[__private__dont__use]._exit(e);
     } catch {
     }
-    p(this, w, !1), p(this, E, null), delete this[__private__dont__use].onMessage, delete this[__private__dont__use];
+    h(this, w, !1), h(this, E, null), delete this[__private__dont__use].onMessage, delete this[__private__dont__use];
   }
 }
 x = new WeakMap(), F = new WeakMap(), A = new WeakMap(), w = new WeakMap(), E = new WeakMap(), v = new WeakMap(), P = new WeakMap(), M = new WeakMap(), W = new WeakSet(), te = function() {
@@ -1366,8 +1375,8 @@ x = new WeakMap(), F = new WeakMap(), A = new WeakMap(), w = new WeakMap(), E =
       var l;
       t = (u) => {
         console.error(u), console.error(u.error);
-        const h = new Error("Rethrown");
-        h.cause = u.error, h.betterMessage = u.message, i(h);
+        const p = new Error("Rethrown");
+        p.cause = u.error, p.betterMessage = u.message, i(p);
       }, (l = c(this, E)) == null || l.addEventListener(
         "error",
         t
@@ -1392,7 +1401,7 @@ x = new WeakMap(), F = new WeakMap(), A = new WeakMap(), w = new WeakMap(), E =
     const i = o, a = "betterMessage" in i ? i.betterMessage : i.message, l = new Error(a);
     throw l.cause = i, console.error(l), l;
   } finally {
-    (n = c(this, E)) == null || n.removeEventListener("error", t), p(this, v, {});
+    (n = c(this, E)) == null || n.removeEventListener("error", t), h(this, v, {});
   }
   const { headers: r, httpStatusCode: s } = f(this, B, re).call(this);
   return new PHPResponse(
@@ -1508,27 +1517,27 @@ function expose(e, t = globalThis, r = ["*"]) {
     const { id: o, type: i, path: a } = Object.assign({ path: [] }, n.data), l = (n.data.argumentList || []).map(fromWireValue);
     let u;
     try {
-      const h = a.slice(0, -1).reduce((_, I) => _[I], e), m = a.reduce((_, I) => _[I], e);
+      const p = a.slice(0, -1).reduce((m, I) => m[I], e), _ = a.reduce((m, I) => m[I], e);
       switch (i) {
         case "GET":
-          u = m;
+          u = _;
           break;
         case "SET":
-          h[a.slice(-1)[0]] = fromWireValue(n.data.value), u = !0;
+          p[a.slice(-1)[0]] = fromWireValue(n.data.value), u = !0;
           break;
         case "APPLY":
-          u = m.apply(h, l);
+          u = _.apply(p, l);
           break;
         case "CONSTRUCT":
           {
-            const _ = new m(...l);
-            u = proxy(_);
+            const m = new _(...l);
+            u = proxy(m);
           }
           break;
         case "ENDPOINT":
           {
-            const { port1: _, port2: I } = new MessageChannel();
-            expose(e, I), u = transfer(_, [_]);
+            const { port1: m, port2: I } = new MessageChannel();
+            expose(e, I), u = transfer(m, [m]);
           }
           break;
         case "RELEASE":
@@ -1537,18 +1546,18 @@ function expose(e, t = globalThis, r = ["*"]) {
         default:
           return;
       }
-    } catch (h) {
-      u = { value: h, [throwMarker]: 0 };
+    } catch (p) {
+      u = { value: p, [throwMarker]: 0 };
     }
-    Promise.resolve(u).catch((h) => ({ value: h, [throwMarker]: 0 })).then((h) => {
-      const [m, _] = toWireValue(h);
-      t.postMessage(Object.assign(Object.assign({}, m), { id: o }), _), i === "RELEASE" && (t.removeEventListener("message", s), closeEndPoint(t), finalizer in e && typeof e[finalizer] == "function" && e[finalizer]());
-    }).catch((h) => {
-      const [m, _] = toWireValue({
+    Promise.resolve(u).catch((p) => ({ value: p, [throwMarker]: 0 })).then((p) => {
+      const [_, m] = toWireValue(p);
+      t.postMessage(Object.assign(Object.assign({}, _), { id: o }), m), i === "RELEASE" && (t.removeEventListener("message", s), closeEndPoint(t), finalizer in e && typeof e[finalizer] == "function" && e[finalizer]());
+    }).catch((p) => {
+      const [_, m] = toWireValue({
         value: new TypeError("Unserializable return value"),
         [throwMarker]: 0
       });
-      t.postMessage(Object.assign(Object.assign({}, m), { id: o }), _);
+      t.postMessage(Object.assign(Object.assign({}, _), { id: o }), m);
     });
   }), t.start && t.start();
 }
@@ -1608,7 +1617,7 @@ function createProxy(e, t = [], r = function() {
       const [l, u] = toWireValue(a);
       return requestResponseMessage(e, {
         type: "SET",
-        path: [...t, i].map((h) => h.toString()),
+        path: [...t, i].map((p) => p.toString()),
         value: l
       }, u).then(fromWireValue);
     },
@@ -1621,12 +1630,12 @@ function createProxy(e, t = [], r = function() {
         }).then(fromWireValue);
       if (l === "bind")
         return createProxy(e, t.slice(0, -1));
-      const [u, h] = processArguments(a);
+      const [u, p] = processArguments(a);
       return requestResponseMessage(e, {
         type: "APPLY",
-        path: t.map((m) => m.toString()),
+        path: t.map((_) => _.toString()),
         argumentList: u
-      }, h).then(fromWireValue);
+      }, p).then(fromWireValue);
     },
     construct(o, i) {
       throwIfProxyReleased(s);
@@ -1996,10 +2005,10 @@ function responseTo(e, t) {
 async function registerServiceWorker(e, t, r) {
   const s = navigator.serviceWorker;
   if (!s)
-    throw location.protocol === "https:" ? new Error(
-      "Service workers are not supported in this browser."
-    ) : new Error(
-      "WordPress Playground requires service workers which are only supported on HTTPS sites. This site does not use HTTPS, please retry on one that does. "
+    throw window.isSecureContext ? new PhpWasmError(
+      "Service workers are not supported in your browser."
+    ) : new PhpWasmError(
+      "WordPress Playground uses service workers and may only work on HTTPS and http://localhost/ sites, but the current site is neither."
     );
   console.debug("[window][sw] Registering a Service Worker"), await (await s.register(r, {
     type: "module",
@@ -2008,7 +2017,7 @@ async function registerServiceWorker(e, t, r) {
   })).update(), navigator.serviceWorker.addEventListener(
     "message",
     async function(i) {
-      if (console.debug("[window][sw] Message from ServiceWorker", i), t && i.data.scope !== t)
+      if (t && i.data.scope !== t)
         return;
       const a = i.data.args || [], l = i.data.method, u = await e[l](...a);
       i.source.postMessage(responseTo(i.data.requestId, u));