Merge branch 'develop' into trunk

Author: dkotter

changelog.txt

@@ -1,5 +1,12 @@
 *** GoCardless for WooCommerce Changelog ***
 
+2025-08-05 - version 2.9.7
+* Add - Improved subscription cancellation by cancelling "Pending Submission" payments and preventing retries on non-cancellable payments.
+* Fix - Ensure webhook events are handled properly without any issues.
+* Dev - Bump WordPress minimum supported version to 6.7.
+* Dev - Bump WooCommerce "tested up to" version 10.1.
+* Dev - Bump WooCommerce minimum supported version to 9.9.
+
 2025-07-02 - version 2.9.6
 * Add - Respond with an error to the GoCardless webhook call if the scheduling action fails.
 * Add - A notice indicating that GoCardless is connected in sandbox mode if the merchant is connected to a sandbox account.

includes/class-wc-gocardless-api.php

@@ -401,6 +401,23 @@ public static function create_payment( $params = array() ) {
 		return self::_request( 'payments', $args );
 	}
 
+	/**
+	 * Update payment.
+	 *
+	 * @param string $payment_id Payment ID.
+	 * @param array  $params     Parameters to update payment.
+	 *
+	 * @return array|WP_Error
+	 */
+	public static function update_payment( $payment_id, $params = array() ) {
+		$args = array(
+			'method' => 'PUT',
+			'body'   => wp_json_encode( array( 'payments' => $params ) ),
+		);
+
+		return self::_request( 'payments/' . $payment_id, $args );
+	}
+
 	/**
 	 * Get a single payment from given payment_id.
 	 *
@@ -417,7 +434,7 @@ public static function get_payment( $payment_id ) {
 	 *
 	 * @param string $payment_id Payment ID.
 	 *
-	 * @return array
+	 * @return array|WP_Error
 	 */
 	public static function cancel_payment( $payment_id ) {
 		$args = array(

includes/class-wc-gocardless-gateway-addons.php

@@ -29,6 +29,10 @@ public function __construct() {
 			// Allow store managers to manually set GoCardless as the payment method on a subscription.
 			add_filter( 'woocommerce_subscription_payment_meta', array( $this, 'add_subscription_payment_meta' ), 10, 2 );
 			add_action( 'woocommerce_subscription_validate_payment_meta', array( $this, 'validate_subscription_payment_meta' ), 10, 2 );
+
+			// Cancel in-progress payment on subscription cancellation.
+			add_action( 'woocommerce_subscription_pending-cancel_' . $this->id, array( $this, 'maybe_cancel_subscription_payment' ) );
+			add_action( 'woocommerce_subscription_cancelled_' . $this->id, array( $this, 'maybe_cancel_subscription_payment' ) );
 		}
 
 		if ( class_exists( 'WC_Pre_Orders_Order' ) ) {
@@ -323,4 +327,63 @@ public function validate_subscription_payment_meta( $payment_method_id, $payment
 			}
 		}
 	}
+
+	/**
+	 * Cancel the order payment on subscription cancellation.
+	 *
+	 * If the payment is pending submission, we can cancel it.
+	 * Otherwise, update the retry_if_possible to false to avoid the payment being retried (except for paid_out and cancelled payment states).
+	 *
+	 * @since 2.9.7
+	 *
+	 * @param WC_Subscription $subscription Subscription object.
+	 */
+	public function maybe_cancel_subscription_payment( $subscription ) {
+		if ( ! $subscription ) {
+			return;
+		}
+		wc_gocardless()->log( sprintf( '%s - Subscription cancelled/Pending cancellation, checking if payment should be cancelled', __METHOD__ ) );
+
+		$last_order = $subscription->get_last_order( 'all' );
+		if ( ! $last_order ) {
+			return;
+		}
+
+		$payment_id = $this->get_order_resource( $last_order->get_id(), 'payment', 'id' );
+		$payment    = WC_GoCardless_API::get_payment( $payment_id );
+		if ( is_wp_error( $payment ) || empty( $payment['payments'] ) ) {
+			wc_gocardless()->log( sprintf( '%s - Failed to retrieve payment.', __METHOD__ ) );
+			return;
+		}
+
+		$gocardless_status = $payment['payments']['status'] ?? '';
+		wc_gocardless()->log( sprintf( '%s - GoCardless payment status: %s', __METHOD__, $gocardless_status ) );
+
+		// If the payment is pending submission, we can cancel it.
+		if ( 'pending_submission' === $gocardless_status ) {
+			$response = WC_GoCardless_API::cancel_payment( $payment_id );
+			if ( ! is_wp_error( $response ) ) {
+				wc_gocardless()->log( sprintf( '%s - Payment cancelled', __METHOD__ ) );
+			} else {
+				wc_gocardless()->log( sprintf( '%s - Failed to cancel payment: %s', __METHOD__, $response->get_error_message() ) );
+			}
+		} elseif (
+			! in_array(
+				$gocardless_status,
+				array(
+					'paid_out',
+					'cancelled',
+				),
+				true
+			)
+		) {
+			// We can't cancel the payment, so we update it to not retry if possible to avoid the payment being retried.
+			$response = WC_GoCardless_API::update_payment( $payment_id, array( 'retry_if_possible' => false ) );
+			if ( ! is_wp_error( $response ) ) {
+				wc_gocardless()->log( sprintf( '%s - Payment updated with retry_if_possible set to false', __METHOD__ ) );
+			} else {
+				wc_gocardless()->log( sprintf( '%s - Failed to update payment: %s', __METHOD__, $response->get_error_message() ) );
+			}
+		}
+	}
 }

includes/class-wc-gocardless-gateway.php

@@ -1632,24 +1632,43 @@ protected function _handle_webhook() {
 
 			wc_gocardless()->log( sprintf( '%s - Handling webhook. Payload: %s', __METHOD__, print_r( $payload, true ) ) );
 
-			$args = array( $payload );
-
-			// Process the webhook payload asynchronously.
-			$action_id = WC()->queue()->schedule_single(
-				WC()->call_function( 'time' ) + 1,
-				'woocommerce_gocardless_process_webhook_payload_async',
-				$args,
-				'woocommerce-gocardless-webhook'
-			);
+			$webhook_payload = $payload;
+			$schedule_failed = false;
+
+			/*
+			 * Loop through each event to schedule the action for each event separately.
+			 * This is to avoid the issue where the webhook payload is too large and the action not get scheduled.
+			 *
+			 * @see https://github.com/gocardless/woocommerce-gateway-gocardless/issues/79
+			 */
+			foreach ( $payload['events'] as $event ) {
+				// Update the webhook payload with the current event only.
+				$webhook_payload['events'] = array( $event );
+
+				// Schedule the action to process the webhook payload asynchronously.
+				$action_id = WC()->queue()->schedule_single(
+					time() + 1,
+					'woocommerce_gocardless_process_webhook_payload_async',
+					array( $webhook_payload ),
+					'woocommerce-gocardless-webhook'
+				);
 
-			// If the action is not scheduled, return error to GoCardless, to get a retry.
-			if ( empty( $action_id ) ) {
+				// If any action fail to schedule, mark the schedule as failed, and return error to GoCardless, to get a retry.
+				if ( empty( $action_id ) ) {
+					$schedule_failed = true;
+					break;
+				}
+
+				$webhook_payload['events'] = array();
+				wc_gocardless()->log( sprintf( '%s - Action scheduled with ID %d, to process webhook.', __METHOD__, $action_id ) );
+			}
+
+			// Return error to GoCardless, to get a retry.
+			if ( $schedule_failed ) {
 				wc_gocardless()->log( sprintf( '%s - Failed to schedule action to process webhook.', __METHOD__ ) );
 				header( 'HTTP/1.1 500 Internal Server Error' );
 				throw new Exception( esc_html__( 'Failed to schedule action to process webhook.', 'woocommerce-gateway-gocardless' ) );
 			}
-
-			wc_gocardless()->log( sprintf( '%s - Action scheduled with ID %d, to process webhook.', __METHOD__, $action_id ) );
 		} catch ( Exception $e ) {
 			wc_gocardless()->log( sprintf( '%s - Error when handling webhook: %s', __METHOD__, $e->getMessage() ) );
 			wp_send_json_error( array( 'message' => $e->getMessage() ) );