Add event selection check for response headers logging

Updated QueryFilterLogger to only add logging headers if the RESPONSE_HEADERS_TO_SEND event is selected in the configuration. Added is_selected_event helper and corresponding unit tests to ensure correct behavior based on configuration.

Author: colinmurphy

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

@@ -166,6 +166,10 @@ public function add_logging_headers( array $headers ): array {
 			return $headers;
 		}
 
+		if ( ! $this->is_selected_event( Events::RESPONSE_HEADERS_TO_SEND ) ) {
+			return $headers;
+		}
+
 		$request_id                        = uniqid( 'wpgql_log_' );
 		$headers['X-WPGraphQL-Logging-ID'] = $request_id;
 

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

@@ -53,6 +53,17 @@ public function should_log_event(string $event, ?string $query = null): bool {
 		if ( ! $this->is_logging_enabled( $this->config, $query ) ) {
 			return false;
 		}
+		return $this->is_selected_event( $event );
+	}
+
+	/**
+	 * Check if the event is selected in the configuration.
+	 *
+	 * @param string $event The event name to check.
+	 *
+	 * @return bool True if the event is selected, false otherwise.
+	 */
+	public function is_selected_event(string $event): bool {
 		$selected_events = $this->config[ BasicConfigurationTab::EVENT_LOG_SELECTION ] ?? [];
 		if ( ! is_array( $selected_events ) || empty( $selected_events ) ) {
 			return false;

plugins/wpgraphql-logging/tests/wpunit/Events/QueryFilterLoggerTest.php

@@ -260,4 +260,47 @@ public function test_graphql_request_results_log_event_add_context_with_subscrib
 		$this->assertEquals('This is meta value.', $log_entry->get_context()['meta_data']);
 		$this->assertEquals(Level::Debug->value, $log_entry->get_level());
 	}
+
+
+	/**************************************************************
+	 * add_response_headers
+	 **************************************************************/
+	public function test_graphql_response_headers_logging_disabled(): void {
+		$instance = $this->create_instance(
+			[
+				BasicConfigurationTab::ENABLED => false,
+			]
+		);
+		$headers = ['Content-Type' => 'application/json'];
+		$result = $instance->add_logging_headers($headers);
+		$this->assertSame($headers, $result);
+	}
+
+	public function test_graphql_response_headers_logging_not_selected(): void {
+		$instance = $this->create_instance(
+			[
+				BasicConfigurationTab::ENABLED => true,
+				BasicConfigurationTab::EVENT_LOG_SELECTION => [Events::PRE_REQUEST],
+			]
+		);
+		$headers = ['Content-Type' => 'application/json'];
+		$result = $instance->add_logging_headers($headers);
+		$this->assertSame($headers, $result);
+	}
+
+
+	public function test_graphql_response_headers_logging_add_header(): void {
+		$instance = $this->create_instance(
+			[
+				BasicConfigurationTab::ENABLED => true,
+				BasicConfigurationTab::EVENT_LOG_SELECTION => [Events::RESPONSE_HEADERS_TO_SEND],
+			]
+		);
+		$headers = ['Content-Type' => 'application/json'];
+		$result = $instance->add_logging_headers($headers);
+		$this->assertNotSame($headers, $result);
+		$this->assertArrayHasKey('X-WPGraphQL-Logging-ID', $result);
+		$this->assertNotEmpty($result['X-WPGraphQL-Logging-ID']);
+		$this->assertCount(2, $result);
+	}
 }