Changeset 3339885

Timestamp:

08/05/2025 09:16:42 PM (7 months ago)

Author:

gocardless

Message:

Update to version 2.9.7 from GitHub

Location:

woocommerce-gateway-gocardless

Files:

• tags/2.9.7 (copied) (copied from woocommerce-gateway-gocardless/trunk)
• tags/2.9.7/changelog.txt (modified) (1 diff)
• tags/2.9.7/includes/class-wc-gocardless-api.php (modified) (2 diffs)
• tags/2.9.7/includes/class-wc-gocardless-gateway-addons.php (modified) (2 diffs)
• tags/2.9.7/includes/class-wc-gocardless-gateway.php (modified) (1 diff)
• tags/2.9.7/readme.txt (modified) (2 diffs)
• tags/2.9.7/woocommerce-gateway-gocardless.php (modified) (3 diffs)
• trunk/changelog.txt (modified) (1 diff)
• trunk/includes/class-wc-gocardless-api.php (modified) (2 diffs)
• trunk/includes/class-wc-gocardless-gateway-addons.php (modified) (2 diffs)
• trunk/includes/class-wc-gocardless-gateway.php (modified) (1 diff)
• trunk/readme.txt (modified) (2 diffs)
• trunk/woocommerce-gateway-gocardless.php (modified) (3 diffs)

woocommerce-gateway-gocardless/tags/2.9.7/changelog.txt

@@ -1 +1 @@
 *** 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

woocommerce-gateway-gocardless/tags/2.9.7/includes/class-wc-gocardless-api.php

@@ -403 +403 @@
 
     /**
+     * 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.
      *
@@ -418 +435 @@
      * @param string $payment_id Payment ID.
      *
-     * @return array
+     * @return array|WP_Error
      */
     public static function cancel_payment( $payment_id ) {

woocommerce-gateway-gocardless/tags/2.9.7/includes/class-wc-gocardless-gateway-addons.php

@@ -30 +30 @@
             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' ) );
         }
 
@@ -324 +328 @@
         }
     }
+
+    /**
+     * 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() ) );
+            }
+        }
+    }
 }

woocommerce-gateway-gocardless/tags/2.9.7/includes/class-wc-gocardless-gateway.php

@@ -1633 +1633 @@
             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'
-            );
-
-            // If the action is not scheduled, return error to GoCardless, to get a retry.
-            if ( empty( $action_id ) ) {
+            $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 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() ) );

woocommerce-gateway-gocardless/tags/2.9.7/readme.txt

@@ -3 +3 @@
 Tags:         gocardless, woocommerce, direct debit, instant bank pay
 Tested up to: 6.8
-Stable tag:   2.9.6
+Stable tag:   2.9.7
 License:      GPL-3.0-or-later
 License URI:  https://spdx.org/licenses/GPL-3.0-or-later.html
@@ -140 +140 @@
 
 == Changelog ==
+
+= 2.9.7 - 2025-08-05 =
+* 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.
 
 = 2.9.6 - 2025-07-02 =

woocommerce-gateway-gocardless/tags/2.9.7/woocommerce-gateway-gocardless.php

@@ -4 +4 @@
  * Plugin URI:           https://www.woocommerce.com/products/gocardless/
  * Description:          Extends both WooCommerce and WooCommerce Subscriptions with the GoCardless Payment Gateway. A GoCardless merchant account is required.
- * Version:              2.9.6
- * Requires at least:    6.6
+ * Version:              2.9.7
+ * Requires at least:    6.7
  * Requires PHP:         7.4
  * PHP tested up to:     8.3
@@ -13 +13 @@
  * License URI:          https://spdx.org/licenses/GPL-3.0-or-later.html
  * Requires Plugins:     woocommerce
- * WC requires at least: 9.8
- * WC tested up to:      10.0
+ * WC requires at least: 9.9
+ * WC tested up to:      10.1
  *
  * Copyright: © 2023-2025 WooCommerce
@@ -39 +39 @@
      * @var string
      */
-    public $version = '2.9.6'; // WRCS: DEFINED_VERSION.
+    public $version = '2.9.7'; // WRCS: DEFINED_VERSION.
 
     /**

woocommerce-gateway-gocardless/trunk/changelog.txt

@@ -1 +1 @@
 *** 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

woocommerce-gateway-gocardless/trunk/includes/class-wc-gocardless-api.php

@@ -403 +403 @@
 
     /**
+     * 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.
      *
@@ -418 +435 @@
      * @param string $payment_id Payment ID.
      *
-     * @return array
+     * @return array|WP_Error
      */
     public static function cancel_payment( $payment_id ) {

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

@@ -30 +30 @@
             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' ) );
         }
 
@@ -324 +328 @@
         }
     }
+
+    /**
+     * 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() ) );
+            }
+        }
+    }
 }

woocommerce-gateway-gocardless/trunk/includes/class-wc-gocardless-gateway.php

@@ -1633 +1633 @@
             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'
-            );
-
-            // If the action is not scheduled, return error to GoCardless, to get a retry.
-            if ( empty( $action_id ) ) {
+            $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 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() ) );

woocommerce-gateway-gocardless/trunk/readme.txt

@@ -3 +3 @@
 Tags:         gocardless, woocommerce, direct debit, instant bank pay
 Tested up to: 6.8
-Stable tag:   2.9.6
+Stable tag:   2.9.7
 License:      GPL-3.0-or-later
 License URI:  https://spdx.org/licenses/GPL-3.0-or-later.html
@@ -140 +140 @@
 
 == Changelog ==
+
+= 2.9.7 - 2025-08-05 =
+* 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.
 
 = 2.9.6 - 2025-07-02 =

woocommerce-gateway-gocardless/trunk/woocommerce-gateway-gocardless.php

@@ -4 +4 @@
  * Plugin URI:           https://www.woocommerce.com/products/gocardless/
  * Description:          Extends both WooCommerce and WooCommerce Subscriptions with the GoCardless Payment Gateway. A GoCardless merchant account is required.
- * Version:              2.9.6
- * Requires at least:    6.6
+ * Version:              2.9.7
+ * Requires at least:    6.7
  * Requires PHP:         7.4
  * PHP tested up to:     8.3
@@ -13 +13 @@
  * License URI:          https://spdx.org/licenses/GPL-3.0-or-later.html
  * Requires Plugins:     woocommerce
- * WC requires at least: 9.8
- * WC tested up to:      10.0
+ * WC requires at least: 9.9
+ * WC tested up to:      10.1
  *
  * Copyright: © 2023-2025 WooCommerce
@@ -39 +39 @@
      * @var string
      */
-    public $version = '2.9.6'; // WRCS: DEFINED_VERSION.
+    public $version = '2.9.7'; // WRCS: DEFINED_VERSION.
 
     /**