feat(sync-actions): adding support for changeAssetOrder in ProductVar…

…iants (#1885)

* feat(sync-actions): adding support for changeAssetOrder in ProductVariants

* test(sync-actions): extend test for changeAssetOrder

---------

Co-authored-by: Markus Azer <[email protected]>

.changeset/tender-wasps-judge.md

@@ -0,0 +1,5 @@
+---
+'@commercetools/sync-actions': minor
+---
+
+Add support for 'changeAssetOrder' in (ProductVariants)[https://docs.commercetools.com/api/projects/products#change-asset-order].

README.md

@@ -188,4 +188,3 @@ We'd love to have your helping hand on this ecosystem! Please see [CONTRIBUTING.
 [personal-data-erasure-icon]: https://img.shields.io/npm/v/@commercetools/personal-data-erasure.svg?style=flat-square
 [personal-data-erasure-dependencies]: https://david-dm.org/commercetools/nodejs?path=packages/personal-data-erasure
 [personal-data-erasure-dependencies-icon]: https://img.shields.io/david/commercetools/nodejs.svg?path=packages/personal-data-erasure&style=flat-square
-

docs/sdk/api/sdkMiddlewareHttp.md

@@ -42,7 +42,7 @@ The HTTP middleware can run in either a browser or Node.js environment. For Node
 13. `fetch` _(Function)_: A `fetch` implementation which can be e.g. `node-fetch` or `unfetch` but also the native browser `fetch` function
 14. `timeout` _(Number)_: Request/response timeout in ms. Must be globally available or passed in `AbortController`
 15. `abortController` or `getAbortController` depending on what you chose to handle the timeout (_abortController_): This property accepts the `AbortController` instance. Could be [abort-controller](https://www.npmjs.com/package/abort-controller) or a globally available one.
-16.  `retryConfig` _(Object)_: Field required in the object listed below
+16. `retryConfig` _(Object)_: Field required in the object listed below
 
 #### Retrying requests
 
@@ -73,12 +73,7 @@ const client = createClient({
         retryDelay: 300, //milliseconds
         maxDelay: 5000, //milliseconds
         retryOnAbort: false,
-        retryCodes: [
-          504,
-          'ETIMEDOUT',
-          'ECONNREFUSED',
-          503
-        ]
+        retryCodes: [504, 'ETIMEDOUT', 'ECONNREFUSED', 503],
       },
 
       // Optional if not globally available

packages/sync-actions/package.json

@@ -43,6 +43,8 @@
     "lodash.isnil": "^4.0.0",
     "lodash.shuffle": "^4.2.0",
     "lodash.sortby": "^4.7.0",
-    "lodash.uniqwith": "^4.5.0"
+    "lodash.uniqwith": "^4.5.0",
+    "lodash.intersection": "^4.4.0",
+    "lodash.without": "^4.4.0"
   }
 }

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

@@ -1,6 +1,8 @@
 /* eslint-disable max-len */
 import forEach from 'lodash.foreach'
 import uniqWith from 'lodash.uniqwith'
+import intersection from 'lodash.intersection'
+import without from 'lodash.without'
 import * as diffpatcher from './utils/diffpatcher'
 import extractMatchingPairs from './utils/extract-matching-pairs'
 import actionsMapCustom from './utils/action-map-custom'
@@ -58,6 +60,9 @@ const getIsUpdateAction = (key, resource) =>
 const getIsRemoveAction = (key, resource) =>
   REGEX_UNDERSCORE_NUMBER.test(key) && Number(resource[2]) === 0
 
+const getIsItemMovedAction = (key, resource) =>
+  REGEX_UNDERSCORE_NUMBER.test(key) && Number(resource[2]) === 3
+
 function _buildSkuActions(variantDiff, oldVariant) {
   if ({}.hasOwnProperty.call(variantDiff, 'sku')) {
     const newValue = diffpatcher.getDeltaValue(variantDiff.sku)
@@ -401,6 +406,30 @@ function toVariantIdentifier(variant) {
   return id ? { variantId: id } : { sku }
 }
 
+function _buildVariantChangeAssetOrderAction(
+  diffAssets,
+  oldVariant,
+  newVariant
+) {
+  const isAssetOrderChanged = Object.entries(diffAssets).find((entry) =>
+    getIsItemMovedAction(entry[0], entry[1])
+  )
+  if (!isAssetOrderChanged) {
+    return []
+  }
+  const assetIdsBefore = oldVariant.assets.map((_) => _.id)
+  const assetIdsCurrent = newVariant.assets
+    .map((_) => _.id)
+    .filter((_) => _ !== undefined)
+  const assetIdsToKeep = intersection(assetIdsCurrent, assetIdsBefore)
+  const assetIdsToRemove = without(assetIdsBefore, ...assetIdsToKeep)
+  const changeAssetOrderAction = {
+    action: 'changeAssetOrder',
+    assetOrder: assetIdsToKeep.concat(assetIdsToRemove),
+    ...toVariantIdentifier(oldVariant),
+  }
+  return [changeAssetOrderAction]
+}
 function _buildVariantAssetsActions(diffAssets, oldVariant, newVariant) {
   const assetActions = []
 
@@ -478,7 +507,12 @@ function _buildVariantAssetsActions(diffAssets, oldVariant, newVariant) {
     }
   })
 
-  return assetActions
+  const changedAssetOrderAction = _buildVariantChangeAssetOrderAction(
+    diffAssets,
+    oldVariant,
+    newVariant
+  )
+  return [...changedAssetOrderAction, ...assetActions]
 }
 
 /**

packages/sync-actions/src/product-types-actions.js

@@ -186,13 +186,14 @@ const generateUpdateActionsForAttributeEnumValues = (
     ...Object.values(
       removedAttributeEnumValues.reduce(
         (nextEnumUpdateActions, removedAttributeEnumValue) => {
-          const removedAttributeEnumValueOfSameAttributeName = nextEnumUpdateActions[
-            removedAttributeEnumValue.hint.attributeName
-          ] || {
-            keys: [],
-            attributeName: removedAttributeEnumValue.hint.attributeName,
-            action: 'removeEnumValues',
-          }
+          const removedAttributeEnumValueOfSameAttributeName =
+            nextEnumUpdateActions[
+              removedAttributeEnumValue.hint.attributeName
+            ] || {
+              keys: [],
+              attributeName: removedAttributeEnumValue.hint.attributeName,
+              action: 'removeEnumValues',
+            }
           return {
             ...nextEnumUpdateActions,
             [removedAttributeEnumValue.hint.attributeName]: {

packages/sync-actions/src/quote-requests-actions.js

@@ -2,7 +2,7 @@ import { buildBaseAttributesActions } from './utils/common-actions'
 
 export const baseActionsList = [
   { action: 'changeQuoteRequestState', key: 'quoteRequestState' },
-  { action: 'transitionState', key: 'state'},
+  { action: 'transitionState', key: 'state' },
 ]
 
 export function actionsMapBase(diff, oldObj, newObj, config = {}) {

packages/sync-actions/src/quote-requests.js

@@ -12,10 +12,7 @@ import actionsMapCustom from './utils/action-map-custom'
 import * as QuoteRequestsActions from './quote-requests-actions'
 import * as diffpatcher from './utils/diffpatcher'
 
-const actionGroups = [
-  'base',
-  'custom',
-]
+const actionGroups = ['base', 'custom']
 
 function createQuoteRequestsMapActions(
   mapActionGroup: Function,
@@ -29,7 +26,7 @@ function createQuoteRequestsMapActions(
   return function doMapActions(
     diff: Object,
     newObj: Object,
-    oldObj: Object,
+    oldObj: Object
   ): Array<UpdateAction> {
     const allActions = []
 
@@ -59,13 +56,13 @@ export default (
   syncActionConfig: SyncActionConfig
 ): SyncAction => {
   const mapActionGroup = createMapActionGroup(actionGroupList)
-  const doMapActions = createQuoteRequestsMapActions(mapActionGroup, syncActionConfig)
-
-  const buildActions = createBuildActions(
-    diffpatcher.diff,
-    doMapActions,
+  const doMapActions = createQuoteRequestsMapActions(
+    mapActionGroup,
+    syncActionConfig
   )
 
+  const buildActions = createBuildActions(diffpatcher.diff, doMapActions)
+
   return { buildActions }
 }
 

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

@@ -3,7 +3,7 @@ import { buildBaseAttributesActions } from './utils/common-actions'
 export const baseActionsList = [
   { action: 'changeQuoteState', key: 'quoteState' },
   { action: 'requestQuoteRenegotiation', key: 'buyerComment' },
-  { action: 'transitionState', key: 'state'},
+  { action: 'transitionState', key: 'state' },
 ]
 
 export function actionsMapBase(diff, oldObj, newObj, config = {}) {

packages/sync-actions/src/quotes.js

@@ -12,10 +12,7 @@ import actionsMapCustom from './utils/action-map-custom'
 import * as QuotesActions from './quotes-actions'
 import * as diffpatcher from './utils/diffpatcher'
 
-const actionGroups = [
-  'base',
-  'custom',
-]
+const actionGroups = ['base', 'custom']
 
 function createQuotesMapActions(
   mapActionGroup: Function,
@@ -29,18 +26,13 @@ function createQuotesMapActions(
   return function doMapActions(
     diff: Object,
     newObj: Object,
-    oldObj: Object,
+    oldObj: Object
   ): Array<UpdateAction> {
     const allActions = []
 
     allActions.push(
       mapActionGroup('base', (): Array<UpdateAction> =>
-        QuotesActions.actionsMapBase(
-          diff,
-          oldObj,
-          newObj,
-          syncActionConfig
-        )
+        QuotesActions.actionsMapBase(diff, oldObj, newObj, syncActionConfig)
       )
     )
 
@@ -61,10 +53,7 @@ export default (
   const mapActionGroup = createMapActionGroup(actionGroupList)
   const doMapActions = createQuotesMapActions(mapActionGroup, syncActionConfig)
 
-  const buildActions = createBuildActions(
-    diffpatcher.diff,
-    doMapActions,
-  )
+  const buildActions = createBuildActions(diffpatcher.diff, doMapActions)
 
   return { buildActions }
 }

packages/sync-actions/src/staged-quotes-actions.js

@@ -3,8 +3,8 @@ import { buildBaseAttributesActions } from './utils/common-actions'
 export const baseActionsList = [
   { action: 'changeStagedQuoteState', key: 'stagedQuoteState' },
   { action: 'setSellerComment', key: 'sellerComment' },
-  { action: 'setValidTo', key: 'validTo'},
-  { action: 'transitionState', key: 'state'},
+  { action: 'setValidTo', key: 'validTo' },
+  { action: 'transitionState', key: 'state' },
 ]
 
 export function actionsMapBase(diff, oldObj, newObj, config = {}) {

packages/sync-actions/src/staged-quotes.js

@@ -12,10 +12,7 @@ import actionsMapCustom from './utils/action-map-custom'
 import * as StagedQuotesActions from './staged-quotes-actions'
 import * as diffpatcher from './utils/diffpatcher'
 
-const actionGroups = [
-  'base',
-  'custom',
-]
+const actionGroups = ['base', 'custom']
 
 function createStagedQuotesMapActions(
   mapActionGroup: Function,
@@ -29,7 +26,7 @@ function createStagedQuotesMapActions(
   return function doMapActions(
     diff: Object,
     newObj: Object,
-    oldObj: Object,
+    oldObj: Object
   ): Array<UpdateAction> {
     const allActions = []
 
@@ -59,13 +56,13 @@ export default (
   syncActionConfig: SyncActionConfig
 ): SyncAction => {
   const mapActionGroup = createMapActionGroup(actionGroupList)
-  const doMapActions = createStagedQuotesMapActions(mapActionGroup, syncActionConfig)
-
-  const buildActions = createBuildActions(
-    diffpatcher.diff,
-    doMapActions,
+  const doMapActions = createStagedQuotesMapActions(
+    mapActionGroup,
+    syncActionConfig
   )
 
+  const buildActions = createBuildActions(diffpatcher.diff, doMapActions)
+
   return { buildActions }
 }
 

packages/sync-actions/test/product-sync-images.spec.js

@@ -198,16 +198,14 @@ describe('Actions', () => {
             assets: [],
             images: [
               {
-                url:
-                  'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/Screen+Shot+2017-04--LOx1OrZZ.png',
+                url: 'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/Screen+Shot+2017-04--LOx1OrZZ.png',
                 dimensions: {
                   w: 1456,
                   h: 1078,
                 },
               },
               {
-                url:
-                  'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/cactus-with-surfboar-BmOeVZEZ.jpg',
+                url: 'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/cactus-with-surfboar-BmOeVZEZ.jpg',
                 label: 'cactus',
                 dimensions: {
                   w: 602,
@@ -245,17 +243,15 @@ describe('Actions', () => {
           sku: '89978FRU',
           images: [
             {
-              url:
-                'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/cactus-with-surfboar-BmOeVZEZ.jpg',
+              url: 'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/cactus-with-surfboar-BmOeVZEZ.jpg',
               label: 'cactus',
               dimensions: {
                 w: 602,
                 h: 600,
               },
             },
             {
-              url:
-                'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/Screen+Shot+2017-04--LOx1OrZZ.png',
+              url: 'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/Screen+Shot+2017-04--LOx1OrZZ.png',
               dimensions: {
                 w: 1456,
                 h: 1078,
@@ -353,16 +349,14 @@ describe('Actions', () => {
             prices: [],
             images: [
               {
-                url:
-                  'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/Screen+Shot+2017-04--LOx1OrZZ.png',
+                url: 'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/Screen+Shot+2017-04--LOx1OrZZ.png',
                 dimensions: {
                   w: 1456,
                   h: 1078,
                 },
               },
               {
-                url:
-                  'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/cactus-with-surfboar-BmOeVZEZ.jpg',
+                url: 'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/cactus-with-surfboar-BmOeVZEZ.jpg',
                 label: 'cactus',
                 dimensions: {
                   w: 602,
@@ -402,8 +396,7 @@ describe('Actions', () => {
           prices: [],
           images: [
             {
-              url:
-                'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/cactus-with-surfboar-BmOeVZEZ.jpg',
+              url: 'https://95bc80c3c245100a18cc-04fc5bec7ec901344d7cbd57f9a2fab3.ssl.cf3.rackcdn.com/cactus-with-surfboar-BmOeVZEZ.jpg',
               label: 'cactus',
               dimensions: {
                 w: 602,