This repository was archived by the owner on Apr 7, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 139
Expand file tree
/
Copy pathTransactionRetryHelperTest.java
More file actions
262 lines (244 loc) · 9.29 KB
/
TransactionRetryHelperTest.java
File metadata and controls
262 lines (244 loc) · 9.29 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
/*
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.spanner;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThrows;
import com.google.api.core.ApiClock;
import com.google.common.base.Stopwatch;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import com.google.protobuf.Duration;
import com.google.rpc.RetryInfo;
import io.grpc.Context;
import io.grpc.Context.CancellableContext;
import io.grpc.Deadline;
import io.grpc.Metadata;
import io.grpc.Status;
import io.grpc.StatusRuntimeException;
import io.grpc.protobuf.ProtoUtils;
import java.util.concurrent.Callable;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
@RunWith(JUnit4.class)
public class TransactionRetryHelperTest {
private static class FakeClock implements ApiClock {
private long currentTime;
@Override
public long nanoTime() {
return TimeUnit.NANOSECONDS.convert(currentTime, TimeUnit.MILLISECONDS);
}
@Override
public long millisTime() {
return currentTime;
}
}
private final TransactionRetryHelper retryHelper =
new TransactionRetryHelper(SpannerOptions.DEFAULT_TRANSACTION_RETRY_SETTINGS);
@Test
public void testRetryDoesNotTimeoutAfterTenMinutes() {
final FakeClock clock = new FakeClock();
final AtomicInteger attempts = new AtomicInteger();
Callable<Integer> callable =
() -> {
if (attempts.getAndIncrement() == 0) {
clock.currentTime += TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES);
throw SpannerExceptionFactory.newSpannerException(ErrorCode.ABORTED, "test");
}
return 1 + 1;
};
assertEquals(
2,
retryHelper
.runTxWithRetriesOnAborted(
callable, SpannerOptions.DEFAULT_TRANSACTION_RETRY_SETTINGS, clock)
.intValue());
}
@Test
public void testRetryDoesFailAfterMoreThanOneDay() {
final FakeClock clock = new FakeClock();
final AtomicInteger attempts = new AtomicInteger();
Callable<Integer> callable =
() -> {
if (attempts.getAndIncrement() == 0) {
clock.currentTime += TimeUnit.MILLISECONDS.convert(25L, TimeUnit.HOURS);
throw SpannerExceptionFactory.newSpannerException(ErrorCode.ABORTED, "test");
}
return 1 + 1;
};
SpannerException e =
assertThrows(
SpannerException.class,
() ->
retryHelper.runTxWithRetriesOnAborted(
callable, SpannerOptions.DEFAULT_TRANSACTION_RETRY_SETTINGS, clock));
assertEquals(ErrorCode.ABORTED, e.getErrorCode());
assertEquals(1, attempts.get());
}
@Test
public void testCancelledContext() {
final CancellableContext withCancellation = Context.current().withCancellation();
final CountDownLatch latch = new CountDownLatch(1);
final Callable<Integer> callable =
() -> {
latch.countDown();
throw SpannerExceptionFactory.newSpannerException(ErrorCode.ABORTED, "test");
};
ScheduledExecutorService service = Executors.newScheduledThreadPool(1);
service.submit(
() -> {
latch.await();
withCancellation.cancel(new InterruptedException());
return null;
});
SpannerException e =
assertThrows(
SpannerException.class,
() -> withCancellation.run(() -> retryHelper.runTxWithRetriesOnAborted(callable)));
assertEquals(ErrorCode.CANCELLED, e.getErrorCode());
}
@Test
public void testTimedOutContext() {
ScheduledExecutorService service = Executors.newScheduledThreadPool(1);
final Callable<Integer> callable =
() -> {
throw SpannerExceptionFactory.newSpannerException(ErrorCode.ABORTED, "test");
};
final CancellableContext withDeadline =
Context.current().withDeadline(Deadline.after(1L, TimeUnit.MILLISECONDS), service);
SpannerException e =
assertThrows(
SpannerException.class,
() -> withDeadline.run(() -> retryHelper.runTxWithRetriesOnAborted(callable)));
assertEquals(ErrorCode.DEADLINE_EXCEEDED, e.getErrorCode());
}
@Test
public void noException() {
Callable<Integer> callable = () -> 1 + 1;
assertThat(retryHelper.runTxWithRetriesOnAborted(callable)).isEqualTo(2);
}
@Test(expected = IllegalStateException.class)
public void propagateUncheckedException() {
Callable<Integer> callable =
() -> {
throw new IllegalStateException("test");
};
retryHelper.runTxWithRetriesOnAborted(callable);
}
@Test
public void retryOnAborted() {
final AtomicInteger attempts = new AtomicInteger();
Callable<Integer> callable =
() -> {
if (attempts.getAndIncrement() == 0) {
throw abortedWithRetryInfo((int) TimeUnit.MILLISECONDS.toNanos(1L));
}
return 1 + 1;
};
assertThat(retryHelper.runTxWithRetriesOnAborted(callable)).isEqualTo(2);
}
@Test
public void retryMultipleTimesOnAborted() {
final AtomicInteger attempts = new AtomicInteger();
Callable<Integer> callable =
() -> {
if (attempts.getAndIncrement() < 2) {
throw abortedWithRetryInfo((int) TimeUnit.MILLISECONDS.toNanos(1));
}
return 1 + 1;
};
assertThat(retryHelper.runTxWithRetriesOnAborted(callable)).isEqualTo(2);
}
@Test(expected = IllegalStateException.class)
public void retryOnAbortedAndThenPropagateUnchecked() {
final AtomicInteger attempts = new AtomicInteger();
Callable<Integer> callable =
() -> {
if (attempts.getAndIncrement() == 0) {
throw abortedWithRetryInfo((int) TimeUnit.MILLISECONDS.toNanos(1L));
}
throw new IllegalStateException("test");
};
retryHelper.runTxWithRetriesOnAborted(callable);
}
@Test
public void testExceptionWithRetryInfo() {
// Workaround from https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6435126.
// See also https://stackoverflow.com/questions/824110/accurate-sleep-for-java-on-windows
// Note that this is a daemon thread, so it will not prevent the JVM from shutting down.
new ThreadFactoryBuilder()
.setDaemon(true)
.build()
.newThread(
() -> {
while (true) {
try {
Thread.sleep(Long.MAX_VALUE);
} catch (InterruptedException e) {
// Ignored exception
}
}
});
final int RETRY_DELAY_MILLIS = 100;
Metadata.Key<RetryInfo> key = ProtoUtils.keyForProto(RetryInfo.getDefaultInstance());
Status status = Status.fromCodeValue(Status.Code.ABORTED.value());
Metadata trailers = new Metadata();
RetryInfo retryInfo =
RetryInfo.newBuilder()
.setRetryDelay(
Duration.newBuilder()
.setNanos(
(int)
TimeUnit.NANOSECONDS.convert(RETRY_DELAY_MILLIS, TimeUnit.MILLISECONDS))
.build())
.build();
trailers.put(key, retryInfo);
final SpannerException e =
SpannerExceptionFactory.newSpannerException(new StatusRuntimeException(status, trailers));
final AtomicInteger attempts = new AtomicInteger();
Callable<Integer> callable =
() -> {
if (attempts.getAndIncrement() == 0) {
throw e;
}
return 1 + 1;
};
// The following call should take at least 100ms, as that is the retry delay specified in the
// retry info of the exception.
Stopwatch watch = Stopwatch.createStarted();
assertThat(retryHelper.runTxWithRetriesOnAborted(callable)).isEqualTo(2);
long elapsed = watch.elapsed(TimeUnit.MILLISECONDS);
// Allow 1ms difference as that should be the accuracy of the sleep method.
assertThat(elapsed).isAtLeast(RETRY_DELAY_MILLIS - 1);
}
private SpannerException abortedWithRetryInfo(int nanos) {
Metadata.Key<RetryInfo> key = ProtoUtils.keyForProto(RetryInfo.getDefaultInstance());
Status status = Status.fromCodeValue(Status.Code.ABORTED.value());
Metadata trailers = new Metadata();
RetryInfo retryInfo =
RetryInfo.newBuilder()
.setRetryDelay(Duration.newBuilder().setNanos(nanos).setSeconds(0L))
.build();
trailers.put(key, retryInfo);
return SpannerExceptionFactory.newSpannerException(
ErrorCode.ABORTED, "test", new StatusRuntimeException(status, trailers));
}
}