Moving the method checking for the subscription extension status to a new helper class

changelog.txt

@@ -1,6 +1,7 @@
 *** Changelog ***
 
 = 9.3.0 - xxxx-xx-xx =
+* Dev - Moves the method to check if the subscriptions extension is enabled to a new helper class.
 * Fix - Fixes a fatal error that might happen when a payment method ID cannot be retrieved during the processing of an order (new checkout experience).
 * Dev - Generates a code coverage report for PHP Unit tests as a comment on PRs.
 * Add - Adds Stripe specific information to the System Status Report data.

includes/admin/class-wc-stripe-admin-notices.php

@@ -9,13 +9,6 @@
  * @since 4.1.0
  */
 class WC_Stripe_Admin_Notices {
-	/**
-	 * Transient key for detached subscriptions.
-	 *
-	 * @var string
-	 */
-	private const DETACHED_SUBSCRIPTIONS_TRANSIENT_KEY = 'wcstripe_detached_subscriptions';
-
 	/**
 	 * Stripe customer page base URL.
 	 *
@@ -73,7 +66,7 @@ public function admin_notices() {
 		$this->payment_methods_check_environment();
 
 		// Subscription related checks.
-		if ( class_exists( 'WC_Subscriptions' ) && class_exists( 'WC_Subscription' ) && version_compare( WC_Subscriptions::$version, '2.2.0', '>=' ) ) {
+		if ( WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() ) {
 			$this->subscriptions_check_environment();
 		}
 
@@ -405,7 +398,7 @@ public function payment_methods_check_environment() {
 	 */
 	public function subscriptions_check_environment() {
 		$detached_messages = '';
-		$subscriptions     = $this->get_detached_subscriptions();
+		$subscriptions     = WC_Stripe_Subscriptions_Helper::get_detached_subscriptions();
 		foreach ( $subscriptions as $subscription ) {
 			$customer_payment_method_link = sprintf(
 				'<a href="%s">%s</a>',
@@ -529,47 +522,6 @@ public function stripe_updated() {
 			update_option( 'wc_stripe_show_sca_notice', 'no' );
 		}
 	}
-
-	/**
-	 * Returns a list of subscriptions without a payment method attached.
-	 *
-	 * @return array
-	 */
-	private function get_detached_subscriptions() {
-		// Check if we have a cached result.
-		$cached_subscriptions = get_transient( self::DETACHED_SUBSCRIPTIONS_TRANSIENT_KEY );
-		if ( ! empty( $cached_subscriptions ) ) {
-			return $cached_subscriptions;
-		}
-
-		$detached_subscriptions = [];
-		$subscriptions          = wcs_get_subscriptions(
-			[
-				'subscriptions_per_page' => -1,
-				'orderby'                => 'date',
-				'order'                  => 'DESC',
-				'subscription_status'    => [ 'active', 'on-hold', 'pending-cancel' ],
-			]
-		);
-		foreach ( $subscriptions as $subscription ) {
-			$source_id = $subscription->get_meta( '_stripe_source_id' );
-			if ( $source_id ) {
-				$payment_method = WC_Stripe_API::get_payment_method( $source_id );
-				if ( ! $payment_method->customer ) {
-					$detached_subscriptions[] = [
-						'id'                        => $subscription->get_id(),
-						'customer_id'               => $subscription->get_meta( '_stripe_customer_id' ),
-						'change_payment_method_url' => $subscription->get_change_payment_method_url(),
-					];
-				}
-			}
-		}
-
-		// Cache the result for a day.
-		set_transient( self::DETACHED_SUBSCRIPTIONS_TRANSIENT_KEY, $detached_subscriptions, DAY_IN_SECONDS );
-
-		return $detached_subscriptions;
-	}
 }
 
 new WC_Stripe_Admin_Notices();

includes/compat/class-wc-stripe-subscriptions-helper.php

@@ -0,0 +1,66 @@
+<?php
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly.
+}
+
+/**
+ * Helper class to handle subscriptions.
+ */
+class WC_Stripe_Subscriptions_Helper {
+	/**
+	 * Transient key for detached subscriptions.
+	 *
+	 * @var string
+	 */
+	private const DETACHED_SUBSCRIPTIONS_TRANSIENT_KEY = 'wcstripe_detached_subscriptions';
+
+	/**
+	 * Checks if subscriptions are enabled on the site.
+	 *
+	 * @return bool Whether subscriptions is enabled or not.
+	 */
+	public static function is_subscriptions_enabled() {
+		return class_exists( 'WC_Subscriptions' ) && class_exists( 'WC_Subscription' ) && version_compare( WC_Subscriptions::$version, '2.2.0', '>=' );
+	}
+
+	/**
+	 * Returns a list of subscriptions that are detached from the customer.
+	 *
+	 * @return array
+	 */
+	public static function get_detached_subscriptions() {
+		// Check if we have a cached result.
+		$cached_subscriptions = get_transient( self::DETACHED_SUBSCRIPTIONS_TRANSIENT_KEY );
+		if ( ! empty( $cached_subscriptions ) ) {
+			return $cached_subscriptions;
+		}
+
+		$detached_subscriptions = [];
+		$subscriptions          = wcs_get_subscriptions(
+			[
+				'subscriptions_per_page' => -1,
+				'orderby'                => 'date',
+				'order'                  => 'DESC',
+				'subscription_status'    => [ 'active', 'on-hold', 'pending-cancel' ],
+			]
+		);
+		foreach ( $subscriptions as $subscription ) {
+			$source_id = $subscription->get_meta( '_stripe_source_id' );
+			if ( $source_id ) {
+				$payment_method = WC_Stripe_API::get_payment_method( $source_id );
+				if ( ! $payment_method->customer ) {
+					$detached_subscriptions[] = [
+						'id'                        => $subscription->get_id(),
+						'customer_id'               => $subscription->get_meta( '_stripe_customer_id' ),
+						'change_payment_method_url' => $subscription->get_change_payment_method_url(),
+					];
+				}
+			}
+		}
+
+		// Cache the result for a day.
+		set_transient( self::DETACHED_SUBSCRIPTIONS_TRANSIENT_KEY, $detached_subscriptions, DAY_IN_SECONDS );
+
+		return $detached_subscriptions;
+	}
+}

includes/compat/trait-wc-stripe-subscriptions-utilities.php

@@ -17,9 +17,12 @@ trait WC_Stripe_Subscriptions_Utilities_Trait {
 	 * @since 5.6.0
 	 *
 	 * @return bool Whether subscriptions is enabled or not.
+	 *
+	 * @deprecated 9.2.0 Use WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled instead.
 	 */
 	public function is_subscriptions_enabled() {
-		return class_exists( 'WC_Subscriptions' ) && class_exists( 'WC_Subscription' ) && version_compare( WC_Subscriptions::$version, '2.2.0', '>=' );
+		wc_deprecated_function( 'is_subscriptions_enabled', '9.2.0', 'WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled' );
+		return WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled();
 	}
 
 	/**
@@ -64,7 +67,7 @@ public function is_changing_payment_method_for_subscription() {
 	 * @return bool
 	 */
 	public function is_payment_recurring( $order_id ) {
-		if ( ! $this->is_subscriptions_enabled() ) {
+		if ( ! WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() ) {
 			return false;
 		}
 		return $this->is_changing_payment_method_for_subscription() || $this->has_subscription( $order_id );
@@ -103,7 +106,7 @@ public function display_save_payment_method_checkbox( $display ) {
 	 * @return bool
 	 */
 	public function is_subscription_item_in_cart() {
-		if ( $this->is_subscriptions_enabled() ) {
+		if ( WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() ) {
 			return ( class_exists( 'WC_Subscriptions_Cart' ) && WC_Subscriptions_Cart::cart_contains_subscription() ) || $this->cart_contains_renewal();
 		}
 		return false;

includes/compat/trait-wc-stripe-subscriptions.php

@@ -25,7 +25,7 @@ trait WC_Stripe_Subscriptions_Trait {
 	 * @since 5.6.0
 	 */
 	public function maybe_init_subscriptions() {
-		if ( ! $this->is_subscriptions_enabled() ) {
+		if ( ! WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() ) {
 			return;
 		}
 
@@ -211,7 +211,7 @@ public function differentiate_change_payment_method_form() {
 	 */
 	public function maybe_change_subscription_payment_method( $order_id ) {
 		return (
-			$this->is_subscriptions_enabled() &&
+			WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() &&
 			$this->has_subscription( $order_id ) &&
 			$this->is_changing_payment_method_for_subscription()
 		);
@@ -572,7 +572,7 @@ public function process_subscription_payment( $amount, $renewal_order, $retry =
 	 * @param string   $payment_gateway_id The payment method ID. eg 'stripe.
 	 */
 	public function maybe_update_source_on_subscription_order( $order, $source, $payment_gateway_id = '' ) {
-		if ( ! $this->is_subscriptions_enabled() ) {
+		if ( ! WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() ) {
 			return;
 		}
 
@@ -1081,7 +1081,7 @@ public function redirect_after_early_renewal( $url ) {
 	 * @param stdClass $intent The Payment Intent object.
 	 */
 	protected function maybe_process_subscription_early_renewal_success( $order, $intent ) {
-		if ( $this->is_subscriptions_enabled() && isset( $_GET['early_renewal'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
+		if ( WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() && isset( $_GET['early_renewal'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
 			if ( function_exists( 'wcs_update_dates_after_early_renewal' ) && function_exists( 'wcs_get_subscription' ) ) {
 				wcs_update_dates_after_early_renewal( wcs_get_subscription( $order->get_meta( '_subscription_renewal' ) ), $order );
 			}
@@ -1098,7 +1098,7 @@ protected function maybe_process_subscription_early_renewal_success( $order, $in
 	 * @param stdClass $intent The Payment Intent object (unused).
 	 */
 	protected function maybe_process_subscription_early_renewal_failure( $order, $intent ) {
-		if ( $this->is_subscriptions_enabled() && isset( $_GET['early_renewal'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
+		if ( WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() && isset( $_GET['early_renewal'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
 			$order->delete( true );
 			wc_add_notice( __( 'Payment authorization for the renewal order was unsuccessful, please try again.', 'woocommerce-gateway-stripe' ), 'error' );
 			$renewal_url = ( function_exists( 'wcs_get_early_renewal_url' ) && function_exists( 'wcs_get_subscription' ) )
@@ -1130,7 +1130,7 @@ protected function must_authorize_off_session( $payment_intent ) {
 	 * @param string   $payment_method_type The payment method ID. eg 'stripe', 'stripe_sepa'.
 	 */
 	public function update_subscription_payment_method_from_order( $order, $payment_method_type ) {
-		if ( ! $this->is_subscriptions_enabled() || ! function_exists( 'wcs_get_subscriptions_for_order' ) ) {
+		if ( ! WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() || ! function_exists( 'wcs_get_subscriptions_for_order' ) ) {
 			return;
 		}
 
@@ -1149,7 +1149,7 @@ public function update_subscription_payment_method_from_order( $order, $payment_
 	 */
 	public function disable_subscription_edit_for_india( $editable, $order ) {
 		$parent_order = wc_get_order( $order->get_parent_id() );
-		if ( $this->is_subscriptions_enabled()
+		if ( WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled()
 			&& $this->is_subscription( $order )
 			&& $parent_order
 			&& ! empty( $parent_order->get_meta( '_stripe_mandate_id', true ) ) ) {

includes/payment-methods/class-wc-stripe-upe-payment-gateway.php

@@ -478,7 +478,7 @@ public function javascript_params() {
 				$stripe_params['customerData'] = [ 'billing_country' => $order->get_billing_country() ];
 			}
 
-			if ( $this->is_subscriptions_enabled() && $is_change_payment_method ) {
+			if ( WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() && $is_change_payment_method ) {
 				$stripe_params['isChangingPayment']   = true;
 				$stripe_params['addPaymentReturnURL'] = wp_sanitize_redirect( esc_url_raw( home_url( add_query_arg( [] ) ) ) );
 

readme.txt

@@ -111,6 +111,7 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 == Changelog ==
 
 = 9.3.0 - xxxx-xx-xx =
+* Dev - Moves the method to check if the subscriptions extension is enabled to a new helper class.
 * Fix - Fixes a fatal error that might happen when a payment method ID cannot be retrieved during the processing of an order (new checkout experience).
 * Dev - Generates a code coverage report for PHP Unit tests as a comment on PRs.
 * Add - Adds Stripe specific information to the System Status Report data.

tests/phpunit/compat/test-class-wc-stripe-subscriptions-helper.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * Class WC_Stripe_Subscriptions_Helper_Test
+ *
+ * @package WooCommerce_Stripe/Tests/WC_Stripe_Subscriptions_Helper
+ */
+
+/**
+ * Class WC_Stripe_Subscriptions_Helper tests.
+ */
+class WC_Stripe_Subscriptions_Helper_Test extends WP_UnitTestCase {
+	/**
+	 * Test for `is_subscriptions_enabled`.
+	 *
+	 * @return void
+	 */
+	public function test_is_subscriptions_enabled() {
+		$this->assertTrue( WC_Stripe_Subscriptions_Helper::is_subscriptions_enabled() );
+	}
+
+	/**
+	 * Test for `get_detached_subscriptions`.
+	 *
+	 * @return void
+	 */
+	public function test_get_detached_subscriptions() {
+		$subscription_id = 1;
+		$customer_id     = 'cus_123';
+		$source_id       = 'src_123';
+
+		$subscription = new WC_Subscription();
+		$subscription->set_id( $subscription_id );
+		$subscription->set_status( 'active' );
+		$subscription->save();
+
+		$subscription->update_meta_data( '_stripe_customer_id', $customer_id );
+		$subscription->update_meta_data( '_stripe_source_id', $source_id );
+		$subscription->save_meta_data();
+
+		WC_Subscriptions_Helpers::$wcs_get_subscriptions = [ $subscription ];
+
+		// Mock response from Stripe API.
+		$test_request = function () {
+			return [
+				'response' => 200,
+				'headers'  => [ 'Content-Type' => 'application/json' ],
+				'body'     => wp_json_encode(
+					[
+						'customer' => null,
+					]
+				),
+			];
+		};
+
+		add_filter( 'pre_http_request', $test_request, 10, 3 );
+
+		$expected = [
+			[
+				'id'                        => $subscription_id,
+				'customer_id'               => $customer_id,
+				'change_payment_method_url' => $subscription->get_change_payment_method_url(),
+			],
+		];
+		$this->assertEquals( $expected, WC_Stripe_Subscriptions_Helper::get_detached_subscriptions() );
+
+		remove_filter( 'pre_http_request', $test_request, 10, 3 );
+
+		// Test cached version
+		$this->assertEquals( $expected, WC_Stripe_Subscriptions_Helper::get_detached_subscriptions() );
+	}
+}

tests/phpunit/helpers/class-wc-helper-subscription.php

@@ -48,4 +48,14 @@ function( $order_types ) {
 	public function get_type() {
 		return $this->order_type;
 	}
+
+	/**
+	 * Generates a URL to add or change the subscription's payment method from the my account page.
+	 *
+	 * @return string
+	 */
+	public function get_change_payment_method_url() {
+		$change_payment_method_url = wc_get_endpoint_url( 'subscription-payment-method', $this->get_id(), wc_get_page_permalink( 'myaccount' ) );
+		return apply_filters( 'wcs_get_change_payment_method_url', $change_payment_method_url, $this->get_id() );
+	}
 }

tests/phpunit/helpers/class-wc-subscriptions-helper.php

@@ -20,9 +20,10 @@ function wcs_get_subscriptions_for_order( $order ) {
 /**
  * A function to mock wcs_get_subscriptions.
  *
+ * @param array $args A set of name value pairs to determine the return value.
  * @return array
  */
-function wcs_get_subscriptions() {
+function wcs_get_subscriptions( $args ) {
 	if ( ! WC_Subscriptions_Helpers::$wcs_get_subscriptions ) {
 		return [];
 	}

tests/phpunit/payment-methods/test-class-wc-stripe-upe-payment-gateway.php

@@ -2648,10 +2648,6 @@ public function test_set_payment_method_title_for_order() {
 
 		WC_Subscriptions_Helpers::$wcs_get_subscriptions_for_order = [ $mock_subscription_0, $mock_subscription_1 ];
 
-		$this->mock_gateway->expects( $this->exactly( 4 ) ) // 4 times because we test 4 payment methods.
-			->method( 'is_subscriptions_enabled' )
-			->willReturn( true );
-
 		/**
 		 * SEPA
 		 */

woocommerce-gateway-stripe.php

@@ -199,6 +199,7 @@ public function init() {
 				require_once __DIR__ . '/includes/class-wc-stripe-helper.php';
 				include_once __DIR__ . '/includes/class-wc-stripe-api.php';
 				include_once __DIR__ . '/includes/class-wc-stripe-mode.php';
+				require_once __DIR__ . '/includes/compat/class-wc-stripe-subscriptions-helper.php';
 				require_once __DIR__ . '/includes/compat/trait-wc-stripe-subscriptions-utilities.php';
 				require_once __DIR__ . '/includes/compat/trait-wc-stripe-subscriptions.php';
 				require_once __DIR__ . '/includes/compat/trait-wc-stripe-pre-orders.php';