[TASK] Add Logging for updating payment and shipping

Relates: #752

Author: extcode

Classes/Controller/Backend/Order/PaymentController.php

@@ -12,22 +12,35 @@
  */
 
 use Extcode\Cart\Controller\Backend\ActionController;
+use Extcode\Cart\Domain\Log\LogServiceInterface;
+use Extcode\Cart\Domain\Log\Model\Log;
 use Extcode\Cart\Domain\Model\Order\Payment;
 use Extcode\Cart\Domain\Repository\Order\PaymentRepository;
 use Extcode\Cart\Event\Order\UpdateServiceEvent;
+use InvalidArgumentException;
 use Psr\Http\Message\ResponseInterface;
 use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 
 class PaymentController extends ActionController
 {
     public function __construct(
-        protected PaymentRepository $paymentRepository
+        private readonly PaymentRepository $paymentRepository,
+        private readonly LogServiceInterface $logService,
     ) {}
 
     public function updateAction(Payment $payment): ResponseInterface
     {
-        // todo: add logging here
         $this->paymentRepository->update($payment);
+        $this->logService->write(
+            Log::info(
+                $this->getOrderItemUid($payment),
+                'updatePayment',
+                'Payment was set to ' . $payment->getStatus() . '.',
+                [
+                    'time' => time(),
+                ]
+            )
+        );
 
         $event = new UpdateServiceEvent($payment);
         $this->eventDispatcher->dispatch($event);
@@ -41,4 +54,15 @@ public function updateAction(Payment $payment): ResponseInterface
 
         return $this->redirect('show', 'Backend\Order\Order', null, ['orderItem' => $payment->getItem()]);
     }
+
+    private function getOrderItemUid(Payment $payment): int
+    {
+        $orderItemUid = $payment->getItem()?->getUid();
+
+        if (is_null($orderItemUid)) {
+            throw new InvalidArgumentException('Method should only called for persisted orders.', 1774715307);
+        }
+
+        return $orderItemUid;
+    }
 }

Classes/Controller/Backend/Order/ShippingController.php

@@ -12,22 +12,35 @@
  */
 
 use Extcode\Cart\Controller\Backend\ActionController;
+use Extcode\Cart\Domain\Log\LogServiceInterface;
+use Extcode\Cart\Domain\Log\Model\Log;
 use Extcode\Cart\Domain\Model\Order\Shipping;
 use Extcode\Cart\Domain\Repository\Order\ShippingRepository;
 use Extcode\Cart\Event\Order\UpdateServiceEvent;
+use InvalidArgumentException;
 use Psr\Http\Message\ResponseInterface;
 use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 
 class ShippingController extends ActionController
 {
     public function __construct(
-        protected ShippingRepository $shippingRepository
+        private readonly ShippingRepository $shippingRepository,
+        private readonly LogServiceInterface $logService,
     ) {}
 
     public function updateAction(Shipping $shipping): ResponseInterface
     {
-        // todo: add logging here
         $this->shippingRepository->update($shipping);
+        $this->logService->write(
+            Log::info(
+                $this->getOrderItemUid($shipping),
+                'updateShipping',
+                'Shipping was set to ' . $shipping->getStatus() . '.',
+                [
+                    'time' => time(),
+                ]
+            )
+        );
 
         $event = new UpdateServiceEvent($shipping);
         $this->eventDispatcher->dispatch($event);
@@ -41,4 +54,15 @@ public function updateAction(Shipping $shipping): ResponseInterface
 
         return $this->redirect('show', 'Backend\Order\Order', null, ['orderItem' => $shipping->getItem()]);
     }
+
+    private function getOrderItemUid(Shipping $shipping): int
+    {
+        $orderItemUid = $shipping->getItem()?->getUid();
+
+        if (is_null($orderItemUid)) {
+            throw new InvalidArgumentException('Method should only called for persisted orders.', 1774715307);
+        }
+
+        return $orderItemUid;
+    }
 }