Add Feature Flag for Development of Progressive Onboarding (#5499)

* Adding changelog entry.

* Added the feature flag, and updated the unit tests.

* Update to use a constant to be more easily refactorable in future.

Author: dmallory42

changelog/dev-5486-po-feature-flag

@@ -0,0 +1,4 @@
+Significance: minor
+Type: dev
+
+Adding a feature flag to allow further development of onboarding UX - currently this will have no effect on live stores.

includes/class-wc-payments-features.php

@@ -17,6 +17,7 @@ class WC_Payments_Features {
 	const WCPAY_SUBSCRIPTIONS_FLAG_NAME     = '_wcpay_feature_subscriptions';
 	const WOOPAY_EXPRESS_CHECKOUT_FLAG_NAME = '_wcpay_feature_woopay_express_checkout';
 	const AUTH_AND_CAPTURE_FLAG_NAME        = '_wcpay_feature_auth_and_capture';
+	const PROGRESSIVE_ONBOARDING_FLAG_NAME  = '_wcpay_feature_progressive_onboarding';
 
 	/**
 	 * Checks whether the UPE gateway is enabled
@@ -164,6 +165,15 @@ public static function is_auth_and_capture_enabled() {
 		return '1' === get_option( self::AUTH_AND_CAPTURE_FLAG_NAME, '1' );
 	}
 
+	/**
+	 * Checks whether Progressive Onboarding is enabled.
+	 *
+	 * @return bool
+	 */
+	public static function is_progressive_onboarding_enabled(): bool {
+		return '1' === get_option( self::PROGRESSIVE_ONBOARDING_FLAG_NAME, '0' );
+	}
+
 	/**
 	 * Returns feature flags as an array suitable for display on the front-end.
 	 *
@@ -182,6 +192,7 @@ public static function to_array() {
 				'clientSecretEncryption'  => self::is_client_secret_encryption_enabled(),
 				'woopayExpressCheckout'   => self::is_woopay_express_checkout_enabled(),
 				'isAuthAndCaptureEnabled' => self::is_auth_and_capture_enabled(),
+				'progressiveOnboarding'   => self::is_progressive_onboarding_enabled(),
 			]
 		);
 	}

tests/unit/test-class-wc-payments-features.php

@@ -5,11 +5,19 @@
  * @package WooCommerce\Payments\Tests
  */
 
+use PHPUnit\Framework\MockObject\MockObject;
+use WCPay\Database_Cache;
+
 /**
  * WC_Payments_Features unit tests.
  */
 class WC_Payments_Features_Test extends WCPAY_UnitTestCase {
 
+	/**
+	 * @var Database_Cache|MockObject
+	 */
+	protected $mock_cache;
+
 	const FLAG_OPTION_NAME_TO_FRONTEND_KEY_MAPPING = [
 		'_wcpay_feature_upe'                        => 'upe',
 		'_wcpay_feature_upe_settings_preview'       => 'upeSettingsPreview',
@@ -18,6 +26,7 @@ class WC_Payments_Features_Test extends WCPAY_UnitTestCase {
 		'_wcpay_feature_account_overview_task_list' => 'accountOverviewTaskList',
 		'_wcpay_feature_custom_deposit_schedules'   => 'customDepositSchedules',
 		'_wcpay_feature_auth_and_capture'           => 'isAuthAndCaptureEnabled',
+		'_wcpay_feature_progressive_onboarding'     => 'progressiveOnboarding',
 	];
 
 	public function set_up() {
@@ -149,7 +158,7 @@ function ( $pre_option, $option, $default ) {
 
 	public function test_is_woopay_express_checkout_enabled_returns_false_when_platform_checkout_eligible_is_false() {
 		add_filter(
-			'pre_option__wcpay_feature_woopay_express_checkout',
+			'pre_option__' . WC_Payments_Features::PROGRESSIVE_ONBOARDING_FLAG_NAME,
 			function ( $pre_option, $option, $default ) {
 				return '1';
 			},
@@ -160,6 +169,35 @@ function ( $pre_option, $option, $default ) {
 		$this->assertFalse( WC_Payments_Features::is_woopay_express_checkout_enabled() );
 	}
 
+	public function test_is_progressive_onboarding_enabled_returns_true() {
+		add_filter(
+			'pre_option_' . WC_Payments_Features::PROGRESSIVE_ONBOARDING_FLAG_NAME,
+			function ( $pre_option, $option, $default ) {
+				return '1';
+			},
+			10,
+			3
+		);
+		$this->assertTrue( WC_Payments_Features::is_progressive_onboarding_enabled() );
+	}
+
+	public function test_is_progressive_onboarding_enabled_returns_false_when_flag_is_false() {
+		add_filter(
+			'pre_option_' . WC_Payments_Features::PROGRESSIVE_ONBOARDING_FLAG_NAME,
+			function ( $pre_option, $option, $default ) {
+				return '0';
+			},
+			10,
+			3
+		);
+		$this->assertFalse( WC_Payments_Features::is_progressive_onboarding_enabled() );
+		$this->assertArrayNotHasKey( 'progressiveOnboarding', WC_Payments_Features::to_array() );
+	}
+
+	public function test_is_progressive_onboarding_enabled_returns_false_when_flag_is_not_set() {
+		$this->assertFalse( WC_Payments_Features::is_progressive_onboarding_enabled() );
+	}
+
 	private function setup_enabled_flags( array $enabled_flags ) {
 		foreach ( array_keys( self::FLAG_OPTION_NAME_TO_FRONTEND_KEY_MAPPING ) as $flag ) {
 			add_filter(