Replacing the SEPA legacy constant identifier (#4802)

* Replacing the SEPA legacy constant identifier

* Update includes/constants/class-wc-stripe-payment-methods.php

Co-authored-by: daledupreez <[email protected]>

* Update readme.txt

Co-authored-by: daledupreez <[email protected]>

* Changelog entry update

* Removing unused import

* Removing unused import

---------

Co-authored-by: daledupreez <[email protected]>

Author: wjrosa

changelog.txt

@@ -1,6 +1,7 @@
 *** Changelog ***
 
 = 10.2.0 - xxxx-xx-xx =
+* Dev - Replace the constant reference for the legacy SEPA payment method
 * Update - Changes the list of payment methods shown in the Stripe account connection modal
 * Update - Changes labels related to saved payment methods from "cards" to "payment methods"
 * Fix - Ensure Amazon Pay, Apple Pay, and Google Pay display settings are managed correctly

includes/compat/class-wc-stripe-subscriptions-legacy-sepa-token-update.php

@@ -158,13 +158,13 @@ private function set_subscription_updated_payment_method( WC_Subscription $subsc
 	 */
 	private function set_subscription_updated_payment_gateway_id( WC_Subscription $subscription ) {
 		// The subscription is not using the legacy SEPA gateway ID.
-		if ( WC_Gateway_Stripe_Sepa::ID !== $subscription->get_payment_method() ) {
+		if ( WC_Stripe_Payment_Methods::LEGACY_SEPA !== $subscription->get_payment_method() ) {
 			// phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
 			throw new \Exception( sprintf( '---- Skipping migration of subscription #%d. Subscription is not using the legacy SEPA payment method.', $subscription->get_id() ) );
 		}
 
 		// Add a meta to the subscription to flag that its token got updated.
-		$subscription->update_meta_data( self::LEGACY_TOKEN_PAYMENT_METHOD_META_KEY, WC_Gateway_Stripe_Sepa::ID );
+		$subscription->update_meta_data( self::LEGACY_TOKEN_PAYMENT_METHOD_META_KEY, WC_Stripe_Payment_Methods::LEGACY_SEPA );
 		$subscription->set_payment_method( $this->updated_sepa_gateway_id );
 
 		$subscription->save();

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

@@ -35,6 +35,8 @@ class WC_Stripe_Payment_Methods {
 	const WECHAT_PAY        = 'wechat_pay';
 	const OC                = 'card'; // This is a special case for the Optimized Checkout
 
+	public const LEGACY_SEPA       = 'stripe_sepa'; // Sepa method identifier for the legacy checkout (now removed)
+
 	// Express method constants
 	const AMAZON_PAY = 'amazon_pay';
 	const GOOGLE_PAY = 'google_pay';

includes/migrations/class-wc-stripe-subscriptions-repairer-legacy-sepa-tokens.php

@@ -145,7 +145,7 @@ protected function get_items_to_repair( $page ) {
 				'posts_per_page' => 20,
 				'status'         => 'any',
 				'paged'          => $page,
-				'payment_method' => WC_Gateway_Stripe_Sepa::ID,
+				'payment_method' => WC_Stripe_Payment_Methods::LEGACY_SEPA,
 				'order'          => 'ASC',
 				'orderby'        => 'ID',
 			]
@@ -177,7 +177,7 @@ public function maybe_migrate_before_renewal( $subscription_id ) {
 		}
 
 		// Run the full repair if the subscription is using the Legacy SEPA gateway ID.
-		if ( $subscription->get_payment_method() === WC_Gateway_Stripe_Sepa::ID ) {
+		if ( $subscription->get_payment_method() === WC_Stripe_Payment_Methods::LEGACY_SEPA ) {
 			$this->repair_item( $subscription_id );
 
 			// Unschedule the repair action as it's no longer needed.
@@ -369,7 +369,7 @@ private function has_legacy_sepa_subscriptions() {
 				'type'           => 'shop_subscription',
 				'status'         => 'any',
 				'posts_per_page' => 1,
-				'payment_method' => WC_Gateway_Stripe_Sepa::ID,
+				'payment_method' => WC_Stripe_Payment_Methods::LEGACY_SEPA,
 			]
 		);
 		$subscriptions_count = count( $subscriptions );

includes/payment-tokens/class-wc-stripe-payment-tokens.php

@@ -122,7 +122,7 @@ public static function get_token_from_request( array $request ) {
 	 * @return bool
 	 */
 	public static function customer_has_saved_methods( $customer_id ) {
-		$gateways = [ WC_Stripe_UPE_Payment_Gateway::ID, WC_Gateway_Stripe_Sepa::ID ];
+		$gateways = [ WC_Stripe_UPE_Payment_Gateway::ID, WC_Stripe_Payment_Methods::LEGACY_SEPA ];
 
 		if ( empty( $customer_id ) ) {
 			return false;
@@ -220,7 +220,7 @@ public function woocommerce_get_customer_payment_tokens_legacy( $tokens, $custom
 					}
 				}
 
-				if ( WC_Gateway_Stripe_Sepa::ID === $gateway_id ) {
+				if ( WC_Stripe_Payment_Methods::LEGACY_SEPA === $gateway_id ) {
 					$stripe_customer = new WC_Stripe_Customer( $customer_id );
 					$stripe_sources  = $stripe_customer->get_sources();
 
@@ -229,7 +229,7 @@ public function woocommerce_get_customer_payment_tokens_legacy( $tokens, $custom
 							if ( ! isset( $stored_tokens[ $source->id ] ) ) {
 								$token = new WC_Payment_Token_SEPA();
 								$token->set_token( $source->id );
-								$token->set_gateway_id( WC_Gateway_Stripe_Sepa::ID );
+								$token->set_gateway_id( WC_Stripe_Payment_Methods::LEGACY_SEPA );
 								$token->set_last4( $source->sepa_debit->last4 );
 								$token->set_user_id( $customer_id );
 								if ( isset( $source->sepa_debit->fingerprint ) ) {
@@ -496,7 +496,7 @@ public function woocommerce_payment_token_deleted( $token_id, $token ) {
 				}
 
 				$stripe_customer->detach_payment_method( $token->get_token() );
-			} elseif ( WC_Stripe_UPE_Payment_Gateway::ID === $token->get_gateway_id() || WC_Gateway_Stripe_Sepa::ID === $token->get_gateway_id() ) {
+			} elseif ( WC_Stripe_UPE_Payment_Gateway::ID === $token->get_gateway_id() || WC_Stripe_Payment_Methods::LEGACY_SEPA === $token->get_gateway_id() ) {
 				$stripe_customer->delete_source( $token->get_token() );
 			}
 		} catch ( WC_Stripe_Exception $e ) {

readme.txt

@@ -111,6 +111,7 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 == Changelog ==
 
 = 10.2.0 - xxxx-xx-xx =
+* Dev - Replace the constant reference for the legacy SEPA payment method
 * Update - Changes the list of payment methods shown in the Stripe account connection modal
 * Update - Changes labels related to saved payment methods from "cards" to "payment methods"
 * Fix - Ensure Amazon Pay, Apple Pay, and Google Pay display settings are managed correctly

tests/phpunit/Admin/Migrations/WC_Stripe_Subscriptions_Repairer_Legacy_SEPA_Tokens_Test.php

@@ -4,8 +4,8 @@
 
 use Exception;
 use PHPUnit\Framework\MockObject\MockObject;
+use WC_Stripe_Payment_Methods;
 use WooCommerce\Stripe\Tests\Helpers\UPE_Test_Helper;
-use WC_Gateway_Stripe_Sepa;
 use WC_Logger;
 use WC_Stripe_API;
 use WC_Stripe_Database_Cache;
@@ -68,7 +68,7 @@ class WC_Stripe_Subscriptions_Repairer_Legacy_SEPA_Tokens_Test extends WP_UnitTe
 	 *
 	 * @var string
 	 */
-	private $legacy_sepa_gateway_id = WC_Gateway_Stripe_Sepa::ID;
+	private $legacy_sepa_gateway_id = WC_Stripe_Payment_Methods::LEGACY_SEPA;
 
 	public function set_up() {
 		parent::set_up();

tests/phpunit/Helpers/WC_Helper_Token.php

@@ -3,7 +3,6 @@
 namespace WooCommerce\Stripe\Tests\Helpers;
 
 use WC_Stripe_UPE_Payment_Gateway;
-use WC_Gateway_Stripe_Sepa;
 use WC_Payment_Token_CC;
 use WC_Payment_Token_SEPA;
 use WC_Payment_Tokens;
@@ -42,9 +41,9 @@ public static function create_token( $payment_method, $user_id = null, $gateway
 	 *
 	 * @param string $payment_method Token payment method.
 	 * @param int    $user_id        ID of the token's user, defaults to get_current_user_id().
-	 * @param string $gateway        Token's Gateway ID, default to WC_Gateway_Stripe_Sepa::ID
+	 * @param string $gateway        Token's Gateway ID, default to WC_Stripe_Payment_Methods::LEGACY_SEPA
 	 */
-	public static function create_sepa_token( $payment_method, $user_id = null, $gateway = WC_Gateway_Stripe_Sepa::ID ) {
+	public static function create_sepa_token( $payment_method, $user_id = null, $gateway = WC_Stripe_Payment_Methods::LEGACY_SEPA ) {
 		$token = new WC_Payment_Token_SEPA();
 		$token->set_payment_method_type( WC_Stripe_Payment_Methods::SEPA_DEBIT );
 		$token->set_token( $payment_method );