VIP Integrations: Improves reading of config files and add multiple configs support of same integration

integrations/integration.php

@@ -7,7 +7,8 @@
 
 namespace Automattic\VIP\Integrations;
 
-use Automattic\VIP\Integrations\IntegrationVipConfig;
+use Org_Integration_Status;
+use Env_Integration_Status;
 
 /**
  * Abstract base class for all integration implementations.
@@ -48,15 +49,22 @@ abstract class Integration {
 	protected bool $is_active = false;
 
 	/**
-	 * Instance of VipIntegrationConfig. It's useful to have full configuration info
+	 * Array containing all configuration data. 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
+	 * @var array
 	 */
-	private IntegrationVipConfig $vip_config;
+	private array $vip_configs = [];
+
+	/**
+	 * A boolean indicating if the integration have multiple configs.
+	 *
+	 * @var bool
+	 */
+	protected bool $have_multiple_configs = false;
 
 	/**
 	 * Constructor.
@@ -66,7 +74,7 @@ abstract class Integration {
 	public function __construct( string $slug ) {
 		$this->slug = $slug;
 
-		add_action( 'switch_blog', array( $this, 'switch_blog_callback' ), 10, 2 );
+		add_action( 'switch_blog', array( $this, 'switch_blog_callback' ), 10 );
 	}
 
 	/**
@@ -97,11 +105,13 @@ public function activate( array $options = [] ): void {
 
 	/**
 	 * Callback for `switch_blog` filter.
+	 *
+	 * @private
 	 */
 	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();
+		if ( isset( $this->vip_configs ) ) {
+			$this->options['config'] = $this->get_site_configs( $this->slug );
 		}
 	}
 
@@ -114,6 +124,17 @@ public function is_active(): bool {
 		return $this->is_active;
 	}
 
+	/**
+	 * Returns `true` if the integration is enabled in VIP configs else `false`.
+	 *
+	 * @return bool
+	 *
+	 * @private
+	 */
+	public function is_active_via_vip(): bool {
+		return in_array( Env_Integration_Status::ENABLED, $this->get_site_statuses() );
+	}
+
 	/**
 	 * Return the configuration for this integration.
 	 *
@@ -135,18 +156,116 @@ public function get_slug(): string {
 	}
 
 	/**
-	 * Set vip_config property.
+	 * Set `vip_configs` property.
 	 *
-	 * @param IntegrationVipConfig $vip_config Instance of IntegrationVipConfig.
+	 * @param array $vip_configs Configurations provided by VIP.
 	 *
 	 * @return void
+	 *
+	 * @private
+	 */
+	public function set_vip_configs( array $vip_configs ): void {
+		$this->vip_configs = $vip_configs;
+	}
+
+	/**
+	 * Get statuses of the integration in context of current site.
+	 *
+	 * @return array<Env_Integration_Status>
+	 */
+	private function get_site_statuses() {
+		/**
+		 * Statuses of the integration.
+		 *
+		 * @var array<string>
+		 */
+		$statuses = [];
+
+		foreach ( $this->vip_configs as $vip_config ) {
+			if ( $this->get_value_from_config( $vip_config, 'org', 'status' ) === Org_Integration_Status::BLOCKED ) {
+				return [ Org_Integration_Status::BLOCKED ];
+			}
+
+			// Look into network_sites config before and then fallback to env config.
+			$statuses[] = $this->get_value_from_config( $vip_config, 'network_sites', 'status' ) ??
+				$this->get_value_from_config( $vip_config, 'env', 'status' );
+		}
+
+		return $statuses;
+	}
+
+	/**
+	 * Get configs of the integration in context of current site.
+	 *
+	 * @return array<array<mixed>> Returns an array of configs if the integration have multiple configs else single config object.
+	 *
+	 * @private
 	 */
-	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
+	public function get_site_configs() {
+		/**
+		 * Array containing configs of the integration.
+		 *
+		 * @var array<array<mixed>>
+		 */
+		$configs = [];
+
+		// Get configs of the integration from configurations provided by VIP.
+		foreach ( $this->vip_configs as $vip_config ) {
+			if ( is_multisite() ) {
+				$config = $this->get_value_from_config( $vip_config, 'network_sites', 'config' );
+
+				// If network site config is not found then fallback to env config if it exists.
+				if ( empty( $config ) && true === $this->get_value_from_config( $vip_config, 'env', 'cascade_config' ) ) {
+					$config = $this->get_value_from_config( $vip_config, 'env', 'config' );
+				}
+			} else {
+				$config = $this->get_value_from_config( $vip_config, 'env', 'config' );
+			}
+
+			if ( ! isset( $config ) ) {
+				continue;
+			}
+
+			$configs[] = $config;
+		}
+
+		// Return config object if integration have only one config else return all configs.
+		return ( ! $this->have_multiple_configs && isset( $configs[0] ) ) ? $configs[0] : $configs;
+	}
+
+	/**
+	 * Get config value based on given type and key.
+	 *
+	 * @param array  $vip_config  Configurations provided by VIP.
+	 * @param string $config_type Type of the config whose data is needed i.e. org, env, network-sites etc.
+	 * @param string $key Key of the config from which we have to extract the data.
+	 *
+	 * @return null|string|array Returns `null` if key is not found, `string` if key is "status" and `array` if key is "config".
+	 */
+	private function get_value_from_config( array $vip_config, string $config_type, string $key ) {
+		$value = null;
+
+		if ( ! in_array( $config_type, [ 'org', 'env', 'network_sites' ], true ) ) {
+			trigger_error( 'config_type param (' . esc_html( $config_type ) . ') must be one of org, env or network_sites.', E_USER_WARNING ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
+		} elseif ( isset( $vip_config[ $config_type ] ) ) {
+
+			// Look for key inside org or env config.
+			if ( 'network_sites' !== $config_type && isset( $vip_config[ $config_type ][ $key ] ) ) {
+				return $vip_config[ $config_type ][ $key ];
+			}
+
+			// Look for key inside network-sites config.
+			$network_site_id = get_current_blog_id();
+			if (
+				'network_sites' === $config_type &&
+				isset( $vip_config[ $config_type ][ $network_site_id ] ) &&
+				isset( $vip_config[ $config_type ][ $network_site_id ][ $key ] )
+			) {
+				return $vip_config[ $config_type ][ $network_site_id ][ $key ];
+			}
 		}
 
-		$this->vip_config = $vip_config;
+		return $value;
 	}
 
 	/**