chore(java): add api compat check (#1335)

Author: aallam

.github/.cache_version

@@ -1 +1 @@
-0.0.17
+0.0.18

.github/workflows/check.yml

@@ -232,6 +232,10 @@ jobs:
         if: ${{ steps.cache.outputs.cache-hit != 'true' && matrix.client.language == 'javascript' && contains(matrix.client.toRun,'algoliasearch') }}
         run: cd ${{ matrix.client.path }} && yarn workspace algoliasearch test
 
+      - name: Run Java 'algoliasearch' public API validation
+        if: ${{ steps.cache.outputs.cache-hit != 'true' && matrix.client.language == 'java' }}
+        run: cd ${{ matrix.client.path }} && ./gradlew :api:japicmp
+
       - name: Remove previous CTS output
         run: rm -rf ${{ matrix.client.testsToDelete }} || true
 

.gitignore

@@ -30,3 +30,4 @@ dist
 
 generators/bin
 
+**/java/bin/

clients/algoliasearch-client-java-2/api/build.gradle

@@ -0,0 +1,39 @@
+// This package is to check the public API (binary) compatibility of the latest
+// published release with `algoliasearch-client-java` package.
+
+import me.champeau.gradle.japicmp.JapicmpTask
+
+plugins {
+  id 'java-library'
+  id 'me.champeau.gradle.japicmp' version '0.4.1'
+}
+
+repositories {
+  maven { url = "https://oss.sonatype.org/content/repositories/snapshots/" }
+  mavenCentral()
+}
+
+def baselineConfig = configurations.register('baseline')
+def latestConfig = configurations.register('latest')
+
+dependencies {
+  baseline('com.algolia:algoliasearch-client-java:4.+') {
+    transitive = false
+  }
+  latest(projects.algoliasearchCore)
+}
+
+def japicmp = tasks.register('japicmp', JapicmpTask) {
+  dependsOn tasks.findByName("jar")
+  oldClasspath.setFrom(baselineConfig)
+  newClasspath.setFrom(latestConfig)
+  onlyBinaryIncompatibleModified.set(true)
+  failOnModification.set(true)
+  txtOutputFile.set(file("$buildDir/reports/japi.txt"))
+  ignoreMissingClasses.set(true)
+  includeSynthetic.set(true)
+}
+
+tasks.findByName('check').configure {
+  dependsOn japicmp
+}

clients/algoliasearch-client-java-2/settings.gradle

@@ -1,3 +1,6 @@
 rootProject.name = "algoliasearch-client-java"
 
 include(":algoliasearch-core")
+include(":api")
+
+enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")