Add an admin notice for SEPA subscriptions migrations after disabling legacy checkout (#3422)

* Display an admin notice to inform users of the SEPA migration after disabling legacy checkout

* Get any status

* The next action should never be more than 3 hours so remove the else case

* Add changelog entries

* Display the notice for up to 3 days to limit the scope of the notice queries

* Stop showing the notice after all subscriptions have been migrated

* If admin re-enable legacy checkout and then later disable legacy checkout, we should make sure to reattempt the migrations

* Update includes/migrations/class-wc-stripe-subscriptions-repairer-legacy-sepa-tokens.php

Co-authored-by: Matt Allan <[email protected]>

* Schedule jobs to run in 1 minute rather than 1 hour

* Update notice to no longer include next update time case

* Treat in-progress actions as $is_still_scheduling_jobs

* Remove duplicated Paged param

* Schedule individual SEPA updates to run in 2 minutes

* Add a tool to enable users to restart the migration if needed

* Replace "migrate" with "update"

* Move variable around for slight performance improvement

* Add changelog entry for new tool

* Update includes/migrations/class-wc-stripe-subscriptions-repairer-legacy-sepa-tokens.php

Co-authored-by: Matt Allan <[email protected]>

---------

Co-authored-by: Matt Allan <[email protected]>

Author: 2 people

changelog.txt

@@ -29,6 +29,8 @@
 * Fix - Address Klarna availability based on correct presentment currency rules.
 * Fix - Use correct ISO country code of United Kingdom in supported country and currency list of AliPay and WeChat.
 * Fix - Prevent duplicate order notes and emails being sent when purchasing subscription products with no initial payment.
+* Add - Display an admin notice on the WooCommerce > Subscriptions screen for tracking the progress of SEPA subscriptions migrations after the legacy checkout is disabled.
+* Add - Introduce a new tool on the WooCommerce > Status > Tools screen to restart the legacy SEPA subscriptions update.
 
 = 8.6.1 - 2024-08-09 =
 * Tweak - Improves the wording of the invalid Stripe keys errors, instructing merchants to click the "Configure connection" button instead of manually setting the keys.

includes/admin/class-wc-rest-stripe-settings-controller.php

@@ -455,6 +455,12 @@ private function update_is_upe_enabled( WP_REST_Request $request ) {
 		}
 
 		$settings = WC_Stripe_Helper::get_stripe_settings();
+
+		// If the new UPE is enabled, we need to remove the flag to ensure legacy SEPA tokens are updated flag.
+		if ( $is_upe_enabled && ! WC_Stripe_Feature_Flags::is_upe_checkout_enabled() ) {
+			delete_option( 'woocommerce_stripe_subscriptions_legacy_sepa_tokens_updated' );
+		}
+
 		$settings[ WC_Stripe_Feature_Flags::UPE_CHECKOUT_FEATURE_ATTRIBUTE_NAME ] = $is_upe_enabled ? 'yes' : 'disabled';
 		WC_Stripe_Helper::update_main_stripe_settings( $settings );
 

includes/migrations/class-wc-stripe-subscriptions-repairer-legacy-sepa-tokens.php

@@ -12,6 +12,20 @@
  */
 class WC_Stripe_Subscriptions_Repairer_Legacy_SEPA_Tokens extends WCS_Background_Repairer {
 
+	/**
+	 * The transient key used to store the progress of the repair.
+	 *
+	 * @var string
+	 */
+	private $action_progress_transient = 'wc_stripe_legacy_sepa_tokens_repair_progress';
+
+	/**
+	 * The transient key used to store whether we should display the notice to the user.
+	 *
+	 * @var string
+	 */
+	private $display_notice_transient = 'wc_stripe_legacy_sepa_tokens_repair_notice';
+
 	/**
 	 * Constructor
 	 *
@@ -26,6 +40,10 @@ public function __construct( WC_Logger_Interface $logger ) {
 
 		// Repair subscriptions prior to renewal as a backstop. Hooked onto 0 to run before the actual renewal.
 		add_action( 'woocommerce_scheduled_subscription_payment', [ $this, 'maybe_migrate_before_renewal' ], 0 );
+
+		add_action( 'admin_notices', [ $this, 'display_admin_notice' ] );
+
+		add_filter( 'woocommerce_debug_tools', [ $this, 'add_debug_tool' ] );
 	}
 
 	/**
@@ -48,6 +66,9 @@ public function maybe_update() {
 		// This will be handled in the scheduled action.
 		$this->schedule_repair();
 
+		// Display the admin notice to inform the user that the repair is in progress. Limited to 3 days.
+		set_transient( $this->display_notice_transient, 'yes', 3 * DAY_IN_SECONDS );
+
 		// Prevent the repair from being scheduled again.
 		update_option( 'woocommerce_stripe_subscriptions_legacy_sepa_tokens_updated', 'yes' );
 	}
@@ -67,11 +88,32 @@ public function repair_item( $subscription_id ) {
 			$token_updater->maybe_update_subscription_legacy_payment_method( $subscription_id );
 
 			$this->log( sprintf( 'Successful migration of subscription #%1$d.', $subscription_id ) );
+
+			delete_transient( $this->action_progress_transient );
 		} catch ( \Exception $e ) {
 			$this->log( $e->getMessage() );
 		}
 	}
 
+	/**
+	 * Schedules an individual action to migrate a subscription.
+	 *
+	 * Overrides the parent class function to make two changes:
+	 * 1. Don't schedule an action if one already exists.
+	 * 2. Schedules the migration to happen in two minutes instead of in one hour.
+	 * 3. Delete the transient which stores the progress of the repair.
+	 *
+	 * @param int $item The ID of the subscription to migrate.
+	 */
+	protected function update_item( $item ) {
+		if ( ! as_next_scheduled_action( $this->repair_hook, [ 'repair_object' => $item ] ) ) {
+			as_schedule_single_action( gmdate( 'U' ) + ( 2 * MINUTE_IN_SECONDS ), $this->repair_hook, [ 'repair_object' => $item ] );
+		}
+
+		unset( $this->items_to_repair[ $item ] );
+		delete_transient( $this->action_progress_transient );
+	}
+
 	/**
 	 * Gets the batch of subscriptions using the Legacy SEPA payment method to be updated.
 	 *
@@ -85,7 +127,6 @@ protected function get_items_to_repair( $page ) {
 				'return'         => 'ids',
 				'type'           => 'shop_subscription',
 				'posts_per_page' => 20,
-				'paged'          => $page,
 				'status'         => 'any',
 				'paged'          => $page,
 				'payment_method' => WC_Gateway_Stripe_Sepa::ID,
@@ -140,4 +181,186 @@ public function maybe_migrate_before_renewal( $subscription_id ) {
 			$token_updater->maybe_update_subscription_source( $subscription );
 		}
 	}
+
+	/**
+	 * Displays an admin notice to inform the user that the repair is in progress.
+	 *
+	 * This notice is displayed on the Subscriptions list table page and includes information about the progress of the repair.
+	 * What % of the repair is complete, or when the next scheduled action is expected to run.
+	 */
+	public function display_admin_notice() {
+
+		if ( ! class_exists( 'WC_Subscriptions' ) || ! WC_Stripe_Feature_Flags::is_upe_checkout_enabled() ) {
+			return;
+		}
+
+		// Only display this on the subscriptions list table page.
+		if ( ! $this->is_admin_subscriptions_list_table_screen() ) {
+			return;
+		}
+
+		// The notice is only displayed for up to 3 days after disabling the setting.
+		$display_notice = get_transient( $this->display_notice_transient ) === 'yes';
+
+		if ( ! $display_notice ) {
+			return;
+		}
+
+		// If there are no subscriptions to be migrated, remove the transient so we don't show the notice.
+		// Don't return early so we can show the notice at least once.
+		if ( ! $this->has_legacy_sepa_subscriptions() ) {
+			delete_transient( $this->display_notice_transient );
+		}
+
+		$action_progress = $this->get_scheduled_action_counts();
+
+		if ( ! $action_progress ) {
+			return;
+		}
+
+		// If we're still in the process of scheduling jobs, show a note to the user.
+		if ( (bool) as_next_scheduled_action( $this->scheduled_hook ) ) {
+			// translators: %1$s: <strong> tag, %2$s: </strong> tag, %3$s: <i> tag. %4$s: </i> tag.
+			$progress = sprintf( __( '%1$sProgress: %2$s %3$sWe are still identifying all subscriptions that require updating.%4$s', 'woocommerce-gateway-stripe' ), '<strong>', '</strong>', '<i>', '</i>' );
+		} else {
+			// All scheduled actions have run, so we're done.
+			if ( 0 === absint( $action_progress['pending'] ) ) {
+				// Remove the transient to prevent the notice from showing again.
+				delete_transient( $this->display_notice_transient );
+			}
+
+			// Calculate the percentage of completed actions.
+			$total_action_count = $action_progress['pending'] + $action_progress['complete'];
+			$compete_percentage = $total_action_count ? floor( ( $action_progress['complete'] / $total_action_count ) * 100 ) : 0;
+
+			// translators: %1$s: <strong> tag, %2$s: </strong> tag, %3$s: percentage complete.
+			$progress = sprintf( __( '%1$sProgress: %2$s %3$s%% complete', 'woocommerce-gateway-stripe' ), '<strong>', '</strong>', $compete_percentage );
+		}
+
+		// Note: We're using a Subscriptions class to generate the admin notice, however, it's safe to use given the context of this class.
+		$notice = new WCS_Admin_Notice( 'notice notice-warning is-dismissible' );
+		$notice->set_html_content(
+			'<h4>' . esc_html__( 'SEPA subscription update in progress', 'woocommerce-gateway-stripe' ) . '</h4>' .
+			'<p>' . __( "We are currently updating customer subscriptions that use the legacy Stripe SEPA Direct Debit payment method. During this update, you may notice that some subscriptions appear as manual renewals. Don't worry—renewals will continue to process as normal. Please be aware this process may take some time.", 'woocommerce-gateway-stripe' ) . '</p>' .
+			'<p>' . $progress . '</p>'
+		);
+
+		$notice->display();
+	}
+
+	/**
+	 * Checks if the current screen is the subscriptions list table.
+	 *
+	 * @return bool True if the current screen is the subscriptions list table, false otherwise.
+	 */
+	private function is_admin_subscriptions_list_table_screen() {
+		if ( ! is_admin() || ! function_exists( 'get_current_screen' ) ) {
+			return false;
+		}
+
+		$screen = get_current_screen();
+
+		if ( ! is_object( $screen ) ) {
+			return false;
+		}
+
+		// Check if we are on the subscriptions list table page in a HPOS or WP_Post context.
+		return in_array( $screen->id, [ 'woocommerce_page_wc-orders--shop_subscription', 'edit-shop_subscription' ], true );
+	}
+
+	/**
+	 * Fetches the number of pending and completed migration scheduled actions.
+	 *
+	 * @return array|bool The counts of pending and completed actions. False if the Action Scheduler store is not available.
+	 */
+	private function get_scheduled_action_counts() {
+		$action_counts = get_transient( $this->action_progress_transient );
+
+		// If the transient is not set, calculate the action counts.
+		if ( false === $action_counts ) {
+			$store = ActionScheduler::store();
+
+			if ( ! $store ) {
+				return false;
+			}
+
+			$action_counts = [
+				'pending' => (int) $store->query_actions(
+					[
+						'hook'   => $this->repair_hook,
+						'status' => ActionScheduler_Store::STATUS_PENDING,
+					],
+					'count'
+				),
+				'complete' => (int) $store->query_actions(
+					[
+						'hook'   => $this->repair_hook,
+						'status' => ActionScheduler_Store::STATUS_COMPLETE,
+					],
+					'count'
+				),
+			];
+
+			set_transient( $this->action_progress_transient, $action_counts, 10 * MINUTE_IN_SECONDS );
+		}
+
+		return $action_counts;
+	}
+
+	/**
+	 * Registers the repair tool for the Legacy SEPA token migration.
+	 *
+	 * @param array $tools The existing repair tools.
+	 *
+	 * @return array The updated repair tools.
+	 */
+	public function add_debug_tool( $tools ) {
+		// We don't need to show the tool if the WooCommerce Subscriptions extension isn't active or the UPE checkout isn't enabled
+		if ( ! class_exists( 'WC_Subscriptions' ) || ! WC_Stripe_Feature_Flags::is_upe_checkout_enabled() ) {
+			return $tools;
+		}
+
+		// Don't show the tool if the repair is already in progress or there are no subscriptions to migrate.
+		if ( (bool) as_next_scheduled_action( $this->scheduled_hook ) || (bool) as_next_scheduled_action( $this->repair_hook ) || ! $this->has_legacy_sepa_subscriptions() ) {
+			return $tools;
+		}
+
+		$tools['stripe_legacy_sepa_tokens'] = [
+			'name'     => __( 'Stripe Legacy SEPA Token Update', 'woocommerce-gateway-stripe' ),
+			'desc'     => __( 'This will restart the legacy Stripe SEPA update process.', 'woocommerce-gateway-stripe' ),
+			'button'   => __( 'Restart SEPA token update', 'woocommerce-gateway-stripe' ),
+			'callback' => [ $this, 'restart_update' ],
+		];
+
+		return $tools;
+	}
+
+	/**
+	 * Checks if there are subscriptions using the Legacy SEPA payment method.
+	 *
+	 * @return bool True if there are subscriptions using the Legacy SEPA payment method, false otherwise.
+	 */
+	private function has_legacy_sepa_subscriptions() {
+		$subscriptions = wc_get_orders(
+			[
+				'return'         => 'ids',
+				'type'           => 'shop_subscription',
+				'status'         => 'any',
+				'posts_per_page' => 1,
+				'payment_method' => WC_Gateway_Stripe_Sepa::ID,
+			]
+		);
+
+		return ! empty( $subscriptions );
+	}
+
+	/**
+	 * Restarts the legacy token update process.
+	 */
+	public function restart_update() {
+		// Clear the option to allow the update to be scheduled again.
+		delete_option( 'woocommerce_stripe_subscriptions_legacy_sepa_tokens_updated' );
+
+		$this->maybe_update();
+	}
 }

readme.txt

@@ -157,5 +157,7 @@ If you get stuck, you can ask for help in the Plugin Forum.
 * Fix - Address Klarna availability based on correct presentment currency rules.
 * Fix - Use correct ISO country code of United Kingdom in supported country and currency list of AliPay and WeChat.
 * Fix - Prevent duplicate order notes and emails being sent when purchasing subscription products with no initial payment.
+* Add - Display an admin notice on the WooCommerce > Subscriptions screen for tracking the progress of SEPA subscriptions migrations after the legacy checkout is disabled.
+* Add - Introduce a new tool on the WooCommerce > Status > Tools screen to restart the legacy SEPA subscriptions update.
 
 [See changelog for all versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).