Merge pull request #90 from logeecom/master

Release version 3.4.6
packlink-dev · Aug 28, 2024 · 654ccac · 654ccac
2 parents 670725e + 8cdb501
commit 654ccac
Show file tree

Hide file tree

Showing 5 changed files with 104 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
+## [3.4.6](https://github.com/packlink-dev/ecommerce_module_core/compare/v3.4.5...v3.4.6) - 2024-08-28
+### Changed
+- Add detection of expired drafts
+
 ## [3.4.5](https://github.com/packlink-dev/ecommerce_module_core/compare/v3.4.4...v3.4.5) - 2024-07-30
 ### Changed
 - Change BatchTaskCleanupTask to delete tasks in batches

diff --git a/src/BusinessLogic/OrderShipmentDetails/Models/OrderShipmentDetails.php b/src/BusinessLogic/OrderShipmentDetails/Models/OrderShipmentDetails.php
@@ -40,6 +40,7 @@ class OrderShipmentDetails extends Entity
         'deleted',
         'currency',
         'customsInvoiceId',
+        'isExpired',
     );
     /**
      * Shop order ID.
@@ -117,6 +118,10 @@ class OrderShipmentDetails extends Entity
      * @var string
      */
     private $customsInvoiceId = '';
+    /**
+     * @var bool
+     */
+    private $isExpired = false;
 
     /**
      * Returns entity configuration object.
@@ -457,4 +462,20 @@ public function setCustomsInvoiceId($customsInvoiceId)
     {
         $this->customsInvoiceId = $customsInvoiceId;
     }
+
+    /**
+     * @return bool
+     */
+    public function isExpired()
+    {
+        return $this->isExpired;
+    }
+
+    /**
+     * @param bool $isExpired
+     */
+    public function setIsExpired($isExpired)
+    {
+        $this->isExpired = $isExpired;
+    }
 }
diff --git a/src/BusinessLogic/ShipmentDraft/ShipmentDraftService.php b/src/BusinessLogic/ShipmentDraft/ShipmentDraftService.php
@@ -4,12 +4,15 @@
 
 use DateInterval;
 use Logeecom\Infrastructure\Configuration\Configuration;
+use Logeecom\Infrastructure\Logger\Logger;
 use Logeecom\Infrastructure\ORM\RepositoryRegistry;
 use Logeecom\Infrastructure\ServiceRegister;
 use Logeecom\Infrastructure\TaskExecution\QueueItem;
 use Logeecom\Infrastructure\TaskExecution\QueueService;
 use Logeecom\Infrastructure\Utility\TimeProvider;
 use Packlink\BusinessLogic\BaseService;
+use Packlink\BusinessLogic\Http\Proxy;
+use Packlink\BusinessLogic\OrderShipmentDetails\OrderShipmentDetailsService;
 use Packlink\BusinessLogic\Scheduler\Models\HourlySchedule;
 use Packlink\BusinessLogic\Scheduler\Models\Schedule;
 use Packlink\BusinessLogic\ShipmentDraft\Objects\ShipmentDraftStatus;
@@ -115,6 +118,30 @@ public function getDraftStatus($orderId)
         return $status;
     }
 
+    /**
+     * Checks if draft is expired.
+     *
+     * @param string $reference
+     *
+     * @return bool
+     */
+    public function isDraftExpired($reference)
+    {
+        try {
+            $shipment = $this->getProxy()->getShipment($reference);
+
+            if ($shipment) {
+                return false;
+            }
+
+            return true;
+        } catch (\Exception $e) {
+            Logger::logError($e->getMessage());
+
+            return false;
+        }
+    }
+
     /**
      * Enqueues delayed send draft task.
      *
@@ -155,4 +182,14 @@ private function getConfigService()
     {
         return ServiceRegister::getService(Configuration::CLASS_NAME);
     }
+
+    /**
+     * Retrieves proxy.
+     *
+     * @return Proxy | object
+     */
+    private function getProxy()
+    {
+        return ServiceRegister::getService(Proxy::CLASS_NAME);
+    }
 }
diff --git a/src/BusinessLogic/Tasks/SendDraftTask.php b/src/BusinessLogic/Tasks/SendDraftTask.php
@@ -37,7 +37,7 @@ class SendDraftTask extends Task
      *
      * @var string
      */
-    private $orderId;
+    protected $orderId;
     /**
      * Order service instance.
      *
@@ -55,7 +55,7 @@ class SendDraftTask extends Task
      *
      * @var OrderShipmentDetailsService
      */
-    private $orderShipmentDetailsService;
+    protected $orderShipmentDetailsService;
     /**
      * @var CustomsService
      */
@@ -159,8 +159,7 @@ public function execute()
     {
         $this->setExecution();
 
-        $isRepositoryRegistered = RepositoryRegistry::isRegistered(OrderShipmentDetails::getClassName());
-        if ($isRepositoryRegistered && $this->isDraftCreated($this->orderId)) {
+        if ($this->shouldNotSynchronize()) {
             Logger::logInfo("Draft for order [{$this->orderId}] has been already created. Task is terminating.");
             $this->reportProgress(100);
 
@@ -201,6 +200,16 @@ public function execute()
         $this->reportProgress(100);
     }
 
+    /**
+     * @return bool
+     */
+    protected function shouldNotSynchronize()
+    {
+        $isRepositoryRegistered = RepositoryRegistry::isRegistered(OrderShipmentDetails::getClassName());
+
+        return $isRepositoryRegistered && $this->isDraftCreated($this->orderId);
+    }
+
     /**
      * @param Draft $draft
      * @param Order $order
@@ -281,7 +290,7 @@ private function getOrderService()
      *
      * @return OrderShipmentDetailsService Service instance.
      */
-    private function getOrderShipmentDetailsService()
+    protected function getOrderShipmentDetailsService()
     {
         if ($this->orderShipmentDetailsService === null) {
             $this->orderShipmentDetailsService = ServiceRegister::getService(OrderShipmentDetailsService::CLASS_NAME);

diff --git a/tests/BusinessLogic/Order/ShipmentDraftServiceTest.php b/tests/BusinessLogic/Order/ShipmentDraftServiceTest.php
@@ -306,6 +306,34 @@ public function testStatusFailed()
         $this->assertEquals('Attempt 7: Error in task.', $draftStatus->message);
     }
 
+    public function testDraftExpired()
+    {
+        // arrange
+        /** @var TestHttpClient $httpClient */
+        $httpClient = ServiceRegister::getService(HttpClient::CLASS_NAME);
+        $httpClient->setMockResponses(array(new HttpResponse(404, array(), '')));
+
+        // act
+        $result = $this->draftShipmentService->isDraftExpired('PRO202401234567');
+
+        // assert
+        $this->assertTrue($result);
+    }
+
+    public function testDraftNotExpired()
+    {
+        // arrange
+        /** @var TestHttpClient $httpClient */
+        $httpClient = ServiceRegister::getService(HttpClient::CLASS_NAME);
+        $httpClient->setMockResponses(array(new HttpResponse(200, array(), file_get_contents(__DIR__ . '/../Common/ApiResponses/shipment.json'))));
+
+        // act
+        $result = $this->draftShipmentService->isDraftExpired('PRO202401234567');
+
+        // assert
+        $this->assertFalse($result);
+    }
+
     private function getScheduleRepository()
     {
         return RepositoryRegistry::getRepository(Schedule::getClassName());