Create order and redirect when no order

This commit is contained in:
Alex P 2023-11-14 10:55:30 +02:00
parent 5c699c24a5
commit a61e9303e9
No known key found for this signature in database
GPG key ID: 54487A734A204D71
10 changed files with 214 additions and 131 deletions

View file

@ -142,7 +142,8 @@ return array(
$container->get( 'wcgateway.settings.allow_card_button_gateway.default' ),
$container->get( 'onboarding.environment' ),
$container->get( 'vaulting.repository.payment-token' ),
$container->get( 'woocommerce.logger.woocommerce' )
$container->get( 'woocommerce.logger.woocommerce' ),
$container->get( 'api.factory.paypal-checkout-url' )
);
},
'wcgateway.disabler' => static function ( ContainerInterface $container ): DisableGateways {
@ -346,7 +347,10 @@ return array(
$logger,
$environment,
$subscription_helper,
$order_helper
$order_helper,
$container->get( 'api.factory.purchase-unit' ),
$container->get( 'api.factory.payer' ),
$container->get( 'api.factory.shipping-preference' )
);
},
'wcgateway.processor.refunds' => static function ( ContainerInterface $container ): RefundProcessor {

View file

@ -85,14 +85,14 @@ class ReturnUrlEndpoint {
// phpcs:enable WordPress.Security.NonceVerification.Recommended
$order = $this->order_endpoint->order( $token );
$this->session_handler->replace_order( $order );
$wc_order_id = (int) $order->purchase_units()[0]->custom_id();
if ( ! $wc_order_id ) {
// We cannot finish processing here without WC order, but at least go into the continuation mode.
if ( $order->status()->is( OrderStatus::APPROVED )
|| $order->status()->is( OrderStatus::COMPLETED )
) {
$this->session_handler->replace_order( $order );
wp_safe_redirect( wc_get_checkout_url() );
exit();
}

View file

@ -0,0 +1,18 @@
<?php
/**
* Thrown when there is no PayPal order during WC order processing.
*
* @package WooCommerce\PayPalCommerce\WcGateway\Exception
*/
declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\WcGateway\Exception;
use Exception;
/**
* Class PayPalOrderMissingException
*/
class PayPalOrderMissingException extends Exception {
}

View file

@ -21,6 +21,7 @@ use WooCommerce\PayPalCommerce\Subscription\FreeTrialHandlerTrait;
use WooCommerce\PayPalCommerce\Subscription\Helper\SubscriptionHelper;
use WooCommerce\PayPalCommerce\Vaulting\PaymentTokenRepository;
use WooCommerce\PayPalCommerce\WcGateway\Exception\GatewayGenericException;
use WooCommerce\PayPalCommerce\WcGateway\Exception\PayPalOrderMissingException;
use WooCommerce\PayPalCommerce\WcGateway\Processor\OrderProcessor;
use WooCommerce\PayPalCommerce\WcGateway\Processor\RefundProcessor;
use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface;
@ -126,21 +127,29 @@ class CardButtonGateway extends \WC_Payment_Gateway {
*/
private $logger;
/**
* The function return the PayPal checkout URL for the given order ID.
*
* @var callable(string):string
*/
private $paypal_checkout_url_factory;
/**
* CardButtonGateway constructor.
*
* @param SettingsRenderer $settings_renderer The Settings Renderer.
* @param OrderProcessor $order_processor The Order Processor.
* @param ContainerInterface $config The settings.
* @param SessionHandler $session_handler The Session Handler.
* @param RefundProcessor $refund_processor The Refund Processor.
* @param State $state The state.
* @param TransactionUrlProvider $transaction_url_provider Service providing transaction view URL based on order.
* @param SubscriptionHelper $subscription_helper The subscription helper.
* @param bool $default_enabled Whether the gateway should be enabled by default.
* @param Environment $environment The environment.
* @param PaymentTokenRepository $payment_token_repository The payment token repository.
* @param LoggerInterface $logger The logger.
* @param SettingsRenderer $settings_renderer The Settings Renderer.
* @param OrderProcessor $order_processor The Order Processor.
* @param ContainerInterface $config The settings.
* @param SessionHandler $session_handler The Session Handler.
* @param RefundProcessor $refund_processor The Refund Processor.
* @param State $state The state.
* @param TransactionUrlProvider $transaction_url_provider Service providing transaction view URL based on order.
* @param SubscriptionHelper $subscription_helper The subscription helper.
* @param bool $default_enabled Whether the gateway should be enabled by default.
* @param Environment $environment The environment.
* @param PaymentTokenRepository $payment_token_repository The payment token repository.
* @param LoggerInterface $logger The logger.
* @param callable(string):string $paypal_checkout_url_factory The function return the PayPal checkout URL for the given order ID.
*/
public function __construct(
SettingsRenderer $settings_renderer,
@ -154,22 +163,24 @@ class CardButtonGateway extends \WC_Payment_Gateway {
bool $default_enabled,
Environment $environment,
PaymentTokenRepository $payment_token_repository,
LoggerInterface $logger
LoggerInterface $logger,
callable $paypal_checkout_url_factory
) {
$this->id = self::ID;
$this->settings_renderer = $settings_renderer;
$this->order_processor = $order_processor;
$this->config = $config;
$this->session_handler = $session_handler;
$this->refund_processor = $refund_processor;
$this->state = $state;
$this->transaction_url_provider = $transaction_url_provider;
$this->subscription_helper = $subscription_helper;
$this->default_enabled = $default_enabled;
$this->environment = $environment;
$this->onboarded = $state->current_state() === State::STATE_ONBOARDED;
$this->payment_token_repository = $payment_token_repository;
$this->logger = $logger;
$this->id = self::ID;
$this->settings_renderer = $settings_renderer;
$this->order_processor = $order_processor;
$this->config = $config;
$this->session_handler = $session_handler;
$this->refund_processor = $refund_processor;
$this->state = $state;
$this->transaction_url_provider = $transaction_url_provider;
$this->subscription_helper = $subscription_helper;
$this->default_enabled = $default_enabled;
$this->environment = $environment;
$this->onboarded = $state->current_state() === State::STATE_ONBOARDED;
$this->payment_token_repository = $payment_token_repository;
$this->logger = $logger;
$this->paypal_checkout_url_factory = $paypal_checkout_url_factory;
$this->supports = array(
'refunds',
@ -294,18 +305,20 @@ class CardButtonGateway extends \WC_Payment_Gateway {
//phpcs:enable WordPress.Security.NonceVerification.Recommended
try {
if ( ! $this->order_processor->process( $wc_order ) ) {
return $this->handle_payment_failure(
$wc_order,
new Exception(
$this->order_processor->last_error()
)
try {
$this->order_processor->process( $wc_order );
do_action( 'woocommerce_paypal_payments_before_handle_payment_success', $wc_order );
return $this->handle_payment_success( $wc_order );
} catch ( PayPalOrderMissingException $exc ) {
$order = $this->order_processor->create_order( $wc_order );
return array(
'result' => 'success',
'redirect' => ( $this->paypal_checkout_url_factory )( $order->id() ),
);
}
do_action( 'woocommerce_paypal_payments_before_handle_payment_success', $wc_order );
return $this->handle_payment_success( $wc_order );
} catch ( PayPalApiException $error ) {
return $this->handle_payment_failure(
$wc_order,
@ -315,7 +328,7 @@ class CardButtonGateway extends \WC_Payment_Gateway {
$error
)
);
} catch ( RuntimeException $error ) {
} catch ( Exception $error ) {
return $this->handle_payment_failure( $wc_order, $error );
}
}

View file

@ -387,14 +387,7 @@ class CreditCardGateway extends \WC_Payment_Gateway_CC {
//phpcs:enable WordPress.Security.NonceVerification.Recommended
try {
if ( ! $this->order_processor->process( $wc_order ) ) {
return $this->handle_payment_failure(
$wc_order,
new Exception(
$this->order_processor->last_error()
)
);
}
$this->order_processor->process( $wc_order );
do_action( 'woocommerce_paypal_payments_before_handle_payment_success', $wc_order );
@ -408,7 +401,7 @@ class CreditCardGateway extends \WC_Payment_Gateway_CC {
$error
)
);
} catch ( RuntimeException $error ) {
} catch ( Exception $error ) {
return $this->handle_payment_failure( $wc_order, $error );
}
}

View file

@ -24,6 +24,7 @@ use WooCommerce\PayPalCommerce\Subscription\FreeTrialHandlerTrait;
use WooCommerce\PayPalCommerce\Subscription\Helper\SubscriptionHelper;
use WooCommerce\PayPalCommerce\Vaulting\PaymentTokenRepository;
use WooCommerce\PayPalCommerce\WcGateway\Exception\GatewayGenericException;
use WooCommerce\PayPalCommerce\WcGateway\Exception\PayPalOrderMissingException;
use WooCommerce\PayPalCommerce\WcGateway\FundingSource\FundingSourceRenderer;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayUponInvoice\PayUponInvoiceGateway;
use WooCommerce\PayPalCommerce\WcGateway\Processor\OrderMetaTrait;
@ -556,19 +557,20 @@ class PayPalGateway extends \WC_Payment_Gateway {
return $this->handle_payment_success( $wc_order );
}
try {
$this->order_processor->process( $wc_order );
if ( ! $this->order_processor->process( $wc_order ) ) {
return $this->handle_payment_failure(
$wc_order,
new Exception(
$this->order_processor->last_error()
)
do_action( 'woocommerce_paypal_payments_before_handle_payment_success', $wc_order );
return $this->handle_payment_success( $wc_order );
} catch ( PayPalOrderMissingException $exc ) {
$order = $this->order_processor->create_order( $wc_order );
return array(
'result' => 'success',
'redirect' => ( $this->paypal_checkout_url_factory )( $order->id() ),
);
}
do_action( 'woocommerce_paypal_payments_before_handle_payment_success', $wc_order );
return $this->handle_payment_success( $wc_order );
} catch ( PayPalApiException $error ) {
$retry_keys_messages = array(
'INSTRUMENT_DECLINED' => __( 'Instrument declined.', 'woocommerce-paypal-payments' ),
@ -617,7 +619,7 @@ class PayPalGateway extends \WC_Payment_Gateway {
$error
)
);
} catch ( RuntimeException $error ) {
} catch ( Exception $error ) {
return $this->handle_payment_failure( $wc_order, $error );
}
}

View file

@ -9,19 +9,25 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\WcGateway\Processor;
use Exception;
use Psr\Log\LoggerInterface;
use WC_Order;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
use WooCommerce\PayPalCommerce\ApiClient\Entity\ApplicationContext;
use WooCommerce\PayPalCommerce\ApiClient\Entity\Order;
use WooCommerce\PayPalCommerce\ApiClient\Entity\OrderStatus;
use WooCommerce\PayPalCommerce\ApiClient\Exception\RuntimeException;
use WooCommerce\PayPalCommerce\ApiClient\Factory\OrderFactory;
use WooCommerce\PayPalCommerce\ApiClient\Factory\PayerFactory;
use WooCommerce\PayPalCommerce\ApiClient\Factory\PurchaseUnitFactory;
use WooCommerce\PayPalCommerce\ApiClient\Factory\ShippingPreferenceFactory;
use WooCommerce\PayPalCommerce\ApiClient\Helper\OrderHelper;
use WooCommerce\PayPalCommerce\Button\Helper\ThreeDSecure;
use WooCommerce\PayPalCommerce\Onboarding\Environment;
use WooCommerce\PayPalCommerce\Session\SessionHandler;
use WooCommerce\PayPalCommerce\Subscription\Helper\SubscriptionHelper;
use WooCommerce\PayPalCommerce\Vaulting\PaymentTokenRepository;
use WooCommerce\PayPalCommerce\WcGateway\Exception\PayPalOrderMissingException;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayPalGateway;
use WooCommerce\PayPalCommerce\WcGateway\Settings\Settings;
@ -88,13 +94,6 @@ class OrderProcessor {
*/
private $settings;
/**
* The last error.
*
* @var string
*/
private $last_error = '';
/**
* A logger.
*
@ -116,6 +115,27 @@ class OrderProcessor {
*/
private $order_helper;
/**
* The PurchaseUnit factory.
*
* @var PurchaseUnitFactory
*/
private $purchase_unit_factory;
/**
* The payer factory.
*
* @var PayerFactory
*/
private $payer_factory;
/**
* The shipping_preference factory.
*
* @var ShippingPreferenceFactory
*/
private $shipping_preference_factory;
/**
* Array to store temporary order data changes to restore after processing.
*
@ -136,6 +156,9 @@ class OrderProcessor {
* @param Environment $environment The environment.
* @param SubscriptionHelper $subscription_helper The subscription helper.
* @param OrderHelper $order_helper The order helper.
* @param PurchaseUnitFactory $purchase_unit_factory The PurchaseUnit factory.
* @param PayerFactory $payer_factory The payer factory.
* @param ShippingPreferenceFactory $shipping_preference_factory The shipping_preference factory.
*/
public function __construct(
SessionHandler $session_handler,
@ -147,7 +170,10 @@ class OrderProcessor {
LoggerInterface $logger,
Environment $environment,
SubscriptionHelper $subscription_helper,
OrderHelper $order_helper
OrderHelper $order_helper,
PurchaseUnitFactory $purchase_unit_factory,
PayerFactory $payer_factory,
ShippingPreferenceFactory $shipping_preference_factory
) {
$this->session_handler = $session_handler;
@ -160,60 +186,57 @@ class OrderProcessor {
$this->logger = $logger;
$this->subscription_helper = $subscription_helper;
$this->order_helper = $order_helper;
$this->purchase_unit_factory = $purchase_unit_factory;
$this->payer_factory = $payer_factory;
$this->shipping_preference_factory = $shipping_preference_factory;
}
/**
* Processes a given WooCommerce order and captured/authorizes the connected PayPal orders.
*
* @param \WC_Order $wc_order The WooCommerce order.
* @param WC_Order $wc_order The WooCommerce order.
*
* @return bool
* @throws PayPalOrderMissingException If no PayPal order.
* @throws Exception If processing fails.
*/
public function process( \WC_Order $wc_order ): bool {
// phpcs:ignore WordPress.Security.NonceVerification
$order_id = $wc_order->get_meta( PayPalGateway::ORDER_ID_META_KEY ) ?: wc_clean( wp_unslash( $_POST['paypal_order_id'] ?? '' ) );
$order = $this->session_handler->order();
if ( ! $order && is_string( $order_id ) && $order_id ) {
$order = $this->order_endpoint->order( $order_id );
}
public function process( WC_Order $wc_order ): void {
$order = $this->session_handler->order();
if ( ! $order ) {
$order_id = $wc_order->get_meta( PayPalGateway::ORDER_ID_META_KEY );
if ( ! $order_id ) {
// phpcs:ignore WordPress.Security.NonceVerification
$order_id = $wc_order->get_meta( PayPalGateway::ORDER_ID_META_KEY ) ?: wc_clean( wp_unslash( $_POST['paypal_order_id'] ?? '' ) );
if ( is_string( $order_id ) && $order_id ) {
try {
$order = $this->order_endpoint->order( $order_id );
} catch ( RuntimeException $exception ) {
throw new Exception( __( 'Could not retrieve PayPal order.', 'woocommerce-paypal-payments' ) );
}
} else {
$this->logger->warning(
sprintf(
'No PayPal order ID found in order #%d meta.',
$wc_order->get_id()
)
);
$this->last_error = __( 'Could not retrieve order. Maybe it was already completed or this browser is not supported. Please check your email or try again with a different browser.', 'woocommerce-paypal-payments' );
return false;
}
try {
$order = $this->order_endpoint->order( $order_id );
} catch ( RuntimeException $exception ) {
$this->last_error = __( 'Could not retrieve PayPal order.', 'woocommerce-paypal-payments' );
return false;
throw new PayPalOrderMissingException(
__(
'Could not retrieve order. Maybe it was already completed or this browser is not supported. Please check your email or try again with a different browser.',
'woocommerce-paypal-payments'
)
);
}
}
$this->add_paypal_meta( $wc_order, $order, $this->environment );
$error_message = null;
if ( $this->order_helper->contains_physical_goods( $order ) && ! $this->order_is_ready_for_process( $order ) ) {
$error_message = __(
'The payment is not ready for processing yet.',
'woocommerce-paypal-payments'
throw new Exception(
__(
'The payment is not ready for processing yet.',
'woocommerce-paypal-payments'
)
);
}
if ( $error_message ) {
$this->last_error = sprintf(
// translators: %s is the message of the error.
__( 'Payment error: %s', 'woocommerce-paypal-payments' ),
$error_message
);
return false;
}
$order = $this->patch_order( $wc_order, $order );
@ -242,8 +265,30 @@ class OrderProcessor {
if ( $this->capture_authorized_downloads( $order ) ) {
$this->authorized_payments_processor->capture_authorized_payment( $wc_order );
}
$this->last_error = '';
return true;
}
/**
* Creates a PayPal order for the given WC order.
*
* @param WC_Order $wc_order The WC order.
* @return Order
* @throws RuntimeException If order creation fails.
*/
public function create_order( WC_Order $wc_order ): Order {
$pu = $this->purchase_unit_factory->from_wc_order( $wc_order );
$shipping_preference = $this->shipping_preference_factory->from_state( $pu, 'checkout' );
$order = $this->order_endpoint->create(
array( $pu ),
$shipping_preference,
$this->payer_factory->from_wc_order( $wc_order ),
null,
'',
ApplicationContext::USER_ACTION_PAY_NOW
);
$this->add_paypal_meta( $wc_order, $order, $this->environment );
return $order;
}
/**
@ -280,25 +325,15 @@ class OrderProcessor {
return true;
}
/**
* Returns the last error.
*
* @return string
*/
public function last_error(): string {
return $this->last_error;
}
/**
* Patches a given PayPal order with a WooCommerce order.
*
* @param \WC_Order $wc_order The WooCommerce order.
* @param Order $order The PayPal order.
* @param WC_Order $wc_order The WooCommerce order.
* @param Order $order The PayPal order.
*
* @return Order
*/
public function patch_order( \WC_Order $wc_order, Order $order ): Order {
public function patch_order( WC_Order $wc_order, Order $order ): Order {
$this->apply_outbound_order_filters( $wc_order );
$updated_order = $this->order_factory->from_wc_order( $wc_order, $order );
$this->restore_order_from_filters( $wc_order );

View file

@ -15,6 +15,7 @@ use WC_Session_Handler;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
use WooCommerce\PayPalCommerce\ApiClient\Entity\OrderStatus;
use Psr\Log\LoggerInterface;
use WooCommerce\PayPalCommerce\ApiClient\Exception\RuntimeException;
use WooCommerce\PayPalCommerce\Session\MemoryWcSession;
use WooCommerce\PayPalCommerce\Session\SessionHandler;
use WooCommerce\PayPalCommerce\WcGateway\FundingSource\FundingSourceRenderer;
@ -228,12 +229,14 @@ class CheckoutOrderApproved implements RequestHandler {
continue;
}
if ( ! $this->order_processor->process( $wc_order ) ) {
try {
$this->order_processor->process( $wc_order );
} catch ( RuntimeException $exception ) {
return $this->failure_response(
sprintf(
'Failed to process WC order %s: %s.',
(string) $wc_order->get_id(),
$this->order_processor->last_error()
$exception->getMessage()
)
);
}

View file

@ -3,6 +3,7 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\WcGateway\Gateway;
use Exception;
use Psr\Log\LoggerInterface;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
use WooCommerce\PayPalCommerce\ApiClient\Entity\Order;
@ -207,13 +208,10 @@ class WcGatewayTest extends TestCase
public function testProcessPaymentFails() {
$orderId = 1;
$wcOrder = Mockery::mock(\WC_Order::class);
$lastError = 'some-error';
$error = 'some-error';
$this->orderProcessor
->expects('process')
->andReturnFalse();
$this->orderProcessor
->expects('last_error')
->andReturn($lastError);
->andThrow(new Exception($error));
$this->subscriptionHelper->shouldReceive('has_subscription')->with($orderId)->andReturn(true);
$this->subscriptionHelper->shouldReceive('is_subscription_change_payment')->andReturn(true);
$wcOrder->shouldReceive('update_status')->andReturn(true);
@ -226,7 +224,7 @@ class WcGatewayTest extends TestCase
$this->sessionHandler
->shouldReceive('destroy_session_data');
expect('wc_add_notice')
->with($lastError, 'error');
->with($error, 'error');
$redirectUrl = 'http://example.com/checkout';

View file

@ -4,6 +4,10 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\WcGateway\Processor;
use Exception;
use WooCommerce\PayPalCommerce\ApiClient\Factory\PayerFactory;
use WooCommerce\PayPalCommerce\ApiClient\Factory\PurchaseUnitFactory;
use WooCommerce\PayPalCommerce\ApiClient\Factory\ShippingPreferenceFactory;
use WooCommerce\PayPalCommerce\Vendor\Dhii\Container\Dictionary;
use Psr\Log\LoggerInterface;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
@ -143,7 +147,10 @@ class OrderProcessorTest extends TestCase
$logger,
$this->environment,
$subscription_helper,
$order_helper
$order_helper,
Mockery::mock(PurchaseUnitFactory::class),
Mockery::mock(PayerFactory::class),
Mockery::mock(ShippingPreferenceFactory::class)
);
$wcOrder
@ -173,7 +180,9 @@ class OrderProcessorTest extends TestCase
$order_helper->shouldReceive('contains_physical_goods')->andReturn(true);
$this->assertTrue($testee->process($wcOrder));
$testee->process($wcOrder);
$this->expectNotToPerformAssertions();
}
public function testCapture() {
@ -268,7 +277,10 @@ class OrderProcessorTest extends TestCase
$logger,
$this->environment,
$subscription_helper,
$order_helper
$order_helper,
Mockery::mock(PurchaseUnitFactory::class),
Mockery::mock(PayerFactory::class),
Mockery::mock(ShippingPreferenceFactory::class)
);
$wcOrder
@ -293,7 +305,9 @@ class OrderProcessorTest extends TestCase
$order_helper->shouldReceive('contains_physical_goods')->andReturn(true);
$this->assertTrue($testee->process($wcOrder));
$testee->process($wcOrder);
$this->expectNotToPerformAssertions();
}
public function testError() {
@ -375,7 +389,10 @@ class OrderProcessorTest extends TestCase
$logger,
$this->environment,
$subscription_helper,
$order_helper
$order_helper,
Mockery::mock(PurchaseUnitFactory::class),
Mockery::mock(PayerFactory::class),
Mockery::mock(ShippingPreferenceFactory::class)
);
$wcOrder
@ -394,8 +411,8 @@ class OrderProcessorTest extends TestCase
$order_helper->shouldReceive('contains_physical_goods')->andReturn(true);
$this->assertFalse($testee->process($wcOrder));
$this->assertNotEmpty($testee->last_error());
$this->expectException(Exception::class);
$testee->process($wcOrder);
}