MOL-1196: Tracking

src/Facade/MollieShipment.php

@@ -11,6 +11,7 @@
 use Kiener\MolliePayments\Service\MolliePaymentExtractor;
 use Kiener\MolliePayments\Service\OrderDeliveryService;
 use Kiener\MolliePayments\Service\OrderService;
+use Kiener\MolliePayments\Service\TrackingInfoStructFactory;
 use Kiener\MolliePayments\Service\Transition\DeliveryTransitionServiceInterface;
 use Kiener\MolliePayments\Struct\MollieApi\ShipmentTrackingInfoStruct;
 use Psr\Log\LoggerInterface;
@@ -20,6 +21,7 @@
 use Shopware\Core\Checkout\Order\Aggregate\OrderLineItem\OrderLineItemEntity;
 use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionEntity;
 use Shopware\Core\Checkout\Order\OrderEntity;
+use Shopware\Core\Checkout\Shipping\ShippingMethodEntity;
 use Shopware\Core\Content\Product\ProductEntity;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\Uuid\Uuid;
@@ -61,11 +63,17 @@ class MollieShipment implements MollieShipmentInterface
      */
     private $orderDataExtractor;
 
+    /**
+     * @var TrackingInfoStructFactory
+     */
+    private $trackingInfoStructFactory;
+
     /**
      * @var LoggerInterface
      */
     private $logger;
 
+
     /**
      * @param MolliePaymentExtractor $extractor
      * @param DeliveryTransitionServiceInterface $deliveryTransitionService
@@ -76,7 +84,7 @@ class MollieShipment implements MollieShipmentInterface
      * @param OrderDataExtractor $orderDataExtractor
      * @param LoggerInterface $logger
      */
-    public function __construct(MolliePaymentExtractor $extractor, DeliveryTransitionServiceInterface $deliveryTransitionService, Order $mollieApiOrderService, Shipment $mollieApiShipmentService, OrderDeliveryService $orderDeliveryService, OrderService $orderService, OrderDataExtractor $orderDataExtractor, LoggerInterface $logger)
+    public function __construct(MolliePaymentExtractor $extractor, DeliveryTransitionServiceInterface $deliveryTransitionService, Order $mollieApiOrderService, Shipment $mollieApiShipmentService, OrderDeliveryService $orderDeliveryService, OrderService $orderService, OrderDataExtractor $orderDataExtractor, TrackingInfoStructFactory $trackingInfoStructFactory, LoggerInterface $logger)
     {
         $this->extractor = $extractor;
         $this->deliveryTransitionService = $deliveryTransitionService;
@@ -86,6 +94,7 @@ public function __construct(MolliePaymentExtractor $extractor, DeliveryTransitio
         $this->orderService = $orderService;
         $this->orderDataExtractor = $orderDataExtractor;
         $this->logger = $logger;
+        $this->trackingInfoStructFactory = $trackingInfoStructFactory;
     }
 
     /**
@@ -170,7 +179,9 @@ public function setShipment(string $orderDeliveryId, Context $context): bool
             return false;
         }
 
-        $addedMollieShipment = $this->mollieApiOrderService->setShipment($mollieOrderId, $order->getSalesChannelId());
+        $trackingInfoStruct = $this->trackingInfoStructFactory->createFromDelivery($delivery);
+
+        $addedMollieShipment = $this->mollieApiOrderService->setShipment($mollieOrderId, $trackingInfoStruct, $order->getSalesChannelId());
 
         if ($addedMollieShipment) {
             $values = [CustomFieldsInterface::DELIVERY_SHIPPED => true];
@@ -250,7 +261,7 @@ public function shipOrder(
         $shipment = $this->mollieApiShipmentService->shipOrder(
             $mollieOrderId,
             $order->getSalesChannelId(),
-            $this->createTrackingInfoStruct($trackingCarrier, $trackingCode, $trackingUrl)
+            $this->trackingInfoStructFactory->create($trackingCarrier, $trackingCode, $trackingUrl)
         );
 
         $delivery = $this->orderDataExtractor->extractDelivery($order, $context);
@@ -371,7 +382,7 @@ public function shipItem(
             $order->getSalesChannelId(),
             $mollieOrderLineId,
             $quantity,
-            $this->createTrackingInfoStruct($trackingCarrier, $trackingCode, $trackingUrl)
+            $this->trackingInfoStructFactory->create($trackingCarrier, $trackingCode, $trackingUrl)
         );
 
         $delivery = $this->orderDataExtractor->extractDelivery($order, $context);
@@ -463,21 +474,4 @@ private function findMatchingLineItems(OrderEntity $order, string $itemIdentifie
             return false;
         });
     }
-
-    private function createTrackingInfoStruct(string $trackingCarrier, string $trackingCode, string $trackingUrl): ?ShipmentTrackingInfoStruct
-    {
-        if (empty($trackingCarrier) && empty($trackingCode)) {
-            return null;
-        }
-
-        if (empty($trackingCarrier)) {
-            throw new \InvalidArgumentException('Missing Argument for Tracking Carrier!');
-        }
-
-        if (empty($trackingCode)) {
-            throw new \InvalidArgumentException('Missing Argument for Tracking Code!');
-        }
-
-        return new ShipmentTrackingInfoStruct($trackingCarrier, $trackingCode, $trackingUrl);
-    }
 }

src/Resources/config/services.xml

@@ -178,6 +178,9 @@
             <argument key="$envAppUrl">%env(default::APP_URL)%</argument>
         </service>
 
+        <service id="Kiener\MolliePayments\Service\TrackingInfoStructFactory"/>
+
+
     </services>
 
 </container>

src/Resources/config/services/facades.xml

@@ -13,9 +13,11 @@
             <argument type="service" id="Kiener\MolliePayments\Service\OrderDeliveryService"/>
             <argument type="service" id="Kiener\MolliePayments\Service\OrderService"/>
             <argument type="service" id="Kiener\MolliePayments\Service\MollieApi\OrderDataExtractor"/>
+            <argument type="service" id="Kiener\MolliePayments\Service\TrackingInfoStructFactory"/>
             <argument type="service" id="mollie_payments.logger"/>
         </service>
 
+
         <service id="Kiener\MolliePayments\Facade\MolliePaymentDoPay" public="true">
             <argument type="service" id="Kiener\MolliePayments\Service\MollieApi\OrderDataExtractor"/>
             <argument type="service" id="Kiener\MolliePayments\Service\MollieApi\Builder\MollieOrderBuilder"/>

src/Resources/config/services/subscriber.xml

@@ -21,11 +21,6 @@
             <tag name="kernel.event_subscriber"/>
         </service>
 
-        <service id="Kiener\MolliePayments\Subscriber\ShippingSubscriber">
-            <argument type="service" id="Kiener\MolliePayments\Facade\MollieShipment"/>
-            <argument type="service" id="mollie_payments.logger"/>
-            <tag name="kernel.event_subscriber"/>
-        </service>
 
         <service id="Kiener\MolliePayments\Subscriber\SystemConfigSubscriber">
             <argument type="service" id="Kiener\MolliePayments\Service\SettingsService"/>

src/Service/MollieApi/Order.php

@@ -14,6 +14,7 @@
 use Kiener\MolliePayments\Service\MollieApi\RequestAnonymizer\MollieRequestAnonymizer;
 use Kiener\MolliePayments\Service\Router\RoutingBuilder;
 use Kiener\MolliePayments\Service\SettingsService;
+use Kiener\MolliePayments\Struct\MollieApi\ShipmentTrackingInfoStruct;
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\Order as MollieOrder;
 use Mollie\Api\Resources\OrderLine;
@@ -25,7 +26,9 @@
 use Psr\Log\LoggerInterface;
 use RuntimeException;
 use Shopware\Core\Checkout\Customer\CustomerEntity;
+use Shopware\Core\Checkout\Order\Aggregate\OrderDelivery\OrderDeliveryEntity;
 use Shopware\Core\Checkout\Order\OrderEntity;
+use Shopware\Core\Checkout\Shipping\ShippingMethodEntity;
 use Shopware\Core\System\SalesChannel\SalesChannelContext;
 
 class Order
@@ -391,14 +394,17 @@ public function getPaymentUrl(string $mollieOrderId, string $salesChannelId): ?s
         return $mollieOrder->status === 'created' ? $mollieOrder->getCheckoutUrl() : null;
     }
 
-    public function setShipment(string $mollieOrderId, string $salesChannelId): bool
+    public function setShipment(string $mollieOrderId, ?ShipmentTrackingInfoStruct $trackingInfoStruct, string $salesChannelId): bool
     {
         $mollieOrder = $this->getMollieOrder($mollieOrderId, $salesChannelId);
-
+        $shipment = [];
+        if ($trackingInfoStruct instanceof ShipmentTrackingInfoStruct) {
+            $shipment['tracking'] = $trackingInfoStruct->toArray();
+        }
         /** @var OrderLine $orderLine */
         foreach ($mollieOrder->lines() as $orderLine) {
             if ($orderLine->shippableQuantity > 0) {
-                $mollieOrder->shipAll();
+                $mollieOrder->shipAll($shipment);
 
                 return true;
             }

src/Service/OrderDeliveryService.php

@@ -27,6 +27,7 @@ public function getDelivery(string $orderDeliveryId, Context $context): ?OrderDe
     {
         $criteria = new Criteria([$orderDeliveryId]);
         $criteria->addAssociation('order.transactions.paymentMethod');
+        $criteria->addAssociation('shippingMethod');
         $result = $this->orderDeliveryRepository->search($criteria, $context);
 
         return $result->first();

src/Service/TrackingInfoStructFactory.php

@@ -0,0 +1,86 @@
+<?php
+declare(strict_types=1);
+
+namespace Kiener\MolliePayments\Service;
+
+use Kiener\MolliePayments\Struct\MollieApi\ShipmentTrackingInfoStruct;
+use Shopware\Core\Checkout\Order\Aggregate\OrderDelivery\OrderDeliveryEntity;
+
+class TrackingInfoStructFactory
+{
+    /**
+     * Mollie throws an error with length >= 100
+     */
+    const MAX_TRACKING_CODE_LENGTH = 99;
+
+    public function createFromDelivery(OrderDeliveryEntity $orderDeliveryEntity): ?ShipmentTrackingInfoStruct
+    {
+        $trackingCodes = $orderDeliveryEntity->getTrackingCodes();
+        $shippingMethod = $orderDeliveryEntity->getShippingMethod();
+        if ($shippingMethod === null) {
+            return null;
+        }
+        /**
+         * Currently we create one shipping in mollie for one order. one shipping object can have only one tracking code.
+         * When we have multiple Tracking Codes, we do not know which tracking code we should send to mollie. So we just dont send any tracking information at all
+         *
+         * https://docs.mollie.com/reference/v2/shipments-api/create-shipment
+         */
+        if (count($trackingCodes) !== 1) {
+            return null;
+        }
+
+        return $this->createInfoStruct((string)$shippingMethod->getName(), $trackingCodes[0], (string)$shippingMethod->getTrackingUrl());
+    }
+
+    public function create(string $trackingCarrier, string $trackingCode, string $trackingUrl): ?ShipmentTrackingInfoStruct
+    {
+        return $this->createInfoStruct($trackingCarrier, $trackingCode, $trackingUrl);
+    }
+
+    private function createInfoStruct(string $trackingCarrier, string $trackingCode, string $trackingUrl): ?ShipmentTrackingInfoStruct
+    {
+        if (empty($trackingCarrier) && empty($trackingCode)) {
+            return null;
+        }
+
+        if (empty($trackingCarrier)) {
+            throw new \InvalidArgumentException('Missing Argument for Tracking Carrier!');
+        }
+
+        if (empty($trackingCode)) {
+            throw new \InvalidArgumentException('Missing Argument for Tracking Code!');
+        }
+
+        # we just have to completely remove those codes, so that no tracking happens, but a shipping works.
+        # still, if we find multiple codes (because separators exist), then we use the first one only
+        if (mb_strlen($trackingCode) > self::MAX_TRACKING_CODE_LENGTH) {
+            if (strpos($trackingCode, ',') !== false) {
+                $trackingCode = trim(explode(',', $trackingCode)[0]);
+            } elseif (strpos($trackingCode, ';') !== false) {
+                $trackingCode = trim(explode(';', $trackingCode)[0]);
+            }
+
+            # if we are still too long, then simply remove the code
+            if (mb_strlen($trackingCode) > self::MAX_TRACKING_CODE_LENGTH) {
+                return new ShipmentTrackingInfoStruct($trackingCarrier, '', '');
+            }
+        }
+
+
+        $trackingUrl = trim(sprintf($trackingUrl, $trackingCode));
+
+        if (filter_var($trackingUrl, FILTER_VALIDATE_URL) === false) {
+            $trackingUrl = '';
+        }
+
+        /**
+         * following characters are not allowed in the tracking URL {,},<,>,#
+         */
+        if (preg_match_all('/[{}<>#]/m', $trackingUrl)) {
+            $trackingUrl = '';
+        }
+
+        return new ShipmentTrackingInfoStruct($trackingCarrier, $trackingCode, $trackingUrl);
+    }
+}