Merge pull request #6234 from Automattic/staging

Production release v20250408.0

Author: rebeccahum

.github/actions/run-wp-tests/action.yml

@@ -84,7 +84,7 @@ runs:
       uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # 3.1.0
 
     - name: Set up WordPress and WordPress Test Library
-      uses: sjinks/[email protected].3
+      uses: sjinks/[email protected].4
       with:
         version: ${{ inputs.wordpress }}
 

.github/workflows/codeql-analysis.yml

@@ -33,12 +33,12 @@ jobs:
         uses: actions/[email protected]
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/[email protected].11
+        uses: github/codeql-action/[email protected].13
         with:
           languages: ${{ matrix.language }}
           config-file: ./.github/codeql-config.yml
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/[email protected].11
+        uses: github/codeql-action/[email protected].13
         with:
           category: "/language:${{matrix.language}}"

.github/workflows/stale.yml

@@ -12,4 +12,4 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - uses: Automattic/vip-actions/stale@bb2853ecb6cd7dba2efe589ebb10cf930759fe69 # trunk
+      - uses: Automattic/vip-actions/stale@1137b91acf0f5ea4e0db044bcf14ceabed9b068f # trunk

000-vip-init.php

@@ -234,15 +234,35 @@
 require_once __DIR__ . '/vip-helpers/class-wpcomvip-restrictions.php';
 
 // Load the Telemetry files
-require_once __DIR__ . '/telemetry/class-telemetry-system.php';
-require_once __DIR__ . '/telemetry/class-tracks.php';
-require_once __DIR__ . '/telemetry/class-telemetry-client.php';
-require_once __DIR__ . '/telemetry/class-telemetry-event-queue.php';
-require_once __DIR__ . '/telemetry/class-telemetry-event.php';
-require_once __DIR__ . '/telemetry/tracks/class-tracks-event-dto.php';
-require_once __DIR__ . '/telemetry/tracks/class-tracks-event.php';
-require_once __DIR__ . '/telemetry/tracks/class-tracks-client.php';
-require_once __DIR__ . '/telemetry/tracks/tracks-utils.php';
+// Temporary loader during rollout, remove and directly require after rollout.
+$telemetry_files = [
+	__DIR__ . '/telemetry/class-telemetry-system.php',
+	__DIR__ . '/telemetry/class-telemetry-client.php',
+	__DIR__ . '/telemetry/class-telemetry-event-queue.php',
+	__DIR__ . '/telemetry/class-telemetry-event.php',
+	__DIR__ . '/telemetry/class-telemetry.php',
+	__DIR__ . '/telemetry/tracks/class-tracks.php',
+	__DIR__ . '/telemetry/tracks/class-tracks-event-dto.php',
+	__DIR__ . '/telemetry/tracks/class-tracks-event.php',
+	__DIR__ . '/telemetry/tracks/class-tracks-client.php',
+	__DIR__ . '/telemetry/tracks/tracks-utils.php',
+	__DIR__ . '/telemetry/pendo/class-pendo.php',
+	__DIR__ . '/telemetry/pendo/class-pendo-track-client.php',
+	__DIR__ . '/telemetry/pendo/class-pendo-track-event-dto.php',
+	__DIR__ . '/telemetry/pendo/class-pendo-track-event.php',
+	__DIR__ . '/telemetry/pendo/pendo-utils.php',
+];
+
+// Make sure all telemetry files are present before loading them.
+$safe_to_load_telemetry = array_reduce( $telemetry_files, function ( bool $carry, string $file ): bool {
+	return $carry && file_exists( $file );
+}, true );
+
+if ( true === $safe_to_load_telemetry ) {
+	foreach ( $telemetry_files as $file ) {
+		require_once $file;
+	}
+}
 
 add_action( 'init', [ WPComVIP_Restrictions::class, 'instance' ] );
 

__tests__/e2e/package-lock.json

@@ -20,6 +20,11 @@ class Site_Details_Index {
 	 */
 	private $timestamp = null;
 
+	const SYNC_DATA_OPTION = 'vip_config_sync_data';
+
+	const MINUTE_IN_MS = MINUTE_IN_SECONDS * 1000;
+	const DAY_IN_MS    = DAY_IN_SECONDS * 1000;
+
 	/**
 	 * Standard singleton except accept a timestamp for mocking purposes.
 	 *
@@ -349,32 +354,127 @@ public function get_site_details() {
 	}
 
 	/**
-	 * Builds the site details structure and then puts it into logstash
-	 * and sends it to the site details service
+	 * Builds the site details and sends it to the site details service.
 	 */
 	public function put_site_details() {
 		$site_details = $this->get_site_details();
-		$url          = null;
-		$token        = null;
+		$sync_data    = get_option( self::SYNC_DATA_OPTION, [] );
+		$sync_data    = is_array( $sync_data ) ? $sync_data : [];
+
+		$sync_type = $this->determine_sync_type( $site_details, $sync_data );
+
+		// Run a heartbeat sync.
+		if ( 'heartbeat' === $sync_type ) {
+			$success = $this->send_sync( '/sites/heartbeat', [
+				'client_site_id' => $site_details['client_site_id'],
+				'blog_id'        => $site_details['core']['blog_id'],
+				'timestamp'      => $site_details['timestamp'],
+			] );
+
+			if ( $success ) {
+				$sync_data['last_synced'] = $site_details['timestamp'];
+				update_option( self::SYNC_DATA_OPTION, $sync_data, false );
+			}
+		}
+
+		// Run a full sync.
+		if ( 'full' === $sync_type ) {
+			$success = $this->send_sync( '/sites', $site_details );
 
-		if ( defined( 'VIP_SERVICES_AUTH_TOKENS' ) && ! empty( VIP_SERVICES_AUTH_TOKENS ) ) {
-			$auth_token_details = json_decode( base64_decode( VIP_SERVICES_AUTH_TOKENS ), true );
-			$url                = $auth_token_details['site']['vip-site-details']['url'] ?? null;
-			$token              = $auth_token_details['site']['vip-site-details']['token'] ?? null;
+			if ( $success ) {
+				$timestamp = $site_details['timestamp'];
+
+				// Stagger the future syncs if this is the first time we're setting the option.
+				if ( empty( $sync_data['last_full_synced'] ) ) {
+					$sync_data['last_full_synced'] = wp_rand( $timestamp - self::DAY_IN_MS, $timestamp );
+					$sync_data['last_synced']      = wp_rand( $timestamp - self::MINUTE_IN_MS * 25, $timestamp );
+				} else {
+					$sync_data['last_full_synced'] = $timestamp;
+					$sync_data['last_synced']      = $timestamp;
+				}
+
+				$sync_data['last_sync_hash'] = $this->get_site_details_data_hash( $site_details );
+				update_option( self::SYNC_DATA_OPTION, $sync_data, false );
+			}
 		}
+	}
 
-		if ( $url && $token ) {
-			$args = array(
-				'method'  => 'PUT',
-				'body'    => wp_json_encode( $site_details ),
-				'headers' => array(
-					'Authorization' => 'Bearer ' . $token,
-					'Content-Type'  => 'application/json',
-				),
-			);
+	/**
+	 * Determine if we need a full sync, a heartbeat, or none at all.
+	 */
+	private function determine_sync_type( $site_details, $sync_data ) {
+		$current_timestamp        = $site_details['timestamp'];
+		$last_sync_timestamp      = $sync_data['last_synced'] ?? 0;
+		$last_full_sync_timestamp = $sync_data['last_full_synced'] ?? 0;
+
+		// Safeguard a reset on the timestamps if they have been incorrectly altered.
+		$max_allowed_timestamp = $current_timestamp + ( self::MINUTE_IN_MS * 5 );
+		if ( $last_sync_timestamp > $max_allowed_timestamp || $last_full_sync_timestamp > $max_allowed_timestamp ) {
+			$last_full_sync_timestamp = 0;
+			$last_sync_timestamp      = 0;
+		}
+
+		// Send a full sync at least once per day.
+		if ( $current_timestamp - $last_full_sync_timestamp > self::DAY_IN_MS ) {
+			return 'full';
+		}
+
+		$current_data_hash = $this->get_site_details_data_hash( $site_details );
+		$last_data_hash    = $sync_data['last_sync_hash'] ?? '';
+
+		// Send a full sync if the data has changed.
+		if ( $current_data_hash !== $last_data_hash ) {
+			return 'full';
+		}
 
-			vip_safe_wp_remote_request( rtrim( $url, '/' ) . '/sites', false, 3, 5, 10, $args );
+		// Send a heartbeat if it's been more than 25 minutes (1/3 of the stale threshold).
+		if ( $current_timestamp - $last_sync_timestamp > self::MINUTE_IN_MS * 25 ) {
+			return 'heartbeat';
 		}
+
+		return 'none';
+	}
+
+	/**
+	 * Hashes the data for comparison purposes, removing the timestamp.
+	 */
+	private function get_site_details_data_hash( $site_details ) {
+		unset( $site_details['timestamp'] );
+		return hash( 'sha256', wp_json_encode( $site_details ) );
+	}
+
+	/**
+	 * Sends sync data to the service.
+	 */
+	private function send_sync( $endpoint, $body ) {
+		if ( ! defined( 'VIP_SERVICES_AUTH_TOKENS' ) || empty( VIP_SERVICES_AUTH_TOKENS ) ) {
+			return false;
+		}
+
+		$auth_tokens = json_decode( base64_decode( VIP_SERVICES_AUTH_TOKENS ), true );
+
+		$url   = $auth_tokens['site']['vip-site-details']['url'] ?? null;
+		$token = $auth_tokens['site']['vip-site-details']['token'] ?? null;
+		if ( ! $url || ! $token ) {
+			return false;
+		}
+
+		$response = vip_safe_wp_remote_request( rtrim( $url, '/' ) . $endpoint, false, 3, 5, 10, [
+			'method'  => 'PUT',
+			'body'    => wp_json_encode( $body ),
+			'headers' => array(
+				'Authorization' => 'Bearer ' . $token,
+				'Content-Type'  => 'application/json',
+			),
+		] );
+
+		$response_code = (int) wp_remote_retrieve_response_code( $response );
+		if ( is_wp_error( $response ) || 200 !== $response_code ) {
+			return false;
+		}
+
+		$response_body = json_decode( wp_remote_retrieve_body( $response ), true );
+		return isset( $response_body['updated'] ) && true === $response_body['updated'];
 	}
 
 	/**