Refactor error handling

Author: swallez

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

@@ -19,14 +19,15 @@
 
 package co.elastic.clients.base;
 
+import co.elastic.clients.elasticsearch._types.ErrorResponse;
 import co.elastic.clients.json.JsonpDeserializer;
 import org.apache.http.client.utils.URLEncodedUtils;
 
 import java.util.Collections;
 import java.util.Map;
 import java.util.function.Function;
 
-public class SimpleEndpoint<RequestT, ResponseT> implements Endpoint<RequestT, ResponseT, ElasticsearchError> {
+public class SimpleEndpoint<RequestT, ResponseT> implements Endpoint<RequestT, ResponseT, ErrorResponse> {
 
  private static final Function<?, Map<String, String>> EMPTY_MAP = x -> Collections.emptyMap();
 
@@ -99,8 +100,8 @@ public boolean isError(int statusCode) {
  }
 
  @Override
- public JsonpDeserializer<ElasticsearchError> errorParser(int statusCode) {
- return ElasticsearchError._DESERIALIZER;
+ public JsonpDeserializer<ErrorResponse> errorParser(int statusCode) {
+ return ErrorResponse._DESERIALIZER;
  }
 
  public <NewResponseT> SimpleEndpoint<RequestT, NewResponseT> withResponseDeserializer(

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

@@ -19,12 +19,13 @@
 
 package co.elastic.clients.base.rest_client;
 
-import co.elastic.clients.base.ApiException;
 import co.elastic.clients.base.BooleanEndpoint;
 import co.elastic.clients.base.BooleanResponse;
 import co.elastic.clients.base.ElasticsearchCatRequest;
+import co.elastic.clients.elasticsearch.ElasticsearchException;
 import co.elastic.clients.base.Endpoint;
 import co.elastic.clients.base.Transport;
+import co.elastic.clients.elasticsearch._types.ErrorResponse;
 import co.elastic.clients.json.JsonpDeserializer;
 import co.elastic.clients.json.JsonpMapper;
 import co.elastic.clients.json.NdJsonpSerializable;
@@ -222,7 +223,8 @@ private <ResponseT, ErrorT> ResponseT getHighLevelResponse(
  error = errorParser.deserialize(parser, mapper);
  }
 
- throw new ApiException(error);
+ // TODO: have the endpoint provide the exception contructor
+ throw new ElasticsearchException((ErrorResponse) error);
 
  } else if (endpoint instanceof BooleanEndpoint) {
  BooleanEndpoint<?> bep = (BooleanEndpoint<?>)endpoint;

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

@@ -0,0 +1,60 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package co.elastic.clients.elasticsearch;
+
+import co.elastic.clients.elasticsearch._types.ErrorCause;
+import co.elastic.clients.elasticsearch._types.ErrorResponse;
+
+/**
+ * Exception thrown by API client methods when Elasticsearch could not accept or process a request.
+ * <p>
+ * The {@link #error()} contains the error's type and reason along with additional details that depend on the error type and
+ * the API endpoint that was called.
+ */
+public class ElasticsearchException extends RuntimeException {
+
+ private final ErrorResponse response;
+
+ public ElasticsearchException(ErrorResponse response) {
+ super(response.error().reason());
+ this.response = response;
+ }
+
+ /**
+ * The error response sent by Elasticsearch
+ */
+ public ErrorResponse response() {
+ return this.response;
+ }
+
+ /**
+ * The cause of the error. Shortcut for {@code response().error()}.
+ */
+ public ErrorCause error() {
+ return this.response.error();
+ }
+
+ /**
+ * Status code returned by Elasticsearch. Shortcut for {@code response().status()}.
+ */
+ public int status() {
+ return this.response.status();
+ }
+}

java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchException.java

@@ -35,6 +35,11 @@ class JsonDataImpl implements JsonData {
  this.mapper = mapper;
  }
 
+ @Override
+ public String toString() {
+ return value.toString();
+ }
+
  @Override
  public JsonValue toJson() {
  return toJson(null);

java-client/src/main/java/co/elastic/clients/json/JsonDataImpl.java

@@ -19,9 +19,8 @@
 
 package co.elastic.clients.elasticsearch.end_to_end;
 
-import co.elastic.clients.base.ApiException;
 import co.elastic.clients.base.BooleanResponse;
-import co.elastic.clients.base.ElasticsearchError;
+import co.elastic.clients.elasticsearch.ElasticsearchException;
 import co.elastic.clients.base.rest_client.RestClientTransport;
 import co.elastic.clients.base.Transport;
 import co.elastic.clients.elasticsearch.ElasticsearchAsyncClient;
@@ -257,10 +256,10 @@ public void testRefresh() throws IOException {
  GetResponse<String> response = client.get(
  _0 -> _0.index("doesnotexist").id("reallynot"), String.class
  );
- } catch(ApiException apie) {
- ElasticsearchError error = (ElasticsearchError) apie.error();
- assertEquals(404, error.status());
- assertEquals("index_not_found_exception", error.error().asJsonObject().getString("type"));
+ } catch(ElasticsearchException ex) {
+ assertEquals(404, ex.status());
+ assertEquals("index_not_found_exception", ex.error().type());
+ assertEquals("doesnotexist", ex.error().metadata().get("index").to(String.class));
  }
 
  try {
@@ -269,10 +268,9 @@ public void testRefresh() throws IOException {
  _0 -> _0.index("doesnotexist").id("reallynot"), String.class
  ).get();
  } catch(ExecutionException ee) {
- ApiException apie = ((ApiException) ee.getCause());
- ElasticsearchError error = (ElasticsearchError) apie.error();
- assertEquals(404, error.status());
- assertEquals("index_not_found_exception", error.error().asJsonObject().getString("type"));
+ ElasticsearchException ex = ((ElasticsearchException) ee.getCause());
+ assertEquals(404, ex.status());
+ assertEquals("index_not_found_exception", ex.error().type());
  }
  }
 

java-client/src/test/java/co/elastic/clients/elasticsearch/end_to_end/RequestTest.java

@@ -19,9 +19,9 @@
 
 package co.elastic.clients.elasticsearch.experiments.api;
 
-import co.elastic.clients.base.ElasticsearchError;
 import co.elastic.clients.base.Endpoint;
 import co.elastic.clients.base.SimpleEndpoint;
+import co.elastic.clients.elasticsearch._types.ErrorResponse;
 import co.elastic.clients.json.JsonpMapper;
 import co.elastic.clients.json.JsonpSerializable;
 import co.elastic.clients.util.ObjectBuilder;
@@ -257,7 +257,7 @@ public FooOptRequest build() {
 // PARSER = new ObjectBuilderParser<>(op);
 // }
 
- public static final Endpoint<FooOptRequest, FooResponse, ElasticsearchError> ENDPOINT =
+ public static final Endpoint<FooOptRequest, FooResponse, ErrorResponse> ENDPOINT =
  new SimpleEndpoint<FooOptRequest, FooResponse>(
  r -> "POST",
  r -> "/foo",

java-client/src/test/java/co/elastic/clients/elasticsearch/experiments/api/FooOptRequest.java

@@ -19,9 +19,9 @@
 
 package co.elastic.clients.elasticsearch.experiments.api;
 
-import co.elastic.clients.base.ElasticsearchError;
 import co.elastic.clients.base.Endpoint;
 import co.elastic.clients.base.SimpleEndpoint;
+import co.elastic.clients.elasticsearch._types.ErrorResponse;
 import co.elastic.clients.elasticsearch.experiments.api.query.Query;
 import co.elastic.clients.json.JsonpDeserializer;
 import co.elastic.clients.json.JsonpMapper;
@@ -297,7 +297,7 @@ public static JsonpDeserializer<FooRequest> parser() {
  // Endpoint
  //===========================================
 
- public static final Endpoint<FooRequest, FooResponse, ElasticsearchError> ENDPOINT =
+ public static final Endpoint<FooRequest, FooResponse, ErrorResponse> ENDPOINT =
  new SimpleEndpoint<>(
  r -> "POST",
  r -> "/foo",

java-client/src/test/java/co/elastic/clients/elasticsearch/experiments/api/FooRequest.java

@@ -19,9 +19,9 @@
 
 package co.elastic.clients.elasticsearch.experiments.generics;
 
-import co.elastic.clients.base.ElasticsearchError;
 import co.elastic.clients.base.Endpoint;
 import co.elastic.clients.base.SimpleEndpoint;
+import co.elastic.clients.elasticsearch._types.ErrorResponse;
 import co.elastic.clients.json.DelegatingDeserializer;
 import co.elastic.clients.json.JsonpDeserializer;
 import co.elastic.clients.json.JsonpMapper;
@@ -100,7 +100,7 @@ private static <GenParam> void setupParser(DelegatingDeserializer<Builder<GenPar
  }
 
 
- public static <GenParam> Endpoint<Boolean, GenericClass<GenParam>, ElasticsearchError> endpoint(
+ public static <GenParam> Endpoint<Boolean, GenericClass<GenParam>, ErrorResponse> endpoint(
  JsonpDeserializer<GenParam> genParamDeserializer
  ) {
  return new SimpleEndpoint<>(