fix: filter out unchanged taxrates from changed list (#1914)

* fix: filter out unchanged taxrates from changed list

* fix: remove typename from subrates as well

* refactor: extract funtion to utils

* Create honest-hats-push.md

* test: unchanged taxrates on actions

.changeset/honest-hats-push.md

@@ -0,0 +1,5 @@
+---
+"@commercetools/sync-actions": patch
+---
+
+fix: filter out unchanged taxrates from changed list

packages/sync-actions/src/tax-categories-actions.js

@@ -1,9 +1,11 @@
+import { deepEqual } from 'fast-equals'
 import { buildBaseAttributesActions } from './utils/common-actions'
 import createBuildArrayActions, {
   ADD_ACTIONS,
   REMOVE_ACTIONS,
   CHANGE_ACTIONS,
 } from './utils/create-build-array-actions'
+import removeTypename from './utils/remove-typename'
 
 export const baseActionsList = [
   { action: 'changeName', key: 'name' },
@@ -31,12 +33,28 @@ export function actionsMapRates(diff, oldObj, newObj) {
       action: 'removeTaxRate',
       taxRateId: objectToRemove.id,
     }),
-    [CHANGE_ACTIONS]: (oldObject, updatedObject) => ({
-      action: 'replaceTaxRate',
-      taxRateId:
-        oldObject.id === updatedObject.id ? oldObject.id : updatedObject.id,
-      taxRate: updatedObject,
-    }),
+    [CHANGE_ACTIONS]: (oldObject, updatedObject) => {
+      // filter out taxRates that were not changed
+      // so the API doesn't return it with a different id
+      // we need to remove __typename from the object to compare them
+      const taxCategoryWithoutTypeName = removeTypename(oldObject)
+      const oldObjectSubRatesWithoutTypename =
+        oldObject.subRates?.map(removeTypename)
+
+      const oldObjectWithoutTypename = {
+        ...taxCategoryWithoutTypeName,
+        subRates: oldObjectSubRatesWithoutTypename,
+      }
+
+      if (deepEqual(oldObjectWithoutTypename, updatedObject)) return null
+
+      return {
+        action: 'replaceTaxRate',
+        taxRateId:
+          oldObject.id === updatedObject.id ? oldObject.id : updatedObject.id,
+        taxRate: updatedObject,
+      }
+    },
   })
 
   return handler(diff, oldObj, newObj)

packages/sync-actions/src/utils/remove-typename.js

@@ -0,0 +1,4 @@
+export default function removeTypename(obj) {
+  const { __typename, ...objWithoutTypename } = obj
+  return objWithoutTypename
+}

packages/sync-actions/test/tax-categories-sync.spec.js

@@ -64,13 +64,20 @@ describe('Actions', () => {
   })
 
   test('should build `replaceTaxRate` action', () => {
+    // unchanged tax rates should not be included in the actions
+    const unchangedTaxRate = {
+      id: 'taxRate-2',
+      name: '1% DE',
+      amount: '0.01',
+    }
     const before = {
       rates: [
         {
           id: 'taxRate-1',
           name: '5% US',
           amount: '0.05',
         },
+        unchangedTaxRate,
       ],
     }
     const now = {
@@ -80,6 +87,7 @@ describe('Actions', () => {
           name: '11% US',
           amount: '0.11',
         },
+        unchangedTaxRate,
       ],
     }