fix(sync-actions): ensure proper address update actions order (#1971)

* fix(sync-actions): ensure proper address update actions order

Author: emuzych

.changeset/early-loops-stay.md

@@ -0,0 +1,5 @@
+---
+'@commercetools/sync-actions': patch
+---
+
+ensure proper order of address update actions

packages/sync-actions/src/business-units.js

@@ -22,6 +22,18 @@ const createCustomerMapActions = (mapActionGroup, syncActionConfig) => {
       )
     )
 
+    allActions.push(
+      mapActionGroup('billingAddressIds', () =>
+        customerActions.actionsMapRemoveBillingAddresses(diff, oldObj, newObj)
+      )
+    )
+
+    allActions.push(
+      mapActionGroup('shippingAddressIds', () =>
+        customerActions.actionsMapRemoveShippingAddresses(diff, oldObj, newObj)
+      )
+    )
+
     allActions.push(
       mapActionGroup('addresses', () =>
         customerActions.actionsMapAddresses(diff, oldObj, newObj)
@@ -41,13 +53,13 @@ const createCustomerMapActions = (mapActionGroup, syncActionConfig) => {
 
     allActions.push(
       mapActionGroup('billingAddressIds', () =>
-        customerActions.actionsMapBillingAddresses(diff, oldObj, newObj)
+        customerActions.actionsMapAddBillingAddresses(diff, oldObj, newObj)
       )
     )
 
     allActions.push(
       mapActionGroup('shippingAddressIds', () =>
-        customerActions.actionsMapShippingAddresses(diff, oldObj, newObj)
+        customerActions.actionsMapAddShippingAddresses(diff, oldObj, newObj)
       )
     )
 

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

@@ -118,12 +118,19 @@ export function actionsMapAddresses(diff, oldObj, newObj) {
   return handler(diff, oldObj, newObj)
 }
 
-export function actionsMapBillingAddresses(diff, oldObj, newObj) {
+export function actionsMapAddBillingAddresses(diff, oldObj, newObj) {
   const handler = createBuildArrayActions('billingAddressIds', {
     [ADD_ACTIONS]: (addressId) => ({
       action: 'addBillingAddressId',
       addressId,
     }),
+  })
+
+  return handler(diff, oldObj, newObj)
+}
+
+export function actionsMapRemoveBillingAddresses(diff, oldObj, newObj) {
+  const handler = createBuildArrayActions('billingAddressIds', {
     [REMOVE_ACTIONS]: (addressId) => ({
       action: 'removeBillingAddressId',
       addressId,
@@ -133,12 +140,19 @@ export function actionsMapBillingAddresses(diff, oldObj, newObj) {
   return handler(diff, oldObj, newObj)
 }
 
-export function actionsMapShippingAddresses(diff, oldObj, newObj) {
+export function actionsMapAddShippingAddresses(diff, oldObj, newObj) {
   const handler = createBuildArrayActions('shippingAddressIds', {
     [ADD_ACTIONS]: (addressId) => ({
       action: 'addShippingAddressId',
       addressId,
     }),
+  })
+
+  return handler(diff, oldObj, newObj)
+}
+
+export function actionsMapRemoveShippingAddresses(diff, oldObj, newObj) {
+  const handler = createBuildArrayActions('shippingAddressIds', {
     [REMOVE_ACTIONS]: (addressId) => ({
       action: 'removeShippingAddressId',
       addressId,

packages/sync-actions/src/customers.js

@@ -44,6 +44,18 @@ function createCustomerMapActions(
       )
     )
 
+    allActions.push(
+      mapActionGroup('billingAddressIds', (): Array<UpdateAction> =>
+        customerActions.actionsMapRemoveBillingAddresses(diff, oldObj, newObj)
+      )
+    )
+
+    allActions.push(
+      mapActionGroup('shippingAddressIds', (): Array<UpdateAction> =>
+        customerActions.actionsMapRemoveShippingAddresses(diff, oldObj, newObj)
+      )
+    )
+
     allActions.push(
       mapActionGroup('addresses', (): Array<UpdateAction> =>
         customerActions.actionsMapAddresses(diff, oldObj, newObj)
@@ -63,13 +75,13 @@ function createCustomerMapActions(
 
     allActions.push(
       mapActionGroup('billingAddressIds', (): Array<UpdateAction> =>
-        customerActions.actionsMapBillingAddresses(diff, oldObj, newObj)
+        customerActions.actionsMapAddBillingAddresses(diff, oldObj, newObj)
       )
     )
 
     allActions.push(
       mapActionGroup('shippingAddressIds', (): Array<UpdateAction> =>
-        customerActions.actionsMapShippingAddresses(diff, oldObj, newObj)
+        customerActions.actionsMapAddShippingAddresses(diff, oldObj, newObj)
       )
     )
 

packages/sync-actions/test/business-units-sync.spec.js

@@ -710,4 +710,42 @@ describe('Actions', () => {
     ]
     expect(actual).toEqual(expected)
   })
+
+  test('should build actions for addresses in proper order', () => {
+    const before = {
+      addresses: [{ id: 'abc123' }, { id: 'abc456' }],
+      billingAddressIds: ['abc123', 'abc456'],
+      defaultBillingAddress: 'abc123',
+    }
+    const now = {
+      addresses: [{ id: 'xyz123' }, { id: 'abc456' }],
+      billingAddressIds: ['xyz123', 'abc456'],
+      defaultBillingAddressId: 'xyz123',
+    }
+    expect(businessUnitsSync.buildActions(now, before)).toStrictEqual([
+      // removeBillingAddressId action should be before removeAddress
+      {
+        action: 'removeBillingAddressId',
+        addressId: 'abc123',
+      },
+      {
+        action: 'removeAddress',
+        addressId: 'abc123',
+      },
+      {
+        action: 'addAddress',
+        address: {
+          id: 'xyz123',
+        },
+      },
+      {
+        action: 'setDefaultBillingAddress',
+        addressId: 'xyz123',
+      },
+      {
+        action: 'addBillingAddressId',
+        addressId: 'xyz123',
+      },
+    ])
+  })
 })

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

@@ -643,4 +643,42 @@ describe('Actions', () => {
       customerSync.buildActions(now, before)
     }).toThrow('Invalid Authentication Mode')
   })
+
+  test('should build actions for addresses in proper order', () => {
+    const before = {
+      addresses: [{ id: 'abc123' }, { id: 'abc456' }],
+      billingAddressIds: ['abc123', 'abc456'],
+      defaultBillingAddress: 'abc123',
+    }
+    const now = {
+      addresses: [{ id: 'xyz123' }, { id: 'abc456' }],
+      billingAddressIds: ['xyz123', 'abc456'],
+      defaultBillingAddressId: 'xyz123',
+    }
+    expect(customerSync.buildActions(now, before)).toStrictEqual([
+      // removeBillingAddressId action should be before removeAddress
+      {
+        action: 'removeBillingAddressId',
+        addressId: 'abc123',
+      },
+      {
+        action: 'removeAddress',
+        addressId: 'abc123',
+      },
+      {
+        action: 'addAddress',
+        address: {
+          id: 'xyz123',
+        },
+      },
+      {
+        action: 'setDefaultBillingAddress',
+        addressId: 'xyz123',
+      },
+      {
+        action: 'addBillingAddressId',
+        addressId: 'xyz123',
+      },
+    ])
+  })
 })