diff --git a/.psalm/stubs.php b/.psalm/stubs.php index 7282b6907..6d897c723 100644 --- a/.psalm/stubs.php +++ b/.psalm/stubs.php @@ -2,6 +2,12 @@ if (!defined('PAYPAL_INTEGRATION_DATE')) { define('PAYPAL_INTEGRATION_DATE', '2023-06-02'); } +if (!defined('PAYPAL_URL')) { + define( 'PAYPAL_URL', 'https://www.paypal.com' ); +} +if (!defined('PAYPAL_SANDBOX_URL')) { + define( 'PAYPAL_SANDBOX_URL', 'https://www.sandbox.paypal.com' ); +} if (!defined('EP_PAGES')) { define('EP_PAGES', 4096); } diff --git a/api/order-functions.php b/api/order-functions.php index 701b064fb..340be8585 100644 --- a/api/order-functions.php +++ b/api/order-functions.php @@ -21,6 +21,7 @@ use WooCommerce\PayPalCommerce\PPCP; use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayPalGateway; use WooCommerce\PayPalCommerce\WcGateway\Helper\RefundFeesUpdater; use WooCommerce\PayPalCommerce\WcGateway\Processor\AuthorizedPaymentsProcessor; +use WooCommerce\PayPalCommerce\WcGateway\Processor\OrderProcessor; use WooCommerce\PayPalCommerce\WcGateway\Processor\RefundProcessor; /** @@ -47,6 +48,19 @@ function ppcp_get_paypal_order( $paypal_id_or_wc_order ): Order { return $order_endpoint->order( $paypal_id_or_wc_order ); } +/** + * Creates a PayPal order for the given WC order. + * + * @param WC_Order $wc_order The WC order. + * @throws Exception When the operation fails. + */ +function ppcp_create_paypal_order_for_wc_order( WC_Order $wc_order ): Order { + $order_processor = PPCP::container()->get( 'wcgateway.order-processor' ); + assert( $order_processor instanceof OrderProcessor ); + + return $order_processor->create_order( $wc_order ); +} + /** * Captures the PayPal order. * diff --git a/modules/ppcp-api-client/services.php b/modules/ppcp-api-client/services.php index c5478554f..076782081 100644 --- a/modules/ppcp-api-client/services.php +++ b/modules/ppcp-api-client/services.php @@ -80,6 +80,14 @@ return array( 'api.paypal-host' => function( ContainerInterface $container ) : string { return PAYPAL_API_URL; }, + 'api.paypal-website-url' => function( ContainerInterface $container ) : string { + return PAYPAL_URL; + }, + 'api.factory.paypal-checkout-url' => function( ContainerInterface $container ) : callable { + return function ( string $id ) use ( $container ): string { + return $container->get( 'api.paypal-website-url' ) . '/checkoutnow?token=' . $id; + }; + }, 'api.partner_merchant_id' => static function () : string { return ''; }, diff --git a/modules/ppcp-blocks/resources/js/checkout-block.js b/modules/ppcp-blocks/resources/js/checkout-block.js index 582fdede3..8631d8b05 100644 --- a/modules/ppcp-blocks/resources/js/checkout-block.js +++ b/modules/ppcp-blocks/resources/js/checkout-block.js @@ -42,7 +42,7 @@ const PayPalComponent = ({ const [loaded, setLoaded] = useState(false); useEffect(() => { - if (!loaded) { + if (!loaded && !config.scriptData.continuation) { loadPaypalScript(config.scriptData, () => { setLoaded(true); @@ -316,20 +316,36 @@ const PayPalComponent = ({ } const features = ['products']; -let registerMethod = registerExpressPaymentMethod; -if (config.scriptData.continuation) { - features.push('ppcp_continuation'); - registerMethod = registerPaymentMethod; -} -registerMethod({ - name: config.id, - label:
, - content: , - edit: , - ariaLabel: config.title, - canMakePayment: () => config.enabled, - supports: { - features: features, - }, -}); +if (config.usePlaceOrder && !config.scriptData.continuation) { + registerPaymentMethod({ + name: config.id, + label:
, + content:
, + edit:
, + placeOrderButtonLabel: config.placeOrderButtonText, + ariaLabel: config.title, + canMakePayment: () => config.enabled, + supports: { + features: features, + }, + }); +} else { + let registerMethod = registerExpressPaymentMethod; + if (config.scriptData.continuation) { + features.push('ppcp_continuation'); + registerMethod = registerPaymentMethod; + } + + registerMethod({ + name: config.id, + label:
, + content: , + edit: , + ariaLabel: config.title, + canMakePayment: () => config.enabled, + supports: { + features: features, + }, + }); +} diff --git a/modules/ppcp-blocks/services.php b/modules/ppcp-blocks/services.php index 5b5a5159b..8b4ac5475 100644 --- a/modules/ppcp-blocks/services.php +++ b/modules/ppcp-blocks/services.php @@ -34,7 +34,9 @@ return array( $container->get( 'wcgateway.paypal-gateway' ), $container->get( 'blocks.settings.final_review_enabled' ), $container->get( 'session.cancellation.view' ), - $container->get( 'session.handler' ) + $container->get( 'session.handler' ), + $container->get( 'wcgateway.use-place-order-button' ), + $container->get( 'wcgateway.place-order-button-text' ) ); }, 'blocks.settings.final_review_enabled' => static function ( ContainerInterface $container ): bool { diff --git a/modules/ppcp-blocks/src/PayPalPaymentMethod.php b/modules/ppcp-blocks/src/PayPalPaymentMethod.php index 3c407f2a2..2fc2cbca1 100644 --- a/modules/ppcp-blocks/src/PayPalPaymentMethod.php +++ b/modules/ppcp-blocks/src/PayPalPaymentMethod.php @@ -87,6 +87,20 @@ class PayPalPaymentMethod extends AbstractPaymentMethodType { */ private $session_handler; + /** + * Whether to use the standard "Place order" button. + * + * @var bool + */ + protected $use_place_order; + + /** + * The text for the standard "Place order" button. + * + * @var string + */ + protected $place_order_button_text; + /** * Assets constructor. * @@ -99,6 +113,8 @@ class PayPalPaymentMethod extends AbstractPaymentMethodType { * @param bool $final_review_enabled Whether the final review is enabled. * @param CancelView $cancellation_view The cancellation view. * @param SessionHandler $session_handler The Session handler. + * @param bool $use_place_order Whether to use the standard "Place order" button. + * @param string $place_order_button_text The text for the standard "Place order" button. */ public function __construct( string $module_url, @@ -109,18 +125,22 @@ class PayPalPaymentMethod extends AbstractPaymentMethodType { PayPalGateway $gateway, bool $final_review_enabled, CancelView $cancellation_view, - SessionHandler $session_handler + SessionHandler $session_handler, + bool $use_place_order, + string $place_order_button_text ) { - $this->name = PayPalGateway::ID; - $this->module_url = $module_url; - $this->version = $version; - $this->smart_button = $smart_button; - $this->plugin_settings = $plugin_settings; - $this->settings_status = $settings_status; - $this->gateway = $gateway; - $this->final_review_enabled = $final_review_enabled; - $this->cancellation_view = $cancellation_view; - $this->session_handler = $session_handler; + $this->name = PayPalGateway::ID; + $this->module_url = $module_url; + $this->version = $version; + $this->smart_button = $smart_button; + $this->plugin_settings = $plugin_settings; + $this->settings_status = $settings_status; + $this->gateway = $gateway; + $this->final_review_enabled = $final_review_enabled; + $this->cancellation_view = $cancellation_view; + $this->session_handler = $session_handler; + $this->use_place_order = $use_place_order; + $this->place_order_button_text = $place_order_button_text; } /** @@ -175,19 +195,21 @@ class PayPalPaymentMethod extends AbstractPaymentMethodType { } return array( - 'id' => $this->gateway->id, - 'title' => $this->gateway->title, - 'description' => $this->gateway->description, - 'enabled' => $this->settings_status->is_smart_button_enabled_for_location( $script_data['context'] ), - 'fundingSource' => $this->session_handler->funding_source(), - 'finalReviewEnabled' => $this->final_review_enabled, - 'ajax' => array( + 'id' => $this->gateway->id, + 'title' => $this->gateway->title, + 'description' => $this->gateway->description, + 'enabled' => $this->settings_status->is_smart_button_enabled_for_location( $script_data['context'] ), + 'fundingSource' => $this->session_handler->funding_source(), + 'finalReviewEnabled' => $this->final_review_enabled, + 'usePlaceOrder' => $this->use_place_order, + 'placeOrderButtonText' => $this->place_order_button_text, + 'ajax' => array( 'update_shipping' => array( 'endpoint' => WC_AJAX::get_endpoint( UpdateShippingEndpoint::ENDPOINT ), 'nonce' => wp_create_nonce( UpdateShippingEndpoint::nonce() ), ), ), - 'scriptData' => $script_data, + 'scriptData' => $script_data, ); } } diff --git a/modules/ppcp-button/services.php b/modules/ppcp-button/services.php index 9267307d8..cae843039 100644 --- a/modules/ppcp-button/services.php +++ b/modules/ppcp-button/services.php @@ -15,8 +15,10 @@ use WooCommerce\PayPalCommerce\Button\Endpoint\SimulateCartEndpoint; use WooCommerce\PayPalCommerce\Button\Helper\CartProductsHelper; use WooCommerce\PayPalCommerce\Button\Helper\CheckoutFormSaver; use WooCommerce\PayPalCommerce\Button\Endpoint\SaveCheckoutFormEndpoint; +use WooCommerce\PayPalCommerce\Button\Helper\ContextTrait; use WooCommerce\PayPalCommerce\Button\Validation\CheckoutFormValidator; use WooCommerce\PayPalCommerce\Button\Endpoint\ValidateCheckoutEndpoint; +use WooCommerce\PayPalCommerce\Session\SessionHandler; use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface; use WooCommerce\PayPalCommerce\Button\Assets\DisabledSmartButton; use WooCommerce\PayPalCommerce\Button\Assets\SmartButton; @@ -68,8 +70,41 @@ return array( return $dummy_ids[ $shop_country ] ?? $container->get( 'button.client_id' ); }, + // This service may not work correctly when called too early. + 'button.context' => static function ( ContainerInterface $container ): string { + $obj = new class() { + use ContextTrait; + + /** + * Session handler. + * + * @var SessionHandler + */ + protected $session_handler; + + /** Constructor. */ + public function __construct() { + // phpcs:ignore PHPCompatibility.FunctionDeclarations.NewClosure.ThisFoundInStatic + $this->session_handler = new SessionHandler(); + } + + /** + * Wrapper for a non-public function. + */ + public function get_context(): string { + // phpcs:ignore PHPCompatibility.FunctionDeclarations.NewClosure.ThisFoundInStatic + return $this->context(); + } + }; + return $obj->get_context(); + }, 'button.smart-button' => static function ( ContainerInterface $container ): SmartButtonInterface { $state = $container->get( 'onboarding.state' ); + if ( $container->get( 'wcgateway.use-place-order-button' ) + && in_array( $container->get( 'button.context' ), array( 'checkout', 'pay-now' ), true ) + ) { + return new DisabledSmartButton(); + } if ( $state->current_state() !== State::STATE_ONBOARDED ) { return new DisabledSmartButton(); } diff --git a/modules/ppcp-onboarding/services.php b/modules/ppcp-onboarding/services.php index 27ab1ad25..b76519f62 100644 --- a/modules/ppcp-onboarding/services.php +++ b/modules/ppcp-onboarding/services.php @@ -71,6 +71,12 @@ return array( 'api.paypal-host-sandbox' => static function( ContainerInterface $container ) : string { return PAYPAL_SANDBOX_API_URL; }, + 'api.paypal-website-url-production' => static function( ContainerInterface $container ) : string { + return PAYPAL_URL; + }, + 'api.paypal-website-url-sandbox' => static function( ContainerInterface $container ) : string { + return PAYPAL_SANDBOX_URL; + }, 'api.partner_merchant_id-production' => static function( ContainerInterface $container ) : string { return CONNECT_WOO_MERCHANT_ID; }, @@ -89,6 +95,15 @@ return array( } return $container->get( 'api.paypal-host-production' ); + }, + 'api.paypal-website-url' => function( ContainerInterface $container ) : string { + $environment = $container->get( 'onboarding.environment' ); + assert( $environment instanceof Environment ); + if ( $environment->current_environment_is( Environment::SANDBOX ) ) { + return $container->get( 'api.paypal-website-url-sandbox' ); + } + return $container->get( 'api.paypal-website-url-production' ); + }, 'api.bearer' => static function ( ContainerInterface $container ): Bearer { diff --git a/modules/ppcp-wc-gateway/services.php b/modules/ppcp-wc-gateway/services.php index 80af8ce8d..913eaee9f 100644 --- a/modules/ppcp-wc-gateway/services.php +++ b/modules/ppcp-wc-gateway/services.php @@ -97,7 +97,9 @@ return array( $payment_token_repository, $logger, $api_shop_country, - $container->get( 'api.endpoint.order' ) + $container->get( 'api.endpoint.order' ), + $container->get( 'api.factory.paypal-checkout-url' ), + $container->get( 'wcgateway.place-order-button-text' ) ); }, 'wcgateway.credit-card-gateway' => static function ( ContainerInterface $container ): CreditCardGateway { @@ -141,7 +143,9 @@ 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' ), + $container->get( 'wcgateway.place-order-button-text' ) ); }, 'wcgateway.disabler' => static function ( ContainerInterface $container ): DisableGateways { @@ -352,7 +356,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 { @@ -1158,6 +1165,25 @@ return array( ); }, + 'wcgateway.use-place-order-button' => function ( ContainerInterface $container ) : bool { + /** + * Whether to use the standard "Place order" button with redirect to PayPal instead of the PayPal smart buttons. + */ + return apply_filters( + 'woocommerce_paypal_payments_use_place_order_button', + false + ); + }, + 'wcgateway.place-order-button-text' => function ( ContainerInterface $container ) : string { + /** + * The text for the standard "Place order" button, when the "Place order" button mode is enabled. + */ + return apply_filters( + 'woocommerce_paypal_payments_place_order_button_text', + __( 'Pay with PayPal', 'woocommerce-paypal-payments' ) + ); + }, + 'wcgateway.helper.vaulting-scope' => static function ( ContainerInterface $container ): bool { try { $token = $container->get( 'api.bearer' )->bearer(); diff --git a/modules/ppcp-wc-gateway/src/Endpoint/ReturnUrlEndpoint.php b/modules/ppcp-wc-gateway/src/Endpoint/ReturnUrlEndpoint.php index 3efe16542..9d5f98ec7 100644 --- a/modules/ppcp-wc-gateway/src/Endpoint/ReturnUrlEndpoint.php +++ b/modules/ppcp-wc-gateway/src/Endpoint/ReturnUrlEndpoint.php @@ -85,14 +85,18 @@ class ReturnUrlEndpoint { // phpcs:enable WordPress.Security.NonceVerification.Recommended $order = $this->order_endpoint->order( $token ); + if ( $order->status()->is( OrderStatus::APPROVED ) + || $order->status()->is( OrderStatus::COMPLETED ) + ) { + $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(); } diff --git a/modules/ppcp-wc-gateway/src/Exception/PayPalOrderMissingException.php b/modules/ppcp-wc-gateway/src/Exception/PayPalOrderMissingException.php new file mode 100644 index 000000000..6a14e13dd --- /dev/null +++ b/modules/ppcp-wc-gateway/src/Exception/PayPalOrderMissingException.php @@ -0,0 +1,18 @@ +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->order_button_text = $place_order_button_text; $this->supports = array( 'refunds', @@ -294,18 +308,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 +331,7 @@ class CardButtonGateway extends \WC_Payment_Gateway { $error ) ); - } catch ( RuntimeException $error ) { + } catch ( Exception $error ) { return $this->handle_payment_failure( $wc_order, $error ); } } diff --git a/modules/ppcp-wc-gateway/src/Gateway/CreditCardGateway.php b/modules/ppcp-wc-gateway/src/Gateway/CreditCardGateway.php index 1b99b9d05..78012b2d7 100644 --- a/modules/ppcp-wc-gateway/src/Gateway/CreditCardGateway.php +++ b/modules/ppcp-wc-gateway/src/Gateway/CreditCardGateway.php @@ -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 ); } } diff --git a/modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php b/modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php index b17e48a7a..7d8ae3d04 100644 --- a/modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php +++ b/modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php @@ -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; @@ -163,24 +164,33 @@ class PayPalGateway extends \WC_Payment_Gateway { */ private $order_endpoint; + /** + * The function return the PayPal checkout URL for the given order ID. + * + * @var callable(string):string + */ + private $paypal_checkout_url_factory; + /** * PayPalGateway constructor. * - * @param SettingsRenderer $settings_renderer The Settings Renderer. - * @param FundingSourceRenderer $funding_source_renderer The funding source 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 string $page_id ID of the current PPCP gateway settings page, or empty if it is not such page. - * @param Environment $environment The environment. - * @param PaymentTokenRepository $payment_token_repository The payment token repository. - * @param LoggerInterface $logger The logger. - * @param string $api_shop_country The api shop country. - * @param OrderEndpoint $order_endpoint The order endpoint. + * @param SettingsRenderer $settings_renderer The Settings Renderer. + * @param FundingSourceRenderer $funding_source_renderer The funding source 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 string $page_id ID of the current PPCP gateway settings page, or empty if it is not such page. + * @param Environment $environment The environment. + * @param PaymentTokenRepository $payment_token_repository The payment token repository. + * @param LoggerInterface $logger The logger. + * @param string $api_shop_country The api shop country. + * @param OrderEndpoint $order_endpoint The order endpoint. + * @param callable(string):string $paypal_checkout_url_factory The function return the PayPal checkout URL for the given order ID. + * @param string $place_order_button_text The text for the standard "Place order" button. */ public function __construct( SettingsRenderer $settings_renderer, @@ -197,24 +207,28 @@ class PayPalGateway extends \WC_Payment_Gateway { PaymentTokenRepository $payment_token_repository, LoggerInterface $logger, string $api_shop_country, - OrderEndpoint $order_endpoint + OrderEndpoint $order_endpoint, + callable $paypal_checkout_url_factory, + string $place_order_button_text ) { - $this->id = self::ID; - $this->settings_renderer = $settings_renderer; - $this->funding_source_renderer = $funding_source_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->page_id = $page_id; - $this->environment = $environment; - $this->onboarded = $state->current_state() === State::STATE_ONBOARDED; - $this->payment_token_repository = $payment_token_repository; - $this->logger = $logger; - $this->api_shop_country = $api_shop_country; + $this->id = self::ID; + $this->settings_renderer = $settings_renderer; + $this->funding_source_renderer = $funding_source_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->page_id = $page_id; + $this->environment = $environment; + $this->onboarded = $state->current_state() === State::STATE_ONBOARDED; + $this->payment_token_repository = $payment_token_repository; + $this->logger = $logger; + $this->api_shop_country = $api_shop_country; + $this->paypal_checkout_url_factory = $paypal_checkout_url_factory; + $this->order_button_text = $place_order_button_text; if ( $this->onboarded ) { $this->supports = array( 'refunds', 'tokenization' ); @@ -546,19 +560,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' ), @@ -593,12 +608,9 @@ class PayPalGateway extends \WC_Payment_Gateway { ); } - $host = $this->config->has( 'sandbox_on' ) && $this->config->get( 'sandbox_on' ) ? - 'https://www.sandbox.paypal.com/' : 'https://www.paypal.com/'; - $url = $host . 'checkoutnow?token=' . $this->session_handler->order()->id(); return array( 'result' => 'success', - 'redirect' => $url, + 'redirect' => ( $this->paypal_checkout_url_factory )( $this->session_handler->order()->id() ), ); } @@ -610,7 +622,7 @@ class PayPalGateway extends \WC_Payment_Gateway { $error ) ); - } catch ( RuntimeException $error ) { + } catch ( Exception $error ) { return $this->handle_payment_failure( $wc_order, $error ); } } diff --git a/modules/ppcp-wc-gateway/src/Processor/OrderProcessor.php b/modules/ppcp-wc-gateway/src/Processor/OrderProcessor.php index 1fb10ed8c..2497f8f91 100644 --- a/modules/ppcp-wc-gateway/src/Processor/OrderProcessor.php +++ b/modules/ppcp-wc-gateway/src/Processor/OrderProcessor.php @@ -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,28 @@ 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 + ); + + return $order; } /** @@ -280,25 +323,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 ); diff --git a/modules/ppcp-webhooks/src/Handler/CheckoutOrderApproved.php b/modules/ppcp-webhooks/src/Handler/CheckoutOrderApproved.php index 177bda0ad..d93ca5b4c 100644 --- a/modules/ppcp-webhooks/src/Handler/CheckoutOrderApproved.php +++ b/modules/ppcp-webhooks/src/Handler/CheckoutOrderApproved.php @@ -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() ) ); } diff --git a/tests/PHPUnit/Api/CreateOrderForWcOrderTest.php b/tests/PHPUnit/Api/CreateOrderForWcOrderTest.php new file mode 100644 index 000000000..b2d16caf7 --- /dev/null +++ b/tests/PHPUnit/Api/CreateOrderForWcOrderTest.php @@ -0,0 +1,52 @@ +orderProcesor = Mockery::mock(OrderProcessor::class); + + $this->bootstrapModule([ + 'wcgateway.order-processor' => function () { + return $this->orderProcesor; + }, + ]); + } + + public function testSuccess(): void { + $wcOrder = Mockery::mock(WC_Order::class); + $ret = Mockery::mock(Order::class); + $this->orderProcesor + ->expects('create_order') + ->with($wcOrder) + ->andReturn($ret) + ->once(); + + self::assertEquals($ret, ppcp_create_paypal_order_for_wc_order($wcOrder)); + } + + public function testFailure(): void { + $wcOrder = Mockery::mock(WC_Order::class); + $this->orderProcesor + ->expects('create_order') + ->with($wcOrder) + ->andThrow(new RuntimeException()) + ->once(); + + $this->expectException(RuntimeException::class); + + ppcp_create_paypal_order_for_wc_order($wcOrder); + } +} diff --git a/tests/PHPUnit/ModularTestCase.php b/tests/PHPUnit/ModularTestCase.php index 61583c4e1..a880acfbe 100644 --- a/tests/PHPUnit/ModularTestCase.php +++ b/tests/PHPUnit/ModularTestCase.php @@ -41,7 +41,9 @@ class ModularTestCase extends TestCase $wpdb->postmeta = ''; !defined('PAYPAL_API_URL') && define('PAYPAL_API_URL', 'https://api-m.paypal.com'); + !defined('PAYPAL_URL') && define( 'PAYPAL_URL', 'https://www.paypal.com' ); !defined('PAYPAL_SANDBOX_API_URL') && define('PAYPAL_SANDBOX_API_URL', 'https://api-m.sandbox.paypal.com'); + !defined('PAYPAL_SANDBOX_URL') && define( 'PAYPAL_SANDBOX_URL', 'https://www.sandbox.paypal.com' ); !defined('PAYPAL_INTEGRATION_DATE') && define('PAYPAL_INTEGRATION_DATE', '2020-10-15'); !defined('PPCP_FLAG_SUBSCRIPTION') && define('PPCP_FLAG_SUBSCRIPTION', true); diff --git a/tests/PHPUnit/WcGateway/Gateway/WcGatewayTest.php b/tests/PHPUnit/WcGateway/Gateway/WcGatewayTest.php index aa9057c67..962dbbdd4 100644 --- a/tests/PHPUnit/WcGateway/Gateway/WcGatewayTest.php +++ b/tests/PHPUnit/WcGateway/Gateway/WcGatewayTest.php @@ -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; @@ -106,7 +107,11 @@ class WcGatewayTest extends TestCase $this->paymentTokenRepository, $this->logger, $this->apiShopCountry, - $this->orderEndpoint + $this->orderEndpoint, + function ($id) { + return 'checkoutnow=' . $id; + }, + 'Pay via PayPal' ); } @@ -204,13 +209,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); @@ -223,7 +225,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'; diff --git a/tests/PHPUnit/WcGateway/Processor/OrderProcessorTest.php b/tests/PHPUnit/WcGateway/Processor/OrderProcessorTest.php index 97ceca9b5..d6754fdee 100644 --- a/tests/PHPUnit/WcGateway/Processor/OrderProcessorTest.php +++ b/tests/PHPUnit/WcGateway/Processor/OrderProcessorTest.php @@ -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); } diff --git a/woocommerce-paypal-payments.php b/woocommerce-paypal-payments.php index 5e89cbae4..d70e57580 100644 --- a/woocommerce-paypal-payments.php +++ b/woocommerce-paypal-payments.php @@ -22,7 +22,9 @@ namespace WooCommerce\PayPalCommerce; use WooCommerce\PayPalCommerce\WcGateway\Settings\Settings; define( 'PAYPAL_API_URL', 'https://api-m.paypal.com' ); +define( 'PAYPAL_URL', 'https://www.paypal.com' ); define( 'PAYPAL_SANDBOX_API_URL', 'https://api-m.sandbox.paypal.com' ); +define( 'PAYPAL_SANDBOX_URL', 'https://www.sandbox.paypal.com' ); define( 'PAYPAL_INTEGRATION_DATE', '2023-11-06' ); ! defined( 'CONNECT_WOO_CLIENT_ID' ) && define( 'CONNECT_WOO_CLIENT_ID', 'AcCAsWta_JTL__OfpjspNyH7c1GGHH332fLwonA5CwX4Y10mhybRZmHLA0GdRbwKwjQIhpDQy0pluX_P' );