Merge branch 'master' into cleanup-project-after-sdk-v2-migration

# Conflicts:
#	build.gradle

Author: lojzatran

build.gradle

@@ -1,24 +1,24 @@
 plugins {
-    id 'org.ajoberstar.git-publish' version '4.2.0'
-    id 'com.adarshr.test-logger' version '3.2.0'
-    id 'org.ajoberstar.grgit' version '5.2.0'
-    id "com.github.ben-manes.versions" version '0.48.0'
+    id 'org.ajoberstar.git-publish' version '4.2.1'
+    id 'com.adarshr.test-logger' version '4.0.0'
+    id 'org.ajoberstar.grgit' version '5.2.1'
+    id "com.github.ben-manes.versions" version '0.49.0'
     id 'ru.vyarus.mkdocs' version '3.0.0'
-    id "com.github.spotbugs" version "5.1.3"
-    id 'com.diffplug.spotless' version '6.21.0'
+    id "com.github.spotbugs" version "5.2.1"
+    id 'com.diffplug.spotless' version '6.22.0'
     id 'io.github.gradle-nexus.publish-plugin' version '1.3.0'
 }
 
 ext{
-    commercetoolsJavaSdkV2Version = '14.7.0'
-    mockitoJunitJupiterVersion = '5.5.0'
-    jupiterApiVersion = '5.10.0'
+    commercetoolsJavaSdkV2Version = '17.1.0'
+    mockitoJunitJupiterVersion = '5.7.0'
+    jupiterApiVersion = '5.10.1'
     assertjVersion = '3.24.2'
     pmdVersion = '6.55.0'
-    jacocoVersion = '0.8.10'
+    jacocoVersion = '0.8.11'
     caffeineVersion = '3.1.8'
     nexusStagingPluginVersion = '0.22.0'
-    commonTextVersion = '1.9'
+    commonTextVersion = '1.11.0'
 }
 
 apply from: "$rootDir/gradle-scripts/repositories.gradle"
@@ -43,21 +43,18 @@ apply from: "$rootDir/gradle-scripts/mkdocs.gradle"
 apply from: "$rootDir/gradle-scripts/spotless.gradle"
 
 dependencies {
-    implementation "com.commercetools.sdk:commercetools-http-client:${commercetoolsJavaSdkV2Version}"
-    implementation "com.commercetools.sdk:commercetools-sdk-java-api:${commercetoolsJavaSdkV2Version}"
+    implementation "com.commercetools.sdk:commercetools-http-client:${commercetoolsJavaSDK2Version}"
+    implementation "com.commercetools.sdk:commercetools-sdk-java-api:${commercetoolsJavaSDK2Version}"
+
     implementation "com.github.ben-manes.caffeine:caffeine:${caffeineVersion}"
     implementation "org.apache.commons:commons-text:${commonTextVersion}"
-    api 'commons-io:commons-io:2.11.0'
-    api 'commons-codec:commons-codec:1.16.0'
-    api 'com.google.code.findbugs:annotations:3.0.1'
-    api 'com.neovisionaries:nv-i18n:1.28'
+    api "com.commercetools.sdk:commercetools-sdk-compat-v1:${commercetoolsJavaSdkV2Version}"
+    api "com.commercetools.sdk:commercetools-apachehttp-client:${commercetoolsJavaSdkV2Version}"
     testImplementation "org.mockito:mockito-junit-jupiter:${mockitoJunitJupiterVersion}"
     testImplementation "org.junit.jupiter:junit-jupiter-api:${jupiterApiVersion}"
     testImplementation "org.junit.jupiter:junit-jupiter-params:${jupiterApiVersion}"
     testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${jupiterApiVersion}"
     testRuntimeOnly "org.junit.vintage:junit-vintage-engine:${jupiterApiVersion}"
     testImplementation "org.assertj:assertj-core:${assertjVersion}"
-    testImplementation 'com.github.spotbugs:spotbugs-annotations:4.7.3'
-
-
+    testImplementation 'com.github.spotbugs:spotbugs-annotations:4.8.0'
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradlew

@@ -259,6 +259,8 @@ void cacheKeysToIds_WithAlreadyCachedKeys_ShouldNotMakeRequestsAndReturnCurrentC
         spyProductService.cacheKeysToIds(singleton(product.getKey())).toCompletableFuture().join();
     assertThat(cache).hasSize(2);
     assertThat(cache).containsKeys(product.getKey(), product2.getKey());
+    cache = spyProductService.cacheKeysToIds(singleton(null)).toCompletableFuture().join();
+    assertThat(cache).hasSize(2);
 
     // verify only 1 request was made to fetch id the first time, but not second time since it's
     // already in cache.

src/integration-test/java/com/commercetools/sync/integration/services/impl/ProductServiceImplIT.java

@@ -2,7 +2,8 @@
 
 import com.commercetools.sync.commons.helpers.BaseSyncStatistics;
 
-public final class CartDiscountSyncStatistics extends BaseSyncStatistics {
+public final class CartDiscountSyncStatistics
+    extends BaseSyncStatistics<CartDiscountSyncStatistics> {
 
   /**
    * Builds a summary of the cart discount sync statistics instance that looks like the following
@@ -17,4 +18,9 @@ public final class CartDiscountSyncStatistics extends BaseSyncStatistics {
   public String getReportMessage() {
     return getDefaultReportMessageForResource("cart discounts");
   }
+
+  @Override
+  protected CartDiscountSyncStatistics getThis() {
+    return this;
+  }
 }

src/main/java/com/commercetools/sync/cartdiscounts/helpers/CartDiscountSyncStatistics.java

@@ -10,7 +10,7 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
-public class CategorySyncStatistics extends BaseSyncStatistics {
+public class CategorySyncStatistics extends BaseSyncStatistics<CategorySyncStatistics> {
 
   /**
    * The following {@link java.util.Map} ({@code categoryKeysWithMissingParents}) represents
@@ -52,6 +52,11 @@ public String getReportMessage() {
         getNumberOfCategoriesWithMissingParents());
   }
 
+  @Override
+  protected CategorySyncStatistics getThis() {
+    return this;
+  }
+
   /**
    * Returns the total number of categories with missing parents.
    *

src/main/java/com/commercetools/sync/categories/helpers/CategorySyncStatistics.java

@@ -15,8 +15,8 @@ public abstract class BaseSync<
     ResourceT extends BaseResource,
     ResourceDraftT,
     ResourceUpdateActionT extends ResourceUpdateAction<ResourceUpdateActionT>,
-    SyncStatisticsT extends BaseSyncStatistics,
-    SyncOptionsT extends BaseSyncOptions> {
+    SyncStatisticsT extends BaseSyncStatistics<SyncStatisticsT>,
+    SyncOptionsT extends BaseSyncOptions<ResourceT, ResourceDraftT, ResourceUpdateActionT>> {
   protected final SyncStatisticsT statistics;
   protected final SyncOptionsT syncOptions;
 

src/main/java/com/commercetools/sync/commons/BaseSync.java

@@ -3,7 +3,6 @@
 import static org.apache.commons.lang3.StringUtils.isBlank;
 
 import com.commercetools.api.models.common.AssetDraft;
-import com.commercetools.api.models.common.Reference;
 import com.commercetools.api.models.common.ResourceIdentifier;
 import com.commercetools.api.models.customer.CustomerDraft;
 import com.commercetools.api.models.type.CustomFieldsDraft;
@@ -70,14 +69,6 @@ protected void collectReferencedKeysFromAssetDrafts(
     }
   }
 
-  protected <T> void collectReferencedKeyFromReference(
-      @Nullable final Reference reference, @Nonnull final Consumer<String> keyInReferenceSupplier) {
-
-    if (reference != null && !isBlank(reference.getId())) {
-      keyInReferenceSupplier.accept(reference.getId());
-    }
-  }
-
   protected void handleError(@Nonnull final SyncException syncException) {
     this.syncOptions.applyErrorCallback(syncException);
     this.syncStatistics.incrementFailed();

src/main/java/com/commercetools/sync/commons/helpers/BaseBatchValidator.java

@@ -6,7 +6,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 import javax.annotation.Nonnull;
 
-public abstract class BaseSyncStatistics {
+public abstract class BaseSyncStatistics<SyncStatisticsT extends BaseSyncStatistics> {
   private AtomicInteger updated;
   private AtomicInteger created;
   private AtomicInteger failed;
@@ -280,6 +280,29 @@ public long getLatestBatchProcessingTimeInMillis() {
    */
   public abstract String getReportMessage();
 
+  /**
+   * Gets the name of the implementation class extending this abstract class. This name is then
+   * serialized into JSON and stored in the custom object of the last sync statistics. Later we
+   * could use this name to deserialize the custom object into the correct implementation class.
+   *
+   * @return name of the implementation class extending this abstract class.
+   */
+  public String getSyncStatisticsClassName() {
+    return getThis().getClass().getName();
+  }
+
+  /**
+   * Returns {@code this} instance of {@code T}, which extends {@link
+   * com.commercetools.sync.commons.helpers.BaseSyncStatistics}. The purpose of this method is to
+   * make sure that {@code this} is an instance of a class which extends {@link
+   * com.commercetools.sync.commons.helpers.BaseSyncStatistics} in order to be used in the generic
+   * methods of the class. Otherwise, without this method, the methods above would need to cast
+   * {@code this to T} which could lead to a runtime error of the class was extended in a wrong way.
+   *
+   * @return an instance of the class that overrides this method.
+   */
+  protected abstract SyncStatisticsT getThis();
+
   /**
    * Builds a proper summary message of the statistics report of a given {@code resourceString} in
    * following format:

src/main/java/com/commercetools/sync/commons/helpers/BaseSyncStatistics.java

@@ -3,8 +3,8 @@
 import static com.commercetools.sync.commons.utils.CompletableFutureUtils.collectionOfFuturesToFutureOfCollection;
 import static java.util.stream.Collectors.toList;
 
+import com.commercetools.api.client.PagedQueryResourceRequest;
 import com.commercetools.api.client.ProjectApiRoot;
-import com.commercetools.api.models.PagedQueryResourceRequest;
 import com.commercetools.api.models.graph_ql.GraphQLRequest;
 import com.commercetools.api.models.graph_ql.GraphQLResponse;
 import io.vrap.rmf.base.client.ApiHttpResponse;
@@ -24,16 +24,21 @@ public class ChunkUtils {
    *
    * @param requests A list of {@link PagedQueryResourceRequest} implementation to allow {@link
    *     ProjectApiRoot} to execute queries on CTP.
-   * @param <ResourceT> the type of the underlying model.
-   * @param <QueryT> the type of the request model.
+   * @param <ResourceT> the type of the request model.
+   * @param <ResultT> the type of the underlying model.
+   * @param <QueryBuilderDslT> the type of the query builder dsl class (e.g.
+   *     CartDiscountQueryBuilderDsl, CustomerQueryBuilderDsl, ...).
    * @return a list of lists where each list represents the results of passed {@link
    *     PagedQueryResourceRequest}.
    */
-  public static <QueryT extends PagedQueryResourceRequest<QueryT, ResourceT>, ResourceT>
-      CompletableFuture<List<ApiHttpResponse<ResourceT>>> executeChunks(
-          @Nonnull final List<QueryT> requests) {
+  public static <
+          ResourceT extends PagedQueryResourceRequest<ResourceT, ResultT, QueryBuilderDslT>,
+          ResultT,
+          QueryBuilderDslT>
+      CompletableFuture<List<ApiHttpResponse<ResultT>>> executeChunks(
+          @Nonnull final List<ResourceT> requests) {
 
-    final List<CompletableFuture<ApiHttpResponse<ResourceT>>> futures =
+    final List<CompletableFuture<ApiHttpResponse<ResultT>>> futures =
         requests.stream().map(request -> request.execute()).collect(toList());
 
     return collectionOfFuturesToFutureOfCollection(futures, toList());