Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api: Add java.time.Duration overloads to CallOptions, AbstractStub #11562

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
ab97045
SynchronizationContextTest changes for scheduleFixedDelay with Duration
SreeramdasLavanya Sep 20, 2024
fef4c92
Revert "SynchronizationContextTest changes for scheduleFixedDelay wit…
SreeramdasLavanya Sep 20, 2024
6a713ed
SynchronizationContextTest changes for scheduleFixedDelay with Duration
SreeramdasLavanya Sep 20, 2024
db6c21f
SynchronizationContextTest checkstyle issues updated for issue10245
SreeramdasLavanya Sep 23, 2024
778cfb4
Merge branch 'grpc:master' into master
SreeramdasLavanya Sep 23, 2024
328bcbf
Merge branch 'grpc:master' into master
SreeramdasLavanya Sep 24, 2024
6a66054
Merge branch 'grpc:master' into master
SreeramdasLavanya Sep 26, 2024
84a37e9
Issue 10245 fix for long, TimeUnit to java.time.Duration to API's
SreeramdasLavanya Sep 26, 2024
c1090b7
Issue 10245 - Fixed Checkstyle issues
SreeramdasLavanya Sep 26, 2024
6c56aae
Issue 10245 - Fixed Checkstyle issues
SreeramdasLavanya Sep 26, 2024
4113845
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 1, 2024
4531bc2
Issue 10245 - Reverted java.time.Duration changes for Deadline and De…
SreeramdasLavanya Oct 2, 2024
09c3509
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 8, 2024
bd5a80a
Issue 10245 - Implementation for Duration.toNanos() changes
SreeramdasLavanya Oct 8, 2024
e64f659
grpc-api/stub: Implementation for InternalTimeUtil under grpc-api module
SreeramdasLavanya Oct 9, 2024
0b6c594
grpc-api/stub: Added JUnit for the InternalTimeUtils changes
SreeramdasLavanya Oct 9, 2024
4d0aa82
Merge branch 'master' into FixIssue10245
SreeramdasLavanya Oct 9, 2024
62a88ec
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 9, 2024
b905dfa
Merge branch 'master' into FixIssue10245
SreeramdasLavanya Oct 9, 2024
eb66fe5
grpc-api/stub: Modified JUnit for the InternalTimeUtils changes
SreeramdasLavanya Oct 9, 2024
e76d673
grpc-api: Whitespace formatting for unrelated code
SreeramdasLavanya Oct 15, 2024
f01209b
grpc-api: Whitespace formatting for unrelated code and Reverted stati…
SreeramdasLavanya Oct 16, 2024
de2e185
grpc-api: Reverted static import for InternalTimeUtils.convert method
SreeramdasLavanya Oct 16, 2024
7207da8
grpc-api/stub: Renamed InternalTimeUtils to TimeUtils and its effecte…
SreeramdasLavanya Oct 16, 2024
bf6c521
grpc-api: Formatted whitespaces
SreeramdasLavanya Oct 17, 2024
af01908
grpc-api/stub: Renamed convert() method to convertToNanos()
SreeramdasLavanya Oct 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions api/src/main/java/io/grpc/CallOptions.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@
package io.grpc;

import static com.google.common.base.Preconditions.checkArgument;
import static io.grpc.TimeUtils.convert;

import com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
Expand Down Expand Up @@ -176,6 +178,10 @@ public CallOptions withDeadlineAfter(long duration, TimeUnit unit) {
return withDeadline(Deadline.after(duration, unit));
}

public CallOptions withDeadlineAfter(Duration duration) {
return withDeadlineAfter(convert(duration), TimeUnit.NANOSECONDS);
}

/**
* Returns the deadline or {@code null} if the deadline is not set.
*/
Expand Down
11 changes: 10 additions & 1 deletion api/src/main/java/io/grpc/SynchronizationContext.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@

import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static io.grpc.TimeUtils.convert;

import java.lang.Thread.UncaughtExceptionHandler;
import java.time.Duration;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.concurrent.Executor;
Expand Down Expand Up @@ -193,6 +195,13 @@ public String toString() {
return new ScheduledHandle(runnable, future);
}

public final ScheduledHandle scheduleWithFixedDelay(
final Runnable task, Duration initialDelay, Duration delay,
ScheduledExecutorService timerService) {
return scheduleWithFixedDelay(task, convert(initialDelay), convert(delay),
TimeUnit.NANOSECONDS, timerService);
}


private static class ManagedRunnable implements Runnable {
final Runnable task;
Expand Down Expand Up @@ -246,4 +255,4 @@ public boolean isPending() {
return !(runnable.hasStarted || runnable.isCancelled);
}
}
}
}
29 changes: 29 additions & 0 deletions api/src/main/java/io/grpc/TimeUtils.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* Copyright 2024 The gRPC Authors
*
* 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 io.grpc;

import java.time.Duration;

public final class TimeUtils {

Check warning on line 21 in api/src/main/java/io/grpc/TimeUtils.java

View check run for this annotation

Codecov / codecov/patch

api/src/main/java/io/grpc/TimeUtils.java#L21

Added line #L21 was not covered by tests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't create a new public API. This should be package-private.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are using it from a different package io.grpc.stub.AbstractStub too. We'd have to make a copy of this class then. Is that what we want? @ejona86

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a way to expose internal classes/methods from api:

  1. The class/method itself is package-private
  2. Create a new class for the class name that needs exposing, prefixing the class name with Internal and marking it @Internal
  3. Add accessors in that InternalFoo class.

So here you'd create a public InternalTimeUtils class that has convert() on it. We do the dance because 1) we hide Internal* classes from the javadoc, and 2) when we compile with Blaze we build the Internal* classes as a separate target which is visibility-restricted.

We normally do that for APIs needed to coordinate though, not utilities (core has most utilities). In this case, just duplicating the utility seems reasonable. We'll have at most three copies of it: api, stub, core. Most other things depend on core and it it can be public in core. Not the greatest, but it is small.

public static long convert(Duration duration) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not at all clear you get nanos back. convertToNanos()? toNanos()?

try {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ejona86 Why is Codecov complaining even though the class is in fact covered by unit tests?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see it complaining here. I see it complaining on the class. That is probably for the default public constructor. We should give this class a private, never-called constructor, FWIW. I think Codecov would still point out it isn't covered though.

return duration.toNanos();
} catch (ArithmeticException tooBig) {
return duration.isNegative() ? Long.MIN_VALUE : Long.MAX_VALUE;
}
}
}
9 changes: 9 additions & 0 deletions api/src/test/java/io/grpc/CallOptionsTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import com.google.common.base.Objects;
import io.grpc.ClientStreamTracer.StreamInfo;
import io.grpc.internal.SerializingExecutor;
import java.time.Duration;
import java.util.concurrent.Executor;
import org.junit.Test;
import org.junit.runner.RunWith;
Expand Down Expand Up @@ -150,6 +151,14 @@ public void withDeadlineAfter() {
assertAbout(deadline()).that(actual).isWithin(10, MILLISECONDS).of(expected);
}

@Test
public void withDeadlineAfterDuration() {
Deadline actual = CallOptions.DEFAULT.withDeadlineAfter(Duration.ofMinutes(1L)).getDeadline();
Deadline expected = Deadline.after(1, MINUTES);

assertAbout(deadline()).that(actual).isWithin(10, MILLISECONDS).of(expected);
}

@Test
public void toStringMatches_noDeadline_default() {
String actual = allSet
Expand Down
31 changes: 29 additions & 2 deletions api/src/test/java/io/grpc/SynchronizationContextTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@

import com.google.common.util.concurrent.testing.TestingExecutors;
import io.grpc.SynchronizationContext.ScheduledHandle;
import java.time.Duration;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.LinkedBlockingQueue;
Expand Down Expand Up @@ -72,7 +73,7 @@ public void uncaughtException(Thread t, Throwable e) {

@Mock
private Runnable task3;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove formatting changes in all unrelated places.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you take care of this comment? @SreeramdasLavanya

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whitespace formatting changes are still there in this fie.


@After public void tearDown() {
assertThat(uncaughtErrors).isEmpty();
}
Expand Down Expand Up @@ -246,6 +247,24 @@ public void schedule() {
verify(task1).run();
}

@Test
public void scheduleWithFixedDelayDuration() {
MockScheduledExecutorService executorService = new MockScheduledExecutorService();
ScheduledHandle handle =
syncContext.scheduleWithFixedDelay(task1, Duration.ofSeconds(10),
Duration.ofSeconds(10), executorService);

assertThat(executorService.delay)
.isEqualTo(executorService.unit.convert(10, TimeUnit.SECONDS));
assertThat(handle.isPending()).isTrue();
verify(task1, never()).run();

executorService.command.run();

assertThat(handle.isPending()).isFalse();
verify(task1).run();
}

@Test
public void scheduleDueImmediately() {
MockScheduledExecutorService executorService = new MockScheduledExecutorService();
Expand Down Expand Up @@ -357,5 +376,13 @@ static class MockScheduledExecutorService extends ForwardingScheduledExecutorSer
this.unit = unit;
return future = super.schedule(command, delay, unit);
}

@Override public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long intialDelay,
long delay, TimeUnit unit) {
this.command = command;
this.delay = delay;
this.unit = unit;
return future = super.scheduleWithFixedDelay(command, intialDelay, delay, unit);
}
}
}
}
59 changes: 59 additions & 0 deletions api/src/test/java/io/grpc/TimeUtilsTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/*
* Copyright 2024 The gRPC Authors
*
* 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 io.grpc;

import static org.junit.Assert.assertEquals;

import java.time.Duration;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Unit tests for {@link TimeUtils}. */
@RunWith(JUnit4.class)
public class TimeUtilsTest {

@Test
public void testConvertNormalDuration() {
Duration duration = Duration.ofSeconds(10);
long expected = 10 * 1_000_000_000L;

assertEquals(expected, TimeUtils.convert(duration));
}

@Test
public void testConvertNegativeDuration() {
Duration duration = Duration.ofSeconds(-3);
long expected = -3 * 1_000_000_000L;

assertEquals(expected, TimeUtils.convert(duration));
}

@Test
public void testConvertTooLargeDuration() {
Duration duration = Duration.ofSeconds(Long.MAX_VALUE / 1_000_000_000L + 1);

assertEquals(Long.MAX_VALUE, TimeUtils.convert(duration));
}

@Test
public void testConvertTooLargeNegativeDuration() {
Duration duration = Duration.ofSeconds(Long.MIN_VALUE / 1_000_000_000L - 1);

assertEquals(Long.MIN_VALUE, TimeUtils.convert(duration));
}
}
6 changes: 6 additions & 0 deletions stub/src/main/java/io/grpc/stub/AbstractStub.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package io.grpc.stub;

import static com.google.common.base.Preconditions.checkNotNull;
import static io.grpc.TimeUtils.convert;

import io.grpc.CallCredentials;
import io.grpc.CallOptions;
Expand All @@ -26,6 +27,7 @@
import io.grpc.Deadline;
import io.grpc.ExperimentalApi;
import io.grpc.ManagedChannelBuilder;
import java.time.Duration;
import java.util.concurrent.Executor;
import java.util.concurrent.TimeUnit;
import javax.annotation.CheckReturnValue;
Expand Down Expand Up @@ -149,6 +151,10 @@ public final S withDeadlineAfter(long duration, TimeUnit unit) {
return build(channel, callOptions.withDeadlineAfter(duration, unit));
}

public final S withDeadlineAfter(Duration duration) {
kannanjgithub marked this conversation as resolved.
Show resolved Hide resolved
return withDeadlineAfter(convert(duration), TimeUnit.NANOSECONDS);
}

/**
* Returns a new stub with the given executor that is to be used instead of the default one
* specified with {@link ManagedChannelBuilder#executor}. Note that setting this option may not
Expand Down
22 changes: 21 additions & 1 deletion stub/src/test/java/io/grpc/stub/AbstractStubTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,18 @@

package io.grpc.stub;

import static com.google.common.truth.Truth.assertAbout;
import static com.google.common.truth.Truth.assertThat;
import static io.grpc.testing.DeadlineSubject.deadline;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static java.util.concurrent.TimeUnit.MINUTES;

import io.grpc.CallOptions;
import io.grpc.Channel;
import io.grpc.Deadline;
import io.grpc.stub.AbstractStub.StubFactory;
import io.grpc.stub.AbstractStubTest.NoopStub;
import java.time.Duration;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
Expand All @@ -47,8 +53,22 @@ public NoopStub newStub(Channel channel, CallOptions callOptions) {
.isNull();
}

class NoopStub extends AbstractStub<NoopStub> {
@Test
public void testDuration() {
NoopStub stub = NoopStub.newStub(new StubFactory<NoopStub>() {
@Override
public NoopStub newStub(Channel channel, CallOptions callOptions) {
return create(channel, callOptions);
}
}, channel, CallOptions.DEFAULT);
NoopStub stubInstance = stub.withDeadlineAfter(Duration.ofMinutes(1L));
Deadline actual = stubInstance.getCallOptions().getDeadline();
Deadline expected = Deadline.after(1, MINUTES);

assertAbout(deadline()).that(actual).isWithin(10, MILLISECONDS).of(expected);
}

class NoopStub extends AbstractStub<NoopStub> {
NoopStub(Channel channel, CallOptions options) {
super(channel, options);
}
Expand Down