Introducing new filters to control the subscription detached tool parameters (#4475)

* Introducing new filters to control the subscription detached tool parameters

* Changelog and readme entries

* Update includes/class-wc-stripe-status.php

Co-authored-by: Malith Senaweera <[email protected]>

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

Co-authored-by: Malith Senaweera <[email protected]>

* Changing log severity

---------

Co-authored-by: Malith Senaweera <[email protected]>

Author: wjrosa

changelog.txt

@@ -1,6 +1,7 @@
 *** Changelog ***
 
 = 9.7.0 - xxxx-xx-xx =
+* Add - Adds two new safety filters to the subscriptions detached debug tool: `wc_stripe_detached_subscriptions_maximum_time` and `wc_stripe_detached_subscriptions_maximum_count`
 * Add - Show a notice when editing an active subscription that has no payment method attached
 * Fix - Fixes a possible fatal error when trying to generate the order signature for a `WC_Order_Refund` object
 * Add - New WooCommerce Debug Tool to list subscriptions without a payment method attached

includes/class-wc-stripe-status.php

@@ -9,6 +9,13 @@
  * Integrates with Woo Status pages to offer additional tools and insights for the Stripe extension.
  */
 class WC_Stripe_Status {
+	/**
+	 * Maximum number of subscriptions to process in the detached subscriptions tool.
+	 *
+	 * @var int
+	 */
+	private const SUBSCRIPTIONS_DETACHED_LIST_LIMIT = 1000;
+
 	/**
 	 * Instance of WC_Gateway_Stripe
 	 *
@@ -240,7 +247,14 @@ public function debug_tools( $tools ) {
 	 * @return void
 	 */
 	public function list_detached_subscriptions() {
-		$subscriptions     = WC_Stripe_Subscriptions_Helper::get_detached_subscriptions( 1000 ); // Limiting to 1000 subscriptions for safety.
+		/**
+		 * Maximum number of subscriptions to process.
+		 *
+		 * @since 9.7.0
+		 * @param int $max_count The maximum number of subscriptions to process.
+		 */
+		$max_count         = apply_filters( 'wc_stripe_detached_subscriptions_maximum_count', self::SUBSCRIPTIONS_DETACHED_LIST_LIMIT ); // Limit the number of subscriptions to process for safety.
+		$subscriptions     = WC_Stripe_Subscriptions_Helper::get_detached_subscriptions( $max_count );
 		$detached_messages = WC_Stripe_Subscriptions_Helper::build_subscriptions_detached_messages( $subscriptions );
 		echo '<div class="wrap woocommerce">';
 			echo '<h1>' . esc_html__( 'List Detached Stripe Subscriptions', 'woocommerce-gateway-stripe' ) . '</h1>';

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

@@ -23,9 +23,18 @@ class WC_Stripe_Subscriptions_Helper {
 
 	/**
 	 * Maximum number of subscriptions to load per page.
+	 *
+	 * @var int
 	 */
 	private const MAX_SUBSCRIPTIONS_PER_PAGE = 50;
 
+	/**
+	 * Fallback maximum execution time in seconds.
+	 *
+	 * @var int
+	 */
+	private const MAX_EXECUTION_TIME_FALLBACK = 30;
+
 	/**
 	 * Checks if subscriptions are enabled on the site.
 	 *
@@ -60,11 +69,36 @@ public static function get_detached_subscriptions( $limit = -1 ) {
 			return $cached_subscriptions;
 		}
 
-		$subscriptions = [];
-		$page          = 1;
-		$per_page      = self::MAX_SUBSCRIPTIONS_PER_PAGE;
+		$subscriptions     = [];
+		$num_subscriptions = 0;
+		$page              = 1;
+		$per_page          = self::MAX_SUBSCRIPTIONS_PER_PAGE;
+		$start_time        = time();
+
+		// Defaults maximum execution time to server's `max_execution_time` (when available, or 30 if not) minus 5 seconds.
+		$default_max_time = ( ini_get( 'max_execution_time' ) ? ini_get( 'max_execution_time' ) : self::MAX_EXECUTION_TIME_FALLBACK ) - 5;
+
+		/**
+		 * Filter the maximum time allowed for fetching detached subscriptions.
+		 *
+		 * @since 9.7.0
+		 * @param int $max_time The maximum time allowed in seconds. Default is server's `max_execution_time` (when available, or 30 if not) minus 5 seconds.
+		 */
+		$max_time = apply_filters( 'wc_stripe_detached_subscriptions_maximum_time', $default_max_time );
 
 		do {
+			if ( ( time() - $start_time ) > $max_time ) {
+				// If we have been running for more than the default limit, stop to avoid long execution times.
+				WC_Stripe_Logger::log(
+					sprintf(
+						/* translators: %d is the maximum time allowed for fetching detached subscriptions */
+						__( 'Stopped fetching detached subscriptions before the %d seconds limit for safety.', 'woocommerce-gateway-stripe' ),
+						$max_time
+					)
+				);
+				break;
+			}
+
 			$batch             = wcs_get_subscriptions(
 				[
 					'subscriptions_per_page' => $per_page,

readme.txt

@@ -111,6 +111,7 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 == Changelog ==
 
 = 9.7.0 - xxxx-xx-xx =
+* Add - Adds two new safety filters to the subscriptions detached debug tool: `wc_stripe_detached_subscriptions_maximum_time` and `wc_stripe_detached_subscriptions_maximum_count`
 * Add - Show a notice when editing an active subscription that has no payment method attached
 * Fix - Fixes a possible fatal error when trying to generate the order signature for a `WC_Order_Refund` object
 * Add - New WooCommerce Debug Tool to list subscriptions without a payment method attached