Repository navigation
feat(gax): enable stall control for resumable uploads #14989
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,7 +78,9 @@ final class ResumableUploadFutureImpl<ResponseT> implements ResumableUploadFutur | |
| private final ResumableUploadOptions options; | ||
| private final ClientContext clientContext; | ||
| private final ScheduledExecutorService executor; | ||
| private final boolean isResume; | ||
| private final ResumableUploadProgressTracker progressTracker; | ||
| private final @Nullable ResumableUploadStallController stallController; | ||
| private final SettableApiFuture<ResponseT> resultFuture = SettableApiFuture.create(); | ||
|
|
||
| private volatile @Nullable InputStream payload; | ||
|
|
@@ -157,9 +159,13 @@ static <ResponseT> ResumableUploadFutureImpl<ResponseT> createForResume( | |
| sessionUrl, uploadChunkCallable, queryStatusCallable, options, clientContext); | ||
| ApiFuture<QueryStatusResponse<ResponseT>> queryFuture; | ||
| try { | ||
| ApiCallContext queryCallContext = clientContext.getDefaultCallContext(); | ||
| if (future.stallController != null) { | ||
| queryCallContext = | ||
| queryCallContext.withRetrySettings(future.stallController.onStartQuery(Duration.ZERO)); | ||
| } | ||
| queryFuture = | ||
| queryStatusCallable.futureCall(QueryStatusRequest.create(sessionUrl), queryCallContext); | ||
| } catch (Throwable t) { | ||
| queryFuture = ApiFutures.immediateFailedFuture(t); | ||
| } | ||
|
|
@@ -188,6 +194,7 @@ private ResumableUploadFutureImpl( | |
| ResumableUploadOptions options, | ||
| ClientContext clientContext) { | ||
| this.uploadSessionUrl = sessionUrl; | ||
| this.isResume = sessionUrl != null; | ||
| this.uploadChunkCallable = | ||
| checkNotNull(uploadChunkCallable, "uploadChunkCallable must not be null"); | ||
| this.queryStatusCallable = | ||
|
|
@@ -196,8 +203,10 @@ private ResumableUploadFutureImpl( | |
| checkArgument(options.getChunkSize() > 0, "chunkSize must be > 0"); | ||
| this.clientContext = checkNotNull(clientContext, "clientContext must not be null"); | ||
| this.executor = checkNotNull(clientContext.getExecutor(), "executor must not be null"); | ||
| this.stallController = createStallController(options, clientContext); | ||
| if (this.isResume) { | ||
| this.progressTracker = | ||
| ResumableUploadProgressTracker.createForResume(checkNotNull(sessionUrl)); | ||
| } else { | ||
| this.progressTracker = ResumableUploadProgressTracker.create(); | ||
| } | ||
|
|
@@ -207,6 +216,24 @@ private ResumableUploadFutureImpl( | |
| } | ||
| } | ||
|
|
||
| private static @Nullable ResumableUploadStallController createStallController( | ||
| ResumableUploadOptions options, ClientContext clientContext) { | ||
| if (!options.isStallControlEnabled()) { | ||
| return null; | ||
| } | ||
| Duration globalDeadline = null; | ||
| if (options.getGlobalTimeout() != null) { | ||
| globalDeadline = | ||
| Duration.ofMillis(clientContext.getClock().millisTime()).plus(options.getGlobalTimeout()); | ||
| } | ||
| return new ResumableUploadStallController( | ||
| clientContext.getClock(), | ||
| checkNotNull(options.getTransferStallMinimumRate()), | ||
| checkNotNull(options.getTransferStallTimeout()), | ||
| globalDeadline, | ||
| ResumableUploadCallableImpl.RETRY_SETTINGS); | ||
| } | ||
|
|
||
| private <T> void initiate( | ||
| ApiFuture<T> initiationFuture, | ||
| InputStreamSupplier payloadSupplier, | ||
|
|
@@ -235,14 +262,25 @@ public void onFailure(Throwable t) { | |
| if (t instanceof CancellationException || resultFuture.isDone()) { | ||
| return; | ||
| } | ||
| if (isResume && stallController != null) { | ||
| t = stallController.translateException(t, ResumableUploadCommand.QUERY); | ||
| } | ||
| fail(t); | ||
| } | ||
| }, | ||
| MoreExecutors.directExecutor()); | ||
| } | ||
|
|
||
| private void setUpGlobalTimeout() { | ||
| Duration timeout; | ||
| if (options.isStallControlEnabled()) { | ||
| timeout = options.getGlobalTimeout(); | ||
| } else { | ||
| timeout = firstNonNull(options.getGlobalTimeout(), DEFAULT_GLOBAL_TIMEOUT); | ||
| } | ||
| if (timeout == null) { | ||
| return; | ||
| } | ||
| ScheduledFuture<?> timeoutFuture = | ||
| executor.schedule(this::onTimeout, timeout.toMillis(), TimeUnit.MILLISECONDS); | ||
| resultFuture.addListener(() -> timeoutFuture.cancel(false), MoreExecutors.directExecutor()); | ||
|
|
@@ -259,7 +297,8 @@ private void setUpGlobalTimeout() { | |
| checkNotNull(payload), | ||
| chunkSize, | ||
| clientContext, | ||
| progressTracker, | ||
| stallController); | ||
| ApiFuture<ResponseT> uploadFuture = coordinator.getFuture(); | ||
| synchronized (lock) { | ||
| if (inFlightFuture == null) { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,6 +61,24 @@ public abstract class ResumableUploadOptions { | |
| */ | ||
| public abstract @Nullable ResumableUploadProgressListener getProgressListener(); | ||
|
|
||
| /** | ||
| * Returns the minimum acceptable transfer rate in MiB/s (1 MiB = 1,048,576 bytes) for stall | ||
| * detection, or {@code null} if unset. Stall control is only active when both {@link | ||
| * #getTransferStallMinimumRate()} and {@link #getTransferStallTimeout()} are set. | ||
| */ | ||
| public abstract @Nullable Double getTransferStallMinimumRate(); | ||
|
|
||
| /** | ||
| * Returns the maximum duration the upload may remain below {@link #getTransferStallMinimumRate()} | ||
| * before being aborted as stalled, or {@code null} if unset. Stall control is only active when | ||
| * both {@link #getTransferStallMinimumRate()} and {@link #getTransferStallTimeout()} are set. | ||
| */ | ||
| public abstract @Nullable Duration getTransferStallTimeout(); | ||
|
|
||
| boolean isStallControlEnabled() { | ||
| return getTransferStallMinimumRate() != null && getTransferStallTimeout() != null; | ||
| } | ||
|
|
||
| /** | ||
| * Merges another {@code ResumableUploadOptions} instance with this one. Fields set in {@code | ||
| * other} override fields in this instance. | ||
|
|
@@ -76,8 +94,17 @@ public ResumableUploadOptions merge(@Nullable ResumableUploadOptions other) { | |
| if (other.getChunkSize() > 0) { | ||
| builder.setChunkSize(other.getChunkSize()); | ||
| } | ||
| if (other.getTransferStallMinimumRate() != null) { | ||
| builder.setTransferStallMinimumRate(other.getTransferStallMinimumRate()); | ||
| } | ||
| if (other.getTransferStallTimeout() != null) { | ||
| builder.setTransferStallTimeout(other.getTransferStallTimeout()); | ||
| } | ||
| if (other.getGlobalTimeout() != null) { | ||
| builder.setGlobalTimeout(other.getGlobalTimeout()); | ||
| } else if (builder.getTransferStallMinimumRate() != null | ||
| && builder.getTransferStallTimeout() != null) { | ||
| builder.setGlobalTimeout(null); | ||
| } | ||
|
Comment on lines
+105
to
108
Contributor
There was a problem hiding this comment. This logic causes a side-effect where merging an options instance that has both stall control and a custom References
|
||
| ResumableUploadProgressListener otherProgressListener = other.getProgressListener(); | ||
| if (otherProgressListener != null) { | ||
|
|
@@ -128,6 +155,33 @@ public abstract static class Builder { | |
| public abstract Builder setProgressListener( | ||
| @Nullable ResumableUploadProgressListener progressListener); | ||
|
|
||
| /** | ||
| * Sets the minimum acceptable transfer rate in MiB/s (1 MiB = 1,048,576 bytes) for stall | ||
| * detection. Must be finite and positive. Stall control is only active when both {@code | ||
| * transferStallMinimumRate} and {@code transferStallTimeout} are set; enabling stall control | ||
| * without an explicit {@link #setGlobalTimeout(Duration)} disables the default global timeout. | ||
| */ | ||
| public abstract Builder setTransferStallMinimumRate(@Nullable Double transferStallMinimumRate); | ||
|
|
||
| /** | ||
| * Returns the minimum acceptable transfer rate in MiB/s, or {@code null} if unset. See {@link | ||
| * #setTransferStallMinimumRate(Double)}. | ||
| */ | ||
| public abstract @Nullable Double getTransferStallMinimumRate(); | ||
|
|
||
| /** | ||
| * Sets the maximum duration the upload may remain below {@link #getTransferStallMinimumRate()} | ||
| * before being aborted as stalled. Must be positive. Stall control is only active when both | ||
| * {@code transferStallMinimumRate} and {@code transferStallTimeout} are set. | ||
| */ | ||
| public abstract Builder setTransferStallTimeout(@Nullable Duration transferStallTimeout); | ||
|
|
||
| /** | ||
| * Returns the stall timeout duration, or {@code null} if unset. See {@link | ||
| * #setTransferStallTimeout(Duration)}. | ||
| */ | ||
| public abstract @Nullable Duration getTransferStallTimeout(); | ||
|
|
||
| abstract ResumableUploadOptions autoBuild(); | ||
|
|
||
| public ResumableUploadOptions build() { | ||
|
|
@@ -137,6 +191,16 @@ public ResumableUploadOptions build() { | |
| !getGlobalTimeout().isNegative() && !getGlobalTimeout().isZero(), | ||
| "globalTimeout must be positive"); | ||
| } | ||
| if (getTransferStallMinimumRate() != null) { | ||
| Preconditions.checkArgument( | ||
| Double.isFinite(getTransferStallMinimumRate()) && getTransferStallMinimumRate() > 0.0, | ||
| "transferStallMinimumRate must be finite and positive"); | ||
| } | ||
| if (getTransferStallTimeout() != null) { | ||
| Preconditions.checkArgument( | ||
| !getTransferStallTimeout().isNegative() && !getTransferStallTimeout().isZero(), | ||
| "transferStallTimeout must be positive"); | ||
| } | ||
| return autoBuild(); | ||
| } | ||
| } | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the initialization of
recoverySettingsfrom the constructor becausecallContextis not yet initialized at construction time (it isnull). CallingcreateFirstRecoveryAttempt()here will throw aNullPointerExceptionwhenstallControlleris not null.