HSEARCH-5464 Move out client common classes

Author: marko-bekhta

backend/elasticsearch-client/common/pom.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    SPDX-License-Identifier: Apache-2.0
+    Copyright Red Hat Inc. and Hibernate Authors
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.hibernate.search</groupId>
+        <artifactId>hibernate-search-parent-public</artifactId>
+        <version>8.2.0-SNAPSHOT</version>
+        <relativePath>../../../build/parents/public</relativePath>
+    </parent>
+    <artifactId>hibernate-search-backend-elasticsearch-client-common</artifactId>
+
+    <name>Hibernate Search Backend - Elasticsearch Client SPI</name>
+    <description>Rest client SPI for the Elasticsearch backend</description>
+
+    <properties>
+        <!-- This is a publicly distributed module that should be published: -->
+        <deploy.skip>false</deploy.skip>
+        <java.module.name>org.hibernate.search.backend.elasticsearch.client.common</java.module.name>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.hibernate.search</groupId>
+            <artifactId>hibernate-search-engine</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.jboss.logging</groupId>
+            <artifactId>jboss-logging</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.jboss.logging</groupId>
+            <artifactId>jboss-logging-annotations</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.google.code.gson</groupId>
+            <artifactId>gson</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.moditect</groupId>
+                <artifactId>moditect-maven-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+</project>

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/gson/spi/GsonProvider.java renamed to backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/gson/spi/GsonProvider.java

@@ -2,15 +2,11 @@
  * SPDX-License-Identifier: Apache-2.0
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.search.backend.elasticsearch.gson.spi;
+package org.hibernate.search.backend.elasticsearch.client.common.gson.spi;
 
 import java.util.Set;
 import java.util.function.Supplier;
 
-import org.hibernate.search.backend.elasticsearch.lowlevel.index.mapping.impl.RootTypeMapping;
-import org.hibernate.search.backend.elasticsearch.lowlevel.index.settings.impl.IndexSettings;
-import org.hibernate.search.util.common.impl.CollectionHelper;
-
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.reflect.TypeToken;
@@ -21,24 +17,18 @@
 public final class GsonProvider {
 
 	/*
-	 * See https://github.com/google/gson/issues/764.
-	 *
-	 * Only composite type adapters (referring to another type adapter)
-	 * should be affected by this bug, so we'll list the corresponding types here.
-	 * Maybe it's even narrower, and only type adapters that indirectly refer to themselves are affected,
-	 * but I'm not entirely sure about that.
-	 *
-	 * Note we only need to list "root" types:
-	 * all types they refer to will also have their type adapter initialized.
+	 * https://github.com/google/gson/issues/764 is supposedly fixed.
+	 * Hence, we may not need the workaround anymore.
+	 * This version will be used in the test so we'll notice if things are still broken, for the main code
+	 * the workaround is in place through the GsonProviderHelper.
 	 */
-	private static final Set<TypeToken<?>> TYPES_CAUSING_GSON_CONCURRENT_INITIALIZATION_BUG =
-			CollectionHelper.asImmutableSet(
-					TypeToken.get( IndexSettings.class ),
-					TypeToken.get( RootTypeMapping.class )
-			);
-
 	public static GsonProvider create(Supplier<GsonBuilder> builderBaseSupplier, boolean logPrettyPrinting) {
-		return new GsonProvider( builderBaseSupplier, logPrettyPrinting );
+		return create( builderBaseSupplier, logPrettyPrinting, Set.of() );
+	}
+
+	public static GsonProvider create(Supplier<GsonBuilder> builderBaseSupplier, boolean logPrettyPrinting,
+			Set<TypeToken<?>> typeTokensToInit) {
+		return new GsonProvider( builderBaseSupplier, logPrettyPrinting, typeTokensToInit );
 	}
 
 	private final Gson gson;
@@ -47,16 +37,17 @@ public static GsonProvider create(Supplier<GsonBuilder> builderBaseSupplier, boo
 
 	private final JsonLogHelper logHelper;
 
-	private GsonProvider(Supplier<GsonBuilder> builderBaseSupplier, boolean logPrettyPrinting) {
+	private GsonProvider(Supplier<GsonBuilder> builderBaseSupplier, boolean logPrettyPrinting,
+			Set<TypeToken<?>> typeTokensToInit) {
 		// Null serialization needs to be enabled to index null fields
 		gson = builderBaseSupplier.get()
 				.serializeNulls()
 				.create();
-		initializeTypeAdapters( gson );
+		initializeTypeAdapters( gson, typeTokensToInit );
 
 		gsonNoSerializeNulls = builderBaseSupplier.get()
 				.create();
-		initializeTypeAdapters( gsonNoSerializeNulls );
+		initializeTypeAdapters( gsonNoSerializeNulls, typeTokensToInit );
 
 		logHelper = JsonLogHelper.create( builderBaseSupplier.get(), logPrettyPrinting );
 	}
@@ -81,8 +72,8 @@ public JsonLogHelper getLogHelper() {
 	 * We just initialize every adapter known to cause problems before we make the Gson object
 	 * available to multiple threads.
 	 */
-	private static void initializeTypeAdapters(Gson gson) {
-		for ( TypeToken<?> typeToken : TYPES_CAUSING_GSON_CONCURRENT_INITIALIZATION_BUG ) {
+	private static void initializeTypeAdapters(Gson gson, Set<TypeToken<?>> typeTokensToInit) {
+		for ( TypeToken<?> typeToken : typeTokensToInit ) {
 			gson.getAdapter( typeToken );
 		}
 	}

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/gson/spi/JsonLogHelper.java renamed to backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/gson/spi/JsonLogHelper.java

@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: Apache-2.0
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.search.backend.elasticsearch.gson.spi;
+package org.hibernate.search.backend.elasticsearch.client.common.gson.spi;
 
 import java.io.PrintWriter;
 import java.io.StringWriter;

backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/package-info.java

@@ -0,0 +1 @@
+package org.hibernate.search.backend.elasticsearch.client.common;

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/client/spi/ElasticsearchClient.java renamed to backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/spi/ElasticsearchClient.java

@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: Apache-2.0
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.search.backend.elasticsearch.client.spi;
+package org.hibernate.search.backend.elasticsearch.client.common.spi;
 
 import java.util.concurrent.CompletableFuture;
 

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/client/spi/ElasticsearchClientFactory.java renamed to backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/spi/ElasticsearchClientFactory.java

@@ -2,27 +2,23 @@
  * SPDX-License-Identifier: Apache-2.0
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.search.backend.elasticsearch.client.spi;
+package org.hibernate.search.backend.elasticsearch.client.common.spi;
 
-import java.util.Optional;
-
-import org.hibernate.search.backend.elasticsearch.ElasticsearchVersion;
-import org.hibernate.search.backend.elasticsearch.gson.spi.GsonProvider;
+import org.hibernate.search.backend.elasticsearch.client.common.gson.spi.GsonProvider;
 import org.hibernate.search.engine.cfg.ConfigurationPropertySource;
 import org.hibernate.search.engine.common.execution.spi.SimpleScheduledExecutor;
 import org.hibernate.search.engine.environment.bean.BeanResolver;
 import org.hibernate.search.engine.environment.thread.spi.ThreadProvider;
 
 /**
  * Creates the Elasticsearch client.
- *
  */
 public interface ElasticsearchClientFactory {
 
-	ElasticsearchClientImplementor create(BeanResolver beanResolver, ConfigurationPropertySource propertySource,
+	ElasticsearchClientImplementor create(BeanResolver beanResolver,
+			ConfigurationPropertySource propertySource,
 			ThreadProvider threadProvider, String threadNamePrefix,
 			SimpleScheduledExecutor timeoutExecutorService,
-			GsonProvider gsonProvider,
-			Optional<ElasticsearchVersion> configuredVersion);
+			GsonProvider gsonProvider);
 
 }

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/client/spi/ElasticsearchClientImplementor.java renamed to backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/spi/ElasticsearchClientImplementor.java

@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: Apache-2.0
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.search.backend.elasticsearch.client.spi;
+package org.hibernate.search.backend.elasticsearch.client.common.spi;
 
 /**
  * An interface allowing to close an {@link ElasticsearchClient}.

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/client/spi/ElasticsearchRequest.java renamed to backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/spi/ElasticsearchRequest.java

@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: Apache-2.0
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.search.backend.elasticsearch.client.spi;
+package org.hibernate.search.backend.elasticsearch.client.common.spi;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -12,7 +12,7 @@
 import java.util.Map;
 import java.util.StringJoiner;
 
-import org.hibernate.search.backend.elasticsearch.util.spi.URLEncodedString;
+import org.hibernate.search.backend.elasticsearch.client.common.util.spi.URLEncodedString;
 import org.hibernate.search.engine.common.timing.Deadline;
 
 import com.google.gson.JsonObject;

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/client/spi/ElasticsearchResponse.java renamed to backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/spi/ElasticsearchResponse.java

@@ -2,9 +2,7 @@
  * SPDX-License-Identifier: Apache-2.0
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.search.backend.elasticsearch.client.spi;
-
-import java.util.Objects;
+package org.hibernate.search.backend.elasticsearch.client.common.spi;
 
 import com.google.gson.JsonObject;
 

backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/util/spi/URLEncodedString.java renamed to backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/util/spi/URLEncodedString.java

@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: Apache-2.0
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.search.backend.elasticsearch.util.spi;
+package org.hibernate.search.backend.elasticsearch.client.common.util.spi;
 
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;