fix(sync-actions/orders): adjust diff calculation of returnInfo items (#1818)

* test(sync-actions/orders): add test to reproduce bug

* fix(sync-actions/orders): adjust diff calculation of returnInfo items

* docs(release): add changeset

* refactor(sync-actions): apply pr reviews

* fix(test): increase performance time test

* fix(test): coverage

Author: qmateub

.changeset/flat-phones-explain.md

@@ -0,0 +1,5 @@
+---
+'@commercetools/sync-actions': patch
+---
+
+fix(sync-actions/orders): adjust diff calculation of returnInfo items

packages/sync-actions/src/order-actions.js

@@ -146,42 +146,29 @@ export function actionsMapReturnsInfo(diff, oldObj, newObj) {
       }
       return []
     },
-    [CHANGE_ACTIONS]: (oldSReturnInfo, newReturnInfo) => {
-      const updateActions = Object.keys(returnInfoDiff).reduce(
-        (itemActions, key) => {
-          const { items = {} } = returnInfoDiff[key]
-          if (Object.keys(items).length > 0) {
-            return [
-              ...itemActions,
-              ...Object.keys(items).reduce((actions, index) => {
-                const itActions = []
-                const item = newReturnInfo.items[index]
-                if (items[index].shipmentState) {
-                  itActions.push({
-                    action: 'setReturnShipmentState',
-                    returnItemId: item.id,
-                    shipmentState: item.shipmentState,
-                  })
-                }
-                if (items[index].paymentState) {
-                  itActions.push({
-                    action: 'setReturnPaymentState',
-                    returnItemId: item.id,
-                    paymentState: item.paymentState,
-                  })
-                }
-
-                return [...actions, ...itActions]
-              }, []),
-            ]
-          }
-
-          return itemActions
-        },
-        []
-      )
-
-      return updateActions
+    [CHANGE_ACTIONS]: (oldSReturnInfo, newReturnInfo, key) => {
+      const { items = {} } = returnInfoDiff[key]
+      if (Object.keys(items).length === 0) {
+        return []
+      }
+      return Object.keys(items).reduce((actions, index) => {
+        const item = newReturnInfo.items[index]
+        if (items[index].shipmentState) {
+          actions.push({
+            action: 'setReturnShipmentState',
+            returnItemId: item.id,
+            shipmentState: item.shipmentState,
+          })
+        }
+        if (items[index].paymentState) {
+          actions.push({
+            action: 'setReturnPaymentState',
+            returnItemId: item.id,
+            paymentState: item.paymentState,
+          })
+        }
+        return actions
+      }, [])
     },
   })
 

packages/sync-actions/test/order-sync.spec.js

@@ -1,3 +1,4 @@
+import { performance } from 'perf_hooks'
 import orderSyncFn, { actionGroups } from '../src/orders'
 import { baseActionsList } from '../src/order-actions'
 
@@ -546,6 +547,155 @@ describe('Actions', () => {
       ]
       expect(actual).toEqual(expected)
     })
+    describe('when all items have changed its `paymentState`', () => {
+      test('should build `returnInfoPaymentState` action', () => {
+        const before = {
+          returnInfo: [
+            {
+              items: [
+                {
+                  id: 'id1',
+                  shipmentState: 'Returned',
+                  paymentState: 'Initial',
+                },
+              ],
+            },
+            {
+              items: [
+                {
+                  id: 'id2',
+                  shipmentState: 'Returned',
+                  paymentState: 'Initial',
+                },
+                {
+                  id: 'id3',
+                  shipmentState: 'Returned',
+                  paymentState: 'Initial',
+                },
+                {
+                  id: 'id4',
+                  shipmentState: 'Returned',
+                  paymentState: 'Initial',
+                },
+                {
+                  id: 'id5',
+                  shipmentState: 'Returned',
+                  paymentState: 'Initial',
+                },
+              ],
+              returnDate: '2022-10-24T00:00:00.000Z',
+            },
+          ],
+        }
+        const now = {
+          returnInfo: [
+            {
+              items: [
+                {
+                  id: 'id1',
+                  shipmentState: 'Returned',
+                  paymentState: 'NotRefunded',
+                },
+              ],
+            },
+            {
+              items: [
+                {
+                  id: 'id2',
+                  shipmentState: 'Returned',
+                  paymentState: 'Refunded',
+                },
+                {
+                  id: 'id3',
+                  shipmentState: 'Returned',
+                  paymentState: 'Refunded',
+                },
+                {
+                  id: 'id4',
+                  shipmentState: 'Returned',
+                  paymentState: 'Refunded',
+                },
+                {
+                  id: 'id5',
+                  shipmentState: 'Returned',
+                  paymentState: 'Refunded',
+                },
+              ],
+              returnDate: '2022-10-24T00:00:00.000Z',
+            },
+          ],
+        }
+        const actual = orderSync.buildActions(now, before)
+        const expected = [
+          {
+            action: 'setReturnPaymentState',
+            returnItemId: now.returnInfo[0].items[0].id,
+            paymentState: now.returnInfo[0].items[0].paymentState,
+          },
+          {
+            action: 'setReturnPaymentState',
+            returnItemId: now.returnInfo[1].items[0].id,
+            paymentState: now.returnInfo[1].items[0].paymentState,
+          },
+          {
+            action: 'setReturnPaymentState',
+            returnItemId: now.returnInfo[1].items[1].id,
+            paymentState: now.returnInfo[1].items[1].paymentState,
+          },
+          {
+            action: 'setReturnPaymentState',
+            returnItemId: now.returnInfo[1].items[2].id,
+            paymentState: now.returnInfo[1].items[2].paymentState,
+          },
+          {
+            action: 'setReturnPaymentState',
+            returnItemId: now.returnInfo[1].items[3].id,
+            paymentState: now.returnInfo[1].items[3].paymentState,
+          },
+        ]
+        expect(actual).toEqual(expected)
+      })
+      describe('performance test', () => {
+        it('should be performant for large arrays', () => {
+          const before = {
+            returnInfo: Array(100)
+              .fill(null)
+              .map((a, index) => ({
+                items: Array(50)
+                  .fill(null)
+                  .map((b, index2) => {
+                    return {
+                      id: `id-${index}-${index2}`,
+                      shipmentState: 'Returned',
+                      paymentState: 'Initial',
+                    }
+                  }),
+              })),
+          }
+          const now = {
+            returnInfo: Array(100)
+              .fill(null)
+              .map((a, index) => ({
+                items: Array(50)
+                  .fill(null)
+                  .map((b, index2) => {
+                    return {
+                      id: `id-${index}-${index2}`,
+                      shipmentState: 'Returned',
+                      paymentState: 'Refunded',
+                    }
+                  }),
+              })),
+          }
+
+          const start = performance.now()
+          orderSync.buildActions(now, before)
+          const end = performance.now()
+
+          expect(end - start).toBeLessThan(400)
+        })
+      })
+    })
   })
 })