feat(gax): implement uploadChunk in HttpJsonResumableUploadClient

Author: whowes

sdk-platform-java/gax-java/gax-httpjson/src/main/java/com/google/api/gax/httpjson/HttpJsonResumableUploadClient.java

@@ -33,6 +33,8 @@
 import com.google.api.core.ApiFuture;
 import com.google.api.core.InternalApi;
 import com.google.api.core.SettableApiFuture;
+import com.google.api.gax.resumable.ChunkUploadRequest;
+import com.google.api.gax.resumable.ChunkUploadResponse;
 import com.google.api.gax.resumable.ResumableUploadClient;
 import com.google.api.gax.resumable.ResumableUploadSession;
 import com.google.api.gax.rpc.ApiCallContext;
@@ -41,10 +43,14 @@
 import com.google.api.gax.rpc.ClientContext;
 import com.google.api.gax.rpc.StatusCode;
 import com.google.api.gax.rpc.UnaryCallable;
+import com.google.api.pathtemplate.PathTemplate;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Strings;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -69,14 +75,49 @@ public final class HttpJsonResumableUploadClient<RequestT, ResponseT>
 
   private static final String UPLOAD_PROTOCOL_HEADER = "X-Goog-Upload-Protocol";
   private static final String UPLOAD_COMMAND_HEADER = "X-Goog-Upload-Command";
+  private static final String UPLOAD_OFFSET_HEADER = "X-Goog-Upload-Offset";
   private static final String UPLOAD_URL_HEADER = "X-Goog-Upload-URL";
   private static final String UPLOAD_GRANULARITY_HEADER = "X-Goog-Upload-Chunk-Granularity";
+  private static final String UPLOAD_STATUS_HEADER = "X-Goog-Upload-Status";
+  private static final String UPLOAD_SIZE_RECEIVED_HEADER = "X-Goog-Upload-Size-Received";
+  private static final String STATUS_FINAL = "final";
 
   private static final Map<String, List<String>> START_UPLOAD_HEADERS =
       ImmutableMap.of(
           UPLOAD_PROTOCOL_HEADER, ImmutableList.of("resumable"),
           UPLOAD_COMMAND_HEADER, ImmutableList.of("start"));
 
+  private static final PathTemplate PATH_TEMPLATE = PathTemplate.create("{+path}");
+
+  private static final ApiMethodDescriptor<ChunkUploadRequest, String> UPLOAD_CHUNK_DESCRIPTOR =
+      ApiMethodDescriptor.<ChunkUploadRequest, String>newBuilder()
+          .setFullMethodName("ResumableUpload/UploadChunk")
+          .setHttpMethod(HttpMethods.POST)
+          .setType(ApiMethodDescriptor.MethodType.UNARY)
+          .setRequestFormatter(
+              new ResumableUploadChunkRequestFormatter<ChunkUploadRequest>() {
+                @Override
+                public Map<String, List<String>> getQueryParamNames(ChunkUploadRequest request) {
+                  return Collections.emptyMap();
+                }
+
+                @Override
+                public byte[] getBinaryRequestBody(ChunkUploadRequest request) {
+                  return request.getPayload().toByteArray();
+                }
+
+                @Override
+                public String getPath(ChunkUploadRequest request) {
+                  return request.getUploadUrl();
+                }
+
+                @Override
+                public PathTemplate getPathTemplate() {
+                  return PATH_TEMPLATE;
+                }
+              })
+          .setResponseParser(ResumableUploadResponseParser.create())
+          .build();
   private final ClientContext clientContext;
   private final ApiMethodDescriptor<RequestT, String> startUploadDescriptor;
   private final HttpResponseParser<ResponseT> responseParser;
@@ -128,6 +169,49 @@ public ApiFuture<ResumableUploadSession> futureCall(
     };
   }
 
+  @Override
+  public UnaryCallable<ChunkUploadRequest, ChunkUploadResponse<ResponseT>> uploadChunkCallable() {
+    return new UnaryCallable<ChunkUploadRequest, ChunkUploadResponse<ResponseT>>() {
+      @Override
+      public ApiFuture<ChunkUploadResponse<ResponseT>> futureCall(
+          ChunkUploadRequest request, @Nullable ApiCallContext inputContext) {
+        Preconditions.checkNotNull(request);
+        boolean isPayloadEmpty = request.getPayload().isEmpty();
+        String command;
+        if (request.isFinal()) {
+          command = !isPayloadEmpty ? "upload, finalize" : "finalize";
+        } else {
+          command = "upload";
+        }
+        Map<String, List<String>> chunkHeaders =
+            ImmutableMap.of(
+                UPLOAD_COMMAND_HEADER,
+                ImmutableList.of(command),
+                UPLOAD_OFFSET_HEADER,
+                ImmutableList.of(String.valueOf(request.getOffset())));
+
+        HttpJsonCallContext context =
+            (HttpJsonCallContext)
+                HttpJsonCallContext.createDefault()
+                    .nullToSelf(clientContext.getDefaultCallContext())
+                    .merge(inputContext)
+                    .withExtraHeaders(chunkHeaders);
+
+        HttpJsonClientCall<ChunkUploadRequest, String> clientCall =
+            HttpJsonClientCalls.newCall(UPLOAD_CHUNK_DESCRIPTOR, context);
+
+        SettableApiFuture<ChunkUploadResponse<ResponseT>> future = SettableApiFuture.create();
+        HttpJsonClientCalls.startUnaryCall(
+            clientCall,
+            request,
+            context,
+            new ChunkUploadResponseListener<>(request, future, responseParser));
+
+        return future;
+      }
+    };
+  }
+
   private static class StartUploadResponseListener extends HttpJsonClientCall.Listener<String> {
 
     private final SettableApiFuture<ResumableUploadSession> future;
@@ -181,25 +265,133 @@ public void onClose(int statusCode, HttpJsonMetadata trailers) {
                     /* retryable= */ false));
           }
         } else {
-          Throwable cause = trailers.getException();
-          ApiException apiException =
-              cause != null
-                  ? API_EXCEPTION_FACTORY.create(cause)
-                  : ApiExceptionFactory.createException(
-                      "Failed to start upload with status code: " + statusCode,
-                      /* cause= */ null,
-                      HttpJsonStatusCode.of(statusCode),
-                      /* retryable= */ false);
-          future.setException(apiException);
+          future.setException(createApiException(statusCode, trailers, "Failed to start upload"));
         }
-      } catch (Throwable t) {
+      } catch (Exception e) {
         future.setException(
             ApiExceptionFactory.createException(
                 "Internal error processing start upload response",
-                t,
+                e,
+                HttpJsonStatusCode.of(StatusCode.Code.INTERNAL),
+                /* retryable= */ false));
+      }
+    }
+  }
+
+  private static class ChunkUploadResponseListener<ResponseT>
+      extends HttpJsonClientCall.Listener<String> {
+
+    private final ChunkUploadRequest request;
+    private final SettableApiFuture<ChunkUploadResponse<ResponseT>> future;
+    private final HttpResponseParser<ResponseT> responseParser;
+    private boolean hasUploadStatusHeader = false;
+    private boolean isComplete = false;
+    private long committedOffset = -1L;
+    private String responseBody = "";
+
+    ChunkUploadResponseListener(
+        ChunkUploadRequest request,
+        SettableApiFuture<ChunkUploadResponse<ResponseT>> future,
+        HttpResponseParser<ResponseT> responseParser) {
+      this.request = request;
+      this.future = future;
+      this.responseParser = responseParser;
+    }
+
+    @Override
+    public void onHeaders(HttpJsonMetadata responseHeaders) {
+      Map<String, Object> headers = responseHeaders.getHeaders();
+
+      String statusStr = HttpHeadersUtils.getSingleHeader(headers, UPLOAD_STATUS_HEADER);
+      if (statusStr != null) {
+        this.hasUploadStatusHeader = true;
+        if (STATUS_FINAL.equalsIgnoreCase(statusStr)) {
+          this.isComplete = true;
+        }
+      }
+
+      String sizeReceivedStr =
+          HttpHeadersUtils.getSingleHeader(headers, UPLOAD_SIZE_RECEIVED_HEADER);
+      if (!Strings.isNullOrEmpty(sizeReceivedStr)) {
+        try {
+          this.committedOffset = Long.parseLong(sizeReceivedStr);
+        } catch (NumberFormatException ignored) {
+          // Ignore invalid/malformed size received header and fall back to local offset
+          // calculation.
+        }
+      }
+    }
+
+    @Override
+    public void onMessage(@Nullable String message) {
+      if (message != null) {
+        this.responseBody = message;
+      }
+    }
+
+    @Override
+    public void onClose(int statusCode, HttpJsonMetadata trailers) {
+      try {
+        if (statusCode >= 200 && statusCode < 300) {
+          if (!hasUploadStatusHeader) {
+            future.setException(
+                ApiExceptionFactory.createException(
+                    "Upload chunk response did not contain valid X-Goog-Upload-Status header",
+                    /* cause= */ null,
+                    HttpJsonStatusCode.of(StatusCode.Code.INTERNAL),
+                    /* retryable= */ false));
+            return;
+          }
+          long confirmedOffset =
+              committedOffset >= 0
+                  ? committedOffset
+                  : request.getOffset() + request.getPayload().size();
+          ResponseT response = null;
+          if (isComplete) {
+            InputStream stream =
+                new ByteArrayInputStream(responseBody.getBytes(StandardCharsets.UTF_8));
+            response = responseParser.parse(stream);
+          }
+          future.set(ChunkUploadResponse.create(confirmedOffset, isComplete, response));
+        } else {
+          future.setException(createApiException(statusCode, trailers, "Failed to upload chunk"));
+        }
+      } catch (Exception e) {
+        future.setException(
+            ApiExceptionFactory.createException(
+                "Internal error processing upload chunk response",
+                e,
                 HttpJsonStatusCode.of(StatusCode.Code.INTERNAL),
                 /* retryable= */ false));
       }
     }
   }
+
+  private static boolean isUploadFinal(HttpJsonMetadata responseHeaders) {
+    String statusStr =
+        HttpHeadersUtils.getSingleHeader(responseHeaders.getHeaders(), UPLOAD_STATUS_HEADER);
+    return STATUS_FINAL.equalsIgnoreCase(statusStr);
+  }
+
+  private static ApiException createApiException(
+      int statusCode, @Nullable HttpJsonMetadata trailers, String actionDescription) {
+    Throwable cause = trailers != null ? trailers.getException() : null;
+    if (cause != null) {
+      ApiException apiException = API_EXCEPTION_FACTORY.create(cause);
+      if (isUploadFinal(trailers)) {
+        return ApiExceptionFactory.createException(
+            apiException.getMessage(),
+            apiException.getCause(),
+            apiException.getStatusCode(),
+            /* retryable= */ false,
+            apiException.getErrorDetails());
+      }
+      return apiException;
+    }
+    return ApiExceptionFactory.createException(
+        actionDescription + " with status code: " + statusCode,
+        /* cause= */ null,
+        HttpJsonStatusCode.of(statusCode),
+        /* retryable= */ false);
+  }
 }