Add support for variants, refactorings to improve DX

- Add runtime support for variants (wrapping key decoding, property lookahead) - Simplify transport API and remove dependency on LLRC for request options - Add JsonpDeserializable annotation - Lenient parsing of strings, numbers and arrays - Add tests

Author: swallez

java-client/build.gradle.kts

@@ -135,6 +135,7 @@ dependencies {
  compileOnly("com.fasterxml.jackson.core", "jackson-databind", jacksonVersion)
  testImplementation("com.fasterxml.jackson.core", "jackson-core", jacksonVersion)
  testImplementation("com.fasterxml.jackson.core", "jackson-databind", jacksonVersion)
+ testImplementation("io.github.classgraph:classgraph:4.8.116")
 
  // EPL-2.0 OR BSD-3-Clause
  // https://eclipse-ee4j.github.io/yasson/

java-client/src/main/java/co/elastic/clients/base/AdditionalProperties.java

@@ -20,20 +20,20 @@
 package co.elastic.clients.base;
 
 import co.elastic.clients.json.DelegatingDeserializer;
-import co.elastic.clients.json.ObjectDeserializer;
+import co.elastic.clients.json.JsonpDeserializer;
 import co.elastic.clients.json.JsonpMapper;
+import co.elastic.clients.json.JsonpSerializable;
 import co.elastic.clients.json.JsonpSerializer;
 import co.elastic.clients.json.JsonpUtils;
-import co.elastic.clients.json.JsonpDeserializer;
-import co.elastic.clients.json.ToJsonp;
+import co.elastic.clients.json.ObjectDeserializer;
+import jakarta.json.stream.JsonGenerator;
 
 import javax.annotation.Nullable;
-import jakarta.json.stream.JsonGenerator;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
-public abstract class AdditionalProperties<TKey, TValue> implements ToJsonp {
+public abstract class AdditionalProperties<TKey, TValue> implements JsonpSerializable {
  private final Map<String, TValue> value;
 
  @Nullable
@@ -62,7 +62,7 @@ public Map<String, TValue> value() {
  /**
  * Serialize this value to JSON.
  */
- public void toJsonp(JsonGenerator generator, JsonpMapper mapper) {
+ public void serialize(JsonGenerator generator, JsonpMapper mapper) {
  generator.writeStartObject();
  this.toJsonpInternal(generator, mapper);
  generator.writeEnd();

java-client/src/main/java/co/elastic/clients/base/ApiClient.java

@@ -20,33 +20,27 @@
 package co.elastic.clients.base;
 
 import co.elastic.clients.json.JsonpDeserializer;
-import org.elasticsearch.client.RequestOptions;
+import co.elastic.clients.json.JsonpMapperBase;
 
-import javax.annotation.Nullable;
-
-public abstract class ApiClient<Self extends ApiClient<Self>> {
+public abstract class ApiClient {
 
  protected final Transport transport;
 
- @Nullable
- protected final RequestOptions requestOptions;
-
- protected ApiClient(Transport transport, @Nullable RequestOptions requestOptions) {
+ protected ApiClient(Transport transport) {
  this.transport = transport;
- this.requestOptions = requestOptions;
  }
 
- /**
- * Creates a new client with some request options
- */
- public abstract Self withRequestOptions(@Nullable RequestOptions requestOptions);
+ protected <T> JsonpDeserializer<T> getDeserializer(Class<T> clazz) {
+ // Try the built-in deserializers first to avoid repeated lookups in the Jsonp mapper for client-defined classes
+ JsonpDeserializer<T> result = JsonpMapperBase.findDeserializer(clazz);
+ if (result != null) {
+ return result;
+ }
 
- @Nullable
- public final RequestOptions requestOptions() {
- return this.requestOptions;
+ return JsonpDeserializer.of(clazz);
  }
 
- protected <T> JsonpDeserializer<T> getDeserializer(Class<T> clazz) {
- return transport.jsonpMapper().getDeserializer(clazz);
+ public Transport _transport() {
+ return this.transport;
  }
 }

java-client/src/main/java/co/elastic/clients/base/ElasticsearchError.java

@@ -19,8 +19,8 @@
 
 package co.elastic.clients.base;
 
-import co.elastic.clients.json.ObjectDeserializer;
 import co.elastic.clients.json.JsonpDeserializer;
+import co.elastic.clients.json.ObjectDeserializer;
 
 public class ElasticsearchError {
 

java-client/src/main/java/co/elastic/clients/base/RestClientTransport.java

@@ -19,9 +19,11 @@
 
 package co.elastic.clients.base;
 
-import co.elastic.clients.json.JsonpMapper;
 import co.elastic.clients.json.JsonpDeserializer;
-import co.elastic.clients.json.ToJsonp;
+import co.elastic.clients.json.JsonpMapper;
+import co.elastic.clients.json.JsonpSerializable;
+import jakarta.json.stream.JsonGenerator;
+import jakarta.json.stream.JsonParser;
 import org.apache.http.entity.ByteArrayEntity;
 import org.apache.http.entity.ContentType;
 import org.elasticsearch.client.Cancellable;
@@ -30,23 +32,50 @@
 import org.elasticsearch.client.ResponseListener;
 import org.elasticsearch.client.RestClient;
 
-import jakarta.json.stream.JsonGenerator;
-import jakarta.json.stream.JsonParser;
+import javax.annotation.Nullable;
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
+import java.util.function.Function;
 
 public class RestClientTransport implements Transport {
 
  private final RestClient restClient;
  private final JsonpMapper mapper;
+ private RequestOptions requestOptions;
 
- public RestClientTransport(RestClient restClient, JsonpMapper mapper) {
+ public RestClientTransport(RestClient restClient, JsonpMapper mapper, @Nullable RequestOptions options) {
  this.restClient = restClient;
  this.mapper = mapper;
+ this.requestOptions = options;
+ }
+
+ public RestClientTransport(RestClient restClient, JsonpMapper mapper) {
+ this(restClient, mapper, null);
+ }
+
+ /**
+ * Creates a new {@link #RestClientTransport} with specific request options.
+ */
+ public RestClientTransport withRequestOptions(@Nullable RequestOptions options) {
+ return new RestClientTransport(this.restClient, this.mapper, options);
+ }
+
+ /**
+ * Creates a new {@link #RestClientTransport} with specific request options, inheriting existing options.
+ *
+ * @param fn a function taking an options builder initialized with the current request options, or initialized
+ * with default values.
+ */
+ public RestClientTransport withRequestOptions(Function<RequestOptions.Builder, RequestOptions.Builder> fn) {
+ RequestOptions.Builder builder = requestOptions == null ?
+ RequestOptions.DEFAULT.toBuilder() :
+ requestOptions.toBuilder();
+
+ return withRequestOptions(fn.apply(builder).build());
  }
 
  @Override
@@ -56,21 +85,19 @@ public JsonpMapper jsonpMapper() {
 
  public <RequestT, ResponseT, ErrorT> ResponseT performRequest(
  RequestT request,
- Endpoint<RequestT, ResponseT, ErrorT> endpoint,
- RequestOptions options
+ Endpoint<RequestT, ResponseT, ErrorT> endpoint
  ) throws IOException {
 
- org.elasticsearch.client.Request clientReq = prepareLowLevelRequest(request, endpoint, options);
+ org.elasticsearch.client.Request clientReq = prepareLowLevelRequest(request, endpoint);
  org.elasticsearch.client.Response clientResp = restClient.performRequest(clientReq);
  return getHighLevelResponse(clientResp, endpoint);
  }
 
  public <RequestT, ResponseT, ErrorT> CompletableFuture<ResponseT> performRequestAsync(
  RequestT request,
- Endpoint<RequestT, ResponseT, ErrorT> endpoint,
- RequestOptions options
+ Endpoint<RequestT, ResponseT, ErrorT> endpoint
  ) {
- org.elasticsearch.client.Request clientReq = prepareLowLevelRequest(request, endpoint, options);
+ org.elasticsearch.client.Request clientReq = prepareLowLevelRequest(request, endpoint);
 
  RequestFuture<ResponseT> future = new RequestFuture<>();
 
@@ -109,24 +136,22 @@ public boolean cancel(boolean mayInterruptIfRunning) {
 
  private <RequestT> org.elasticsearch.client.Request prepareLowLevelRequest(
  RequestT request,
- Endpoint<RequestT, ?, ?> endpoint,
- RequestOptions options
- ) {
+ Endpoint<RequestT, ?, ?> endpoint) {
  String method = endpoint.method(request);
  String path = endpoint.requestUrl(request);
  Map<String, String> params = endpoint.queryParameters(request);
 
  org.elasticsearch.client.Request clientReq = new org.elasticsearch.client.Request(method, path);
  clientReq.addParameters(params);
- if (options != null) {
- clientReq.setOptions(options);
+ if (requestOptions != null) {
+ clientReq.setOptions(requestOptions);
  }
 
  if (endpoint.hasRequestBody()) {
- // Request has a body and must implement ToJsonp
+ // Request has a body and must implement JsonpSerializable
  ByteArrayOutputStream baos = new ByteArrayOutputStream();
- JsonGenerator generator = mapper.jsonpProvider().createGenerator(baos);
- ((ToJsonp) request).toJsonp(generator, mapper);
+ JsonGenerator generator = mapper.jsonProvider().createGenerator(baos);
+ ((JsonpSerializable) request).serialize(generator, mapper);
  generator.close();
 
  clientReq.setEntity(new ByteArrayEntity(baos.toByteArray(), ContentType.APPLICATION_JSON));
@@ -150,7 +175,7 @@ private <ResponseT, ErrorT> ResponseT getHighLevelResponse(
  // Expecting a body
  ByteArrayOutputStream baos = new ByteArrayOutputStream();
  clientResp.getEntity().writeTo(baos);
- JsonParser parser = mapper.jsonpProvider().createParser(new ByteArrayInputStream(baos.toByteArray()));
+ JsonParser parser = mapper.jsonProvider().createParser(new ByteArrayInputStream(baos.toByteArray()));
  error = errorParser.deserialize(parser, mapper);
  }
 
@@ -171,7 +196,7 @@ private <ResponseT, ErrorT> ResponseT getHighLevelResponse(
  if (responseParser != null) {
  // Expecting a body
  InputStream content = clientResp.getEntity().getContent();
- JsonParser parser = mapper.jsonpProvider().createParser(content);
+ JsonParser parser = mapper.jsonProvider().createParser(content);
  response = responseParser.deserialize(parser, mapper);
  }
  return response;

java-client/src/main/java/co/elastic/clients/base/Transport.java

@@ -20,7 +20,6 @@
 package co.elastic.clients.base;
 
 import co.elastic.clients.json.JsonpMapper;
-import org.elasticsearch.client.RequestOptions;
 
 import java.io.IOException;
 import java.util.concurrent.CompletableFuture;
@@ -32,14 +31,12 @@ public interface Transport {
 
  <RequestT, ResponseT, ErrorT> ResponseT performRequest(
  RequestT request,
- Endpoint<RequestT, ResponseT, ErrorT> endpoint,
- RequestOptions options
+ Endpoint<RequestT, ResponseT, ErrorT> endpoint
  ) throws IOException;
 
  <RequestT, ResponseT, ErrorT> CompletableFuture<ResponseT> performRequestAsync(
  RequestT request,
- Endpoint<RequestT, ResponseT, ErrorT> endpoint,
- RequestOptions options
+ Endpoint<RequestT, ResponseT, ErrorT> endpoint
  );
 
  JsonpMapper jsonpMapper();