Added request headers to the log. Displayed this in the admin view.

Author: colinmurphy

plugins/wpgraphql-logging/src/Admin/View/List/List_Table.php

@@ -134,8 +134,7 @@ public function get_columns(): array {
 				'level_name'      => __( 'Level Name', 'wpgraphql-logging' ),
 				'event'           => __( 'Event', 'wpgraphql-logging' ),
 				'process_id'      => __( 'Process ID', 'wpgraphql-logging' ),
-				'headers'         => __( 'Headers', 'wpgraphql-logging' ),
-				'time'            => __( 'Time', 'wpgraphql-logging' ),
+				'request_headers' => __( 'Headers', 'wpgraphql-logging' ),
 				'memory_usage'    => __( 'Memory Usage', 'wpgraphql-logging' ),
 			]
 		);
@@ -175,6 +174,8 @@ public function column_default( $item, $column_name ): mixed {
 				return $this->get_memory_usage( $item );
 			case 'wpgraphql_query':
 				return $this->get_query( $item );
+			case 'request_headers':
+				return $this->get_request_headers( $item );
 			default:
 				// Users can add their own custom columns and render functionality.
 				return apply_filters( 'wpgraphql_logging_logs_table_column_value', '', $item, $column_name );
@@ -243,7 +244,18 @@ public function column_query( DatabaseEntity $item ): ?string {
 	 */
 	public function get_query(DatabaseEntity $item): string {
 		$extra = $item->get_extra();
-		return ! empty( $extra['wpgraphql_query'] ) ? esc_html( $extra['wpgraphql_query'] ) : '';
+		$query = ! empty( $extra['wpgraphql_query'] ) ? esc_html( $extra['wpgraphql_query'] ) : '';
+		return '<pre style="overflow-x: auto;
+  background: #f6f7f7;
+  padding: 15px;
+  border: 1px solid #ddd;
+  border-radius: 4px;
+  white-space: pre-wrap;
+  word-break: break-word;
+  max-width: 100%;
+  max-height: 300px;
+  overflow-y: auto;
+  box-sizing: border-box;">' . esc_html( $query ) . '</pre>';
 	}
 
 	/**
@@ -278,4 +290,23 @@ public function get_memory_usage(DatabaseEntity $item): string {
 		$extra = $item->get_extra();
 		return ! empty( $extra['memory_peak_usage'] ) ? esc_html( $extra['memory_peak_usage'] ) : '';
 	}
+
+	/**
+	 * Gets the request headers from extra.
+	 *
+	 * @return string The event
+	 */
+	public function get_request_headers(DatabaseEntity $item): string {
+		$extra           = $item->get_extra();
+		$request_headers = $extra['request_headers'] ?? [];
+		if ( empty( $request_headers ) || ! is_array( $request_headers ) ) {
+			return '';
+		}
+
+		$formatted_request_headers = wp_json_encode( $request_headers, JSON_PRETTY_PRINT );
+		if ( false === $formatted_request_headers ) {
+			return '';
+		}
+		return '<pre style="overflow-x: auto; background: #f4f4f4; padding: 15px; border: 1px solid #ddd; border-radius: 4px;">' . esc_html( $formatted_request_headers ) . '</pre>';
+	}
 }

plugins/wpgraphql-logging/src/Admin/View/List/Templates/wpgraphql-logger-list.php

@@ -24,9 +24,7 @@
 	<form method="post">
 		<?php
 		$list_table->prepare_items();
-		// $list_table->display_bulk_actions_top();
 		$list_table->display();
-		// $list_table->display_bulk_actions_bottom();
 		?>
 	</form>
 </div>

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

@@ -249,13 +249,12 @@ public function get_datetime(): string {
 	public static function find_logs(int $limit, int $offset, string $orderby = 'id', string $order = 'DESC'): array {
 		global $wpdb;
 		$table_name = self::get_table_name();
+		$order      = esc_sql( strtoupper( $order ) );
 		$orderby    = esc_sql( $orderby );
-		$order      = esc_sql( $order );
 
+		/** @psalm-suppress PossiblyInvalidCast */
 		$query = $wpdb->prepare(
-			"SELECT * FROM {$table_name} ORDER BY %s %s LIMIT %d, %d", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-			$orderby,
-			$order,
+			"SELECT * FROM {$table_name} ORDER BY {$orderby} {$order} LIMIT %d, %d", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
 			$offset,
 			$limit
 		);

plugins/wpgraphql-logging/src/Logger/LoggerService.php

@@ -12,6 +12,7 @@
 use Monolog\Processor\ProcessorInterface;
 use Monolog\Processor\WebProcessor;
 use WPGraphQL\Logging\Logger\Handlers\WordPressDatabaseHandler;
+use WPGraphQL\Logging\Logger\Processors\RequestHeadersProcessor;
 use WPGraphQL\Logging\Logger\Processors\WPGraphQLQueryProcessor;
 
 /**
@@ -225,6 +226,7 @@ public static function get_default_processors(): array {
 			new WebProcessor(), // Logs web request data. e.g. IP address, request method, URI, etc.
 			new ProcessIdProcessor(), // Logs the process ID.
 			new WPGraphQLQueryProcessor(), // Custom processor to capture GraphQL request data.
+			new RequestHeadersProcessor(), // Custom processor to capture request headers.
 		];
 
 		// Filter for users to add their own processors.

plugins/wpgraphql-logging/src/Logger/Processors/RequestHeadersProcessor.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WPGraphQL\Logging\Logger\Processors;
+
+use Monolog\LogRecord;
+use Monolog\Processor\ProcessorInterface;
+
+/**
+ * This class is responsible for capturing and processing request headers
+ * for logging purposes.
+ *
+ * @package WPGraphQL\Logging
+ *
+ * @since 0.0.1
+ */
+class RequestHeadersProcessor implements ProcessorInterface {
+	/**
+	 * Retrieves the request headers from the $_SERVER superglobal.
+	 *
+	 * @return array<string, mixed> The request headers.
+	 */
+	private function get_headers(): array {
+		$headers = [];
+		foreach ( $_SERVER as $key => $value ) {
+			if ( ! is_string( $value ) || empty( $value ) ) {
+				continue;
+			}
+			$header_key             = substr( $key, 5 );
+			$header_key             = str_replace( '_', '-', $header_key );
+			$header_key             = ucwords( strtolower( sanitize_text_field( (string) $header_key ) ), '-' );
+			$headers[ $header_key ] = sanitize_text_field( $value );
+		}
+
+		return $headers;
+	}
+
+	/**
+	 * This method is called for each log record. It adds the captured
+	 * request headers to the record's 'extra' array.
+	 *
+	 * @param \Monolog\LogRecord $record The log record to process.
+	 *
+	 * @return \Monolog\LogRecord The processed log record.
+	 */
+	public function __invoke( LogRecord $record ): LogRecord {
+		$record->extra['request_headers'] = $this->get_headers();
+
+		return $record;
+	}
+}