feat: QL Session Handler refactored to handle non-GraphQL requests (#870)

kidunot89 · web-flow · commit 76e8db510ee9 · 2024-08-07T12:39:45.000-04:00
* feat: QL Session Handler functionality expanded to support cookies on non-GraphQL requests

* chore: Linter and PHPStan compliance met

* devops: QLSessionHandlerTest patched for suite testing

* chore: Linter and PHPStan compliance met

* fix: More cart session save triggered implemented

* fix: More cart session save triggered implemented

* chore: Linter compliance met

* chore: Linter compliance met

* feat: forgetSession mutation added

* feat: forgetSession mutation added
diff --git a/access-functions.php b/access-functions.php
@@ -19,8 +19,7 @@
 	 * @return bool - True if $haystack starts with $needle, false otherwise.
 	 */
 	function str_starts_with( $haystack, $needle ) {
-		$length = strlen( $needle );
-		return ( substr( $haystack, 0, $length ) === $needle );
+		return 0 === strpos( $haystack, $needle ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctionParameters.str_starts_with
 	}
 }
 
@@ -38,11 +37,8 @@ function str_starts_with( $haystack, $needle ) {
 	 */
 	function str_ends_with( $haystack, $needle ) {
 		$length = strlen( $needle );
-		if ( 0 === $length ) {
-			return true;
-		}
-
-		return ( substr( $haystack, -$length ) === $needle );
+		return 0 === $length
+			|| strpos( $haystack, $needle, - $length ) === $length - 1;
 	}
 }//end if
 
diff --git a/codeception.dist.yml b/codeception.dist.yml
@@ -66,11 +66,11 @@ modules:
       uploads: '/wp-content/uploads'
     WPLoader:
       wpRootFolder: '%WP_CORE_DIR%'
-      dbUrl: 'mysql://%DB_USER%:%DB_PASSWORD%@%DB_HOST%:%DB_PORT%/%DB_NAME%'
-      dbName: '%DB_NAME%'
       dbHost: '%DB_HOST%'
+      dbName: '%DB_NAME%'
       dbUser: '%DB_USER%'
       dbPassword: '%DB_PASSWORD%'
+      dbUrl: 'mysql://%DB_USER%:%DB_PASSWORD%@%DB_HOST%:%DB_PORT%/%DB_NAME%'
       tablePrefix: '%WP_TABLE_PREFIX%'
       domain: '%WORDPRESS_DOMAIN%'
       adminEmail: '%ADMIN_EMAIL%'
diff --git a/includes/admin/class-general.php b/includes/admin/class-general.php
@@ -77,6 +77,24 @@ public static function get_fields() {
 				'value'    => defined( 'NO_QL_SESSION_HANDLER' ) ? 'on' : woographql_setting( 'disable_ql_session_handler', 'off' ),
 				'disabled' => defined( 'NO_QL_SESSION_HANDLER' ),
 			],
+			[
+				'name'     => 'enable_ql_session_handler_on_ajax',
+				'label'    => __( 'Enable QL Session Handler on WC AJAX requests.', 'wp-graphql-woocommerce' ),
+				'desc'     => __( 'Enabling this will enable JSON Web Tokens usage on WC AJAX requests.', 'wp-graphql-woocommerce' )
+					. ( defined( 'NO_QL_SESSION_HANDLER' ) ? __( ' This setting is disabled. The "NO_QL_SESSION_HANDLER" flag has been triggered with code', 'wp-graphql-woocommerce' ) : '' ),
+				'type'     => 'checkbox',
+				'value'    => defined( 'NO_QL_SESSION_HANDLER' ) ? 'off' : woographql_setting( 'enable_ql_session_handler_on_ajax', 'off' ),
+				'disabled' => defined( 'NO_QL_SESSION_HANDLER' ),
+			],
+			[
+				'name'     => 'enable_ql_session_handler_on_rest',
+				'label'    => __( 'Enable QL Session Handler on WP REST requests.', 'wp-graphql-woocommerce' ),
+				'desc'     => __( 'Enabling this will enable JSON Web Tokens usage on WP REST requests.', 'wp-graphql-woocommerce' )
+					. ( defined( 'NO_QL_SESSION_HANDLER' ) ? __( ' This setting is disabled. The "NO_QL_SESSION_HANDLER" flag has been triggered with code', 'wp-graphql-woocommerce' ) : '' ),
+				'type'     => 'checkbox',
+				'value'    => defined( 'NO_QL_SESSION_HANDLER' ) ? 'off' : woographql_setting( 'enable_ql_session_handler_on_rest', 'off' ),
+				'disabled' => defined( 'NO_QL_SESSION_HANDLER' ),
+			],
 			[
 				'name'    => 'enable_unsupported_product_type',
 				'label'   => __( 'Enable Unsupported types', 'wp-graphql-woocommerce' ),
diff --git a/includes/class-type-registry.php b/includes/class-type-registry.php
@@ -199,6 +199,7 @@ public function init() {
 		Mutation\Tax_Rate_Create::register_mutation();
 		Mutation\Tax_Rate_Delete::register_mutation();
 		Mutation\Tax_Rate_Update::register_mutation();
-		Mutation\Update_Session::register_mutation();
+		Mutation\Session_Delete::register_mutation();
+		Mutation\Session_Update::register_mutation();
 	}
 }
diff --git a/includes/class-woocommerce-filters.php b/includes/class-woocommerce-filters.php
@@ -82,14 +82,34 @@ public static function get_authorizing_url_nonce_param_name( $field ) {
 		return woographql_setting( "{$field}_nonce_param", null );
 	}
 
+	/**
+	 * Returns true if the session handler should be loaded.
+	 *
+	 * @return boolean
+	 */
+	public static function should_load_session_handler() {
+		switch ( true ) {
+			case \WPGraphQL\Router::is_graphql_http_request():
+			//phpcs:disable
+			case 'on' === woographql_setting( 'enable_ql_session_handler_on_ajax', 'off' )
+				&& ( ! empty( $_GET['wc-ajax'] ) || defined( 'WC_DOING_AJAX' ) ):
+			//phpcs:enable
+			case 'on' === woographql_setting( 'enable_ql_session_handler_on_rest', 'off' )
+				&& ( defined( 'REST_REQUEST' ) && REST_REQUEST ):
+				return true;
+			default:
+				return false;
+		}
+	}
+
 	/**
 	 * WooCommerce Session Handler callback
 	 *
 	 * @param string $session_class  Class name of WooCommerce Session Handler.
 	 * @return string
 	 */
 	public static function woocommerce_session_handler( $session_class ) {
-		if ( \WPGraphQL\Router::is_graphql_http_request() ) {
+		if ( self::should_load_session_handler() ) {
 			$session_class = '\WPGraphQL\WooCommerce\Utils\QL_Session_Handler';
 		} elseif ( WooGraphQL::auth_router_is_enabled() ) {
 			require_once get_includes_directory() . 'utils/class-protected-router.php';
diff --git a/includes/class-wp-graphql-woocommerce.php b/includes/class-wp-graphql-woocommerce.php
@@ -343,6 +343,8 @@ private function includes() {
 			require $include_directory_path . 'mutation/class-review-update.php';
 			require $include_directory_path . 'mutation/class-payment-method-delete.php';
 			require $include_directory_path . 'mutation/class-payment-method-set-default.php';
+			require $include_directory_path . 'mutation/class-session-delete.php';
+			require $include_directory_path . 'mutation/class-session-update.php';
 			require $include_directory_path . 'mutation/class-shipping-zone-create.php';
 			require $include_directory_path . 'mutation/class-shipping-zone-delete.php';
 			require $include_directory_path . 'mutation/class-shipping-zone-locations-clear.php';
@@ -356,7 +358,6 @@ private function includes() {
 			require $include_directory_path . 'mutation/class-tax-rate-create.php';
 			require $include_directory_path . 'mutation/class-tax-rate-delete.php';
 			require $include_directory_path . 'mutation/class-tax-rate-update.php';
-			require $include_directory_path . 'mutation/class-update-session.php';
 
 			// Include connection class/function files.
 			require $include_directory_path . 'connection/wc-cpt-connection-args.php';
diff --git a/includes/mutation/class-cart-add-fee.php b/includes/mutation/class-cart-add-fee.php
@@ -106,6 +106,8 @@ public static function mutate_and_get_payload() {
 			// Add cart fee.
 			\WC()->cart->add_fee( ...$cart_fee_args );
 
+			do_action( 'woographql_update_session', true );
+
 			// Return payload.
 			return [ 'id' => \sanitize_title( $input['name'] ) ];
 		};
diff --git a/includes/mutation/class-cart-apply-coupon.php b/includes/mutation/class-cart-apply-coupon.php
@@ -76,6 +76,8 @@ public static function mutate_and_get_payload() {
 			$reason = '';
 			// If validate and successful applied to cart, return payload.
 			if ( Cart_Mutation::validate_coupon( $input['code'], $reason ) && \WC()->cart->apply_coupon( $input['code'] ) ) {
+				do_action( 'woographql_update_session', true );
+
 				return [ 'code' => $input['code'] ];
 			}
 
diff --git a/includes/mutation/class-cart-empty.php b/includes/mutation/class-cart-empty.php
@@ -94,6 +94,8 @@ public static function mutate_and_get_payload() {
 			 */
 			do_action( 'graphql_woocommerce_after_empty_cart', $cloned_cart, $input, $context, $info );
 
+			do_action( 'woographql_update_session', true );
+
 			return [ 'cart' => $cloned_cart ];
 		};
 	}
diff --git a/includes/mutation/class-cart-fill.php b/includes/mutation/class-cart-fill.php
@@ -270,6 +270,8 @@ public static function mutate_and_get_payload() {
 			// Recalculate totals.
 			\WC()->cart->calculate_totals();
 
+			do_action( 'woographql_update_session', true );
+
 			// Return payload.
 			return compact(
 				'added',
diff --git a/includes/mutation/class-cart-remove-coupons.php b/includes/mutation/class-cart-remove-coupons.php
@@ -86,6 +86,8 @@ public static function mutate_and_get_payload() {
 				}
 			}
 
+			do_action( 'woographql_update_session', true );
+
 			// Return payload.
 			return [ 'cart' => \WC()->cart ];
 		};
diff --git a/includes/mutation/class-cart-remove-items.php b/includes/mutation/class-cart-remove-items.php
@@ -96,6 +96,8 @@ public static function mutate_and_get_payload() {
 				}
 			}
 
+			do_action( 'woographql_update_session', true );
+
 			// Return payload.
 			return [ 'items' => $cart_items ];
 		};
diff --git a/includes/mutation/class-cart-restore-items.php b/includes/mutation/class-cart-restore-items.php
@@ -82,6 +82,8 @@ public static function mutate_and_get_payload() {
 
 			$cart_items = Cart_Mutation::retrieve_cart_items( $input, $context, $info, 'restore' );
 
+			do_action( 'woographql_update_session', true );
+
 			// Return payload.
 			return [ 'items' => $cart_items ];
 		};
diff --git a/includes/mutation/class-cart-update-item-quantities.php b/includes/mutation/class-cart-update-item-quantities.php
@@ -165,6 +165,8 @@ static function ( $value ) {
 				$info
 			);
 
+			do_action( 'woographql_update_session', true );
+
 			return [
 				'removed' => $removed_items,
 				'updated' => array_keys( $updated ),
diff --git a/includes/mutation/class-cart-update-shipping-method.php b/includes/mutation/class-cart-update-shipping-method.php
@@ -78,6 +78,8 @@ public static function mutate_and_get_payload() {
 			// Recalculate totals.
 			\WC()->cart->calculate_totals();
 
+			do_action( 'woographql_update_session', true );
+
 			return [];
 		};
 	}
diff --git a/includes/mutation/class-customer-update.php b/includes/mutation/class-customer-update.php
@@ -153,6 +153,10 @@ public static function mutate_and_get_payload() {
 			// Save customer and get customer ID.
 			$customer->save();
 
+			if ( $session_only ) {
+				do_action( 'woographql_update_session', true );
+			}
+
 			// Return payload.
 			return ! empty( $payload ) ? $payload : [ 'id' => 'session' ];
 		};
diff --git a/includes/mutation/class-session-delete.php b/includes/mutation/class-session-delete.php
@@ -0,0 +1,95 @@
+<?php
+/**
+ * Mutation - forgetSession
+ *
+ * Registers mutation for deleting sessions from the DB.
+ *
+ * @package WPGraphQL\WooCommerce\Mutation
+ * @since TBD
+ */
+
+namespace WPGraphQL\WooCommerce\Mutation;
+
+use WPGraphQL\WooCommerce\Data\Mutation\Cart_Mutation;
+
+/**
+ * Class - Session_Delete
+ */
+class Session_Delete {
+	/**
+	 * Registers mutation
+	 *
+	 * @return void
+	 */
+	public static function register_mutation() {
+		register_graphql_mutation(
+			'forgetSession',
+			[
+				'inputFields'         => [],
+				'outputFields'        => self::get_output_fields(),
+				'mutateAndGetPayload' => self::mutate_and_get_payload(),
+			]
+		);
+	}
+
+	/**
+	 * Defines the mutation output field configuration
+	 *
+	 * @return array
+	 */
+	public static function get_output_fields() {
+		return [
+			'session' => [
+				'type'    => [ 'list_of' => 'MetaData' ],
+				'resolve' => static function ( $payload ) {
+					// Guard against missing session data.
+					if ( empty( $payload['session'] ) ) {
+						return [];
+					}
+
+					// Prepare session data.
+					$session = [];
+					foreach ( $payload['session'] as $key => $value ) {
+						$meta        = new \stdClass();
+						$meta->id    = null;
+						$meta->key   = $key;
+						$meta->value = maybe_unserialize( $value );
+						$session[]   = $meta;
+					}
+
+					return $session;
+				},
+			],
+		];
+	}
+
+	/**
+	 * Defines the mutation data modification closure.
+	 *
+	 * @return callable
+	 */
+	public static function mutate_and_get_payload() {
+		return static function ( $input ) {
+			Cart_Mutation::check_session_token();
+
+			/**
+			 * Session handler.
+			 *
+			 * @var \WPGraphQL\WooCommerce\Utils\QL_Session_Handler $session
+			 */
+			$session = \WC()->session;
+
+			// Get session data.
+			$session_data = $session->get_session_data();
+			do_action( 'woographql_before_forget_session', $session_data, $input, $session );
+
+			// Clear session data.
+			$session->forget_session();
+
+			do_action( 'woographql_after_forget_session', $session_data, $input, $session );
+
+			// Return payload.
+			return [ 'session' => $session_data ];
+		};
+	}
+}
diff --git a/includes/mutation/class-session-update.php b/includes/mutation/class-session-update.php
@@ -15,9 +15,9 @@
 use WPGraphQL\WooCommerce\Model\Customer;
 
 /**
- * Class - Update_Session
+ * Class - Session_Update
  */
-class Update_Session {
+class Session_Update {
 	/**
 	 * Registers mutation
 	 *
diff --git a/includes/utils/class-ql-session-handler.php b/includes/utils/class-ql-session-handler.php
diff --git a/includes/utils/class-session-transaction-manager.php b/includes/utils/class-session-transaction-manager.php
diff --git a/tests/_support/Factory/CartFactory.php b/tests/_support/Factory/CartFactory.php
diff --git a/tests/functional/CartTransactionQueueCest.php b/tests/functional/CartTransactionQueueCest.php
diff --git a/tests/wpunit/QLSessionHandlerTest.php b/tests/wpunit/QLSessionHandlerTest.php
diff --git a/tests/wpunit/SessionMutationsTest.php b/tests/wpunit/SessionMutationsTest.php

Original file line number	Diff line number	Diff line change
`@@ -199,6 +199,7 @@ public function init() {`
`199`	`199`	`Mutation\Tax_Rate_Create::register_mutation();`
`200`	`200`	`Mutation\Tax_Rate_Delete::register_mutation();`
`201`	`201`	`Mutation\Tax_Rate_Update::register_mutation();`
`202`		`- Mutation\Update_Session::register_mutation();`
	`202`	`+ Mutation\Session_Delete::register_mutation();`
	`203`	`+ Mutation\Session_Update::register_mutation();`
`203`	`204`	`}`
`204`	`205`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,8 @@ public static function mutate_and_get_payload() {`
`76`	`76`	`$reason = '';`
`77`	`77`	`// If validate and successful applied to cart, return payload.`
`78`	`78`	`if ( Cart_Mutation::validate_coupon( $input['code'], $reason ) && \WC()->cart->apply_coupon( $input['code'] ) ) {`
	`79`	`+ do_action( 'woographql_update_session', true );`
	`80`	`+`
`79`	`81`	`return [ 'code' => $input['code'] ];`
`80`	`82`	`}`
`81`	`83`
Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,8 @@ public static function mutate_and_get_payload() {`
`94`	`94`	`*/`
`95`	`95`	`do_action( 'graphql_woocommerce_after_empty_cart', $cloned_cart, $input, $context, $info );`
`96`	`96`
	`97`	`+ do_action( 'woographql_update_session', true );`
	`98`	`+`
`97`	`99`	`return [ 'cart' => $cloned_cart ];`
`98`	`100`	`};`
`99`	`101`	`}`