Merge pull request #4860 from Automattic/develop

Staging release: v20230912.1

Author: WPprodigy

__tests__/e2e/package-lock.json

@@ -11,7 +11,7 @@
   },
   "author": "Automattic",
   "devDependencies": {
-    "@automattic/eslint-plugin-wpvip": "^0.5.2",
+    "@automattic/eslint-plugin-wpvip": "^0.6.0",
     "@babel/plugin-syntax-decorators": "^7.18.6",
     "@playwright/test": "^1.27.1",
     "asana-phrase": "^0.0.8",

__tests__/e2e/package.json

@@ -1,6 +1,6 @@
 {
     "require-dev": {
-        "phpunit/phpunit": "9.6.11",
+        "phpunit/phpunit": "9.6.12",
         "automattic/vipwpcs": "2.3.4",
         "phpcompatibility/phpcompatibility-wp": "2.1.4",
         "erusev/parsedown": "1.7.4",

composer.json

@@ -22,6 +22,14 @@ class BlockDataApiIntegration extends Integration {
 	 */
 	protected string $version = '1.0';
 
+	/**
+	 * Returns `true` if `Block Data API` is already available e.g. via customer code. We will use
+	 * this function to prevent activating of integration from platform side.
+	 */
+	public function is_loaded(): bool {
+		return defined( 'VIP_BLOCK_DATA_API_LOADED' );
+	}
+
 	/**
 	 * Applies hooks to load Block Data API plugin.
 	 *
@@ -30,8 +38,11 @@ class BlockDataApiIntegration extends Integration {
 	public function load(): void {
 		// Wait until plugins_loaded to give precedence to the plugin in the customer repo.
 		add_action( 'plugins_loaded', function() {
-			// Do not load plugin if already loaded by customer code.
-			if ( defined( 'VIP_BLOCK_DATA_API_LOADED' ) ) {
+			// Return if the integration is already loaded.
+			//
+			// In activate() method we do make sure to not activate the integration if its already loaded
+			// but still adding it here as a safety measure i.e. if load() is called directly.
+			if ( $this->is_loaded() ) {
 				return;
 			}
 
@@ -44,4 +55,9 @@ public function load(): void {
 			}
 		} );
 	}
+
+	/**
+	 * Configure `Block Data API` for VIP Platform.
+	 */
+	public function configure(): void {}
 }

composer.lock

@@ -63,10 +63,17 @@ public function __construct( string $slug ) {
 	 * @private
 	 */
 	public function activate( array $options = [] ): void {
+		// If integration is already available in customer code then don't activate it from platform side.
+		if ( $this->is_loaded() ) {
+			trigger_error( // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
+				sprintf( 'Prevented activating of integration with slug "%s" because it is already loaded.', esc_html( $this->slug ) ),
+				E_USER_WARNING
+			);
+		}
+
 		// Don't do anything if integration is already activated.
 		if ( $this->is_active() ) {
 			trigger_error( sprintf( 'VIP Integration with slug "%s" is already activated.', esc_html( $this->get_slug() ) ), E_USER_WARNING ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
-			return;
 		}
 
 		$this->is_active = true;
@@ -102,6 +109,14 @@ public function get_slug(): string {
 		return $this->slug;
 	}
 
+	/**
+	 * Returns `true` if the integration is already available e.g. via customer code. We will use
+	 * this function to prevent activating of integration again.
+	 *
+	 * @private
+	 */
+	abstract public function is_loaded(): bool;
+
 	/**
 	 * Implement custom action and filter calls to load integration here.
 	 *
@@ -112,4 +127,14 @@ public function get_slug(): string {
 	 * @private
 	 */
 	abstract public function load(): void;
+
+	/**
+	 * Configure the integration for VIP platform.
+	 *
+	 * If we want to implement functionality only if the integration is enabled via VIP
+	 * then we will use this function.
+	 *
+	 * @private
+	 */
+	abstract public function configure(): void;
 }

integrations/block-data-api.php

@@ -69,6 +69,11 @@ public function activate_platform_integrations() {
 				$this->activate( $slug, [
 					'config' => $vip_config->get_site_config(),
 				] );
+
+				// If integration is activated successfully without any error then configure.
+				if ( $integration->is_active() ) {
+					$integration->configure();
+				}
 			}
 		}
 	}

integrations/integration.php

@@ -13,24 +13,45 @@
  * @private
  */
 class ParselyIntegration extends Integration {
+	/**
+	 * Returns `true` if `Parse.ly` is already available e.g. customer code. We will use
+	 * this function to prevent loading of integration again from platform side.
+	 */
+	public function is_loaded(): bool {
+		return class_exists( 'Parsely' ) || class_exists( 'Parsely\Parsely' );
+	}
+
 	/**
 	 * Loads the plugin.
 	 *
 	 * @private
 	 */
 	public function load(): void {
-		// Do not load plugin if already loaded by customer code.
-		if ( class_exists( 'Parsely\Parsely' ) ) {
+		// Return if the integration is already loaded.
+			//
+			// In activate() method we do make sure to not activate the integration if its already loaded
+			// but still adding it here as a safety measure i.e. if load() is called directly.
+		if ( $this->is_loaded() ) {
 			return;
 		}
 
 		// Activating the integration via setting constant whose implementation is already
 		// handled via Automattic\VIP\WP_Parsely_Integration (ideally we should move
 		// all the implementation here such that there will be only one way of managing
 		// the plugin).
-		define( 'VIP_PARSELY_ENABLED', true );
+		if ( ! defined( 'VIP_PARSELY_ENABLED' ) ) {
+			define( 'VIP_PARSELY_ENABLED', true );
+		}
+	}
 
+	/**
+	 * Configure `Parse.ly` for VIP Platform.
+	 *
+	 * @private
+	 */
+	public function configure(): void {
 		add_filter( 'wp_parsely_credentials', array( $this, 'wp_parsely_credentials_callback' ) );
+		add_filter( 'wp_parsely_managed_options', array( $this, 'wp_parsely_managed_options_callback' ) );
 	}
 
 	/**
@@ -55,4 +76,24 @@ public function wp_parsely_credentials_callback( $original_credentials ) {
 		// and we have to hide the credential banner warning or more.
 		return array_merge( array( 'is_managed' => true ), $credentials );
 	}
+
+	/**
+	 * Callback for `wp_parsely_managed_options` filter.
+	 *
+	 * @param array $value Value passed to filter.
+	 *
+	 * @return array
+	 */
+	public function wp_parsely_managed_options_callback( $value ) {
+		return array(
+			'force_https_canonicals' => true,
+			'meta_type'              => 'repeated_metas',
+			// Managed options that will obey the values on database.
+			'cats_as_tags'           => null,
+			'content_id_prefix'      => null,
+			'logo'                   => null,
+			'lowercase_tags'         => null,
+			'use_top_level_cats'     => null,
+		);
+	}
 }

integrations/integrations.php

@@ -14,9 +14,9 @@
 	],
 	"plugins": [
 		[ "@babel/plugin-transform-react-jsx", { "pragma": "h", "pragmaFrag": "Fragment" } ],
-		[ "@babel/plugin-proposal-class-properties" ],
-		[ "@babel/plugin-proposal-object-rest-spread", { "loose": true } ],
+		[ "@babel/plugin-transform-class-properties" ],
+		[ "@babel/plugin-transform-object-rest-spread", { "loose": true } ],
 		[ "@babel/plugin-transform-object-assign" ],
-		[ "@babel/plugin-proposal-private-property-in-object" ]
+		[ "@babel/plugin-transform-private-property-in-object" ]
 	]
 }

integrations/parsely.php

@@ -1,8 +1,7 @@
 {
 	"root": true,
-	"plugins": ["@babel"],
 	"extends": [
-		"plugin:@automattic/wpvip/base",
+		"plugin:@automattic/wpvip/javascript",
 		"plugin:@automattic/wpvip/react",
 		"preact"
 	],