Add logging support to Playground

packages/php-wasm/universal/src/lib/base-php.ts

@@ -28,6 +28,7 @@ import {
 	UnhandledRejectionsTarget,
 } from './wasm-error-reporting';
 import { Semaphore, createSpawnHandler, joinPaths } from '@php-wasm/util';
+import { LogSeverity, get_logger } from './logger';
 
 const STRING = 'string';
 const NUMBER = 'number';
@@ -264,21 +265,28 @@ export abstract class BasePHP implements IsomorphicLocalPHP {
 				this.#setPHPCode(' ?>' + request.code);
 			}
 			this.#addServerGlobalEntriesInWasm();
-			const response = await this.#handleRequest();
-			if (request.throwOnError && response.exitCode !== 0) {
-				const output = {
-					stdout: response.text,
-					stderr: response.errors,
-				};
-				console.warn(`PHP.run() output was:`, output);
-				const error = new Error(
-					`PHP.run() failed with exit code ${response.exitCode} and the following output`
+			try {
+				const response = await this.#handleRequest();
+				if (request.throwOnError && response.exitCode !== 0) {
+					const output = {
+						stdout: response.text,
+						stderr: response.errors,
+					};
+					console.warn(`PHP.run() output was:`, output);
+					const error = new Error(
+						`PHP.run() failed with exit code ${response.exitCode} and the following output`
+					);
+					// @ts-ignore
+					error.output = output;
+					throw error;
+				}
+				return response;
+			} catch (e: any) {
+				get_logger(this).log(
+					e.message,
+					LogSeverity.Error,
 				);
-				// @ts-ignore
-				error.output = output;
-				throw error;
 			}
-			return response;
 		} finally {
 			try {
 				if (heapBodyPointer) {
@@ -770,6 +778,7 @@ export abstract class BasePHP implements IsomorphicLocalPHP {
 		// runtime.
 		const oldFS = this[__private__dont__use].FS;
 
+		console.log('PHP runtime exited');
 		// Kill the current runtime
 		try {
 			this.exit();
@@ -799,6 +808,7 @@ export abstract class BasePHP implements IsomorphicLocalPHP {
 	}
 
 	exit(code = 0) {
+		console.log('PHP exit()');
 		this.dispatchEvent({
 			type: 'runtime.beforedestroy',
 		});

packages/php-wasm/universal/src/lib/logger.ts

@@ -0,0 +1,121 @@
+import { UniversalPHP } from "./universal-php";
+
+export enum LogSeverity {
+    // A dine grained debugging event. Typically disabled in default configurations.
+    Trace = 1,
+    // A debugging event.
+    Debug = 5,
+    // An informational event. Indicates that an event happened.
+    Info = 9,
+    // A warning event. Not an error but is likely more important than an informational event.
+    Warn = 13,
+    // An error event. Something went wrong.
+    Error = 17,
+    // A fatal error such as application or system crash.
+    Fatal = 21,
+}
+
+export type Log = {
+    // Time when the event occurred.
+    timestamp: number;
+    // Time when the event was observed.
+    observedTimestamp: number;
+    // Request trace id.
+    traceId: number;
+    // Request span id.
+    spanId: number; // Not implemented
+    // W3C trace flag.
+    traceFlags: number;
+    // The severity text (also known as log level).
+    severityText: string;
+    // Numerical value of the severity.
+    severityNumber: LogSeverity;
+    // The body of the log record.
+    body: string;
+    // Describes the source of the log.
+    resource: string;
+    // Describes the scope that emitted the log.
+    instrumentationScope: string; // Not implemented
+    // Additional information about the event.
+    attributes: Record<string, string>;
+};
+
+export class Logger {
+    private php: UniversalPHP | undefined;
+    private logs: Log[] = [];
+    private wordpressLogs: string[] | undefined = undefined;
+
+    constructor(php?: UniversalPHP) {
+        this.php = php;
+        if (this.php) {
+            this.php.addEventListener(
+                'request.end',
+                () => {
+                    console.log(this.getLogs());
+                }
+            )
+            this.php.onMessage((message) => {
+                try {
+                    const logMessage = JSON.parse(message);
+                    if (logMessage.type === 'wordpress-log') {
+                        this.log(
+                            logMessage.body,
+                            logMessage.severityNumber,
+                            logMessage.timestamp,
+                            'wordpress',
+                        );
+                    }
+                } catch (error) {
+                    // Not a log message
+                }
+            });
+        }
+        if ( typeof window !== 'undefined' ) {
+            window.onerror = (message, source, lineno, colno) => {
+                this.log(
+                    `${message} in ${source} on line ${lineno}:${colno}`,
+                    LogSeverity.Fatal,
+                    Date.now(),
+                    'javascript',
+                );
+            }
+        }
+    }
+
+    public log(body: string, severityNumber: LogSeverity = LogSeverity.Info, timestamp?: number, resource = 'php', instrumentationScope = 'php', attributes: Record<string, string> = {}): void {
+        const now = Date.now();
+        this.logs.push({
+            timestamp: timestamp || now,
+            observedTimestamp: now,
+            traceId: 1, // @TODO: Implement trace id
+            spanId: 1, // @TODO: Implement span id
+            traceFlags: 1,
+            severityText: LogSeverity[severityNumber],
+            severityNumber,
+            body,
+            resource,
+            instrumentationScope,
+            attributes,
+        });
+    }
+
+    public getLogs(): Log[] {
+        return this.logs;
+    }
+
+    public async addWordPressLogs() {
+        if (this.php && this.wordpressLogs === undefined) {
+            const rawLogs =  await this.php.readFileAsText('/tmp/debug.log');
+        }
+    }
+
+};
+
+let logger: Logger | undefined = undefined;
+
+export function get_logger(php?: BasePHP): Logger {
+    if (!logger) {
+        logger = new Logger(php);
+    }
+    return logger;
+}

packages/playground/remote/src/lib/playground-mu-plugin/0-playground.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * This is a temporary workaround to hide the 32bit integer warnings that 
+ * This is a temporary workaround to hide the 32bit integer warnings that
  * appear when using various time related function, such as strtotime and mktime.
  * Examples of the warnings that are displayed:
  * Warning: mktime(): Epoch doesn't fit in a PHP integer in <file>
@@ -29,19 +29,19 @@ function () {
 );
 
 /**
- * Because the in-browser Playground doesn't have access to the internet, 
- * network-dependent features like directories don't work. Normally, you'll 
+ * Because the in-browser Playground doesn't have access to the internet,
+ * network-dependent features like directories don't work. Normally, you'll
  * see a confusing message like "An unexpected error occurred." This mu-plugin
  * makes it more clear that the feature is not yet supported.
- * 
+ *
  * https://github.com/WordPress/wordpress-playground/issues/498
- * 
+ *
  * Added styling to hide the Popular tags section of the Plugins page
  * and the nonfunctional Try Again button (both Plugins and Themes) that's
  * appended when the message is displayed.
- * 
+ *
  * https://github.com/WordPress/wordpress-playground/issues/927
- * 
+ *
  */
 add_action('admin_head', function () {
   echo '<style>
@@ -90,7 +90,7 @@ function networking_disabled() {
  * the sandbox attribute. What they really should be targeting is the
  * playground iframe itself (name="playground"). This mu-plugin rewrites
  * all target="_top" links to target="playground" instead.
- * 
+ *
  * https://github.com/WordPress/wordpress-playground/issues/266
  */
 add_action('admin_print_scripts', function () {
@@ -129,9 +129,9 @@ function networking_disabled() {
  * The default WordPress requests transports have been disabled
  * at this point. However, the Requests class requires at least
  * one working transport or else it throws warnings and acts up.
- * 
+ *
  * This mu-plugin provides that transport. It's one of the two:
- * 
+ *
  * * WP_Http_Fetch – Sends requests using browser's fetch() function.
  *                   Only enabled when PHP was compiled with the VRZNO
  * 					 extension.
@@ -154,10 +154,10 @@ function networking_disabled() {
 	/**
 	 * Disable signature verification as it doesn't seem to work with
 	 * fetch requests:
-	 * 
+	 *
 	 * https://downloads.wordpress.org/plugin/classic-editor.zip returns no signature header.
 	 * https://downloads.wordpress.org/plugin/classic-editor.zip.sig returns 404.
-	 * 
+	 *
 	 * @TODO Investigate why.
 	 */
 	add_filter('wp_signature_hosts', function ($hosts) {
@@ -176,3 +176,51 @@ function networking_disabled() {
 		return $transports;
 	});
 }
+
+// Configure error logging
+$log_file = WP_CONTENT_DIR . '/debug.log';
+error_reporting(E_ALL);
+define('ERROR_LOG_FILE', $log_file);
+ini_set('error_log', $log_file);
+
+/**
+ * Get OpenTracing severity number from PHP error code
+ *
+ * @param int $code PHP error code
+ * @return int OpenTracing severity number
+ */
+function get_severity_number($code)
+{
+	// @TODO Update numbers
+	switch ($code) {
+		case E_ERROR:
+		case E_CORE_ERROR:
+		case E_COMPILE_ERROR:
+		case E_USER_ERROR:
+			return 17;
+		case E_WARNING:
+		case E_CORE_WARNING:
+		case E_COMPILE_WARNING:
+		case E_USER_WARNING:
+			return 13;
+		case E_NOTICE:
+		case E_USER_NOTICE:
+			return 9;
+		default:
+			return 5;
+	}
+}
+
+function playground_error_handler($errno, $errstr, $errfile, $errline)
+{
+	post_message_to_js(
+		json_encode([
+			'event' => 'wordpress-log',
+			'timestamp' => time(),
+			'severityNumber' => get_severity_number($errno),
+			'body' => "$errstr in $errfile on line $errline",
+		])
+	);
+	return true;
+}
+set_error_handler('playground_error_handler');