Bug/12102 timezone fix

includes/Core/Email_Reporting/Email_Log.php

@@ -11,6 +11,7 @@
 namespace Google\Site_Kit\Core\Email_Reporting;
 
 use Google\Site_Kit\Core\User\Email_Reporting_Settings as Reporting_Settings;
+use Google\Site_Kit\Core\Util\BC_Functions;
 use Google\Site_Kit\Core\Util\Method_Proxy_Trait;
 
 /**
@@ -224,8 +225,8 @@ protected static function format_reference_date( $value ) {
 			return null;
 		}
 
-		if ( function_exists( 'wp_timezone' ) && function_exists( 'wp_date' ) ) {
-			$timezone = wp_timezone();
+		if ( function_exists( 'wp_date' ) ) {
+			$timezone = BC_Functions::wp_timezone();
 			if ( $timezone ) {
 				return wp_date( 'Y-m-d', $timestamp, $timezone );
 			}

includes/Core/Email_Reporting/Email_Report_Payload_Processor.php

@@ -10,6 +10,8 @@
 
 namespace Google\Site_Kit\Core\Email_Reporting;
 
+use Google\Site_Kit\Core\Util\BC_Functions;
+
 /**
  * Helper class to normalize and process report payloads for email sections.
  *
@@ -94,7 +96,7 @@ public function compute_date_range( $date_range ) {
 		}
 
 		// Ensure dates are localized strings (Y-m-d) using site timezone.
-		$timezone = function_exists( 'wp_timezone' ) ? wp_timezone() : null;
+		$timezone = BC_Functions::wp_timezone();
 		if ( function_exists( 'wp_date' ) && $timezone ) {
 			$start_timestamp = strtotime( $start );
 			$end_timestamp   = strtotime( $end );

includes/Core/Email_Reporting/Email_Reporting.php

@@ -303,7 +303,7 @@ public function register() {
 			$this->scheduler->schedule_monitor();
 			$this->scheduler->schedule_cleanup();
 
-			add_action( Email_Reporting_Scheduler::ACTION_INITIATOR, array( $this->initiator_task, 'handle_callback_action' ), 10, 1 );
+			add_action( Email_Reporting_Scheduler::ACTION_INITIATOR, array( $this->initiator_task, 'handle_callback_action' ), 10, 2 );
 			add_action( Email_Reporting_Scheduler::ACTION_MONITOR, array( $this->monitor_task, 'handle_monitor_action' ) );
 			add_action( Email_Reporting_Scheduler::ACTION_WORKER, array( $this->worker_task, 'handle_callback_action' ), 10, 3 );
 			add_action( Email_Reporting_Scheduler::ACTION_FALLBACK, array( $this->fallback_task, 'handle_fallback_action' ), 10, 3 );

includes/Core/Email_Reporting/Email_Reporting_Scheduler.php

@@ -10,6 +10,7 @@
 
 namespace Google\Site_Kit\Core\Email_Reporting;
 
+use Google\Site_Kit\Core\Util\BC_Functions;
 use Google\Site_Kit\Core\User\Email_Reporting_Settings;
 
 /**
@@ -73,13 +74,13 @@ public function schedule_initiator_events() {
 	 * @param string $frequency Frequency slug.
 	 */
 	public function schedule_initiator_once( $frequency ) {
-		if ( wp_next_scheduled( self::ACTION_INITIATOR, array( $frequency ) ) ) {
+		if ( $this->is_initiator_scheduled( $frequency ) ) {
 			return;
 		}
 
-		$next = $this->frequency_planner->next_occurrence( $frequency, time(), wp_timezone() );
+		$next = $this->frequency_planner->next_occurrence( $frequency, time(), BC_Functions::wp_timezone() );
 
-		wp_schedule_single_event( $next, self::ACTION_INITIATOR, array( $frequency ) );
+		wp_schedule_single_event( $next, self::ACTION_INITIATOR, array( $frequency, $next ) );
 	}
 
 	/**
@@ -91,9 +92,61 @@ public function schedule_initiator_once( $frequency ) {
 	 * @param int    $timestamp Base timestamp used to calculate the next run.
 	 */
 	public function schedule_next_initiator( $frequency, $timestamp ) {
-		$next = $this->frequency_planner->next_occurrence( $frequency, $timestamp, wp_timezone() );
+		$next = $this->frequency_planner->next_occurrence( $frequency, $timestamp, BC_Functions::wp_timezone() );
 
-		wp_schedule_single_event( $next, self::ACTION_INITIATOR, array( $frequency ) );
+		wp_schedule_single_event( $next, self::ACTION_INITIATOR, array( $frequency, $next ) );
+	}
+
+	/**
+	 * Checks whether an initiator event exists for the provided frequency.
+	 *
+	 * @since n.e.x.t
+	 *
+	 * @param string $frequency Frequency slug.
+	 * @return bool Whether an initiator event is already scheduled for this frequency.
+	 */
+	public function is_initiator_scheduled( $frequency ) {
+		return false !== $this->get_initiator_timestamp( $frequency );
+	}
+
+	/**
+	 * Gets the timestamp of the next initiator event for a frequency.
+	 *
+	 * We intentionally scan cron entries instead of using `wp_next_scheduled()`
+	 * because initiators are scheduled with dynamic args:
+	 * `[ $frequency, $scheduled_timestamp ]`. `wp_next_scheduled()` requires an
+	 * exact args match, but here we only need to know whether *any* initiator
+	 * exists for a given frequency regardless of its scheduled timestamp.
+	 *
+	 * @since n.e.x.t
+	 *
+	 * @param string $frequency Frequency slug.
+	 * @return int|false Timestamp if found, otherwise false.
+	 */
+	public function get_initiator_timestamp( $frequency ) {
+		$cron = _get_cron_array();
+
+		if ( ! is_array( $cron ) ) {
+			return false;
+		}
+
+		foreach ( $cron as $timestamp => $hooks ) {
+			if ( empty( $hooks[ self::ACTION_INITIATOR ] ) || ! is_array( $hooks[ self::ACTION_INITIATOR ] ) ) {
+				continue;
+			}
+
+			foreach ( $hooks[ self::ACTION_INITIATOR ] as $event ) {
+				$args = isset( $event['args'] ) && is_array( $event['args'] )
+					? $event['args']
+					: array();
+
+				if ( isset( $args[0] ) && $frequency === $args[0] ) {
+					return (int) $timestamp;
+				}
+			}
+		}
+
+		return false;
 	}
 
 	/**

includes/Core/Email_Reporting/Email_Template_Formatter.php

@@ -13,6 +13,7 @@
 use Google\Site_Kit\Context;
 use Google\Site_Kit\Core\Golinks\Golinks;
 use Google\Site_Kit\Core\Email_Reporting\Notices\Enable_Conversion_Events_Email_Notice;
+use Google\Site_Kit\Core\Util\BC_Functions;
 use Google\Site_Kit\Core\User\Email_Reporting_Settings;
 use WP_Error;
 use WP_Post;
@@ -537,7 +538,7 @@ private function build_date_label( array $date_range ) {
 				return $value;
 			}
 
-			$timezone = function_exists( 'wp_timezone' ) ? wp_timezone() : null;
+			$timezone = BC_Functions::wp_timezone();
 			if ( $timezone && function_exists( 'wp_date' ) ) {
 				return wp_date( 'M j', $timestamp, $timezone );
 			}

includes/Core/Email_Reporting/Initiator_Task.php

@@ -12,6 +12,7 @@
 
 use DateInterval;
 use DateTimeImmutable;
+use Google\Site_Kit\Core\Util\BC_Functions;
 use Google\Site_Kit\Core\User\Email_Reporting_Settings;
 
 /**
@@ -55,10 +56,15 @@ public function __construct( Email_Reporting_Scheduler $scheduler, Subscribed_Us
 	 *
 	 * @since 1.167.0
 	 *
-	 * @param string $frequency Frequency slug.
+	 * @param string   $frequency           Frequency slug.
+	 * @param int|null $scheduled_timestamp Scheduled initiator timestamp.
 	 */
-	public function handle_callback_action( $frequency ) {
-		$timestamp = time();
+	public function handle_callback_action( $frequency, $scheduled_timestamp = null ) {
+		$timestamp = (int) $scheduled_timestamp;
+
+		if ( $timestamp <= 0 ) {
+			$timestamp = time();
+		}
 
 		$this->scheduler->schedule_next_initiator( $frequency, $timestamp );
 
@@ -101,7 +107,7 @@ public function handle_callback_action( $frequency ) {
 	 * @return array Reference date payload.
 	 */
 	public static function build_reference_dates( $frequency, $timestamp ) {
-		$time_zone = wp_timezone();
+		$time_zone = BC_Functions::wp_timezone();
 		$send_date = ( new DateTimeImmutable( '@' . $timestamp ) )
 			->setTimezone( $time_zone )
 			->setTime( 0, 0, 0 );
@@ -114,7 +120,11 @@ public static function build_reference_dates( $frequency, $timestamp ) {
 
 		$period_days = isset( $period_lengths[ $frequency ] ) ? $period_lengths[ $frequency ] : $period_lengths[ Email_Reporting_Settings::FREQUENCY_WEEKLY ];
 
-		$start_date         = $send_date->sub( new DateInterval( sprintf( 'P%dD', $period_days ) ) );
+		// Keep the period length inclusive of sendDate (e.g. weekly = 7 days total).
+		// Subtracting period_days would produce an 8-day window.
+		$start_date         = $send_date->sub(
+			new DateInterval( sprintf( 'P%dD', max( $period_days - 1, 0 ) ) )
+		);
 		$compare_end_date   = $start_date->sub( new DateInterval( 'P1D' ) );
 		$compare_start_date = $compare_end_date->sub(
 			new DateInterval( sprintf( 'P%dD', max( $period_days - 1, 0 ) ) )

includes/Core/Email_Reporting/Monitor_Task.php

@@ -66,7 +66,7 @@ public function handle_monitor_action() {
 		}
 
 		foreach ( array( User_Email_Reporting_Settings::FREQUENCY_WEEKLY, User_Email_Reporting_Settings::FREQUENCY_MONTHLY, User_Email_Reporting_Settings::FREQUENCY_QUARTERLY ) as $frequency ) {
-			if ( wp_next_scheduled( Email_Reporting_Scheduler::ACTION_INITIATOR, array( $frequency ) ) ) {
+			if ( $this->scheduler->is_initiator_scheduled( $frequency ) ) {
 				continue;
 			}
 

includes/Core/Email_Reporting/Subscription_Confirmation_Task.php

@@ -10,6 +10,7 @@
 
 namespace Google\Site_Kit\Core\Email_Reporting;
 
+use Google\Site_Kit\Core\Util\BC_Functions;
 use Google\Site_Kit\Core\User\Email_Reporting_Settings;
 
 /**
@@ -95,7 +96,7 @@ public function schedule( $user_id, $frequency ) {
 		$first_report_timestamp = $this->frequency_planner->next_occurrence(
 			$frequency,
 			$timestamp,
-			wp_timezone()
+			BC_Functions::wp_timezone()
 		);
 		$reference_dates        = Initiator_Task::build_reference_dates( $frequency, $first_report_timestamp );
 

includes/Core/Util/BC_Functions.php

@@ -22,6 +22,8 @@
  * @method static void wp_print_script_tag( $attributes )
  * @method static void wp_print_inline_script_tag( $javascript, $attributes = array() )
  * @method static bool array_is_list( array $value )
+ * @method static string wp_timezone_string()
+ * @method static \DateTimeZone wp_timezone()
  */
 class BC_Functions {
 
@@ -151,6 +153,43 @@ protected static function wp_get_sidebar( $id ) {
 		return null;
 	}
 
+	/**
+	 * A fallback for the wp_timezone_string function introduced in WordPress 5.3.0.
+	 *
+	 * @since n.e.x.t
+	 *
+	 * @return string PHP timezone string or a ±HH:MM offset.
+	 */
+	protected static function wp_timezone_string() {
+		$timezone_string = get_option( 'timezone_string' );
+
+		if ( $timezone_string ) {
+			return $timezone_string;
+		}
+
+		$offset  = (float) get_option( 'gmt_offset' );
+		$hours   = (int) $offset;
+		$minutes = ( $offset - $hours );
+
+		$sign      = ( $offset < 0 ) ? '-' : '+';
+		$abs_hour  = abs( $hours );
+		$abs_mins  = abs( $minutes * 60 );
+		$tz_offset = sprintf( '%s%02d:%02d', $sign, $abs_hour, $abs_mins );
+
+		return $tz_offset;
+	}
+
+	/**
+	 * A fallback for the wp_timezone function introduced in WordPress 5.3.0.
+	 *
+	 * @since n.e.x.t
+	 *
+	 * @return \DateTimeZone Site timezone.
+	 */
+	protected static function wp_timezone() {
+		return new \DateTimeZone( self::wp_timezone_string() );
+	}
+
 	/**
 	 * A fallback for the array_is_list function introduced in PHP 8.1.
 	 *

tests/phpunit/integration/Core/Email_Reporting/Email_ReportingTest.php

@@ -11,6 +11,7 @@
 use Google\Site_Kit\Core\Email_Reporting\Email_Log;
 use Google\Site_Kit\Core\Email_Reporting\Email_Reporting;
 use Google\Site_Kit\Core\Email_Reporting\Email_Reporting_Scheduler;
+use Google\Site_Kit\Core\Email_Reporting\Frequency_Planner;
 use Google\Site_Kit\Core\Email_Reporting\Email_Reporting_Settings;
 use Google\Site_Kit\Core\User\Email_Reporting_Settings as User_Email_Reporting_Settings;
 use Google\Site_Kit\Core\Email_Reporting\Email_Reporting_Data_Requests;
@@ -155,7 +156,7 @@ public function test_register_schedules_initiators_when_enabled() {
 
 		foreach ( array( User_Email_Reporting_Settings::FREQUENCY_WEEKLY, User_Email_Reporting_Settings::FREQUENCY_MONTHLY, User_Email_Reporting_Settings::FREQUENCY_QUARTERLY ) as $frequency ) {
 			$this->assertNotFalse(
-				wp_next_scheduled( Email_Reporting_Scheduler::ACTION_INITIATOR, array( $frequency ) ),
+				$this->get_initiator_scheduled_timestamp( $frequency ),
 				sprintf( 'Expected initiator to be scheduled for frequency %s.', $frequency )
 			);
 		}
@@ -179,7 +180,7 @@ public function test_disabling_unschedules_all_events() {
 
 		foreach ( array( User_Email_Reporting_Settings::FREQUENCY_WEEKLY, User_Email_Reporting_Settings::FREQUENCY_MONTHLY, User_Email_Reporting_Settings::FREQUENCY_QUARTERLY ) as $frequency ) {
 			$this->assertFalse(
-				wp_next_scheduled( Email_Reporting_Scheduler::ACTION_INITIATOR, array( $frequency ) ),
+				$this->get_initiator_scheduled_timestamp( $frequency ),
 				sprintf( 'Initiator should be unscheduled for frequency %s when reporting disabled.', $frequency )
 			);
 		}
@@ -198,7 +199,8 @@ public function test_register_clears_existing_events_when_disabled() {
 		$settings = new Email_Reporting_Settings( $this->options );
 		$settings->set( array( 'enabled' => false ) );
 
-		wp_schedule_single_event( time() + 50, Email_Reporting_Scheduler::ACTION_INITIATOR, array( User_Email_Reporting_Settings::FREQUENCY_WEEKLY ) );
+		$initiator_timestamp = time() + 50;
+		wp_schedule_single_event( $initiator_timestamp, Email_Reporting_Scheduler::ACTION_INITIATOR, array( User_Email_Reporting_Settings::FREQUENCY_WEEKLY, $initiator_timestamp ) );
 		$worker_timestamp = time();
 		wp_schedule_single_event( time() + 50, Email_Reporting_Scheduler::ACTION_WORKER, array( 'batch', User_Email_Reporting_Settings::FREQUENCY_WEEKLY, $worker_timestamp ) );
 		$fallback_timestamp = time();
@@ -209,7 +211,7 @@ public function test_register_clears_existing_events_when_disabled() {
 		$email_reporting = $this->create_email_reporting();
 		$email_reporting->register();
 
-		$this->assertFalse( wp_next_scheduled( Email_Reporting_Scheduler::ACTION_INITIATOR, array( User_Email_Reporting_Settings::FREQUENCY_WEEKLY ) ), 'Initiator event should be cleared when reporting is disabled.' );
+		$this->assertFalse( $this->get_initiator_scheduled_timestamp( User_Email_Reporting_Settings::FREQUENCY_WEEKLY ), 'Initiator event should be cleared when reporting is disabled.' );
 		$this->assertFalse( wp_next_scheduled( Email_Reporting_Scheduler::ACTION_WORKER, array( 'batch', User_Email_Reporting_Settings::FREQUENCY_WEEKLY, $worker_timestamp ) ), 'Worker event should be cleared when reporting is disabled.' );
 		$this->assertFalse( wp_next_scheduled( Email_Reporting_Scheduler::ACTION_FALLBACK, array( 'batch', User_Email_Reporting_Settings::FREQUENCY_WEEKLY, $fallback_timestamp ) ), 'Fallback event should be cleared when reporting is disabled.' );
 		$this->assertFalse( wp_next_scheduled( Email_Reporting_Scheduler::ACTION_MONITOR ), 'Monitor event should be cleared when reporting is disabled.' );
@@ -221,16 +223,17 @@ public function test_register_unschedules_when_setup_incomplete() {
 		remove_filter( 'googlesitekit_setup_complete', '__return_true' );
 		delete_option( Credentials::OPTION );
 
-		wp_schedule_single_event( time() + 50, Email_Reporting_Scheduler::ACTION_INITIATOR, array( User_Email_Reporting_Settings::FREQUENCY_WEEKLY ) );
+		$initiator_timestamp = time() + 50;
+		wp_schedule_single_event( $initiator_timestamp, Email_Reporting_Scheduler::ACTION_INITIATOR, array( User_Email_Reporting_Settings::FREQUENCY_WEEKLY, $initiator_timestamp ) );
 		wp_schedule_event( time() + 50, 'daily', Email_Reporting_Scheduler::ACTION_MONITOR );
 		wp_schedule_event( time() + 50, 'daily', Email_Reporting_Scheduler::ACTION_CLEANUP );
 
 		$email_reporting = $this->create_email_reporting();
 		$email_reporting->register();
 
-		$this->assertFalse( wp_next_scheduled( Email_Reporting_Scheduler::ACTION_INITIATOR, array( User_Email_Reporting_Settings::FREQUENCY_WEEKLY ) ), 'Initiator should be unscheduled when setup is incomplete.' );
-		$this->assertFalse( wp_next_scheduled( Email_Reporting_Scheduler::ACTION_INITIATOR, array( User_Email_Reporting_Settings::FREQUENCY_MONTHLY ) ), 'Monthly initiator should not be scheduled when setup is incomplete.' );
-		$this->assertFalse( wp_next_scheduled( Email_Reporting_Scheduler::ACTION_INITIATOR, array( User_Email_Reporting_Settings::FREQUENCY_QUARTERLY ) ), 'Quarterly initiator should not be scheduled when setup is incomplete.' );
+		$this->assertFalse( $this->get_initiator_scheduled_timestamp( User_Email_Reporting_Settings::FREQUENCY_WEEKLY ), 'Initiator should be unscheduled when setup is incomplete.' );
+		$this->assertFalse( $this->get_initiator_scheduled_timestamp( User_Email_Reporting_Settings::FREQUENCY_MONTHLY ), 'Monthly initiator should not be scheduled when setup is incomplete.' );
+		$this->assertFalse( $this->get_initiator_scheduled_timestamp( User_Email_Reporting_Settings::FREQUENCY_QUARTERLY ), 'Quarterly initiator should not be scheduled when setup is incomplete.' );
 		$this->assertFalse( wp_next_scheduled( Email_Reporting_Scheduler::ACTION_MONITOR ), 'Monitor should not be scheduled when setup is incomplete.' );
 		$this->assertFalse( wp_next_scheduled( Email_Reporting_Scheduler::ACTION_CLEANUP ), 'Cleanup should not be scheduled when setup is incomplete.' );
 	}
@@ -258,6 +261,11 @@ private function create_email_reporting() {
 		);
 	}
 
+	private function get_initiator_scheduled_timestamp( $frequency ) {
+		$scheduler = new Email_Reporting_Scheduler( new Frequency_Planner() );
+		return $scheduler->get_initiator_timestamp( $frequency );
+	}
+
 	private function clear_scheduled_events() {
 		foreach ( array( Email_Reporting_Scheduler::ACTION_INITIATOR, Email_Reporting_Scheduler::ACTION_WORKER, Email_Reporting_Scheduler::ACTION_FALLBACK, Email_Reporting_Scheduler::ACTION_MONITOR, Email_Reporting_Scheduler::ACTION_CLEANUP ) as $hook ) {
 			wp_unschedule_hook( $hook );