Issue #3000882 by zaporylie, Adameue, bojanz: Newly added order item is not aggregated with existing order item if has an empty field

Author: zaporylie

modules/cart/src/OrderItemMatcher.php

@@ -68,12 +68,20 @@ public function matchAll(OrderItemInterface $order_item, array $order_items) {
     $matched_order_items = [];
     /** @var \Drupal\commerce_order\Entity\OrderItemInterface $existing_order_item */
     foreach ($order_items as $existing_order_item) {
-      foreach ($comparison_fields as $comparison_field) {
-        if (!$existing_order_item->hasField($comparison_field) || !$order_item->hasField($comparison_field)) {
+      foreach ($comparison_fields as $field_name) {
+        if (!$existing_order_item->hasField($field_name) || !$order_item->hasField($field_name)) {
           // The field is missing on one of the order items.
           continue 2;
         }
-        if (!$existing_order_item->get($comparison_field)->equals($order_item->get($comparison_field))) {
+
+        $existing_order_item_field = $existing_order_item->get($field_name);
+        $order_item_field = $order_item->get($field_name);
+        // Two empty fields should be considered identical, but an empty item
+        // can affect the comparison and cause a false mismatch.
+        $existing_order_item_field = $existing_order_item_field->filterEmptyItems();
+        $order_item_field = $order_item_field->filterEmptyItems();
+
+        if (!$existing_order_item_field->equals($order_item_field)) {
           // Order item doesn't match.
           continue 2;
         }

modules/cart/tests/src/Kernel/OrderItemMatcherTest.php

@@ -226,6 +226,14 @@ public function testCustomField() {
       'field_custom_text' => 'Blue',
     ]);
     $order_item3->save();
+    $order_item4 = OrderItem::create([
+      'type' => 'default',
+      'quantity' => 4,
+      'unit_price' => new Price('12.00', 'USD'),
+      'purchased_entity' => $this->variation1,
+      'field_custom_text' => '',
+    ]);
+    $order_item4->save();
 
     // Same purchased entity, different custom text, no match.
     $matches = $this->orderItemMatcher->matchAll($order_item1, [$order_item2]);
@@ -239,21 +247,31 @@ public function testCustomField() {
     $this->assertNotEmpty($match);
     $this->assertEquals($match, $order_item3);
 
-    // Item with missing custom text does not match.
-    $order_item4 = OrderItem::create([
+    // Item with missing custom text, no match.
+    $order_item5 = OrderItem::create([
       'type' => 'default',
       'quantity' => 5,
       'unit_price' => new Price('12.00', 'USD'),
       'purchased_entity' => $this->variation1,
     ]);
-    $order_item4->save();
-
-    $matches = $this->orderItemMatcher->matchAll($order_item4, [
+    $matches = $this->orderItemMatcher->matchAll($order_item5, [
       $order_item1,
       $order_item2,
       $order_item3,
     ]);
     $this->assertEmpty($matches);
+
+    // Empty custom text on both sides, match.
+    $order_item6 = OrderItem::create([
+      'type' => 'default',
+      'quantity' => 5,
+      'unit_price' => new Price('12.00', 'USD'),
+      'purchased_entity' => $this->variation1,
+      'field_custom_text' => '',
+    ]);
+    $match = $this->orderItemMatcher->match($order_item6, [$order_item4]);
+    $this->assertNotEmpty($match);
+    $this->assertEquals($match, $order_item4);
   }
 
 }