ml.comet.experiment.impl.http.ConnectionUtils Maven / Gradle / Ivy
package ml.comet.experiment.impl.http;
import io.netty.handler.codec.http.HttpHeaderNames;
import io.netty.handler.codec.http.HttpHeaderValues;
import lombok.NonNull;
import lombok.Value;
import ml.comet.experiment.exception.CometApiException;
import ml.comet.experiment.impl.constants.FormParamName;
import ml.comet.experiment.impl.constants.QueryParamName;
import ml.comet.experiment.impl.rest.CometWebJavaSdkException;
import ml.comet.experiment.impl.utils.JsonUtils;
import org.asynchttpclient.Request;
import org.asynchttpclient.RequestBuilder;
import org.asynchttpclient.Response;
import org.asynchttpclient.request.body.generator.ByteArrayBodyGenerator;
import org.asynchttpclient.request.body.multipart.ByteArrayPart;
import org.asynchttpclient.request.body.multipart.FileLikePart;
import org.asynchttpclient.request.body.multipart.FilePart;
import org.asynchttpclient.request.body.multipart.Part;
import org.asynchttpclient.request.body.multipart.StringPart;
import org.asynchttpclient.util.HttpConstants;
import org.slf4j.Logger;
import java.io.File;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import static ml.comet.experiment.impl.constants.FormParamName.FILE;
/**
* Collection of the utilities used by Connection.
*/
public class ConnectionUtils {
/**
* Creates GET request to the given endpoint with specified query parameters.
*
* @param url the endpoint URL
* @param queryParams the request query parameters.
* @return the GET request.
*/
static Request createGetRequest(@NonNull String url, Map queryParams) {
return createRequestBuilder(HttpConstants.Methods.GET, queryParams)
.setUrl(url)
.build();
}
/**
* Creates POST request from given file to the specified endpoint.
*
* @param file the file to be included in the body parts.
* @param url the URL of the endpoint.
* @param queryParams the query parameters of the request.
* @param formParams the form parameters to be added.
* @return the POST request with specified file.
*/
static Request createPostFileRequest(@NonNull File file, @NonNull String url,
Map queryParams,
Map formParams) {
return createMultipartRequestBuilder(
new FilePart(FILE.paramName(), file), queryParams, formParams)
.setUrl(url)
.build();
}
/**
* Creates POST request from given byte array to the specified endpoint.
*
* @param bytes the bytes array to include into request.
* @param url the URL of the endpoint.
* @param queryParams the query parameters of the request.
* @param formParams the form parameters to be added
* @return the POST request with specified byte array as body part.
*/
static Request createPostByteArrayRequest(byte[] bytes, @NonNull String url,
Map queryParams,
Map formParams) {
return createMultipartRequestBuilder(
new ByteArrayPart(FILE.paramName(), bytes, HttpHeaderValues.APPLICATION_OCTET_STREAM.toString()),
queryParams, formParams)
.setUrl(url)
.build();
}
/**
* Creates POST FORM request from given parameters to the specified endpoint.
*
* @param url the URL of the endpoint.
* @param queryParams the query parameters of the request.
* @param formParams the form parameters to be added
* @return the POST request for FORM submission.
*/
static Request createPostFormRequest(@NonNull String url,
Map queryParams,
@NonNull Map formParams) {
return createMultipartRequestBuilder(queryParams, formParams)
.setUrl(url)
.build();
}
/**
* Creates Request with specified body for given url.
*/
static Request createPostJsonRequest(@NonNull String body, @NonNull String url) {
return new RequestBuilder()
.setUrl(url)
.setHeader(HttpHeaderNames.CONTENT_TYPE, HttpHeaderValues.APPLICATION_JSON)
.setBody(new ByteArrayBodyGenerator(body.getBytes(StandardCharsets.UTF_8)))
.setMethod(HttpConstants.Methods.POST)
.build();
}
/**
* Returns true if the status code is in [200..300), which means the request was successfully received,
* understood, and accepted.
*/
static boolean isResponseSuccessful(int statusCode) {
return statusCode >= 200 && statusCode < 300;
}
/**
* Creates request builder configured with common parameters.
*
* @param httpMethod the HTTP method.
* @param queryParams the query parameters to be added to the request builder.
* @return the pre-configured request builder.
*/
static RequestBuilder createRequestBuilder(@NonNull String httpMethod, Map queryParams) {
RequestBuilder builder = new RequestBuilder(httpMethod);
if (Objects.nonNull(queryParams)) {
queryParams.forEach((k, v) -> {
if (v != null) {
builder.addQueryParam(k.paramName(), v);
}
});
}
return builder;
}
/**
* Creates multipart request builder using provided parameters.
*
* @param fileLikePart the file like part to be added
* @param queryParams the query parameters to be added
* @param formParams the form parameters
* @return the pre-configured request builder.
*/
static RequestBuilder createMultipartRequestBuilder(
@NonNull FileLikePart fileLikePart, Map queryParams,
Map formParams) {
RequestBuilder builder = createMultipartRequestBuilder(queryParams, formParams);
builder.addBodyPart(fileLikePart);
return builder;
}
/**
* Creates multipart request builder using provided parameters. This builder creates simple form submission request.
*
* @param queryParams the query parameters to be added
* @param formParams the form parameters
* @return the pre-configured request builder.
*/
static RequestBuilder createMultipartRequestBuilder(Map queryParams,
Map formParams) {
RequestBuilder builder = createRequestBuilder(HttpConstants.Methods.POST, queryParams);
List parts = new ArrayList<>();
if (Objects.nonNull(formParams)) {
formParams.forEach((k, v) -> {
if (v != null) {
parts.add(createStringPart(k.paramName(), v));
}
});
}
builder
.setHeader(HttpHeaderNames.CONTENT_TYPE, HttpHeaderValues.MULTIPART_FORM_DATA)
.setBodyParts(parts);
return builder;
}
/**
* Allows checking response status and throw related exceptions.
*
* @param response the {@link Response} to be checked.
* @throws CometWebJavaSdkException if remote endpoint returned BAD REQUEST error status.
* @throws CometApiException is request failed with another error code.
*/
public static void checkResponseStatus(@NonNull Response response)
throws CometWebJavaSdkException, CometApiException {
int statusCode = response.getStatusCode();
if (isResponseSuccessful(statusCode)) {
return;
}
// check for status code and raise appropriate exception
if ((statusCode == 400 || statusCode == 403 || statusCode == 405) && response.hasResponseBody()) {
throw JsonUtils.fromJson(
response.getResponseBody(), CometWebJavaSdkException.class);
}
throw new CometApiException(response.getStatusCode(), response.getStatusText(), 0);
}
private static Part createStringPart(String name, @NonNull Object value) {
return new StringPart(name, value.toString());
}
/**
* The function allowing to debug response.
*/
@Value
public static class DebugLogResponse implements Function {
Logger logger;
String endpoint;
@Override
public Response apply(Response response) {
// log response for debug purposes
if (ConnectionUtils.isResponseSuccessful(response.getStatusCode())) {
logger.debug("for endpoint {} got response {}\n", endpoint, response.getResponseBody());
} else {
logger.error("for endpoint {} got response {}\n", endpoint, response.getStatusText());
}
return response;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy