Disable OC when PMC is disabled (#4444)

* Disable OC when PMC is disabled

* Unit test

* Moving PMC enabled condition out of the feature flags class

* Revert test changes

* Fix tests

* Improving test readability

* Fix OC source of truth

* Fix tests

* Improving tests

* Improving tests

* Improving tests

* Improving tests

* Improving tests

* New helper to test OC related methods

* Remove unused import

* Renaming some variables to keep consistency

* Fix tests

* Changelog and reame entries

* Unit tests

* Fix tests

* New test helper for PMC

* Moving the PMC check inside the feature flag method again

* Removing unnecessary import

* Fix tests

* Fix changelog entries

* Fix tests

Author: wjrosa

changelog.txt

@@ -1,6 +1,7 @@
 *** Changelog ***
 
 = 9.6.0 - xxxx-xx-xx =
+* Fix - Fixes some inconsistencies related to the Optimized Checkout feature and improves its unit tests
 * Add - Introduces a new marketing note to promote BNPLs (Buy Now Pay Later) payment methods (Klarna and Affirm) on WooCommerce admin home page
 * Fix - Fixes some inconsistencies related to the Optimized Checkout feature and improves its unit tests
 * Fix - Throws a specific exception on an edge case where a saved payment method could not be found when processing an order in the new checkout experience

includes/class-wc-stripe-feature-flags.php

@@ -192,11 +192,14 @@ public static function is_spe_available() {
 	 * @return bool
 	 */
 	public static function is_oc_available() {
-		$default_value = self::get_option_with_default( self::OC_FEATURE_FLAG_NAME );
+		$default_value   = self::get_option_with_default( self::OC_FEATURE_FLAG_NAME );
+		$stripe_settings = WC_Stripe_Helper::get_stripe_settings();
+		$pmc_enabled     = $stripe_settings['pmc_enabled'] ?? 'no';
 		return apply_filters(
 			'wc_stripe_is_optimized_checkout_available',
-			'yes' === $default_value,
-			$default_value
+			'yes' === $default_value && 'yes' === $pmc_enabled,
+			$default_value,
+			$pmc_enabled
 		);
 	}
 }

readme.txt

@@ -112,6 +112,7 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 
 = 9.6.0 - xxxx-xx-xx =
 
+* Fix - Fixes some inconsistencies related to the Optimized Checkout feature and improves its unit tests
 * Add - Introduces a new marketing note to promote BNPLs (Buy Now Pay Later) payment methods (Klarna and Affirm) on WooCommerce admin home page
 * Fix - Fixes some inconsistencies related to the Optimized Checkout feature and improves its unit tests
 * Fix - Throws a specific exception on an edge case where a saved payment method could not be found when processing an order in the new checkout experience

tests/e2e/bin/setup.sh

@@ -135,7 +135,7 @@ echo " - Activating plugin"
 redirect_output cli wp plugin activate woocommerce-gateway-stripe
 
 echo " - Updating WooCommerce Gateway Stripe settings"
-redirect_output cli wp option update woocommerce_stripe_settings --format=json "{\"enabled\":\"yes\",\"title\":\"Credit Card (Stripe)\",\"description\":\"Pay with your credit card via Stripe.\",\"api_credentials\":\"\",\"testmode\":\"yes\",\"test_publishable_key\":\"${STRIPE_PUB_KEY}\",\"test_secret_key\":\"${STRIPE_SECRET_KEY}\",\"publishable_key\":\"\",\"secret_key\":\"\",\"webhook\":\"\",\"test_webhook_secret\":\"\",\"webhook_secret\":\"\",\"inline_cc_form\":\"no\",\"statement_descriptor\":\"\",\"short_statement_descriptor\":\"\",\"capture\":\"yes\",\"payment_request\":\"yes\",\"payment_request_button_type\":\"buy\",\"payment_request_button_theme\":\"dark\",\"payment_request_button_locations\":[\"product\",\"cart\",\"checkout\"],\"payment_request_button_size\":\"default\",\"saved_cards\":\"yes\",\"logging\":\"no\",\"upe_checkout_experience_enabled\":\"yes\"}"
+redirect_output cli wp option update woocommerce_stripe_settings --format=json "{\"enabled\":\"yes\",\"title\":\"Credit Card (Stripe)\",\"description\":\"Pay with your credit card via Stripe.\",\"api_credentials\":\"\",\"testmode\":\"yes\",\"test_publishable_key\":\"${STRIPE_PUB_KEY}\",\"test_secret_key\":\"${STRIPE_SECRET_KEY}\",\"publishable_key\":\"\",\"secret_key\":\"\",\"webhook\":\"\",\"test_webhook_secret\":\"\",\"webhook_secret\":\"\",\"inline_cc_form\":\"no\",\"statement_descriptor\":\"\",\"short_statement_descriptor\":\"\",\"capture\":\"yes\",\"payment_request\":\"yes\",\"payment_request_button_type\":\"buy\",\"payment_request_button_theme\":\"dark\",\"payment_request_button_locations\":[\"product\",\"cart\",\"checkout\"],\"payment_request_button_size\":\"default\",\"saved_cards\":\"yes\",\"logging\":\"no\",\"upe_checkout_experience_enabled\":\"yes\",\"test_connection_type\":\"connect\"}"
 
 echo " - Enabling the ACH feature flag"
 redirect_output cli wp option update _wcstripe_feature_lpm_ach 'yes'

tests/phpunit/Helpers/PMC_Test_Helper.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace WooCommerce\Stripe\Tests\Helpers;
+
+use WC_Stripe_Database_Cache;
+use WC_Stripe_Helper;
+use WC_Stripe_Payment_Method_Configurations;
+use WC_Stripe_Payment_Methods;
+
+/**
+ * Provides useful methods to test logic related to the Payment Method Configuration API.
+ */
+class PMC_Test_Helper {
+	/**
+	 * Enables the Payment Method Configuration API for testing purposes.
+	 *
+	 * @return void
+	 */
+	public static function enable_pmc() {
+		$stripe_settings                = WC_Stripe_Helper::get_stripe_settings();
+		$stripe_settings['pmc_enabled'] = 'yes';
+		WC_Stripe_Helper::update_main_stripe_settings( $stripe_settings );
+	}
+
+	/**
+	 * Disables the Payment Method Configuration API for testing purposes.
+	 *
+	 * @return void
+	 */
+	public static function disable_pmc() {
+		$stripe_settings                = WC_Stripe_Helper::get_stripe_settings();
+		$stripe_settings['pmc_enabled'] = 'no';
+		WC_Stripe_Helper::update_main_stripe_settings( $stripe_settings );
+	}
+
+	/**
+	 * Caches a mocked payment method configuration for testing purposes.
+	 *
+	 * @return void
+	 */
+	public static function cache_mocked_configuration() {
+		$payment_method_configuration = [
+			'id'                            => 'pmc_abcdef',
+			'object'                        => 'payment_method_configuration',
+			'active'                        => true,
+			'parent'                        => WC_Stripe_Payment_Method_Configurations::TEST_MODE_CONFIGURATION_PARENT_ID,
+			'livemode'                      => false,
+			WC_Stripe_Payment_Methods::CARD => (object) [
+				'display_preference' => (object) [ 'value' => 'on' ],
+			],
+		];
+		WC_Stripe_Database_Cache::set( WC_Stripe_Payment_Method_Configurations::CONFIGURATION_CACHE_KEY, $payment_method_configuration );
+	}
+
+	/**
+	 * Deletes the cached payment method configuration for testing purposes.
+	 *
+	 * @return void
+	 */
+	public static function delete_cached_configuration() {
+		WC_Stripe_Database_Cache::delete( WC_Stripe_Payment_Method_Configurations::CONFIGURATION_CACHE_KEY );
+	}
+}

tests/phpunit/PaymentMethods/WC_Stripe_UPE_Payment_Gateway_Test.php

@@ -5,6 +5,9 @@
 use Automattic\WooCommerce\Enums\OrderStatus;
 use Exception;
 use WooCommerce\Stripe\Tests\Helpers\OC_Test_Helper;
+use WC_Stripe_Database_Cache;
+use WC_Stripe_Payment_Method_Configurations;
+use WooCommerce\Stripe\Tests\Helpers\PMC_Test_Helper;
 use WooCommerce\Stripe\Tests\Helpers\UPE_Test_Helper;
 use WC_Data_Exception;
 use WC_Order;
@@ -2893,13 +2896,21 @@ public function payment_method_titles_provider() {
 	/**
 	 * Test that a failed payment intent is not reused and a new one is created instead.
 	 *
+	 * @param bool $pmc_enabled Whether the payment method configurations are enabled.
 	 * @param bool $setting_enabled Whether the optimized checkout setting is enabled.
 	 * @param bool $expected The expected result of the `is_oc_enabled` method.
 	 * @return void
 	 *
 	 * @dataProvider provide_test_is_oc_enabled
 	 */
-	public function test_is_oc_enabled( $setting_enabled, $expected ) {
+	public function test_is_oc_enabled( $pmc_enabled, $setting_enabled, $expected ) {
+		if ( $pmc_enabled ) {
+			PMC_Test_Helper::enable_pmc();
+
+			// Mock the payment method configuration for the test, to avoid it being disabled by default.
+			PMC_Test_Helper::cache_mocked_configuration();
+		}
+
 		if ( $setting_enabled ) {
 			OC_Test_Helper::enable_oc();
 		}
@@ -2908,6 +2919,8 @@ public function test_is_oc_enabled( $setting_enabled, $expected ) {
 		$actual  = $gateway->is_oc_enabled();
 
 		// Clean up
+		PMC_Test_Helper::disable_pmc();
+		PMC_Test_Helper::delete_cached_configuration();
 		OC_Test_Helper::disable_oc();
 
 		$this->assertSame( $expected, $actual );
@@ -2920,13 +2933,20 @@ public function test_is_oc_enabled( $setting_enabled, $expected ) {
 	 */
 	public function provide_test_is_oc_enabled() {
 		return [
-			'Disabled' => [
+			'Disabled (all disabled)' => [
+				'pmc enabled'   => false,
+				'setting value' => false,
+				'expected'      => false,
+			],
+			'Disabled (pmc enabled)'  => [
+				'pmc enabled'   => true,
 				'setting value' => false,
 				'expected'      => false,
 			],
-			'Enabled'  => [
+			'Enabled'                 => [
+				'pmc enabled'   => true,
 				'setting value' => true,
-				'expected'     => true,
+				'expected'      => true,
 			],
 		];
 	}

tests/phpunit/PaymentMethods/WC_Stripe_UPE_Payment_Method_Test.php

@@ -13,8 +13,10 @@
 use WC_Payment_Token_SEPA;
 use WC_Stripe;
 use WC_Stripe_Currency_Code;
+use WC_Stripe_Database_Cache;
 use WC_Stripe_Feature_Flags;
 use WC_Stripe_Helper;
+use WC_Stripe_Payment_Method_Configurations;
 use WC_Stripe_Payment_Methods;
 use WC_Stripe_Payment_Token_CC;
 use WC_Stripe_UPE_Payment_Gateway;
@@ -28,6 +30,7 @@
 use WC_Stripe_UPE_Payment_Method_Link;
 use WC_Stripe_UPE_Payment_Method_Wechat_Pay;
 use WooCommerce\Stripe\Tests\Helpers\OC_Test_Helper;
+use WooCommerce\Stripe\Tests\Helpers\PMC_Test_Helper;
 use WooCommerce\Stripe\Tests\WC_Mock_Stripe_API_Unit_Test_Case;
 
 /**
@@ -867,6 +870,10 @@ public function test_payment_methods_support_custom_name_and_description() {
 		$updated_payment_settings['description'] = $custom_description;
 		update_option( 'woocommerce_stripe_' . $payment_method_id . '_settings', $updated_payment_settings );
 
+		PMC_Test_Helper::enable_pmc();
+		// Mock the payment method configuration for the test, to avoid it being disabled by default.
+		PMC_Test_Helper::cache_mocked_configuration();
+
 		$mocked_payment_method = $this->getMockBuilder( WC_Stripe_UPE_Payment_Method_CC::class )
 			->setMethods(
 				[
@@ -883,6 +890,8 @@ public function test_payment_methods_support_custom_name_and_description() {
 
 		// Clean up.
 		OC_Test_Helper::disable_oc();
+		PMC_Test_Helper::disable_pmc();
+		PMC_Test_Helper::delete_cached_configuration();
 		update_option( 'woocommerce_stripe_' . $payment_method_id . '_settings', $original_payment_settings );
 
 		$this->assertEmpty( $actual );

tests/phpunit/WC_Stripe_Payment_Gateway_Test.php

@@ -10,7 +10,6 @@
 use WC_Stripe_Exception;
 use WC_Stripe_Helper;
 use WooCommerce\Stripe\Tests\Helpers\OC_Test_Helper;
-use WooCommerce\Stripe\Tests\Helpers\OCTest_Helper;
 use WooCommerce\Stripe\Tests\Helpers\WC_Helper_Order;
 use WP_Error;
 use WP_UnitTestCase;