Change pay with PayPal form URL to use order token

UPGRADE.md

@@ -1,3 +1,15 @@
+### UPGRADE FROM 1.3.0 to 1.3.1
+
+1. `sylius_paypal_plugin_pay_with_paypal_form` route now operates on both payment ID and order token. URl then changed from
+   `/pay-with-paypal/{id}` to `/pay-with-paypal/{orderToken}/{paymentId}`. If you use this route anywhere in your application, you
+   need to change the URL attributes
+
+### UPGRADE FROM 1.2.3 to 1.2.4
+
+1. `sylius_paypal_plugin_pay_with_paypal_form` route now operates on both payment ID and order token. URl then changed from
+    `/pay-with-paypal/{id}` to `/pay-with-paypal/{orderToken}/{paymentId}`. If you use this route anywhere in your application, you
+    need to change the URL attributes
+
 ### UPGRADE FROM 1.0.X TO 1.1.0
 
 1. Upgrade your application to [Sylius 1.8](https://github.com/Sylius/Sylius/blob/master/UPGRADE-1.8.md).

phpstan.neon

@@ -14,3 +14,6 @@ parameters:
         # Test dependencies
         - 'tests/Application/app/**.php'
         - 'tests/Application/src/**.php'
+
+    ignoreErrors:
+        - '/Call to an undefined method Sylius\\Component\\Core\\Repository\\PaymentRepositoryInterface\:\:createQueryBuilder\(\)\./'

psalm.xml

@@ -12,6 +12,7 @@
             <directory name="vendor" />
             <file name="src/DependencyInjection/Configuration.php" />
             <file name="src/UrlUtils.php" />
+            <file name="src/Controller/PayWithPayPalFormAction.php" />
         </ignoreFiles>
     </projectFiles>
 

spec/Payum/Action/ResolveNextRouteActionSpec.php

@@ -17,6 +17,7 @@ final class ResolveNextRouteActionSpec extends ObjectBehavior
     function it_executes_resolve_next_route_request_with_processing_payment(
         ResolveNextRoute $request,
         PaymentInterface $payment,
+        OrderInterface $order,
         PaymentMethodInterface $paymentMethod,
         GatewayConfigInterface $gatewayConfig
     ): void {
@@ -28,19 +29,24 @@ function it_executes_resolve_next_route_request_with_processing_payment(
         $paymentMethod->getGatewayConfig()->willReturn($gatewayConfig);
         $gatewayConfig->getFactoryName()->willReturn('sylius.pay_pal');
 
+        $payment->getOrder()->willReturn($order);
+        $order->getTokenValue()->willReturn('123!@#asd');
+
         $request->setRouteName('sylius_paypal_plugin_pay_with_paypal_form')->shouldBeCalled();
-        $request->setRouteParameters(['id' => 12])->shouldBeCalled();
+        $request->setRouteParameters(['orderToken' => '123!@#asd', 'paymentId' => 12])->shouldBeCalled();
 
         $this->execute($request);
     }
 
     function it_executes_resolve_next_route_request_with_completed_payment(
         ResolveNextRoute $request,
         PaymentInterface $payment,
+        OrderInterface $order,
         PaymentMethodInterface $paymentMethod,
         GatewayConfigInterface $gatewayConfig
     ): void {
         $request->getFirstModel()->willReturn($payment);
+        $payment->getOrder()->willReturn($order);
 
         $payment->getState()->willReturn(PaymentInterface::STATE_COMPLETED);
         $payment->getMethod()->willReturn($paymentMethod);

src/Controller/PayWithPayPalFormAction.php

@@ -49,8 +49,11 @@ public function __construct(
 
     public function __invoke(Request $request): Response
     {
+        $paymentId = (string) $request->attributes->get('paymentId');
+        $orderToken = (string) $request->attributes->get('orderToken');
+
         /** @var PaymentInterface $payment */
-        $payment = $this->paymentRepository->find($request->attributes->get('id'));
+        $payment = $this->findOneByPaymentIdOrderToken($paymentId, $orderToken);
         /** @var PaymentMethodInterface $paymentMethod */
         $paymentMethod = $payment->getMethod();
 
@@ -79,4 +82,22 @@ public function __invoke(Request $request): Response
             'partner_attribution_id' => $partnerAttributionId,
         ]));
     }
+
+    /**
+     * Need to be used due to support for Sylius 1.8.
+     * After dropping it, we can switch to Sylius\Component\Core\Repository\PaymentRepositoryInterface::findOneByOrderToken
+     */
+    private function findOneByPaymentIdOrderToken(string $paymentId, string $orderToken): ?PaymentInterface
+    {
+        return $this->paymentRepository
+            ->createQueryBuilder('p')
+            ->innerJoin('p.order', 'o')
+            ->andWhere('p.id = :paymentId')
+            ->andWhere('o.tokenValue = :orderToken')
+            ->setParameter('paymentId', $paymentId)
+            ->setParameter('orderToken', $orderToken)
+            ->getQuery()
+            ->getOneOrNullResult()
+        ;
+    }
 }

src/Payum/Action/ResolveNextRouteAction.php

@@ -19,9 +19,14 @@ public function execute($request): void
         /** @var PaymentInterface $payment */
         $payment = $request->getFirstModel();
 
+        /** @var OrderInterface $order */
+        $order = $payment->getOrder();
+
         if ($payment->getState() === PaymentInterface::STATE_NEW) {
             $request->setRouteName('sylius_paypal_plugin_pay_with_paypal_form');
-            $request->setRouteParameters(['id' => $payment->getId()]);
+            $request->setRouteParameters(
+                ['orderToken' => $order->getTokenValue(), 'paymentId' => $payment->getId()]
+            );
 
             return;
         }
@@ -32,9 +37,6 @@ public function execute($request): void
             return;
         }
 
-        /** @var OrderInterface $order */
-        $order = $payment->getOrder();
-
         $request->setRouteName('sylius_shop_order_show');
         $request->setRouteParameters(['tokenValue' => $order->getTokenValue()]);
     }

src/Resources/config/shop_routing.yaml

@@ -1,5 +1,5 @@
 sylius_paypal_plugin_pay_with_paypal_form:
-    path: /pay-with-paypal/{id}
+    path: /pay-with-paypal/{orderToken}/{paymentId}
     methods: [GET]
     defaults:
         _controller: Sylius\PayPalPlugin\Controller\PayWithPayPalFormAction