fix: Session transaction queue fix (#832)

* fix: Session transaction queue pop relocated to earlier occurrence in request

* chore: Linter and PHPStan compliance met

Author: kidunot89

includes/utils/class-ql-session-handler.php

@@ -107,7 +107,6 @@ public function init() {
 		 */
 		add_action( 'woocommerce_set_cart_cookies', [ $this, 'set_customer_session_token' ], 10 );
 		add_action( 'woographql_update_session', [ $this, 'set_customer_session_token' ], 10 );
-		add_action( 'graphql_after_resolve_field', [ $this, 'save_if_dirty' ], 10, 4 );
 		add_action( 'shutdown', [ $this, 'save_data' ] );
 		add_action( 'wp_logout', [ $this, 'destroy_session' ] );
 
@@ -413,19 +412,9 @@ public function forget_session() {
 	/**
 	 * Save any changes to database after a session mutations has been run.
 	 *
-	 * @param mixed                                $source   Operation root object.
-	 * @param array                                $args     Operation arguments.
-	 * @param \WPGraphQL\AppContext                $context  AppContext instance.
-	 * @param \GraphQL\Type\Definition\ResolveInfo $info     Operation ResolveInfo object.
-	 *
 	 * @return void
 	 */
-	public function save_if_dirty( $source, $args, $context, $info ) {
-		// Bail early, if not one of the session mutations.
-		if ( ! in_array( $info->fieldName, Session_Transaction_Manager::get_session_mutations(), true ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-			return;
-		}
-
+	public function save_if_dirty() {
 		// Update if user recently authenticated.
 		if ( is_user_logged_in() && get_current_user_id() !== $this->_customer_id ) {
 			$this->_customer_id = get_current_user_id();

includes/utils/class-session-transaction-manager.php

@@ -60,7 +60,8 @@ public function __construct( &$session_handler ) {
 		$this->session_handler = $session_handler;
 
 		add_action( 'graphql_before_resolve_field', [ $this, 'update_transaction_queue' ], 10, 4 );
-		add_action( 'graphql_process_http_request_response', [ $this, 'pop_transaction_id' ], 20 );
+		add_action( 'graphql_mutation_response', [ $this, 'pop_transaction_id' ], 20, 6 );
+		add_action( 'woographql_session_transaction_complete', [ $this->session_handler, 'save_if_dirty' ], 10 );
 	}
 
 	/**
@@ -202,16 +203,28 @@ public function get_transaction_queue() {
 	/**
 	 * Pop transaction ID off the top of the queue, ending the transaction.
 	 *
+	 * @param array                                $payload          The Payload returned from the mutation.
+	 * @param array                                $input            The mutation input args, after being filtered by 'graphql_mutation_input'.
+	 * @param array                                $unfiltered_input The unfiltered input args of the mutation
+	 * @param \WPGraphQL\AppContext                $context          The AppContext object.
+	 * @param \GraphQL\Type\Definition\ResolveInfo $info             The ResolveInfo object.
+	 * @param string                               $mutation         The name of the mutation field.
+	 *
 	 * @throws \GraphQL\Error\UserError If transaction ID is not on the top of the queue.
 	 *
 	 * @return void
 	 */
-	public function pop_transaction_id() {
+	public function pop_transaction_id( $payload, $input, $unfiltered_input, $context, $info, $mutation ) {
 		// Bail if transaction not started.
 		if ( is_null( $this->transaction_id ) ) {
 			return;
 		}
 
+		// Bail if not the expected mutation.
+		if ( str_starts_with( $this->transaction_id, "wooSession_{$mutation}_" ) ) {
+			return;
+		}
+
 		// Get transaction queue.
 		$transaction_queue = get_transient( "woo_session_transactions_queue_{$this->session_handler->get_customer_id()}" );
 
@@ -223,6 +236,16 @@ public function pop_transaction_id() {
 			// Remove Transaction ID and update queue.
 			array_shift( $transaction_queue );
 			$this->save_transaction_queue( $transaction_queue );
+
+			/**
+			 * Mark transaction completion
+			 * 
+			 * @param string|null $transition_id     Removed transaction ID.
+			 * @param array       $transaction_queue Transaction Queue.
+			 */
+			do_action( 'woographql_session_transaction_complete', $this->transaction_id, $transaction_queue );
+			
+			// Clear transaction ID.
 			$this->transaction_id = null;
 		}
 	}

tests/functional/CartTransactionQueueCest.php

@@ -268,11 +268,11 @@ public function testCartTransactionQueueWithConcurrentRequest( FunctionalTester
 		$client   = new \GuzzleHttp\Client( compact( 'base_uri', 'headers', 'timeout' ) );
 
 		$iterator = static function ( $requests ) use ( $client ) {
-			$stagger = 1000;
+			$stagger = 800;
 			foreach ( $requests as $index => $payload ) {
 				yield static function () use ( $client, $stagger, $index, $payload ) {
 					$body      = json_encode( $payload );
-					$delay     = $stagger * $index + 1;
+					$delay     = $stagger * ($index + 1);
 					$connected = false;
 					$progress  = static function ( $downloadTotal, $downloadedBytes, $uploadTotal, $uploadedBytes ) use ( $index, &$connected ) {
 						if ( $uploadTotal === $uploadedBytes && 0 === $downloadTotal && ! $connected ) {
@@ -294,8 +294,10 @@ public function testCartTransactionQueueWithConcurrentRequest( FunctionalTester
 					\codecept_debug( "Finished session mutation request $index @ " . ( new \Carbon\Carbon() )->format( 'Y-m-d H:i:s' ) );
 
 					$expected = $expected_responses[ $index ];
+					$headers  = $response->getHeaders();
 					$body     = json_decode( $response->getBody(), true );
-
+					
+					\codecept_debug( $headers );
 					\codecept_debug( $body );
 					$I->assertEquals( $expected, $body['data'] );
 				},