Skip to content

Commit bb96c3e

Browse files
diegomarquezpdiegomarquezp
authored
feat: introduce java.time (#2415)
This PR introduces `java.time` alternatives to existing `org.threeten.bp.*` methods, as well as switching internal variables (if any) to `java.time` The main constraint is to keep the changes backwards compatible, so for each existing threeten method "`method1(org.threeten.bp.Duration)`" we will add an alternative with a _Duration_ (or _Timestamp_ when applicable) suffix: "`method1Duration(java.time.Duration)`". For most cases, the implementation will be held in the `java.time` method and the old threeten method will just delegate the call to it. However, for the case of abstract classes, the implementation will be kept in the threeten method to avoid breaking changes (i.e. users that already overloaded the method in their user code). Note: https://cloud.google.com/bigtable/docs/reference/sql/data-types#timestamp_type implies that nanosecond precision will be ignored.
1 parent f98dca1 commit bb96c3e

45 files changed

Lines changed: 289 additions & 145 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎google-cloud-bigtable/clirr-ignored-differences.xml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,4 +275,37 @@
275275
<className>com/google/cloud/bigtable/data/v2/stub/metrics/DefaultMetricsProvider</className>
276276
<method>*</method>
277277
</difference>
278+
<difference>
279+
<!-- InternalApi was updated -->
280+
<differenceType>7006</differenceType>
281+
<className>com/google/cloud/bigtable/data/v2/internal/*</className>
282+
<method>*getTimestamp(*)</method>
283+
<to>java.time.Instant</to>
284+
</difference>
285+
<difference>
286+
<!-- BetaApi was updated -->
287+
<differenceType>7006</differenceType>
288+
<className>com/google/cloud/bigtable/data/v2/models/sql/StructReader</className>
289+
<method>*getTimestamp(*)</method>
290+
<to>java.time.Instant</to>
291+
</difference>
292+
<difference>
293+
<!-- BetaApi was updated -->
294+
<differenceType>7005</differenceType>
295+
<className>com/google/cloud/bigtable/data/v2/models/sql/Statement$Builder</className>
296+
<method>*setTimestampParam(java.lang.String, org.threeten.bp.Instant)</method>
297+
<to>*setTimestampParam(java.lang.String, java.time.Instant)</to>
298+
</difference>
299+
<difference>
300+
<!-- ChangeStream api is internal, only used by apache/beam-->
301+
<differenceType>7013</differenceType>
302+
<className>com/google/cloud/bigtable/data/v2/models/ChangeStreamMutation</className>
303+
<method>*get*Time()</method>
304+
</difference>
305+
<difference>
306+
<!-- Heartbeat is part of the ChangeStream api, which is internal and only used by apache/beam-->
307+
<differenceType>7013</differenceType>
308+
<className>com/google/cloud/bigtable/data/v2/models/Heartbeat</className>
309+
<method>*getEstimatedLowWatermarkTime()</method>
310+
</difference>
278311
</differences>

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/common/Type.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
import com.google.common.base.Objects;
2424
import com.google.common.collect.ImmutableList;
2525
import com.google.protobuf.ByteString;
26+
import java.time.Instant;
2627
import java.util.List;
27-
import org.threeten.bp.Instant;
2828

2929
/**
3030
* Shared type implementations. Right now this is only used by SqlType but this will become a shared

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/BigtableDataSettings.java‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@
3939
import java.util.logging.Logger;
4040
import javax.annotation.Nonnull;
4141
import javax.annotation.Nullable;
42-
import org.threeten.bp.Duration;
4342

4443
/**
4544
* Settings class to configure an instance of {@link BigtableDataClient}.
@@ -134,9 +133,11 @@ public static Builder newBuilderForEmulator(String hostname, int port) {
134133
.setMaxInboundMessageSize(256 * 1024 * 1024)
135134
.setChannelPoolSettings(ChannelPoolSettings.staticallySized(1))
136135
.setChannelConfigurator(ManagedChannelBuilder::usePlaintext)
137-
.setKeepAliveTime(Duration.ofSeconds(61)) // sends ping in this interval
138-
.setKeepAliveTimeout(
139-
Duration.ofSeconds(10)) // wait this long before considering the connection dead
136+
.setKeepAliveTimeDuration(
137+
java.time.Duration.ofSeconds(61)) // sends ping in this interval
138+
.setKeepAliveTimeoutDuration(
139+
java.time.Duration.ofSeconds(
140+
10)) // wait this long before considering the connection dead
140141
.build());
141142

142143
LOGGER.info("Connecting to the Bigtable emulator at " + hostname + ":" + port);

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/internal/AbstractProtoStructReader.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@
2525
import com.google.common.base.Preconditions;
2626
import com.google.protobuf.ByteString;
2727
import com.google.protobuf.Timestamp;
28+
import java.time.Instant;
2829
import java.util.ArrayList;
2930
import java.util.Collections;
3031
import java.util.HashMap;
3132
import java.util.List;
3233
import java.util.Map;
33-
import org.threeten.bp.Instant;
3434

3535
@InternalApi
3636
public abstract class AbstractProtoStructReader implements StructReader {

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/internal/ResultSetImpl.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@
2828
import com.google.cloud.bigtable.data.v2.stub.sql.SqlServerStream;
2929
import com.google.common.base.Preconditions;
3030
import com.google.protobuf.ByteString;
31+
import java.time.Instant;
3132
import java.util.Iterator;
3233
import java.util.List;
3334
import java.util.Map;
34-
import org.threeten.bp.Instant;
3535

3636
/**
3737
* The primary implementation of a ResultSet.

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/models/ChangeStreamMutation.java‎

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,17 @@
1515
*/
1616
package com.google.cloud.bigtable.data.v2.models;
1717

18+
import static com.google.api.gax.util.TimeConversionUtils.toThreetenInstant;
19+
1820
import com.google.api.core.InternalApi;
21+
import com.google.api.core.ObsoleteApi;
1922
import com.google.auto.value.AutoValue;
2023
import com.google.cloud.bigtable.data.v2.models.Range.TimestampRange;
2124
import com.google.cloud.bigtable.data.v2.stub.changestream.ChangeStreamRecordMerger;
2225
import com.google.common.collect.ImmutableList;
2326
import com.google.protobuf.ByteString;
2427
import java.io.Serializable;
2528
import javax.annotation.Nonnull;
26-
import org.threeten.bp.Instant;
2729

2830
/**
2931
* A ChangeStreamMutation represents a list of mods(represented by List<{@link Entry}>) targeted at
@@ -73,13 +75,13 @@ public enum MutationType {
7375
static Builder createUserMutation(
7476
@Nonnull ByteString rowKey,
7577
@Nonnull String sourceClusterId,
76-
Instant commitTimestamp,
78+
java.time.Instant commitTimestamp,
7779
int tieBreaker) {
7880
return builder()
7981
.setRowKey(rowKey)
8082
.setType(MutationType.USER)
8183
.setSourceClusterId(sourceClusterId)
82-
.setCommitTimestamp(commitTimestamp)
84+
.setCommitTime(commitTimestamp)
8385
.setTieBreaker(tieBreaker);
8486
}
8587

@@ -89,12 +91,12 @@ static Builder createUserMutation(
8991
* mutation.
9092
*/
9193
static Builder createGcMutation(
92-
@Nonnull ByteString rowKey, Instant commitTimestamp, int tieBreaker) {
94+
@Nonnull ByteString rowKey, java.time.Instant commitTimestamp, int tieBreaker) {
9395
return builder()
9496
.setRowKey(rowKey)
9597
.setType(MutationType.GARBAGE_COLLECTION)
9698
.setSourceClusterId("")
97-
.setCommitTimestamp(commitTimestamp)
99+
.setCommitTime(commitTimestamp)
98100
.setTieBreaker(tieBreaker);
99101
}
100102

@@ -110,8 +112,14 @@ static Builder createGcMutation(
110112
@Nonnull
111113
public abstract String getSourceClusterId();
112114

115+
/** This method is obsolete. Use {@link #getCommitTime()} instead. */
116+
@ObsoleteApi("Use getCommitTime() instead")
117+
public org.threeten.bp.Instant getCommitTimestamp() {
118+
return toThreetenInstant(getCommitTime());
119+
}
120+
113121
/** Get the commit timestamp of the current mutation. */
114-
public abstract Instant getCommitTimestamp();
122+
public abstract java.time.Instant getCommitTime();
115123

116124
/**
117125
* Get the tie breaker of the current mutation. This is used to resolve conflicts when multiple
@@ -123,8 +131,14 @@ static Builder createGcMutation(
123131
@Nonnull
124132
public abstract String getToken();
125133

134+
/** This method is obsolete. Use {@link #getEstimatedLowWatermarkTime()} instead. */
135+
@ObsoleteApi("Use getEstimatedLowWatermarkTime() instead")
136+
public org.threeten.bp.Instant getEstimatedLowWatermark() {
137+
return toThreetenInstant(getEstimatedLowWatermarkTime());
138+
}
139+
126140
/** Get the low watermark of the current mutation. */
127-
public abstract Instant getEstimatedLowWatermark();
141+
public abstract java.time.Instant getEstimatedLowWatermarkTime();
128142

129143
/** Get the list of mods of the current mutation. */
130144
@Nonnull
@@ -145,15 +159,15 @@ abstract static class Builder {
145159

146160
abstract Builder setSourceClusterId(@Nonnull String sourceClusterId);
147161

148-
abstract Builder setCommitTimestamp(Instant commitTimestamp);
162+
abstract Builder setCommitTime(java.time.Instant commitTimestamp);
149163

150164
abstract Builder setTieBreaker(int tieBreaker);
151165

152166
abstract ImmutableList.Builder<Entry> entriesBuilder();
153167

154168
abstract Builder setToken(@Nonnull String token);
155169

156-
abstract Builder setEstimatedLowWatermark(Instant estimatedLowWatermark);
170+
abstract Builder setEstimatedLowWatermarkTime(java.time.Instant estimatedLowWatermark);
157171

158172
Builder setCell(
159173
@Nonnull String familyName,

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/models/ChangeStreamRecordAdapter.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
import com.google.bigtable.v2.ReadChangeStreamResponse;
2020
import com.google.cloud.bigtable.data.v2.models.Range.TimestampRange;
2121
import com.google.protobuf.ByteString;
22+
import java.time.Instant;
2223
import javax.annotation.Nonnull;
23-
import org.threeten.bp.Instant;
2424

2525
/**
2626
* An extension point that allows end users to plug in a custom implementation of logical change

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/models/DefaultChangeStreamRecordAdapter.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020
import com.google.cloud.bigtable.data.v2.models.Range.TimestampRange;
2121
import com.google.common.base.Preconditions;
2222
import com.google.protobuf.ByteString;
23+
import java.time.Instant;
2324
import javax.annotation.Nonnull;
2425
import javax.annotation.Nullable;
25-
import org.threeten.bp.Instant;
2626

2727
/**
2828
* Default implementation of a {@link ChangeStreamRecordAdapter} that uses {@link
@@ -112,8 +112,7 @@ public void startUserMutation(
112112

113113
/** {@inheritDoc} */
114114
@Override
115-
public void startGcMutation(
116-
@Nonnull ByteString rowKey, Instant commitTimestamp, int tieBreaker) {
115+
public void startGcMutation(ByteString rowKey, Instant commitTimestamp, int tieBreaker) {
117116
this.changeStreamMutationBuilder =
118117
ChangeStreamMutation.createGcMutation(rowKey, commitTimestamp, tieBreaker);
119118
}
@@ -176,9 +175,9 @@ public void finishCell() {
176175
/** {@inheritDoc} */
177176
@Override
178177
public ChangeStreamRecord finishChangeStreamMutation(
179-
@Nonnull String token, Instant estimatedLowWatermark) {
178+
String token, Instant estimatedLowWatermark) {
180179
this.changeStreamMutationBuilder.setToken(token);
181-
this.changeStreamMutationBuilder.setEstimatedLowWatermark(estimatedLowWatermark);
180+
this.changeStreamMutationBuilder.setEstimatedLowWatermarkTime(estimatedLowWatermark);
182181
return this.changeStreamMutationBuilder.build();
183182
}
184183

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/models/Heartbeat.java‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@
1515
*/
1616
package com.google.cloud.bigtable.data.v2.models;
1717

18+
import static com.google.api.gax.util.TimeConversionUtils.toThreetenInstant;
19+
1820
import com.google.api.core.InternalApi;
21+
import com.google.api.core.ObsoleteApi;
1922
import com.google.auto.value.AutoValue;
2023
import com.google.bigtable.v2.ReadChangeStreamResponse;
2124
import java.io.Serializable;
2225
import javax.annotation.Nonnull;
23-
import org.threeten.bp.Instant;
2426

2527
/** A simple wrapper for {@link ReadChangeStreamResponse.Heartbeat}. */
2628
@InternalApi("Intended for use by the BigtableIO in apache/beam only.")
@@ -29,22 +31,29 @@ public abstract class Heartbeat implements ChangeStreamRecord, Serializable {
2931
private static final long serialVersionUID = 7316215828353608504L;
3032

3133
private static Heartbeat create(
32-
ChangeStreamContinuationToken changeStreamContinuationToken, Instant estimatedLowWatermark) {
34+
ChangeStreamContinuationToken changeStreamContinuationToken,
35+
java.time.Instant estimatedLowWatermark) {
3336
return new AutoValue_Heartbeat(changeStreamContinuationToken, estimatedLowWatermark);
3437
}
3538

3639
/** Wraps the protobuf {@link ReadChangeStreamResponse.Heartbeat}. */
3740
static Heartbeat fromProto(@Nonnull ReadChangeStreamResponse.Heartbeat heartbeat) {
3841
return create(
3942
ChangeStreamContinuationToken.fromProto(heartbeat.getContinuationToken()),
40-
Instant.ofEpochSecond(
43+
java.time.Instant.ofEpochSecond(
4144
heartbeat.getEstimatedLowWatermark().getSeconds(),
4245
heartbeat.getEstimatedLowWatermark().getNanos()));
4346
}
4447

4548
@InternalApi("Intended for use by the BigtableIO in apache/beam only.")
4649
public abstract ChangeStreamContinuationToken getChangeStreamContinuationToken();
4750

51+
/** This method is obsolete. Use {@link #getEstimatedLowWatermarkTime()} instead. */
52+
@ObsoleteApi("Use getEstimatedLowWatermarkTime() instead")
53+
public org.threeten.bp.Instant getEstimatedLowWatermark() {
54+
return toThreetenInstant(getEstimatedLowWatermarkTime());
55+
}
56+
4857
@InternalApi("Intended for use by the BigtableIO in apache/beam only.")
49-
public abstract Instant getEstimatedLowWatermark();
58+
public abstract java.time.Instant getEstimatedLowWatermarkTime();
5059
}

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/models/ReadChangeStreamQuery.java‎

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@
1515
*/
1616
package com.google.cloud.bigtable.data.v2.models;
1717

18+
import static com.google.api.gax.util.TimeConversionUtils.toJavaTimeDuration;
19+
import static com.google.api.gax.util.TimeConversionUtils.toJavaTimeInstant;
20+
1821
import com.google.api.core.InternalApi;
22+
import com.google.api.core.ObsoleteApi;
1923
import com.google.bigtable.v2.ReadChangeStreamRequest;
2024
import com.google.bigtable.v2.RowRange;
2125
import com.google.bigtable.v2.StreamContinuationTokens;
@@ -36,7 +40,6 @@
3640
import java.util.List;
3741
import javax.annotation.Nonnull;
3842
import javax.annotation.Nullable;
39-
import org.threeten.bp.Instant;
4043

4144
/** A simple wrapper to construct a query for the ReadChangeStream RPC. */
4245
@InternalApi("Intended for use by the BigtableIO in apache/beam only.")
@@ -143,8 +146,14 @@ public ReadChangeStreamQuery streamPartition(ByteStringRange range) {
143146
return streamPartition(rangeBuilder.build());
144147
}
145148

149+
/** This method is obsolete. Use {@link #startTime(java.time.Instant)} instead. */
150+
@ObsoleteApi("Use startTime(java.time.Instant) instead")
151+
public ReadChangeStreamQuery startTime(org.threeten.bp.Instant value) {
152+
return startTime(toJavaTimeInstant(value));
153+
}
154+
146155
/** Sets the startTime to read the change stream. */
147-
public ReadChangeStreamQuery startTime(Instant value) {
156+
public ReadChangeStreamQuery startTime(java.time.Instant value) {
148157
Preconditions.checkState(
149158
!builder.hasContinuationTokens(),
150159
"startTime and continuationTokens can't be specified together");
@@ -156,8 +165,14 @@ public ReadChangeStreamQuery startTime(Instant value) {
156165
return this;
157166
}
158167

168+
/** This method is obsolete. Use {@link #endTime(java.time.Instant)} instead. */
169+
@ObsoleteApi("Use endTime(java.time.Instant) instead")
170+
public ReadChangeStreamQuery endTime(org.threeten.bp.Instant value) {
171+
return endTime(toJavaTimeInstant(value));
172+
}
173+
159174
/** Sets the endTime to read the change stream. */
160-
public ReadChangeStreamQuery endTime(Instant value) {
175+
public ReadChangeStreamQuery endTime(java.time.Instant value) {
161176
builder.setEndTime(
162177
Timestamp.newBuilder()
163178
.setSeconds(value.getEpochSecond())
@@ -181,8 +196,14 @@ public ReadChangeStreamQuery continuationTokens(
181196
return this;
182197
}
183198

184-
/** Sets the heartbeat duration for the change stream. */
199+
/** This method is obsolete. Use {@link #heartbeatDuration(java.time.Duration)} instead. */
200+
@ObsoleteApi("Use heartbeatDuration(java.time.Duration) instead")
185201
public ReadChangeStreamQuery heartbeatDuration(org.threeten.bp.Duration duration) {
202+
return heartbeatDuration(toJavaTimeDuration(duration));
203+
}
204+
205+
/** Sets the heartbeat duration for the change stream. */
206+
public ReadChangeStreamQuery heartbeatDuration(java.time.Duration duration) {
186207
builder.setHeartbeatDuration(
187208
Duration.newBuilder()
188209
.setSeconds(duration.getSeconds())

0 commit comments

Comments
 (0)