@php-wasm/logger 0.6.16 → 0.7.0

package/index.js

@@ -1 +1 @@
-"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;
+"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(i){t.onload=t.onerror=null,i.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,i,a){super(n);let s;a!=null&&a.lastModified&&(s=new Date),(!s||isNaN(s.getFullYear()))&&(s=new Date),this.lastModifiedDate=s,this.lastModified=s.getMilliseconds(),this.name=i||""}}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 i=n.byobRequest.view,s=await r.slice(t,t+i.byteLength).arrayBuffer(),d=new Uint8Array(s);new Uint8Array(i.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 c extends EventTarget{constructor(e){super(),this.fatalErrorEvent="playground-fatal-error",this.logs=[],this.windowConnected=!1,this.lastPHPLogLength=0,this.context={},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)}addServiceWorkerMessageListener(){navigator.serviceWorker.addEventListener("message",e=>{var t;((t=e.data)==null?void 0:t.numberOfOpenPlaygroundTabs)!==void 0&&this.addContext({numberOfOpenPlaygroundTabs:e.data.numberOfOpenPlaygroundTabs})})}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]}addContext(e){this.context={...this.context,...e}}getContext(){return{...this.context}}}const f=new c;function h(o){o.addWindowErrorListener(),o.addServiceWorkerMessageListener()}function g(o,e){o.addPlaygroundRequestEndListener(e)}function m(o){o.addEventListener("activate",()=>{o.clients.matchAll().then(e=>{const t={numberOfOpenPlaygroundTabs:e.filter(r=>r.frameType==="top-level").length};o.clients.matchAll({includeUncontrolled:!0}).then(r=>{for(const n of r)n.postMessage(t)})})})}function w(o,e){o.addEventListener(o.fatalErrorEvent,e)}exports.Logger=c;exports.addCrashListener=w;exports.collectPhpLogs=g;exports.collectWindowErrors=h;exports.logger=f;exports.reportServiceWorkerMetrics=m;

package/index.mjs

@@ -1,42 +1,42 @@
 const u = function() {
-  var o;
-  return typeof process < "u" && ((o = process.release) == null ? void 0 : o.name) === "node" ? "NODE" : typeof window < "u" ? "WEB" : (
+  var n;
+  return typeof process < "u" && ((n = process.release) == null ? void 0 : n.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"));
+  let n = function(t) {
+    return new Promise(function(r, o) {
+      t.onload = t.onerror = function(i) {
+        t.onload = t.onerror = null, i.type === "load" ? r(t.result) : o(new Error("Failed to read the blob/file"));
       };
     });
   }, e = function() {
-    const t = new Uint8Array([1, 2, 3, 4]), n = new File([t], "test").stream();
+    const t = new Uint8Array([1, 2, 3, 4]), o = new File([t], "test").stream();
     try {
-      return n.getReader({ mode: "byob" }), !0;
+      return o.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 || "";
+      constructor(o, i, a) {
+        super(o);
+        let s;
+        a != null && a.lastModified && (s = /* @__PURE__ */ new Date()), (!s || isNaN(s.getFullYear())) && (s = /* @__PURE__ */ new Date()), this.lastModifiedDate = s, this.lastModified = s.getMilliseconds(), this.name = i || "";
       }
     }
     global.File = t;
   }
   typeof Blob.prototype.arrayBuffer > "u" && (Blob.prototype.arrayBuffer = function() {
     const r = new FileReader();
-    return r.readAsArrayBuffer(this), o(r);
+    return r.readAsArrayBuffer(this), n(r);
   }), typeof Blob.prototype.text > "u" && (Blob.prototype.text = function() {
     const r = new FileReader();
-    return r.readAsText(this), o(r);
+    return r.readAsText(this), n(r);
   }), (typeof Blob.prototype.stream > "u" || !e()) && (Blob.prototype.stream = function() {
     let t = 0;
     const r = this;
@@ -45,31 +45,31 @@ if (u === "NODE") {
       // 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(
+      async pull(o) {
+        const i = o.byobRequest.view, s = await r.slice(
           t,
-          t + s.byteLength
-        ).arrayBuffer(), d = new Uint8Array(i);
-        new Uint8Array(s.buffer).set(d);
+          t + i.byteLength
+        ).arrayBuffer(), d = new Uint8Array(s);
+        new Uint8Array(i.buffer).set(d);
         const l = d.byteLength;
-        n.byobRequest.respond(l), t += l, t >= r.size && n.close();
+        o.byobRequest.respond(l), t += l, t >= r.size && o.close();
       }
     });
   });
 }
 if (u === "NODE" && typeof CustomEvent > "u") {
-  class o extends Event {
+  class n extends Event {
     constructor(t, r = {}) {
       super(t, r), this.detail = r.detail;
     }
     initCustomEvent() {
     }
   }
-  globalThis.CustomEvent = o;
+  globalThis.CustomEvent = n;
 }
 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);
+    super(), this.fatalErrorEvent = "playground-fatal-error", this.logs = [], this.windowConnected = !1, this.lastPHPLogLength = 0, this.context = {}, this.errorLogPath = "/wordpress/wp-content/debug.log", e && (this.errorLogPath = e);
   }
   /**
    * Read the WordPress debug.log file and return its content.
@@ -114,6 +114,18 @@ class f extends EventTarget {
       this.logUnhandledRejection.bind(this)
     ), this.windowConnected = !0);
   }
+  /**
+   * Register a listener for service worker messages and log the data.
+   * The service worker will send the number of open Playground tabs.
+   */
+  addServiceWorkerMessageListener() {
+    navigator.serviceWorker.addEventListener("message", (e) => {
+      var t;
+      ((t = e.data) == null ? void 0 : t.numberOfOpenPlaygroundTabs) !== void 0 && this.addContext({
+        numberOfOpenPlaygroundTabs: e.data.numberOfOpenPlaygroundTabs
+      });
+    });
+  }
   /**
    * Register a listener for the request.end event and log the data.
    * @param UniversalPHP playground instance
@@ -176,12 +188,12 @@ class f extends EventTarget {
    */
   log(e, t, r) {
     t === void 0 && (t = "Info");
-    const n = this.formatMessage(
+    const o = this.formatMessage(
       e,
       t,
       r ?? "Playground"
     );
-    this.logRaw(n);
+    this.logRaw(o);
   }
   /**
    * Log message without severity and timestamp.
@@ -195,23 +207,55 @@ class f extends EventTarget {
    * @returns string[]
    */
   getLogs() {
-    return this.logs;
+    return [...this.logs];
+  }
+  /**
+   * Add context data.
+   */
+  addContext(e) {
+    this.context = { ...this.context, ...e };
+  }
+  /**
+   * Get context data.
+   */
+  getContext() {
+    return { ...this.context };
   }
 }
 const c = new f();
-function h(o) {
-  o.addWindowErrorListener();
+function h(n) {
+  n.addWindowErrorListener(), n.addServiceWorkerMessageListener();
+}
+function g(n, e) {
+  n.addPlaygroundRequestEndListener(e);
 }
-function g(o, e) {
-  o.addPlaygroundRequestEndListener(e);
+function m(n) {
+  n.addEventListener("activate", () => {
+    n.clients.matchAll().then((e) => {
+      const t = {
+        numberOfOpenPlaygroundTabs: e.filter(
+          // Only count top-level frames to get the number of tabs.
+          (r) => r.frameType === "top-level"
+        ).length
+      };
+      n.clients.matchAll({
+        // We don't claim the clients, so we need to include uncontrolled clients to inform all tabs.
+        includeUncontrolled: !0
+      }).then((r) => {
+        for (const o of r)
+          o.postMessage(t);
+      });
+    });
+  });
 }
-function w(o, e) {
-  o.addEventListener(o.fatalErrorEvent, e);
+function w(n, e) {
+  n.addEventListener(n.fatalErrorEvent, e);
 }
 export {
   f as Logger,
-  w as addFatalErrorListener,
+  w as addCrashListener,
   g as collectPhpLogs,
   h as collectWindowErrors,
-  c as logger
+  c as logger,
+  m as reportServiceWorkerMetrics
 };

package/lib/logger.d.ts

@@ -1,3 +1,4 @@
+/// <reference lib="webworker" />
 import { UniversalPHP } from '../../../universal/src/index.ts/src/lib/universal-php';
 /**
  * Log severity levels.
@@ -24,6 +25,10 @@ export declare class Logger extends EventTarget {
      * The length of the last PHP log.
      */
     private lastPHPLogLength;
+    /**
+     * Context data
+     */
+    private context;
     /**
      * The path to the error log file.
      */
@@ -52,6 +57,11 @@ export declare class Logger extends EventTarget {
      * Register a listener for the window error events and log the data.
      */
     addWindowErrorListener(): void;
+    /**
+     * Register a listener for service worker messages and log the data.
+     * The service worker will send the number of open Playground tabs.
+     */
+    addServiceWorkerMessageListener(): void;
     /**
      * Register a listener for the request.end event and log the data.
      * @param UniversalPHP playground instance
@@ -88,6 +98,14 @@ export declare class Logger extends EventTarget {
      * @returns string[]
      */
     getLogs(): string[];
+    /**
+     * Add context data.
+     */
+    addContext(data: Record<string, any>): void;
+    /**
+     * Get context data.
+     */
+    getContext(): Record<string, any>;
 }
 /**
  * The logger instance.
@@ -105,11 +123,21 @@ export declare function collectWindowErrors(loggerInstance: Logger): void;
  */
 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.
+ * **Call this inside a service worker.**
+ *
+ * Reports service worker metrics.
+ * Allows the logger to request metrics from the service worker by sending a message.
+ * The service worker will respond with the number of open Playground tabs.
+ *
+ * @param worker The service worker
+ */
+export declare function reportServiceWorkerMetrics(worker: ServiceWorkerGlobalScope): void;
+/**
+ * Add a listener for the Playground crashes.
+ * These crashes include Playground errors like Asyncify errors.
  * 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;
+export declare function addCrashListener(loggerInstance: Logger, callback: EventListenerOrEventListenerObject): void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@php-wasm/logger",
-	"version": "0.6.16",
+	"version": "0.7.0",
 	"description": "A logger for PHP-wasm clients like Playground and WP-now.",
 	"repository": {
 		"type": "git",
@@ -25,5 +25,5 @@
 		"node": ">=18.18.0",
 		"npm": ">=8.11.0"
 	},
-	"gitHead": "1981567e7eacecbc4a18c870267c20bf489afd8f"
+	"gitHead": "c5eba3d709f2821c4303521e8c81b962e3bcca23"
 }