feat: introduce `java.time` by diegomarquezp · Pull Request #2415 · googleapis/java-bigtable

diegomarquezp · 2024-11-14T16:52:16Z

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.

…ava-bigtable into introduce-java-time

…ds + nanos)" This reverts commit a7746ad.

diegomarquezp · 2024-11-22T01:57:24Z

ci / windows failing in several PRs - see this job from #2425

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

google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/models/sql/SqlType.java

google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/models/sql/Statement.java

...rc/main/java/com/google/cloud/bigtable/data/v2/stub/RateLimitingServerStreamingCallable.java

mutianf

I reviewed the following:

common/Type.java
data/v2/BigtableDataSettings.java
data/v2/stub
data/v2/metrics
gaxx/retrying
and tests related to these changes.

mutianf · 2024-12-10T20:31:32Z

...d-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/stub/metrics/CompositeTracer.java

    }
  }

-  public void attemptFailed(Throwable error, Duration delay) {


Instead of deleting this method, should attemptFailled call attemptFailedDuration?

We moved all references in gax to attemptFailedDuration
googleapis/sdk-platform-java#1872

However it still makes sense to keep both. I'll push a commit with this.

I noticed our tracking sheet has a new comment in there. Confirmed it should be as you pointed out.

mutianf · 2024-12-10T20:40:31Z

...e/src/test/java/com/google/cloud/bigtable/data/v2/stub/BigtableBatchingCallSettingsTest.java

      BatchingSettings.newBuilder()
          .setElementCountThreshold(10L)
          .setRequestByteThreshold(20L)
-          .setDelayThreshold(Duration.ofMillis(5))


Im wondering if we should keep the test code the same so that we can verify these settings are ported to the new settings correctly? We can leave a todo to update them in a separate PR.

mutianf · 2024-12-10T20:41:52Z

...gtable/src/test/java/com/google/cloud/bigtable/data/v2/stub/metrics/CompositeTracerTest.java

  public void testAttemptFailed() {
    RuntimeException error = new RuntimeException();
    Duration delay = Duration.ofMillis(10);
-    compositeTracer.attemptFailed(error, delay);


same here, I think we should keep calling attemptFailed and verify attemptFailedDuration gets called?

jackdingilian

I reviewed the following files and their corresponding tests:
internal/AbstractProtoStructReader.java
internal/ResultSetImpl.java
models/ChangeStreamMutation.java
models/ChangeStreamRecordAdapter.java
models/Heartbeat.java
models/ReadChangeStreamQuery.java
models/sql/SqlType.java
models/sql/Statement.java
models/sql/StructReader.java
changestream/ChangeStreamStateMachine.java

jackdingilian · 2024-12-11T17:38:08Z

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

+
+    /** This method is obsolete. Use {@link #setCommitTime(java.time.Instant)} instead. */
+    @ObsoleteApi("Use setCommitTime(java.time.Instant) instead")
+    abstract Builder setCommitTimestamp(org.threeten.bp.Instant commitTimestamp);


I think it would be better to remove the threeten setter, only store it as java.time.Instant, and then reverse the overload of getCommitTime(stamp) above.

The builder is fully internal, we just need to maintain backwards compatibility for the getter

Thanks for the catch. This was indeed stated in the tracking sheet. I'll update this as an internal class.

jackdingilian · 2024-12-11T17:39:31Z

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

    abstract Builder setToken(@Nonnull String token);

-    abstract Builder setEstimatedLowWatermark(Instant estimatedLowWatermark);
+    Builder setLowWatermarkTime(java.time.Instant estimatedLowWatermark) {


Same question as for commit time. Also if we need to keep both setters this should be 'setEstimatedLowWatermarkTime'

jackdingilian · 2024-12-11T17:39:58Z

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

+    }
+
+    /** This method is obsolete. Use {@link #setLowWatermarkTime(java.time.Instant)} instead. */
+    @ObsoleteApi("Use setEstimatedLowWatermarkInstant(java.time.Instant) instead")


setEstimatedLowWatermarkInstant should be setEstimatedLowWatermarkTime

This will be removed since it's an internal api change as per #2415 (comment)

jackdingilian · 2024-12-11T17:42:23Z

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


+  /** This method is obsolete. Use {@link #getEstimatedLowWatermarkInstant()} instead. */
+  @ObsoleteApi("Use getEstimatedLowWatermarkInstant() instead")
+  public abstract org.threeten.bp.Instant getEstimatedLowWatermark();


Same question as in ChangeStreamMutation. Wouldn't it be better to store this as java.time.Instant?

jackdingilian · 2024-12-11T17:49:45Z

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

+
  @InternalApi("Intended for use by the BigtableIO in apache/beam only.")
-  public abstract Instant getEstimatedLowWatermark();
+  public java.time.Instant getEstimatedLowWatermarkInstant() {


In ChangeStreamMutation we call this getEstimatedLowWatermarkTime. We should be consistent w that naming here

Removed as this is an internal api. I only kept the java.time version

jackdingilian · 2024-12-11T20:32:50Z

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


-  /** Get the commit timestamp of the current mutation. */
-  public abstract Instant getCommitTimestamp();
+  public abstract java.time.Instant getCommitTimestamp();


We still need the threeten getter here, since this is used by beam users. Same for Heartbeat below

And for estimatedLowWatermark

This reverts commit 51657d8.

diegomarquezp · 2024-12-12T16:04:53Z

@jackdingilian thanks for the review and apologies for the misunderstanding. This time I got it right:

ChangeStreamMutation.Builder setters directly switched to java.time, no overloads.
ChangeStreamMutation getters have been swapped: java.time is abstract and threeten delegates.
We respect the java.time name getEstimatedLowWatermarkTime (the Instant suffix was corrected)
Heartbeat getters have been swapped: java.time is abstract and threeten delegates.

diegomarquezp added 2 commits November 14, 2024 16:27

feat: introduce java.time to java-bigtable

71aa9a8

fix tests i

62dd45f

product-auto-label bot added size: l Pull request size is large. api: bigtable Issues related to the googleapis/java-bigtable API. labels Nov 14, 2024

cloud-java-bot and others added 13 commits November 14, 2024 16:55

chore: generate libraries at Thu Nov 14 16:52:48 UTC 2024

959a469

fix tests

ca275dc

make protobuf timestamp conversion fully precise (epoch seconds + nanos)

a7746ad

Merge branch 'introduce-java-time' of https://github.com/googleapis/j…

321c952

…ava-bigtable into introduce-java-time

resolve to microsecond level

d25d6ef

Revert "make protobuf timestamp conversion fully precise (epoch secon…

796aa4b

…ds + nanos)" This reverts commit a7746ad.

restore ms precision

a7e6167

fix precision in tests

0072191

fix tests

99600a6

fix tests, clirr

3765977

fix test proxy

38b13e9

format

f6efe6b

format ii

41bc6ea

diegomarquezp added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 20, 2024

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 20, 2024

fix ITs

e06a104

diegomarquezp commented Nov 22, 2024

View reviewed changes

google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/common/Type.java Show resolved Hide resolved

diegomarquezp commented Nov 22, 2024

View reviewed changes

google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/models/sql/SqlType.java Outdated Show resolved Hide resolved

diegomarquezp commented Nov 22, 2024

View reviewed changes

google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/models/sql/Statement.java Outdated Show resolved Hide resolved

diegomarquezp commented Nov 22, 2024

View reviewed changes

...rc/main/java/com/google/cloud/bigtable/data/v2/stub/RateLimitingServerStreamingCallable.java Show resolved Hide resolved

fix it, timestamp precision

fc920b0

diegomarquezp marked this pull request as ready for review November 22, 2024 02:12

diegomarquezp requested a review from a team as a code owner November 22, 2024 02:12

diegomarquezp requested a review from a team November 22, 2024 02:12

diegomarquezp requested a review from a team as a code owner November 22, 2024 02:12

diegomarquezp removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Dec 7, 2024

mutianf reviewed Dec 10, 2024

View reviewed changes

diegomarquezp added 2 commits December 11, 2024 10:51

restore metrics

540b19d

use threeten methods in tests

ce6a279

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Dec 11, 2024

diegomarquezp requested a review from mutianf December 11, 2024 17:03

mutianf approved these changes Dec 11, 2024

View reviewed changes

jackdingilian reviewed Dec 11, 2024

View reviewed changes

convert to internal changes in change stream classes

51657d8

product-auto-label bot added size: m Pull request size is medium. and removed size: l Pull request size is large. labels Dec 11, 2024

diegomarquezp requested a review from jackdingilian December 11, 2024 20:24

jackdingilian reviewed Dec 11, 2024

View reviewed changes

diegomarquezp added 2 commits December 12, 2024 10:40

Revert "convert to internal changes in change stream classes"

06501e7

This reverts commit 51657d8.

convert to internal changes in change stream classes ii

ed0213d

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Dec 12, 2024

diegomarquezp requested a review from jackdingilian December 12, 2024 16:05

jackdingilian approved these changes Dec 12, 2024

View reviewed changes

fix clirr

5994e4f

diegomarquezp added the automerge Merge the pull request once unit tests and other checks pass. label Dec 13, 2024

Merge branch 'main' into introduce-java-time

7ce813f

gcf-merge-on-green bot merged commit bb96c3e into main Dec 13, 2024
19 checks passed

gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Dec 13, 2024

gcf-merge-on-green bot deleted the introduce-java-time branch December 13, 2024 19:14

diegomarquezp mentioned this pull request Dec 16, 2024

Update tests to use java.time methods #2451

Open

release-please bot mentioned this pull request Dec 17, 2024

chore(main): release 2.51.0 #2453

Merged

release-please bot mentioned this pull request Dec 15, 2025

chore(protobuf-4.x-rc): release 2.71.0-rc1 #2726

Merged

Conversation

diegomarquezp commented Nov 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

diegomarquezp commented Nov 22, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mutianf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jackdingilian left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diegomarquezp commented Dec 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

diegomarquezp commented Nov 14, 2024 •

edited

Loading

diegomarquezp commented Dec 12, 2024 •

edited

Loading