Skip to content

Commit 566ca01

Browse files
committed
feat(gax): add recoverable error query and buffer realignment loop
Introduces a query-and-realign loop when encountering recoverable protocol errors during chunk uploads. Queries the server for the committed offset and adjusts the buffer window before resuming chunk transmission.
1 parent 715822d commit 566ca01

5 files changed

Lines changed: 330 additions & 31 deletions

File tree

‎sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/rpc/ResumableUploadCallableImpl.java‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@
3737
import com.google.api.core.InternalApi;
3838
import com.google.api.gax.resumable.ChunkUploadRequest;
3939
import com.google.api.gax.resumable.ChunkUploadResponse;
40+
import com.google.api.gax.resumable.QueryStatusRequest;
41+
import com.google.api.gax.resumable.QueryStatusResponse;
4042
import com.google.api.gax.resumable.ResumableUploadClient;
4143
import com.google.api.gax.resumable.ResumableUploadSession;
4244
import com.google.api.gax.retrying.ExponentialRetryAlgorithm;
@@ -74,6 +76,8 @@ public class ResumableUploadCallableImpl<RequestT, ResponseT>
7476
private final ClientContext clientContext;
7577
private final UnaryCallable<ChunkUploadRequest, ChunkUploadResponse<ResponseT>>
7678
retryingUploadChunkCallable;
79+
private final UnaryCallable<QueryStatusRequest, QueryStatusResponse<ResponseT>>
80+
retryingQueryCallable;
7781

7882
public ResumableUploadCallableImpl(
7983
ResumableUploadClient<RequestT, ResponseT> client,
@@ -89,6 +93,8 @@ public ResumableUploadCallableImpl(
8993
.build();
9094
this.retryingUploadChunkCallable =
9195
createRetryingCallable(client.uploadChunkCallable(), ResumableUploadCommand.UPLOAD);
96+
this.retryingQueryCallable =
97+
createRetryingCallable(client.queryStatusCallable(), ResumableUploadCommand.QUERY);
9298
}
9399

94100
@Override
@@ -110,7 +116,12 @@ public ResumableUploadFuture<ResponseT> futureCall(
110116
}
111117

112118
return ResumableUploadFutureImpl.create(
113-
startFuture, retryingUploadChunkCallable, payload, effectiveSettings, clientContext);
119+
startFuture,
120+
retryingUploadChunkCallable,
121+
retryingQueryCallable,
122+
payload,
123+
effectiveSettings,
124+
clientContext);
114125
}
115126

116127
@Override

‎sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/rpc/ResumableUploadChunkCoordinator.java‎

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -210,24 +210,22 @@ private void onChunkUploaded(ChunkUploadResponse<ResponseT> response) {
210210
if (result.isDone()) {
211211
return;
212212
}
213-
try {
214-
if (response.getUploadStatus() == ResumableUploadStatus.FINAL) {
215-
result.set(response.getResponse());
216-
} else if (buffer.isFinal()) {
217-
throw new IllegalStateException(
218-
"Upload stream ended and final chunk was transmitted, but server returned incomplete"
219-
+ " status for upload URL: "
220-
+ uploadUrl);
221-
} else {
222-
long nextOffset = buffer.getBufferBaseOffset() + buffer.getPayloadLength();
223-
transmitChunk(nextOffset);
224-
}
225-
} catch (Throwable t) {
226-
result.setException(t);
213+
long nextOffset = buffer.getBufferBaseOffset() + buffer.getPayloadLength();
214+
if (response.getUploadStatus() == ResumableUploadStatus.FINAL) {
215+
result.set(response.getResponse());
216+
} else if (buffer.isFinal()) {
217+
result.setException(
218+
new IllegalStateException(
219+
"Upload stream ended and final chunk was transmitted, but server returned"
220+
+ " incomplete status for upload URL: "
221+
+ uploadUrl));
222+
} else {
223+
chunkExecutor.execute(() -> transmitChunk(nextOffset));
227224
}
228225
}
229226

230227
private ChunkUploadRequest buildCurrentChunkRequest() {
228+
// Determine if this is the final chunk and build the chunk request.
231229
return ChunkUploadRequest.newBuilder()
232230
.setUploadUrl(uploadUrl)
233231
.setPayload(buffer.getBuffer())
@@ -237,21 +235,20 @@ private ChunkUploadRequest buildCurrentChunkRequest() {
237235
.build();
238236
}
239237

240-
private static FailedPreconditionException protocolViolation(String message) {
241-
return new FailedPreconditionException(
242-
message,
243-
null,
244-
new StatusCode() {
245-
@Override
246-
public StatusCode.Code getCode() {
247-
return StatusCode.Code.FAILED_PRECONDITION;
248-
}
238+
private static final StatusCode FAILED_PRECONDITION_STATUS_CODE =
239+
new StatusCode() {
240+
@Override
241+
public StatusCode.Code getCode() {
242+
return StatusCode.Code.FAILED_PRECONDITION;
243+
}
249244

250-
@Override
251-
public @Nullable Object getTransportCode() {
252-
return null;
253-
}
254-
},
255-
false);
245+
@Override
246+
public @Nullable Object getTransportCode() {
247+
return null;
248+
}
249+
};
250+
251+
private static FailedPreconditionException protocolViolation(String message) {
252+
return new FailedPreconditionException(message, null, FAILED_PRECONDITION_STATUS_CODE, false);
256253
}
257254
}

‎sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/rpc/ResumableUploadFutureImpl.java‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@
3838
import com.google.api.core.SettableApiFuture;
3939
import com.google.api.gax.resumable.ChunkUploadRequest;
4040
import com.google.api.gax.resumable.ChunkUploadResponse;
41+
import com.google.api.gax.resumable.QueryStatusRequest;
42+
import com.google.api.gax.resumable.QueryStatusResponse;
4143
import com.google.api.gax.resumable.ResumableUploadSession;
4244
import com.google.common.util.concurrent.MoreExecutors;
4345
import com.google.errorprone.annotations.concurrent.GuardedBy;
@@ -65,6 +67,8 @@ final class ResumableUploadFutureImpl<ResponseT> implements ResumableUploadFutur
6567
private final ApiFuture<ResumableUploadSession> startFuture;
6668
private final UnaryCallable<ChunkUploadRequest, ChunkUploadResponse<ResponseT>>
6769
uploadChunkCallable;
70+
private final UnaryCallable<QueryStatusRequest, QueryStatusResponse<ResponseT>>
71+
queryStatusCallable;
6872
private final InputStream payload;
6973
private final ResumableUploadCallSettings settings;
7074
private final ClientContext clientContext;
@@ -85,12 +89,18 @@ final class ResumableUploadFutureImpl<ResponseT> implements ResumableUploadFutur
8589
static <ResponseT> ResumableUploadFutureImpl<ResponseT> create(
8690
ApiFuture<ResumableUploadSession> startFuture,
8791
UnaryCallable<ChunkUploadRequest, ChunkUploadResponse<ResponseT>> uploadChunkCallable,
92+
UnaryCallable<QueryStatusRequest, QueryStatusResponse<ResponseT>> queryStatusCallable,
8893
InputStream payload,
8994
ResumableUploadCallSettings settings,
9095
ClientContext clientContext) {
9196
ResumableUploadFutureImpl<ResponseT> future =
9297
new ResumableUploadFutureImpl<>(
93-
startFuture, uploadChunkCallable, payload, settings, clientContext);
98+
startFuture,
99+
uploadChunkCallable,
100+
queryStatusCallable,
101+
payload,
102+
settings,
103+
clientContext);
94104
try {
95105
future.start();
96106
} catch (Throwable t) {
@@ -102,12 +112,15 @@ static <ResponseT> ResumableUploadFutureImpl<ResponseT> create(
102112
private ResumableUploadFutureImpl(
103113
ApiFuture<ResumableUploadSession> startFuture,
104114
UnaryCallable<ChunkUploadRequest, ChunkUploadResponse<ResponseT>> uploadChunkCallable,
115+
UnaryCallable<QueryStatusRequest, QueryStatusResponse<ResponseT>> queryStatusCallable,
105116
InputStream payload,
106117
ResumableUploadCallSettings settings,
107118
ClientContext clientContext) {
108119
this.startFuture = checkNotNull(startFuture, "startFuture must not be null");
109120
this.uploadChunkCallable =
110121
checkNotNull(uploadChunkCallable, "uploadChunkCallable must not be null");
122+
this.queryStatusCallable =
123+
checkNotNull(queryStatusCallable, "queryStatusCallable must not be null");
111124
this.payload = checkNotNull(payload, "payload must not be null");
112125
this.settings = checkNotNull(settings, "settings must not be null");
113126
checkArgument(settings.getChunkSize() > 0, "chunkSize must be > 0");
@@ -128,6 +141,7 @@ public void onSuccess(ResumableUploadSession session) {
128141
ResumableUploadChunkCoordinator<ResponseT> coordinator =
129142
new ResumableUploadChunkCoordinator<>(
130143
uploadChunkCallable,
144+
queryStatusCallable,
131145
uploadSessionUrl,
132146
payload,
133147
settings.getChunkSize(),

‎sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/rpc/CallableTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,8 @@ void testResumableUploadCallable() {
216216
mock(ResumableUploadClient.class, Mockito.withSettings().withoutAnnotations());
217217
when(uploadClient.uploadChunkCallable())
218218
.thenReturn(mock(UnaryCallable.class, Mockito.withSettings().withoutAnnotations()));
219+
when(uploadClient.queryStatusCallable())
220+
.thenReturn(mock(UnaryCallable.class, Mockito.withSettings().withoutAnnotations()));
219221
ResumableUploadCallSettings settings =
220222
ResumableUploadCallSettings.newBuilder().setChunkSize(1024).build();
221223

0 commit comments

Comments
 (0)