rdblue commented on a change in pull request #4245: URL: https://github.com/apache/iceberg/pull/4245#discussion_r821295450
########## File path: core/src/main/java/org/apache/iceberg/rest/HttpRESTClient.java ########## @@ -0,0 +1,288 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF 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 org.apache.iceberg.rest; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.io.IOException; +import java.net.URI; +import java.util.Map; +import java.util.Optional; +import java.util.function.Consumer; +import javax.annotation.Nullable; +import org.apache.hc.client5.http.classic.methods.HttpUriRequest; +import org.apache.hc.client5.http.classic.methods.HttpUriRequestBase; +import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; +import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse; +import org.apache.hc.client5.http.impl.classic.HttpClients; +import org.apache.hc.core5.http.ContentType; +import org.apache.hc.core5.http.HttpHeaders; +import org.apache.hc.core5.http.HttpStatus; +import org.apache.hc.core5.http.Method; +import org.apache.hc.core5.http.ParseException; +import org.apache.hc.core5.http.impl.EnglishReasonPhraseCatalog; +import org.apache.hc.core5.http.io.entity.EntityUtils; +import org.apache.hc.core5.http.io.entity.StringEntity; +import org.apache.hc.core5.io.CloseMode; +import org.apache.iceberg.exceptions.RESTException; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.rest.responses.ErrorResponse; +import org.apache.iceberg.rest.responses.ErrorResponseParser; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An HttpClient for usage with the REST catalog. + */ +public class HttpRESTClient implements RESTClient { + + private static final Logger LOG = LoggerFactory.getLogger(HttpRESTClient.class); + + private final String uri; + private final CloseableHttpClient httpClient; + private final ObjectMapper mapper; + private final Map<String, String> additionalHeaders; + private final Consumer<HttpUriRequest> requestInterceptor; + + private HttpRESTClient( + String uri, + CloseableHttpClient httpClient, + ObjectMapper mapper, + Map<String, String> additionalHeaders, + Consumer<HttpUriRequest> requestInterceptor) { + this.uri = uri; + this.httpClient = httpClient != null ? httpClient : HttpClients.createDefault(); + this.mapper = mapper != null ? mapper : new ObjectMapper(); + this.additionalHeaders = additionalHeaders != null ? additionalHeaders : ImmutableMap.of(); + this.requestInterceptor = requestInterceptor; + } + + private static Optional<String> extractResponseBodyAsString(CloseableHttpResponse response, Class<?> responseType) { + try { + if (response.getEntity() == null) { + return Optional.empty(); + } + return Optional.ofNullable(EntityUtils.toString(response.getEntity(), "UTF-8")); + } catch (IOException | ParseException e) { + if (responseType != null) { + LOG.warn("Failed to convert HTTP response body to string", e); + } + return Optional.empty(); + } + } + + // Per the spec, the only currently defined / used "success" responses are 200 and 202. + private static boolean isSuccessful(CloseableHttpResponse response) { + int code = response.getCode(); + return code == HttpStatus.SC_OK || code == HttpStatus.SC_ACCEPTED; + } + + private static ErrorResponse buildDefaultErrorResponse(CloseableHttpResponse response) { + String responseReason = response.getReasonPhrase(); + String message = + responseReason != null && !responseReason.isEmpty() ? responseReason : + EnglishReasonPhraseCatalog.INSTANCE.getReason(response.getCode(), null /* ignored */); + String type = "ClientGeneratedErrorResponse - No error response body could be parsed"; + return ErrorResponse.builder() + .responseCode(response.getCode()) + .withMessage(message) + .withType(type) + .build(); + } + + private static ErrorResponse parseOrCreateErrorResponse( + CloseableHttpResponse response, Optional<String> responseBody, Method method, Class<?> responseType) { + try { + return responseBody.map(ErrorResponseParser::fromJson).orElseGet(() -> buildDefaultErrorResponse(response)); + } catch (Exception e) { + // Only log a warning that we couldn't parse an error response if some response body was expected + if (responseType != null) { + LOG.warn( + "Failed to parse standard error response for {} call expecting {} response. Creating one instead", + method, responseType.getSimpleName(), e); + } + + return buildDefaultErrorResponse(response); + } + } + + /** + * Method to execute an HTTP request and process the corresponding response. + * + * @param method - HTTP method, such as GET, POST, HEAD, etc. + * @param path - URL path to send the request to + * @param requestBody - Content to place in the request body + * @param responseType - Class of the Response type. Needs to have serializer registered with ObjectMapper + * @param errorHandler - Error handler delegated for HTTP responses which handles server error responses + * @param <T> - Class type of the response for deserialization. Must be registered with the ObjectMapper. + * @return The response entity, parsed and converted to its type T + */ + @Nullable + public <T> T execute( + Method method, String path, Object requestBody, Class<T> responseType, Consumer<ErrorResponse> errorHandler) { + if (path.startsWith("/")) { + throw new RESTException( + "Received a malformed path for a REST request: %s. Paths should not start with /", path); + } + + // TODO - Add RESTUtil.stripTrailingSlash call on uri once PR #4244 is merged and update associated RESTClient + // tests that have special slash handling when using mock-server. + String fullUri = String.format("%s/%s", uri, path); + HttpUriRequestBase request = new HttpUriRequestBase(method.name(), URI.create(fullUri)); + addRequestHeaders(request); + + if (requestBody != null) { + try { + StringEntity stringEntity = new StringEntity(mapper.writeValueAsString(requestBody)); + request.setEntity(stringEntity); + } catch (JsonProcessingException e) { + throw new RESTException(e, "Failed to write request requestBody: %s", requestBody); + } + } + + requestInterceptor.accept(request); + + try (CloseableHttpResponse response = httpClient.execute(request)) { + + Optional<String> responseBody = extractResponseBodyAsString(response, responseType); + + if (!isSuccessful(response)) { + ErrorResponse errorResponse = parseOrCreateErrorResponse(response, responseBody, method, responseType); + errorHandler.accept(errorResponse); + } + + // Successful calls + if (responseType == null) { + return null; + } + + String extractedBody = responseBody.orElseGet(() -> { + throw new RESTException( + "Received a success response code of %d, but failed to extract response body to parse object of type %s", + response.getCode(), responseType.getSimpleName()); + }); + + try { + return mapper.readValue(extractedBody, responseType); + } catch (JsonProcessingException e) { + throw new RESTException( + "Received a success response code of %d, but failed to parse response body into %s", + response.getCode(), responseType.getSimpleName()); + } + } catch (IOException e) { + throw new RESTException("Error occurred while processing %s request", method); Review comment: Exceptions should almost never ignore the caught exception. It is always better to wrap it as a cause. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
