Added notification emails and basic scheduling logic

assets/js/admin/admin.js

@@ -932,6 +932,9 @@ jQuery( function ( $ ) {
 		),
 		$syncRenewals = $(
 			document.getElementById( 'woocommerce_subscriptions_sync_payments' )
+		),
+		$customerNotifications = $(
+			document.getElementById( 'woocommerce_subscriptions_customer_notifications_enabled' )
 		);
 
 	// We're on the Subscriptions settings page
@@ -954,6 +957,9 @@ jQuery( function ( $ ) {
 			).parents( 'tr' ),
 			$suspensionExtensionRow = $(
 				'#woocommerce_subscriptions_recoup_suspension'
+			).parents( 'tr' ),
+			$customerNotificationOffsetRow = $(
+				'#woocommerce_subscriptions_customer_notifications_offset'
 			).parents( 'tr' );
 
 		// No animation for initial hiding when switching is disabled.
@@ -1009,6 +1015,19 @@ jQuery( function ( $ ) {
 				$daysNoFeeRow.fadeOut();
 			}
 		} );
+
+		// No animation when initially hiding customer notification offset row.
+		if ( ! $customerNotifications.is( ':checked' ) ) {
+			$customerNotificationOffsetRow.hide();
+		}
+		// Watch the enable/disable customer notifications checkbox for changes.
+		$customerNotifications.on( 'change', function () {
+			if ( $( this ).is( ':checked' ) ) {
+				$customerNotificationOffsetRow.fadeIn();
+			} else {
+				$customerNotificationOffsetRow.fadeOut();
+			}
+		} );
 	}
 
 	// Don't display the variation notice for variable subscription products

bin/phpcs-2.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+ROOTDIR="$(dirname "$(dirname "$0")")"
+echo $ROOTDIR
+
+# Run PHP CodeSniffer and capture the output
+PHPCS_OUTPUT=$($ROOTDIR/vendor/bin/phpcs --report=json "$@")
+
+# Check if the output is valid JSON
+if echo "$PHPCS_OUTPUT" | jq empty >/dev/null 2>&1; then
+  # If valid JSON, pass it to sarb
+  echo "$PHPCS_OUTPUT" | $ROOTDIR/vendor/bin/sarb remove phpcs.baseline
+else
+  # If not valid JSON, print an error message and the invalid output
+  echo "Failed to parse analysis results. Not valid JSON."
+  echo "$PHPCS_OUTPUT"
+  exit 1
+fi

includes/admin/debug-tools/class-wcs-notifications-debug-tool-processor.php

@@ -0,0 +1,311 @@
+<?php
+
+use Automattic\WooCommerce\Internal\BatchProcessing\BatchProcessingController;
+use Automattic\WooCommerce\Internal\BatchProcessing\BatchProcessorInterface;
+
+class WCS_Notifications_Debug_Tool_Processor implements BatchProcessorInterface {
+
+	/**
+	 * Option name for the tool state.
+	 * This is used to pass the state of the tool between requests.
+	 */
+	const TOOL_STATE_OPTION_NAME = 'wcs_notifications_debug_tool_state';
+
+	/**
+	 * Constructor.
+	 */
+	public function __construct() {
+		add_filter( 'woocommerce_debug_tools', array( $this, 'handle_woocommerce_debug_tools' ), 999, 1 );
+	}
+
+	/**
+	 * Get the state of the tool.
+	 *
+	 * @return array {
+	 *   @last_offset Last offset processed.
+	 * }
+	 */
+	private function get_tool_state(): array {
+		return (array) get_option( self::TOOL_STATE_OPTION_NAME, array() );
+	}
+
+	/**
+	 * Update the state of the tool.
+	 *
+	 * @param array $state New state of the tool.
+	 */
+	private function update_tool_state( $state ) {
+		update_option( self::TOOL_STATE_OPTION_NAME, $state );
+	}
+
+	/**
+	 * Delete the state of the tool.
+	 */
+	private function delete_tool_state() {
+		delete_option( self::TOOL_STATE_OPTION_NAME );
+	}
+
+	/**
+	 * Get a user-friendly name for this processor.
+	 *
+	 * @return string Name of the processor.
+	 */
+	public function get_name(): string {
+		return 'wcs_notifications_debug_tool_processor';
+	}
+
+	/**
+	 * Get a user-friendly description for this processor.
+	 *
+	 * @return string Description of what this processor does.
+	 */
+	public function get_description(): string {
+		return 'WooCommerce Notifications Debug Tool Processor';
+	}
+
+	/**
+	 * Get the allowed subscription statuses to process.
+	 */
+	protected function get_subscription_statuses(): array {
+		$allowed_statuses = array(
+			'active',
+			'pending',
+			'on-hold',
+		);
+
+		return array_map( 'wcs_sanitize_subscription_status_key', $allowed_statuses );
+	}
+
+	public function get_total_pending_count(): int {
+		global $wpdb;
+
+		$allowed_statuses = $this->get_subscription_statuses();
+		$placeholders     = implode( ', ', array_fill( 0, count( $allowed_statuses ), '%s' ) );
+
+		if ( wcs_is_custom_order_tables_usage_enabled() ) {
+			$total_subscriptions = $wpdb->get_var(
+			// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+			// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber
+			// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare
+				$wpdb->prepare(
+					"SELECT 
+								COUNT(id)
+							FROM {$wpdb->prefix}wc_orders 
+							WHERE type='shop_subscription'
+							AND status IN ($placeholders)
+							",
+					...$allowed_statuses
+				)
+			);
+		} else {
+			$total_subscriptions = $wpdb->get_var(
+			// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+			// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber
+			// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare
+				$wpdb->prepare(
+					"SELECT 
+								COUNT(ID)
+							FROM {$wpdb->prefix}posts 
+							WHERE post_type='shop_subscription'
+							AND post_status IN ($placeholders)
+							",
+					...$allowed_statuses
+				)
+			);
+		}
+
+		$state = $this->get_tool_state();
+		if ( isset( $state['last_offset'] ) ) {
+			$total_subscriptions -= (int) $state['last_offset'];
+		}
+
+		return $total_subscriptions;
+	}
+
+	/**
+	 * Returns the next batch of items that need to be processed.
+	 *
+	 * A batch item can be anything needed to identify the actual processing to be done,
+	 * but whenever possible items should be numbers (e.g. database record ids)
+	 * or at least strings, to ease troubleshooting and logging in case of problems.
+	 *
+	 * The size of the batch returned can be less than $size if there aren't that
+	 * many items pending processing (and it can be zero if there isn't anything to process),
+	 * but the size should always be consistent with what 'get_total_pending_count' returns
+	 * (i.e. the size of the returned batch shouldn't be larger than the pending items count).
+	 *
+	 * @param int $size Maximum size of the batch to be returned.
+	 *
+	 * @return array Batch of items to process, containing $size or less items.
+	 */
+	public function get_next_batch_to_process( int $size ): array {
+		global $wpdb;
+
+		$allowed_statuses = $this->get_subscription_statuses();
+		$placeholders     = implode( ', ', array_fill( 0, count( $allowed_statuses ), '%s' ) );
+		$state            = $this->get_tool_state();
+		$offset           = isset( $state['last_offset'] ) ? (int) $state['last_offset'] : 0;
+
+		$args = array_merge(
+			$allowed_statuses,
+			array( $size ),
+			array( $offset ),
+		);
+
+		if ( wcs_is_custom_order_tables_usage_enabled() ) {
+			$subscriptions_to_process = $wpdb->get_col(
+			// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+			// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber
+				$wpdb->prepare(
+					"SELECT 
+								id
+							FROM {$wpdb->prefix}wc_orders 
+							WHERE type='shop_subscription'
+							AND status IN ($placeholders)
+							ORDER BY id ASC
+							LIMIT %d
+							OFFSET %d",
+					...$args
+				)
+			);
+		} else {
+			$subscriptions_to_process = $wpdb->get_col(
+			// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+			// phpcs:disable WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber
+				$wpdb->prepare(
+					"SELECT 
+								ID
+							FROM {$wpdb->prefix}posts 
+							WHERE post_type='shop_subscription'
+							AND post_status IN ($placeholders)
+							ORDER BY ID ASC
+							LIMIT %d
+							OFFSET %d",
+					...$args
+				)
+			);
+		}
+
+		// Reset the tool state if there are no more subscriptions to process.
+		if ( empty( $subscriptions_to_process ) ) {
+			$this->delete_tool_state();
+		}
+
+		return $subscriptions_to_process;
+	}
+
+	/**
+	 * Process data for the supplied batch.
+	 *
+	 * This method should be prepared to receive items that don't actually need processing
+	 * (because they have been processed before) and ignore them, but if at least
+	 * one of the batch items that actually need processing can't be processed, an exception should be thrown.
+	 *
+	 * Once an item has been processed it shouldn't be counted in 'get_total_pending_count'
+	 * nor included in 'get_next_batch_to_process' anymore (unless something happens that causes it
+	 * to actually require further processing).
+	 *
+	 * @throw \Exception Something went wrong while processing the batch.
+	 *
+	 * @param array $batch Batch to process, as returned by 'get_next_batch_to_process'.
+	 */
+	public function process_batch( array $batch ): void {
+		// This is a bit unnecessary. Perhaps convert `update_status` to static to avoid instantiating the class?
+		$subscriptions_notifications = new WCS_Action_Scheduler_Customer_Notifications();
+
+		foreach ( $batch as $subscription_id ) {
+			$subscription = wcs_get_subscription( $subscription_id );
+			$subscriptions_notifications->update_status( $subscription, $subscription->get_status(), null );
+
+			// Update the subscription's update time to mark it as updated.
+			$subscription->set_date_modified( time() );
+			$subscription->save();
+		}
+
+		// Update tool state.
+		$state                = $this->get_tool_state();
+		$state['last_offset'] = isset( $state['last_offset'] ) ? absint( $state['last_offset'] ) + count( $batch ) : count( $batch );
+		$this->update_tool_state( $state );
+	}
+
+	/**
+	 * Default (preferred) batch size to pass to 'get_next_batch_to_process'.
+	 * The controller will pass this size unless it's externally configured
+	 * to use a different size.
+	 *
+	 * @return int Default batch size.
+	 */
+	public function get_default_batch_size(): int {
+		return 20;
+	}
+
+	/**
+	 * Start the background process for coupon data conversion.
+	 *
+	 * @return string Informative string to show after the tool is triggered in UI.
+	 */
+	public function enqueue(): string {
+		$batch_processor = wc_get_container()->get( BatchProcessingController::class );
+		if ( $batch_processor->is_enqueued( self::class ) ) {
+			return __( 'Background process for updating subscription notifications already started, nothing done.', 'woocommerce-subscriptions' );
+		}
+
+		$batch_processor->enqueue_processor( self::class );
+		return __( 'Background process for updating subscription notifications started', 'woocommerce-subscriptions' );
+	}
+
+	/**
+	 * Stop the background process for coupon data conversion.
+	 *
+	 * @return string Informative string to show after the tool is triggered in UI.
+	 */
+	public function dequeue(): string {
+		$batch_processor = wc_get_container()->get( BatchProcessingController::class );
+		if ( ! $batch_processor->is_enqueued( self::class ) ) {
+			return __( 'Background process for updating subscription notifications not started, nothing done.', 'woocommerce-subscriptions' );
+		}
+
+		$batch_processor->remove_processor( self::class );
+		return __( 'Background process for updating subscription notifications stopped', 'woocommerce-subscriptions' );
+	}
+
+	/**
+	 * Add the tool to start or stop the background process that manages notification batch processing.
+	 *
+	 * @param array $tools Old tools array.
+	 * @return array Updated tools array.
+	 */
+	public function handle_woocommerce_debug_tools( array $tools ): array {
+		$batch_processor = wc_get_container()->get( BatchProcessingController::class );
+		$pending_count   = $this->get_total_pending_count();
+
+		if ( 0 === $pending_count ) {
+			$tools['start_add_subscription_notifications'] = array(
+				'name'     => __( 'Start adding subscription notifications', 'woocommerce-subscriptions' ),
+				'button'   => __( 'Add notifications', 'woocommerce-subscriptions' ),
+				'disabled' => true,
+				'desc'     => __( 'This tool will add notifications to pending, active and on-hold subscriptions. This will happen overtime in the background (via Action Scheduler). There are currently no entries to convert.', 'woocommerce-subscriptions' ),
+			);
+		} elseif ( $batch_processor->is_enqueued( self::class ) ) {
+			$tools['stop_add_subscription_notifications'] = array(
+				'name'     => __( 'Stop adding subscription notifications', 'woocommerce-subscriptions' ),
+				'button'   => __( 'Stop adding notifications', 'woocommerce-subscriptions' ),
+				'desc'     =>
+				/* translators: %d=count of entries pending conversion */
+					sprintf( __( 'This will stop the background process that adds notifications to pending, active and on-hold subscriptions. There are currently %d entries that can be converted.', 'woocommerce-subscriptions' ), $pending_count ),
+				'callback' => array( $this, 'dequeue' ),
+			);
+		} else {
+			$tools['start_add_subscription_notifications'] = array(
+				'name'     => __( 'Start adding subscription notifications', 'woocommerce-subscriptions' ),
+				'button'   => __( 'Add notifications', 'woocommerce-subscriptions' ),
+				'desc'     =>
+				/* translators: %d=count of entries pending conversion */
+					sprintf( __( 'This tool will add notifications to pending, active and on-hold subscriptions. This will happen overtime in the background (via Action Scheduler). There are currently %d entries that can be converted.', 'woocommerce-subscriptions' ), $pending_count ),
+				'callback' => array( $this, 'enqueue' ),
+			);
+		}
+
+		return $tools;
+	}
+}