refactor(sync-actions): rename terminology to allow/ignore (#1601)

emmenko · web-flow · commit 9999af122e06 · 2020-08-21T20:11:07.000+02:00
diff --git a/README.md b/README.md
@@ -32,8 +32,8 @@ If you have any urgent issues regarding this repository please create a support
 We'd love to have your helping hand on this ecosystem! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on our guidelines.
 
 ## Packages
-:warning: **Typescript SDK** is moved to a new [`repository`](https://github.com/commercetools/commercetools-typescript-sdks) now, this package will be deleted soon from the current repository.
 
+:warning: **Typescript SDK** is moved to a new [`repository`](https://github.com/commercetools/commercetools-typescript-sdks) now, this package will be deleted soon from the current repository.
 
 ### SDK
 
diff --git a/docs/sdk/Glossary.md b/docs/sdk/Glossary.md
@@ -109,6 +109,6 @@ type SyncAction = {
 
 type ActionGroup = {
   type: string,
-  group: 'black' | 'white',
+  group: 'ignore' | 'allow',
 }
 ```
diff --git a/docs/sdk/api/syncActions.md b/docs/sdk/api/syncActions.md
@@ -25,7 +25,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -63,7 +63,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -102,7 +102,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -140,7 +140,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -178,7 +178,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -216,7 +216,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -254,7 +254,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -292,7 +292,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -332,7 +332,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -370,7 +370,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -408,7 +408,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -446,7 +446,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 2.  `config` _(Object)_: A configuration object to which has one of the following options:
 
 | Key                     | Type      | Required             | Description                                                                                                            |
@@ -599,7 +599,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -638,7 +638,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -677,7 +677,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -718,7 +718,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 2.  `config` _(Object)_: A configuration object to which has one of the following options:
 
 | Key                     | Type      | Required             | Description                                                                                                            |
@@ -768,7 +768,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
@@ -847,7 +847,7 @@ Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API up
 
 #### Arguments
 
-1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _blacklisted_ or _whitelisted_.
+1.  `actionGroups` _(Array)_: A list of [action group](/sdk/Glossary.md#syncaction) in case some actions need to be _ignored_ or _allowed_.
 
 #### Usage example
 
diff --git a/packages/sync-actions/src/categories.js b/packages/sync-actions/src/categories.js
@@ -66,16 +66,16 @@ export default (
   syncActionConfig: SyncActionConfig
 ): SyncAction => {
   // actionGroupList contains information about which action groups
-  // are white/black listed
+  // are allowed or ignored
 
   // createMapActionGroup returns function 'mapActionGroup' that takes params:
   // - action group name
   // - callback function that should return a list of actions that correspond
   //    to the for the action group
 
   // this resulting function mapActionGroup will call the callback function
-  // for whitelisted action groups and return the return value of the callback
-  // It will return an empty array for blacklisted action groups
+  // for allowed action groups and return the return value of the callback
+  // It will return an empty array for ignored action groups
   const mapActionGroup = createMapActionGroup(actionGroupList)
   const doMapActions = createCategoryMapActions(
     mapActionGroup,
diff --git a/packages/sync-actions/src/customers.js b/packages/sync-actions/src/customers.js
@@ -70,16 +70,16 @@ export default (
   syncActionConfig: SyncActionConfig
 ): SyncAction => {
   // actionGroupList contains information about which action groups
-  // are white/black listed
+  // are allowed or ignored
 
   // createMapActionGroup returns function 'mapActionGroup' that takes params:
   // - action group name
   // - callback function that should return a list of actions that correspond
   //    to the for the action group
 
   // this resulting function mapActionGroup will call the callback function
-  // for whitelisted action groups and return the return value of the callback
-  // It will return an empty array for blacklisted action groups
+  // for allowed action groups and return the return value of the callback
+  // It will return an empty array for ignored action groups
   const mapActionGroup = createMapActionGroup(actionGroupList)
   const doMapActions = createCustomerMapActions(
     mapActionGroup,
diff --git a/packages/sync-actions/src/discount-codes.js b/packages/sync-actions/src/discount-codes.js
@@ -25,16 +25,16 @@ function createDiscountCodesMapActions(mapActionGroup, syncActionConfig) {
 
 export default (actionGroupList, syncActionConfig = {}) => {
   // actionGroupList contains information about which action groups
-  // are white/black listed
+  // are allowed or ignored
 
   // createMapActionGroup returns function 'mapActionGroup' that takes params:
   // - action group name
   // - callback function that should return a list of actions that correspond
   //    to the for the action group
 
   // this resulting function mapActionGroup will call the callback function
-  // for whitelisted action groups and return the return value of the callback
-  // It will return an empty array for blacklisted action groups
+  // for allowed action groups and return the return value of the callback
+  // It will return an empty array for ignored action groups
   const mapActionGroup = createMapActionGroup(actionGroupList)
   const doMapActions = createDiscountCodesMapActions(
     mapActionGroup,
diff --git a/packages/sync-actions/src/inventories.js b/packages/sync-actions/src/inventories.js
@@ -48,16 +48,16 @@ export default (
   syncActionConfig: SyncActionConfig
 ): SyncAction => {
   // actionGroupList contains information about which action groups
-  // are white/black listed
+  // are allowed or ignored
 
   // createMapActionGroup returns function 'mapActionGroup' that takes params:
   // - action group name
   // - callback function that should return a list of actions that correspond
   //    to the for the action group
 
   // this resulting function mapActionGroup will call the callback function
-  // for whitelisted action groups and return the return value of the callback
-  // It will return an empty array for blacklisted action groups
+  // for allowed action groups and return the return value of the callback
+  // It will return an empty array for ignored action groups
   const mapActionGroup = createMapActionGroup(actionGroupList)
   const doMapActions = createInventoryMapActions(
     mapActionGroup,
diff --git a/packages/sync-actions/src/orders.js b/packages/sync-actions/src/orders.js
@@ -58,16 +58,16 @@ export default (
   syncActionConfig: SyncActionConfig
 ): SyncAction => {
   // actionGroupList contains information about which action groups
-  // are white/black listed
+  // are allowed or ignored
 
   // createMapActionGroup returns function 'mapActionGroup' that takes params:
   // - action group name
   // - callback function that should return a list of actions that correspond
   //    to the for the action group
 
   // this resulting function mapActionGroup will call the callback function
-  // for whitelisted action groups and return the return value of the callback
-  // It will return an empty array for blacklisted action groups
+  // for allowed action groups and return the return value of the callback
+  // It will return an empty array for ignored action groups
   const mapActionGroup = createMapActionGroup(actionGroupList)
   const doMapActions = createOrderMapActions(mapActionGroup, syncActionConfig)
   const buildActions = createBuildActions(diffpatcher.diff, doMapActions)
diff --git a/packages/sync-actions/src/shipping-methods.js b/packages/sync-actions/src/shipping-methods.js
@@ -49,16 +49,16 @@ export default (
   syncActionConfig: SyncActionConfig
 ): SyncAction => {
   // actionGroupList contains information about which action groups
-  // are white/black listed
+  // are allowed or ignored
 
   // createMapActionGroup returns function 'mapActionGroup' that takes params:
   // - action group name
   // - callback function that should return a list of actions that correspond
   //    to the for the action group
 
   // this resulting function mapActionGroup will call the callback function
-  // for whitelisted action groups and return the return value of the callback
-  // It will return an empty array for blacklisted action groups
+  // for allowed action groups and return the return value of the callback
+  // It will return an empty array for ignored action groups
   const mapActionGroup = createMapActionGroup(actionGroupList)
   const doMapActions = createShippingMethodsMapActions(
     mapActionGroup,
diff --git a/packages/sync-actions/src/tax-categories.js b/packages/sync-actions/src/tax-categories.js
@@ -50,16 +50,16 @@ export default (
   syncActionConfig: SyncActionConfig
 ): SyncAction => {
   // config contains information about which action groups
-  // are white/black listed
+  // are allowed or ignored
 
   // createMapActionGroup returns function 'mapActionGroup' that takes params:
   // - action group name
   // - callback function that should return a list of actions that correspond
   //    to the for the action group
 
   // this resulting function mapActionGroup will call the callback function
-  // for whitelisted action groups and return the return value of the callback
-  // It will return an empty array for blacklisted action groups
+  // for allowed action groups and return the return value of the callback
+  // It will return an empty array for ignored action groups
   const mapActionGroup = createMapActionGroup(actionGroupList)
   const doMapActions = createTaxCategoriesMapActions(
     mapActionGroup,
diff --git a/packages/sync-actions/src/utils/create-map-action-group.js b/packages/sync-actions/src/utils/create-map-action-group.js
@@ -1,9 +1,9 @@
-// Array of action groups which need to be whitelisted or blacklisted.
+// Array of action groups which need to be allowed or ignored.
 // Example:
 // [
-//   { type: 'base', group: 'black' },
-//   { type: 'prices', group: 'white' },
-//   { type: 'variants', group: 'black' },
+//   { type: 'base', group: 'ignore' },
+//   { type: 'prices', group: 'allow' },
+//   { type: 'variants', group: 'ignore' },
 // ]
 export default function createMapActionGroup(actionGroups = []) {
   return function mapActionGroup(type, fn) {
@@ -12,11 +12,13 @@ export default function createMapActionGroup(actionGroups = []) {
     const found = actionGroups.find((c) => c.type === type)
     if (!found) return []
 
-    if (found.group === 'black') return []
-    if (found.group === 'white') return fn()
+    // Keep `black` for backwards compatibility.
+    if (found.group === 'ignore' || found.group === 'black') return []
+    // Keep `white` for backwards compatibility.
+    if (found.group === 'allow' || found.group === 'white') return fn()
 
     throw new Error(
-      `Action group '${found.group}' not supported. Please use black or white.`
+      `Action group '${found.group}' not supported. Use either "allow" or "ignore".`
     )
   }
 }
diff --git a/packages/sync-actions/src/zones.js b/packages/sync-actions/src/zones.js
@@ -47,16 +47,16 @@ export default (
   syncActionConfig: SyncActionConfig
 ): SyncAction => {
   // config contains information about which action groups
-  // are white/black listed
+  // are allowed or ignored
 
   // createMapActionGroup returns function 'mapActionGroup' that takes params:
   // - action group name
   // - callback function that should return a list of actions that correspond
   //    to the for the action group
 
   // this resulting function mapActionGroup will call the callback function
-  // for whitelisted action groups and return the return value of the callback
-  // It will return an empty array for blacklisted action groups
+  // for allowed action groups and return the return value of the callback
+  // It will return an empty array for ignored action groups
   const mapActionGroup = createMapActionGroup(actionGroupList)
   const doMapActions = createZonesMapActions(mapActionGroup, syncActionConfig)
   const buildActions = createBuildActions(diffpatcher.diff, doMapActions)
diff --git a/packages/sync-actions/test/utils/create-map-action-group.spec.js b/packages/sync-actions/test/utils/create-map-action-group.spec.js
diff --git a/types/sdk.js b/types/sdk.js

Original file line number	Diff line number	Diff line change
`@@ -109,6 +109,6 @@ type SyncAction = {`
`109`	`109`
`110`	`110`	`type ActionGroup = {`
`111`	`111`	`type: string,`
`112`		`- group: 'black' \| 'white',`
	`112`	`+ group: 'ignore' \| 'allow',`
`113`	`113`	`}`
`114`	`114`	```