woocommerce/woocommerce-paypal-payments
2
0
Fork 0
mirror of https://github.com/woocommerce/woocommerce-paypal-payments.git synced 2025-09-06 10:55:00 +08:00
Code Issues Projects Packages Wiki Activity Actions 7

Merge pull request #1435 from woocommerce/PCP-860-apm

Browse source 
Improve handling of APMs when popup is not used or not redirected back to WC
This commit is contained in:
Emili Castells 2023-07-04 16:22:39 +02:00 • committed by GitHub
commit 1d75e73b56
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
45 changed files with 827 additions and 617 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.env.e2e.example
View file

@ -15,6 +15,8 @@ PRODUCT_ID=123
SUBSCRIPTION_URL="/product/sub"
APM_ID="sofort"
WP_MERCHANT_USER="admin"
WP_MERCHANT_PASSWORD="admin"

3
.psalm/stubs.php
View file

@ -1,4 +1,7 @@
<?php
if (!defined('PAYPAL_INTEGRATION_DATE')) {
define('PAYPAL_INTEGRATION_DATE', '2023-06-02');
}
if (!defined('EP_PAGES')) {
define('EP_PAGES', 4096);
}

9
modules/ppcp-api-client/src/Factory/PurchaseUnitFactory.php
View file

@ -9,10 +9,12 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\ApiClient\Factory;
use WC_Session_Handler;
use WooCommerce\PayPalCommerce\ApiClient\Entity\Item;
use WooCommerce\PayPalCommerce\ApiClient\Entity\PurchaseUnit;
use WooCommerce\PayPalCommerce\ApiClient\Exception\RuntimeException;
use WooCommerce\PayPalCommerce\ApiClient\Repository\PayeeRepository;
use WooCommerce\PayPalCommerce\Webhooks\CustomIds;
/**
* Class PurchaseUnitFactory
@ -188,6 +190,13 @@ class PurchaseUnitFactory {
$payee = $this->payee_repository->payee();
$custom_id = '';
$session = WC()->session;
if ( $session instanceof WC_Session_Handler ) {
$session_id = $session->get_customer_unique_id();
if ( $session_id ) {
$custom_id = CustomIds::CUSTOMER_ID_PREFIX . $session_id;
}
}
$invoice_id = '';
$soft_descriptor = '';
$purchase_unit = new PurchaseUnit(

13
modules/ppcp-button/resources/js/button.js
View file

@ -28,6 +28,8 @@ const cardsSpinner = new Spinner('#ppcp-hosted-fields');
const bootstrap = () => {
const checkoutFormSelector = 'form.woocommerce-checkout';
const context = PayPalCommerceGateway.context;
const errorHandler = new ErrorHandler(
PayPalCommerceGateway.labels.error.generic,
document.querySelector(checkoutFormSelector) ?? document.querySelector('.woocommerce-notices-wrapper')
@ -58,7 +60,7 @@ const bootstrap = () => {
}
});
const onSmartButtonClick = (data, actions) => {
const onSmartButtonClick = async (data, actions) => {
window.ppcpFundingSource = data.fundingSource;
const requiredFields = jQuery('form.woocommerce-checkout .validate-required:visible :input');
requiredFields.each((i, input) => {
@ -120,6 +122,14 @@ const bootstrap = () => {
freeTrialHandler.handle();
return actions.reject();
}
if (context === 'checkout' && !PayPalCommerceGateway.funding_sources_without_redirect.includes(data.fundingSource)) {
try {
await formSaver.save(form);
} catch (error) {
console.error(error);
}
}
};
let smartButtonsOptions = {
@ -138,7 +148,6 @@ const bootstrap = () => {
};
const renderer = new Renderer(creditCardRenderer, PayPalCommerceGateway, onSmartButtonClick, onSmartButtonsInit, smartButtonsOptions);
const messageRenderer = new MessageRenderer(PayPalCommerceGateway.messages);
const context = PayPalCommerceGateway.context;
if (context === 'mini-cart' || context === 'product') {
if (PayPalCommerceGateway.mini_cart_buttons_enabled === '1') {
const miniCartBootstrap = new MiniCartBootstap(

26
modules/ppcp-button/services.php
View file

@ -67,23 +67,6 @@ return array(
return $dummy_ids[ $shop_country ] ?? $container->get( 'button.client_id' );
},
'button.is_paypal_continuation' => static function( ContainerInterface $container ): bool {
$session_handler = $container->get( 'session.handler' );
$order = $session_handler->order();
if ( ! $order ) {
return false;
}
$source = $order->payment_source();
if ( $source && $source->card() ) {
return false; // Ignore for DCC.
}
if ( 'card' === $session_handler->funding_source() ) {
return false; // Ignore for card buttons.
}
return true;
},
'button.smart-button' => static function ( ContainerInterface $container ): SmartButtonInterface {
$state = $container->get( 'onboarding.state' );
if ( $state->current_state() !== State::STATE_ONBOARDED ) {
@ -125,6 +108,7 @@ return array(
$container->get( 'button.basic-checkout-validation-enabled' ),
$container->get( 'button.early-wc-checkout-validation-enabled' ),
$container->get( 'button.pay-now-contexts' ),
$container->get( 'wcgateway.funding-sources-without-redirect' ),
$container->get( 'woocommerce.logger.woocommerce' )
);
},
@ -176,6 +160,7 @@ return array(
$container->get( 'button.early-wc-checkout-validation-enabled' ),
$container->get( 'button.pay-now-contexts' ),
$container->get( 'button.handle-shipping-in-paypal' ),
$container->get( 'wcgateway.funding-sources-without-redirect' ),
$logger
);
},
@ -184,8 +169,7 @@ return array(
$state = $container->get( 'onboarding.state' );
$order_processor = $container->get( 'wcgateway.order-processor' );
$session_handler = $container->get( 'session.handler' );
$prefix = $container->get( 'api.prefix' );
return new EarlyOrderHandler( $state, $order_processor, $session_handler, $prefix );
return new EarlyOrderHandler( $state, $order_processor, $session_handler );
},
'button.endpoint.approve-order' => static function ( ContainerInterface $container ): ApproveOrderEndpoint {
$request_data = $container->get( 'button.request-data' );
@ -215,7 +199,9 @@ return array(
);
},
'button.checkout-form-saver' => static function ( ContainerInterface $container ): CheckoutFormSaver {
return new CheckoutFormSaver();
return new CheckoutFormSaver(
$container->get( 'session.handler' )
);
},
'button.endpoint.save-checkout-form' => static function ( ContainerInterface $container ): SaveCheckoutFormEndpoint {
return new SaveCheckoutFormEndpoint(

13
modules/ppcp-button/src/Assets/SmartButton.php
View file

@ -174,6 +174,13 @@ class SmartButton implements SmartButtonInterface {
*/
private $pay_now_contexts;
/**
* The sources that do not cause issues about redirecting (on mobile, ...) and sometimes not returning back.
*
* @var string[]
*/
private $funding_sources_without_redirect;
/**
* The logger.
*
@ -209,6 +216,7 @@ class SmartButton implements SmartButtonInterface {
* @param bool $basic_checkout_validation_enabled Whether the basic JS validation of the form iss enabled.
* @param bool $early_validation_enabled Whether to execute WC validation of the checkout form.
* @param array $pay_now_contexts The contexts that should have the Pay Now button.
* @param string[] $funding_sources_without_redirect The sources that do not cause issues about redirecting (on mobile, ...) and sometimes not returning back.
* @param LoggerInterface $logger The logger.
*/
public function __construct(
@ -230,6 +238,7 @@ class SmartButton implements SmartButtonInterface {
bool $basic_checkout_validation_enabled,
bool $early_validation_enabled,
array $pay_now_contexts,
array $funding_sources_without_redirect,
LoggerInterface $logger
) {
@ -251,6 +260,7 @@ class SmartButton implements SmartButtonInterface {
$this->basic_checkout_validation_enabled = $basic_checkout_validation_enabled;
$this->early_validation_enabled = $early_validation_enabled;
$this->pay_now_contexts = $pay_now_contexts;
$this->funding_sources_without_redirect = $funding_sources_without_redirect;
$this->logger = $logger;
}
@ -942,6 +952,7 @@ class SmartButton implements SmartButtonInterface {
'mini_cart_buttons_enabled' => $this->settings_status->is_smart_button_enabled_for_location( 'mini-cart' ),
'basic_checkout_validation_enabled' => $this->basic_checkout_validation_enabled,
'early_checkout_validation_enabled' => $this->early_validation_enabled,
'funding_sources_without_redirect' => $this->funding_sources_without_redirect,
);
if ( $this->style_for_context( 'layout', 'mini-cart' ) !== 'horizontal' ) {
@ -1003,7 +1014,7 @@ class SmartButton implements SmartButtonInterface {
);
if (
$this->environment->current_environment_is( Environment::SANDBOX )
&& defined( 'WP_DEBUG' ) && \WP_DEBUG && is_user_logged_in()
&& defined( 'WP_DEBUG' ) && \WP_DEBUG
&& WC()->customer instanceof \WC_Customer && WC()->customer->get_billing_country()
&& 2 === strlen( WC()->customer->get_billing_country() )
) {

15
modules/ppcp-button/src/Endpoint/CreateOrderEndpoint.php
View file

@ -152,6 +152,13 @@ class CreateOrderEndpoint implements EndpointInterface {
*/
private $handle_shipping_in_paypal;
/**
* The sources that do not cause issues about redirecting (on mobile, ...) and sometimes not returning back.
*
* @var string[]
*/
private $funding_sources_without_redirect;
/**
* The logger.
*
@ -175,6 +182,7 @@ class CreateOrderEndpoint implements EndpointInterface {
* @param bool $early_validation_enabled Whether to execute WC validation of the checkout form.
* @param string[] $pay_now_contexts The contexts that should have the Pay Now button.
* @param bool $handle_shipping_in_paypal If true, the shipping methods are sent to PayPal allowing the customer to select it inside the popup.
* @param string[] $funding_sources_without_redirect The sources that do not cause issues about redirecting (on mobile, ...) and sometimes not returning back.
* @param LoggerInterface $logger The logger.
*/
public function __construct(
@ -191,6 +199,7 @@ class CreateOrderEndpoint implements EndpointInterface {
bool $early_validation_enabled,
array $pay_now_contexts,
bool $handle_shipping_in_paypal,
array $funding_sources_without_redirect,
LoggerInterface $logger
) {
@ -207,6 +216,7 @@ class CreateOrderEndpoint implements EndpointInterface {
$this->early_validation_enabled = $early_validation_enabled;
$this->pay_now_contexts = $pay_now_contexts;
$this->handle_shipping_in_paypal = $handle_shipping_in_paypal;
$this->funding_sources_without_redirect = $funding_sources_without_redirect;
$this->logger = $logger;
}
@ -288,6 +298,11 @@ class CreateOrderEndpoint implements EndpointInterface {
}
if ( 'checkout' === $data['context'] ) {
if ( $payment_method === PayPalGateway::ID && ! in_array( $funding_source, $this->funding_sources_without_redirect, true ) ) {
$this->session_handler->replace_order( $order );
$this->session_handler->replace_funding_source( $funding_source );
}
if (
! $this->early_order_handler->should_create_early_order()
|| $this->registration_needed

21
modules/ppcp-button/src/Helper/CheckoutFormSaver.php
View file

@ -10,11 +10,30 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\Button\Helper;
use WC_Checkout;
use WooCommerce\PayPalCommerce\Session\SessionHandler;
/**
* Class CheckoutFormSaver
*/
class CheckoutFormSaver extends WC_Checkout {
/**
* The Session handler.
*
* @var SessionHandler
*/
private $session_handler;
/**
* CheckoutFormSaver constructor.
*
* @param SessionHandler $session_handler The session handler.
*/
public function __construct(
SessionHandler $session_handler
) {
$this->session_handler = $session_handler;
}
/**
* Saves the form data to the WC customer and session.
*
@ -28,5 +47,7 @@ class CheckoutFormSaver extends WC_Checkout {
$data = $this->get_posted_data();
$this->update_session( $data );
$this->session_handler->replace_checkout_form( $data );
}
}

8
modules/ppcp-button/src/Helper/ContextTrait.php
View file

@ -9,6 +9,8 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\Button\Helper;
use WooCommerce\PayPalCommerce\ApiClient\Entity\OrderStatus;
trait ContextTrait {
/**
@ -63,6 +65,12 @@ trait ContextTrait {
return false;
}
if ( ! $order->status()->is( OrderStatus::APPROVED )
&& ! $order->status()->is( OrderStatus::COMPLETED )
) {
return false;
}
$source = $order->payment_source();
if ( $source && $source->card() ) {
return false; // Ignore for DCC.

10
modules/ppcp-button/src/Helper/EarlyOrderHandler.php
View file

@ -15,15 +15,12 @@ use WooCommerce\PayPalCommerce\Onboarding\State;
use WooCommerce\PayPalCommerce\Session\SessionHandler;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayPalGateway;
use WooCommerce\PayPalCommerce\WcGateway\Processor\OrderProcessor;
use WooCommerce\PayPalCommerce\Webhooks\Handler\PrefixTrait;
/**
* Class EarlyOrderHandler
*/
class EarlyOrderHandler {
use PrefixTrait;
/**
* The State.
*
@ -51,19 +48,16 @@ class EarlyOrderHandler {
* @param State $state The State.
* @param OrderProcessor $order_processor The Order Processor.
* @param SessionHandler $session_handler The Session Handler.
* @param string $prefix The Prefix.
*/
public function __construct(
State $state,
OrderProcessor $order_processor,
SessionHandler $session_handler,
string $prefix
SessionHandler $session_handler
) {
$this->state = $state;
$this->order_processor = $order_processor;
$this->session_handler = $session_handler;
$this->prefix = $prefix;
}
/**
@ -101,7 +95,7 @@ class EarlyOrderHandler {
$order_id = false;
foreach ( $order->purchase_units() as $purchase_unit ) {
if ( $purchase_unit->custom_id() === sanitize_text_field( wp_unslash( $_REQUEST['ppcp-resume-order'] ) ) ) {
$order_id = (int) $this->sanitize_custom_id( $purchase_unit->custom_id() );
$order_id = (int) $purchase_unit->custom_id();
}
}
if ( $order_id === $resume_order_id ) {

16
modules/ppcp-session/src/Cancellation/CancelController.php
View file

@ -9,12 +9,14 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\Session\Cancellation;
use WooCommerce\PayPalCommerce\Button\Helper\ContextTrait;
use WooCommerce\PayPalCommerce\Session\SessionHandler;
/**
* Class CancelController
*/
class CancelController {
use ContextTrait;
public const NONCE = 'ppcp-cancel';
@ -50,7 +52,7 @@ class CancelController {
/**
* Runs the controller.
*/
public function run() {
public function run(): void {
$param_name = self::NONCE;
if ( isset( $_GET[ $param_name ] ) && // Input var ok.
wp_verify_nonce(
@ -61,20 +63,10 @@ class CancelController {
$this->session_handler->destroy_session_data();
}
$order = $this->session_handler->order();
if ( ! $order ) {
if ( ! $this->is_paypal_continuation() ) {
return;
}
$source = $order->payment_source();
if ( $source && $source->card() ) {
return; // Ignore for DCC.
}
if ( 'card' === $this->session_handler->funding_source() ) {
return; // Ignore for card buttons.
}
$url = add_query_arg( array( $param_name => wp_create_nonce( self::NONCE ) ), wc_get_checkout_url() );
add_action(
'woocommerce_review_order_after_submit',

75
modules/ppcp-session/src/MemoryWcSession.php Normal file
View file

@ -0,0 +1,75 @@
<?php
/**
* A WC_Session_Handler subclass for loading the session when it is normally not available (e.g. in webhooks).
*
* @package WooCommerce\PayPalCommerce\Session
*
* phpcs:disable Generic.Commenting.DocComment
*/
declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\Session;
use WC_Session_Handler;
/**
* MemoryWcSession class.
*/
class MemoryWcSession extends WC_Session_Handler {
/**
* The session data (from WC()->session->get_session).
*
* @var array
*/
private static $data;
/**
* The customer ID.
*
* @var string|int
*/
private static $customer_id;
/**
* Enqueues this session handler with the given data to be used by WC.
*
* @param array $session_data The session data (from WC()->session->get_session).
* @param int|string $customer_id The customer ID.
*/
public static function replace_session_handler( array $session_data, $customer_id ): void {
self::$data = $session_data;
self::$customer_id = $customer_id;
add_filter(
'woocommerce_session_handler',
function () {
return MemoryWcSession::class;
}
);
}
/**
* @inerhitDoc
*/
public function init_session_cookie() {
$this->_customer_id = self::$customer_id;
$this->_data = self::$data;
}
/**
* @inerhitDoc
*/
public function get_session_data() {
return self::$data;
}
/**
* @inerhitDoc
*/
public function forget_session() {
self::$data = array();
parent::forget_session();
}
}

36
modules/ppcp-session/src/SessionHandler.php
View file

@ -47,6 +47,13 @@ class SessionHandler {
*/
private $funding_source = null;
/**
* The checkout form data.
*
* @var array
*/
private $checkout_form = array();
/**
* Returns the order.
*
@ -55,6 +62,8 @@ class SessionHandler {
public function order() {
$this->load_session();
do_action( 'ppcp_session_get_order', $this->order, $this );
return $this->order;
}
@ -71,6 +80,30 @@ class SessionHandler {
$this->store_session();
}
/**
* Returns the checkout form data.
*
* @return array
*/
public function checkout_form(): array {
$this->load_session();
return $this->checkout_form;
}
/**
* Replaces the checkout form data.
*
* @param array $checkout_form The checkout form data.
*/
public function replace_checkout_form( array $checkout_form ): void {
$this->load_session();
$this->checkout_form = $checkout_form;
$this->store_session();
}
/**
* Returns the BN Code.
*
@ -151,6 +184,7 @@ class SessionHandler {
$this->bn_code = '';
$this->insufficient_funding_tries = 0;
$this->funding_source = null;
$this->checkout_form = array();
$this->store_session();
return $this;
}
@ -188,6 +222,7 @@ class SessionHandler {
if ( ! is_string( $this->funding_source ) ) {
$this->funding_source = null;
}
$this->checkout_form = $data['checkout_form'] ?? array();
}
/**
@ -202,6 +237,7 @@ class SessionHandler {
'bn_code' => $obj->bn_code,
'insufficient_funding_tries' => $obj->insufficient_funding_tries,
'funding_source' => $obj->funding_source,
'checkout_form' => $obj->checkout_form,
);
}
}

50
modules/ppcp-session/src/SessionModule.php
View file

@ -9,6 +9,11 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\Session;
use Psr\Log\LoggerInterface;
use Throwable;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
use WooCommerce\PayPalCommerce\ApiClient\Entity\Order;
use WooCommerce\PayPalCommerce\ApiClient\Entity\OrderStatus;
use WooCommerce\PayPalCommerce\Vendor\Dhii\Container\ServiceProvider;
use WooCommerce\PayPalCommerce\Vendor\Dhii\Modular\Module\ModuleInterface;
use WooCommerce\PayPalCommerce\Session\Cancellation\CancelController;
@ -19,6 +24,12 @@ use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface;
* Class SessionModule
*/
class SessionModule implements ModuleInterface {
/**
* A flag to avoid multiple requests to reload order.
*
* @var bool
*/
private $reloaded_order = false;
/**
* {@inheritDoc}
@ -46,6 +57,45 @@ class SessionModule implements ModuleInterface {
$controller->run();
}
);
add_action(
'ppcp_session_get_order',
function ( ?Order $order, SessionHandler $session_handler ) use ( $c ): void {
if ( ! isset( WC()->session ) ) {
return;
}
if ( $this->reloaded_order ) {
return;
}
if ( ! $order ) {
return;
}
if ( $order->status()->is( OrderStatus::APPROVED )
|| $order->status()->is( OrderStatus::COMPLETED )
) {
return;
}
$order_endpoint = $c->get( 'api.endpoint.order' );
assert( $order_endpoint instanceof OrderEndpoint );
$this->reloaded_order = true;
try {
$session_handler->replace_order( $order_endpoint->order( $order->id() ) );
} catch ( Throwable $exception ) {
$logger = $c->get( 'woocommerce.logger.woocommerce' );
assert( $logger instanceof LoggerInterface );
$logger->warning( 'Failed to reload PayPal order in the session: ' . $exception->getMessage() );
}
},
10,
2
);
}
/**

10
modules/ppcp-wc-gateway/services.php
View file

@ -911,6 +911,12 @@ return array(
'paylater' => _x( 'Pay Later', 'Name of payment method', 'woocommerce-paypal-payments' ),
);
},
/**
* The sources that do not cause issues about redirecting (on mobile, ...) and sometimes not returning back.
*/
'wcgateway.funding-sources-without-redirect' => static function( ContainerInterface $container ): array {
return array( 'paypal', 'paylater', 'venmo', 'card' );
},
'wcgateway.settings.funding-sources' => static function( ContainerInterface $container ): array {
return array_diff_key(
$container->get( 'wcgateway.all-funding-sources' ),
@ -946,11 +952,11 @@ return array(
'wcgateway.endpoint.return-url' => static function ( ContainerInterface $container ) : ReturnUrlEndpoint {
$gateway = $container->get( 'wcgateway.paypal-gateway' );
$endpoint = $container->get( 'api.endpoint.order' );
$prefix = $container->get( 'api.prefix' );
return new ReturnUrlEndpoint(
$gateway,
$endpoint,
$prefix
$container->get( 'session.handler' ),
$container->get( 'woocommerce.logger.woocommerce' )
);
},

18
modules/ppcp-wc-gateway/src/Checkout/DisableGateways.php
View file

@ -9,6 +9,7 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\WcGateway\Checkout;
use WooCommerce\PayPalCommerce\Button\Helper\ContextTrait;
use WooCommerce\PayPalCommerce\Session\SessionHandler;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\CardButtonGateway;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\CreditCardGateway;
@ -20,6 +21,7 @@ use WooCommerce\PayPalCommerce\WcGateway\Helper\SettingsStatus;
* Class DisableGateways
*/
class DisableGateways {
use ContextTrait;
/**
* The Session Handler.
@ -127,20 +129,6 @@ class DisableGateways {
* @return bool
*/
private function needs_to_disable_gateways(): bool {
$order = $this->session_handler->order();
if ( ! $order ) {
return false;
}
$source = $order->payment_source();
if ( $source && $source->card() ) {
return false; // DCC.
}
if ( 'card' === $this->session_handler->funding_source() ) {
return false; // Card buttons.
}
return true;
return $this->is_paypal_continuation();
}
}

46
modules/ppcp-wc-gateway/src/Endpoint/ReturnUrlEndpoint.php
View file

@ -9,17 +9,18 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\WcGateway\Endpoint;
use Psr\Log\LoggerInterface;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
use WooCommerce\PayPalCommerce\ApiClient\Entity\OrderStatus;
use WooCommerce\PayPalCommerce\Session\SessionHandler;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\OXXO\OXXOGateway;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayPalGateway;
use WooCommerce\PayPalCommerce\Webhooks\Handler\PrefixTrait;
/**
* Class ReturnUrlEndpoint
*/
class ReturnUrlEndpoint {
use PrefixTrait;
const ENDPOINT = 'ppc-return-url';
/**
@ -36,17 +37,38 @@ class ReturnUrlEndpoint {
*/
private $order_endpoint;
/**
* The session handler
*
* @var SessionHandler
*/
protected $session_handler;
/**
* The logger.
*
* @var LoggerInterface
*/
protected $logger;
/**
* ReturnUrlEndpoint constructor.
*
* @param PayPalGateway $gateway The PayPal Gateway.
* @param OrderEndpoint $order_endpoint The Order Endpoint.
* @param string $prefix The prefix.
* @param SessionHandler $session_handler The session handler.
* @param LoggerInterface $logger The logger.
*/
public function __construct( PayPalGateway $gateway, OrderEndpoint $order_endpoint, string $prefix ) {
public function __construct(
PayPalGateway $gateway,
OrderEndpoint $order_endpoint,
SessionHandler $session_handler,
LoggerInterface $logger
) {
$this->gateway = $gateway;
$this->order_endpoint = $order_endpoint;
$this->prefix = $prefix;
$this->session_handler = $session_handler;
$this->logger = $logger;
}
/**
@ -63,13 +85,25 @@ class ReturnUrlEndpoint {
// phpcs:enable WordPress.Security.NonceVerification.Recommended
$order = $this->order_endpoint->order( $token );
$wc_order_id = $this->sanitize_custom_id( $order->purchase_units()[0]->custom_id() );
$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();
}
$this->logger->warning( "Return URL endpoint $token: no WC order ID." );
exit();
}
$wc_order = wc_get_order( $wc_order_id );
if ( ! is_a( $wc_order, \WC_Order::class ) ) {
$this->logger->warning( "Return URL endpoint $token: WC order $wc_order_id not found." );
exit();
}

6
modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php
View file

@ -13,6 +13,7 @@ use Exception;
use Psr\Log\LoggerInterface;
use WC_Order;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
use WooCommerce\PayPalCommerce\ApiClient\Entity\OrderStatus;
use WooCommerce\PayPalCommerce\ApiClient\Entity\PaymentToken;
use WooCommerce\PayPalCommerce\ApiClient\Exception\PayPalApiException;
use WooCommerce\PayPalCommerce\ApiClient\Exception\RuntimeException;
@ -253,9 +254,14 @@ class PayPalGateway extends \WC_Payment_Gateway {
$funding_source = $this->session_handler->funding_source();
if ( $funding_source ) {
$order = $this->session_handler->order();
if ( $order &&
( $order->status()->is( OrderStatus::APPROVED ) || $order->status()->is( OrderStatus::COMPLETED ) )
) {
$this->title = $this->funding_source_renderer->render_name( $funding_source );
$this->description = $this->funding_source_renderer->render_description( $funding_source );
}
}
$this->init_form_fields();
$this->init_settings();

4
modules/ppcp-wc-gateway/src/Processor/OrderProcessor.php
View file

@ -166,7 +166,7 @@ class OrderProcessor {
// 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 ) ) {
if ( ! $order && is_string( $order_id ) && $order_id ) {
$order = $this->order_endpoint->order( $order_id );
}
if ( ! $order ) {
@ -178,7 +178,7 @@ class OrderProcessor {
$wc_order->get_id()
)
);
$this->last_error = __( 'Could not retrieve order. This browser may not be supported. Please try again with a different browser.', 'woocommerce-paypal-payments' );
$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;
}

16
modules/ppcp-webhooks/services.php
View file

@ -82,12 +82,18 @@ return array(
$payment_token_factory = $container->get( 'vaulting.payment-token-factory' );
return array(
new CheckoutOrderApproved( $logger, $prefix, $order_endpoint ),
new CheckoutOrderCompleted( $logger, $prefix ),
new CheckoutOrderApproved(
$logger,
$order_endpoint,
$container->get( 'session.handler' ),
$container->get( 'wcgateway.funding-source.renderer' ),
$container->get( 'wcgateway.order-processor' )
),
new CheckoutOrderCompleted( $logger ),
new CheckoutPaymentApprovalReversed( $logger ),
new PaymentCaptureRefunded( $logger, $prefix ),
new PaymentCaptureReversed( $logger, $prefix ),
new PaymentCaptureCompleted( $logger, $prefix, $order_endpoint ),
new PaymentCaptureRefunded( $logger ),
new PaymentCaptureReversed( $logger ),
new PaymentCaptureCompleted( $logger, $order_endpoint ),
new VaultPaymentTokenCreated( $logger, $prefix, $authorized_payments_processor, $payment_token_factory ),
new VaultPaymentTokenDeleted( $logger ),
new PaymentCapturePending( $logger ),

18
modules/ppcp-webhooks/src/CustomIds.php Normal file
View file

@ -0,0 +1,18 @@
<?php
/**
* The constants for handling custom_id in the webhook requests.
*
* @package WooCommerce\PayPalCommerce\Webhooks
*/
declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\Webhooks;
/**
* Interface CustomIds
*/
interface CustomIds {
public const CUSTOMER_ID_PREFIX = 'pcp_customer_';
}

7
modules/ppcp-webhooks/src/Handler/BillingPlanPricingChangeActivated.php
View file

@ -17,6 +17,7 @@ use WP_REST_Response;
* Class BillingPlanPricingChangeActivated
*/
class BillingPlanPricingChangeActivated implements RequestHandler {
use RequestHandlerTrait;
/**
* The logger.
@ -64,9 +65,8 @@ class BillingPlanPricingChangeActivated implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
if ( is_null( $request['resource'] ) ) {
return new WP_REST_Response( $response );
return $this->failure_response();
}
$plan_id = wc_clean( wp_unslash( $request['resource']['id'] ?? '' ) );
@ -92,7 +92,6 @@ class BillingPlanPricingChangeActivated implements RequestHandler {
}
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

7
modules/ppcp-webhooks/src/Handler/BillingPlanUpdated.php
View file

@ -17,6 +17,7 @@ use WP_REST_Response;
* Class BillingPlanUpdated
*/
class BillingPlanUpdated implements RequestHandler {
use RequestHandlerTrait;
/**
* The logger.
@ -64,9 +65,8 @@ class BillingPlanUpdated implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
if ( is_null( $request['resource'] ) ) {
return new WP_REST_Response( $response );
return $this->failure_response();
}
$plan_id = wc_clean( wp_unslash( $request['resource']['id'] ?? '' ) );
@ -109,7 +109,6 @@ class BillingPlanUpdated implements RequestHandler {
}
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

7
modules/ppcp-webhooks/src/Handler/BillingSubscriptionCancelled.php
View file

@ -17,6 +17,7 @@ use WP_REST_Response;
* Class BillingSubscriptionCancelled
*/
class BillingSubscriptionCancelled implements RequestHandler {
use RequestHandlerTrait;
/**
* The logger.
@ -64,9 +65,8 @@ class BillingSubscriptionCancelled implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
if ( is_null( $request['resource'] ) ) {
return new WP_REST_Response( $response );
return $this->failure_response();
}
$subscription_id = wc_clean( wp_unslash( $request['resource']['id'] ?? '' ) );
@ -87,7 +87,6 @@ class BillingSubscriptionCancelled implements RequestHandler {
}
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

7
modules/ppcp-webhooks/src/Handler/CatalogProductUpdated.php
View file

@ -17,6 +17,7 @@ use WP_REST_Response;
* Class CatalogProductUpdated
*/
class CatalogProductUpdated implements RequestHandler {
use RequestHandlerTrait;
/**
* The logger.
@ -64,9 +65,8 @@ class CatalogProductUpdated implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
if ( is_null( $request['resource'] ) ) {
return new WP_REST_Response( $response );
return $this->failure_response();
}
$product_id = wc_clean( wp_unslash( $request['resource']['id'] ?? '' ) );
@ -104,7 +104,6 @@ class CatalogProductUpdated implements RequestHandler {
}
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

257
modules/ppcp-webhooks/src/Handler/CheckoutOrderApproved.php
View file

@ -9,18 +9,25 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\Webhooks\Handler;
use WC_Checkout;
use WC_Order;
use WC_Session_Handler;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
use WooCommerce\PayPalCommerce\ApiClient\Exception\RuntimeException;
use WooCommerce\PayPalCommerce\ApiClient\Entity\OrderStatus;
use Psr\Log\LoggerInterface;
use WooCommerce\PayPalCommerce\Session\MemoryWcSession;
use WooCommerce\PayPalCommerce\Session\SessionHandler;
use WooCommerce\PayPalCommerce\WcGateway\FundingSource\FundingSourceRenderer;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\OXXO\OXXOGateway;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayUponInvoice\PayUponInvoiceGateway;
use WooCommerce\PayPalCommerce\WcGateway\Processor\OrderProcessor;
/**
* Class CheckoutOrderApproved
*/
class CheckoutOrderApproved implements RequestHandler {
use PrefixTrait;
use RequestHandlerTrait;
/**
* The logger.
@ -36,17 +43,48 @@ class CheckoutOrderApproved implements RequestHandler {
*/
private $order_endpoint;
/**
* The Session handler.
*
* @var SessionHandler
*/
private $session_handler;
/**
* The funding source renderer.
*
* @var FundingSourceRenderer
*/
protected $funding_source_renderer;
/**
* The processor for orders.
*
* @var OrderProcessor
*/
protected $order_processor;
/**
* CheckoutOrderApproved constructor.
*
* @param LoggerInterface $logger The logger.
* @param string $prefix The prefix.
* @param OrderEndpoint $order_endpoint The order endpoint.
* @param SessionHandler $session_handler The session handler.
* @param FundingSourceRenderer $funding_source_renderer The funding source renderer.
* @param OrderProcessor $order_processor The Order Processor.
*/
public function __construct( LoggerInterface $logger, string $prefix, OrderEndpoint $order_endpoint ) {
public function __construct(
LoggerInterface $logger,
OrderEndpoint $order_endpoint,
SessionHandler $session_handler,
FundingSourceRenderer $funding_source_renderer,
OrderProcessor $order_processor
) {
$this->logger = $logger;
$this->prefix = $prefix;
$this->order_endpoint = $order_endpoint;
$this->session_handler = $session_handler;
$this->funding_source_renderer = $funding_source_renderer;
$this->order_processor = $order_processor;
}
/**
@ -79,114 +117,94 @@ class CheckoutOrderApproved implements RequestHandler {
* @return \WP_REST_Response
*/
public function handle_request( \WP_REST_Request $request ): \WP_REST_Response {
$response = array( 'success' => false );
$custom_ids = array_filter(
array_map(
static function ( array $purchase_unit ): string {
return isset( $purchase_unit['custom_id'] ) ?
(string) $purchase_unit['custom_id'] : '';
},
isset( $request['resource']['purchase_units'] ) ?
(array) $request['resource']['purchase_units'] : array()
),
static function ( string $order_id ): bool {
return ! empty( $order_id );
}
);
if ( empty( $custom_ids ) ) {
$message = sprintf(
// translators: %s is the PayPal webhook Id.
__(
'No order for webhook event %s was found.',
'woocommerce-paypal-payments'
),
isset( $request['id'] ) ? $request['id'] : ''
);
$this->logger->log(
'warning',
$message,
array(
'request' => $request,
$order_id = isset( $request['resource']['id'] ) ? $request['resource']['id'] : null;
if ( ! $order_id ) {
return $this->failure_response(
sprintf(
'No order ID in webhook event %s.',
$request['id'] ?: ''
)
);
$response['message'] = $message;
return rest_ensure_response( $response );
}
try {
$order = isset( $request['resource']['id'] ) ?
$this->order_endpoint->order( $request['resource']['id'] ) : null;
if ( ! $order ) {
$message = sprintf(
// translators: %s is the PayPal webhook Id.
__(
'No paypal payment for webhook event %s was found.',
'woocommerce-paypal-payments'
),
isset( $request['id'] ) ? $request['id'] : ''
);
$this->logger->log(
'warning',
$message,
array(
'request' => $request,
$order = $this->order_endpoint->order( $order_id );
$wc_orders = array();
$wc_order_ids = $this->get_wc_order_ids_from_request( $request );
if ( empty( $wc_order_ids ) ) {
$customer_ids = $this->get_wc_customer_ids_from_request( $request );
if ( empty( $customer_ids ) ) {
return $this->no_custom_ids_response( $request );
}
$customer_id = $customer_ids[0];
if ( $order->status()->is( OrderStatus::COMPLETED ) ) {
$this->logger->info( "Order {$order->id()} already completed." );
return $this->success_response();
}
$wc_session = new WC_Session_Handler();
$session_data = $wc_session->get_session( $customer_id );
if ( ! is_array( $session_data ) ) {
return $this->failure_response( "Failed to get session data {$customer_id}" );
}
MemoryWcSession::replace_session_handler( $session_data, $customer_id );
wc_load_cart();
WC()->cart->get_cart_from_session();
WC()->cart->calculate_shipping();
$form = $this->session_handler->checkout_form();
$checkout = new WC_Checkout();
$wc_order_id = $checkout->create_order( $form );
$wc_order = wc_get_order( $wc_order_id );
if ( ! $wc_order instanceof WC_Order ) {
return $this->failure_response(
sprintf(
'Failed to create WC order in webhook event %s.',
$request['id'] ?: ''
)
);
$response['message'] = $message;
return rest_ensure_response( $response );
}
if ( $order->intent() === 'CAPTURE' ) {
$order = $this->order_endpoint->capture( $order );
}
} catch ( RuntimeException $error ) {
$message = sprintf(
// translators: %s is the PayPal webhook Id.
__(
'Could not capture payment for webhook event %s.',
'woocommerce-paypal-payments'
),
isset( $request['id'] ) ? $request['id'] : ''
);
$this->logger->log(
'warning',
$message,
array(
'request' => $request,
)
);
$response['message'] = $message;
return rest_ensure_response( $response );
$funding_source = $this->session_handler->funding_source();
if ( $funding_source ) {
$wc_order->set_payment_method_title( $this->funding_source_renderer->render_name( $funding_source ) );
}
$wc_order_ids = array_map(
array(
$this,
'sanitize_custom_id',
),
$custom_ids
if ( is_numeric( $customer_id ) ) {
$wc_order->set_customer_id( (int) $customer_id );
}
$wc_order->save();
$wc_orders[] = $wc_order;
add_action(
'shutdown',
function () use ( $customer_id ): void {
$session = WC()->session;
assert( $session instanceof WC_Session_Handler );
/**
* Wrong type-hint.
*
* @psalm-suppress InvalidScalarArgument
*/
$session->delete_session( $customer_id );
$session->forget_session();
}
);
$args = array(
'post__in' => $wc_order_ids,
'limit' => -1,
);
$wc_orders = wc_get_orders( $args );
} else {
$wc_orders = $this->get_wc_orders_from_custom_ids( $wc_order_ids );
if ( ! $wc_orders ) {
$message = sprintf(
// translators: %s is the PayPal order Id.
__( 'Order for PayPal order %s not found.', 'woocommerce-paypal-payments' ),
isset( $request['resource']['id'] ) ? $request['resource']['id'] : ''
);
$this->logger->log(
'warning',
$message,
array(
'request' => $request,
)
);
$response['message'] = $message;
return rest_ensure_response( $response );
return $this->no_wc_orders_response( $request );
}
}
foreach ( $wc_orders as $wc_order ) {
@ -197,31 +215,24 @@ class CheckoutOrderApproved implements RequestHandler {
if ( ! in_array( $wc_order->get_status(), array( 'pending', 'on-hold' ), true ) ) {
continue;
}
if ( $order->intent() === 'CAPTURE' ) {
$wc_order->payment_complete();
} else {
$wc_order->update_status(
'on-hold',
__( 'Payment can be captured.', 'woocommerce-paypal-payments' )
);
}
$this->logger->log(
'info',
if ( ! $this->order_processor->process( $wc_order ) ) {
return $this->failure_response(
sprintf(
// translators: %s is the order ID.
__(
'Order %s has been updated through PayPal',
'woocommerce-paypal-payments'
),
(string) $wc_order->get_id()
),
array(
'request' => $request,
'order' => $wc_order,
'Failed to process WC order %s: %s.',
(string) $wc_order->get_id(),
$this->order_processor->last_error()
)
);
}
$response['success'] = true;
return rest_ensure_response( $response );
$this->logger->info(
sprintf(
'WC order %s has been processed after approval in PayPal.',
(string) $wc_order->get_id()
)
);
}
return $this->success_response();
}
}

21
modules/ppcp-webhooks/src/Handler/CheckoutOrderCompleted.php
View file

@ -19,7 +19,7 @@ use WP_REST_Response;
*/
class CheckoutOrderCompleted implements RequestHandler {
use PrefixTrait, RequestHandlerTrait;
use RequestHandlerTrait;
/**
* The logger.
@ -32,11 +32,9 @@ class CheckoutOrderCompleted implements RequestHandler {
* CheckoutOrderCompleted constructor.
*
* @param LoggerInterface $logger The logger.
* @param string $prefix The prefix.
*/
public function __construct( LoggerInterface $logger, string $prefix ) {
public function __construct( LoggerInterface $logger ) {
$this->logger = $logger;
$this->prefix = $prefix;
}
/**
@ -69,16 +67,14 @@ class CheckoutOrderCompleted implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
$custom_ids = $this->get_custom_ids_from_request( $request );
$custom_ids = $this->get_wc_order_ids_from_request( $request );
if ( empty( $custom_ids ) ) {
return $this->no_custom_ids_from_request( $request, $response );
return $this->no_custom_ids_response( $request );
}
$wc_orders = $this->get_wc_orders_from_custom_ids( $custom_ids );
if ( ! $wc_orders ) {
return $this->no_wc_orders_from_custom_ids( $request, $response );
return $this->no_wc_orders_response( $request );
}
foreach ( $wc_orders as $wc_order ) {
@ -93,17 +89,12 @@ class CheckoutOrderCompleted implements RequestHandler {
$this->logger->info(
sprintf(
// translators: %s is the order ID.
__(
'Order %s has been updated through PayPal',
'woocommerce-paypal-payments'
),
(string) $wc_order->get_id()
)
);
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

17
modules/ppcp-webhooks/src/Handler/CheckoutPaymentApprovalReversed.php
View file

@ -18,7 +18,7 @@ use WP_REST_Response;
*/
class CheckoutPaymentApprovalReversed implements RequestHandler {
use RequestHandlerTrait, PrefixTrait;
use RequestHandlerTrait;
/**
* The logger.
@ -66,26 +66,20 @@ class CheckoutPaymentApprovalReversed implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
$custom_ids = $this->get_custom_ids_from_request( $request );
$custom_ids = $this->get_wc_order_ids_from_request( $request );
if ( empty( $custom_ids ) ) {
return $this->no_custom_ids_from_request( $request, $response );
return $this->no_custom_ids_response( $request );
}
$wc_orders = $this->get_wc_orders_from_custom_ids( $custom_ids );
if ( ! $wc_orders ) {
return $this->no_wc_orders_from_custom_ids( $request, $response );
return $this->no_wc_orders_response( $request );
}
foreach ( $wc_orders as $wc_order ) {
if ( in_array( $wc_order->get_status(), array( 'pending', 'on-hold' ), true ) ) {
$error_message = sprintf(
// translators: %1$s is the order id.
__(
'Failed to capture order %1$s through PayPal.',
'woocommerce-paypal-payments'
),
(string) $wc_order->get_id()
);
@ -95,7 +89,6 @@ class CheckoutPaymentApprovalReversed implements RequestHandler {
}
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

39
modules/ppcp-webhooks/src/Handler/PaymentCaptureCompleted.php
View file

@ -22,7 +22,7 @@ use WP_REST_Response;
*/
class PaymentCaptureCompleted implements RequestHandler {
use PrefixTrait, TransactionIdHandlingTrait;
use TransactionIdHandlingTrait, RequestHandlerTrait;
/**
* The logger.
@ -42,16 +42,13 @@ class PaymentCaptureCompleted implements RequestHandler {
* PaymentCaptureCompleted constructor.
*
* @param LoggerInterface $logger The logger.
* @param string $prefix The prefix.
* @param OrderEndpoint $order_endpoint The order endpoint.
*/
public function __construct(
LoggerInterface $logger,
string $prefix,
OrderEndpoint $order_endpoint
) {
$this->logger = $logger;
$this->prefix = $prefix;
$this->order_endpoint = $order_endpoint;
}
@ -83,33 +80,24 @@ class PaymentCaptureCompleted implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( \WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
$webhook_id = (string) ( $request['id'] ?? '' );
$resource = $request['resource'];
if ( ! is_array( $resource ) ) {
$message = 'Resource data not found in webhook request.';
$this->logger->warning( $message, array( 'request' => $request ) );
$response['message'] = $message;
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$wc_order_id = isset( $resource['custom_id'] ) ?
$this->sanitize_custom_id( (string) $resource['custom_id'] ) : 0;
$wc_order_id = isset( $resource['custom_id'] ) ? (string) $resource['custom_id'] : 0;
if ( ! $wc_order_id ) {
$message = sprintf( 'No order for webhook event %s was found.', $webhook_id );
$this->logger->warning( $message, array( 'request' => $request ) );
$response['message'] = $message;
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$wc_order = wc_get_order( $wc_order_id );
if ( ! is_a( $wc_order, \WC_Order::class ) ) {
$message = sprintf( 'No order for webhook event %s was found.', $webhook_id );
$this->logger->warning( $message, array( 'request' => $request ) );
$response['message'] = $message;
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$order_id = $resource['supplementary_data']['related_ids']['order_id'] ?? null;
@ -120,8 +108,7 @@ class PaymentCaptureCompleted implements RequestHandler {
do_action( 'ppcp_payment_capture_completed_webhook_handler', $wc_order, $order_id );
if ( $wc_order->get_status() !== 'on-hold' ) {
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
$wc_order->add_order_note(
__( 'Payment successfully captured.', 'woocommerce-paypal-payments' )
@ -130,19 +117,10 @@ class PaymentCaptureCompleted implements RequestHandler {
$wc_order->payment_complete();
$wc_order->update_meta_data( AuthorizedPaymentsProcessor::CAPTURED_META_KEY, 'true' );
$wc_order->save();
$this->logger->log(
'info',
$this->logger->info(
sprintf(
// translators: %s is the order ID.
__(
'Order %s has been updated through PayPal',
'woocommerce-paypal-payments'
),
(string) $wc_order->get_id()
),
array(
'request' => $request,
'order' => $wc_order,
)
);
@ -159,7 +137,6 @@ class PaymentCaptureCompleted implements RequestHandler {
}
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

31
modules/ppcp-webhooks/src/Handler/PaymentCapturePending.php
View file

@ -18,7 +18,7 @@ use WP_REST_Response;
*/
class PaymentCapturePending implements RequestHandler {
use PrefixTrait;
use RequestHandlerTrait;
/**
* The logger.
@ -66,36 +66,21 @@ class PaymentCapturePending implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
$order_id = $request['resource'] !== null && isset( $request['resource']['custom_id'] )
? $this->sanitize_custom_id( $request['resource']['custom_id'] )
? $request['resource']['custom_id']
: 0;
if ( ! $order_id ) {
$message = sprintf(
// translators: %s is the PayPal webhook Id.
__(
'No order for webhook event %s was found.',
'woocommerce-paypal-payments'
),
$request['id'] !== null && isset( $request['id'] ) ? $request['id'] : ''
);
$this->logger->log(
'warning',
$message,
array(
'request' => $request,
)
);
$response['message'] = $message;
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$resource = $request['resource'];
if ( ! is_array( $resource ) ) {
$message = 'Resource data not found in webhook request.';
$this->logger->warning( $message, array( 'request' => $request ) );
$response['message'] = $message;
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$wc_order = wc_get_order( $order_id );
@ -105,10 +90,7 @@ class PaymentCapturePending implements RequestHandler {
$request['resource'] !== null && isset( $request['resource']['id'] ) ? $request['resource']['id'] : ''
);
$this->logger->warning( $message );
$response['message'] = $message;
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
if ( $wc_order->get_status() === 'pending' ) {
@ -116,7 +98,6 @@ class PaymentCapturePending implements RequestHandler {
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

80
modules/ppcp-webhooks/src/Handler/PaymentCaptureRefunded.php
View file

@ -10,8 +10,10 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\Webhooks\Handler;
use Psr\Log\LoggerInterface;
use WC_Order;
use WooCommerce\PayPalCommerce\WcGateway\Processor\RefundMetaTrait;
use WooCommerce\PayPalCommerce\WcGateway\Processor\TransactionIdHandlingTrait;
use WP_Error;
use WP_REST_Request;
use WP_REST_Response;
@ -20,7 +22,7 @@ use WP_REST_Response;
*/
class PaymentCaptureRefunded implements RequestHandler {
use PrefixTrait, TransactionIdHandlingTrait, RefundMetaTrait;
use TransactionIdHandlingTrait, RefundMetaTrait, RequestHandlerTrait;
/**
* The logger.
@ -33,11 +35,9 @@ class PaymentCaptureRefunded implements RequestHandler {
* PaymentCaptureRefunded constructor.
*
* @param LoggerInterface $logger The logger.
* @param string $prefix The prefix.
*/
public function __construct( LoggerInterface $logger, string $prefix ) {
public function __construct( LoggerInterface $logger ) {
$this->logger = $logger;
$this->prefix = $prefix;
}
/**
@ -68,59 +68,32 @@ class PaymentCaptureRefunded implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
$order_id = isset( $request['resource']['custom_id'] ) ?
$this->sanitize_custom_id( $request['resource']['custom_id'] ) : 0;
$request['resource']['custom_id'] : 0;
$refund_id = (string) ( $request['resource']['id'] ?? '' );
if ( ! $order_id ) {
$message = sprintf(
// translators: %s is the PayPal webhook Id.
__(
'No order for webhook event %s was found.',
'woocommerce-paypal-payments'
),
isset( $request['id'] ) ? $request['id'] : ''
);
$this->logger->log(
'warning',
$message,
array(
'request' => $request,
)
);
$response['message'] = $message;
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$wc_order = wc_get_order( $order_id );
if ( ! is_a( $wc_order, \WC_Order::class ) ) {
if ( ! is_a( $wc_order, WC_Order::class ) ) {
$message = sprintf(
// translators: %s is the PayPal refund Id.
__( 'Order for PayPal refund %s not found.', 'woocommerce-paypal-payments' ),
'Order for PayPal refund %s not found.',
$refund_id
);
$this->logger->log(
'warning',
$message,
array(
'request' => $request,
)
);
$response['message'] = $message;
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$already_added_refunds = $this->get_refunds_meta( $wc_order );
if ( in_array( $refund_id, $already_added_refunds, true ) ) {
$this->logger->info( "Refund {$refund_id} is already handled." );
return new WP_REST_Response( $response );
return $this->success_response();
}
/**
* The WooCommerce order.
*
* @var \WC_Order $wc_order
*/
$refund = wc_create_refund(
array(
'order_id' => $wc_order->get_id(),
@ -128,37 +101,21 @@ class PaymentCaptureRefunded implements RequestHandler {
)
);
if ( is_wp_error( $refund ) ) {
$this->logger->log(
'warning',
sprintf(
// translators: %s is the order id.
__( 'Order %s could not be refunded', 'woocommerce-paypal-payments' ),
(string) $wc_order->get_id()
),
array(
'request' => $request,
'error' => $refund,
)
assert( $refund instanceof WP_Error );
$message = sprintf(
'Order %1$s could not be refunded. %2$s',
(string) $wc_order->get_id(),
$refund->get_error_message()
);
$response['message'] = $refund->get_error_message();
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$this->logger->log(
'info',
$this->logger->info(
sprintf(
// translators: %1$s is the order id %2$s is the amount which has been refunded.
__(
'Order %1$s has been refunded with %2$s through PayPal',
'woocommerce-paypal-payments'
),
(string) $wc_order->get_id(),
(string) $refund->get_amount()
),
array(
'request' => $request,
'order' => $wc_order,
)
);
@ -167,7 +124,6 @@ class PaymentCaptureRefunded implements RequestHandler {
$this->add_refund_to_meta( $wc_order, $refund_id );
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

71
modules/ppcp-webhooks/src/Handler/PaymentCaptureReversed.php
View file

@ -19,7 +19,7 @@ use Psr\Log\LoggerInterface;
*/
class PaymentCaptureReversed implements RequestHandler {
use PrefixTrait;
use RequestHandlerTrait;
/**
* The logger.
@ -32,11 +32,9 @@ class PaymentCaptureReversed implements RequestHandler {
* PaymentCaptureReversed constructor.
*
* @param LoggerInterface $logger The logger.
* @param string $prefix The prefix.
*/
public function __construct( LoggerInterface $logger, string $prefix ) {
public function __construct( LoggerInterface $logger ) {
$this->logger = $logger;
$this->prefix = $prefix;
}
/**
@ -71,45 +69,23 @@ class PaymentCaptureReversed implements RequestHandler {
* @return \WP_REST_Response
*/
public function handle_request( \WP_REST_Request $request ): \WP_REST_Response {
$response = array( 'success' => false );
$order_id = isset( $request['resource']['custom_id'] ) ?
$this->sanitize_custom_id( $request['resource']['custom_id'] ) : 0;
$request['resource']['custom_id'] : 0;
if ( ! $order_id ) {
$message = sprintf(
// translators: %s is the PayPal webhook Id.
__(
'No order for webhook event %s was found.',
'woocommerce-paypal-payments'
),
isset( $request['id'] ) ? $request['id'] : ''
);
$this->logger->log(
'warning',
$message,
array(
'request' => $request,
)
);
$response['message'] = $message;
return rest_ensure_response( $response );
return $this->failure_response( $message );
}
$wc_order = wc_get_order( $order_id );
if ( ! is_a( $wc_order, \WC_Order::class ) ) {
$message = sprintf(
// translators: %s is the PayPal refund Id.
__( 'Order for PayPal refund %s not found.', 'woocommerce-paypal-payments' ),
'Order for PayPal refund %s not found.',
isset( $request['resource']['id'] ) ? $request['resource']['id'] : ''
);
$this->logger->log(
'warning',
$message,
array(
'request' => $request,
)
);
$response['message'] = $message;
return rest_ensure_response( $response );
return $this->failure_response( $message );
}
/**
@ -117,33 +93,20 @@ class PaymentCaptureReversed implements RequestHandler {
*/
$note = apply_filters( 'ppcp_payment_capture_reversed_webhook_update_status_note', '', $wc_order, $request['event_type'] );
/**
* The WooCommerce order.
*
* @var \WC_Order $wc_order
*/
$response['success'] = (bool) $wc_order->update_status( 'cancelled', $note );
$is_success = $wc_order->update_status( 'cancelled', $note );
if ( ! $is_success ) {
$message = sprintf(
'Failed to cancel order %1$s cancelled through PayPal',
(string) $wc_order->get_id()
);
return $this->failure_response( $message );
}
$message = $response['success'] ? sprintf(
// translators: %1$s is the order id.
__(
$message = sprintf(
'Order %1$s has been cancelled through PayPal',
'woocommerce-paypal-payments'
),
(string) $wc_order->get_id()
) : sprintf(
// translators: %1$s is the order id.
__( 'Failed to cancel order %1$s through PayPal', 'woocommerce-paypal-payments' ),
(string) $wc_order->get_id()
);
$this->logger->log(
$response['success'] ? 'info' : 'warning',
$message,
array(
'request' => $request,
'order' => $wc_order,
)
);
return rest_ensure_response( $response );
$this->logger->info( $message );
return $this->success_response();
}
}

12
modules/ppcp-webhooks/src/Handler/PaymentSaleCompleted.php
View file

@ -20,7 +20,7 @@ use WP_REST_Response;
*/
class PaymentSaleCompleted implements RequestHandler {
use TransactionIdHandlingTrait;
use TransactionIdHandlingTrait, RequestHandlerTrait;
/**
* The logger.
@ -67,17 +67,14 @@ class PaymentSaleCompleted implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
if ( is_null( $request['resource'] ) ) {
return new WP_REST_Response( $response );
return $this->failure_response();
}
$billing_agreement_id = wc_clean( wp_unslash( $request['resource']['billing_agreement_id'] ?? '' ) );
if ( ! $billing_agreement_id ) {
$message = 'Could not retrieve billing agreement id for subscription.';
$this->logger->warning( $message, array( 'request' => $request ) );
$response['message'] = $message;
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$args = array(
@ -99,7 +96,6 @@ class PaymentSaleCompleted implements RequestHandler {
}
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

29
modules/ppcp-webhooks/src/Handler/PaymentSaleRefunded.php
View file

@ -21,7 +21,7 @@ use WP_REST_Response;
*/
class PaymentSaleRefunded implements RequestHandler {
use TransactionIdHandlingTrait, RefundMetaTrait;
use TransactionIdHandlingTrait, RefundMetaTrait, RequestHandlerTrait;
/**
* The logger.
@ -68,16 +68,15 @@ class PaymentSaleRefunded implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
if ( is_null( $request['resource'] ) ) {
return new WP_REST_Response( $response );
return $this->failure_response();
}
$refund_id = (string) ( $request['resource']['id'] ?? '' );
$transaction_id = $request['resource']['sale_id'] ?? '';
$total_refunded_amount = $request['resource']['total_refunded_amount']['value'] ?? '';
if ( ! $refund_id || ! $transaction_id || ! $total_refunded_amount ) {
return new WP_REST_Response( $response );
return $this->failure_response();
}
$args = array(
@ -90,7 +89,7 @@ class PaymentSaleRefunded implements RequestHandler {
$wc_orders = wc_get_orders( $args );
if ( ! is_array( $wc_orders ) ) {
return new WP_REST_Response( $response );
return $this->failure_response();
}
foreach ( $wc_orders as $wc_order ) {
@ -102,24 +101,17 @@ class PaymentSaleRefunded implements RequestHandler {
);
if ( $refund instanceof WP_Error ) {
$this->logger->warning(
sprintf(
// translators: %s is the order id.
__( 'Order %s could not be refunded', 'woocommerce-paypal-payments' ),
(string) $wc_order->get_id()
)
$message = sprintf(
'Order %s could not be refunded. %s',
(string) $wc_order->get_id(),
$refund->get_error_message()
);
$response['message'] = $refund->get_error_message();
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$order_refunded_message = sprintf(
// translators: %1$s is the order id %2$s is the amount which has been refunded.
__(
'Order %1$s has been refunded with %2$s through PayPal.',
'woocommerce-paypal-payments'
),
(string) $wc_order->get_id(),
(string) $total_refunded_amount
);
@ -130,7 +122,6 @@ class PaymentSaleRefunded implements RequestHandler {
$this->add_refund_to_meta( $wc_order, $refund_id );
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

40
modules/ppcp-webhooks/src/Handler/PrefixTrait.php
View file

@ -1,40 +0,0 @@
<?php
/**
* Trait which helps to remove the prefix of IDs.
*
* @package WooCommerce\PayPalCommerce\Webhooks\Handler
*/
declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\Webhooks\Handler;
/**
* Trait PrefixTrait
*/
trait PrefixTrait {
/**
* The prefix.
*
* @var string
*/
private $prefix = '';
/**
* Removes the prefix from a given Id.
*
* @param string $custom_id The custom id.
*
* @return int
*/
private function sanitize_custom_id( string $custom_id ): int {
$id = $custom_id;
if ( strlen( $this->prefix ) > 0 && 0 === strpos( $id, $this->prefix ) ) {
$id = substr( $id, strlen( $this->prefix ) );
}
return (int) $id;
}
}

159
modules/ppcp-webhooks/src/Handler/RequestHandlerTrait.php
View file

@ -9,8 +9,8 @@ declare(strict_types=1);
namespace WooCommerce\PayPalCommerce\Webhooks\Handler;
use stdClass;
use WC_Order;
use WooCommerce\PayPalCommerce\Webhooks\CustomIds;
use WP_REST_Request;
use WP_REST_Response;
@ -19,22 +19,78 @@ trait RequestHandlerTrait {
/**
* Get available custom ids from the given request
*
* @param \WP_REST_Request $request The request.
* @return array
* @param WP_REST_Request $request The request.
* @return string[]
*/
protected function get_custom_ids_from_request( WP_REST_Request $request ): array {
return array_filter(
array_map(
static function ( array $purchase_unit ): string {
return isset( $purchase_unit['custom_id'] ) ?
(string) $purchase_unit['custom_id'] : '';
},
$request['resource'] !== null && isset( $request['resource']['purchase_units'] ) ?
(array) $request['resource']['purchase_units'] : array()
),
static function ( string $order_id ): bool {
return ! empty( $order_id );
$resource = $request['resource'];
if ( ! is_array( $resource ) ) {
return array();
}
$ids = array();
if ( isset( $resource['custom_id'] ) && ! empty( $resource['custom_id'] ) ) {
$ids[] = $resource['custom_id'];
} elseif ( isset( $resource['purchase_units'] ) ) {
$ids = array_map(
static function ( array $purchase_unit ): string {
return $purchase_unit['custom_id'] ?? '';
},
(array) $resource['purchase_units']
);
}
return array_values(
array_filter(
$ids,
function ( string $id ): bool {
return ! empty( $id );
}
)
);
}
/**
* Get available WC order ids from the given request.
*
* @param WP_REST_Request $request The request.
* @return string[]
*/
protected function get_wc_order_ids_from_request( WP_REST_Request $request ): array {
$ids = $this->get_custom_ids_from_request( $request );
return array_values(
array_filter(
$ids,
function ( string $id ): bool {
return strpos( $id, CustomIds::CUSTOMER_ID_PREFIX ) === false;
}
)
);
}
/**
* Get available WC customer ids from the given request.
*
* @param WP_REST_Request $request The request.
* @return string[]
*/
protected function get_wc_customer_ids_from_request( WP_REST_Request $request ): array {
$ids = $this->get_custom_ids_from_request( $request );
$customer_ids = array_values(
array_filter(
$ids,
function ( string $id ): bool {
return strpos( $id, CustomIds::CUSTOMER_ID_PREFIX ) === 0;
}
)
);
return array_map(
function ( string $str ): string {
return (string) substr( $str, strlen( CustomIds::CUSTOMER_ID_PREFIX ) );
},
$customer_ids
);
}
@ -45,13 +101,7 @@ trait RequestHandlerTrait {
* @return WC_Order[]
*/
protected function get_wc_orders_from_custom_ids( array $custom_ids ): array {
$order_ids = array_map(
array(
$this,
'sanitize_custom_id',
),
$custom_ids
);
$order_ids = $custom_ids;
$args = array(
'post__in' => $order_ids,
'limit' => -1,
@ -62,49 +112,62 @@ trait RequestHandlerTrait {
}
/**
* Return and log response for no custom ids found in request.
* Logs and returns response for no custom ids found in request.
*
* @param WP_REST_Request $request The request.
* @param array $response The response.
* @return WP_REST_Response
*/
protected function no_custom_ids_from_request( WP_REST_Request $request, array $response ): WP_REST_Response {
protected function no_custom_ids_response( WP_REST_Request $request ): WP_REST_Response {
$message = sprintf(
// translators: %s is the PayPal webhook Id.
__( 'No order for webhook event %s was found.', 'woocommerce-paypal-payments' ),
$request['id'] !== null && isset( $request['id'] ) ? $request['id'] : ''
);
return $this->log_and_return_response( $message, $response );
}
/**
* Return and log response for no WC orders found in response.
*
* @param WP_REST_Request $request The request.
* @param array $response The response.
* @return WP_REST_Response
*/
protected function no_wc_orders_from_custom_ids( WP_REST_Request $request, array $response ): WP_REST_Response {
$message = sprintf(
// translators: %s is the PayPal order Id.
__( 'WC order for PayPal order %s not found.', 'woocommerce-paypal-payments' ),
'WC order ID was not found in webhook event %s for PayPal order %s.',
(string) ( $request['id'] ?? '' ),
// Psalm 4.x does not seem to understand ?? with ArrayAccess correctly.
$request['resource'] !== null && isset( $request['resource']['id'] ) ? $request['resource']['id'] : ''
);
return $this->log_and_return_response( $message, $response );
return $this->failure_response( $message );
}
/**
* Return and log response with the given message.
* Logs and returns response for no WC orders found via custom ids.
*
* @param string $message The message.
* @param array $response The response.
* @param WP_REST_Request $request The request.
* @return WP_REST_Response
*/
private function log_and_return_response( string $message, array $response ): WP_REST_Response {
protected function no_wc_orders_response( WP_REST_Request $request ): WP_REST_Response {
$message = sprintf(
'WC order %s not found in webhook event %s for PayPal order %s.',
implode( ', ', $this->get_custom_ids_from_request( $request ) ),
(string) ( $request['id'] ?? '' ),
$request['resource'] !== null && isset( $request['resource']['id'] ) ? $request['resource']['id'] : ''
);
return $this->failure_response( $message );
}
/**
* Returns success response.
*
* @return WP_REST_Response
*/
protected function success_response(): WP_REST_Response {
return new WP_REST_Response( array( 'success' => true ) );
}
/**
* Logs and returns failure response with the given message.
*
* @param string $message The message.
* @return WP_REST_Response
*/
private function failure_response( string $message = '' ): WP_REST_Response {
$response = array(
'success' => false,
);
if ( $message ) {
$this->logger->warning( $message );
$response['message'] = $message;
}
return new WP_REST_Response( $response );
}

10
modules/ppcp-webhooks/src/Handler/VaultPaymentTokenCreated.php
View file

@ -24,6 +24,7 @@ use WP_REST_Response;
* Class VaultPaymentTokenCreated
*/
class VaultPaymentTokenCreated implements RequestHandler {
use RequestHandlerTrait;
/**
* The logger.
@ -103,16 +104,12 @@ class VaultPaymentTokenCreated implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
$customer_id = null !== $request['resource'] && isset( $request['resource']['customer_id'] )
? $request['resource']['customer_id']
: '';
if ( ! $customer_id ) {
$message = 'No customer id was found.';
$this->logger->warning( $message, array( 'request' => $request ) );
$response['message'] = $message;
return new WP_REST_Response( $response );
return $this->failure_response( $message );
}
$wc_customer_id = (int) str_replace( $this->prefix, '', $customer_id );
@ -150,7 +147,6 @@ class VaultPaymentTokenCreated implements RequestHandler {
}
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

6
modules/ppcp-webhooks/src/Handler/VaultPaymentTokenDeleted.php
View file

@ -18,6 +18,7 @@ use WP_REST_Response;
* Class VaultPaymentTokenDeleted
*/
class VaultPaymentTokenDeleted implements RequestHandler {
use RequestHandlerTrait;
/**
* The logger.
@ -65,8 +66,6 @@ class VaultPaymentTokenDeleted implements RequestHandler {
* @return WP_REST_Response
*/
public function handle_request( WP_REST_Request $request ): WP_REST_Response {
$response = array( 'success' => false );
if ( ! is_null( $request['resource'] ) && isset( $request['resource']['id'] ) ) {
$token_id = wc_clean( wp_unslash( $request['resource']['id'] ?? '' ) );
@ -89,7 +88,6 @@ class VaultPaymentTokenDeleted implements RequestHandler {
}
}
$response['success'] = true;
return new WP_REST_Response( $response );
return $this->success_response();
}
}

36
modules/ppcp-webhooks/src/IncomingWebhookEndpoint.php
View file

@ -17,12 +17,14 @@ use WooCommerce\PayPalCommerce\ApiClient\Exception\RuntimeException;
use WooCommerce\PayPalCommerce\ApiClient\Factory\WebhookEventFactory;
use WooCommerce\PayPalCommerce\Webhooks\Handler\RequestHandler;
use Psr\Log\LoggerInterface;
use WooCommerce\PayPalCommerce\Webhooks\Handler\RequestHandlerTrait;
use WooCommerce\PayPalCommerce\Webhooks\Status\WebhookSimulation;
/**
* Class IncomingWebhookEndpoint
*/
class IncomingWebhookEndpoint {
use RequestHandlerTrait;
const NAMESPACE = 'paypal/v1';
const ROUTE = 'incoming';
@ -211,26 +213,16 @@ class IncomingWebhookEndpoint {
if ( $this->simulation->is_simulation_event( $event ) ) {
$this->logger->info( 'Received simulated webhook.' );
$this->simulation->receive( $event );
return rest_ensure_response(
array(
'success' => true,
)
);
return $this->success_response();
}
foreach ( $this->handlers as $handler ) {
if ( $handler->responsible_for_request( $request ) ) {
$response = $handler->handle_request( $request );
$this->logger->log(
'info',
$this->logger->info(
sprintf(
// translators: %s is the event type.
__( 'Webhook has been handled by %s', 'woocommerce-paypal-payments' ),
'Webhook has been handled by %s',
( $handler->event_types() ) ? current( $handler->event_types() ) : ''
),
array(
'request' => $request,
'response' => $response,
)
);
return $response;
@ -238,22 +230,10 @@ class IncomingWebhookEndpoint {
}
$message = sprintf(
// translators: %s is the request type.
__( 'Could not find handler for request type %s', 'woocommerce-paypal-payments' ),
$request['event_type']
'Could not find handler for request type %s',
$request['event_type'] ?: ''
);
$this->logger->log(
'warning',
$message,
array(
'request' => $request,
)
);
$response = array(
'success' => false,
'message' => $message,
);
return rest_ensure_response( $response );
return $this->failure_response( $message );
}
/**

6
tests/PHPUnit/ApiClient/Factory/PurchaseUnitFactoryTest.php
View file

@ -258,7 +258,7 @@ class PurchaseUnitFactoryTest extends TestCase
{
$wcCustomer = Mockery::mock(\WC_Customer::class);
expect('WC')
->andReturn((object) ['customer' => $wcCustomer]);
->andReturn((object) ['customer' => $wcCustomer, 'session' => null]);
$wcCart = Mockery::mock(\WC_Cart::class);
$amount = Mockery::mock(Amount::class);
@ -322,7 +322,7 @@ class PurchaseUnitFactoryTest extends TestCase
public function testWcCartShippingGetsDroppendWhenNoCustomer()
{
expect('WC')
->andReturn((object) ['customer' => null]);
->andReturn((object) ['customer' => null, 'session' => null]);
$wcCart = Mockery::mock(\WC_Cart::class);
$amount = Mockery::mock(Amount::class);
@ -360,7 +360,7 @@ class PurchaseUnitFactoryTest extends TestCase
public function testWcCartShippingGetsDroppendWhenNoCountryCode()
{
expect('WC')
->andReturn((object) ['customer' => Mockery::mock(\WC_Customer::class)]);
->andReturn((object) ['customer' => Mockery::mock(\WC_Customer::class), 'session' => null]);
$wcCart = Mockery::mock(\WC_Cart::class);
$amount = Mockery::mock(Amount::class);

1
tests/PHPUnit/Button/Endpoint/CreateOrderEndpointTest.php
View file

@ -169,6 +169,7 @@ class CreateOrderEndpointTest extends TestCase
false,
['checkout'],
false,
['paypal'],
new NullLogger()
);
return array($payer_factory, $testee);

7
tests/PHPUnit/WcGateway/Gateway/WcGatewayTest.php
View file

@ -5,6 +5,8 @@ namespace WooCommerce\PayPalCommerce\WcGateway\Gateway;
use Psr\Log\LoggerInterface;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
use WooCommerce\PayPalCommerce\ApiClient\Entity\Order;
use WooCommerce\PayPalCommerce\ApiClient\Entity\OrderStatus;
use WooCommerce\PayPalCommerce\Onboarding\Environment;
use WooCommerce\PayPalCommerce\Onboarding\State;
use WooCommerce\PayPalCommerce\Session\SessionHandler;
@ -75,6 +77,11 @@ class WcGatewayTest extends TestCase
->andReturnUsing(function () {
return $this->fundingSource;
});
$order = Mockery::mock(Order::class);
$order->shouldReceive('status')->andReturn(new OrderStatus(OrderStatus::APPROVED));
$this->sessionHandler
->shouldReceive('order')
->andReturn($order);
$this->settings->shouldReceive('has')->andReturnFalse();

74
tests/playwright/place-order.spec.js
View file

@ -1,6 +1,6 @@
const {test, expect} = require('@playwright/test');
const {serverExec} = require("./utils/server");
const {fillCheckoutForm, expectOrderReceivedPage} = require("./utils/checkout");
const {fillCheckoutForm, expectOrderReceivedPage, acceptTerms} = require("./utils/checkout");
const {openPaypalPopup, loginIntoPaypal, waitForPaypalShippingList, completePaypalPayment} = require("./utils/paypal-popup");
const {
@ -11,9 +11,11 @@ const {
PRODUCT_ID,
CHECKOUT_URL,
CHECKOUT_PAGE_ID,
CART_URL,
BLOCK_CHECKOUT_URL,
BLOCK_CHECKOUT_PAGE_ID,
BLOCK_CART_URL,
APM_ID,
} = process.env;
async function completeBlockContinuation(page) {
@ -21,11 +23,25 @@ async function completeBlockContinuation(page) {
await expect(page.locator('.component-frame')).toHaveCount(0);
await page.locator('.wc-block-components-checkout-place-order-button').click();
await Promise.all(
page.waitForNavigation(),
page.locator('.wc-block-components-checkout-place-order-button').click(),
);
}
await page.waitForNavigation();
async function expectContinuation(page) {
await expect(page.locator('#payment_method_ppcp-gateway')).toBeChecked();
await expectOrderReceivedPage(page);
await expect(page.locator('.component-frame')).toHaveCount(0);
}
async function completeContinuation(page) {
await expectContinuation(page);
await Promise.all([
page.waitForNavigation(),
page.locator('#place_order').click(),
]);
}
test.describe('Classic checkout', () => {
@ -44,10 +60,7 @@ test.describe('Classic checkout', () => {
await fillCheckoutForm(page);
await Promise.all([
page.waitForNavigation(),
page.locator('#place_order').click(),
]);
await completeContinuation(page);
await expectOrderReceivedPage(page);
});
@ -77,6 +90,47 @@ test.describe('Classic checkout', () => {
await expectOrderReceivedPage(page);
});
test('PayPal APM button place order', async ({page}) => {
await page.goto(CART_URL + '?add-to-cart=' + PRODUCT_ID);
await page.goto(CHECKOUT_URL);
await fillCheckoutForm(page);
const popup = await openPaypalPopup(page, {fundingSource: APM_ID});
await popup.getByText('Continue', { exact: true }).click();
await completePaypalPayment(popup, {selector: '[name="Successful"]'});
await expectOrderReceivedPage(page);
});
test('PayPal APM button place order when redirect fails', async ({page}) => {
await page.goto(CART_URL + '?add-to-cart=' + PRODUCT_ID);
await page.goto(CHECKOUT_URL);
await fillCheckoutForm(page);
await page.evaluate('PayPalCommerceGateway.ajax.approve_order = null');
const popup = await openPaypalPopup(page, {fundingSource: APM_ID});
await popup.getByText('Continue', { exact: true }).click();
await completePaypalPayment(popup, {selector: '[name="Successful"]'});
await expect(page.locator('.woocommerce-error')).toBeVisible();
await page.reload();
await expectContinuation(page);
await acceptTerms(page);
await completeContinuation(page);
await expectOrderReceivedPage(page);
});
});
test.describe('Block checkout', () => {
@ -97,6 +151,8 @@ test.describe('Block checkout', () => {
await completePaypalPayment(popup);
await completeBlockContinuation(page);
await expectOrderReceivedPage(page);
});
test('PayPal express block cart', async ({page}) => {
@ -109,6 +165,8 @@ test.describe('Block checkout', () => {
await completePaypalPayment(popup);
await completeBlockContinuation(page);
await expectOrderReceivedPage(page);
});
test.describe('Without review', () => {

4
tests/playwright/utils/checkout.js
View file

@ -26,6 +26,10 @@ export const fillCheckoutForm = async (page) => {
await differentShippingLocator.uncheck();
}
await acceptTerms(page);
}
export const acceptTerms = async (page) => {
const termsLocator = page.locator('[name="terms"]');
if (await termsLocator.count() > 0) {
await termsLocator.check();

35
tests/playwright/utils/paypal-popup.js
View file

@ -8,16 +8,24 @@ const {
/**
* Opens the PayPal popup by pressing the button, and returns the popup object.
* @param page
* @param {{timeout: ?int, fundingSource: ?string}} options
* @param {boolean} retry Retries the button click if the popup did not appear after timeout.
* @param {int} timeout
*/
export const openPaypalPopup = async (page, retry = true, timeout = 5000) => {
export const openPaypalPopup = async (page, options = {}, retry = true) => {
options = {
...{
timeout: 5000,
fundingSource: 'paypal',
},
...options
};
try {
await page.locator('.component-frame').scrollIntoViewIfNeeded();
const [popup] = await Promise.all([
page.waitForEvent('popup', {timeout}),
page.frameLocator('.component-frame').locator('[data-funding-source="paypal"]').click(),
page.waitForEvent('popup', {timeout: options.timeout}),
page.frameLocator('.component-frame').locator(`[data-funding-source="${options.fundingSource}"]`).click(),
]);
await popup.waitForLoadState();
@ -41,7 +49,7 @@ export const openPaypalPopup = async (page, retry = true, timeout = 5000) => {
}
if (retry) {
return openPaypalPopup(page, false);
return openPaypalPopup(page, options, false);
}
throw err;
}
@ -83,9 +91,20 @@ export const waitForPaypalShippingList = async (popup) => {
await expect(popup.locator('#shippingMethodsDropdown')).toBeVisible({timeout: 15000});
}
export const completePaypalPayment = async (popup) => {
/**
* @param popup
* @param {{timeout: ?int, selector: ?string}} options
*/
export const completePaypalPayment = async (popup, options) => {
options = {
...{
timeout: 20000,
selector: '#payment-submit-btn',
},
...options
};
await Promise.all([
popup.waitForEvent('close', {timeout: 20000}),
popup.click('#payment-submit-btn'),
popup.waitForEvent('close', {timeout: options.timeout}),
popup.click(options.selector),
]);
}