@php-wasm/logger 0.6.7 → 0.6.9

package/index.d.ts

@@ -1 +1 @@
-export * from './logger';
+export * from './lib/logger';

package/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class i{constructor(e){this.LOG_PREFIX="Playground",this.windowConnected=!1,this.lastPHPLogLength=0,this.errorLogPath="/wordpress/wp-content/debug.log",e&&(this.errorLogPath=e)}async getRequestPhpErrorLog(e){return await e.fileExists(this.errorLogPath)?await e.readFileAsText(this.errorLogPath):""}logWindowError(e){this.log(`${e.message} in ${e.filename} on line ${e.lineno}:${e.colno}`,"fatal")}logUnhandledRejection(e){this.log(`${e.reason.stack}`,"fatal")}addWindowErrorListener(){this.windowConnected||typeof window>"u"||(window.addEventListener("error",this.logWindowError.bind(this)),window.addEventListener("unhandledrejection",this.logUnhandledRejection.bind(this)),window.addEventListener("rejectionhandled",this.logUnhandledRejection.bind(this)),this.windowConnected=!0)}addPlaygroundRequestEndListener(e){e.addEventListener("request.end",async()=>{const t=await this.getRequestPhpErrorLog(e);t.length>this.lastPHPLogLength&&(this.logRaw(t.substring(this.lastPHPLogLength)),this.lastPHPLogLength=t.length)})}formatLogDate(e){const t=new Intl.DateTimeFormat("en-GB",{year:"numeric",month:"short",day:"2-digit",timeZone:"UTC"}).format(e).replace(/ /g,"-"),n=new Intl.DateTimeFormat("en-GB",{hour:"2-digit",minute:"2-digit",second:"2-digit",hour12:!1,timeZone:"UTC",timeZoneName:"short"}).format(e);return t+" "+n}formatMessage(e,t){return`[${this.formatLogDate(new Date)}] ${this.LOG_PREFIX} ${t}: ${e}`}log(e,t){t===void 0&&(t="info");const n=this.formatMessage(e,t);this.logRaw(n)}logRaw(e){console.debug(e)}}const r=new i;function s(o){o.addWindowErrorListener()}function a(o,e){o.addPlaygroundRequestEndListener(e)}exports.Logger=i;exports.collectPhpLogs=a;exports.collectWindowErrors=s;exports.logger=r;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const u=function(){var o;return typeof process<"u"&&((o=process.release)==null?void 0:o.name)==="node"?"NODE":typeof window<"u"?"WEB":typeof WorkerGlobalScope<"u"&&self instanceof WorkerGlobalScope?"WORKER":"NODE"}();if(u==="NODE"){let o=function(t){return new Promise(function(r,n){t.onload=t.onerror=function(s){t.onload=t.onerror=null,s.type==="load"?r(t.result):n(new Error("Failed to read the blob/file"))}})},e=function(){const t=new Uint8Array([1,2,3,4]),n=new File([t],"test").stream();try{return n.getReader({mode:"byob"}),!0}catch{return!1}};if(typeof File>"u"){class t extends Blob{constructor(n,s,a){super(n);let i;a!=null&&a.lastModified&&(i=new Date),(!i||isNaN(i.getFullYear()))&&(i=new Date),this.lastModifiedDate=i,this.lastModified=i.getMilliseconds(),this.name=s||""}}global.File=t}typeof Blob.prototype.arrayBuffer>"u"&&(Blob.prototype.arrayBuffer=function(){const r=new FileReader;return r.readAsArrayBuffer(this),o(r)}),typeof Blob.prototype.text>"u"&&(Blob.prototype.text=function(){const r=new FileReader;return r.readAsText(this),o(r)}),(typeof Blob.prototype.stream>"u"||!e())&&(Blob.prototype.stream=function(){let t=0;const r=this;return new ReadableStream({type:"bytes",autoAllocateChunkSize:512*1024,async pull(n){const s=n.byobRequest.view,i=await r.slice(t,t+s.byteLength).arrayBuffer(),d=new Uint8Array(i);new Uint8Array(s.buffer).set(d);const l=d.byteLength;n.byobRequest.respond(l),t+=l,t>=r.size&&n.close()}})})}if(u==="NODE"&&typeof CustomEvent>"u"){class o extends Event{constructor(t,r={}){super(t,r),this.detail=r.detail}initCustomEvent(){}}globalThis.CustomEvent=o}class f extends EventTarget{constructor(e){super(),this.fatalErrorEvent="playground-fatal-error",this.logs=[],this.windowConnected=!1,this.lastPHPLogLength=0,this.errorLogPath="/wordpress/wp-content/debug.log",e&&(this.errorLogPath=e)}async getRequestPhpErrorLog(e){return await e.fileExists(this.errorLogPath)?await e.readFileAsText(this.errorLogPath):""}logWindowError(e){this.log(`${e.message} in ${e.filename} on line ${e.lineno}:${e.colno}`,"Error")}logUnhandledRejection(e){if(!(e!=null&&e.reason))return;const t=(e==null?void 0:e.reason.stack)??e.reason;this.log(t,"Error")}addWindowErrorListener(){this.windowConnected||typeof window>"u"||(window.addEventListener("error",this.logWindowError.bind(this)),window.addEventListener("unhandledrejection",this.logUnhandledRejection.bind(this)),window.addEventListener("rejectionhandled",this.logUnhandledRejection.bind(this)),this.windowConnected=!0)}addPlaygroundRequestEndListener(e){e.addEventListener("request.end",async()=>{const t=await this.getRequestPhpErrorLog(e);t.length>this.lastPHPLogLength&&(this.logRaw(t.substring(this.lastPHPLogLength)),this.lastPHPLogLength=t.length)}),e.addEventListener("request.error",t=>{t=t,t.error&&(this.log(`${t.error.message} ${t.error.stack}`,"Fatal","PHP-WASM"),this.dispatchEvent(new CustomEvent(this.fatalErrorEvent,{detail:{logs:this.getLogs(),source:t.source}})))})}formatLogDate(e){const t=new Intl.DateTimeFormat("en-GB",{year:"numeric",month:"short",day:"2-digit",timeZone:"UTC"}).format(e).replace(/ /g,"-"),r=new Intl.DateTimeFormat("en-GB",{hour:"2-digit",minute:"2-digit",second:"2-digit",hour12:!1,timeZone:"UTC",timeZoneName:"short"}).format(e);return t+" "+r}formatMessage(e,t,r){return`[${this.formatLogDate(new Date)}] ${r} ${t}: ${e}`}log(e,t,r){t===void 0&&(t="Info");const n=this.formatMessage(e,t,r??"Playground");this.logRaw(n)}logRaw(e){this.logs.push(e),console.debug(e)}getLogs(){return this.logs}}const c=new f;function g(o){o.addWindowErrorListener()}function h(o,e){o.addPlaygroundRequestEndListener(e)}function w(o,e){o.addEventListener(o.fatalErrorEvent,e)}exports.Logger=f;exports.addFatalErrorListener=w;exports.collectPhpLogs=h;exports.collectWindowErrors=g;exports.logger=c;

package/index.mjs

@@ -1,6 +1,75 @@
-class i {
-  constructor(t) {
-    this.LOG_PREFIX = "Playground", this.windowConnected = !1, this.lastPHPLogLength = 0, this.errorLogPath = "/wordpress/wp-content/debug.log", t && (this.errorLogPath = t);
+const u = function() {
+  var o;
+  return typeof process < "u" && ((o = process.release) == null ? void 0 : o.name) === "node" ? "NODE" : typeof window < "u" ? "WEB" : (
+    // @ts-ignore
+    typeof WorkerGlobalScope < "u" && // @ts-ignore
+    self instanceof WorkerGlobalScope ? "WORKER" : "NODE"
+  );
+}();
+if (u === "NODE") {
+  let o = function(t) {
+    return new Promise(function(r, n) {
+      t.onload = t.onerror = function(s) {
+        t.onload = t.onerror = null, s.type === "load" ? r(t.result) : n(new Error("Failed to read the blob/file"));
+      };
+    });
+  }, e = function() {
+    const t = new Uint8Array([1, 2, 3, 4]), n = new File([t], "test").stream();
+    try {
+      return n.getReader({ mode: "byob" }), !0;
+    } catch {
+      return !1;
+    }
+  };
+  if (typeof File > "u") {
+    class t extends Blob {
+      constructor(n, s, a) {
+        super(n);
+        let i;
+        a != null && a.lastModified && (i = /* @__PURE__ */ new Date()), (!i || isNaN(i.getFullYear())) && (i = /* @__PURE__ */ new Date()), this.lastModifiedDate = i, this.lastModified = i.getMilliseconds(), this.name = s || "";
+      }
+    }
+    global.File = t;
+  }
+  typeof Blob.prototype.arrayBuffer > "u" && (Blob.prototype.arrayBuffer = function() {
+    const r = new FileReader();
+    return r.readAsArrayBuffer(this), o(r);
+  }), typeof Blob.prototype.text > "u" && (Blob.prototype.text = function() {
+    const r = new FileReader();
+    return r.readAsText(this), o(r);
+  }), (typeof Blob.prototype.stream > "u" || !e()) && (Blob.prototype.stream = function() {
+    let t = 0;
+    const r = this;
+    return new ReadableStream({
+      type: "bytes",
+      // 0.5 MB seems like a reasonable chunk size, let's adjust
+      // this if needed.
+      autoAllocateChunkSize: 512 * 1024,
+      async pull(n) {
+        const s = n.byobRequest.view, i = await r.slice(
+          t,
+          t + s.byteLength
+        ).arrayBuffer(), d = new Uint8Array(i);
+        new Uint8Array(s.buffer).set(d);
+        const l = d.byteLength;
+        n.byobRequest.respond(l), t += l, t >= r.size && n.close();
+      }
+    });
+  });
+}
+if (u === "NODE" && typeof CustomEvent > "u") {
+  class o extends Event {
+    constructor(t, r = {}) {
+      super(t, r), this.detail = r.detail;
+    }
+    initCustomEvent() {
+    }
+  }
+  globalThis.CustomEvent = o;
+}
+class f extends EventTarget {
+  constructor(e) {
+    super(), this.fatalErrorEvent = "playground-fatal-error", this.logs = [], this.windowConnected = !1, this.lastPHPLogLength = 0, this.errorLogPath = "/wordpress/wp-content/debug.log", e && (this.errorLogPath = e);
   }
   /**
    * Read the WordPress debug.log file and return its content.
@@ -8,18 +77,18 @@ class i {
    * @param UniversalPHP playground instance
    * @returns string The content of the debug.log file
    */
-  async getRequestPhpErrorLog(t) {
-    return await t.fileExists(this.errorLogPath) ? await t.readFileAsText(this.errorLogPath) : "";
+  async getRequestPhpErrorLog(e) {
+    return await e.fileExists(this.errorLogPath) ? await e.readFileAsText(this.errorLogPath) : "";
   }
   /**
    * Log Windows errors.
    *
    * @param ErrorEvent event
    */
-  logWindowError(t) {
+  logWindowError(e) {
     this.log(
-      `${t.message} in ${t.filename} on line ${t.lineno}:${t.colno}`,
-      "fatal"
+      `${e.message} in ${e.filename} on line ${e.lineno}:${e.colno}`,
+      "Error"
     );
   }
   /**
@@ -27,8 +96,11 @@ class i {
    *
    * @param PromiseRejectionEvent event
    */
-  logUnhandledRejection(t) {
-    this.log(`${t.reason.stack}`, "fatal");
+  logUnhandledRejection(e) {
+    if (!(e != null && e.reason))
+      return;
+    const t = (e == null ? void 0 : e.reason.stack) ?? e.reason;
+    this.log(t, "Error");
   }
   /**
    * Register a listener for the window error events and log the data.
@@ -46,10 +118,23 @@ class i {
    * Register a listener for the request.end event and log the data.
    * @param UniversalPHP playground instance
    */
-  addPlaygroundRequestEndListener(t) {
-    t.addEventListener("request.end", async () => {
-      const e = await this.getRequestPhpErrorLog(t);
-      e.length > this.lastPHPLogLength && (this.logRaw(e.substring(this.lastPHPLogLength)), this.lastPHPLogLength = e.length);
+  addPlaygroundRequestEndListener(e) {
+    e.addEventListener("request.end", async () => {
+      const t = await this.getRequestPhpErrorLog(e);
+      t.length > this.lastPHPLogLength && (this.logRaw(t.substring(this.lastPHPLogLength)), this.lastPHPLogLength = t.length);
+    }), e.addEventListener("request.error", (t) => {
+      t = t, t.error && (this.log(
+        `${t.error.message} ${t.error.stack}`,
+        "Fatal",
+        "PHP-WASM"
+      ), this.dispatchEvent(
+        new CustomEvent(this.fatalErrorEvent, {
+          detail: {
+            logs: this.getLogs(),
+            source: t.source
+          }
+        })
+      ));
     });
   }
   /**
@@ -58,58 +143,75 @@ class i {
    * @param date
    * @returns string
    */
-  formatLogDate(t) {
-    const e = new Intl.DateTimeFormat("en-GB", {
+  formatLogDate(e) {
+    const t = new Intl.DateTimeFormat("en-GB", {
       year: "numeric",
       month: "short",
       day: "2-digit",
       timeZone: "UTC"
-    }).format(t).replace(/ /g, "-"), n = new Intl.DateTimeFormat("en-GB", {
+    }).format(e).replace(/ /g, "-"), r = new Intl.DateTimeFormat("en-GB", {
       hour: "2-digit",
       minute: "2-digit",
       second: "2-digit",
       hour12: !1,
       timeZone: "UTC",
       timeZoneName: "short"
-    }).format(t);
-    return e + " " + n;
+    }).format(e);
+    return t + " " + r;
   }
   /**
    * Format log message and severity and log it.
    * @param string message
    * @param LogSeverity severity
+   * @param string prefix
    */
-  formatMessage(t, e) {
-    return `[${this.formatLogDate(/* @__PURE__ */ new Date())}] ${this.LOG_PREFIX} ${e}: ${t}`;
+  formatMessage(e, t, r) {
+    return `[${this.formatLogDate(/* @__PURE__ */ new Date())}] ${r} ${t}: ${e}`;
   }
   /**
    * Log message with severity and timestamp.
    * @param string message
    * @param LogSeverity severity
+   * @param string prefix
    */
-  log(t, e) {
-    e === void 0 && (e = "info");
-    const n = this.formatMessage(t, e);
+  log(e, t, r) {
+    t === void 0 && (t = "Info");
+    const n = this.formatMessage(
+      e,
+      t,
+      r ?? "Playground"
+    );
     this.logRaw(n);
   }
   /**
    * Log message without severity and timestamp.
    * @param string log
    */
-  logRaw(t) {
-    console.debug(t);
+  logRaw(e) {
+    this.logs.push(e), console.debug(e);
+  }
+  /**
+   * Get all logs.
+   * @returns string[]
+   */
+  getLogs() {
+    return this.logs;
   }
 }
-const r = new i();
-function s(o) {
+const c = new f();
+function h(o) {
   o.addWindowErrorListener();
 }
-function a(o, t) {
-  o.addPlaygroundRequestEndListener(t);
+function g(o, e) {
+  o.addPlaygroundRequestEndListener(e);
+}
+function w(o, e) {
+  o.addEventListener(o.fatalErrorEvent, e);
 }
 export {
-  i as Logger,
-  a as collectPhpLogs,
-  s as collectWindowErrors,
-  r as logger
+  f as Logger,
+  w as addFatalErrorListener,
+  g as collectPhpLogs,
+  h as collectWindowErrors,
+  c as logger
 };

package/{logger.d.ts → lib/logger.d.ts}

@@ -1,13 +1,21 @@
-import { UniversalPHP } from '../../universal/src/index.ts/src/lib/universal-php';
+import { UniversalPHP } from '../../../universal/src/index.ts/src/lib/universal-php';
 /**
  * Log severity levels.
  */
-export type LogSeverity = 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+export type LogSeverity = 'Debug' | 'Info' | 'Warn' | 'Error' | 'Fatal';
+/**
+ * Log prefix.
+ */
+export type LogPrefix = 'Playground' | 'PHP-WASM';
 /**
  * A logger for Playground.
  */
-export declare class Logger {
-    private readonly LOG_PREFIX;
+export declare class Logger extends EventTarget {
+    readonly fatalErrorEvent = "playground-fatal-error";
+    /**
+     * Log messages
+     */
+    private logs;
     /**
      * Whether the window events are connected.
      */
@@ -60,19 +68,26 @@ export declare class Logger {
      * Format log message and severity and log it.
      * @param string message
      * @param LogSeverity severity
+     * @param string prefix
      */
-    formatMessage(message: string, severity: LogSeverity): string;
+    formatMessage(message: string, severity: LogSeverity, prefix: string): string;
     /**
      * Log message with severity and timestamp.
      * @param string message
      * @param LogSeverity severity
+     * @param string prefix
      */
-    log(message: string, severity?: LogSeverity): void;
+    log(message: string, severity?: LogSeverity, prefix?: LogPrefix): void;
     /**
      * Log message without severity and timestamp.
      * @param string log
      */
     logRaw(log: string): void;
+    /**
+     * Get all logs.
+     * @returns string[]
+     */
+    getLogs(): string[];
 }
 /**
  * The logger instance.
@@ -89,3 +104,12 @@ export declare function collectWindowErrors(loggerInstance: Logger): void;
  * @param loggerInstance The logger instance
  */
 export declare function collectPhpLogs(loggerInstance: Logger, playground: UniversalPHP): void;
+/**
+ * Add a listener for the fatal Playground errors.
+ * These errors include Playground errors like Asyncify errors. PHP errors won't trigger this event.
+ * The callback function will receive an Event object with logs in the detail property.
+ *
+ * @param loggerInstance The logger instance
+ * @param callback The callback function
+ */
+export declare function addFatalErrorListener(loggerInstance: Logger, callback: EventListenerOrEventListenerObject): void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@php-wasm/logger",
-	"version": "0.6.7",
+	"version": "0.6.9",
 	"description": "A logger for PHP-wasm clients like Playground and WP-now.",
 	"repository": {
 		"type": "git",
@@ -25,5 +25,5 @@
 		"node": ">=18.18.2",
 		"npm": ">=8.11.0"
 	},
-	"gitHead": "c4c52563eee8997b94cd4a0875e10fb5d8ccda42"
+	"gitHead": "f6b98ad6d05617ee8cb1234c21318fdde17a6e56"
 }