@php-wasm/logger 0.6.4

package/index.d.ts

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

package/index.js

@@ -0,0 +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;

package/index.mjs

@@ -0,0 +1,115 @@
+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);
+  }
+  /**
+   * Read the WordPress debug.log file and return its content.
+   *
+   * @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) : "";
+  }
+  /**
+   * Log Windows errors.
+   *
+   * @param ErrorEvent event
+   */
+  logWindowError(t) {
+    this.log(
+      `${t.message} in ${t.filename} on line ${t.lineno}:${t.colno}`,
+      "fatal"
+    );
+  }
+  /**
+   * Log unhandled promise rejections.
+   *
+   * @param PromiseRejectionEvent event
+   */
+  logUnhandledRejection(t) {
+    this.log(`${t.reason.stack}`, "fatal");
+  }
+  /**
+   * Register a listener for the window error events and log the data.
+   */
+  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);
+  }
+  /**
+   * 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);
+    });
+  }
+  /**
+   * Get UTC date in the PHP log format https://github.com/php/php-src/blob/master/main/main.c#L849
+   *
+   * @param date
+   * @returns string
+   */
+  formatLogDate(t) {
+    const e = new Intl.DateTimeFormat("en-GB", {
+      year: "numeric",
+      month: "short",
+      day: "2-digit",
+      timeZone: "UTC"
+    }).format(t).replace(/ /g, "-"), n = 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 log message and severity and log it.
+   * @param string message
+   * @param LogSeverity severity
+   */
+  formatMessage(t, e) {
+    return `[${this.formatLogDate(/* @__PURE__ */ new Date())}] ${this.LOG_PREFIX} ${e}: ${t}`;
+  }
+  /**
+   * Log message with severity and timestamp.
+   * @param string message
+   * @param LogSeverity severity
+   */
+  log(t, e) {
+    e === void 0 && (e = "info");
+    const n = this.formatMessage(t, e);
+    this.logRaw(n);
+  }
+  /**
+   * Log message without severity and timestamp.
+   * @param string log
+   */
+  logRaw(t) {
+    console.debug(t);
+  }
+}
+const r = new i();
+function s(o) {
+  o.addWindowErrorListener();
+}
+function a(o, t) {
+  o.addPlaygroundRequestEndListener(t);
+}
+export {
+  i as Logger,
+  a as collectPhpLogs,
+  s as collectWindowErrors,
+  r as logger
+};

package/logger.d.ts

@@ -0,0 +1,91 @@
+import { UniversalPHP } from '../../universal/src/index.ts/src/lib/universal-php';
+/**
+ * Log severity levels.
+ */
+export type LogSeverity = 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+/**
+ * A logger for Playground.
+ */
+export declare class Logger {
+    private readonly LOG_PREFIX;
+    /**
+     * Whether the window events are connected.
+     */
+    private windowConnected;
+    /**
+     * The length of the last PHP log.
+     */
+    private lastPHPLogLength;
+    /**
+     * The path to the error log file.
+     */
+    private errorLogPath;
+    constructor(errorLogPath?: string);
+    /**
+     * Read the WordPress debug.log file and return its content.
+     *
+     * @param UniversalPHP playground instance
+     * @returns string The content of the debug.log file
+     */
+    private getRequestPhpErrorLog;
+    /**
+     * Log Windows errors.
+     *
+     * @param ErrorEvent event
+     */
+    private logWindowError;
+    /**
+     * Log unhandled promise rejections.
+     *
+     * @param PromiseRejectionEvent event
+     */
+    private logUnhandledRejection;
+    /**
+     * Register a listener for the window error events and log the data.
+     */
+    addWindowErrorListener(): void;
+    /**
+     * Register a listener for the request.end event and log the data.
+     * @param UniversalPHP playground instance
+     */
+    addPlaygroundRequestEndListener(playground: UniversalPHP): void;
+    /**
+     * Get UTC date in the PHP log format https://github.com/php/php-src/blob/master/main/main.c#L849
+     *
+     * @param date
+     * @returns string
+     */
+    private formatLogDate;
+    /**
+     * Format log message and severity and log it.
+     * @param string message
+     * @param LogSeverity severity
+     */
+    formatMessage(message: string, severity: LogSeverity): string;
+    /**
+     * Log message with severity and timestamp.
+     * @param string message
+     * @param LogSeverity severity
+     */
+    log(message: string, severity?: LogSeverity): void;
+    /**
+     * Log message without severity and timestamp.
+     * @param string log
+     */
+    logRaw(log: string): void;
+}
+/**
+ * The logger instance.
+ */
+export declare const logger: Logger;
+/**
+ * Collect errors from JavaScript window events like error and log them.
+ * @param loggerInstance The logger instance
+ */
+export declare function collectWindowErrors(loggerInstance: Logger): void;
+/**
+ * Collect PHP logs from the error_log file and log them.
+ * @param UniversalPHP playground instance
+ * @param loggerInstance The logger instance
+ */
+export declare function collectPhpLogs(loggerInstance: Logger, playground: UniversalPHP): void;

package/package.json

@@ -0,0 +1,29 @@
+{
+	"name": "@php-wasm/logger",
+	"version": "0.6.4",
+	"description": "A logger for PHP-wasm clients like Playground and WP-now.",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/WordPress/wordpress-playground"
+	},
+	"homepage": "https://developer.wordpress.org/playground",
+	"author": "The WordPress contributors",
+	"typedoc": {
+		"entryPoint": "./src/index.ts",
+		"readmeFile": "./README.md",
+		"displayName": "@php-wasm/logger",
+		"tsconfig": "./tsconfig.lib.json"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "../../../dist/packages/php-wasm/logger"
+	},
+	"license": "GPL-2.0-or-later",
+	"main": "index.cjs",
+	"types": "index.d.ts",
+	"engines": {
+		"node": ">=18.18.2",
+		"npm": ">=8.11.0"
+	},
+	"gitHead": "8b74852e9701f5083b367f9a294f34200230ce79"
+}