Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix syncing of local tokens with remote payment methods #2897

Merged
merged 8 commits into from
Feb 19, 2024
Merged

Fix syncing of local tokens with remote payment methods #2897

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
cb59f4f
Refactor deleting local payment methods that don't exist in Stripe
a-danae Feb 7, 2024
b5ee889
Create tokens for payment methods missing locally
a-danae Feb 7, 2024
5590f4d
Handle exceptions when creating and deleting payment methods
a-danae Feb 7, 2024
c1257be
Add missing variable for the payment method type
a-danae Feb 8, 2024
70ae700
Bail out early when the token doesn't belong to our reusable payment …
a-danae Feb 15, 2024
2aada62
Retrieve the main gateway instance through WC_Stripe::get_main_stripe…
a-danae Feb 19, 2024
207d567
Remove unused WC_Stripe_Payment_Tokens::get_original_payment_method_t…
a-danae Feb 19, 2024
6c503dc
Merge branch 'add/deferred-intent' into fix/tokens-syncing
a-danae Feb 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 77 additions & 63 deletions includes/class-wc-stripe-payment-tokens.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,65 +250,99 @@ public function woocommerce_get_customer_upe_payment_tokens( $tokens, $user_id,
return $tokens;
}

$gateway = WC_Stripe::get_instance()->get_main_stripe_gateway();
$upe_gateway = null;
try {
$gateway = WC_Stripe::get_instance()->get_main_stripe_gateway();
$customer = new WC_Stripe_Customer( $user_id );

foreach ( $gateway->payment_methods as $payment_gateway ) {
if ( $payment_gateway->id === $gateway_id ) {
$upe_gateway = $payment_gateway;
break;
}
}
// Payment methods that exist in Stripe.
$stripe_payment_methods = [];
$stripe_payment_methods_ids = [];

if ( ! $upe_gateway || ! $upe_gateway->is_reusable() ) {
return $tokens;
}
// List of the types already retrieved to avoid pulling redundant information.
$types_retrieved_from_stripe = [];

$customer = new WC_Stripe_Customer( $user_id );
$current_tokens = [];
// IDs of the payment methods that exist locally.
$locally_stored_payment_methods_ids = [];

foreach ( $tokens as $token ) {
// Store relevant existing tokens here.
// We will use this list to check whether these methods still exist on Stripe's side.
$current_tokens[ $token->get_token() ] = $token;
}
// 1. Check if there's any discrepancy between the locally saved payment methods and those saved on Stripe's side.
// 2. If local payment methods are not found on Stripe's side, delete them.
// 3. If payment methods are found on Stripe's side but not locally, create them.
foreach ( $tokens as $token ) {
$token_gateway_id = $token->get_gateway_id();

try {
// If this UPE method uses a different payment method type as a token, we don't want to retrieve tokens for it. ie Bancontact uses SEPA tokens.
$payment_methods = $customer->get_payment_methods( $upe_gateway->get_retrievable_type() );
// The gateway ID of the token doesn't belong to our gateways.
if ( ! in_array( $token_gateway_id, self::UPE_REUSABLE_GATEWAYS, true ) ) {
continue;
}

// Prevent unnecessary recursion, WC_Payment_Token::save() ends up calling 'woocommerce_get_customer_payment_tokens' in some cases.
remove_action( 'woocommerce_get_customer_payment_tokens', [ $this, 'woocommerce_get_customer_payment_tokens' ], 10, 3 );
$payment_method_type = $this->get_payment_method_type_from_token( $token );

foreach ( $payment_methods as $payment_method ) {
if ( ! isset( $current_tokens[ $payment_method->id ] ) ) {
$payment_method_type = $this->get_original_payment_method_type( $payment_method );
// The payment method type doesn't match the ones we use. Nothing to do here.
if ( ! isset( $gateway->payment_methods[ $payment_method_type ] ) ) {
continue;
}

if ( $payment_method_type !== $upe_gateway::STRIPE_ID ) {
continue;
}
$payment_method_instance = $gateway->payment_methods[ $payment_method_type ];
$payment_method_instance_id = $payment_method_instance->id;

// Create new token for new payment method and add to list.
$token = $upe_gateway->create_payment_token_for_user( $user_id, $payment_method );
$tokens[ $token->get_id() ] = $token;
// Card tokens are the only ones expected to have a mismatch between the token's gateway ID and the payment method instance ID.
if (
'stripe_card' === $token_gateway_id &&
'card' !== $payment_method_instance_id &&
$token_gateway_id !== $payment_method_instance_id
) {
continue;
}

// Don't display the payment method if the gateway isn't enabled.
if ( ! $payment_method_instance->is_enabled() ) {
unset( $tokens[ $token->get_id() ] );
continue;
}

// Get the slug for the payment method type expected by the Stripe API.
$payment_method_retrievable_type = $payment_method_instance->get_retrievable_type();

// Avoid redundancy by only processing the payment methods for each type once.
if ( ! in_array( $payment_method_retrievable_type, $types_retrieved_from_stripe, true ) ) {

$payment_methods_for_type = $customer->get_payment_methods( $payment_method_retrievable_type );
$stripe_payment_methods = array_merge( $stripe_payment_methods, $payment_methods_for_type );
$stripe_payment_methods_ids = array_merge( $stripe_payment_methods_ids, wp_list_pluck( $payment_methods_for_type, 'id' ) );

$types_retrieved_from_stripe[] = $payment_method_retrievable_type;
}

// Delete the local payment method if it doesn't exist in Stripe.
if ( ! in_array( $token->get_token(), $stripe_payment_methods_ids, true ) ) {
unset( $tokens[ $token->get_id() ] );

// Prevent unnecessary recursion when deleting tokens.
remove_action( 'woocommerce_payment_token_deleted', [ $this, 'woocommerce_payment_token_deleted' ], 10, 2 );

$token->delete();

add_action( 'woocommerce_payment_token_deleted', [ $this, 'woocommerce_payment_token_deleted' ], 10, 2 );
} else {
// Count that existing token for payment method is still present on Stripe.
// Remaining IDs in $remaining_tokens no longer exist with Stripe and will be eliminated.
unset( $current_tokens[ $payment_method->id ] );
$locally_stored_payment_methods_ids[] = $token->get_token();
}
}

add_action( 'woocommerce_get_customer_payment_tokens', [ $this, 'woocommerce_get_customer_payment_tokens' ], 10, 3 );
// Prevent unnecessary recursion, WC_Payment_Token::save() ends up calling 'woocommerce_get_customer_payment_tokens' in some cases.
remove_action( 'woocommerce_get_customer_payment_tokens', [ $this, 'woocommerce_get_customer_payment_tokens' ], 10, 3 );

// Create a local payment method if it exists in Stripe but not locally.
foreach ( $stripe_payment_methods as $stripe_payment_method ) {

// Eliminate remaining payment methods no longer known by Stripe.
// Prevent unnecessary recursion, when deleting tokens.
remove_action( 'woocommerce_payment_token_deleted', [ $this, 'woocommerce_payment_token_deleted' ], 10, 2 );
// Create a new token for the payment method and add it to the list.
if ( ! in_array( $stripe_payment_method->id, $locally_stored_payment_methods_ids, true ) ) {
$token = $payment_method_instance->create_payment_token_for_user( $user_id, $stripe_payment_method );

foreach ( $current_tokens as $token ) {
unset( $tokens[ $token->get_id() ] );
$token->delete();
$tokens[ $token->get_id() ] = $token;
}
}
add_action( 'woocommerce_payment_token_deleted', [ $this, 'woocommerce_payment_token_deleted' ], 10, 2 );

add_action( 'woocommerce_get_customer_payment_tokens', [ $this, 'woocommerce_get_customer_payment_tokens' ], 10, 3 );

} catch ( WC_Stripe_Exception $e ) {
wc_add_notice( $e->getLocalizedMessage(), 'error' );
Expand All @@ -318,26 +352,6 @@ public function woocommerce_get_customer_upe_payment_tokens( $tokens, $user_id,
return $tokens;
}

/**
* Returns original type of payment method from Stripe payment method response,
* after checking whether payment method is SEPA method generated from another type.
*
* @param object $payment_method Stripe payment method JSON object.
*
* @return string Payment method type/ID
*/
private function get_original_payment_method_type( $payment_method ) {
if ( WC_Stripe_UPE_Payment_Method_Sepa::STRIPE_ID === $payment_method->type ) {
if ( ! is_null( $payment_method->sepa_debit->generated_from->charge ) ) {
return $payment_method->sepa_debit->generated_from->charge->payment_method_details->type;
}
if ( ! is_null( $payment_method->sepa_debit->generated_from->setup_attempt ) ) {
return $payment_method->sepa_debit->generated_from->setup_attempt->payment_method_details->type;
}
}
return $payment_method->type;
}

/**
* Returns original Stripe payment method type from payment token
*
Expand Down
Loading