From c15b8ee463cc9ec2b9c6db80cd3feafc3e18e811 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Wed, 2 Aug 2023 17:09:06 +0100 Subject: [PATCH 01/22] Refactor purchase_item ditching behaviour to allow for extra line item with roundings. --- modules/ppcp-api-client/src/Entity/Item.php | 5 +- modules/ppcp-api-client/src/Entity/Money.php | 19 +- .../src/Entity/PurchaseUnit.php | 117 +------- .../src/Helper/MoneyFormatter.php | 21 +- .../src/Helper/PurchaseUnitSanitizer.php | 270 ++++++++++++++++++ 5 files changed, 317 insertions(+), 115 deletions(-) create mode 100644 modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php diff --git a/modules/ppcp-api-client/src/Entity/Item.php b/modules/ppcp-api-client/src/Entity/Item.php index efcaa179d..13f4702ba 100644 --- a/modules/ppcp-api-client/src/Entity/Item.php +++ b/modules/ppcp-api-client/src/Entity/Item.php @@ -201,12 +201,13 @@ class Item { /** * Returns the object as array. * + * @param bool $round_to_floor If value rounding should be floor. * @return array */ - public function to_array() { + public function to_array( bool $round_to_floor = false ): array { $item = array( 'name' => $this->name(), - 'unit_amount' => $this->unit_amount()->to_array(), + 'unit_amount' => $this->unit_amount()->to_array( $round_to_floor ), 'quantity' => $this->quantity(), 'description' => $this->description(), 'sku' => $this->sku(), diff --git a/modules/ppcp-api-client/src/Entity/Money.php b/modules/ppcp-api-client/src/Entity/Money.php index 5ba49dc43..e8f638feb 100644 --- a/modules/ppcp-api-client/src/Entity/Money.php +++ b/modules/ppcp-api-client/src/Entity/Money.php @@ -62,10 +62,11 @@ class Money { /** * The value formatted as string for API requests. * + * @param bool $round_to_floor If value rounding should be floor. * @return string */ - public function value_str(): string { - return $this->money_formatter->format( $this->value, $this->currency_code ); + public function value_str( bool $round_to_floor = false ): string { + return $this->money_formatter->format( $this->value, $this->currency_code, $round_to_floor ); } /** @@ -80,12 +81,22 @@ class Money { /** * Returns the object as array. * + * @param bool $round_to_floor If value rounding should be floor. * @return array */ - public function to_array(): array { + public function to_array( bool $round_to_floor = false ): array { return array( 'currency_code' => $this->currency_code(), - 'value' => $this->value_str(), + 'value' => $this->value_str( $round_to_floor ), ); } + + /** + * Indicates if the default rounding for this value is rounding up. + * + * @return bool + */ + public function is_rounding_up(): bool { + return (float) $this->value_str() > $this->value; + } } diff --git a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php index f2c64c73a..9359b422b 100644 --- a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php +++ b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php @@ -9,6 +9,8 @@ declare(strict_types=1); namespace WooCommerce\PayPalCommerce\ApiClient\Entity; +use WooCommerce\PayPalCommerce\ApiClient\Helper\PurchaseUnitSanitizer; + /** * Class PurchaseUnit */ @@ -277,11 +279,11 @@ class PurchaseUnit { /** * Returns the object as array. * - * @param bool $ditch_items_when_mismatch Whether ditch items when mismatch or not. + * @param bool $sanitize_output Whether output should be sanitized for PayPal consumption. * * @return array */ - public function to_array( bool $ditch_items_when_mismatch = true ): array { + public function to_array( bool $sanitize_output = true ): array { $purchase_unit = array( 'reference_id' => $this->reference_id(), 'amount' => $this->amount()->to_array(), @@ -294,17 +296,6 @@ class PurchaseUnit { ), ); - $ditch = $ditch_items_when_mismatch && $this->ditch_items_when_mismatch( $this->amount(), ...$this->items() ); - /** - * The filter can be used to control when the items and totals breakdown are removed from PayPal order info. - */ - $ditch = apply_filters( 'ppcp_ditch_items_breakdown', $ditch, $this ); - - if ( $ditch ) { - unset( $purchase_unit['items'] ); - unset( $purchase_unit['amount']['breakdown'] ); - } - if ( $this->payee() ) { $purchase_unit['payee'] = $this->payee()->to_array(); } @@ -325,101 +316,11 @@ class PurchaseUnit { if ( $this->soft_descriptor() ) { $purchase_unit['soft_descriptor'] = $this->soft_descriptor(); } + + if ( $sanitize_output ) { + $purchase_unit = ( new PurchaseUnitSanitizer( $purchase_unit, $this->items() ) )->sanitize(); + } + return $purchase_unit; } - - /** - * All money values send to PayPal can only have 2 decimal points. WooCommerce internally does - * not have this restriction. Therefore the totals of the cart in WooCommerce and the totals - * of the rounded money values of the items, we send to PayPal, can differ. In those cases, - * we can not send the line items. - * - * @param Amount $amount The amount. - * @param Item ...$items The items. - * @return bool - */ - private function ditch_items_when_mismatch( Amount $amount, Item ...$items ): bool { - $breakdown = $amount->breakdown(); - if ( ! $breakdown ) { - return false; - } - - $item_total = $breakdown->item_total(); - if ( $item_total ) { - $remaining_item_total = array_reduce( - $items, - function ( float $total, Item $item ): float { - return $total - (float) $item->unit_amount()->value_str() * (float) $item->quantity(); - }, - (float) $item_total->value_str() - ); - - $remaining_item_total = round( $remaining_item_total, 2 ); - - if ( 0.0 !== $remaining_item_total ) { - return true; - } - } - - $tax_total = $breakdown->tax_total(); - $items_with_tax = array_filter( - $this->items, - function ( Item $item ): bool { - return null !== $item->tax(); - } - ); - if ( $tax_total && ! empty( $items_with_tax ) ) { - $remaining_tax_total = array_reduce( - $items, - function ( float $total, Item $item ): float { - $tax = $item->tax(); - if ( $tax ) { - $total -= (float) $tax->value_str() * (float) $item->quantity(); - } - return $total; - }, - (float) $tax_total->value_str() - ); - - $remaining_tax_total = round( $remaining_tax_total, 2 ); - - if ( 0.0 !== $remaining_tax_total ) { - return true; - } - } - - $shipping = $breakdown->shipping(); - $discount = $breakdown->discount(); - $shipping_discount = $breakdown->shipping_discount(); - $handling = $breakdown->handling(); - $insurance = $breakdown->insurance(); - - $amount_total = 0.0; - if ( $shipping ) { - $amount_total += (float) $shipping->value_str(); - } - if ( $item_total ) { - $amount_total += (float) $item_total->value_str(); - } - if ( $discount ) { - $amount_total -= (float) $discount->value_str(); - } - if ( $tax_total ) { - $amount_total += (float) $tax_total->value_str(); - } - if ( $shipping_discount ) { - $amount_total -= (float) $shipping_discount->value_str(); - } - if ( $handling ) { - $amount_total += (float) $handling->value_str(); - } - if ( $insurance ) { - $amount_total += (float) $insurance->value_str(); - } - - $amount_str = $amount->value_str(); - $amount_total_str = ( new Money( $amount_total, $amount->currency_code() ) )->value_str(); - $needs_to_ditch = $amount_str !== $amount_total_str; - return $needs_to_ditch; - } } diff --git a/modules/ppcp-api-client/src/Helper/MoneyFormatter.php b/modules/ppcp-api-client/src/Helper/MoneyFormatter.php index 447ba0a0e..3e19a10f5 100644 --- a/modules/ppcp-api-client/src/Helper/MoneyFormatter.php +++ b/modules/ppcp-api-client/src/Helper/MoneyFormatter.php @@ -25,12 +25,31 @@ class MoneyFormatter { * * @param float $value The value. * @param string $currency The 3-letter currency code. + * @param bool $round_to_floor If value rounding should be floor. * * @return string */ - public function format( float $value, string $currency ): string { + public function format( float $value, string $currency, bool $round_to_floor = false ): string { + if ( $round_to_floor ) { + return in_array( $currency, $this->currencies_without_decimals, true ) + ? (string) floor( $value ) + : number_format( $this->floor_with_decimals( $value, 2 ), 2, '.', '' ); + } + return in_array( $currency, $this->currencies_without_decimals, true ) ? (string) round( $value, 0 ) : number_format( $value, 2, '.', '' ); } + + /** + * Rounds to floor with decimal precision. + * + * @param float $value The value. + * @param int $decimals The number of decimals. + * @return float + */ + private function floor_with_decimals( float $value, int $decimals = 0 ): float { + $adjustment = (float) pow( 10, $decimals ); + return floor( $value * $adjustment ) / $adjustment; + } } diff --git a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php new file mode 100644 index 000000000..a6bc1a289 --- /dev/null +++ b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php @@ -0,0 +1,270 @@ +purchase_unit = $purchase_unit; + $this->item_objects = $item_objects; + } + + /** + * The purchase_unit amount. + * + * @return array + */ + private function amount(): array { + return $this->purchase_unit['amount'] ?? array(); + } + + /** + * The purchase_unit currency code. + * + * @return string + */ + private function currency_code(): string { + return (string) ( $this->amount()['currency_code'] ?? '' ); + } + + /** + * The purchase_unit breakdown. + * + * @return array + */ + private function breakdown(): array { + return $this->amount()['breakdown'] ?? array(); + } + + /** + * The purchase_unit breakdown. + * + * @param string $key The breakdown element to get the value from. + * @return float + */ + private function breakdown_value( string $key ): float { + if ( ! isset( $this->breakdown()[ $key ] ) ) { + return 0.0; + } + return (float) ( $this->breakdown()[ $key ]['value'] ?? 0.0 ); + } + + /** + * The purchase_unit items array. + * + * @return array + */ + private function items(): array { + return $this->purchase_unit['items'] ?? array(); + } + + /** + * The sanitizes the purchase_unit array. + * + * @return array + */ + public function sanitize(): array { + $this->sanitize_item_amount_mismatch(); + $this->sanitize_item_tax_mismatch(); + $this->sanitize_breakdown_mismatch(); + return $this->purchase_unit; + } + + /** + * The sanitizes the purchase_unit items amount. + * + * @return void + */ + private function sanitize_item_amount_mismatch(): void { + $item_mismatch = $this->calculate_item_mismatch(); + + if ( $item_mismatch < 0 ) { + // Do floors on item amounts so item_mismatch is a positive value. + foreach ( $this->item_objects as $index => $item ) { + $this->purchase_unit['items'][ $index ] = $item->to_array( + $item->unit_amount()->is_rounding_up() + ); + } + } + + $item_mismatch = $this->calculate_item_mismatch(); + + if ( $item_mismatch > 0 ) { + // Add extra line item with roundings. + $roundings_money = new Money( $item_mismatch, $this->currency_code() ); + $this->purchase_unit['items'][] = ( new Item( 'Roundings', $roundings_money, 1 ) )->to_array(); + } + + $item_mismatch = $this->calculate_item_mismatch(); + + if ( $item_mismatch !== 0.0 ) { + // Ditch items. + if ( isset( $this->purchase_unit['items'] ) ) { + unset( $this->purchase_unit['items'] ); + } + } + } + + /** + * The sanitizes the purchase_unit items tax. + * + * @return void + */ + private function sanitize_item_tax_mismatch(): void { + $tax_mismatch = $this->calculate_tax_mismatch(); + + if ( $tax_mismatch !== 0.0 ) { + // Unset tax in items. + foreach ( $this->purchase_unit['items'] as $index => $item ) { + if ( isset( $this->purchase_unit['items'][ $index ]['tax'] ) ) { + unset( $this->purchase_unit['items'][ $index ]['tax'] ); + } + if ( isset( $this->purchase_unit['items'][ $index ]['tax_rate'] ) ) { + unset( $this->purchase_unit['items'][ $index ]['tax_rate'] ); + } + } + } + } + + /** + * The sanitizes the purchase_unit breakdown. + * + * @return void + */ + private function sanitize_breakdown_mismatch(): void { + $breakdown_mismatch = $this->calculate_breakdown_mismatch(); + + if ( $breakdown_mismatch !== 0.0 ) { + // Ditch breakdowns and items. + if ( isset( $this->purchase_unit['items'] ) ) { + unset( $this->purchase_unit['items'] ); + } + if ( isset( $this->purchase_unit['amount']['breakdown'] ) ) { + unset( $this->purchase_unit['amount']['breakdown'] ); + } + } + } + + /** + * The calculates amount mismatch of items sums with breakdown. + * + * @return float + */ + private function calculate_item_mismatch(): float { + $item_total = $this->breakdown_value( 'item_total' ); + if ( ! $item_total ) { + return 0; + } + + $remaining_item_total = array_reduce( + $this->items(), + function ( float $total, array $item ): float { + return $total - (float) $item['unit_amount']['value'] * (float) $item['quantity']; + }, + $item_total + ); + + return round( $remaining_item_total, 2 ); + } + + /** + * The calculates tax mismatch of items sums with breakdown. + * + * @return float + */ + private function calculate_tax_mismatch(): float { + $tax_total = $this->breakdown_value( 'tax_total' ); + $items_with_tax = array_filter( + $this->items(), + function ( array $item ): bool { + return isset( $item['tax'] ); + } + ); + + if ( ! $tax_total || empty( $items_with_tax ) ) { + return 0; + } + + $remaining_tax_total = array_reduce( + $this->items(), + function ( float $total, array $item ): float { + $tax = $item['tax'] ?? false; + if ( $tax ) { + $total -= (float) $tax['value'] * (float) $item['quantity']; + } + return $total; + }, + $tax_total + ); + + return round( $remaining_tax_total, 2 ); + } + + /** + * The calculates mismatch of breakdown sums with total amount. + * + * @return float + */ + private function calculate_breakdown_mismatch(): float { + $breakdown = $this->breakdown(); + if ( ! $breakdown ) { + return 0; + } + + $amount_total = 0.0; + $amount_total += $this->breakdown_value( 'item_total' ); + $amount_total += $this->breakdown_value( 'tax_total' ); + $amount_total += $this->breakdown_value( 'shipping' ); + $amount_total += $this->breakdown_value( 'discount' ); + $amount_total += $this->breakdown_value( 'shipping_discount' ); + $amount_total += $this->breakdown_value( 'handling' ); + $amount_total += $this->breakdown_value( 'insurance' ); + + $amount_str = $this->amount()['value'] ?? 0; + $amount_total_str = ( new Money( $amount_total, $this->currency_code() ) )->value_str(); + + return $amount_str - $amount_total_str; + } +} From 837bdb0392b9a9fd10a695fa3e05ceb697419e10 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Mon, 7 Aug 2023 16:12:02 +0100 Subject: [PATCH 02/22] Add PurchaseUnitSanitizer tests Add subtotal mismatch admin options --- modules/ppcp-api-client/services.php | 13 +- .../src/Entity/PurchaseUnit.php | 21 ++- .../src/Factory/PurchaseUnitFactory.php | 49 +++++-- .../src/Helper/PurchaseUnitSanitizer.php | 109 ++++++++++---- .../Settings/Fields/connection-tab-fields.php | 37 +++++ .../ApiClient/Entity/PurchaseUnitTest.php | 135 ++++++++++++++++-- 6 files changed, 314 insertions(+), 50 deletions(-) diff --git a/modules/ppcp-api-client/services.php b/modules/ppcp-api-client/services.php index 71c9a25f8..92d251507 100644 --- a/modules/ppcp-api-client/services.php +++ b/modules/ppcp-api-client/services.php @@ -17,6 +17,7 @@ use WooCommerce\PayPalCommerce\ApiClient\Factory\PaymentPreferencesFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PlanFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\ProductFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\ShippingOptionFactory; +use WooCommerce\PayPalCommerce\ApiClient\Helper\PurchaseUnitSanitizer; use WooCommerce\PayPalCommerce\Session\SessionHandler; use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface; use WooCommerce\PayPalCommerce\ApiClient\Authentication\Bearer; @@ -299,6 +300,7 @@ return array( $payments_factory = $container->get( 'api.factory.payments' ); $prefix = $container->get( 'api.prefix' ); $soft_descriptor = $container->get( 'wcgateway.soft-descriptor' ); + $sanitizer = $container->get( 'api.helper.purchase-unit-sanitizer' ); return new PurchaseUnitFactory( $amount_factory, @@ -308,7 +310,8 @@ return array( $shipping_factory, $payments_factory, $prefix, - $soft_descriptor + $soft_descriptor, + $sanitizer ); }, 'api.factory.patch-collection-factory' => static function ( ContainerInterface $container ): PatchCollectionFactory { @@ -814,4 +817,12 @@ return array( 'api.order-helper' => static function( ContainerInterface $container ): OrderHelper { return new OrderHelper(); }, + 'api.helper.purchase-unit-sanitizer' => static function( ContainerInterface $container ): PurchaseUnitSanitizer { + $settings = $container->get( 'wcgateway.settings' ); + assert( $settings instanceof Settings ); + + $behavior = $settings->has( 'subtotal_mismatch_behavior' ) ? $settings->get( 'subtotal_mismatch_behavior' ) : null; + $line_name = $settings->has( 'subtotal_mismatch_line_name' ) ? $settings->get( 'subtotal_mismatch_line_name' ) : null; + return new PurchaseUnitSanitizer( $behavior, $line_name ); + }, ); diff --git a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php index 9359b422b..cb2601a9d 100644 --- a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php +++ b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php @@ -93,6 +93,13 @@ class PurchaseUnit { */ private $contains_physical_goods = false; + /** + * The sanitizer for this purchase unit output. + * + * @var PurchaseUnitSanitizer|null + */ + private $sanitizer; + /** * PurchaseUnit constructor. * @@ -222,6 +229,16 @@ class PurchaseUnit { $this->custom_id = $custom_id; } + /** + * Sets the sanitizer for this purchase unit output. + * + * @param PurchaseUnitSanitizer|null $sanitizer The sanitizer. + * @return void + */ + public function set_sanitizer( ?PurchaseUnitSanitizer $sanitizer ) { + $this->sanitizer = $sanitizer; + } + /** * Returns the invoice id. * @@ -317,8 +334,8 @@ class PurchaseUnit { $purchase_unit['soft_descriptor'] = $this->soft_descriptor(); } - if ( $sanitize_output ) { - $purchase_unit = ( new PurchaseUnitSanitizer( $purchase_unit, $this->items() ) )->sanitize(); + if ( $sanitize_output && isset( $this->sanitizer ) ) { + $purchase_unit = ( $this->sanitizer->sanitize( $purchase_unit, $this->items() ) ); } return $purchase_unit; diff --git a/modules/ppcp-api-client/src/Factory/PurchaseUnitFactory.php b/modules/ppcp-api-client/src/Factory/PurchaseUnitFactory.php index 8b06d17f5..ecb35592b 100644 --- a/modules/ppcp-api-client/src/Factory/PurchaseUnitFactory.php +++ b/modules/ppcp-api-client/src/Factory/PurchaseUnitFactory.php @@ -13,6 +13,7 @@ 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\Helper\PurchaseUnitSanitizer; use WooCommerce\PayPalCommerce\ApiClient\Repository\PayeeRepository; use WooCommerce\PayPalCommerce\Webhooks\CustomIds; @@ -77,17 +78,25 @@ class PurchaseUnitFactory { */ private $soft_descriptor; + /** + * The sanitizer for purchase unit output data. + * + * @var PurchaseUnitSanitizer|null + */ + private $sanitizer; + /** * PurchaseUnitFactory constructor. * - * @param AmountFactory $amount_factory The amount factory. - * @param PayeeRepository $payee_repository The Payee repository. - * @param PayeeFactory $payee_factory The Payee factory. - * @param ItemFactory $item_factory The item factory. - * @param ShippingFactory $shipping_factory The shipping factory. - * @param PaymentsFactory $payments_factory The payments factory. - * @param string $prefix The prefix. - * @param string $soft_descriptor The soft descriptor. + * @param AmountFactory $amount_factory The amount factory. + * @param PayeeRepository $payee_repository The Payee repository. + * @param PayeeFactory $payee_factory The Payee factory. + * @param ItemFactory $item_factory The item factory. + * @param ShippingFactory $shipping_factory The shipping factory. + * @param PaymentsFactory $payments_factory The payments factory. + * @param string $prefix The prefix. + * @param string $soft_descriptor The soft descriptor. + * @param ?PurchaseUnitSanitizer $sanitizer The purchase unit to_array sanitizer. */ public function __construct( AmountFactory $amount_factory, @@ -97,7 +106,8 @@ class PurchaseUnitFactory { ShippingFactory $shipping_factory, PaymentsFactory $payments_factory, string $prefix = 'WC-', - string $soft_descriptor = '' + string $soft_descriptor = '', + PurchaseUnitSanitizer $sanitizer = null ) { $this->amount_factory = $amount_factory; @@ -108,6 +118,7 @@ class PurchaseUnitFactory { $this->payments_factory = $payments_factory; $this->prefix = $prefix; $this->soft_descriptor = $soft_descriptor; + $this->sanitizer = $sanitizer; } /** @@ -151,6 +162,9 @@ class PurchaseUnitFactory { $invoice_id, $soft_descriptor ); + + $this->init_purchase_unit( $purchase_unit ); + /** * Returns PurchaseUnit for the WC order. */ @@ -221,6 +235,8 @@ class PurchaseUnitFactory { $soft_descriptor ); + $this->init_purchase_unit( $purchase_unit ); + return $purchase_unit; } @@ -283,6 +299,9 @@ class PurchaseUnitFactory { $soft_descriptor, $payments ); + + $this->init_purchase_unit( $purchase_unit ); + return $purchase_unit; } @@ -313,4 +332,16 @@ class PurchaseUnitFactory { $countries = array( 'AE', 'AF', 'AG', 'AI', 'AL', 'AN', 'AO', 'AW', 'BB', 'BF', 'BH', 'BI', 'BJ', 'BM', 'BO', 'BS', 'BT', 'BW', 'BZ', 'CD', 'CF', 'CG', 'CI', 'CK', 'CL', 'CM', 'CO', 'CR', 'CV', 'DJ', 'DM', 'DO', 'EC', 'EG', 'ER', 'ET', 'FJ', 'FK', 'GA', 'GD', 'GH', 'GI', 'GM', 'GN', 'GQ', 'GT', 'GW', 'GY', 'HK', 'HN', 'HT', 'IE', 'IQ', 'IR', 'JM', 'JO', 'KE', 'KH', 'KI', 'KM', 'KN', 'KP', 'KW', 'KY', 'LA', 'LB', 'LC', 'LK', 'LR', 'LS', 'LY', 'ML', 'MM', 'MO', 'MR', 'MS', 'MT', 'MU', 'MW', 'MZ', 'NA', 'NE', 'NG', 'NI', 'NP', 'NR', 'NU', 'OM', 'PA', 'PE', 'PF', 'PY', 'QA', 'RW', 'SA', 'SB', 'SC', 'SD', 'SL', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SY', 'TC', 'TD', 'TG', 'TL', 'TO', 'TT', 'TV', 'TZ', 'UG', 'UY', 'VC', 'VE', 'VG', 'VN', 'VU', 'WS', 'XA', 'XB', 'XC', 'XE', 'XL', 'XM', 'XN', 'XS', 'YE', 'ZM', 'ZW' ); return in_array( $country_code, $countries, true ); } + + /** + * Initializes a purchase unit object. + * + * @param PurchaseUnit $purchase_unit The purchase unit. + * @return void + */ + private function init_purchase_unit( PurchaseUnit $purchase_unit ): void { + if ( $this->sanitizer instanceof PurchaseUnitSanitizer ) { + $purchase_unit->set_sanitizer( $this->sanitizer ); + } + } } diff --git a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php index a6bc1a289..1f2a972e6 100644 --- a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php +++ b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php @@ -24,31 +24,80 @@ use WooCommerce\PayPalCommerce\ApiClient\Entity\Money; * Class PurchaseUnitSanitizer */ class PurchaseUnitSanitizer { + const MODE_DITCH = 'ditch'; + const MODE_EXTRA_LINE = 'extra_line'; + const VALID_MODES = array( + self::MODE_DITCH, + self::MODE_EXTRA_LINE, + ); + + const EXTRA_LINE_NAME = 'Subtotal mismatch'; /** * The purchase unit data * * @var array */ - private $purchase_unit; + private $purchase_unit = array(); /** * The purchase unit Item objects * * @var array|Item[] */ - private $item_objects; + private $item_objects = array(); + + /** + * The working mode + * + * @var string + */ + private $mode; + + /** + * The name for the extra line + * + * @var string + */ + private $extra_line_name; /** * PurchaseUnitSanitizer constructor. * - * @param array $purchase_unit The purchase_unit array that should be sanitized. - * @param array|Item[] $item_objects The purchase unit Item objects used for recalculations. + * @param string|null $mode The mismatch handling mode, ditch or extra_line. + * @param string|null $extra_line_name The name of the extra line. */ - public function __construct( array $purchase_unit, array $item_objects ) { - $this->purchase_unit = $purchase_unit; - $this->item_objects = $item_objects; + public function __construct( string $mode = null, string $extra_line_name = null ) { + + if ( ! in_array( $mode, self::VALID_MODES, true ) ) { + $mode = self::MODE_DITCH; + } + + if ( ! $extra_line_name ) { + $extra_line_name = self::EXTRA_LINE_NAME; + } + + $this->mode = $mode; + $this->extra_line_name = $extra_line_name; + } + + /** + * Indicates if mode is ditch. + * + * @return bool + */ + private function is_mode_ditch(): bool { + return $this->mode === self::MODE_DITCH; + } + + /** + * Indicates if mode is adding extra line. + * + * @return bool + */ + private function is_mode_extra_line(): bool { + return $this->mode === self::MODE_EXTRA_LINE; } /** @@ -103,9 +152,14 @@ class PurchaseUnitSanitizer { /** * The sanitizes the purchase_unit array. * + * @param array $purchase_unit The purchase_unit array that should be sanitized. + * @param array|Item[] $item_objects The purchase unit Item objects used for recalculations. * @return array */ - public function sanitize(): array { + public function sanitize( array $purchase_unit, array $item_objects ): array { + $this->purchase_unit = $purchase_unit; + $this->item_objects = $item_objects; + $this->sanitize_item_amount_mismatch(); $this->sanitize_item_tax_mismatch(); $this->sanitize_breakdown_mismatch(); @@ -120,25 +174,28 @@ class PurchaseUnitSanitizer { private function sanitize_item_amount_mismatch(): void { $item_mismatch = $this->calculate_item_mismatch(); - if ( $item_mismatch < 0 ) { - // Do floors on item amounts so item_mismatch is a positive value. - foreach ( $this->item_objects as $index => $item ) { - $this->purchase_unit['items'][ $index ] = $item->to_array( - $item->unit_amount()->is_rounding_up() - ); + if ( $this->is_mode_extra_line() ) { + if ( $item_mismatch < 0 ) { + // Do floors on item amounts so item_mismatch is a positive value. + foreach ( $this->item_objects as $index => $item ) { + $this->purchase_unit['items'][ $index ] = $item->to_array( + $item->unit_amount()->is_rounding_up() + ); + } } + + $item_mismatch = $this->calculate_item_mismatch(); + + if ( $item_mismatch > 0 ) { + // Add extra line item with roundings. + $line_name = $this->extra_line_name; + $roundings_money = new Money( $item_mismatch, $this->currency_code() ); + $this->purchase_unit['items'][] = ( new Item( $line_name, $roundings_money, 1 ) )->to_array(); + } + + $item_mismatch = $this->calculate_item_mismatch(); } - $item_mismatch = $this->calculate_item_mismatch(); - - if ( $item_mismatch > 0 ) { - // Add extra line item with roundings. - $roundings_money = new Money( $item_mismatch, $this->currency_code() ); - $this->purchase_unit['items'][] = ( new Item( 'Roundings', $roundings_money, 1 ) )->to_array(); - } - - $item_mismatch = $this->calculate_item_mismatch(); - if ( $item_mismatch !== 0.0 ) { // Ditch items. if ( isset( $this->purchase_unit['items'] ) ) { @@ -257,8 +314,8 @@ class PurchaseUnitSanitizer { $amount_total += $this->breakdown_value( 'item_total' ); $amount_total += $this->breakdown_value( 'tax_total' ); $amount_total += $this->breakdown_value( 'shipping' ); - $amount_total += $this->breakdown_value( 'discount' ); - $amount_total += $this->breakdown_value( 'shipping_discount' ); + $amount_total -= $this->breakdown_value( 'discount' ); + $amount_total -= $this->breakdown_value( 'shipping_discount' ); $amount_total += $this->breakdown_value( 'handling' ); $amount_total += $this->breakdown_value( 'insurance' ); diff --git a/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php b/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php index 9d42b1240..0b099ebae 100644 --- a/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php +++ b/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace WooCommerce\PayPalCommerce\WcGateway\Settings; +use WooCommerce\PayPalCommerce\ApiClient\Helper\PurchaseUnitSanitizer; use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface; use WooCommerce\PayPalCommerce\ApiClient\Helper\DccApplies; use WooCommerce\PayPalCommerce\Onboarding\Environment; @@ -496,6 +497,42 @@ return function ( ContainerInterface $container, array $fields ): array { 'requirements' => array(), 'gateway' => Settings::CONNECTION_TAB_ID, ), + 'subtotal_mismatch_behavior' => array( + 'title' => __( 'Subtotal mismatch behavior', 'woocommerce-paypal-payments' ), + 'type' => 'select', + 'input_class' => array( 'wc-enhanced-select' ), + 'default' => 'vertical', + 'desc_tip' => true, + 'description' => __( + 'Differences between WooCommerce and PayPal roundings may give origin to a mismatch in order items subtotal calculations. If not handled these mismatches will cause the PayPal transaction to fail.', + 'woocommerce-paypal-payments' + ), + 'options' => array( + PurchaseUnitSanitizer::MODE_DITCH => __( 'Do not send line items to PayPal', 'woocommerce-paypal-payments' ), + PurchaseUnitSanitizer::MODE_EXTRA_LINE => __( 'Add another line item', 'woocommerce-paypal-payments' ), + ), + 'screens' => array( + State::STATE_START, + State::STATE_ONBOARDED, + ), + 'requirements' => array(), + 'gateway' => Settings::CONNECTION_TAB_ID, + ), + 'subtotal_mismatch_line_name' => array( + 'title' => __( 'Subtotal mismatch line name', 'woocommerce-paypal-payments' ), + 'type' => 'text', + 'desc_tip' => true, + 'description' => __( 'The name of the extra line that will be sent to PayPal to correct the subtotal mismatch.', 'woocommerce-paypal-payments' ), + 'maxlength' => 22, + 'default' => '', + 'screens' => array( + State::STATE_START, + State::STATE_ONBOARDED, + ), + 'requirements' => array(), + 'placeholder' => PurchaseUnitSanitizer::EXTRA_LINE_NAME, + 'gateway' => Settings::CONNECTION_TAB_ID, + ), ); return array_merge( $fields, $connection_fields ); diff --git a/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php b/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php index dbb18c4de..5b546307c 100644 --- a/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php +++ b/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php @@ -3,6 +3,7 @@ declare(strict_types=1); namespace WooCommerce\PayPalCommerce\ApiClient\Entity; +use WooCommerce\PayPalCommerce\ApiClient\Helper\PurchaseUnitSanitizer; use WooCommerce\PayPalCommerce\TestCase; use Mockery; @@ -75,24 +76,57 @@ class PurchaseUnitTest extends TestCase $this->assertEquals($expected, $testee->to_array()); } - /** - * @dataProvider dataForDitchTests - * @param array $items - * @param Amount $amount - * @param bool $doDitch - */ - public function testDitchMethod(array $items, Amount $amount, bool $doDitch, string $message) + /** + * @dataProvider dataForDitchTests + * @param array $items + * @param Amount $amount + * @param bool|array $doDitch + * @param string $message + */ + public function testDitchMethod(array $items, Amount $amount, $doDitch, string $message) { + if (is_array($doDitch)) { + $doDitchItems = $doDitch['items']; + $doDitchBreakdown = $doDitch['breakdown']; + $doDitchTax = $doDitch['tax']; + } else { + $doDitchItems = $doDitch; + $doDitchBreakdown = $doDitch; + $doDitchTax = $doDitch; + } + +// $dataSetName = $this->dataName(); +// if ($dataSetName !== 'dont_ditch_with_discount') { +// return; +// } +// +// print_r($amount->to_array()); +// foreach ($items as $item) { +// print_r($item->to_array()); +// } + $testee = new PurchaseUnit( $amount, $items ); + $testee->set_sanitizer(new PurchaseUnitSanitizer(PurchaseUnitSanitizer::MODE_DITCH)); + $array = $testee->to_array(); - $resultItems = $doDitch === ! array_key_exists('items', $array); - $resultBreakdown = $doDitch === ! array_key_exists('breakdown', $array['amount']); + $resultItems = $doDitchItems === ! array_key_exists('items', $array); +// +// echo "------ RESULT ------\n"; +// print_r($array); +// die('.'); + + $resultBreakdown = $doDitchBreakdown === ! array_key_exists('breakdown', $array['amount']); $this->assertTrue($resultItems, $message); $this->assertTrue($resultBreakdown, $message); + + foreach ($array['items'] ?? [] as $item) { + $resultTax = $doDitchTax === ! array_key_exists('tax', $item); + $this->assertTrue($resultTax, $message); + } } public function dataForDitchTests() : array @@ -406,6 +440,58 @@ class PurchaseUnitTest extends TestCase 'insurance' => null, ], ], + 'ditch_items_total_but_not_breakdown' => [ + 'message' => 'Items should be ditched because the item total does not add up. But not breakdown because it adds up.', + 'ditch' => [ + 'items' => true, + 'breakdown' => false, + 'tax' => true, + ], + 'items' => [ + [ + 'value' => 11, + 'quantity' => 2, + 'tax' => 3, + 'category' => Item::PHYSICAL_GOODS, + ], + ], + 'amount' => 26, + 'breakdown' => [ + 'item_total' => 20, + 'tax_total' => 6, + 'shipping' => null, + 'discount' => null, + 'shipping_discount' => null, + 'handling' => null, + 'insurance' => null, + ], + ], + 'ditch_items_tax_with_incorrect_tax_total' => [ + 'message' => 'Ditch tax from items. Items should not be ditched because the mismatch is on the tax.', + 'ditch' => [ + 'items' => false, + 'breakdown' => false, + 'tax' => true, + ], + 'items' => [ + [ + 'value' => 10, + 'quantity' => 2, + 'tax' => 4, + 'category' => Item::PHYSICAL_GOODS, + ], + ], + 'amount' => 26, + 'breakdown' => [ + 'item_total' => 20, + 'tax_total' => 6, + 'shipping' => null, + 'discount' => null, + 'shipping_discount' => null, + 'handling' => null, + 'insurance' => null, + ], + ], ]; $values = []; @@ -421,10 +507,16 @@ class PurchaseUnitTest extends TestCase 'tax' => $tax, 'quantity'=> $item['quantity'], 'category' => $item['category'], - 'to_array' => [], + 'to_array' => [ + 'unit_amount' => $unitAmount->to_array(), + 'tax' => $tax->to_array(), + 'quantity'=> $item['quantity'], + 'category' => $item['category'], + ], ] ); } + $breakdown = null; if ($test['breakdown']) { $breakdown = Mockery::mock(AmountBreakdown::class); @@ -438,10 +530,29 @@ class PurchaseUnitTest extends TestCase return $money; }); } + + $breakdown + ->shouldReceive('to_array') + ->andReturn( + array_map( + function ($value) { + return $value ? (new Money($value, 'EUR'))->to_array() : null; + }, + $test['breakdown'] + ) + ); } + + $amountMoney = new Money($test['amount'], 'EUR'); $amount = Mockery::mock(Amount::class); - $amount->shouldReceive('to_array')->andReturn(['value' => number_format( $test['amount'], 2, '.', '' ), 'breakdown' => []]); - $amount->shouldReceive('value_str')->andReturn(number_format( $test['amount'], 2, '.', '' )); + $amount + ->shouldReceive('to_array') + ->andReturn([ + 'value' => $amountMoney->value_str(), + 'currency_code' => $amountMoney->currency_code(), + 'breakdown' => $breakdown ? $breakdown->to_array() : [], + ]); + $amount->shouldReceive('value_str')->andReturn($amountMoney->value_str()); $amount->shouldReceive('currency_code')->andReturn('EUR'); $amount->shouldReceive('breakdown')->andReturn($breakdown); From a43b93ffff06a4169fb40843e40110feb536b96c Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Mon, 7 Aug 2023 18:09:25 +0100 Subject: [PATCH 03/22] Add test cases for PurchaseUnitSanitizer --- .../Endpoint/PayUponInvoiceOrderEndpoint.php | 2 +- .../src/Entity/PurchaseUnit.php | 5 +- .../src/Helper/PurchaseUnitSanitizer.php | 22 +- .../ApiClient/Entity/PurchaseUnitTest.php | 270 +++++++++++++++++- 4 files changed, 276 insertions(+), 23 deletions(-) diff --git a/modules/ppcp-api-client/src/Endpoint/PayUponInvoiceOrderEndpoint.php b/modules/ppcp-api-client/src/Endpoint/PayUponInvoiceOrderEndpoint.php index 97b40a73d..df3091311 100644 --- a/modules/ppcp-api-client/src/Endpoint/PayUponInvoiceOrderEndpoint.php +++ b/modules/ppcp-api-client/src/Endpoint/PayUponInvoiceOrderEndpoint.php @@ -112,7 +112,7 @@ class PayUponInvoiceOrderEndpoint { 'processing_instruction' => 'ORDER_COMPLETE_ON_PAYMENT_APPROVAL', 'purchase_units' => array_map( static function ( PurchaseUnit $item ): array { - return $item->to_array( false ); + return $item->to_array( true, false ); }, $items ), diff --git a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php index cb2601a9d..26928cf4c 100644 --- a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php +++ b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php @@ -297,10 +297,11 @@ class PurchaseUnit { * Returns the object as array. * * @param bool $sanitize_output Whether output should be sanitized for PayPal consumption. + * @param bool $allow_ditch_items Whether to allow items to be ditched. * * @return array */ - public function to_array( bool $sanitize_output = true ): array { + public function to_array( bool $sanitize_output = true, bool $allow_ditch_items = true ): array { $purchase_unit = array( 'reference_id' => $this->reference_id(), 'amount' => $this->amount()->to_array(), @@ -335,7 +336,7 @@ class PurchaseUnit { } if ( $sanitize_output && isset( $this->sanitizer ) ) { - $purchase_unit = ( $this->sanitizer->sanitize( $purchase_unit, $this->items() ) ); + $purchase_unit = ( $this->sanitizer->sanitize( $purchase_unit, $this->items(), $allow_ditch_items ) ); } return $purchase_unit; diff --git a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php index 1f2a972e6..263b428e4 100644 --- a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php +++ b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php @@ -47,6 +47,13 @@ class PurchaseUnitSanitizer { */ private $item_objects = array(); + /** + * Whether to allow items to be ditched. + * + * @var bool + */ + private $allow_ditch_items = true; + /** * The working mode * @@ -154,11 +161,13 @@ class PurchaseUnitSanitizer { * * @param array $purchase_unit The purchase_unit array that should be sanitized. * @param array|Item[] $item_objects The purchase unit Item objects used for recalculations. + * @param bool $allow_ditch_items Whether to allow items to be ditched. * @return array */ - public function sanitize( array $purchase_unit, array $item_objects ): array { - $this->purchase_unit = $purchase_unit; - $this->item_objects = $item_objects; + public function sanitize( array $purchase_unit, array $item_objects, bool $allow_ditch_items = true ): array { + $this->purchase_unit = $purchase_unit; + $this->item_objects = $item_objects; + $this->allow_ditch_items = $allow_ditch_items; $this->sanitize_item_amount_mismatch(); $this->sanitize_item_tax_mismatch(); @@ -176,6 +185,7 @@ class PurchaseUnitSanitizer { if ( $this->is_mode_extra_line() ) { if ( $item_mismatch < 0 ) { + // Do floors on item amounts so item_mismatch is a positive value. foreach ( $this->item_objects as $index => $item ) { $this->purchase_unit['items'][ $index ] = $item->to_array( @@ -198,7 +208,7 @@ class PurchaseUnitSanitizer { if ( $item_mismatch !== 0.0 ) { // Ditch items. - if ( isset( $this->purchase_unit['items'] ) ) { + if ( $this->allow_ditch_items && isset( $this->purchase_unit['items'] ) ) { unset( $this->purchase_unit['items'] ); } } @@ -212,7 +222,7 @@ class PurchaseUnitSanitizer { private function sanitize_item_tax_mismatch(): void { $tax_mismatch = $this->calculate_tax_mismatch(); - if ( $tax_mismatch !== 0.0 ) { + if ( $this->allow_ditch_items && $tax_mismatch !== 0.0 ) { // Unset tax in items. foreach ( $this->purchase_unit['items'] as $index => $item ) { if ( isset( $this->purchase_unit['items'][ $index ]['tax'] ) ) { @@ -233,7 +243,7 @@ class PurchaseUnitSanitizer { private function sanitize_breakdown_mismatch(): void { $breakdown_mismatch = $this->calculate_breakdown_mismatch(); - if ( $breakdown_mismatch !== 0.0 ) { + if ( $this->allow_ditch_items && $breakdown_mismatch !== 0.0 ) { // Ditch breakdowns and items. if ( isset( $this->purchase_unit['items'] ) ) { unset( $this->purchase_unit['items'] ); diff --git a/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php b/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php index 5b546307c..328f5cb15 100644 --- a/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php +++ b/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php @@ -95,16 +95,6 @@ class PurchaseUnitTest extends TestCase $doDitchTax = $doDitch; } -// $dataSetName = $this->dataName(); -// if ($dataSetName !== 'dont_ditch_with_discount') { -// return; -// } -// -// print_r($amount->to_array()); -// foreach ($items as $item) { -// print_r($item->to_array()); -// } - $testee = new PurchaseUnit( $amount, $items @@ -114,10 +104,6 @@ class PurchaseUnitTest extends TestCase $array = $testee->to_array(); $resultItems = $doDitchItems === ! array_key_exists('items', $array); -// -// echo "------ RESULT ------\n"; -// print_r($array); -// die('.'); $resultBreakdown = $doDitchBreakdown === ! array_key_exists('breakdown', $array['amount']); $this->assertTrue($resultItems, $message); @@ -567,6 +553,262 @@ class PurchaseUnitTest extends TestCase return $values; } + /** + * @dataProvider dataForExtraLineTests + * @param array $items + * @param Amount $amount + * @param array $expected + * @param string $message + */ + public function testExtraLineMethod(array $items, Amount $amount, array $expected, string $message) + { + $testee = new PurchaseUnit( + $amount, + $items + ); + + $testee->set_sanitizer(new PurchaseUnitSanitizer(PurchaseUnitSanitizer::MODE_EXTRA_LINE, $expected['extra_line_name'] ?? null)); + + $countItemsBefore = count($items); + $array = $testee->to_array(); + $countItemsAfter = count($array['items']); + $extraItem = array_pop($array['items']); + + $this->assertEquals($countItemsBefore + 1, $countItemsAfter, $message); + $this->assertEquals($expected['extra_line_value'], $extraItem['unit_amount']['value'], $message); + $this->assertEquals($expected['extra_line_name'] ?? PurchaseUnitSanitizer::EXTRA_LINE_NAME, $extraItem['name'], $message); + + foreach ($array['items'] as $i => $item) { + $this->assertEquals($expected['item_value'][$i], $item['unit_amount']['value'], $message); + } + } + + public function dataForExtraLineTests() : array + { + $data = [ + 'default' => [ + 'message' => 'Extra line should be added with price 0.01 and line amount 10.', + 'expected' => [ + 'item_value' => [10], + 'extra_line_value' => 0.01, + ], + 'items' => [ + [ + 'value' => 10, + 'quantity' => 2, + 'tax' => 3, + 'category' => Item::PHYSICAL_GOODS, + ], + ], + 'amount' => 26.01, + 'breakdown' => [ + 'item_total' => 20.01, + 'tax_total' => 6, + 'shipping' => null, + 'discount' => null, + 'shipping_discount' => null, + 'handling' => null, + 'insurance' => null, + ], + ], + 'with_custom_name' => [ + 'message' => 'Extra line should be added with price 0.01 and line amount 10.', + 'expected' => [ + 'item_value' => [10], + 'extra_line_value' => 0.01, + 'extra_line_name' => 'My custom line name', + ], + 'items' => [ + [ + 'value' => 10, + 'quantity' => 2, + 'tax' => 3, + 'category' => Item::PHYSICAL_GOODS, + ], + ], + 'amount' => 26.01, + 'breakdown' => [ + 'item_total' => 20.01, + 'tax_total' => 6, + 'shipping' => null, + 'discount' => null, + 'shipping_discount' => null, + 'handling' => null, + 'insurance' => null, + ], + ], + 'with_rounding_down' => [ + 'message' => 'Extra line should be added with price 0.01 and line amount 10.00.', + 'expected' => [ + 'item_value' => [10.00], + 'extra_line_value' => 0.01 + ], + 'items' => [ + [ + 'value' => 10.005, + 'quantity' => 2, + 'tax' => 3, + 'category' => Item::PHYSICAL_GOODS, + ], + ], + 'amount' => 26.01, + 'breakdown' => [ + 'item_total' => 20.01, + 'tax_total' => 6, + 'shipping' => null, + 'discount' => null, + 'shipping_discount' => null, + 'handling' => null, + 'insurance' => null, + ], + ], + 'with_rounding_down_only_first_item' => [ + 'message' => 'Extra line should be added with price 0.01 and lines amount 10.00 and 5.00.', + 'expected' => [ + 'item_value' => [10.00, 5.00], + 'extra_line_value' => 0.01 + ], + 'items' => [ + [ + 'value' => 10.005, + 'quantity' => 2, + 'tax' => 3, + 'category' => Item::PHYSICAL_GOODS, + ], + [ + 'value' => 5, + 'quantity' => 2, + 'tax' => 3, + 'category' => Item::PHYSICAL_GOODS, + ], + ], + 'amount' => 36.01, + 'breakdown' => [ + 'item_total' => 30.01, + 'tax_total' => 6, + 'shipping' => null, + 'discount' => null, + 'shipping_discount' => null, + 'handling' => null, + 'insurance' => null, + ], + ], + 'with_multiple_roundings_down' => [ + 'message' => 'Extra line should be added with price 0.01 and lines amount 10.00, 5.00 and 6.66.', + 'expected' => [ + 'item_value' => [10.00, 5.00, 6.66], + 'extra_line_value' => 0.01 + ], + 'items' => [ + [ + 'value' => 10.005, + 'quantity' => 1, + 'tax' => 3, + 'category' => Item::PHYSICAL_GOODS, + ], + [ + 'value' => 5.001, + 'quantity' => 1, + 'tax' => 3, + 'category' => Item::PHYSICAL_GOODS, + ], + [ + 'value' => 6.666, + 'quantity' => 1, + 'tax' => 3, + 'category' => Item::PHYSICAL_GOODS, + ], + ], + 'amount' => 27.67, + 'breakdown' => [ + 'item_total' => 21.67, + 'tax_total' => 6, + 'shipping' => null, + 'discount' => null, + 'shipping_discount' => null, + 'handling' => null, + 'insurance' => null, + ], + ] + ]; + + $values = []; + foreach ($data as $testKey => $test) { + $items = []; + foreach ($test['items'] as $key => $item) { + $unitAmount = new Money($item['value'], 'EUR'); + $tax = new Money($item['tax'], 'EUR'); + $items[$key] = Mockery::mock( + Item::class, + [ + 'unit_amount' => $unitAmount, + 'tax' => $tax, + 'quantity'=> $item['quantity'], + 'category' => $item['category'], + ] + ); + + $items[$key]->shouldReceive('to_array')->andReturnUsing(function (bool $roundToFloor = false) use ($unitAmount, $tax, $item) { + return [ + 'unit_amount' => $unitAmount->to_array($roundToFloor), + 'tax' => $tax->to_array(), + 'quantity'=> $item['quantity'], + 'category' => $item['category'], + ]; + }); + + } + + $breakdown = null; + if ($test['breakdown']) { + $breakdown = Mockery::mock(AmountBreakdown::class); + foreach ($test['breakdown'] as $method => $value) { + $breakdown->shouldReceive($method)->andReturnUsing(function () use ($value) { + if (! is_numeric($value)) { + return null; + } + + $money = new Money($value, 'EUR'); + return $money; + }); + } + + $breakdown + ->shouldReceive('to_array') + ->andReturn( + array_map( + function ($value) { + return $value ? (new Money($value, 'EUR'))->to_array() : null; + }, + $test['breakdown'] + ) + ); + } + + $amountMoney = new Money($test['amount'], 'EUR'); + $amount = Mockery::mock(Amount::class); + $amount + ->shouldReceive('to_array') + ->andReturn([ + 'value' => $amountMoney->value_str(), + 'currency_code' => $amountMoney->currency_code(), + 'breakdown' => $breakdown ? $breakdown->to_array() : [], + ]); + $amount->shouldReceive('value_str')->andReturn($amountMoney->value_str()); + $amount->shouldReceive('currency_code')->andReturn('EUR'); + $amount->shouldReceive('breakdown')->andReturn($breakdown); + + $values[$testKey] = [ + $items, + $amount, + $test['expected'], + $test['message'], + ]; + } + + return $values; + } + public function testPayee() { $amount = Mockery::mock(Amount::class); From 1a0fa269ef99b0b495dd52c017a2ff19f95500f8 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Tue, 8 Aug 2023 15:20:40 +0100 Subject: [PATCH 04/22] Add passing data between PayPal order and WC order via transient helper. Add order notes when ditch oor extra line occurs. --- modules/ppcp-api-client/services.php | 6 + modules/ppcp-api-client/src/ApiModule.php | 27 +++ .../src/Endpoint/OrderEndpoint.php | 3 + .../Endpoint/PayUponInvoiceOrderEndpoint.php | 5 +- .../src/Helper/OrderTransient.php | 160 ++++++++++++++++++ .../src/Helper/PurchaseUnitSanitizer.php | 21 +++ modules/ppcp-button/services.php | 2 +- .../src/Endpoint/CreateOrderEndpoint.php | 3 + .../src/Helper/EarlyOrderHandler.php | 7 +- .../src/Processor/OrderMetaTrait.php | 13 +- psalm-baseline.xml | 5 + 11 files changed, 245 insertions(+), 7 deletions(-) create mode 100644 modules/ppcp-api-client/src/Helper/OrderTransient.php diff --git a/modules/ppcp-api-client/services.php b/modules/ppcp-api-client/services.php index 92d251507..3d7ad7e03 100644 --- a/modules/ppcp-api-client/services.php +++ b/modules/ppcp-api-client/services.php @@ -17,6 +17,7 @@ use WooCommerce\PayPalCommerce\ApiClient\Factory\PaymentPreferencesFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PlanFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\ProductFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\ShippingOptionFactory; +use WooCommerce\PayPalCommerce\ApiClient\Helper\OrderTransient; use WooCommerce\PayPalCommerce\ApiClient\Helper\PurchaseUnitSanitizer; use WooCommerce\PayPalCommerce\Session\SessionHandler; use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface; @@ -817,6 +818,11 @@ return array( 'api.order-helper' => static function( ContainerInterface $container ): OrderHelper { return new OrderHelper(); }, + 'api.helper.order-transient' => static function( ContainerInterface $container ): OrderTransient { + $cache = new Cache( 'ppcp-paypal-bearer' ); + $purchase_unit_sanitizer = $container->get( 'api.helper.purchase-unit-sanitizer' ); + return new OrderTransient( $cache, $purchase_unit_sanitizer ); + }, 'api.helper.purchase-unit-sanitizer' => static function( ContainerInterface $container ): PurchaseUnitSanitizer { $settings = $container->get( 'wcgateway.settings' ); assert( $settings instanceof Settings ); diff --git a/modules/ppcp-api-client/src/ApiModule.php b/modules/ppcp-api-client/src/ApiModule.php index 95a0efd14..7a07be123 100644 --- a/modules/ppcp-api-client/src/ApiModule.php +++ b/modules/ppcp-api-client/src/ApiModule.php @@ -9,10 +9,13 @@ declare(strict_types=1); namespace WooCommerce\PayPalCommerce\ApiClient; +use WC_Order; +use WooCommerce\PayPalCommerce\ApiClient\Helper\OrderTransient; use WooCommerce\PayPalCommerce\Vendor\Dhii\Container\ServiceProvider; use WooCommerce\PayPalCommerce\Vendor\Dhii\Modular\Module\ModuleInterface; use WooCommerce\PayPalCommerce\Vendor\Interop\Container\ServiceProviderInterface; use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface; +use WooCommerce\PayPalCommerce\ApiClient\Entity\Order; /** * Class ApiModule @@ -40,6 +43,30 @@ class ApiModule implements ModuleInterface { WC()->session->set( 'ppcp_fees', $fees ); } ); + add_action( + 'woocommerce_paypal_payments_paypal_order_created', + function ( Order $order ) use ( $c ) { + $transient = $c->has( 'api.helper.order-transient' ) ? $c->get( 'api.helper.order-transient' ) : null; + + if ( $transient instanceof OrderTransient ) { + $transient->on_order_created( $order ); + } + }, + 10, + 1 + ); + add_action( + 'woocommerce_paypal_payments_woocommerce_order_created', + function ( WC_Order $wc_order, Order $order ) use ( $c ) { + $transient = $c->has( 'api.helper.order-transient' ) ? $c->get( 'api.helper.order-transient' ) : null; + + if ( $transient instanceof OrderTransient ) { + $transient->on_woocommerce_order_created( $wc_order, $order ); + } + }, + 10, + 2 + ); } /** diff --git a/modules/ppcp-api-client/src/Endpoint/OrderEndpoint.php b/modules/ppcp-api-client/src/Endpoint/OrderEndpoint.php index 3b0954fae..3b232c7f6 100644 --- a/modules/ppcp-api-client/src/Endpoint/OrderEndpoint.php +++ b/modules/ppcp-api-client/src/Endpoint/OrderEndpoint.php @@ -281,6 +281,9 @@ class OrderEndpoint { throw $error; } $order = $this->order_factory->from_paypal_response( $json ); + + do_action( 'woocommerce_paypal_payments_paypal_order_created', $order ); + return $order; } diff --git a/modules/ppcp-api-client/src/Endpoint/PayUponInvoiceOrderEndpoint.php b/modules/ppcp-api-client/src/Endpoint/PayUponInvoiceOrderEndpoint.php index df3091311..f91d848a1 100644 --- a/modules/ppcp-api-client/src/Endpoint/PayUponInvoiceOrderEndpoint.php +++ b/modules/ppcp-api-client/src/Endpoint/PayUponInvoiceOrderEndpoint.php @@ -166,8 +166,11 @@ class PayUponInvoiceOrderEndpoint { throw new PayPalApiException( $json, $status_code ); } + $order = $this->order_factory->from_paypal_response( $json ); - return $this->order_factory->from_paypal_response( $json ); + do_action( 'woocommerce_paypal_payments_paypal_order_created', $order ); + + return $order; } /** diff --git a/modules/ppcp-api-client/src/Helper/OrderTransient.php b/modules/ppcp-api-client/src/Helper/OrderTransient.php new file mode 100644 index 000000000..d0c7d4a01 --- /dev/null +++ b/modules/ppcp-api-client/src/Helper/OrderTransient.php @@ -0,0 +1,160 @@ +cache = $cache; + $this->purchase_unit_sanitizer = $purchase_unit_sanitizer; + } + + /** + * Processes the created PayPal order. + * + * @param Order $order The PayPal order. + * @return void + */ + public function on_order_created( Order $order ): void { + $message = $this->purchase_unit_sanitizer->get_last_message(); + $this->add_order_note( $order, $message ); + } + + /** + * Processes the created WooCommerce order. + * + * @param WC_Order $wc_order The WooCommerce order. + * @param Order $order The PayPal order. + * @return void + */ + public function on_woocommerce_order_created( WC_Order $wc_order, Order $order ): void { + $cache_key = $this->cache_key( $order ); + + if ( ! $cache_key ) { + return; + } + + $this->apply_order_notes( $order, $wc_order ); + $this->cache->delete( $cache_key ); + } + + /** + * Adds an order note associated with a PayPal order. + * It can be added to a WooCommerce order associated with this PayPal order in the future. + * + * @param Order $order The PayPal order. + * @param string $message The message to be added to order notes. + * @return void + */ + private function add_order_note( Order $order, string $message ): void { + if ( ! $message ) { + return; + } + + $cache_key = $this->cache_key( $order ); + + if ( ! $cache_key ) { + return; + } + + $transient = $this->cache->get( $cache_key ); + + if ( ! is_array( $transient ) ) { + $transient = array(); + } + + if ( ! is_array( $transient['notes'] ) ) { + $transient['notes'] = array(); + } + + $transient['notes'][] = $message; + + $this->cache->set( $cache_key, $transient, self::CACHE_TIMEOUT ); + } + + /** + * Adds an order note associated with a PayPal order. + * It can be added to a WooCommerce order associated with this PayPal order in the future. + * + * @param Order $order The PayPal order. + * @param WC_Order $wc_order The WooCommerce order. + * @return void + */ + private function apply_order_notes( Order $order, WC_Order $wc_order ): void { + $cache_key = $this->cache_key( $order ); + + if ( ! $cache_key ) { + return; + } + + $transient = $this->cache->get( $cache_key ); + + if ( ! is_array( $transient ) ) { + return; + } + + if ( ! is_array( $transient['notes'] ) ) { + return; + } + + foreach ( $transient['notes'] as $note ) { + if ( ! is_string( $note ) ) { + continue; + } + $wc_order->add_order_note( $note ); + } + } + + /** + * Build cache key. + * + * @param Order $order The PayPal order. + * @return string|null + */ + private function cache_key( Order $order ): ?string { + if ( ! $order->id() ) { + return null; + } + return implode( '_', array( self::CACHE_KEY . $order->id() ) ); + } + +} diff --git a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php index 263b428e4..403ec5a68 100644 --- a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php +++ b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php @@ -68,6 +68,12 @@ class PurchaseUnitSanitizer { */ private $extra_line_name; + /** + * The last message. To be added to order notes. + * + * @var string + */ + private $last_message = ''; /** * PurchaseUnitSanitizer constructor. @@ -201,6 +207,8 @@ class PurchaseUnitSanitizer { $line_name = $this->extra_line_name; $roundings_money = new Money( $item_mismatch, $this->currency_code() ); $this->purchase_unit['items'][] = ( new Item( $line_name, $roundings_money, 1 ) )->to_array(); + + $this->last_message = __( 'Item amount mismatch. Extra line added.', 'woocommerce-paypal-payments' ); } $item_mismatch = $this->calculate_item_mismatch(); @@ -210,6 +218,7 @@ class PurchaseUnitSanitizer { // Ditch items. if ( $this->allow_ditch_items && isset( $this->purchase_unit['items'] ) ) { unset( $this->purchase_unit['items'] ); + $this->last_message = __( 'Item amount mismatch. Items ditched.', 'woocommerce-paypal-payments' ); } } } @@ -251,6 +260,8 @@ class PurchaseUnitSanitizer { if ( isset( $this->purchase_unit['amount']['breakdown'] ) ) { unset( $this->purchase_unit['amount']['breakdown'] ); } + + $this->last_message = __( 'Breakdown mismatch. Items and breakdown ditched.', 'woocommerce-paypal-payments' ); } } @@ -334,4 +345,14 @@ class PurchaseUnitSanitizer { return $amount_str - $amount_total_str; } + + /** + * Returns the last sanitization message. + * + * @return string + */ + public function get_last_message(): string { + return $this->last_message; + } + } diff --git a/modules/ppcp-button/services.php b/modules/ppcp-button/services.php index 88ee20dd0..dca33196f 100644 --- a/modules/ppcp-button/services.php +++ b/modules/ppcp-button/services.php @@ -156,7 +156,7 @@ return array( $session_handler = $container->get( 'session.handler' ); $settings = $container->get( 'wcgateway.settings' ); $early_order_handler = $container->get( 'button.helper.early-order-handler' ); - $registration_needed = $container->get( 'button.current-user-must-register' ); + $registration_needed = $container->get( 'button.current-user-must-register' ); $logger = $container->get( 'woocommerce.logger.woocommerce' ); return new CreateOrderEndpoint( $request_data, diff --git a/modules/ppcp-button/src/Endpoint/CreateOrderEndpoint.php b/modules/ppcp-button/src/Endpoint/CreateOrderEndpoint.php index d4ddfb21f..4ee88c3c7 100644 --- a/modules/ppcp-button/src/Endpoint/CreateOrderEndpoint.php +++ b/modules/ppcp-button/src/Endpoint/CreateOrderEndpoint.php @@ -25,6 +25,7 @@ use WooCommerce\PayPalCommerce\ApiClient\Exception\RuntimeException; use WooCommerce\PayPalCommerce\ApiClient\Factory\PayerFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PurchaseUnitFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\ShippingPreferenceFactory; +use WooCommerce\PayPalCommerce\ApiClient\Helper\OrderTransient; use WooCommerce\PayPalCommerce\Button\Exception\ValidationException; use WooCommerce\PayPalCommerce\Button\Validation\CheckoutFormValidator; use WooCommerce\PayPalCommerce\Button\Helper\EarlyOrderHandler; @@ -330,6 +331,8 @@ class CreateOrderEndpoint implements EndpointInterface { $wc_order->update_meta_data( PayPalGateway::ORDER_ID_META_KEY, $order->id() ); $wc_order->update_meta_data( PayPalGateway::INTENT_META_KEY, $order->intent() ); $wc_order->save_meta_data(); + + do_action( 'woocommerce_paypal_payments_woocommerce_order_created', $wc_order, $order ); } wp_send_json_success( $this->make_response( $order ) ); diff --git a/modules/ppcp-button/src/Helper/EarlyOrderHandler.php b/modules/ppcp-button/src/Helper/EarlyOrderHandler.php index 4ac8583d0..03d8fbeed 100644 --- a/modules/ppcp-button/src/Helper/EarlyOrderHandler.php +++ b/modules/ppcp-button/src/Helper/EarlyOrderHandler.php @@ -11,6 +11,7 @@ namespace WooCommerce\PayPalCommerce\Button\Helper; use WooCommerce\PayPalCommerce\ApiClient\Entity\Order; use WooCommerce\PayPalCommerce\ApiClient\Exception\PayPalApiException; +use WooCommerce\PayPalCommerce\ApiClient\Helper\OrderTransient; use WooCommerce\PayPalCommerce\Onboarding\State; use WooCommerce\PayPalCommerce\Session\SessionHandler; use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayPalGateway; @@ -163,6 +164,10 @@ class EarlyOrderHandler { /** * Patch Order so we have the \WC_Order id added. */ - return $this->order_processor->patch_order( $wc_order, $order ); + $order = $this->order_processor->patch_order( $wc_order, $order ); + + do_action( 'woocommerce_paypal_payments_woocommerce_order_created', $wc_order, $order ); + + return $order; } } diff --git a/modules/ppcp-wc-gateway/src/Processor/OrderMetaTrait.php b/modules/ppcp-wc-gateway/src/Processor/OrderMetaTrait.php index 815f8d73e..47348eca3 100644 --- a/modules/ppcp-wc-gateway/src/Processor/OrderMetaTrait.php +++ b/modules/ppcp-wc-gateway/src/Processor/OrderMetaTrait.php @@ -11,6 +11,7 @@ namespace WooCommerce\PayPalCommerce\WcGateway\Processor; use WC_Order; use WooCommerce\PayPalCommerce\ApiClient\Entity\Order; +use WooCommerce\PayPalCommerce\ApiClient\Helper\OrderTransient; use WooCommerce\PayPalCommerce\Onboarding\Environment; use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayPalGateway; @@ -22,14 +23,16 @@ trait OrderMetaTrait { /** * Adds common metadata to the order. * - * @param WC_Order $wc_order The WC order to which metadata will be added. - * @param Order $order The PayPal order. - * @param Environment $environment The environment. + * @param WC_Order $wc_order The WC order to which metadata will be added. + * @param Order $order The PayPal order. + * @param Environment $environment The environment. + * @param OrderTransient|null $order_transient The order transient helper. */ protected function add_paypal_meta( WC_Order $wc_order, Order $order, - Environment $environment + Environment $environment, + OrderTransient $order_transient = null ): void { $wc_order->update_meta_data( PayPalGateway::ORDER_ID_META_KEY, $order->id() ); $wc_order->update_meta_data( PayPalGateway::INTENT_META_KEY, $order->intent() ); @@ -43,6 +46,8 @@ trait OrderMetaTrait { } $wc_order->save(); + + do_action( 'woocommerce_paypal_payments_woocommerce_order_created', $wc_order, $order ); } /** diff --git a/psalm-baseline.xml b/psalm-baseline.xml index 42ce967ca..c866d0bed 100644 --- a/psalm-baseline.xml +++ b/psalm-baseline.xml @@ -259,6 +259,11 @@ DAY_IN_SECONDS + + + DAY_IN_SECONDS + + realpath( __FILE__ ) From dea55e24c45c4440570559c2537b24e2a605dfd0 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Tue, 8 Aug 2023 17:01:03 +0100 Subject: [PATCH 05/22] Fix tests --- tests/e2e/PHPUnit/Order/PurchaseUnitTest.php | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/tests/e2e/PHPUnit/Order/PurchaseUnitTest.php b/tests/e2e/PHPUnit/Order/PurchaseUnitTest.php index 23edee911..6a72c4255 100644 --- a/tests/e2e/PHPUnit/Order/PurchaseUnitTest.php +++ b/tests/e2e/PHPUnit/Order/PurchaseUnitTest.php @@ -364,6 +364,11 @@ class PurchaseUnitTest extends TestCase ], self::adaptAmountFormat([ 'value' => 10.69, + 'breakdown' => [ + 'item_total' => 10.69, + 'tax_total' => 0, + 'shipping' => 0, + ], ]), ]; } @@ -432,6 +437,11 @@ class PurchaseUnitTest extends TestCase ], self::adaptAmountFormat([ 'value' => 10.69, + 'breakdown' => [ + 'item_total' => 10.69, + 'tax_total' => 0, + 'shipping' => 0, + ], ], get_woocommerce_currency()), ]; } From bb3b8553b9766adafdc05c790e0b05b3cd96ef79 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Wed, 9 Aug 2023 11:48:49 +0100 Subject: [PATCH 06/22] Refactor PurchaseUnitSanitizer to subtract 0.01 instead of rounding down Refactor PurchaseUnitSanitizer to use singleton pattern --- lib/packages/Pattern/SingletonTrait.php | 33 +++++++++++++++++++ modules/ppcp-api-client/services.php | 5 ++- modules/ppcp-api-client/src/Entity/Item.php | 5 ++- modules/ppcp-api-client/src/Entity/Money.php | 19 +++-------- .../src/Entity/PurchaseUnit.php | 2 +- .../src/Helper/MoneyFormatter.php | 21 +----------- .../src/Helper/PurchaseUnitSanitizer.php | 32 ++++++++++-------- .../ApiClient/Entity/PurchaseUnitTest.php | 14 ++++---- 8 files changed, 70 insertions(+), 61 deletions(-) create mode 100644 lib/packages/Pattern/SingletonTrait.php diff --git a/lib/packages/Pattern/SingletonTrait.php b/lib/packages/Pattern/SingletonTrait.php new file mode 100644 index 000000000..73669e076 --- /dev/null +++ b/lib/packages/Pattern/SingletonTrait.php @@ -0,0 +1,33 @@ + static function( ContainerInterface $container ): PurchaseUnitSanitizer { + if ( $instance = PurchaseUnitSanitizer::get_instance() ) { + return $instance; + } $settings = $container->get( 'wcgateway.settings' ); assert( $settings instanceof Settings ); $behavior = $settings->has( 'subtotal_mismatch_behavior' ) ? $settings->get( 'subtotal_mismatch_behavior' ) : null; $line_name = $settings->has( 'subtotal_mismatch_line_name' ) ? $settings->get( 'subtotal_mismatch_line_name' ) : null; - return new PurchaseUnitSanitizer( $behavior, $line_name ); + return PurchaseUnitSanitizer::singleton( $behavior, $line_name ); }, ); diff --git a/modules/ppcp-api-client/src/Entity/Item.php b/modules/ppcp-api-client/src/Entity/Item.php index 13f4702ba..44356b580 100644 --- a/modules/ppcp-api-client/src/Entity/Item.php +++ b/modules/ppcp-api-client/src/Entity/Item.php @@ -201,13 +201,12 @@ class Item { /** * Returns the object as array. * - * @param bool $round_to_floor If value rounding should be floor. * @return array */ - public function to_array( bool $round_to_floor = false ): array { + public function to_array(): array { $item = array( 'name' => $this->name(), - 'unit_amount' => $this->unit_amount()->to_array( $round_to_floor ), + 'unit_amount' => $this->unit_amount()->to_array(), 'quantity' => $this->quantity(), 'description' => $this->description(), 'sku' => $this->sku(), diff --git a/modules/ppcp-api-client/src/Entity/Money.php b/modules/ppcp-api-client/src/Entity/Money.php index e8f638feb..5ba49dc43 100644 --- a/modules/ppcp-api-client/src/Entity/Money.php +++ b/modules/ppcp-api-client/src/Entity/Money.php @@ -62,11 +62,10 @@ class Money { /** * The value formatted as string for API requests. * - * @param bool $round_to_floor If value rounding should be floor. * @return string */ - public function value_str( bool $round_to_floor = false ): string { - return $this->money_formatter->format( $this->value, $this->currency_code, $round_to_floor ); + public function value_str(): string { + return $this->money_formatter->format( $this->value, $this->currency_code ); } /** @@ -81,22 +80,12 @@ class Money { /** * Returns the object as array. * - * @param bool $round_to_floor If value rounding should be floor. * @return array */ - public function to_array( bool $round_to_floor = false ): array { + public function to_array(): array { return array( 'currency_code' => $this->currency_code(), - 'value' => $this->value_str( $round_to_floor ), + 'value' => $this->value_str(), ); } - - /** - * Indicates if the default rounding for this value is rounding up. - * - * @return bool - */ - public function is_rounding_up(): bool { - return (float) $this->value_str() > $this->value; - } } diff --git a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php index 26928cf4c..61a5bbb6a 100644 --- a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php +++ b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php @@ -336,7 +336,7 @@ class PurchaseUnit { } if ( $sanitize_output && isset( $this->sanitizer ) ) { - $purchase_unit = ( $this->sanitizer->sanitize( $purchase_unit, $this->items(), $allow_ditch_items ) ); + $purchase_unit = ( $this->sanitizer->sanitize( $purchase_unit, $allow_ditch_items ) ); } return $purchase_unit; diff --git a/modules/ppcp-api-client/src/Helper/MoneyFormatter.php b/modules/ppcp-api-client/src/Helper/MoneyFormatter.php index 3e19a10f5..447ba0a0e 100644 --- a/modules/ppcp-api-client/src/Helper/MoneyFormatter.php +++ b/modules/ppcp-api-client/src/Helper/MoneyFormatter.php @@ -25,31 +25,12 @@ class MoneyFormatter { * * @param float $value The value. * @param string $currency The 3-letter currency code. - * @param bool $round_to_floor If value rounding should be floor. * * @return string */ - public function format( float $value, string $currency, bool $round_to_floor = false ): string { - if ( $round_to_floor ) { - return in_array( $currency, $this->currencies_without_decimals, true ) - ? (string) floor( $value ) - : number_format( $this->floor_with_decimals( $value, 2 ), 2, '.', '' ); - } - + public function format( float $value, string $currency ): string { return in_array( $currency, $this->currencies_without_decimals, true ) ? (string) round( $value, 0 ) : number_format( $value, 2, '.', '' ); } - - /** - * Rounds to floor with decimal precision. - * - * @param float $value The value. - * @param int $decimals The number of decimals. - * @return float - */ - private function floor_with_decimals( float $value, int $decimals = 0 ): float { - $adjustment = (float) pow( 10, $decimals ); - return floor( $value * $adjustment ) / $adjustment; - } } diff --git a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php index 403ec5a68..4da9281df 100644 --- a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php +++ b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php @@ -19,11 +19,14 @@ namespace WooCommerce\PayPalCommerce\ApiClient\Helper; use WooCommerce\PayPalCommerce\ApiClient\Entity\Item; use WooCommerce\PayPalCommerce\ApiClient\Entity\Money; +use WooCommerce\PayPalCommerce\Vendor\Pattern\SingletonTrait; /** * Class PurchaseUnitSanitizer */ class PurchaseUnitSanitizer { + use SingletonTrait; + const MODE_DITCH = 'ditch'; const MODE_EXTRA_LINE = 'extra_line'; const VALID_MODES = array( @@ -40,13 +43,6 @@ class PurchaseUnitSanitizer { */ private $purchase_unit = array(); - /** - * The purchase unit Item objects - * - * @var array|Item[] - */ - private $item_objects = array(); - /** * Whether to allow items to be ditched. * @@ -95,6 +91,17 @@ class PurchaseUnitSanitizer { $this->extra_line_name = $extra_line_name; } + /** + * PurchaseUnitSanitizer singleton. + * + * @param string|null $mode The mismatch handling mode, ditch or extra_line. + * @param string|null $extra_line_name The name of the extra line. + * @return self + */ + public static function singleton( string $mode = null, string $extra_line_name = null ): self { + return self::set_instance( new self( $mode, $extra_line_name ) ); + } + /** * Indicates if mode is ditch. * @@ -166,13 +173,11 @@ class PurchaseUnitSanitizer { * The sanitizes the purchase_unit array. * * @param array $purchase_unit The purchase_unit array that should be sanitized. - * @param array|Item[] $item_objects The purchase unit Item objects used for recalculations. * @param bool $allow_ditch_items Whether to allow items to be ditched. * @return array */ - public function sanitize( array $purchase_unit, array $item_objects, bool $allow_ditch_items = true ): array { + public function sanitize( array $purchase_unit, bool $allow_ditch_items = true ): array { $this->purchase_unit = $purchase_unit; - $this->item_objects = $item_objects; $this->allow_ditch_items = $allow_ditch_items; $this->sanitize_item_amount_mismatch(); @@ -193,10 +198,9 @@ class PurchaseUnitSanitizer { if ( $item_mismatch < 0 ) { // Do floors on item amounts so item_mismatch is a positive value. - foreach ( $this->item_objects as $index => $item ) { - $this->purchase_unit['items'][ $index ] = $item->to_array( - $item->unit_amount()->is_rounding_up() - ); + foreach ( $this->purchase_unit['items'] as $index => $item ) { + // get a more intelligent adjustment mechanism + $this->purchase_unit['items'][ $index ]['unit_amount']['value'] = ( (float) $this->purchase_unit['items'][ $index ]['unit_amount']['value'] ) - 0.01; } } diff --git a/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php b/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php index 328f5cb15..c9d81f8aa 100644 --- a/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php +++ b/tests/PHPUnit/ApiClient/Entity/PurchaseUnitTest.php @@ -662,11 +662,11 @@ class PurchaseUnitTest extends TestCase 'insurance' => null, ], ], - 'with_rounding_down_only_first_item' => [ - 'message' => 'Extra line should be added with price 0.01 and lines amount 10.00 and 5.00.', + 'with_two_rounding_down' => [ + 'message' => 'Extra line should be added with price 0.03 and lines amount 10.00 and 4.99.', 'expected' => [ - 'item_value' => [10.00, 5.00], - 'extra_line_value' => 0.01 + 'item_value' => [10.00, 4.99], + 'extra_line_value' => 0.03 ], 'items' => [ [ @@ -693,11 +693,11 @@ class PurchaseUnitTest extends TestCase 'insurance' => null, ], ], - 'with_multiple_roundings_down' => [ + 'with_many_roundings_down' => [ 'message' => 'Extra line should be added with price 0.01 and lines amount 10.00, 5.00 and 6.66.', 'expected' => [ - 'item_value' => [10.00, 5.00, 6.66], - 'extra_line_value' => 0.01 + 'item_value' => [10.00, 4.99, 6.66], + 'extra_line_value' => 0.02 ], 'items' => [ [ From 2b497182d3e6c42639fa1aa2e329345597bf2aee Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Wed, 9 Aug 2023 12:03:09 +0100 Subject: [PATCH 07/22] Fix lint Fix currency precision --- modules/ppcp-api-client/services.php | 4 +++- .../ppcp-api-client/src/Helper/MoneyFormatter.php | 12 ++++++++++++ .../src/Helper/PurchaseUnitSanitizer.php | 9 +++++---- 3 files changed, 20 insertions(+), 5 deletions(-) diff --git a/modules/ppcp-api-client/services.php b/modules/ppcp-api-client/services.php index 8e8dd790f..ae8d03961 100644 --- a/modules/ppcp-api-client/services.php +++ b/modules/ppcp-api-client/services.php @@ -824,9 +824,11 @@ return array( return new OrderTransient( $cache, $purchase_unit_sanitizer ); }, 'api.helper.purchase-unit-sanitizer' => static function( ContainerInterface $container ): PurchaseUnitSanitizer { - if ( $instance = PurchaseUnitSanitizer::get_instance() ) { + $instance = PurchaseUnitSanitizer::get_instance(); + if ( $instance ) { return $instance; } + $settings = $container->get( 'wcgateway.settings' ); assert( $settings instanceof Settings ); diff --git a/modules/ppcp-api-client/src/Helper/MoneyFormatter.php b/modules/ppcp-api-client/src/Helper/MoneyFormatter.php index 447ba0a0e..914adbe70 100644 --- a/modules/ppcp-api-client/src/Helper/MoneyFormatter.php +++ b/modules/ppcp-api-client/src/Helper/MoneyFormatter.php @@ -33,4 +33,16 @@ class MoneyFormatter { ? (string) round( $value, 0 ) : number_format( $value, 2, '.', '' ); } + + /** + * Returns the minimum amount a currency can be incremented or decremented. + * + * @param string $currency The 3-letter currency code. + * @return float + */ + public function minimum_increment( string $currency ): float { + return (float) in_array( $currency, $this->currencies_without_decimals, true ) + ? 1.00 + : 0.01; + } } diff --git a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php index 4da9281df..6da6ca478 100644 --- a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php +++ b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php @@ -172,8 +172,8 @@ class PurchaseUnitSanitizer { /** * The sanitizes the purchase_unit array. * - * @param array $purchase_unit The purchase_unit array that should be sanitized. - * @param bool $allow_ditch_items Whether to allow items to be ditched. + * @param array $purchase_unit The purchase_unit array that should be sanitized. + * @param bool $allow_ditch_items Whether to allow items to be ditched. * @return array */ public function sanitize( array $purchase_unit, bool $allow_ditch_items = true ): array { @@ -199,8 +199,9 @@ class PurchaseUnitSanitizer { // Do floors on item amounts so item_mismatch is a positive value. foreach ( $this->purchase_unit['items'] as $index => $item ) { - // get a more intelligent adjustment mechanism - $this->purchase_unit['items'][ $index ]['unit_amount']['value'] = ( (float) $this->purchase_unit['items'][ $index ]['unit_amount']['value'] ) - 0.01; + // Get a more intelligent adjustment mechanism. + $increment = ( new MoneyFormatter() )->minimum_increment( $item['unit_amount']['currency_code'] ); + $this->purchase_unit['items'][ $index ]['unit_amount']['value'] = ( (float) $item['unit_amount']['value'] ) - $increment; } } From ecb884c86caa2b718406c681252f6a35ca94ffe1 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Thu, 10 Aug 2023 09:46:15 +0100 Subject: [PATCH 08/22] Add SingletonDecorator Refactor PurchaseUnitSanitizer service registration to SingletonDecorator --- lib/packages/Pattern/SingletonDecorator.php | 61 +++++++++++++++++++ modules/ppcp-api-client/services.php | 12 ++-- .../src/Helper/PurchaseUnitSanitizer.php | 14 ----- 3 files changed, 65 insertions(+), 22 deletions(-) create mode 100644 lib/packages/Pattern/SingletonDecorator.php diff --git a/lib/packages/Pattern/SingletonDecorator.php b/lib/packages/Pattern/SingletonDecorator.php new file mode 100644 index 000000000..3fdc9a2c9 --- /dev/null +++ b/lib/packages/Pattern/SingletonDecorator.php @@ -0,0 +1,61 @@ +callable = $callable; + } + + /** + * The make constructor. + * + * @param callable $callable + * @return self + */ + public static function make( callable $callable ): self { + return new static( $callable ); + } + + /** + * Invokes a callable once and returns the same result on subsequent invokes. + * + * @param mixed ...$args Arguments to be passed to the callable. + * @return mixed + */ + public function __invoke( ...$args ) { + if ( ! $this->executed ) { + $this->result = call_user_func_array( $this->callable, $args ); + $this->executed = true; + } + + return $this->result; + } +} diff --git a/modules/ppcp-api-client/services.php b/modules/ppcp-api-client/services.php index ae8d03961..d079d5704 100644 --- a/modules/ppcp-api-client/services.php +++ b/modules/ppcp-api-client/services.php @@ -20,6 +20,7 @@ use WooCommerce\PayPalCommerce\ApiClient\Factory\ShippingOptionFactory; use WooCommerce\PayPalCommerce\ApiClient\Helper\OrderTransient; use WooCommerce\PayPalCommerce\ApiClient\Helper\PurchaseUnitSanitizer; use WooCommerce\PayPalCommerce\Session\SessionHandler; +use WooCommerce\PayPalCommerce\Vendor\Pattern\SingletonDecorator; use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface; use WooCommerce\PayPalCommerce\ApiClient\Authentication\Bearer; use WooCommerce\PayPalCommerce\ApiClient\Authentication\PayPalBearer; @@ -823,17 +824,12 @@ return array( $purchase_unit_sanitizer = $container->get( 'api.helper.purchase-unit-sanitizer' ); return new OrderTransient( $cache, $purchase_unit_sanitizer ); }, - 'api.helper.purchase-unit-sanitizer' => static function( ContainerInterface $container ): PurchaseUnitSanitizer { - $instance = PurchaseUnitSanitizer::get_instance(); - if ( $instance ) { - return $instance; - } - + 'api.helper.purchase-unit-sanitizer' => SingletonDecorator::make(static function( ContainerInterface $container ): PurchaseUnitSanitizer { $settings = $container->get( 'wcgateway.settings' ); assert( $settings instanceof Settings ); $behavior = $settings->has( 'subtotal_mismatch_behavior' ) ? $settings->get( 'subtotal_mismatch_behavior' ) : null; $line_name = $settings->has( 'subtotal_mismatch_line_name' ) ? $settings->get( 'subtotal_mismatch_line_name' ) : null; - return PurchaseUnitSanitizer::singleton( $behavior, $line_name ); - }, + return new PurchaseUnitSanitizer( $behavior, $line_name ); + }), ); diff --git a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php index 6da6ca478..468787c02 100644 --- a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php +++ b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php @@ -19,14 +19,11 @@ namespace WooCommerce\PayPalCommerce\ApiClient\Helper; use WooCommerce\PayPalCommerce\ApiClient\Entity\Item; use WooCommerce\PayPalCommerce\ApiClient\Entity\Money; -use WooCommerce\PayPalCommerce\Vendor\Pattern\SingletonTrait; /** * Class PurchaseUnitSanitizer */ class PurchaseUnitSanitizer { - use SingletonTrait; - const MODE_DITCH = 'ditch'; const MODE_EXTRA_LINE = 'extra_line'; const VALID_MODES = array( @@ -91,17 +88,6 @@ class PurchaseUnitSanitizer { $this->extra_line_name = $extra_line_name; } - /** - * PurchaseUnitSanitizer singleton. - * - * @param string|null $mode The mismatch handling mode, ditch or extra_line. - * @param string|null $extra_line_name The name of the extra line. - * @return self - */ - public static function singleton( string $mode = null, string $extra_line_name = null ): self { - return self::set_instance( new self( $mode, $extra_line_name ) ); - } - /** * Indicates if mode is ditch. * From 4338b9879cc73e1e9e419e6de8acce8f026aff2b Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Thu, 10 Aug 2023 10:01:28 +0100 Subject: [PATCH 09/22] Fix lint --- modules/ppcp-api-client/services.php | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/modules/ppcp-api-client/services.php b/modules/ppcp-api-client/services.php index d079d5704..66bda386f 100644 --- a/modules/ppcp-api-client/services.php +++ b/modules/ppcp-api-client/services.php @@ -824,12 +824,14 @@ return array( $purchase_unit_sanitizer = $container->get( 'api.helper.purchase-unit-sanitizer' ); return new OrderTransient( $cache, $purchase_unit_sanitizer ); }, - 'api.helper.purchase-unit-sanitizer' => SingletonDecorator::make(static function( ContainerInterface $container ): PurchaseUnitSanitizer { - $settings = $container->get( 'wcgateway.settings' ); - assert( $settings instanceof Settings ); + 'api.helper.purchase-unit-sanitizer' => SingletonDecorator::make( + static function( ContainerInterface $container ): PurchaseUnitSanitizer { + $settings = $container->get( 'wcgateway.settings' ); + assert( $settings instanceof Settings ); - $behavior = $settings->has( 'subtotal_mismatch_behavior' ) ? $settings->get( 'subtotal_mismatch_behavior' ) : null; - $line_name = $settings->has( 'subtotal_mismatch_line_name' ) ? $settings->get( 'subtotal_mismatch_line_name' ) : null; - return new PurchaseUnitSanitizer( $behavior, $line_name ); - }), + $behavior = $settings->has( 'subtotal_mismatch_behavior' ) ? $settings->get( 'subtotal_mismatch_behavior' ) : null; + $line_name = $settings->has( 'subtotal_mismatch_line_name' ) ? $settings->get( 'subtotal_mismatch_line_name' ) : null; + return new PurchaseUnitSanitizer( $behavior, $line_name ); + } + ), ); From 1b87257fdb8fbc2c0bdda4014d464bb47e85c4c8 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Fri, 11 Aug 2023 10:35:50 +0100 Subject: [PATCH 10/22] Refactor unsupported currency notice to show only on payment pages and under the PayPal plugin. --- .../ppcp-admin-notices/src/Entity/Message.php | 20 +++++++- .../src/Renderer/Renderer.php | 3 +- .../ppcp-wc-gateway/resources/js/common.js | 10 ++++ .../resources/js/common/wrapped-elements.js | 14 ++++++ modules/ppcp-wc-gateway/services.php | 16 +++++-- .../src/Assets/SettingsPageAssets.php | 38 ++++++++++++--- .../Notice/UnsupportedCurrencyAdminNotice.php | 46 +++++++++++++++---- .../src/Settings/HeaderRenderer.php | 2 + .../ppcp-wc-gateway/src/WCGatewayModule.php | 3 +- modules/ppcp-wc-gateway/webpack.config.js | 1 + 10 files changed, 131 insertions(+), 22 deletions(-) create mode 100644 modules/ppcp-wc-gateway/resources/js/common.js create mode 100644 modules/ppcp-wc-gateway/resources/js/common/wrapped-elements.js diff --git a/modules/ppcp-admin-notices/src/Entity/Message.php b/modules/ppcp-admin-notices/src/Entity/Message.php index 7a0466ef6..0e8bc959e 100644 --- a/modules/ppcp-admin-notices/src/Entity/Message.php +++ b/modules/ppcp-admin-notices/src/Entity/Message.php @@ -35,17 +35,26 @@ class Message { */ private $dismissable; + /** + * The wrapper selector that will contain the notice. + * + * @var string + */ + private $wrapper; + /** * Message constructor. * * @param string $message The message text. * @param string $type The message type. * @param bool $dismissable Whether the message is dismissable. + * @param string $wrapper The wrapper selector that will contain the notice. */ - public function __construct( string $message, string $type, bool $dismissable = true ) { + public function __construct( string $message, string $type, bool $dismissable = true, string $wrapper = '' ) { $this->type = $type; $this->message = $message; $this->dismissable = $dismissable; + $this->wrapper = $wrapper; } /** @@ -74,4 +83,13 @@ class Message { public function is_dismissable(): bool { return $this->dismissable; } + + /** + * Returns the wrapper selector that will contain the notice. + * + * @return string + */ + public function wrapper(): string { + return $this->wrapper; + } } diff --git a/modules/ppcp-admin-notices/src/Renderer/Renderer.php b/modules/ppcp-admin-notices/src/Renderer/Renderer.php index b67da1c30..f44c7aabc 100644 --- a/modules/ppcp-admin-notices/src/Renderer/Renderer.php +++ b/modules/ppcp-admin-notices/src/Renderer/Renderer.php @@ -41,9 +41,10 @@ class Renderer implements RendererInterface { $messages = $this->repository->current_message(); foreach ( $messages as $message ) { printf( - '

%s

', + '

%s

', $message->type(), ( $message->is_dismissable() ) ? 'is-dismissible' : '', + $message->wrapper() ? sprintf('data-ppcp-wrapper="%s"', $message->wrapper()) : '', wp_kses_post( $message->message() ) ); } diff --git a/modules/ppcp-wc-gateway/resources/js/common.js b/modules/ppcp-wc-gateway/resources/js/common.js new file mode 100644 index 000000000..e017594a7 --- /dev/null +++ b/modules/ppcp-wc-gateway/resources/js/common.js @@ -0,0 +1,10 @@ +import moveWrappedElements from "./common/wrapped-elements"; +document.addEventListener( + 'DOMContentLoaded', + () => { + // Wait for current execution context to end. + setTimeout(function () { + moveWrappedElements(); + }, 0); + } +); diff --git a/modules/ppcp-wc-gateway/resources/js/common/wrapped-elements.js b/modules/ppcp-wc-gateway/resources/js/common/wrapped-elements.js new file mode 100644 index 000000000..827e50586 --- /dev/null +++ b/modules/ppcp-wc-gateway/resources/js/common/wrapped-elements.js @@ -0,0 +1,14 @@ + +// This function is needed because WordPress moves our custom notices to the global placeholder. +function moveWrappedElements() { + (($) => { + $('*[data-ppcp-wrapper]').each(function() { + let $wrapper = $('.' + $(this).data('ppcpWrapper')); + if ($wrapper.length) { + $wrapper.append(this); + } + }); + })(jQuery) +} + +export default moveWrappedElements; diff --git a/modules/ppcp-wc-gateway/services.php b/modules/ppcp-wc-gateway/services.php index 2e9c6211d..7a63ff728 100644 --- a/modules/ppcp-wc-gateway/services.php +++ b/modules/ppcp-wc-gateway/services.php @@ -211,10 +211,18 @@ return array( return new ConnectAdminNotice( $state, $settings ); }, 'wcgateway.notice.currency-unsupported' => static function ( ContainerInterface $container ): UnsupportedCurrencyAdminNotice { - $state = $container->get( 'onboarding.state' ); - $shop_currency = $container->get( 'api.shop.currency' ); - $supported_currencies = $container->get( 'api.supported-currencies' ); - return new UnsupportedCurrencyAdminNotice( $state, $shop_currency, $supported_currencies ); + $state = $container->get( 'onboarding.state' ); + $shop_currency = $container->get( 'api.shop.currency' ); + $supported_currencies = $container->get( 'api.supported-currencies' ); + $is_wc_gateways_list_page = $container->get( 'wcgateway.is-wc-gateways-list-page' ); + $is_ppcp_settings_page = $container->get( 'wcgateway.is-ppcp-settings-page' ); + return new UnsupportedCurrencyAdminNotice( + $state, + $shop_currency, + $supported_currencies, + $is_wc_gateways_list_page, + $is_ppcp_settings_page + ); }, 'wcgateway.notice.dcc-without-paypal' => static function ( ContainerInterface $container ): GatewayWithoutPayPalAdminNotice { return new GatewayWithoutPayPalAdminNotice( diff --git a/modules/ppcp-wc-gateway/src/Assets/SettingsPageAssets.php b/modules/ppcp-wc-gateway/src/Assets/SettingsPageAssets.php index aa069a7e7..27ab97ce3 100644 --- a/modules/ppcp-wc-gateway/src/Assets/SettingsPageAssets.php +++ b/modules/ppcp-wc-gateway/src/Assets/SettingsPageAssets.php @@ -87,6 +87,13 @@ class SettingsPageAssets { */ protected $all_funding_sources; + /** + * Whether it's a settings page of this plugin. + * + * @var bool + */ + private $is_settings_page; + /** * Assets constructor. * @@ -100,6 +107,7 @@ class SettingsPageAssets { * @param bool $is_pay_later_button_enabled Whether Pay Later button is enabled either for checkout, cart or product page. * @param array $disabled_sources The list of disabled funding sources. * @param array $all_funding_sources The list of all existing funding sources. + * @param bool $is_settings_page Whether it's a settings page of this plugin. */ public function __construct( string $module_url, @@ -111,7 +119,8 @@ class SettingsPageAssets { Environment $environment, bool $is_pay_later_button_enabled, array $disabled_sources, - array $all_funding_sources + array $all_funding_sources, + bool $is_settings_page ) { $this->module_url = $module_url; $this->version = $version; @@ -123,6 +132,7 @@ class SettingsPageAssets { $this->is_pay_later_button_enabled = $is_pay_later_button_enabled; $this->disabled_sources = $disabled_sources; $this->all_funding_sources = $all_funding_sources; + $this->is_settings_page = $is_settings_page; } /** @@ -136,11 +146,13 @@ class SettingsPageAssets { return; } - if ( ! $this->is_paypal_payment_method_page() ) { - return; + if ( $this->is_settings_page ) { + $this->register_admin_assets(); } - $this->register_admin_assets(); + if ( $this->is_paypal_payment_method_page() ) { + $this->register_paypal_admin_assets(); + } } ); @@ -171,9 +183,9 @@ class SettingsPageAssets { } /** - * Register assets for admin pages. + * Register assets for PayPal admin pages. */ - private function register_admin_assets(): void { + private function register_paypal_admin_assets(): void { wp_enqueue_style( 'ppcp-gateway-settings', trailingslashit( $this->module_url ) . 'assets/css/gateway-settings.css', @@ -210,4 +222,18 @@ class SettingsPageAssets { ) ); } + + /** + * Register assets for PayPal admin pages. + */ + private function register_admin_assets(): void { + wp_enqueue_script( + 'ppcp-admin-common', + trailingslashit( $this->module_url ) . 'assets/js/common.js', + array(), + $this->version, + true + ); + } + } diff --git a/modules/ppcp-wc-gateway/src/Notice/UnsupportedCurrencyAdminNotice.php b/modules/ppcp-wc-gateway/src/Notice/UnsupportedCurrencyAdminNotice.php index 27ef14f79..540a557b8 100644 --- a/modules/ppcp-wc-gateway/src/Notice/UnsupportedCurrencyAdminNotice.php +++ b/modules/ppcp-wc-gateway/src/Notice/UnsupportedCurrencyAdminNotice.php @@ -40,6 +40,20 @@ class UnsupportedCurrencyAdminNotice { */ private $shop_currency; + /** + * Indicates if we're on the WooCommerce gateways list page. + * + * @var bool + */ + private $is_wc_gateways_list_page; + + /** + * Indicates if we're on a PPCP Settings page. + * + * @var bool + */ + private $is_ppcp_settings_page; + /** * UnsupportedCurrencyAdminNotice constructor. * @@ -47,10 +61,19 @@ class UnsupportedCurrencyAdminNotice { * @param string $shop_currency The shop currency. * @param array $supported_currencies The supported currencies. */ - public function __construct( State $state, string $shop_currency, array $supported_currencies ) { - $this->state = $state; - $this->shop_currency = $shop_currency; - $this->supported_currencies = $supported_currencies; + public function __construct( + State $state, + string $shop_currency, + array $supported_currencies, + bool $is_wc_gateways_list_page, + bool $is_ppcp_settings_page + ) { + $this->state = $state; + $this->shop_currency = $shop_currency; + $this->supported_currencies = $supported_currencies; + $this->is_wc_gateways_list_page = $is_wc_gateways_list_page; + $this->is_ppcp_settings_page = $is_ppcp_settings_page; + } /** @@ -63,16 +86,19 @@ class UnsupportedCurrencyAdminNotice { return null; } + $paypal_currency_support_url = 'https://developer.paypal.com/api/rest/reference/currency-codes/'; + $message = sprintf( - /* translators: %1$s the shop currency, 2$s the gateway name. */ + /* translators: %1$s the shop currency, %2$s the PayPal currency support page link opening HTML tag, %3$s the link ending HTML tag. */ __( - 'Attention: Your current WooCommerce store currency (%1$s) is not supported by PayPal. Please update your store currency to one that is supported by PayPal to ensure smooth transactions. Visit the PayPal currency support page for more information on supported currencies.', + 'Attention: Your current WooCommerce store currency (%1$s) is not supported by PayPal. Please update your store currency to one that is supported by PayPal to ensure smooth transactions. Visit the %2$sPayPal currency support page%3$s for more information on supported currencies.', 'woocommerce-paypal-payments' ), $this->shop_currency, - 'https://developer.paypal.com/api/rest/reference/currency-codes/' + '', + '' ); - return new Message( $message, 'warning' ); + return new Message( $message, 'warning', true, 'ppcp-notice-wrapper' ); } /** @@ -81,7 +107,9 @@ class UnsupportedCurrencyAdminNotice { * @return bool */ protected function should_display(): bool { - return $this->state->current_state() === State::STATE_ONBOARDED && ! $this->currency_supported(); + return $this->state->current_state() === State::STATE_ONBOARDED + && ! $this->currency_supported() + && ($this->is_wc_gateways_list_page || $this->is_ppcp_settings_page); } /** diff --git a/modules/ppcp-wc-gateway/src/Settings/HeaderRenderer.php b/modules/ppcp-wc-gateway/src/Settings/HeaderRenderer.php index a4302bc37..5f9b79280 100644 --- a/modules/ppcp-wc-gateway/src/Settings/HeaderRenderer.php +++ b/modules/ppcp-wc-gateway/src/Settings/HeaderRenderer.php @@ -77,6 +77,8 @@ class HeaderRenderer { ' + +
'; } } diff --git a/modules/ppcp-wc-gateway/src/WCGatewayModule.php b/modules/ppcp-wc-gateway/src/WCGatewayModule.php index 28c610b7e..477ce303f 100644 --- a/modules/ppcp-wc-gateway/src/WCGatewayModule.php +++ b/modules/ppcp-wc-gateway/src/WCGatewayModule.php @@ -183,7 +183,8 @@ class WCGatewayModule implements ModuleInterface { $c->get( 'onboarding.environment' ), $settings_status->is_pay_later_button_enabled(), $settings->has( 'disable_funding' ) ? $settings->get( 'disable_funding' ) : array(), - $c->get( 'wcgateway.settings.funding-sources' ) + $c->get( 'wcgateway.settings.funding-sources' ), + $c->get( 'wcgateway.is-ppcp-settings-page' ) ); $assets->register_assets(); } diff --git a/modules/ppcp-wc-gateway/webpack.config.js b/modules/ppcp-wc-gateway/webpack.config.js index bd4a22fdc..a8a78a8bc 100644 --- a/modules/ppcp-wc-gateway/webpack.config.js +++ b/modules/ppcp-wc-gateway/webpack.config.js @@ -6,6 +6,7 @@ module.exports = { mode: isProduction ? 'production' : 'development', target: 'web', entry: { + 'common': path.resolve('./resources/js/common.js'), 'gateway-settings': path.resolve('./resources/js/gateway-settings.js'), 'fraudnet': path.resolve('./resources/js/fraudnet.js'), 'oxxo': path.resolve('./resources/js/oxxo.js'), From 0a873eb2a151a8c847da45fc4d3eb58c3641b616 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Fri, 11 Aug 2023 10:57:08 +0100 Subject: [PATCH 11/22] Fix lint --- modules/ppcp-admin-notices/src/Renderer/Renderer.php | 2 +- .../src/Notice/UnsupportedCurrencyAdminNotice.php | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/ppcp-admin-notices/src/Renderer/Renderer.php b/modules/ppcp-admin-notices/src/Renderer/Renderer.php index f44c7aabc..1202d2ab4 100644 --- a/modules/ppcp-admin-notices/src/Renderer/Renderer.php +++ b/modules/ppcp-admin-notices/src/Renderer/Renderer.php @@ -44,7 +44,7 @@ class Renderer implements RendererInterface { '

%s

', $message->type(), ( $message->is_dismissable() ) ? 'is-dismissible' : '', - $message->wrapper() ? sprintf('data-ppcp-wrapper="%s"', $message->wrapper()) : '', + ( $message->wrapper() ? sprintf( 'data-ppcp-wrapper="%s"', esc_attr( $message->wrapper() ) ) : '' ), wp_kses_post( $message->message() ) ); } diff --git a/modules/ppcp-wc-gateway/src/Notice/UnsupportedCurrencyAdminNotice.php b/modules/ppcp-wc-gateway/src/Notice/UnsupportedCurrencyAdminNotice.php index 540a557b8..88f02cffe 100644 --- a/modules/ppcp-wc-gateway/src/Notice/UnsupportedCurrencyAdminNotice.php +++ b/modules/ppcp-wc-gateway/src/Notice/UnsupportedCurrencyAdminNotice.php @@ -60,6 +60,8 @@ class UnsupportedCurrencyAdminNotice { * @param State $state The state. * @param string $shop_currency The shop currency. * @param array $supported_currencies The supported currencies. + * @param bool $is_wc_gateways_list_page Indicates if we're on the WooCommerce gateways list page. + * @param bool $is_ppcp_settings_page Indicates if we're on a PPCP Settings page. */ public function __construct( State $state, @@ -109,7 +111,7 @@ class UnsupportedCurrencyAdminNotice { protected function should_display(): bool { return $this->state->current_state() === State::STATE_ONBOARDED && ! $this->currency_supported() - && ($this->is_wc_gateways_list_page || $this->is_ppcp_settings_page); + && ( $this->is_wc_gateways_list_page || $this->is_ppcp_settings_page ); } /** From 1d20566592e7f1f941bcd054280d49b3f3e50435 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Fri, 11 Aug 2023 11:36:20 +0100 Subject: [PATCH 12/22] Fix tests --- tests/PHPUnit/WcGateway/Assets/SettingsPagesAssetsTest.php | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/tests/PHPUnit/WcGateway/Assets/SettingsPagesAssetsTest.php b/tests/PHPUnit/WcGateway/Assets/SettingsPagesAssetsTest.php index 6bd2ca14f..95aa53e0c 100644 --- a/tests/PHPUnit/WcGateway/Assets/SettingsPagesAssetsTest.php +++ b/tests/PHPUnit/WcGateway/Assets/SettingsPagesAssetsTest.php @@ -27,8 +27,9 @@ class SettingsPagesAssetsTest extends TestCase Mockery::mock(Environment::class), true, array(), - array() - ); + array(), + true + ); when('is_admin') ->justReturn(true); From d48c2f60c6b597e8e0484236eceff659f296f388 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Mon, 14 Aug 2023 12:00:40 +0100 Subject: [PATCH 13/22] Fix code review changes Add ppcp_ditch_items_breakdown support --- composer.json | 1 + .../Pattern/SingletonDecorator.php | 2 +- .../Pattern/SingletonTrait.php | 2 +- modules/ppcp-api-client/services.php | 26 +++---- .../src/Entity/PurchaseUnit.php | 24 +++++++ .../src/Helper/PurchaseUnitSanitizer.php | 70 ++++++++++++------- .../Settings/Fields/connection-tab-fields.php | 2 +- 7 files changed, 86 insertions(+), 41 deletions(-) rename lib/{packages => isolated}/Pattern/SingletonDecorator.php (94%) rename lib/{packages => isolated}/Pattern/SingletonTrait.php (90%) diff --git a/composer.json b/composer.json index 4a94eb54b..4a3a9624f 100644 --- a/composer.json +++ b/composer.json @@ -29,6 +29,7 @@ "autoload": { "psr-4": { "WooCommerce\\PayPalCommerce\\": "src", + "WooCommerce\\PayPalCommerce\\Isolated\\": "lib/isolated/", "WooCommerce\\PayPalCommerce\\Vendor\\": "lib/packages/" }, "files": [ diff --git a/lib/packages/Pattern/SingletonDecorator.php b/lib/isolated/Pattern/SingletonDecorator.php similarity index 94% rename from lib/packages/Pattern/SingletonDecorator.php rename to lib/isolated/Pattern/SingletonDecorator.php index 3fdc9a2c9..ea9c85a04 100644 --- a/lib/packages/Pattern/SingletonDecorator.php +++ b/lib/isolated/Pattern/SingletonDecorator.php @@ -1,6 +1,6 @@ sanitizer->sanitize( $purchase_unit, $allow_ditch_items ) ); } + return $this->apply_ditch_items_mismatch_filter( + $this->sanitizer->has_ditched_items_breakdown(), + $purchase_unit + ); + } + + public function apply_ditch_items_mismatch_filter( bool $ditched_items_breakdown, array $purchase_unit ): array + { + /** + * The filter can be used to control when the items and totals breakdown are removed from PayPal order info. + */ + $ditch = apply_filters( 'ppcp_ditch_items_breakdown', $ditched_items_breakdown, $this ); + + if ( $ditch ) { + unset( $purchase_unit['items'] ); + unset( $purchase_unit['amount']['breakdown'] ); + + if ( isset( $this->sanitizer ) ) { + $this->sanitizer->set_last_message( + __( 'Ditch items breakdown filter. Items and breakdown ditched.', 'woocommerce-paypal-payments' ) + ); + } + } + return $purchase_unit; } } diff --git a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php index 468787c02..16d50a149 100644 --- a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php +++ b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php @@ -68,6 +68,13 @@ class PurchaseUnitSanitizer { */ private $last_message = ''; + /** + * If the items and breakdown has been ditched. + * + * @var bool + */ + private $has_ditched_items_breakdown = false; + /** * PurchaseUnitSanitizer constructor. * @@ -88,24 +95,6 @@ class PurchaseUnitSanitizer { $this->extra_line_name = $extra_line_name; } - /** - * Indicates if mode is ditch. - * - * @return bool - */ - private function is_mode_ditch(): bool { - return $this->mode === self::MODE_DITCH; - } - - /** - * Indicates if mode is adding extra line. - * - * @return bool - */ - private function is_mode_extra_line(): bool { - return $this->mode === self::MODE_EXTRA_LINE; - } - /** * The purchase_unit amount. * @@ -163,8 +152,9 @@ class PurchaseUnitSanitizer { * @return array */ public function sanitize( array $purchase_unit, bool $allow_ditch_items = true ): array { - $this->purchase_unit = $purchase_unit; - $this->allow_ditch_items = $allow_ditch_items; + $this->purchase_unit = $purchase_unit; + $this->allow_ditch_items = $allow_ditch_items; + $this->has_ditched_items_breakdown = false; $this->sanitize_item_amount_mismatch(); $this->sanitize_item_tax_mismatch(); @@ -180,14 +170,18 @@ class PurchaseUnitSanitizer { private function sanitize_item_amount_mismatch(): void { $item_mismatch = $this->calculate_item_mismatch(); - if ( $this->is_mode_extra_line() ) { + if ( $this->mode === self::MODE_EXTRA_LINE ) { if ( $item_mismatch < 0 ) { // Do floors on item amounts so item_mismatch is a positive value. foreach ( $this->purchase_unit['items'] as $index => $item ) { // Get a more intelligent adjustment mechanism. $increment = ( new MoneyFormatter() )->minimum_increment( $item['unit_amount']['currency_code'] ); - $this->purchase_unit['items'][ $index ]['unit_amount']['value'] = ( (float) $item['unit_amount']['value'] ) - $increment; + + $this->purchase_unit['items'][ $index ]['unit_amount'] = ( new Money( + ( (float) $item['unit_amount']['value'] ) - $increment, + $item['unit_amount']['currency_code'] + ) )->to_array(); } } @@ -199,7 +193,9 @@ class PurchaseUnitSanitizer { $roundings_money = new Money( $item_mismatch, $this->currency_code() ); $this->purchase_unit['items'][] = ( new Item( $line_name, $roundings_money, 1 ) )->to_array(); - $this->last_message = __( 'Item amount mismatch. Extra line added.', 'woocommerce-paypal-payments' ); + $this->set_last_message( + __( 'Item amount mismatch. Extra line added.', 'woocommerce-paypal-payments' ) + ); } $item_mismatch = $this->calculate_item_mismatch(); @@ -209,7 +205,9 @@ class PurchaseUnitSanitizer { // Ditch items. if ( $this->allow_ditch_items && isset( $this->purchase_unit['items'] ) ) { unset( $this->purchase_unit['items'] ); - $this->last_message = __( 'Item amount mismatch. Items ditched.', 'woocommerce-paypal-payments' ); + $this->set_last_message( + __( 'Item amount mismatch. Items ditched.', 'woocommerce-paypal-payments' ) + ); } } } @@ -252,7 +250,10 @@ class PurchaseUnitSanitizer { unset( $this->purchase_unit['amount']['breakdown'] ); } - $this->last_message = __( 'Breakdown mismatch. Items and breakdown ditched.', 'woocommerce-paypal-payments' ); + $this->has_ditched_items_breakdown = true; + $this->set_last_message( + __( 'Breakdown mismatch. Items and breakdown ditched.', 'woocommerce-paypal-payments' ) + ); } } @@ -337,6 +338,16 @@ class PurchaseUnitSanitizer { return $amount_str - $amount_total_str; } + /** + * Indicates if the items and breakdown were ditched. + * + * @return bool + */ + public function has_ditched_items_breakdown(): bool + { + return $this->has_ditched_items_breakdown; + } + /** * Returns the last sanitization message. * @@ -346,4 +357,13 @@ class PurchaseUnitSanitizer { return $this->last_message; } + /** + * Set the last sanitization message. + * + * @param string $message + */ + public function set_last_message( string $message ): void { + $this->last_message = $message; + } + } diff --git a/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php b/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php index 0b099ebae..64babe773 100644 --- a/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php +++ b/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php @@ -504,7 +504,7 @@ return function ( ContainerInterface $container, array $fields ): array { 'default' => 'vertical', 'desc_tip' => true, 'description' => __( - 'Differences between WooCommerce and PayPal roundings may give origin to a mismatch in order items subtotal calculations. If not handled these mismatches will cause the PayPal transaction to fail.', + 'Differences between WooCommerce and PayPal roundings may cause mismatch in order items subtotal calculations. If not handled, these mismatches will cause the PayPal transaction to fail.', 'woocommerce-paypal-payments' ), 'options' => array( From 1e8469788312504792040a46d81f39002a8e8ee7 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Mon, 14 Aug 2023 13:40:50 +0100 Subject: [PATCH 14/22] Fix ditched_items_breakdown filter log message condition. --- modules/ppcp-api-client/src/Entity/PurchaseUnit.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php index 389ce6d87..1c881edb8 100644 --- a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php +++ b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php @@ -356,7 +356,7 @@ class PurchaseUnit { unset( $purchase_unit['items'] ); unset( $purchase_unit['amount']['breakdown'] ); - if ( isset( $this->sanitizer ) ) { + if ( isset( $this->sanitizer ) && ( $ditch !== $ditched_items_breakdown ) ) { $this->sanitizer->set_last_message( __( 'Ditch items breakdown filter. Items and breakdown ditched.', 'woocommerce-paypal-payments' ) ); From 576805a15ac5047456eb7c7cd6823faed20ca7ee Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Mon, 14 Aug 2023 14:01:13 +0100 Subject: [PATCH 15/22] Fix lint --- .../src/Entity/PurchaseUnit.php | 18 ++++++++++++++---- .../src/Helper/PurchaseUnitSanitizer.php | 5 ++--- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php index 1c881edb8..820df82af 100644 --- a/modules/ppcp-api-client/src/Entity/PurchaseUnit.php +++ b/modules/ppcp-api-client/src/Entity/PurchaseUnit.php @@ -335,18 +335,28 @@ class PurchaseUnit { $purchase_unit['soft_descriptor'] = $this->soft_descriptor(); } + $has_ditched_items_breakdown = false; + if ( $sanitize_output && isset( $this->sanitizer ) ) { - $purchase_unit = ( $this->sanitizer->sanitize( $purchase_unit, $allow_ditch_items ) ); + $purchase_unit = ( $this->sanitizer->sanitize( $purchase_unit, $allow_ditch_items ) ); + $has_ditched_items_breakdown = $this->sanitizer->has_ditched_items_breakdown(); } return $this->apply_ditch_items_mismatch_filter( - $this->sanitizer->has_ditched_items_breakdown(), + $has_ditched_items_breakdown, $purchase_unit ); } - public function apply_ditch_items_mismatch_filter( bool $ditched_items_breakdown, array $purchase_unit ): array - { + /** + * Applies the ppcp_ditch_items_breakdown filter. + * If true purchase_unit items and breakdown are ditched from PayPal. + * + * @param bool $ditched_items_breakdown If the breakdown and items were already ditched. + * @param array $purchase_unit The purchase_unit array. + * @return array + */ + public function apply_ditch_items_mismatch_filter( bool $ditched_items_breakdown, array $purchase_unit ): array { /** * The filter can be used to control when the items and totals breakdown are removed from PayPal order info. */ diff --git a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php index 16d50a149..7cb0c048f 100644 --- a/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php +++ b/modules/ppcp-api-client/src/Helper/PurchaseUnitSanitizer.php @@ -343,8 +343,7 @@ class PurchaseUnitSanitizer { * * @return bool */ - public function has_ditched_items_breakdown(): bool - { + public function has_ditched_items_breakdown(): bool { return $this->has_ditched_items_breakdown; } @@ -360,7 +359,7 @@ class PurchaseUnitSanitizer { /** * Set the last sanitization message. * - * @param string $message + * @param string $message The message. */ public function set_last_message( string $message ): void { $this->last_message = $message; From 0eb616c94e5a90488bddd2a71a90af1392649fe2 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Tue, 15 Aug 2023 08:27:59 +0100 Subject: [PATCH 16/22] Refactor WooCommerce\PayPalCommerce\Internale\Pattern to WooCommerce\PayPalCommerce\Common\Pattern --- composer.json | 2 +- .../Pattern/SingletonDecorator.php | 9 ++++++++- lib/{isolated => common}/Pattern/SingletonTrait.php | 10 +++++++++- modules/ppcp-api-client/services.php | 2 +- 4 files changed, 19 insertions(+), 4 deletions(-) rename lib/{isolated => common}/Pattern/SingletonDecorator.php (79%) rename lib/{isolated => common}/Pattern/SingletonTrait.php (71%) diff --git a/composer.json b/composer.json index 4a3a9624f..bb2ccbf7c 100644 --- a/composer.json +++ b/composer.json @@ -29,7 +29,7 @@ "autoload": { "psr-4": { "WooCommerce\\PayPalCommerce\\": "src", - "WooCommerce\\PayPalCommerce\\Isolated\\": "lib/isolated/", + "WooCommerce\\PayPalCommerce\\Common\\": "lib/common/", "WooCommerce\\PayPalCommerce\\Vendor\\": "lib/packages/" }, "files": [ diff --git a/lib/isolated/Pattern/SingletonDecorator.php b/lib/common/Pattern/SingletonDecorator.php similarity index 79% rename from lib/isolated/Pattern/SingletonDecorator.php rename to lib/common/Pattern/SingletonDecorator.php index ea9c85a04..54282dc91 100644 --- a/lib/isolated/Pattern/SingletonDecorator.php +++ b/lib/common/Pattern/SingletonDecorator.php @@ -1,7 +1,14 @@ Date: Tue, 15 Aug 2023 08:29:26 +0100 Subject: [PATCH 17/22] Removed satackey/action-docker-layer-caching from e2e testing --- .github/workflows/e2e.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml index 3731a1de4..0bf80c13b 100644 --- a/.github/workflows/e2e.yml +++ b/.github/workflows/e2e.yml @@ -12,9 +12,6 @@ jobs: name: PHP ${{ matrix.php-versions }} WC ${{ matrix.wc-versions }} steps: - - uses: satackey/action-docker-layer-caching@v0.0.11 - continue-on-error: true - - uses: ddev/github-action-setup-ddev@v1 with: autostart: false From af6d51b3a11bb3d8adea52b4c4763f41d07195f5 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Tue, 15 Aug 2023 08:58:38 +0100 Subject: [PATCH 18/22] Removed satackey/action-docker-layer-caching from e2e testing --- .github/workflows/e2e.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml index 3731a1de4..0bf80c13b 100644 --- a/.github/workflows/e2e.yml +++ b/.github/workflows/e2e.yml @@ -12,9 +12,6 @@ jobs: name: PHP ${{ matrix.php-versions }} WC ${{ matrix.wc-versions }} steps: - - uses: satackey/action-docker-layer-caching@v0.0.11 - continue-on-error: true - - uses: ddev/github-action-setup-ddev@v1 with: autostart: false From 9c94d5a5363452148909d32a103c0bfceee1cd79 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Wed, 16 Aug 2023 15:39:57 +0100 Subject: [PATCH 19/22] Updated lib/README.md for new common folder. --- lib/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/README.md b/lib/README.md index 9114c43ef..d38e3edd4 100644 --- a/lib/README.md +++ b/lib/README.md @@ -1,5 +1,10 @@ +## packages The packages that are likely to cause conflicts with other plugins (by loading multiple incompatible versions). Their namespaces are isolated by [Mozart](https://github.com/coenjacobs/mozart). Currently, the packages are simply added in the repo to avoid making the build process more complex (Mozart has different PHP requirements). We need to isolate only PSR-11 containers and Dhii modularity packages, which are not supposed to change often. + +## common +This folder contains reusable classes or components that do not fit into any specific module. +They are designed to be versatile and can be used by any module within the plugin. From d41a51fa63485840a2c84019f4192579429fd722 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Wed, 30 Aug 2023 16:57:06 +0100 Subject: [PATCH 20/22] Add handler support for settings fields Add settings SubElementsHandler --- .../js/SettingsHandler/SubElementsHandler.js | 51 +++++++++++++++++++ .../resources/js/gateway-settings.js | 12 +++++ .../Settings/Fields/connection-tab-fields.php | 33 ++++++++---- 3 files changed, 86 insertions(+), 10 deletions(-) create mode 100644 modules/ppcp-wc-gateway/resources/js/SettingsHandler/SubElementsHandler.js diff --git a/modules/ppcp-wc-gateway/resources/js/SettingsHandler/SubElementsHandler.js b/modules/ppcp-wc-gateway/resources/js/SettingsHandler/SubElementsHandler.js new file mode 100644 index 000000000..cb0b30252 --- /dev/null +++ b/modules/ppcp-wc-gateway/resources/js/SettingsHandler/SubElementsHandler.js @@ -0,0 +1,51 @@ + +class SubElementsHandler { + constructor(element, options) { + const fieldSelector = 'input, select, textarea'; + + this.element = element; + this.values = options.values; + this.elements = options.elements; + + this.elementsSelector = this.elements.join(','); + + this.input = jQuery(this.element).is(fieldSelector) + ? this.element + : jQuery(this.element).find(fieldSelector).get(0); + + this.updateElementsVisibility(); + + jQuery(this.input).change(() => { + this.updateElementsVisibility(); + }); + } + + updateElementsVisibility() { + const $elements = jQuery(this.elementsSelector); + + let value = this.getValue(this.input); + value = (value !== null ? value.toString() : value); + + if (this.values.indexOf(value) !== -1) { + $elements.show(); + } else { + $elements.hide(); + } + } + + getValue(element) { + const $el = jQuery(element); + + if ($el.is(':checkbox') || $el.is(':radio')) { + if ($el.is(':checked')) { + return $el.val(); + } else { + return null; + } + } else { + return $el.val(); + } + } +} + +export default SubElementsHandler; diff --git a/modules/ppcp-wc-gateway/resources/js/gateway-settings.js b/modules/ppcp-wc-gateway/resources/js/gateway-settings.js index c20432d48..bbb455be9 100644 --- a/modules/ppcp-wc-gateway/resources/js/gateway-settings.js +++ b/modules/ppcp-wc-gateway/resources/js/gateway-settings.js @@ -4,6 +4,7 @@ import Renderer from '../../../ppcp-button/resources/js/modules/Renderer/Rendere import MessageRenderer from "../../../ppcp-button/resources/js/modules/Renderer/MessageRenderer"; import {setVisibleByClass, isVisible} from "../../../ppcp-button/resources/js/modules/Helper/Hiding"; import widgetBuilder from "../../../ppcp-button/resources/js/modules/Renderer/WidgetBuilder"; +import SubElementsHandler from "./SettingsHandler/SubElementsHandler"; document.addEventListener( 'DOMContentLoaded', @@ -307,5 +308,16 @@ document.addEventListener( createButtonPreview(() => getButtonDefaultSettings('#ppcpPayLaterButtonPreview')); }); } + + // Generic behaviours, can be moved to common.js once it's on trunk branch. + jQuery( '*[data-ppcp-handlers]' ).each( (index, el) => { + const handlers = jQuery(el).data('ppcpHandlers'); + for (const handlerConfig of handlers) { + new { + SubElementsHandler: SubElementsHandler + }[handlerConfig.handler](el, handlerConfig.options) + } + }); + } ); diff --git a/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php b/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php index 64babe773..02f805101 100644 --- a/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php +++ b/modules/ppcp-wc-gateway/src/Settings/Fields/connection-tab-fields.php @@ -498,25 +498,38 @@ return function ( ContainerInterface $container, array $fields ): array { 'gateway' => Settings::CONNECTION_TAB_ID, ), 'subtotal_mismatch_behavior' => array( - 'title' => __( 'Subtotal mismatch behavior', 'woocommerce-paypal-payments' ), - 'type' => 'select', - 'input_class' => array( 'wc-enhanced-select' ), - 'default' => 'vertical', - 'desc_tip' => true, - 'description' => __( + 'title' => __( 'Subtotal mismatch behavior', 'woocommerce-paypal-payments' ), + 'type' => 'select', + 'input_class' => array( 'wc-enhanced-select' ), + 'default' => 'vertical', + 'desc_tip' => true, + 'description' => __( 'Differences between WooCommerce and PayPal roundings may cause mismatch in order items subtotal calculations. If not handled, these mismatches will cause the PayPal transaction to fail.', 'woocommerce-paypal-payments' ), - 'options' => array( + 'options' => array( PurchaseUnitSanitizer::MODE_DITCH => __( 'Do not send line items to PayPal', 'woocommerce-paypal-payments' ), PurchaseUnitSanitizer::MODE_EXTRA_LINE => __( 'Add another line item', 'woocommerce-paypal-payments' ), ), - 'screens' => array( + 'screens' => array( State::STATE_START, State::STATE_ONBOARDED, ), - 'requirements' => array(), - 'gateway' => Settings::CONNECTION_TAB_ID, + 'requirements' => array(), + 'gateway' => Settings::CONNECTION_TAB_ID, + 'custom_attributes' => array( + 'data-ppcp-handlers' => wp_json_encode( + array( + array( + 'handler' => 'SubElementsHandler', + 'options' => array( + 'values' => array( PurchaseUnitSanitizer::MODE_EXTRA_LINE ), + 'elements' => array( '#field-subtotal_mismatch_line_name' ), + ), + ), + ) + ), + ), ), 'subtotal_mismatch_line_name' => array( 'title' => __( 'Subtotal mismatch line name', 'woocommerce-paypal-payments' ), From 17cf2d36e37ae3b0e2e1103728f3ac589a7fa073 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Wed, 30 Aug 2023 17:13:03 +0100 Subject: [PATCH 21/22] Fix merge conflicts --- modules/ppcp-api-client/services.php | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/modules/ppcp-api-client/services.php b/modules/ppcp-api-client/services.php index 9483fe45a..ec73e16fd 100644 --- a/modules/ppcp-api-client/services.php +++ b/modules/ppcp-api-client/services.php @@ -27,9 +27,6 @@ use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface; use WooCommerce\PayPalCommerce\ApiClient\Authentication\Bearer; use WooCommerce\PayPalCommerce\ApiClient\Authentication\PayPalBearer; use WooCommerce\PayPalCommerce\ApiClient\Endpoint\BillingAgreementsEndpoint; -use WooCommerce\PayPalCommerce\ApiClient\Endpoint\BillingPlans; -use WooCommerce\PayPalCommerce\ApiClient\Endpoint\BillingSubscriptions; -use WooCommerce\PayPalCommerce\ApiClient\Endpoint\CatalogProducts; use WooCommerce\PayPalCommerce\ApiClient\Endpoint\IdentityToken; use WooCommerce\PayPalCommerce\ApiClient\Endpoint\LoginSeller; use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint; @@ -42,7 +39,6 @@ use WooCommerce\PayPalCommerce\ApiClient\Factory\AddressFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\AmountFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\ApplicationContextFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\AuthorizationFactory; -use WooCommerce\PayPalCommerce\ApiClient\Factory\BillingCycleFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\CaptureFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\ExchangeRateFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\FraudProcessorResponseFactory; @@ -52,19 +48,15 @@ use WooCommerce\PayPalCommerce\ApiClient\Factory\OrderFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PatchCollectionFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PayeeFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PayerFactory; -use WooCommerce\PayPalCommerce\ApiClient\Factory\PaymentPreferencesFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PaymentsFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PaymentSourceFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PaymentTokenActionLinksFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PaymentTokenFactory; -use WooCommerce\PayPalCommerce\ApiClient\Factory\PlanFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PlatformFeeFactory; -use WooCommerce\PayPalCommerce\ApiClient\Factory\ProductFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\PurchaseUnitFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\SellerReceivableBreakdownFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\SellerStatusFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\ShippingFactory; -use WooCommerce\PayPalCommerce\ApiClient\Factory\ShippingOptionFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\ShippingPreferenceFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\WebhookEventFactory; use WooCommerce\PayPalCommerce\ApiClient\Factory\WebhookFactory; @@ -78,8 +70,6 @@ use WooCommerce\PayPalCommerce\ApiClient\Repository\CustomerRepository; use WooCommerce\PayPalCommerce\ApiClient\Repository\OrderRepository; use WooCommerce\PayPalCommerce\ApiClient\Repository\PartnerReferralsData; use WooCommerce\PayPalCommerce\ApiClient\Repository\PayeeRepository; -use WooCommerce\PayPalCommerce\Session\SessionHandler; -use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface; use WooCommerce\PayPalCommerce\WcGateway\Settings\Settings; return array( From f54f413f7b216e88f8e60a20580a1ca8913b246a Mon Sep 17 00:00:00 2001 From: Alex P Date: Mon, 4 Sep 2023 16:09:33 +0300 Subject: [PATCH 22/22] Set payment method title for order edit page only if our gateway --- modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php b/modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php index 0b01b4750..c703de904 100644 --- a/modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php +++ b/modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php @@ -290,9 +290,11 @@ class PayPalGateway extends \WC_Payment_Gateway { // in the constructor, so must do it here. global $theorder; if ( $theorder instanceof WC_Order ) { - $payment_method_title = $theorder->get_payment_method_title(); - if ( $payment_method_title ) { - $this->title = $payment_method_title; + if ( $theorder->get_payment_method() === self::ID ) { + $payment_method_title = $theorder->get_payment_method_title(); + if ( $payment_method_title ) { + $this->title = $payment_method_title; + } } } }