Created POC (not complete) with database handler, graphql query processor, and POC service to log request/response (not complete).

Author: colinmurphy

plugins/wpgraphql-logging/phpcs.xml

@@ -26,8 +26,8 @@
 	<arg name="extensions" value="php"/>
 	<arg name="severity" value="1"/>
 	<arg name="parallel" value="20"/>
-	<config name="testVersion" value="7.4-"/>
-	<config name="minimum_wp_version" value="6.0"/>
+	<config name="testVersion" value="8.1-"/>
+	<config name="minimum_wp_version" value="6.5"/>
 
 	<!-- ===================================== -->
 	<!-- Base Standards                        -->

plugins/wpgraphql-logging/phpstan.neon.dist

@@ -25,9 +25,8 @@ parameters:
     # Configuration
     level: 8
     phpVersion:
-          min: 70400
+          min: 80100
           max: 80400
     paths:
         - wpgraphql-logging.php
         - src/
-

plugins/wpgraphql-logging/psalm.xml

@@ -7,6 +7,7 @@
 	xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 	findUnusedBaselineEntry="true"
 	findUnusedCode="false"
+	phpVersion="8.1"
 >
 	<projectFiles>
 		<file name="wpgraphql-logging.php"/>

plugins/wpgraphql-logging/src/Events/QueryEventLifecycle.php

@@ -0,0 +1,108 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WPGraphQL\Logging\Events;
+
+use Monolog\Level;
+use WPGraphQL\Logging\Logger\LoggerService;
+
+/**
+ * WPGraphQL Query Event Lifecycle -
+ *
+ * POC @TODO - Add pub/sub for query events.
+ *
+ * @package WPGraphQL\Logging
+ *
+ * @since 0.0.1
+ */
+class QueryEventLifecycle {
+	/**
+	 * The single instance of the class.
+	 *
+	 * @var \WPGraphQL\Logging\Events\QueryEventLifecycle|null
+	 */
+	private static ?QueryEventLifecycle $instance = null;
+
+	/**
+	 * The logger service instance.
+	 *
+	 * @param \WPGraphQL\Logging\Logger\LoggerService $logger
+	 */
+	protected function __construct(readonly LoggerService $logger) {
+	}
+
+	/**
+	 * Get or create the single instance of the class.
+	 */
+	public static function init(): QueryEventLifecycle {
+		if ( null === self::$instance ) {
+			// @TODO - Add filter to allow for custom logger service.
+			$logger         = LoggerService::get_instance();
+			self::$instance = new self( $logger );
+			self::$instance->setup();
+		}
+		return self::$instance;
+	}
+
+	/**
+	 * Logs the pre-request event for a GraphQL query.
+	 *
+	 * @param string $query The GraphQL query.
+	 * @param mixed  $variables The variables for the query.
+	 * @param string $operation_name The name of the operation.
+	 */
+	public function log_pre_request( $query, $variables, $operation_name ): void {
+
+		try {
+			$context = [];
+			$context = apply_filters( 'wpgraphql_logging_pre_request_context', $context, $query, $variables, $operation_name );
+			$level   = apply_filters( 'wpgraphql_logging_pre_request_level', Level::Info, $query, $variables, $operation_name );
+			$this->logger->log( $level, 'WPGraphQL Incoming Request', $context );
+		} catch ( \Throwable $e ) {
+			// @TODO - Handle logging errors gracefully.
+			error_log( 'Error in log_pre_request: ' . $e->getMessage() ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
+		}
+	}
+
+	/**
+	 * Logs the post-request event for a GraphQL query.
+	 *
+	 * @param mixed                $response The response from the GraphQL request.
+	 * @param mixed                $result The result of the GraphQL request.
+	 * @param string               $operation_name The name of the operation.
+	 * @param string               $query The GraphQL query.
+	 * @param array<string, mixed> $variables The variables for the query.
+	 */
+	public function log_post_request( $response, $result, string $operation_name, string $query, array $variables ): void {
+
+		try {
+			$context = [];
+			$level   = Level::Info;
+			$context = apply_filters( 'wpgraphql_logging_post_request_context', $context, $response, $result, $operation_name, $query, $variables );
+			$level   = apply_filters( 'wpgraphql_logging_post_request_level', $level, $response, $result, $operation_name, $query, $variables );
+			$this->logger->log( $level, 'WPGraphQL Outgoing Response', $context );
+		} catch ( \Throwable $e ) {
+			// @TODO - Handle logging errors gracefully.
+			error_log( 'Error in log_post_request: ' . $e->getMessage() );  // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
+		}
+	}
+
+	/**
+	 * Register actions and filters.
+	 */
+	protected function setup(): void {
+
+		// @TODO: Update POC and use pub/sub for query events.
+
+		/**
+		 * @psalm-suppress HookNotFound
+		 */
+		add_action( 'do_graphql_request', [ $this, 'log_pre_request' ], 10, 3 );
+
+		/**
+		 * @psalm-suppress HookNotFound
+		 */
+		add_action( 'graphql_process_http_request_response', [ $this, 'log_post_request' ], 10, 5 );
+	}
+}

plugins/wpgraphql-logging/src/Hooks/PluginHooks.php

@@ -6,6 +6,13 @@
 
 use WPGraphQL\Logging\Logger\Database\DatabaseEntity;
 
+/**
+ * Hooks for the WPGraphQL Logging plugin.
+ *
+ * @package WPGraphQL\Logging
+ *
+ * @since 0.0.1
+ */
 class PluginHooks {
 	/**
 	 * The single instance of the class.

plugins/wpgraphql-logging/src/Logger/Database/DatabaseEntity.php

@@ -152,6 +152,68 @@ public function save(): int {
 		return 0;
 	}
 
+	/**
+	 * Gets the ID of the log entry.
+	 */
+	public function get_id(): ?int {
+		return $this->id;
+	}
+
+	/**
+	 * Gets the channel of the log entry.
+	 */
+	public function get_channel(): string {
+		return $this->channel;
+	}
+
+	/**
+	 * Gets the logging level of the log entry.
+	 */
+	public function get_level(): int {
+		return $this->level;
+	}
+
+	/**
+	 * Gets the name of the logging level of the log entry.
+	 */
+	public function get_level_name(): string {
+		return $this->level_name;
+	}
+
+	/**
+	 * Gets the message of the log entry.
+	 */
+	public function get_message(): string {
+		return $this->message;
+	}
+
+	/**
+	 * Gets the context of the log entry.
+	 *
+	 * @return array<string, mixed> The context of the log entry.
+	 */
+	public function get_context(): array {
+		return $this->context;
+	}
+
+	/**
+	 * Gets the extra data of the log entry.
+	 *
+	 * @return array<string, mixed> The extra data of the log entry.
+	 */
+	public function get_extra(): array {
+		return $this->extra;
+	}
+
+	/**
+	 * Gets the datetime of the log entry.
+	 *
+	 * @return string The datetime of the log entry in MySQL format.
+	 */
+	public function get_datetime(): string {
+		return $this->datetime;
+	}
+
 	/**
 	 * Gets the name of the logging table.
 	 */
@@ -193,7 +255,7 @@ public static function get_schema(): string {
 	 * Creates the logging table in the database.
 	 */
 	public static function create_table(): void {
-		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
+		require_once ABSPATH . 'wp-admin/includes/upgrade.php'; // @phpstan-ignore-line
 		dbDelta( self::get_schema() );
 	}
 
@@ -250,30 +312,9 @@ private static function create_from_db_row(array $row): self {
 		$log->level      = (int) $row['level'];
 		$log->level_name = $row['level_name'];
 		$log->message    = $row['message'];
-		$log->context    = $row['context'] ? json_decode( $row['context'], true ) : [];
-		$log->extra      = $row['extra'] ? json_decode( $row['extra'], true ) : [];
+		$log->context    = ( isset( $row['context'] ) && '' !== $row['context'] ) ? json_decode( $row['context'], true ) : [];
+		$log->extra      = ( isset( $row['extra'] ) && '' !== $row['extra'] ) ? json_decode( $row['extra'], true ) : [];
 		$log->datetime   = $row['datetime'];
 		return $log;
 	}
-
-	/**
-	 * Magic method to handle dynamic getters like get_level().
-	 *
-	 * @param string       $name The name of the method called.
-	 * @param array<mixed> $arguments The arguments passed to the method.
-	 *
-	 * @throws \BadMethodCallException If the method does not exist.
-	 *
-	 * @return mixed The value of the property if it exists, otherwise throws an exception.
-	 */
-	public function __call(string $name, array $arguments) {
-		if ( strpos( $name, 'get_' ) === 0 ) {
-			$property = substr( $name, 4 );
-			if ( property_exists( $this, $property ) ) {
-				return $this->$property;
-			}
-		}
-		$name = $this->sanitize_text_field( $name );
-		throw new \BadMethodCallException( sprintf( 'Method %s does not exist.', esc_html( $name ) ) );
-	}
 }

plugins/wpgraphql-logging/src/Logger/Handlers/WordPressDatabaseHandler.php

@@ -27,19 +27,36 @@ class WordPressDatabaseHandler extends AbstractProcessingHandler {
 	 */
 	protected function write( LogRecord $record ): void {
 		try {
-			$name   = $record->level->getName();
 			$entity = DatabaseEntity::create(
 				$record->channel,
 				$record->level->value,
-				(is_string($name) && $name !== '') ? $name : 'INFO',
+				$this->get_record_name( $record ),
 				$record->message,
-				$record->context ?: [],
-				$record->extra ?: []
+				$record->context ?? [],
+				$record->extra ?? []
 			);
 
 			$entity->save();
 		} catch ( Throwable $e ) {
 			error_log( 'Error logging to WordPress database: ' . $e->getMessage() ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
 		}
 	}
+
+	/**
+	 * Gets the name of the log record.
+	 *
+	 * @param \Monolog\LogRecord $record The log record.
+	 *
+	 * @return string The name of the log record.
+	 */
+	protected function get_record_name( LogRecord $record ): string {
+
+		/**
+		* @psalm-suppress InvalidCast
+		*/
+		$name    = (string) $record->level->getName(); // @phpstan-ignore-line
+		$default = 'INFO';
+
+		return $name ?: $default; // @phpstan-ignore-line
+	}
 }