PPI-1056 - Refactor payment handlers to AbstractPaymentHandlers

phpstan-baseline.neon

@@ -10,11 +10,6 @@ parameters:
 			count: 1
 			path: src/Checkout/ExpressCheckout/Service/ExpressCustomerService.php
 
-		-
-			message: "#^Mixed variable in a `\\$session\\-\\>getFlashBag\\(\\)\\-\\>\\.\\.\\.\\(\\)` can skip important errors\\. Make sure the type is known$#"
-			count: 1
-			path: src/Checkout/Payment/Method/PUIHandler.php
-
 		-
 			message: "#^Usage of ALTER TABLE \\.\\. AFTER is disallowed in migrations to avoid implicit temporary table usage\\.$#"
 			count: 1
@@ -214,8 +209,3 @@ parameters:
 			message: "#^Provide more specific return type \"Shopware\\\\Core\\\\TestBootstrapper\" over abstract one$#"
 			count: 11
 			path: tests/TestBootstrapper.php
-
-		-
-			message: "#^Class like namespace \"Swag\\\\PayPal\\\\Test\\\\Util\\\\Lifecycle\" does not follow PSR\\-4 configuration in composer\\.json$#"
-			count: 1
-			path: tests/Util/Availability/AvailabilityServiceTest.php

phpstan.neon.dist

@@ -19,8 +19,8 @@ parameters:
     excludePaths:
         - src/Resources
         - src/DevOps/Rector
-        # tag:v6.7.0 - does not fully understand overwrite multiple definitions of DefaultPayment
-        - src/Pos/Payment/PosPayment.php
+        - tests/Checkout/ExpressCheckout/ExpressCheckoutSubscriberTest.php
+        - tests/DeprecatedTagTest.php
 
     bootstrapFiles:
         - bin/static-analyze-autoloader.php
@@ -36,9 +36,6 @@ parameters:
         null_over_false: true
 
     ignoreErrors:
-        # Will be fixed in v6.7
-        - '#Do not use md5 function, use class Shopware\\Core\\Framework\\Util\\Hasher instead.#'
-
         # We won't type all arrays/iterables for now
         - '#no value type specified in iterable type#'
 
@@ -67,41 +64,6 @@ parameters:
             paths:
                 - tests/**/*.php
 
-        - # Can be removed once the min SW version is 6.6.1.0
-            message: '#Method Context::createDefaultContext\(\) should not be used in CLI context. Use Context::createCLIContext\(\) instead#'
-            paths:
-                - src/Checkout/PUI/ScheduledTask/PUIInstructionsFetchTaskHandler.php
-                - src/Checkout/Payment/ScheduledTask/TransactionStatusSyncTaskHandler.php
-                - src/Pos/Command/AbstractPosCommand.php
-                - src/Pos/Schedule/AbstractSyncTaskHandler.php
-                - src/Reporting/ScheduledTask/TurnoverReportingTaskHandler.php
-
-        - # ignore shopware v6.7 payment handlers refactor deprecations
-            message: '#tag:v6.7.0 -.*PaymentTransactionStruct#'
-            paths:
-                - src/Checkout/Card/*Validator.php
-                - src/Checkout/Card/CardValidatorInterface.php
-                - src/Checkout/Payment/**/*Handler.php
-                - src/Checkout/Payment/PayPalPaymentHandler.php
-                - src/Checkout/Payment/Service/VaultTokenService.php
-                - src/OrdersApi/Builder/*Builder.php
-                - src/PaymentsApi/Builder/OrderPaymentBuilderInterface.php
-                - src/PaymentsApi/Builder/*Builder.php
-                - src/PaymentsApi/Patch/*.php
-
-        - # ignore shopware v6.7 payment handlers refactor deprecations
-            message: '#.*tag:v6.7.0 - will be removed, (extend AbstractPaymentHandler)|(use `build`) instead#'
-            paths:
-                - src/Checkout/Payment/**/*Handler.php
-                - src/Checkout/Payment/PayPalPaymentHandler.php
-                - src/Checkout/SalesChannel/CreateOrderRoute.php
-                - src/Webhook/Handler/VaultPaymentTokenCreated.php
-
-        - # ignore shopware v6.7 payment handlers refactor deprecations
-            message: '#Swag\\PayPal\\Pos\\Payment\\PosPayment#'
-            paths:
-                - tests/Pos/Util/InformationDefaultServiceTest.php
-
 services:
     -   # register the class, so we can decorate it, but don't tag it as a rule, so only our decorator is used by PHPStan
         class: Symplify\PHPStanRules\Rules\NoReturnSetterMethodRule

src/Checkout/Card/ACDCValidator.php

@@ -7,9 +7,9 @@
 
 namespace Swag\PayPal\Checkout\Card;
 
-use Shopware\Core\Checkout\Payment\Cart\SyncPaymentTransactionStruct;
+use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionEntity;
+use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\Log\Package;
-use Shopware\Core\System\SalesChannel\SalesChannelContext;
 use Swag\PayPal\Checkout\Exception\MissingPayloadException;
 use Swag\PayPal\RestApi\V2\Api\Order;
 
@@ -21,7 +21,7 @@ class ACDCValidator extends AbstractCardValidator implements CardValidatorInterf
      *
      * @see https://developer.paypal.com/docs/checkout/advanced/customize/3d-secure/response-parameters/
      */
-    public function validate(Order $order, SyncPaymentTransactionStruct $transaction, SalesChannelContext $salesChannelContext): bool
+    public function validate(Order $order, OrderTransactionEntity $transaction, Context $context): bool
     {
         $card = $order->getPaymentSource()?->getCard();
 
@@ -33,6 +33,6 @@ public function validate(Order $order, SyncPaymentTransactionStruct $transaction
             return true;
         }
 
-        return $this->validateAuthenticationResult($card->getAuthenticationResult(), $salesChannelContext);
+        return $this->validateAuthenticationResult($card->getAuthenticationResult(), $transaction->getOrder()?->getSalesChannelId());
     }
 }

src/Checkout/Card/AbstractCardValidator.php

@@ -8,7 +8,6 @@
 namespace Swag\PayPal\Checkout\Card;
 
 use Shopware\Core\Framework\Log\Package;
-use Shopware\Core\System\SalesChannel\SalesChannelContext;
 use Shopware\Core\System\SystemConfig\SystemConfigService;
 use Swag\PayPal\RestApi\V2\Api\Order\PaymentSource\Card\AuthenticationResult;
 use Swag\PayPal\Setting\Settings;
@@ -24,14 +23,14 @@ public function __construct(
     ) {
     }
 
-    protected function validateAuthenticationResult(AuthenticationResult $authenticationResult, SalesChannelContext $salesChannelContext): bool
+    protected function validateAuthenticationResult(AuthenticationResult $authenticationResult, ?string $salesChannelId): bool
     {
         if ($authenticationResult->getLiabilityShift() === self::LIABILITY_SHIFT_POSSIBLE
             || $authenticationResult->getLiabilityShift() === self::LIABILITY_SHIFT_YES) {
             return true;
         }
 
-        if ($this->systemConfigService->getBool(Settings::ACDC_FORCE_3DS, $salesChannelContext->getSalesChannelId())) {
+        if ($this->systemConfigService->getBool(Settings::ACDC_FORCE_3DS, $salesChannelId)) {
             return false;
         }
 

src/Checkout/Card/ApplePayValidator.php

@@ -7,16 +7,16 @@
 
 namespace Swag\PayPal\Checkout\Card;
 
-use Shopware\Core\Checkout\Payment\Cart\SyncPaymentTransactionStruct;
+use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionEntity;
+use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\Log\Package;
-use Shopware\Core\System\SalesChannel\SalesChannelContext;
 use Swag\PayPal\Checkout\Exception\MissingPayloadException;
 use Swag\PayPal\RestApi\V2\Api\Order;
 
 #[Package('checkout')]
 class ApplePayValidator extends AbstractCardValidator
 {
-    public function validate(Order $order, SyncPaymentTransactionStruct $transaction, SalesChannelContext $salesChannelContext): bool
+    public function validate(Order $order, OrderTransactionEntity $transaction, Context $context): bool
     {
         $card = $order->getPaymentSource()?->getApplePay()?->getCard();
 

src/Checkout/Card/CardValidatorInterface.php

@@ -7,9 +7,9 @@
 
 namespace Swag\PayPal\Checkout\Card;
 
-use Shopware\Core\Checkout\Payment\Cart\SyncPaymentTransactionStruct;
+use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionEntity;
+use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\Log\Package;
-use Shopware\Core\System\SalesChannel\SalesChannelContext;
 use Swag\PayPal\RestApi\V2\Api\Order;
 
 #[Package('checkout')]
@@ -35,5 +35,5 @@ interface CardValidatorInterface
     public const AUTHENTICATION_STATUS_INFORMATION_ONLY = 'I';
     public const AUTHENTICATION_STATUS_DECOUPLED = 'D';
 
-    public function validate(Order $order, SyncPaymentTransactionStruct $transaction, SalesChannelContext $salesChannelContext): bool;
+    public function validate(Order $order, OrderTransactionEntity $transaction, Context $context): bool;
 }

src/Checkout/Card/GooglePayValidator.php

@@ -7,9 +7,9 @@
 
 namespace Swag\PayPal\Checkout\Card;
 
-use Shopware\Core\Checkout\Payment\Cart\SyncPaymentTransactionStruct;
+use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionEntity;
+use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\Log\Package;
-use Shopware\Core\System\SalesChannel\SalesChannelContext;
 use Swag\PayPal\Checkout\Exception\MissingPayloadException;
 use Swag\PayPal\RestApi\V2\Api\Order;
 
@@ -21,7 +21,7 @@ class GooglePayValidator extends AbstractCardValidator implements CardValidatorI
      *
      * @see https://developer.paypal.com/docs/checkout/advanced/customize/3d-secure/response-parameters/
      */
-    public function validate(Order $order, SyncPaymentTransactionStruct $transaction, SalesChannelContext $salesChannelContext): bool
+    public function validate(Order $order, OrderTransactionEntity $transaction, Context $context): bool
     {
         $card = $order->getPaymentSource()?->getGooglePay()?->getCard();
 
@@ -33,6 +33,6 @@ public function validate(Order $order, SyncPaymentTransactionStruct $transaction
             return true;
         }
 
-        return $this->validateAuthenticationResult($card->getAuthenticationResult(), $salesChannelContext);
+        return $this->validateAuthenticationResult($card->getAuthenticationResult(), $transaction->getOrder()?->getSalesChannelId());
     }
 }

src/Checkout/CheckoutException.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+/*
+ * (c) shopware AG <[email protected]>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Swag\PayPal\Checkout;
+
+use Shopware\Core\Checkout\Payment\Cart\PaymentHandler\AbstractPaymentHandler;
+use Shopware\Core\Checkout\Payment\PaymentException;
+use Shopware\Core\Framework\Log\Package;
+use Symfony\Component\HttpFoundation\Response;
+
+#[Package('checkout')]
+class CheckoutException extends PaymentException
+{
+    public const PREPARED_ORDER_REQUIRED = 'PREPARED_ORDER_REQUIRED';
+
+    /**
+     * @param class-string<AbstractPaymentHandler> $paymentHandler
+     */
+    public static function preparedOrderRequired(string $paymentHandler): self
+    {
+        return new self(
+            Response::HTTP_BAD_REQUEST,
+            self::PREPARED_ORDER_REQUIRED,
+            'PayPal Order ID does not exist in the request. The payment method {{ paymentHandler }} requires a prepared PayPal order.',
+            ['paymentHandler' => $paymentHandler],
+        );
+    }
+}

src/Checkout/ExpressCheckout/SalesChannel/ExpressPrepareCheckoutRoute.php

@@ -19,7 +19,6 @@
 use Shopware\Core\System\SalesChannel\SalesChannelContext;
 use Swag\PayPal\Checkout\ExpressCheckout\ExpressCheckoutData;
 use Swag\PayPal\Checkout\ExpressCheckout\Service\ExpressCustomerService;
-use Swag\PayPal\Checkout\Payment\PayPalPaymentHandler;
 use Swag\PayPal\RestApi\V2\Resource\OrderResource;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -30,6 +29,7 @@
 class ExpressPrepareCheckoutRoute extends AbstractExpressPrepareCheckoutRoute
 {
     public const PAYPAL_EXPRESS_CHECKOUT_CART_EXTENSION_ID = 'payPalEcsCartData';
+    public const PAYPAL_REQUEST_PARAMETER_TOKEN = 'token';
 
     /**
      * @internal
@@ -72,10 +72,10 @@ public function prepareCheckout(SalesChannelContext $salesChannelContext, Reques
     {
         try {
             $this->logger->debug('Started', ['request' => $request->request->all()]);
-            $paypalOrderId = $request->request->get(PayPalPaymentHandler::PAYPAL_REQUEST_PARAMETER_TOKEN);
+            $paypalOrderId = $request->request->get(self::PAYPAL_REQUEST_PARAMETER_TOKEN);
 
             if (!\is_string($paypalOrderId)) {
-                throw RoutingException::missingRequestParameter(PayPalPaymentHandler::PAYPAL_REQUEST_PARAMETER_TOKEN);
+                throw RoutingException::missingRequestParameter(self::PAYPAL_REQUEST_PARAMETER_TOKEN);
             }
 
             $paypalOrder = $this->orderResource->get($paypalOrderId, $salesChannelContext->getSalesChannel()->getId());

src/Checkout/PUI/ScheduledTask/PUIInstructionsFetchTaskHandler.php

@@ -7,6 +7,7 @@
 
 namespace Swag\PayPal\Checkout\PUI\ScheduledTask;
 
+use Psr\Log\LoggerInterface;
 use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionStates;
 use Shopware\Core\Defaults;
 use Shopware\Core\Framework\Context;
@@ -32,11 +33,12 @@ class PUIInstructionsFetchTaskHandler extends ScheduledTaskHandler
 {
     public function __construct(
         EntityRepository $scheduledTaskRepository,
+        LoggerInterface $logger,
         private readonly EntityRepository $orderTransactionRepository,
         private readonly PaymentMethodDataRegistry $methodDataRegistry,
         private readonly MessageBusInterface $bus,
     ) {
-        parent::__construct($scheduledTaskRepository);
+        parent::__construct($scheduledTaskRepository, $logger);
     }
 
     public function run(): void
@@ -59,7 +61,7 @@ public function run(): void
             ]));
 
         /** @var string[] $transactionIds */
-        $transactionIds = $this->orderTransactionRepository->searchIds($criteria, Context::createDefaultContext())->getIds();
+        $transactionIds = $this->orderTransactionRepository->searchIds($criteria, Context::createCLIContext())->getIds();
 
         foreach ($transactionIds as $transactionId) {
             $this->bus->dispatch(new PUIInstructionsFetchMessage($transactionId));