Skip to content

Commit 63b33e9

Browse files
olavloiteolavloite
authored
fix: use streaming retry settings for ResumableStreamIterator (#49)
* fix: use streaming retry settings for ResumableStreamIterator * fix: remove unused reference to backoff
1 parent 38ae1e3 commit 63b33e9

File tree

3 files changed

+77
-92
lines changed

3 files changed

+77
-92
lines changed

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/AbstractResultSet.java

+77-3
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,19 @@
1717
package com.google.cloud.spanner;
1818

1919
import static com.google.cloud.spanner.SpannerExceptionFactory.newSpannerException;
20+
import static com.google.cloud.spanner.SpannerExceptionFactory.newSpannerExceptionForCancellation;
2021
import static com.google.common.base.Preconditions.checkArgument;
2122
import static com.google.common.base.Preconditions.checkNotNull;
2223
import static com.google.common.base.Preconditions.checkState;
2324

2425
import com.google.api.client.util.BackOff;
26+
import com.google.api.client.util.ExponentialBackOff;
27+
import com.google.api.gax.retrying.RetrySettings;
2528
import com.google.cloud.ByteArray;
2629
import com.google.cloud.Date;
2730
import com.google.cloud.Timestamp;
2831
import com.google.cloud.spanner.spi.v1.SpannerRpc;
32+
import com.google.cloud.spanner.v1.stub.SpannerStubSettings;
2933
import com.google.common.annotations.VisibleForTesting;
3034
import com.google.common.base.Function;
3135
import com.google.common.collect.AbstractIterator;
@@ -46,6 +50,7 @@
4650
import io.opencensus.trace.Span;
4751
import io.opencensus.trace.Tracer;
4852
import io.opencensus.trace.Tracing;
53+
import java.io.IOException;
4954
import java.io.Serializable;
5055
import java.util.AbstractList;
5156
import java.util.ArrayList;
@@ -55,7 +60,10 @@
5560
import java.util.LinkedList;
5661
import java.util.List;
5762
import java.util.concurrent.BlockingQueue;
63+
import java.util.concurrent.CountDownLatch;
64+
import java.util.concurrent.Executor;
5865
import java.util.concurrent.LinkedBlockingQueue;
66+
import java.util.concurrent.TimeUnit;
5967
import java.util.logging.Level;
6068
import java.util.logging.Logger;
6169
import javax.annotation.Nullable;
@@ -820,8 +828,10 @@ void setCall(SpannerRpc.StreamingCall call) {
820828
@VisibleForTesting
821829
abstract static class ResumableStreamIterator extends AbstractIterator<PartialResultSet>
822830
implements CloseableIterator<PartialResultSet> {
831+
private static final RetrySettings STREAMING_RETRY_SETTINGS =
832+
SpannerStubSettings.newBuilder().executeStreamingSqlSettings().getRetrySettings();
823833
private static final Logger logger = Logger.getLogger(ResumableStreamIterator.class.getName());
824-
private final BackOff backOff = SpannerImpl.newBackOff();
834+
private final BackOff backOff = newBackOff();
825835
private final LinkedList<PartialResultSet> buffer = new LinkedList<>();
826836
private final int maxBufferSize;
827837
private final Span span;
@@ -841,6 +851,70 @@ protected ResumableStreamIterator(int maxBufferSize, String streamName, Span par
841851
this.span = tracer.spanBuilderWithExplicitParent(streamName, parent).startSpan();
842852
}
843853

854+
private static ExponentialBackOff newBackOff() {
855+
return new ExponentialBackOff.Builder()
856+
.setMultiplier(STREAMING_RETRY_SETTINGS.getRetryDelayMultiplier())
857+
.setInitialIntervalMillis(
858+
(int) STREAMING_RETRY_SETTINGS.getInitialRetryDelay().toMillis())
859+
.setMaxIntervalMillis((int) STREAMING_RETRY_SETTINGS.getMaxRetryDelay().toMillis())
860+
.setMaxElapsedTimeMillis(Integer.MAX_VALUE) // Prevent Backoff.STOP from getting returned.
861+
.build();
862+
}
863+
864+
private static void backoffSleep(Context context, BackOff backoff) throws SpannerException {
865+
backoffSleep(context, nextBackOffMillis(backoff));
866+
}
867+
868+
private static long nextBackOffMillis(BackOff backoff) throws SpannerException {
869+
try {
870+
return backoff.nextBackOffMillis();
871+
} catch (IOException e) {
872+
throw newSpannerException(ErrorCode.INTERNAL, e.getMessage(), e);
873+
}
874+
}
875+
876+
private static void backoffSleep(Context context, long backoffMillis) throws SpannerException {
877+
tracer
878+
.getCurrentSpan()
879+
.addAnnotation(
880+
"Backing off",
881+
ImmutableMap.of("Delay", AttributeValue.longAttributeValue(backoffMillis)));
882+
final CountDownLatch latch = new CountDownLatch(1);
883+
final Context.CancellationListener listener =
884+
new Context.CancellationListener() {
885+
@Override
886+
public void cancelled(Context context) {
887+
// Wakeup on cancellation / DEADLINE_EXCEEDED.
888+
latch.countDown();
889+
}
890+
};
891+
892+
context.addListener(listener, DirectExecutor.INSTANCE);
893+
try {
894+
if (backoffMillis == BackOff.STOP) {
895+
// Highly unlikely but we handle it just in case.
896+
backoffMillis = STREAMING_RETRY_SETTINGS.getMaxRetryDelay().toMillis();
897+
}
898+
if (latch.await(backoffMillis, TimeUnit.MILLISECONDS)) {
899+
// Woken by context cancellation.
900+
throw newSpannerExceptionForCancellation(context, null);
901+
}
902+
} catch (InterruptedException interruptExcept) {
903+
throw newSpannerExceptionForCancellation(context, interruptExcept);
904+
} finally {
905+
context.removeListener(listener);
906+
}
907+
}
908+
909+
private enum DirectExecutor implements Executor {
910+
INSTANCE;
911+
912+
@Override
913+
public void execute(Runnable command) {
914+
command.run();
915+
}
916+
}
917+
844918
abstract CloseableIterator<PartialResultSet> startStream(@Nullable ByteString resumeToken);
845919

846920
@Override
@@ -915,9 +989,9 @@ protected PartialResultSet computeNext() {
915989
try (Scope s = tracer.withSpan(span)) {
916990
long delay = e.getRetryDelayInMillis();
917991
if (delay != -1) {
918-
SpannerImpl.backoffSleep(context, delay);
992+
backoffSleep(context, delay);
919993
} else {
920-
SpannerImpl.backoffSleep(context, backOff);
994+
backoffSleep(context, backOff);
921995
}
922996
}
923997
continue;

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerImpl.java

-77
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@
1616

1717
package com.google.cloud.spanner;
1818

19-
import static com.google.cloud.spanner.SpannerExceptionFactory.newSpannerException;
20-
import static com.google.cloud.spanner.SpannerExceptionFactory.newSpannerExceptionForCancellation;
21-
22-
import com.google.api.client.util.BackOff;
23-
import com.google.api.client.util.ExponentialBackOff;
2419
import com.google.api.gax.paging.Page;
2520
import com.google.cloud.BaseService;
2621
import com.google.cloud.PageImpl;
@@ -32,32 +27,22 @@
3227
import com.google.common.annotations.VisibleForTesting;
3328
import com.google.common.base.Preconditions;
3429
import com.google.common.base.Strings;
35-
import com.google.common.collect.ImmutableMap;
3630
import com.google.common.util.concurrent.Futures;
3731
import com.google.common.util.concurrent.ListenableFuture;
38-
import io.grpc.Context;
39-
import io.opencensus.trace.AttributeValue;
4032
import io.opencensus.trace.Tracer;
4133
import io.opencensus.trace.Tracing;
42-
import java.io.IOException;
4334
import java.util.ArrayList;
4435
import java.util.HashMap;
4536
import java.util.List;
4637
import java.util.Map;
47-
import java.util.concurrent.CountDownLatch;
4838
import java.util.concurrent.ExecutionException;
49-
import java.util.concurrent.Executor;
50-
import java.util.concurrent.TimeUnit;
5139
import java.util.logging.Level;
5240
import java.util.logging.Logger;
5341
import javax.annotation.Nullable;
5442
import javax.annotation.concurrent.GuardedBy;
5543

5644
/** Default implementation of the Cloud Spanner interface. */
5745
class SpannerImpl extends BaseService<SpannerOptions> implements Spanner {
58-
private static final int MIN_BACKOFF_MS = 1000;
59-
private static final int MAX_BACKOFF_MS = 32000;
60-
6146
private static final Logger logger = Logger.getLogger(SpannerImpl.class.getName());
6247
static final Tracer tracer = Tracing.getTracer();
6348

@@ -101,59 +86,6 @@ class SpannerImpl extends BaseService<SpannerOptions> implements Spanner {
10186
this(options.getSpannerRpcV1(), options);
10287
}
10388

104-
static ExponentialBackOff newBackOff() {
105-
return new ExponentialBackOff.Builder()
106-
.setInitialIntervalMillis(MIN_BACKOFF_MS)
107-
.setMaxIntervalMillis(MAX_BACKOFF_MS)
108-
.setMaxElapsedTimeMillis(Integer.MAX_VALUE) // Prevent Backoff.STOP from getting returned.
109-
.build();
110-
}
111-
112-
static void backoffSleep(Context context, BackOff backoff) throws SpannerException {
113-
backoffSleep(context, nextBackOffMillis(backoff));
114-
}
115-
116-
static long nextBackOffMillis(BackOff backoff) throws SpannerException {
117-
try {
118-
return backoff.nextBackOffMillis();
119-
} catch (IOException e) {
120-
throw newSpannerException(ErrorCode.INTERNAL, e.getMessage(), e);
121-
}
122-
}
123-
124-
static void backoffSleep(Context context, long backoffMillis) throws SpannerException {
125-
tracer
126-
.getCurrentSpan()
127-
.addAnnotation(
128-
"Backing off",
129-
ImmutableMap.of("Delay", AttributeValue.longAttributeValue(backoffMillis)));
130-
final CountDownLatch latch = new CountDownLatch(1);
131-
final Context.CancellationListener listener =
132-
new Context.CancellationListener() {
133-
@Override
134-
public void cancelled(Context context) {
135-
// Wakeup on cancellation / DEADLINE_EXCEEDED.
136-
latch.countDown();
137-
}
138-
};
139-
140-
context.addListener(listener, DirectExecutor.INSTANCE);
141-
try {
142-
if (backoffMillis == BackOff.STOP) {
143-
// Highly unlikely but we handle it just in case.
144-
backoffMillis = MAX_BACKOFF_MS;
145-
}
146-
if (latch.await(backoffMillis, TimeUnit.MILLISECONDS)) {
147-
// Woken by context cancellation.
148-
throw newSpannerExceptionForCancellation(context, null);
149-
}
150-
} catch (InterruptedException interruptExcept) {
151-
throw newSpannerExceptionForCancellation(context, interruptExcept);
152-
} finally {
153-
context.removeListener(listener);
154-
}
155-
}
156-
15789
/** Returns the {@link SpannerRpc} of this {@link SpannerImpl} instance. */
15890
SpannerRpc getRpc() {
15991
return gapicRpc;
@@ -286,13 +218,4 @@ void setNextPageToken(String nextPageToken) {
286218

287219
abstract S fromProto(T proto);
288220
}
289-
290-
private enum DirectExecutor implements Executor {
291-
INSTANCE;
292-
293-
@Override
294-
public void execute(Runnable command) {
295-
command.run();
296-
}
297-
}
298221
}

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java

-12
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
import static com.google.common.base.Preconditions.checkNotNull;
2222
import static com.google.common.base.Preconditions.checkState;
2323

24-
import com.google.api.client.util.BackOff;
2524
import com.google.cloud.Timestamp;
2625
import com.google.cloud.spanner.SessionImpl.SessionTransaction;
2726
import com.google.cloud.spanner.spi.v1.SpannerRpc;
@@ -153,17 +152,6 @@ boolean isAborted() {
153152
}
154153
}
155154

156-
/** Return the delay in milliseconds between requests to Cloud Spanner. */
157-
long getRetryDelayInMillis(BackOff backoff) {
158-
long delay = SpannerImpl.nextBackOffMillis(backoff);
159-
synchronized (lock) {
160-
if (retryDelayInMillis >= 0) {
161-
return retryDelayInMillis;
162-
}
163-
}
164-
return delay;
165-
}
166-
167155
void rollback() {
168156
// We're exiting early due to a user exception, but the transaction is still active.
169157
// Send a rollback for the transaction to release any locks held.

0 commit comments

Comments
 (0)