MindeeHttpApiV2.java

package com.mindee.http;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.mindee.InferenceParameters;
import com.mindee.MindeeException;
import com.mindee.MindeeSettingsV2;
import com.mindee.input.LocalInputSource;
import com.mindee.input.URLInputSource;
import com.mindee.parsing.v2.CommonResponse;
import com.mindee.parsing.v2.ErrorResponse;
import com.mindee.parsing.v2.InferenceResponse;
import com.mindee.parsing.v2.JobResponse;
import java.io.IOException;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
import lombok.Builder;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.classic.methods.HttpPost;
import org.apache.hc.client5.http.config.RequestConfig;
import org.apache.hc.client5.http.entity.mime.HttpMultipartMode;
import org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.ContentType;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.core5.http.HttpHeaders;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.apache.hc.core5.net.URIBuilder;

/**
 * HTTP Client class for the V2 API.
 */
public final class MindeeHttpApiV2 extends MindeeApiV2 {

  private static final ObjectMapper mapper = new ObjectMapper();

  /**
   * The MindeeSetting needed to make the api call.
   */
  private final MindeeSettingsV2 mindeeSettings;
  /**
   * The HttpClientBuilder used to create HttpClient objects used to make api calls over http.
   * Defaults to HttpClientBuilder.create().useSystemProperties()
   */
  private final HttpClientBuilder httpClientBuilder;


  public MindeeHttpApiV2(MindeeSettingsV2 mindeeSettings) {
    this(
        mindeeSettings,
        null
    );
  }

  @Builder
  private MindeeHttpApiV2(
      MindeeSettingsV2 mindeeSettings,
      HttpClientBuilder httpClientBuilder
  ) {
    this.mindeeSettings = mindeeSettings;

    if (httpClientBuilder != null) {
      this.httpClientBuilder = httpClientBuilder;
    } else {
      this.httpClientBuilder = HttpClientBuilder.create().useSystemProperties();
    }
  }

  /**
   * Enqueues a doc with the POST method.
   *
   * @param inputSource Input source to send.
   * @param options     Options to send the file along with.
   * @return A job response.
   */
  @Override
  public JobResponse reqPostInferenceEnqueue(
      LocalInputSource inputSource,
      InferenceParameters options
  ) {
    String url = this.mindeeSettings.getBaseUrl() + "/inferences/enqueue";
    HttpPost post = buildHttpPost(url, options);

    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
    builder.setMode(HttpMultipartMode.EXTENDED);
    builder.addBinaryBody(
        "file",
        inputSource.getFile(),
        ContentType.DEFAULT_BINARY,
        inputSource.getFilename()
    );
    post.setEntity(buildHttpBody(builder, options));
    return executeEnqueue(post);
  }


  /**
   * Enqueues a doc with the POST method.
   *
   * @param inputSource Input source to send.
   * @param options     Options to send the file along with.
   * @return A job response.
   */
  @Override
  public JobResponse reqPostInferenceEnqueue(
      URLInputSource inputSource,
      InferenceParameters options
  ) {
    String url = this.mindeeSettings.getBaseUrl() + "/inferences/enqueue";
    HttpPost post = buildHttpPost(url, options);

    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
    builder.setMode(HttpMultipartMode.EXTENDED);
    builder.addTextBody(
        "url",
        inputSource.getUrl()
    );
    post.setEntity(buildHttpBody(builder, options));
    return executeEnqueue(post);
  }

  /**
   * Executes an enqueue action, common to URL & local inputs.
   * @param post HTTP Post object.
   * @return a valid job response.
   */
  private JobResponse executeEnqueue(HttpPost post) {
    mapper.findAndRegisterModules();
    try (CloseableHttpClient httpClient = httpClientBuilder.build()) {
      return httpClient.execute(
          post, response -> {
            HttpEntity responseEntity = response.getEntity();
            int statusCode = response.getCode();
            if (isInvalidStatusCode(statusCode)) {
              throw getHttpError(response);
            }
            try {
              String raw = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);

              return deserializeOrThrow(raw, JobResponse.class, response.getCode());
            } finally {
              EntityUtils.consumeQuietly(responseEntity);
            }
          }
      );
    } catch (IOException err) {
      throw new MindeeException(err.getMessage(), err);
    }
  }

  @Override
  public JobResponse reqGetJob(
      String jobId
  ) {

    String url = this.mindeeSettings.getBaseUrl() + "/jobs/" + jobId;
    HttpGet get = new HttpGet(url);

    if (this.mindeeSettings.getApiKey().isPresent()) {
      get.setHeader(HttpHeaders.AUTHORIZATION, this.mindeeSettings.getApiKey().get());
    }
    get.setHeader(HttpHeaders.USER_AGENT, getUserAgent());
    RequestConfig noRedirect =
        RequestConfig.custom()
            .setRedirectsEnabled(false)
            .build();
    get.setConfig(noRedirect);

    mapper.findAndRegisterModules();
    try (CloseableHttpClient httpClient = httpClientBuilder.build()) {
      return httpClient.execute(
          get, response -> {
            HttpEntity responseEntity = response.getEntity();
            int statusCode = response.getCode();
            if (isInvalidStatusCode(statusCode)) {
              throw getHttpError(response);
            }
            try {
              String raw = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);

              return deserializeOrThrow(raw, JobResponse.class, response.getCode());
            } finally {
              EntityUtils.consumeQuietly(responseEntity);
            }
          }
      );
    } catch (IOException err) {
      throw new MindeeException(err.getMessage(), err);
    }
  }

  @Override
  public InferenceResponse reqGetInference(String inferenceId) {

    String url = this.mindeeSettings.getBaseUrl() + "/inferences/" + inferenceId;
    HttpGet get = new HttpGet(url);

    if (this.mindeeSettings.getApiKey().isPresent()) {
      get.setHeader(HttpHeaders.AUTHORIZATION, this.mindeeSettings.getApiKey().get());
    }
    get.setHeader(HttpHeaders.USER_AGENT, getUserAgent());

    mapper.findAndRegisterModules();

    try (CloseableHttpClient httpClient = httpClientBuilder
        .build()) {

      return httpClient.execute(
          get,
          response -> {
            HttpEntity entity = response.getEntity();
            int status = response.getCode();
            try {
              if (isInvalidStatusCode(status)) {
                throw getHttpError(response);
              }
              String raw = EntityUtils.toString(entity, StandardCharsets.UTF_8);
              return deserializeOrThrow(raw, InferenceResponse.class, status);
            } finally {
              EntityUtils.consumeQuietly(entity);
            }
          });
    } catch (IOException err) {
      throw new MindeeException(err.getMessage(), err);
    }
  }

  private MindeeHttpExceptionV2 getHttpError(ClassicHttpResponse response) {
    String rawBody;
    try {
      rawBody = response.getEntity() == null
          ? ""
          : EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);

      ErrorResponse err = mapper.readValue(rawBody, ErrorResponse.class);

      if (err.getDetail() == null) {
        err = new ErrorResponse("Unknown error", response.getCode());
      }
      return new MindeeHttpExceptionV2(err.getStatus(), err.getDetail());

    } catch (Exception e) {
      return new MindeeHttpExceptionV2(response.getCode(), "Unknown error");
    }
  }


  private HttpEntity buildHttpBody(
      MultipartEntityBuilder builder,
      InferenceParameters params
  ) {

    if (params.getAlias() != null) {
      builder.addTextBody(
          "alias",
          params.getAlias().toLowerCase()
      );
    }

    builder.addTextBody("model_id", params.getModelId());
    if (params.isRag()) {
      builder.addTextBody("rag", "true");
    }
    if (params.getAlias() != null) {
      builder.addTextBody("alias", params.getAlias());
    }
    if (params.getWebhookIds().length > 0) {
      builder.addTextBody("webhook_ids", String.join(",", params.getWebhookIds()));
    }
    return builder.build();
  }


  private HttpPost buildHttpPost(
      String url,
      InferenceParameters params
  ) {
    HttpPost post;
    try {
      URIBuilder uriBuilder = new URIBuilder(url);
      post = new HttpPost(uriBuilder.build());
    }
    // This exception will never happen because we are providing the URL internally.
    // Do this to avoid declaring the exception in the method signature.
    catch (URISyntaxException err) {
      return new HttpPost("invalid URI");
    }

    if (this.mindeeSettings.getApiKey().isPresent()) {
      post.setHeader(HttpHeaders.AUTHORIZATION, this.mindeeSettings.getApiKey().get());
    }
    post.setHeader(HttpHeaders.USER_AGENT, getUserAgent());
    return post;
  }


  private <R extends CommonResponse> R deserializeOrThrow(
      String body, Class<R> clazz, int httpStatus) throws MindeeHttpExceptionV2 {

    if (httpStatus >= 200 && httpStatus < 400) {
      try {
        R model = mapper.readerFor(clazz).readValue(body);
        model.setRawResponse(body);
        return model;
      } catch (Exception exception) {
        throw new MindeeException("Couldn't deserialize server response:\n" + exception.getMessage());
      }
    }

    ErrorResponse err;
    try {
      err = mapper.readValue(body, ErrorResponse.class);
      if (err.getDetail() == null) {
        err = new ErrorResponse("Unknown error", httpStatus);
      }
    } catch (Exception ignored) {
      err = new ErrorResponse("Unknown error", httpStatus);
    }
    throw new MindeeHttpExceptionV2(err.getStatus(), err.getDetail());
  }
}