Removed event after query execution, as it is a duplicate of response in some ways. I wanted to reduce the amount of events for MVP.

Author: colinmurphy

plugins/wpgraphql-logging/README.md

@@ -78,7 +78,6 @@ wpgraphql-logging/
 - **Query event lifecycle logging**
   - **Pre Request** (`do_graphql_request`): captures `query`, `variables`, `operation_name`.
   - **Before Execution** (`graphql_before_execute`): includes a snapshot of request `params`.
-  - **After Execution** (`graphql_execute`): captures `response`/`ExecutionResult`, `schema`, and `request`.
   - **Before Response Returned** (`graphql_return_response`): inspects `response` and automatically upgrades level to Error when GraphQL `errors` are present (adds `errors` to context when found).
 
 - **Built-in pub/sub event bus**

plugins/wpgraphql-logging/docs/Events.md

@@ -30,7 +30,6 @@ Currently we subscribe to the following WPGraphQL events:
 | --- | --- | --- |
 | `Events::PRE_REQUEST` | `do_graphql_request` | Before the request is processed |
 | `Events::BEFORE_GRAPHQL_EXECUTION` | `graphql_before_execute` | Before query execution |
-| `Events::AFTER_GRAPHQL_EXECUTION` | `graphql_execute` | After query execution |
 | `Events::BEFORE_RESPONSE_RETURNED` | `graphql_return_response` | Before response is returned to client |
 
 ## Usage
@@ -88,7 +87,7 @@ add_action('init', function () {
 
 **Example**
 
-Currently the plugin logs at four points in the WPGraphQL lifecycle: `do_graphql_request`, `graphql_before_execute`, `graphql_execute`, `graphql_return_response`. If you need more visibility you could do the following:
+Currently the plugin logs at three points in the WPGraphQL lifecycle: `do_graphql_request`, `graphql_before_execute`, `graphql_return_response`. If you need more visibility you could do the following:
 
 ```php
 use WPGraphQL\Logging\Logger\LoggerService;

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

@@ -24,15 +24,6 @@ final class Events {
 	 */
 	public const BEFORE_GRAPHQL_EXECUTION = 'graphql_before_execute';
 
-	/**
-	 * WPGraphQL action: graphql_execute
-	 *
-	 * After the request is processed.
-	 *
-	 * @var string
-	 */
-	public const AFTER_GRAPHQL_EXECUTION = 'graphql_execute';
-
 	/**
 	 * WPGraphQL action: graphql_return_response
 	 *

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

@@ -133,51 +133,7 @@ public function log_graphql_before_execute(Request $request ): void {
 		}
 	}
 
-	/**
-	 * After Query Execution.
-	 *
-	 * @hook graphql_execute
-	 *
-	 * @param array<mixed>|\GraphQL\Executor\ExecutionResult $response The GraphQL execution result(s).
-	 * @param \WPGraphQL\WPSchema                            $schema The WPGraphQL schema.
-	 * @param string|null                                    $operation The operation name.
-	 * @param string                                         $query The query string.
-	 * @param array<string, mixed>                           $variables The variables for the query.
-	 * @param \WPGraphQL\Request                             $request The WPGraphQL request instance.
-	 */
-	public function log_after_graphql_execute( array|ExecutionResult $response, WPSchema $schema, ?string $operation, string $query, array $variables, Request $request ): void {
 
-		try {
-			$context = [
-				'query'          => $query,
-				'operation_name' => $operation ?? '',
-				'variables'      => $variables,
-				'response'       => $response,
-				'schema'         => $schema,
-				'request'        => $request,
-			];
-
-			$payload = EventManager::transform(
-				Events::AFTER_GRAPHQL_EXECUTION,
-				[
-					'context' => $context,
-					'level'   => Level::Info,
-				]
-			);
-
-			$this->logger->log( $payload['level'], 'WPGraphQL After Query Execution', $payload['context'] );
-
-			EventManager::publish(
-				Events::AFTER_GRAPHQL_EXECUTION,
-				[
-					'context' => $payload['context'],
-					'level'   => (string) $payload['level']->getName(),
-				]
-			);
-		} catch ( \Throwable $e ) {
-			$this->process_application_error( Events::AFTER_GRAPHQL_EXECUTION, $e );
-		}
-	}
 
 	/**
 	 * Before the GraphQL response is returned to the client.
@@ -277,11 +233,6 @@ protected function setup(): void {
 		 */
 		add_action( 'graphql_before_execute', [ $this, 'log_graphql_before_execute' ], 10, 1 );
 
-		/**
-		 * After Query Execution
-		 */
-		add_action( 'graphql_execute', [ $this, 'log_after_graphql_execute' ], 10, 6 );
-
 		/**
 		 * Response/Error Handling
 		 */

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

@@ -226,6 +226,8 @@ public static function get_default_processors(): array {
 			new ProcessIdProcessor(), // Logs the process ID.
 			new WPGraphQLQueryProcessor(), // Custom processor to capture GraphQL request data.
 		];
+
+		// Filter for users to add their own processors.
 		return apply_filters( 'wpgraphql_logging_default_processors', $default_processors );
 	}
 
@@ -240,6 +242,8 @@ public static function get_default_handlers(): array {
 		$default_handlers = [
 			new WordPressDatabaseHandler(),
 		];
+
+		// Filter for users to add their own handlers.
 		return apply_filters( 'wpgraphql_logging_default_handlers', $default_handlers );
 	}
 
@@ -256,6 +260,7 @@ public static function get_default_context(): array {
 			'site_url'       => home_url(),
 		];
 
+		// Filter for users to modify the default context.
 		return apply_filters( 'wpgraphql_logging_default_context', $context );
 	}
 }

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

@@ -328,7 +328,6 @@ public function eventConstantsProvider(): array {
 		return [
 			[Events::PRE_REQUEST, 'do_graphql_request'],
 			[Events::BEFORE_GRAPHQL_EXECUTION, 'graphql_before_execute'],
-			[Events::AFTER_GRAPHQL_EXECUTION, 'graphql_execute'],
 			[Events::BEFORE_RESPONSE_RETURNED, 'graphql_return_response'],
 		];
 	}

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

@@ -215,47 +215,9 @@ public function test_log_graphql_before_execute_logs_correctly(): void {
 		$this->assertEquals($request->params, $record['context']['params']);
 	}
 
-	public function test_log_after_graphql_execute_logs_correctly(): void {
-		$lifecycle = $this->create_lifecycle_with_mock_logger();
-
-		$response = $this->create_mock_execution_result(['posts' => [['title' => 'Test Post']]]);
-		$schema = $this->create_mock_schema();
-		$operation = 'GetPosts';
-		$query = '{ posts { title } }';
-		$variables = ['limit' => 10];
-		$request = $this->create_mock_request();
-
-		$lifecycle->log_after_graphql_execute($response, $schema, $operation, $query, $variables, $request);
-
-		$this->assertTrue($this->test_handler->hasInfoRecords());
-		$records = $this->test_handler->getRecords();
-		$record = $records[0];
-
-		$this->assertEquals('WPGraphQL After Query Execution', $record['message']);
-		$this->assertEquals($query, $record['context']['query']);
-		$this->assertEquals($operation, $record['context']['operation_name']);
-		$this->assertEquals($variables, $record['context']['variables']);
-		$this->assertEquals($response, $record['context']['response']);
-		$this->assertEquals($schema, $record['context']['schema']);
-		$this->assertEquals($request, $record['context']['request']);
-	}
 
-	public function test_log_after_graphql_execute_handles_null_operation(): void {
-		$lifecycle = $this->create_lifecycle_with_mock_logger();
 
-		$response = $this->create_mock_execution_result();
-		$schema = $this->create_mock_schema();
-		$query = '{ posts { title } }';
-		$variables = [];
-		$request = $this->create_mock_request();
-
-		$lifecycle->log_after_graphql_execute($response, $schema, null, $query, $variables, $request);
-
-		$records = $this->test_handler->getRecords();
-		$record = $records[0];
 
-		$this->assertEquals('', $record['context']['operation_name']);
-	}
 
 	public function test_log_before_response_returned_logs_info_for_success(): void {
 		$lifecycle = $this->create_lifecycle_with_mock_logger();
@@ -420,7 +382,6 @@ public function test_setup_registers_correct_priorities(): void {
 
 		$this->assertEquals(10, has_action('do_graphql_request', [$lifecycle, 'log_pre_request']));
 		$this->assertEquals(10, has_action('graphql_before_execute', [$lifecycle, 'log_graphql_before_execute']));
-		$this->assertEquals(10, has_action('graphql_execute', [$lifecycle, 'log_after_graphql_execute']));
 		$this->assertEquals(10, has_action('graphql_return_response', [$lifecycle, 'log_before_response_returned']));
 	}
 
@@ -503,7 +464,6 @@ public function test_all_lifecycle_methods_handle_exceptions_gracefully(): void
 
 		$response = $this->create_mock_execution_result();
 		$schema = $this->create_mock_schema();
-		$lifecycle->log_after_graphql_execute($response, $schema, null, '{ test }', [], $request);
 
 		$lifecycle->log_before_response_returned($response, $response, $schema, null, '{ test }', null, $request, null);