Merge pull request #184 from commercetools/169-update-actions-filter

169: beforeUpdateCallback

Author: heshamMassoud

docs/RELEASE_NOTES.md

@@ -67,9 +67,6 @@ events.
 a callback that is called whenever an event occurs during the sync process that represents a warning. Currently, these 
 events.
 <!--
-- `removeOtherLocales`
-a flag which enables the sync module to add additional localizations without deleting existing ones, if set to `false`. 
-If set to `true`, which is the default value of the option, it deletes the existing object properties.
 - `removeOtherSetEntries`
 a flag which enables the sync module to add additional Set entries without deleting existing ones, if set to `false`. 
 If set to `true`, which is the default value of the option, it deletes the existing Set entries.
@@ -81,9 +78,9 @@ entries.
 a flag which enables the sync module to add additional object properties (e.g. custom fields, etc..) without deleting 
 existing ones, if set to `false`. If set to `true`, which is the default value of the option, it deletes the existing 
 object properties. -->
-- `updateActionsCallBack`
-a filter function which can be applied on generated list of update actions to produce a resultant list after the filter 
-function has been applied.
+- `beforeUpdateCallback`
+a filter function which can be applied on a generated list of update actions. It allows the user to intercept category 
+update and modify (add/remove) update actions just before they are send to CTP API.
 - `allowUuid`
 a flag, if set to `true`, enables the user to use keys with UUID format for references. By default, it is set to `false`.
 

docs/usage/CATEGORY_SYNC.md

@@ -112,10 +112,6 @@ An example of use can be found [here](https://github.com/commercetools/commercet
 - `warningCallBack`
 a callback that is called whenever an event occurs during the sync process that represents a warning.
 
-- `removeOtherLocales`
-a flag which enables the sync module to add additional localizations without deleting existing ones, if set to `false`.
-If set to `true`, which is the default value of the option, it deletes the existing object properties.
-
 - `removeOtherSetEntries`
 a flag which enables the sync module to add additional Set entries without deleting existing ones, if set to `false`.
 If set to `true`, which is the default value of the option, it deletes the existing Set entries.
@@ -133,6 +129,10 @@ object properties.
 - `allowUuid`
 a flag, if set to `true`, enables the user to use keys with UUID format for references. By default, it is set to `false`.
 
+- `beforeUpdateCallback`
+a filter function which can be applied on a generated list of update actions. It allows the user to intercept inventory 
+entry update and modify (add/remove) update actions just before they are send to CTP API.
+
 <!-- TODO Update above options with links to tests. Tests should be written when inventory sync could actually use them (when custom update actions would use them).  -->
 
 ## Under the hood

docs/usage/INVENTORY_SYNC.md

@@ -66,9 +66,7 @@ events.
 - `warningCallBack` 
 a callback that is called whenever an event occurs during the sync process that represents a warning. Currently, these 
 events.
-<!--
-- `removeOtherLocales`
-a flag which enables the sync module to add additional localizations without deleting existing ones, if set to `false`. 
+<!-- 
 If set to `true`, which is the default value of the option, it deletes the existing object properties.
 - `removeOtherSetEntries`
 a flag which enables the sync module to add additional Set entries without deleting existing ones, if set to `false`. 
@@ -95,9 +93,9 @@ object properties. -->
 
   - The list of action groups allowed to be blacklist or whitelisted on products can be found [here](/src/main/java/com/commercetools/sync/products/ActionGroup.java). 
 
-- `updateActionsCallBack`
-a filter function which can be applied on generated list of update actions to produce a resultant list after the filter 
-function has been applied.
+- `beforeUpdateCallback`
+a filter function which can be applied on a generated list of update actions. It allows the user to intercept product 
+update and modify (add/remove) update actions just before they are send to CTP API.
 - `allowUuid`
 a flag, if set to `true`, enables the user to use keys with UUID format for references. By default, it is set to `false`.
 

docs/usage/PRODUCT_SYNC.md

@@ -82,11 +82,11 @@ public void setupTest() {
 
         final CategorySyncOptions categorySyncOptions = CategorySyncOptionsBuilder
             .of(CTP_TARGET_CLIENT)
-            .setErrorCallBack((errorMessage, exception) -> {
+            .errorCallback((errorMessage, exception) -> {
                 callBackErrorResponses.add(errorMessage);
                 callBackExceptions.add(exception);
             })
-            .setWarningCallBack((warningMessage) -> callBackWarningResponses.add(warningMessage))
+            .warningCallback((warningMessage) -> callBackWarningResponses.add(warningMessage))
             .build();
         categorySync = new CategorySync(categorySyncOptions);
     }
@@ -168,14 +168,14 @@ public void syncDrafts_WithUpdatedCategoriesWithoutReferenceKeys_ShouldNotSyncCa
                 + " key:'%s'. Reason: %s: Failed to resolve custom type reference on "
                 + "CategoryDraft with key:'%s'. "
                 + "Reason: Found a UUID in the id field. Expecting a key without a UUID value. If you want to allow"
-                + " UUID values for reference keys, please use the setAllowUuidKeys(true) option in the sync options.",
+                + " UUID values for reference keys, please use the allowUuidKeys(true) option in the sync options.",
             key1, ReferenceResolutionException.class.getCanonicalName(), key1));
         final String key2 = categoryDrafts.get(1).getKey();
         assertThat(callBackErrorResponses.get(1)).isEqualTo(format("Failed to resolve references on CategoryDraft with"
                 + " key:'%s'. Reason: %s: Failed to resolve custom type reference on "
                 + "CategoryDraft with key:'%s'. Reason: "
                 + "Found a UUID in the id field. Expecting a key without a UUID value. If you want to allow UUID values"
-                + " for reference keys, please use the setAllowUuidKeys(true) option in the sync options.",
+                + " for reference keys, please use the allowUuidKeys(true) option in the sync options.",
             key2, ReferenceResolutionException.class.getCanonicalName(), key2));
 
         assertThat(callBackExceptions).hasSize(2);

src/integration-test/java/com/commercetools/sync/integration/ctpprojectsource/categories/CategorySyncIT.java

@@ -60,7 +60,7 @@ public void setupTest() {
         deleteAllCategories(CTP_SOURCE_CLIENT);
         callBackResponses = new ArrayList<>();
         categorySyncOptions = CategorySyncOptionsBuilder.of(CTP_TARGET_CLIENT)
-                                                        .setWarningCallBack(callBackResponses::add)
+                                                        .warningCallback(callBackResponses::add)
                                                         .build();
     }
 

src/integration-test/java/com/commercetools/sync/integration/ctpprojectsource/categories/updateactionutils/ChangeOrderHintIT.java

@@ -70,7 +70,7 @@ public void setupTest() {
         deleteAllCategories(CTP_SOURCE_CLIENT);
         callBackResponses = new ArrayList<>();
         categorySyncOptions = CategorySyncOptionsBuilder.of(CTP_TARGET_CLIENT)
-                                                        .setWarningCallBack(callBackResponses::add)
+                                                        .warningCallback(callBackResponses::add)
                                                         .build();
     }
 

src/integration-test/java/com/commercetools/sync/integration/ctpprojectsource/categories/updateactionutils/ChangeParentIT.java

@@ -108,14 +108,14 @@ public void setupTest() {
         warningCallBackMessages = new ArrayList<>();
 
         final ProductSyncOptions syncOptions = ProductSyncOptionsBuilder.of(CTP_TARGET_CLIENT)
-                                                                        .setErrorCallBack(
+                                                                        .errorCallback(
                                                                             (errorMessage, exception) -> {
                                                                                 errorCallBackMessages
                                                                                     .add(errorMessage);
                                                                                 errorCallBackExceptions
                                                                                     .add(exception);
                                                                             })
-                                                                        .setWarningCallBack(warningMessage ->
+                                                                        .warningCallback(warningMessage ->
                                                                             warningCallBackMessages
                                                                                 .add(warningMessage))
                                                                         .build();

src/integration-test/java/com/commercetools/sync/integration/ctpprojectsource/products/ProductReferenceResolverIT.java

@@ -149,9 +149,9 @@ private void clearSyncTestCollections() {
 
     private ProductSyncOptions buildSyncOptions() {
         return ProductSyncOptionsBuilder.of(CTP_TARGET_CLIENT)
-                                        .setErrorCallBack(this::errorCallback)
-                                        .setWarningCallBack(warningCallBackMessages::add)
-                                        .setUpdateActionsFilterCallBack(this::updateActionsCallback)
+                                        .errorCallback(this::errorCallback)
+                                        .warningCallback(warningCallBackMessages::add)
+                                        .beforeUpdateCallback(this::beforeUpdateCallback)
                                         .build();
     }
 
@@ -160,9 +160,11 @@ private void errorCallback(@Nonnull final String errorMessage, @Nullable final T
         errorCallBackExceptions.add(exception);
     }
 
-    private List<UpdateAction<Product>> updateActionsCallback(@Nonnull final List<UpdateAction<Product>> builtActions) {
-        updateActions.addAll(builtActions);
-        return builtActions;
+    private List<UpdateAction<Product>> beforeUpdateCallback(@Nonnull final List<UpdateAction<Product>> updateActions,
+                                                             @Nonnull final ProductDraft productDraft,
+                                                             @Nonnull final Product oldProduct) {
+        this.updateActions.addAll(updateActions);
+        return updateActions;
     }
 
     @AfterClass
@@ -279,10 +281,10 @@ public void sync_withProductTypeReference_ShouldUpdateProducts() {
         // Create custom options with whitelisting and action filter callback..
         final ProductSyncOptions customSyncOptions =
             ProductSyncOptionsBuilder.of(CTP_TARGET_CLIENT)
-                                     .setErrorCallBack(this::errorCallback)
-                                     .setWarningCallBack(warningCallBackMessages::add)
-                                     .setUpdateActionsFilterCallBack(this::updateActionsCallback)
-                                     .setSyncFilter(SyncFilter.ofWhiteList(ATTRIBUTES))
+                                     .errorCallback(this::errorCallback)
+                                     .warningCallback(warningCallBackMessages::add)
+                                     .beforeUpdateCallback(this::beforeUpdateCallback)
+                                     .syncFilter(SyncFilter.ofWhiteList(ATTRIBUTES))
                                      .build();
         final ProductSync customSync = new ProductSync(customSyncOptions);
 

src/integration-test/java/com/commercetools/sync/integration/ctpprojectsource/products/ProductSyncIT.java

@@ -238,7 +238,7 @@ public void syncDrafts_WithConcurrentModificationExceptionAndUnexpectedDelete_Sh
 
         final CategorySyncOptions categorySyncOptions =
             CategorySyncOptionsBuilder.of(spyClient)
-                                      .setErrorCallBack((errorMessage, error) -> {
+                                      .errorCallback((errorMessage, error) -> {
                                           errorMessages.add(errorMessage);
                                           errors.add(error);
                                       })