Update payment_button_request_size upgrade checks (#4307)

* Update payment_button_request_size upgrade checks
* Changelog
* Remove error_log() debugging
* Update and expand existing unit tests
* Remove unnecessary tests

Author: daledupreez

changelog.txt

@@ -3,6 +3,7 @@
 = 9.5.3 - xxxx-xx-xx =
 * Fix - Reimplement mapping of Express Checkout state values to align with WooCommerce's expected state formats
 * Tweak - Track charge completed via webhooks in order notes
+* Fix - Ensure that we migrate payment_request_button_size=medium on upgrade
 
 = 9.5.2 - 2025-05-22 =
 * Add - Implement custom database cache for persistent caching with in-memory optimization.

includes/payment-methods/class-wc-stripe-payment-request.php

@@ -2046,13 +2046,19 @@ private function is_payment_request_enabled() {
 	public function migrate_button_size() {
 		$previous_version = get_option( 'wc_stripe_version' );
 
-		// Exit if it's a new install or the previous version is already 7.8.0 or greater.
-		if ( ! $previous_version || version_compare( $previous_version, '7.8.0', '>=' ) ) {
+		// Exit if it's a new install, or if we don't have a stored button size.
+		if ( ! $previous_version || ! isset( $this->stripe_settings['payment_request_button_size'] ) ) {
 			return;
 		}
 
-		if ( ! isset( $this->stripe_settings['payment_request_button_size'] ) ) {
-			return;
+		$button_size = $this->stripe_settings['payment_request_button_size'];
+
+		// If the previous version is already 7.8.0 or greater, exit unless we have 'medium' as the value.
+		if ( version_compare( $previous_version, '7.8.0', '>=' ) ) {
+			if ( 'medium' !== $button_size ) {
+				return;
+			}
+			// If we have 'medium' as the value, we need to migrate it below.
 		}
 
 		$gateway = woocommerce_gateway_stripe()->get_main_stripe_gateway();
@@ -2061,8 +2067,6 @@ public function migrate_button_size() {
 			return;
 		}
 
-		$button_size = $this->stripe_settings['payment_request_button_size'];
-
 		// If the button was set to the default, it is now the small size (40px). If it was set to medium, it is now the default size (48px).
 		if ( 'default' === $button_size ) {
 			$this->stripe_settings['payment_request_button_size'] = 'small';

readme.txt

@@ -114,5 +114,6 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 
 * Fix - Reimplement mapping of Express Checkout state values to align with WooCommerce's expected state formats
 * Tweak - Track charge completed via webhooks in order notes
+* Fix - Ensure that we migrate payment_request_button_size=medium on upgrade
 
 [See changelog for full details across versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).

tests/phpunit/payment-methods/test-wc-stripe-payment-request.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * These teste make assertions against class WC_Stripe_Payment_Request.
+ * These tests make assertions against class WC_Stripe_Payment_Request.
  *
  * @package WooCommerce_Stripe/Tests/Payment_Request
  */
@@ -208,7 +208,8 @@ public function test_migrate_button_size() {
 		/**
 		 * Migration tests.
 		 *
-		 * Migrating the button size only happens when the plugin is updated from a version pre 7.8.0.
+		 * Migrating the button size only happens when the plugin is updated from a version pre 7.8.0,
+		 * or when the button size is set to 'medium'.
 		 */
 		update_option( 'wc_stripe_version', '7.6.0' );
 
@@ -242,10 +243,46 @@ public function test_migrate_button_size() {
 		$this->pr->migrate_button_size();
 		$this->assertEquals( 'large', $this->pr->stripe_settings['payment_request_button_size'] );
 
-		// Medium => Medium.
+		// Medium => default.
+		$this->pr->stripe_settings = [ 'payment_request_button_size' => 'medium' ];
+		$this->pr->migrate_button_size();
+		$this->assertEquals( 'default', $this->pr->stripe_settings['payment_request_button_size'] );
+
+		// Small => small.
+		$this->pr->stripe_settings = [ 'payment_request_button_size' => 'small' ];
+		$this->pr->migrate_button_size();
+		$this->assertEquals( 'small', $this->pr->stripe_settings['payment_request_button_size'] );
+
+		// Button size not set.
+		$this->pr->stripe_settings = [];
+		$this->pr->migrate_button_size();
+		$this->assertArrayNotHasKey( 'payment_request_button_size', $this->pr->stripe_settings );
+		$this->assertEmpty( $this->pr->stripe_settings );
+
+		/**
+		 * Post-migration tests.
+		 */
+		update_option( 'wc_stripe_version', '9.0.0' );
+
+		// Default => default.
+		$this->pr->stripe_settings = [ 'payment_request_button_size' => 'default' ];
+		$this->pr->migrate_button_size();
+		$this->assertEquals( 'default', $this->pr->stripe_settings['payment_request_button_size'] );
+
+		// Large => large.
+		$this->pr->stripe_settings = [ 'payment_request_button_size' => 'large' ];
+		$this->pr->migrate_button_size();
+		$this->assertEquals( 'large', $this->pr->stripe_settings['payment_request_button_size'] );
+
+		// Medium => default.
 		$this->pr->stripe_settings = [ 'payment_request_button_size' => 'medium' ];
 		$this->pr->migrate_button_size();
-		$this->assertEquals( 'medium', $this->pr->stripe_settings['payment_request_button_size'] );
+		$this->assertEquals( 'default', $this->pr->stripe_settings['payment_request_button_size'] );
+
+		// Small => small.
+		$this->pr->stripe_settings = [ 'payment_request_button_size' => 'small' ];
+		$this->pr->migrate_button_size();
+		$this->assertEquals( 'small', $this->pr->stripe_settings['payment_request_button_size'] );
 
 		// Button size not set.
 		$this->pr->stripe_settings = [];