AC-8998::Adobe Commerce Admin REST endpoint "orders/{id}/comments" is changing the status of the order when adding comment to the status

Author: Banvari Lal

app/code/Magento/Sales/Model/Service/OrderService.php

@@ -160,10 +160,21 @@ public function getCommentsList($id)
      * @param int $id
      * @param \Magento\Sales\Api\Data\OrderStatusHistoryInterface $statusHistory
      * @return bool
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function addComment($id, \Magento\Sales\Api\Data\OrderStatusHistoryInterface $statusHistory)
     {
         $order = $this->orderRepository->get($id);
+
+        /**
+         * change order status is not allowed during add comment to the order
+         */
+        if ($statusHistory->getStatus() && $statusHistory->getStatus() != $order->getStatus()) {
+            throw new \Magento\Framework\Exception\LocalizedException(
+                __('Unable to add comment: The status "%1" is not part of the order
+                 status history.', $statusHistory->getStatus())
+            );
+        }
         $order->addStatusHistory($statusHistory);
         $this->orderRepository->save($order);
         $notify = $statusHistory['is_customer_notified'] ?? false;

app/code/Magento/Sales/Test/Unit/Model/Service/OrderServiceTest.php

@@ -28,6 +28,8 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
+use Magento\Framework\Phrase;
+use Magento\Framework\Exception\LocalizedException;
 
 /**
  *
@@ -295,6 +297,22 @@ public function testAddComment()
         $this->assertTrue($this->orderService->addComment(123, $this->orderStatusHistoryMock));
     }
 
+    /**
+     * test for add comment with order status change case
+     */
+    public function testAddCommentWithStatus()
+    {
+        $params = ['status' => 'holded'];
+        $inputException = new LocalizedException(
+            new Phrase('Unable to add comment: The status "%1" is not part of the order
+            status history.', $params)
+        );
+        $this->orderStatusHistoryMock->method('getStatus')
+            ->willThrowException($inputException);
+        $this->expectException(LocalizedException::class);
+        $this->orderService->addComment(123, $this->orderStatusHistoryMock);
+    }
+
     public function testNotify()
     {
         $this->orderRepositoryMock->expects($this->once())