Merge pull request #4877 from Automattic/develop

Staging release: v20230919.0

Author: luiztiago

.github/workflows/changelog-summary-prod.yml

@@ -64,7 +64,7 @@ jobs:
         uses: actions/[email protected]
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@2.25.5
+        uses: shivammathur/setup-php@2.26.0
         with:
           php-version: '7.4'
 

.github/workflows/changelog-summary-staging.yml

@@ -19,7 +19,7 @@ jobs:
         uses: actions/[email protected]
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@2.25.5
+        uses: shivammathur/setup-php@2.26.0
         with:
           php-version: '7.4'
 

.github/workflows/lint.yml

@@ -28,7 +28,7 @@ jobs:
         uses: actions/[email protected]
 
       - name: Set up PHP
-        uses: shivammathur/setup-php@2.25.5
+        uses: shivammathur/setup-php@2.26.0
         with:
           coverage: none
           php-version: "8.0"

__tests__/e2e/package-lock.json

@@ -78,13 +78,29 @@ private function set_config( string $slug ): void {
 	 * @return null|mixed
 	 */
 	protected function get_vip_config_from_file( string $slug ) {
-		$config_file_path = ABSPATH . 'config/integrations-config/' . $slug . '-config.php';
+		$config_file_directory = ABSPATH . 'config/integrations-config';
+		$config_file_name      = $slug . '-config.php';
+		$config_file_path      = $config_file_directory . '/' . $config_file_name;
+
+		/**
+		 * Clear cache to always read data from latest config file.
+		 *
+		 * Kubernetes ConfigMap updates the file via symlink instead of actually replacing the file and
+		 * PHP cache can hold a reference to the old symlink that can cause fatal if we use require
+		 * on it.
+		 */
+		if ( false === @file_get_contents( $config_file_path ) ) { // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+			clearstatcache( true, $config_file_directory . '/' . $config_file_name );
+			// Clears cache for files created by k8s ConfigMap.
+			clearstatcache( true, $config_file_directory . '/..data' );
+			clearstatcache( true, $config_file_directory . '/..data/' . $config_file_name );
+		}
 
 		if ( ! is_readable( $config_file_path ) ) {
 			return null;
 		}
 
-		return require_once $config_file_path;
+		return require $config_file_path;
 	}
 
 	/**

integrations/integration-vip-config.php

@@ -7,6 +7,8 @@
 
 namespace Automattic\VIP\Integrations;
 
+use Automattic\VIP\Integrations\IntegrationVipConfig;
+
 /**
  * Abstract base class for all integration implementations.
  *
@@ -45,13 +47,26 @@ abstract class Integration {
 	 */
 	protected bool $is_active = false;
 
+	/**
+	 * Instance of VipIntegrationConfig. It's useful to have full configuration info
+	 * available inside each integration, we can use it for cases like multisite,
+	 * tracking etc.
+	 *
+	 * Note: We don't use this property for activation of the integration.
+	 *
+	 * @var IntegrationVipConfig
+	 */
+	private IntegrationVipConfig $vip_config;
+
 	/**
 	 * Constructor.
 	 *
 	 * @param string $slug Slug of the integration.
 	 */
 	public function __construct( string $slug ) {
 		$this->slug = $slug;
+
+		add_action( 'switch_blog', array( $this, 'switch_blog_callback' ), 10, 2 );
 	}
 
 	/**
@@ -80,6 +95,16 @@ public function activate( array $options = [] ): void {
 		$this->options   = $options;
 	}
 
+	/**
+	 * Callback for `switch_blog` filter.
+	 */
+	public function switch_blog_callback(): void {
+		// Updating config to make sure `get_config()` returns config of current blog instead of main site.
+		if ( isset( $this->vip_config ) ) {
+			$this->options['config'] = $this->vip_config->get_site_config();
+		}
+	}
+
 	/**
 	 * Returns true if this integration has been activated.
 	 *
@@ -109,6 +134,21 @@ public function get_slug(): string {
 		return $this->slug;
 	}
 
+	/**
+	 * Set vip_config property.
+	 *
+	 * @param IntegrationVipConfig $vip_config Instance of IntegrationVipConfig.
+	 *
+	 * @return void
+	 */
+	public function set_vip_config( IntegrationVipConfig $vip_config ): void {
+		if ( ! $this->is_active() ) {
+			trigger_error( sprintf( 'Configuration info can only assigned if integration is active.' ), E_USER_WARNING ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
+		}
+
+		$this->vip_config = $vip_config;
+	}
+
 	/**
 	 * Returns `true` if the integration is already available e.g. via customer code. We will use
 	 * this function to prevent activating of integration again.

integrations/integration.php

@@ -73,6 +73,7 @@ public function activate_platform_integrations() {
 				// If integration is activated successfully without any error then configure.
 				if ( $integration->is_active() ) {
 					$integration->configure();
+					$integration->set_vip_config( $vip_config );
 				}
 			}
 		}