feat: skip logging introspection queries

Author: theodesp

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

@@ -61,7 +61,7 @@ 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 ) ) {
+			if ( ! $this->is_logging_enabled( $this->config, $query ) ) {
 				return;
 			}
 			$selected_events = $this->config[ Basic_Configuration_Tab::EVENT_LOG_SELECTION ] ?? [];
@@ -96,7 +96,15 @@ public function log_pre_request( string $query, ?string $operation_name, ?array
 	 */
 	public function log_graphql_before_execute( Request $request ): void {
 		try {
-			if ( ! $this->is_logging_enabled( $this->config ) ) {
+			/** @var \GraphQL\Server\OperationParams $params */
+			$params  = $request->params;
+			$context = [
+				'query'          => $params->query,
+				'operation_name' => $params->operation,
+				'variables'      => $params->variables,
+				'params'         => $params,
+			];
+			if ( ! $this->is_logging_enabled( $this->config, $params->query ) ) {
 				return;
 			}
 			$selected_events = $this->config[ Basic_Configuration_Tab::EVENT_LOG_SELECTION ] ?? [];
@@ -106,14 +114,7 @@ public function log_graphql_before_execute( Request $request ): void {
 			if ( ! in_array( Events::BEFORE_GRAPHQL_EXECUTION, $selected_events, true ) ) {
 				return;
 			}
-			/** @var \GraphQL\Server\OperationParams $params */
-			$params  = $request->params;
-			$context = [
-				'query'          => $params->query,
-				'operation_name' => $params->operation,
-				'variables'      => $params->variables,
-				'params'         => $params,
-			];
+			
 			$payload = EventManager::transform( Events::BEFORE_GRAPHQL_EXECUTION, [
 				'context' => $context,
 				'level'   => Level::Info,
@@ -150,7 +151,7 @@ public function log_before_response_returned(
 		?string $query_id
 	): void {
 		try {
-			if ( ! $this->is_logging_enabled( $this->config ) ) {
+			if ( ! $this->is_logging_enabled( $this->config, $query ) ) {
 				return;
 			}
 			$selected_events = $this->config[ Basic_Configuration_Tab::EVENT_LOG_SELECTION ] ?? [];

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

@@ -17,9 +17,8 @@ trait LoggingHelper {
 	 *
 	 * phpcs:disable Generic.Metrics.CyclomaticComplexity, SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh
 	 */
-	protected function is_logging_enabled( array $config ): bool {
+	protected function is_logging_enabled( array $config, ?string $query_string = null ): bool {
 		$is_enabled = true;
-
 		// Check the main "Enabled" checkbox.
 		if ( ! (bool) ( $config[ Basic_Configuration_Tab::ENABLED ] ?? false ) ) {
 			$is_enabled = false;
@@ -50,6 +49,11 @@ protected function is_logging_enabled( array $config ): bool {
 			}
 		}
 
+		// Check if the query is an introspection query and skip logging if it is.
+        if ( $is_enabled && $this->is_introspection_query( $query_string ) ) {
+            $is_enabled = false;
+        }
+
 		/**
 		 * Filter the final decision on whether to log a request.
 		 *
@@ -58,4 +62,18 @@ protected function is_logging_enabled( array $config ): bool {
 		 */
 		return apply_filters( 'wpgraphql_logging_is_enabled', $is_enabled, $config );
 	}
+
+	/**
+     * Checks if a query is an introspection query.
+     *
+     * @param string|null $query_string The GraphQL query string.
+     * @return bool
+     */
+    protected function is_introspection_query( ?string $query_string ): bool {
+        if ( null === $query_string ) {
+            return false;
+        }
+
+        return strpos( $query_string, '__schema' ) !== false;
+    }
 }