Merge pull request #3318 from craftcms/bugfix/3253-line-item-snapshot…

…-unpacking

Consistent decoding of line item snapshot

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Product GQL queries now support `promotable`, `availableForPurchase`, `freeShipping`, `defaultSku`, `defaultPrice`, `defaultVariant`, `defaultHeight`, `defaultLength`, `defaultWidth`, and `defaultWeight` params. ([#3307](https://github.com/craftcms/commerce/pull/3307))
 - Fixed a PHP error that occurred when viewing trashed orders. ([#3308](https://github.com/craftcms/commerce/issues/3308))
 - Fixed an incorrect validation error that occurred when saving a Shipping Zone. ([#3317](https://github.com/craftcms/commerce/issues/3317))
+- Fixed a bug where a line item’s snapshot wasn’t being decoded. ([#3253](https://github.com/craftcms/commerce/issues/3253))
 
 ## 4.3.1 - 2023-10-18
 

src/models/LineItem.php

@@ -108,6 +108,7 @@ class LineItem extends Model
 
     /**
      * @var mixed Snapshot
+     * @TODO add get and set methods in 5.0.0. Strict typing will be enforced.
      */
     public mixed $snapshot = null;
 

src/services/LineItems.php

@@ -312,6 +312,11 @@ public function getLineItemById(int $id): ?LineItem
             ->where(['id' => $id])
             ->one();
 
+        if ($result) {
+            // Unpack the snapshot
+            $result['snapshot'] = Json::decodeIfJson($result['snapshot']);
+        }
+
         return $result ? new LineItem($result) : null;
     }
 

tests/unit/services/LineItemsTest.php

@@ -122,6 +122,18 @@ public function testGetLineItemById(): void
         self::assertEquals($lineItems[0]->qty, $lineItem->qty);
     }
 
+    public function testSnapshotUnpacking(): void
+    {
+        /** @var Order $order */
+        $order = $this->fixtureData->getElement('completed-new');
+        $lineItemById = $this->service->getLineItemById($order->getLineItems()[0]->id);
+        $lineItemFromAll = collect($this->service->getAllLineItemsByOrderId($order->id))->firstWhere('id', $lineItemById->id);
+
+        self::assertIsArray($lineItemById->snapshot);
+        self::assertIsArray($lineItemFromAll->snapshot);
+        self::assertEquals($lineItemById->snapshot, $lineItemFromAll->snapshot);
+    }
+
     public function testCreateLineItem(): void
     {
         /** @var Order $order */