Added tests for Events Action Logger. Added fixes to the action logger after finding a few bugs.

Author: colinmurphy

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

@@ -61,16 +61,10 @@ public function __construct( LoggerService $logger, array $config ) {
 	 */
 	public function log_pre_request( ?string $query, ?string $operation_name, ?array $variables ): void {
 		try {
-			if ( ! $this->is_logging_enabled( $this->config, $query ) ) {
-				return;
-			}
-			$selected_events = $this->config[ BasicConfigurationTab::EVENT_LOG_SELECTION ] ?? [];
-			if ( ! is_array( $selected_events ) || empty( $selected_events ) ) {
-				return;
-			}
-			if ( ! in_array( Events::PRE_REQUEST, $selected_events, true ) ) {
+			if ( ! $this->should_log_event( Events::PRE_REQUEST, $query ) ) {
 				return;
 			}
+
 			$context = [
 				'query'          => $query,
 				'variables'      => $variables,
@@ -97,23 +91,21 @@ public function log_pre_request( ?string $query, ?string $operation_name, ?array
 	public function log_graphql_before_execute( Request $request ): void {
 		try {
 			/** @var \GraphQL\Server\OperationParams $params */
-			$params  = $request->params;
+			$params = $request->params;
+			if ( null === $params || ! \is_object( $params ) ) {
+				return;
+			}
+			$query = $params->query;
+			if ( ! $this->should_log_event( Events::BEFORE_GRAPHQL_EXECUTION, $query ) ) {
+				return;
+			}
+
 			$context = [
-				'query'          => $params->query,
+				'query'          => $query,
 				'operation_name' => $params->operation,
 				'variables'      => $params->variables,
 				'params'         => $params,
 			];
-			if ( ! $this->is_logging_enabled( $this->config, $params->query ) ) {
-				return;
-			}
-			$selected_events = $this->config[ BasicConfigurationTab::EVENT_LOG_SELECTION ] ?? [];
-			if ( ! is_array( $selected_events ) || empty( $selected_events ) ) {
-				return;
-			}
-			if ( ! in_array( Events::BEFORE_GRAPHQL_EXECUTION, $selected_events, true ) ) {
-				return;
-			}
 
 			$payload = EventManager::transform( Events::BEFORE_GRAPHQL_EXECUTION, [
 				'context' => $context,
@@ -154,16 +146,10 @@ public function log_before_response_returned(
 		?string $query_id
 	): void {
 		try {
-			if ( ! $this->is_logging_enabled( $this->config, $query ) ) {
-				return;
-			}
-			$selected_events = $this->config[ BasicConfigurationTab::EVENT_LOG_SELECTION ] ?? [];
-			if ( ! is_array( $selected_events ) || empty( $selected_events ) ) {
-				return;
-			}
-			if ( ! in_array( Events::BEFORE_RESPONSE_RETURNED, $selected_events, true ) ) {
+			if ( ! $this->should_log_event( Events::BEFORE_RESPONSE_RETURNED, $query ) ) {
 				return;
 			}
+
 			$encoded_request = wp_json_encode( $request );
 			$context         = [
 				'response'       => $response,
@@ -196,6 +182,25 @@ public function log_before_response_returned(
 		}
 	}
 
+	/**
+	 * Determine if the event should be logged based on the configuration and selected events.
+	 *
+	 * @param string      $event The event name.
+	 * @param string|null $query The GraphQL query (optional).
+	 *
+	 * @return bool True if the event should be logged, false otherwise.
+	 */
+	public function should_log_event(string $event, ?string $query = null): bool {
+		if ( ! $this->is_logging_enabled( $this->config, $query ) ) {
+			return false;
+		}
+		$selected_events = $this->config[ BasicConfigurationTab::EVENT_LOG_SELECTION ] ?? [];
+		if ( ! is_array( $selected_events ) || empty( $selected_events ) ) {
+			return false;
+		}
+		return in_array( $event, $selected_events, true );
+	}
+
 	/**
 	 * Get the context for the response.
 	 *

plugins/wpgraphql-logging/src/Logger/Rules/ExcludeQueryRule.php

@@ -24,7 +24,7 @@ class ExcludeQueryRule implements LoggingRuleInterface {
 	 */
 	public function passes(array $config, ?string $query_string = null): bool {
 		$queries = $config[ BasicConfigurationTab::EXCLUDE_QUERY ] ?? '';
-		if ( null === $query_string || '' === trim( $queries ) ) {
+		if ( null === $query_string || ! is_string( $queries ) || '' === trim( $queries ) ) {
 			return true;
 		}