commercetools · heshamMassoud · Dec 7, 2018 · Sep 13, 2018 · Sep 13, 2018 · Sep 18, 2018
diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ Currently this library supports synchronising the following entities in commerce
  - [Products](/docs/usage/PRODUCT_SYNC.md)
  - [InventoryEntries](/docs/usage/INVENTORY_SYNC.md)
  - [ProductTypes](/docs/usage/PRODUCT_TYPE_SYNC.md)
+ - [Types](/docs/usage/TYPE_SYNC.md)
 
 ![commercetools-java-sync-final 001](https://user-images.githubusercontent.com/9512131/31230702-0f2255a6-a9e5-11e7-9412-04ed52641dde.png)
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->

diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -70,7 +70,10 @@
         </module>
         <module name="AvoidStarImport">
             <property name="excludes" value="com.commercetools.sync.products.utils.productvariantupdateactionutils.prices.PriceDraftFixtures,
-            com.commercetools.sync.products.utils.productvariantupdateactionutils.prices.PriceFixtures"/>
+            com.commercetools.sync.products.utils.productvariantupdateactionutils.prices.PriceFixtures,
+            com.commercetools.sync.commons.utils.LocalizedEnumValueFixtures,
+            com.commercetools.sync.commons.utils.PlainEnumValueFixtures,
+            com.commercetools.sync.types.utils.FieldDefinitionFixtures"/>
             <property name="allowClassImports" value="false"/>
             <property name="allowStaticMemberImports" value="false"/>
         </module>
@@ -206,4 +209,4 @@
             <property name="ignorePrimitiveTypes" value="true"/>
         </module>
     </module>
-</module>
+</module>
diff --git a/docs/README.md b/docs/README.md
@@ -29,6 +29,7 @@ Currently this library supports synchronising the following entities in commerce
  - [Products](usage/PRODUCT_SYNC.md)
  - [InventoryEntries](usage/INVENTORY_SYNC.md)
  - [ProductTypes](usage/PRODUCT_TYPE_SYNC.md)
+ - [Types](usage/TYPE_SYNC.md)
 
 ![commercetools-java-sync-final 001](https://user-images.githubusercontent.com/9512131/31230702-0f2255a6-a9e5-11e7-9412-04ed52641dde.png)
 

diff --git a/docs/RELEASE_NOTES.md b/docs/RELEASE_NOTES.md
@@ -34,25 +34,28 @@
 [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M15/) | 
 [Jar](https://bintray.com/commercetools/maven/commercetools-sync-java/v1.0.0-M15)
 
-- 🎉 **New Features** (1)
+- 🎉 **New Features** (9)
     - **Commons** - Added `OptionalUtils#filterEmptyOptionals` which are utility methods that filter out the 
     empty optionals in a supplied list (with a varargs variation) returning a list of the contents of the non-empty 
     optionals. [#255](https://github.com/commercetools/commercetools-sync-java/issues/255)
+    - **Type Sync** - Support for syncing types. [#300](https://github.com/commercetools/commercetools-sync-java/issues/300) For more info how to use it please refer to [Type usage doc](/docs/usage/TYPE_SYNC.md). 
+    - **Type Sync** - Exposed `TypeSyncUtils#buildActions` which calculates all needed update actions after comparing a `Type` and a `TypeDraft`. [#300](https://github.com/commercetools/commercetools-sync-java/issues/300)
+    - **Type Sync** - Exposed `TypeUpdateActionUtils` which contains utils for calculating needed update actions after comparing individual fields of a `Type` and a `TypeDraft`. [#300](https://github.com/commercetools/commercetools-sync-java/issues/300)
 
 - 📋 **Documentation** (4)
     - **Commons** - Added the documentation github pages. https://commercetools.github.io/commercetools-sync-java 
     - **Commons** - Added a [Quick Start Guide](/docs/usage/QUICK_START.md) for a convinient entry into the library.
     - **Commons** - Moved documentation of sync options to a separate [doc](/docs/usage/SYNC_OPTIONS.md).
     - **Commons** - Added a the earliest compatible version of the commercetools-jvm-sdk](https://github.com/commercetools/commercetools-jvm-sdk) as a prerequisite for using the library.
 
-- 🛠️ **Enhancements** (16)
+- 🛠️ **Enhancements** (17)
     - **ProductType Sync** - Added concurrency modification exception handling. [#325](https://github.com/commercetools/commercetools-sync-java/issues/325)
     - **Commons** - `ProductSyncUtils#buildActions`, `CategorySyncUtils#buildActions`, `InventorySyncUtils#buildActions` and `ProductTypeSyncUtils#buildActions` now don't apply the `beforeUpdateCallback` implicitly. 
     If you want, you can apply it explicitly on the result of the `..#buildActions` method. [#302](https://github.com/commercetools/commercetools-sync-java/issues/302)
     - **Product Sync** - Reference keys are not validated if they are in UUID format anymore. [#166](https://github.com/commercetools/commercetools-sync-java/issues/166)
     - **Category Sync** - Reference keys are not validated if they are in UUID format anymore. [#166](https://github.com/commercetools/commercetools-sync-java/issues/166)
     - **Inventory Sync** - Reference keys are not validated if they are in UUID format anymore. [#166](https://github.com/commercetools/commercetools-sync-java/issues/166)
-    - **ProductType Sync** - Added `ProductTypeSyncBenchmark` to benchmark the product type sync, to be able to compare the performance of the sync with the future releases. [#301](https://github.com/commercetools/commercetools-sync-java/issues/301)
+    - **ProductType Sync** - Added benchmarks for the `productType` sync to be able to compare the performance of the sync with the future releases. [#301](https://github.com/commercetools/commercetools-sync-java/issues/301)
     - **Commons** - Bumped commercetools-jvm-sdk to version [1.37.0](http://commercetools.github.io/commercetools-jvm-sdk/apidocs/io/sphere/sdk/meta/ReleaseNotes.html#v1_37_0).
     - **Commons** - Bumped `mockito` to 2.23.4.
     - **Commons** - Bumped `com.adarshr.test-logger` to 1.6.0.
@@ -63,7 +66,8 @@
     - **Commons** - Bumped `com.adarshr.test-logger` to 1.6.0.
     - **Commons** - Bumped `org.ajoberstar.grgit` to 3.0.0.
     - **Commons** - Bumped gradle to version [gradle-5.0](https://docs.gradle.org/5.0/release-notes.html)
-
+    - **Type Sync** - Added benchmarks for the `type` sync to be able to compare the performance of the sync with the future releases. [#300](https://github.com/commercetools/commercetools-sync-java/issues/300)
+
 - 🚧 **Breaking Changes** (11) 
     - **Product Sync** - `allowUuid` option is now removed. [#166](https://github.com/commercetools/commercetools-sync-java/issues/166) 
     - **Category Sync** - `allowUuid` option is now removed. [#166](https://github.com/commercetools/commercetools-sync-java/issues/166) 

diff --git a/docs/usage/PRODUCT_TYPE_SYNC.md b/docs/usage/PRODUCT_TYPE_SYNC.md
@@ -12,6 +12,8 @@ against a [ProductTypeDraft](https://docs.commercetools.com/http-api-projects-pr
   - [Sync list of product type drafts](#sync-list-of-product-type-drafts)
     - [Prerequisites](#prerequisites)
     - [Running the sync](#running-the-sync)
+    - [Important to Note](#important-to-note)
+    - [More examples of how to use the sync](#more-examples-of-how-to-use-the-sync)
   - [Build all update actions](#build-all-update-actions)
   - [Build particular update action(s)](#build-particular-update-actions)
 - [Caveats](#caveats)
@@ -26,8 +28,8 @@ against a [ProductTypeDraft](https://docs.commercetools.com/http-api-projects-pr
 
 #### Prerequisites
 
-1. The sync expects a list of `ProductTypeDrafts`s that have their `key` fields set to be matched with
-product types  in the target CTP project. Also, the product types  in the target project are expected to have the `key`
+1. The sync expects a list of `ProductTypeDraft`s that have their `key` fields set to be matched with
+product types in the target CTP project. Also, the product types in the target project are expected to have the `key`
 fields set, otherwise they won't be matched.
 
 2. Create a `sphereClient` [as described here](IMPORTANT_USAGE_TIPS.md#sphereclient-creation).
@@ -64,8 +66,18 @@ __Note__ The statistics object contains the processing time of the last batch on
 
  1. The sync processing time should not take into account the time between supplying batches to the sync.
  2. It is not known by the sync which batch is going to be the last one supplied.
+
+#### Important to Note
+
+1. If two matching `attributeDefinition`s (old and new) on the matching `productType`s (old and new) have a different `AttributeType`, the sync will
+**remove** the existing `attributeDefinition` and then **add** a new `attributeDefinition` with the new `AttributeType`.
 
-More examples of how to use the sync can be found [here](https://github.com/commercetools/commercetools-sync-java/tree/master/src/integration-test/java/com/commercetools/sync/integration/producttypes/ProductTypeSyncIT.java).
+2. The `attributeDefinition` for which the `AttributeType` is not defined (`null`) will not be synced. 
+
+#### More examples of how to use the sync
+
+ 1. [Sync from another CTP project as a source](https://github.com/commercetools/commercetools-sync-java/tree/master/src/integration-test/java/com/commercetools/sync/integration/ctpprojectsource/producttypes/ProductTypeSyncIT.java).
+ 2. [Sync from an external source](https://github.com/commercetools/commercetools-sync-java/tree/master/src/integration-test/java/com/commercetools/sync/integration/externalsource/producttypes/ProductTypeSyncIT.java).
 
 *Make sure to read the [Important Usage Tips](IMPORTANT_USAGE_TIPS.md) for optimal performance.*
 
@@ -88,3 +100,4 @@ More examples of those utils for different fields can be found [here](https://gi
 
 ## Caveats    
 1. Syncing product types with an attribute of type [NestedType](https://docs.commercetools.com/http-api-projects-productTypes.html#nestedtype) is not supported yet.
+2. Currently the sync would handle changes to Enum or LocalizedEnum Types but not [Set](https://docs.commercetools.com/http-api-projects-types.html#settype) of either. [#313](https://github.com/commercetools/commercetools-sync-java/issues/313)
diff --git a/docs/usage/QUICK_START.md b/docs/usage/QUICK_START.md
@@ -83,4 +83,5 @@ implementation 'com.commercetools:commercetools-sync-java:v1.0.0-M14'
 
 #### More Details
 *[Product Sync](PRODUCT_SYNC.md), [ProductType Sync](PRODUCT_TYPE_SYNC.md), 
-[Category Sync](CATEGORY_SYNC.md), [Inventory Sync](INVENTORY_SYNC.md)*
+[Category Sync](CATEGORY_SYNC.md), [Inventory Sync](INVENTORY_SYNC.md), 
+[Type Sync](TYPE_SYNC.md)*
diff --git a/docs/usage/TYPE_SYNC.md b/docs/usage/TYPE_SYNC.md
@@ -0,0 +1,101 @@
+# Type Sync
+
+Module used for importing/syncing Types into a commercetools project. 
+It also provides utilities for generating update actions based on the comparison of a [Type](https://docs.commercetools.com/http-api-projects-types.html#type) 
+against a [TypeDraft](https://docs.commercetools.com/http-api-projects-types.html#typedraft).
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Usage](#usage)
+  - [Sync list of type drafts](#sync-list-of-type-drafts)
+    - [Prerequisites](#prerequisites)
+    - [Running the sync](#running-the-sync)
+    - [Important to Note](#important-to-note)
+    - [More examples of how to use the sync](#more-examples-of-how-to-use-the-sync)
+  - [Build all update actions](#build-all-update-actions)
+  - [Build particular update action(s)](#build-particular-update-actions)
+- [Caveats](#caveats)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Usage
+
+### Sync list of type drafts
+
+#### Prerequisites
+1. The sync expects a list of `TypeDraft`s that have their `key` fields set to be matched with
+types in the target CTP project. Also, the types in the target project are expected to have the `key`
+fields set, otherwise they won't be matched.
+
+2. Create a `sphereClient` [as described here](IMPORTANT_USAGE_TIPS.md#sphereclient-creation).
+
+3. After the `sphereClient` is set up, a `TypeSyncOptions` should be be built as follows:
+````java
+// instantiating a TypeSyncOptions
+final TypeSyncOptions typeSyncOptions = TypeSyncOptionsBuilder.of(sphereClient).build();
+````
+
+[More information about Sync Options](SYNC_OPTIONS.md).
+
+#### Running the sync
+After all the aforementioned points in the previous section have been fulfilled, to run the sync:
+````java
+// instantiating a type sync
+final TypeSync typeSync = new TypeSync(typeSyncOptions);
+
+// execute the sync on your list of types
+CompletionStage<TypeSyncStatistics> syncStatisticsStage = typeSync.sync(typeDrafts);
+````
+The result of the completing the `syncStatisticsStage` in the previous code snippet contains a `TypeSyncStatistics`
+which contains all the stats of the sync process; which includes a report message, the total number of updated, created,
+failed, processed types and the processing time of the last sync batch in different time units and in a
+human-readable format.
+
+````java
+final TypeSyncStatistics stats = syncStatisticsStage.toCompletebleFuture().join();
+stats.getReportMessage();
+/*"Summary: 2000 types were processed in total (1000 created, 995 updated, 5 failed to sync)."*/
+````
+
+__Note__ The statistics object contains the processing time of the last batch only. This is due to two reasons:
+
+ 1. The sync processing time should not take into account the time between supplying batches to the sync.
+ 2. It is not known by the sync which batch is going to be the last one supplied.
+
+#### Important to Note
+1. If two matching `fieldDefinition`s (old and new) on the matching `type`s (old and new) have a different `FieldType`, the sync will
+**remove** the existing `fieldDefinition` and then **add** a new `fieldDefinition` with the new `FieldType`.
+
+2. The `fieldDefinition` for which the `fieldType` is not defined (`null`) will not be synced.
+
+#### More examples of how to use the sync
+
+ 1. [Sync from another CTP project as a source](https://github.com/commercetools/commercetools-sync-java/tree/master/src/integration-test/java/com/commercetools/sync/integration/ctpprojectsource/types/TypeSyncIT.java).
+ 2. [Sync from an external source](https://github.com/commercetools/commercetools-sync-java/tree/master/src/integration-test/java/com/commercetools/sync/integration/externalsource/types/TypeSyncIT.java).
+
+*Make sure to read the [Important Usage Tips](IMPORTANT_USAGE_TIPS.md) for optimal performance.*
+
+### Build all update actions
+
+A utility method provided by the library to compare a `Type` with a new `TypeDraft` and results in a list of type update actions.
+```java
+List<UpdateAction<Type>> updateActions = TypeSyncUtils.buildActions(type, typeDraft, typeSyncOptions);
+```
+
+### Build particular update action(s)
+
+Utility methods provided by the library to compare the specific fields of a `Type` and a new `TypeDraft`, and in turn builds
+ the update action. One example is the `buildChangeNameUpdateAction` which compares names:
+````java
+Optional<UpdateAction<Type>> updateAction = TypeUpdateActionUtils.buildChangeNameAction(oldType, typeDraft);
+````
+More examples of those utils for different types can be found [here](https://github.com/commercetools/commercetools-sync-java/tree/master/src/test/java/com/commercetools/sync/types/utils/TypeUpdateActionUtilsTest.java).
+
+## Caveats
+
+1. Updating the label of enum values and localized enum values of field definition is not supported yet. [#339](https://github.com/commercetools/commercetools-sync-java/issues/339)
+2. Removing the enum values and localized enum values from the field definition is not supported yet. [#339](https://github.com/commercetools/commercetools-sync-java/issues/339)
+3. Updating the input hint of a field definition is not supported yet. [#339](https://github.com/commercetools/commercetools-sync-java/issues/339)
+4. Currently the sync would handle changes to Enum or LocalizedEnum Types but not [Set](https://docs.commercetools.com/http-api-projects-types.html#settype) of either. [#313](https://github.com/commercetools/commercetools-sync-java/issues/313)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -49,6 +49,7 @@ nav:
       - Quick Start: usage/QUICK_START.md
       - Product Sync: usage/PRODUCT_SYNC.md
       - ProductType Sync: usage/PRODUCT_TYPE_SYNC.md
+      - Type Sync: usage/TYPE_SYNC.md
       - Category Sync: usage/CATEGORY_SYNC.md
       - InventoryEntry Sync: usage/INVENTORY_SYNC.md
       - Advanced:

diff --git a/src/benchmark/java/com/commercetools/sync/benchmark/BenchmarkUtils.java b/src/benchmark/java/com/commercetools/sync/benchmark/BenchmarkUtils.java
@@ -35,6 +35,7 @@ public class BenchmarkUtils {
     static final String PRODUCT_SYNC = "productSync";
     static final String INVENTORY_SYNC = "inventorySync";
     static final String CATEGORY_SYNC = "categorySync";
+    static final String TYPE_SYNC = "typeSync";
     static final String PRODUCT_TYPE_SYNC = "productTypeSync";
     static final String CREATES_ONLY = "createsOnly";
     static final String UPDATES_ONLY = "updatesOnly";
@@ -107,9 +108,9 @@ private static double calculateAvg(@Nonnull final List<JsonNode> results) {
     }
 
     private static ObjectNode createVersionNode(@Nonnull final ObjectNode rootNode, @Nonnull final String version) {
-        final ObjectNode newVersionNode = createSyncNode(
+        final ObjectNode newVersionNode = createSyncNode(createSyncNode(createSyncNode(
             createSyncNode(createSyncNode(JsonNodeFactory.instance.objectNode(),
-                PRODUCT_SYNC), INVENTORY_SYNC), CATEGORY_SYNC);
+                PRODUCT_SYNC), INVENTORY_SYNC), CATEGORY_SYNC), PRODUCT_TYPE_SYNC), TYPE_SYNC);
         return (ObjectNode) rootNode.set(version, newVersionNode);
     }
 

diff --git a/src/benchmark/java/com/commercetools/sync/benchmark/ProductSyncBenchmark.java b/src/benchmark/java/com/commercetools/sync/benchmark/ProductSyncBenchmark.java
@@ -158,7 +158,7 @@ public void sync_ExistingProducts_ShouldUpdateProducts() throws IOException {
 
 
         // Calculate time taken for benchmark and assert it lies within threshold
-        final double diff = calculateDiff(SyncSolutionInfo.LIB_VERSION, PRODUCT_SYNC, CREATES_ONLY, totalTime);
+        final double diff = calculateDiff(SyncSolutionInfo.LIB_VERSION, PRODUCT_SYNC, UPDATES_ONLY, totalTime);
         assertThat(diff)
             .withFailMessage(format("Diff of benchmark '%e' is longer than expected threshold of '%d'.", diff,
                 THRESHOLD))
@@ -222,7 +222,7 @@ public void sync_WithSomeExistingProducts_ShouldSyncProducts() throws IOExceptio
 
 
         // Calculate time taken for benchmark and assert it lies within threshold
-        final double diff = calculateDiff(SyncSolutionInfo.LIB_VERSION, PRODUCT_SYNC, CREATES_ONLY, totalTime);
+        final double diff = calculateDiff(SyncSolutionInfo.LIB_VERSION, PRODUCT_SYNC, CREATES_AND_UPDATES, totalTime);
         assertThat(diff)
             .withFailMessage(format("Diff of benchmark '%e' is longer than expected threshold of '%d'.", diff,
                 THRESHOLD))