Shopping List Sync

The module used for importing/syncing Shopping Lists into a commercetools project. It also provides utilities for generating update actions based on the comparison of a ShoppingList against a ShoppingListDraft.

Table of Contents

• Usage
• Prerequisites
  • ProjectApiRoot
  • Required Fields
  • Reference Resolution
  • Syncing from a commercetools project
  • Syncing from an external resource
  • SyncOptions
  • errorCallback
  • warningCallback
  • beforeUpdateCallback
  • beforeCreateCallback
  • batchSize
  • cacheSize
• Running the sync
  • More examples of how to use the sync
• Build all update actions
• Build particular update action(s)
• Caveats
• Migration Guide
• Client configuration and creation
• Signature of ShoppingListSyncOptions
• Build ShoppingListDraft (syncing from external project)
• Query for ShoppingLists (syncing from CTP project)
• JVM-SDK-V2 migration guide

Usage

Prerequisites

ProjectApiRoot

Use the ClientConfigurationUtils which apply the best practices for ProjectApiRoot creation. To create the required ClientCredentials for client creation, please utilize the ClientCredentialsBuilder provided in the java-sdk-v2 Client OAUTH2 package. If you have custom requirements for the client creation, have a look into the Important Usage Tips.

final ClientCredentials clientCredentials =
        new ClientCredentialsBuilder()
        .withClientId("client-id")
        .withClientSecret("client-secret")
        .withScopes("scopes")
        .build();
final ProjectApiRoot apiRoot = ClientConfigurationUtils.createClient("project-key", clientCredentials, "auth-url", "api-url");

Required Fields

The following fields are required to be set in, otherwise, they won't be matched by sync:

Draft	Required Fields	Note
ShoppingListDraft	key	Also, the shopping lists in the target project are expected to have the key fields set.
LineItemDraft	sku	Also, all the line items in the target project are expected to have the sku fields set.
TextLineItemDraft	name

Reference Resolution

In commercetools, a reference can be created by providing the key instead of the ID with the type ResourceIdentifier. When the reference key is provided with a ResourceIdentifier, the sync will resolve the resource with the given key and use the ID of the found resource to create or update a reference. Therefore, in order to resolve the actual ids of those references in the sync process, ResourceIdentifiers with their keys have to be supplied.

Reference Field	Type
customer	CustomerResourceIdentifier
custom.type	TypeResourceIdentifier
lineItems.custom.type	TypeResourceIdentifier
textLineItems.custom.type	TypeResourceIdentifier

Note that a reference without the key field will be considered as an existing resource on the target commercetools project and the library will issue an update/create an API request without reference resolution.

Syncing from a commercetools project

When syncing from a source commercetools project, you can use toShoppingListDrafts method that transforms(resolves by querying and caching key-id pairs) and maps from a ShoppingList to ShoppingListDraft using cache in order to make them ready for reference resolution by the sync, for example:

// Build a ShoppingListQuery for fetching shopping lists from a source CTP project with expansion for line items for the sync:
final ByProjectKeyShoppingListsGet byProjectKeyShoppingListsGet = client.shoppingLists().addExpand("lineItems[*].variant").get();

// Query all shopping lists (NOTE this is just for example, please adjust your logic)
final List<ShoppingList> states = QueryUtils.queryAll(byProjectKeyShoppingListsGet,
        (shoppingLists) -> shoppingLists)
        .thenApply(lists -> lists.stream().flatMap(List::stream).collect(Collectors.toList()))
        .toCompletableFuture()
        .join();

In order to transform and map the ShoppingList to ShoppingListDraft, Utils method toShoppingListDrafts requires projectApiRoot, implementation of ReferenceIdToKeyCache and shoppingLists as parameters. For cache implementation, you can use your own cache implementation or use the class in the library - which implements the cache using caffeine library with an LRU (Least Recently Used) based cache eviction strategyCaffeineReferenceIdToKeyCacheImpl. Example as shown below:

//Implement the cache using library class.
final ReferenceIdToKeyCache referenceIdToKeyCache = new CaffeineReferenceIdToKeyCacheImpl();

//For every reference fetch its key using id, cache it and map from ShoppingList to ShoppingListDraft. With help of the cache same reference keys can be reused.
final CompletableFuture<List<ShoppingListDraft>> shoppingListDrafts = ShoppingListTransformUtils.toShoppingListDrafts(client, referenceIdToKeyCache, shoppingLists);

Syncing from an external resource

• When syncing from an external resource, ResourceIdentifiers with their keys have to be supplied as following example:

final ShoppingListDraft shoppingListDraft =
    ShoppingListDraftBuilder
        .of()
        .name(LocalizedString.ofEnglish("name"))
        .key("shopping-list-key")
        .customer(CustomerResourceIdentifierBuilder.of().key("customer-key").build()) // note that customer provided with key
        .custom(CustomFieldsDraftBuilder.of().type(typeResourceIdentifierBuilder -> typeResourceIdentifierBuilder.key("type-key"))
            .fields(fieldContainerBuilder -> fieldContainerBuilder.values(Map.of())).build()
        ) // note that custom type provided with key
        .lineItems(List.of(ShoppingListLineItemDraftBuilder
          .of()
          .sku("SKU-1")
          .quantity(1L) // note that sku field is set.
          .custom(CustomFieldsDraftBuilder.of().type(typeResourceIdentifierBuilder -> typeResourceIdentifierBuilder.key("type-key"))
             .fields(fieldContainerBuilder -> fieldContainerBuilder.values(Map.of())).build()
           ) // note that custom type provided with key
          .build())
        )
        .textLineItems(List.of(
            TextLineItemDraftBuilder.of().name(ofEnglish("name")).quantity(1L) // note that name field is set for text line item.
              .custom(CustomFieldsDraftBuilder.of().type(typeResourceIdentifierBuilder -> typeResourceIdentifierBuilder.key("type-key"))
                .fields(fieldContainerBuilder -> fieldContainerBuilder.values(Map.of())).build()
              ) // note that custom type provided with key
              .build()
          )
        )
        .build();

SyncOptions

After the projectApiRoot is set up, a ShoppingListSyncOptions should be built as follows:

// instantiating a ShoppingListSyncOptions
final ShoppingListSyncOptions shoppingListSyncOptions = ShoppingListSyncOptionsBuilder.of(projectApiRoot).build();

SyncOptions is an object which provides a place for users to add certain configurations to customize the sync process. Available configurations:

errorCallback

A callback that is called whenever an error event occurs during the sync process. Each resource executes its own error-callback. When the sync process of a particular resource runs successfully, it is not triggered. It contains the following context about the error-event:

• sync exception
• shopping list draft from the source
• shopping list of the target project (only provided if an existing shopping list could be found)
• the update-actions, which failed (only provided if an existing shopping list could be found)

 final Logger logger = LoggerFactory.getLogger(ShoppingListSync.class);
 final ShoppingListSyncOptions shoppingListSyncOptions = ShoppingListSyncOptionsBuilder
         .of(projectApiRoot)
         .errorCallback((syncException, draft, shoppingList, updateActions) -> 
            logger.error(new SyncException("My customized message"), syncException)).build();

warningCallback

A callback is called whenever a warning event occurs during the sync process. Each resource executes its own warning-callback. When the sync process of a particular resource runs successfully, it is not triggered. It contains the following context about the warning message:

• sync exception
• shopping list draft from the source
• shopping list of the target project (only provided if an existing shopping list could be found)

 final Logger logger = LoggerFactory.getLogger(ShoppingListSync.class);
 final ShoppingListSyncOptions shoppingListSyncOptions = ShoppingListSyncOptionsBuilder
         .of(projectApiRoot)
         .warningCallback((syncException, draft, shoppingList) -> 
            logger.warn(new SyncException("My customized message"), syncException)).build();

beforeUpdateCallback

During the sync process, if a target customer and a customer draft are matched, this callback can be used to intercept the update request just before it is sent to the commercetools platform. This allows the user to modify update actions array with custom actions or discard unwanted actions. The callback provides the following information :

• shopping list draft from the source
• shopping list from the target project
• update actions that were calculated after comparing both

final TriFunction<List<ShoppingListUpdateAction>, ShoppingListDraft, ShoppingList,
            List<ShoppingListUpdateAction>> beforeUpdateCallback =
                (updateActions, newShoppingList, oldShoppingList) ->  updateActions
                    .stream()
                    .filter(updateAction -> !(updateAction instanceof ShoppingListSetSlugAction))
                    .collect(Collectors.toList());

final ShoppingListSyncOptions shoppingListSyncOptions = ShoppingListSyncOptionsBuilder
                    .of(projectApiRoot)
                    .beforeUpdateCallback(beforeUpdateCallback)
                    .build();

beforeCreateCallback

During the sync process, if a shopping list draft should be created, this callback can be used to intercept the create request just before it is sent to the commercetools platform. It contains the following information :

• shopping list that should be created

Please refer to the example in the product sync document.

batchSize

A number that could be used to set the batch size with which shopping lists are fetched and processed, as shopping lists are obtained from the target project on the commercetools platform in batches for better performance. The algorithm accumulates up to batchSize resources from the input list, then fetches the corresponding shopping lists from the target project on the commercetools platform in a single request. Playing with this option can slightly improve or reduce processing speed. If it is not set, the default batch size is 50 for shopping list sync.

final ShoppingListSyncOptions shoppingListSyncOptions = 
         ShoppingListSyncOptionsBuilder.of(projectApiRoot).batchSize(30).build();

cacheSize

In the service classes of the commercetools-sync-java library, we have implemented an in-memory LRU cache to store a map used for the reference resolution of the library. The cache reduces the reference resolution based calls to the commercetools API as the required fields of a resource will be fetched only one time. These cached fields then might be used by another resource referencing the already resolved resource instead of fetching from commercetools API. It turns out, having the in-memory LRU cache will improve the overall performance of the sync library and commercetools API. which will improve the overall performance of the sync and commercetools API.

Playing with this option can change the memory usage of the library. If it is not set, the default cache size is 10.000 for shopping list sync.

final ShoppingListSyncOptions shoppingListSyncOptions = 
         ShoppingListSyncOptionsBuilder.of(projectApiRoot).cacheSize(5000).build();

Running the sync

When all prerequisites are fulfilled, follow these steps to run the sync:

// instantiating a shopping list sync
final ShoppingListSync shoppingListSync = new ShoppingListSync(shoppingListSyncOptions);

// execute the sync on your list of shopping lists
CompletionStage<ShoppingListSyncStatistics> syncStatisticsStage = shoppingListSync.sync(shoppingListDrafts);

The result of completing the syncStatisticsStage in the previous code snippet contains a ShoppingListSyncStatistics which contains all the stats of the sync process; which includes a report message, the total number of updated, created, failed, processed shopping lists, and the processing time of the last sync batch in different time units and in a human-readable format.

final ShoppingListSyncStatistics stats = syncStatisticsStage.toCompletebleFuture().join();
stats.getReportMessage();
/*"Summary: 100 shopping lists were processed in total (11 created, 87 updated, 2 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.

More examples of how to use the sync

1. Sync from another CTP project as a source.
2. Sync from an external source.

Make sure to read the Important Usage Tips for optimal performance.

Build all update actions

A utility method provided by the library to compare a ShoppingList to a new ShoppingListDraft. The results are collected in a list of shopping list update actions.

List<ShoppingListUpdateAction> updateActions = ShoppingListSyncUtils.buildActions(shoppingList, shoppingListDraft, shoppingListSyncOptions);

Build particular update action(s)

The library provides utility methods to compare specific fields of a ShoppingList and a new ShoppingListDraft, and builds the update action(s) as a result. One example is the buildChangeNameUpdateAction which compare shopping list names:

Optional<ShoppingListUpdateAction> updateAction = ShoppingListUpdateActionUtils.buildChangeNameAction(shoppingList, shoppingListDraft);

More examples for particular update actions can be found in the test scenarios for ShoppingListUpdateActionUtils.

Caveats

In commercetools shopping lists API, there is no update action to change the addedAt field of the LineItem and TextLineItem, hereby commercetools-java-sync library will not update the addedAt value.

For the new LineItem and TextLineItem the addedAt values will be added, if the draft has the value set.

Migration Guide

The shopping-list-sync uses the JVM-SDK-V2, therefore ensure you Install JVM SDK module commercetools-sdk-java-api with any HTTP client module. The default one is commercetools-http-client.

 <!-- Sample maven pom.xml -->
 <properties>
     <commercetools.version>LATEST</commercetools.version>
 </properties>

 <dependencies>
     <dependency>
       <groupId>com.commercetools.sdk</groupId>
       <artifactId>commercetools-http-client</artifactId>
       <version>${commercetools.version}</version>
     </dependency>
     <dependency>
       <groupId>com.commercetools.sdk</groupId>
       <artifactId>commercetools-sdk-java-api</artifactId>
       <version>${commercetools.version}</version>
     </dependency>
 </dependencies>

Client configuration and creation

For client creation use ClientConfigurationUtils which apply the best practices for ProjectApiRoot creation. If you have custom requirements for the client creation make sure to replace SphereClientFactory with ApiRootBuilder as described in this Migration Document.

Signature of ShoppingListSyncOptions

As models and update actions have changed in the JVM-SDK-V2 the signature of SyncOptions is different. It's constructor now takes a ProjectApiRoot as first argument. The callback functions are signed with ShoppingListDraft, ShoppingList and ShoppingListUpdateAction from package com.commercetools.api.models.shopping_list.*

Note: Type UpdateAction<ShoppingList> has changed to ShoppingListUpdateAction. Make sure you create and supply a specific ShoppingListUpdateAction in beforeUpdateCallback. For that you can use the library-utilities or use a JVM-SDK builder (see also):

// Example: Create a shopping-list update action to change name taking the 'newName' of the shoppingListDraft
    final Function<LocalizedString, ShoppingListUpdateAction> createBeforeUpdateAction =
        (newName) -> ShoppingListChangeNameAction.builder().name(newName).build();

// Add the change name action to the list of update actions before update is executed
    final TriFunction<
            List<ShoppingListUpdateAction>, ShoppingListDraft, ShoppingList, List<ShoppingListUpdateAction>>
        beforeUpdateShoppingListCallback =
            (updateActions, newShoppingListDraft, oldShoppingList) -> {
              final ShoppingListUpdateAction beforeUpdateAction =
                  createBeforeUpdateAction.apply(newShoppingListDraft.getName());
              updateActions.add(beforeUpdateAction);
              return updateActions;
            };

Build ShoppingListDraft (syncing from external project)

The shopping-list-sync expects a list of ShoppingListDrafts to process. If you use java-sync-library to sync your shopping-lists from any external system into a commercetools platform project you have to convert your data into CTP compatible ShoppingListDraft type. This was done in previous version using DraftBuilders. The V2 SDK do not have inheritance for DraftBuilder classes but the differences are minor and you can replace it easily. Here's an example:

// SDK v1: ShoppingListDraftBuilder.of  takes parameters 'key', 'name' and 1 line item 
final ShoppingListDraft shoppingListDraft =
        ShoppingListDraftBuilder.of(LocalizedString.ofEnglish("name"))
          .key("key")
          .plusLineItems(LineItemDraftBuilder.ofSku("sku", Long.valueOf(1)).build())
          .build()

// SDK v2: ShoppingListDraftBuilder without draftTemplate
final ShoppingListDraft shoppingListDraft =
        ShoppingListDraftBuilder.of()
          .name(LocalizedString.ofEnglish("name"))
          .key("product-type-key")
          .lineItems(ShoppingListLineItemDraftBuilder.of().sku("SKU-1").quantity(1L).build())
          .build();

For more information, see the Guide to replace DraftBuilders.

Query for ShoppingLists (syncing from CTP project)

If you sync shopping lists between different commercetools projects you probably use ShoppingListTransformUtils#toShoppingListDrafts to transform ShoppingList into ShoppingListDraft which can be used by the shopping-list-sync. However, if you need to query ShoppingLists from a commercetools project instead of passing ShoppingListQuerys to a sphereClient, create (and execute) requests directly from the apiRoot. Here's an example:

// SDK v1: ShoppingListQuery to fetch all shopping lists
final ShoppingListQuery query = ShoppingListQuery.of();

final PagedQueryResult<ShoppingList> pagedQueryResult = sphereClient.executeBlocking(query);

// SDK v2: Create and execute query to fetch all shopping lists in one line
final ShoppingListPagedQueryResponse result = apiRoot.shoppingLists().get().executeBlocking().getBody();

Read more about querying resources.

JVM-SDK-V2 migration guide

On any other needs to migrate your project using jvm-sdk-v2 please refer to its Migration Guide.