-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
base: master
Are you sure you want to change the base?
Changes from 25 commits
ab97045
fef4c92
6a713ed
db6c21f
778cfb4
328bcbf
6a66054
84a37e9
c1090b7
6c56aae
4113845
4531bc2
09c3509
bd5a80a
e64f659
0b6c594
4d0aa82
62a88ec
b905dfa
eb66fe5
e76d673
f01209b
de2e185
7207da8
bf6c521
af01908
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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 { | ||
public static long convert(Duration duration) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It is not at all clear you get nanos back. |
||
try { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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; | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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; | ||
|
@@ -72,7 +73,7 @@ public void uncaughtException(Thread t, Throwable e) { | |
|
||
@Mock | ||
private Runnable task3; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove formatting changes in all unrelated places. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you take care of this comment? @SreeramdasLavanya There was a problem hiding this comment. Choose a reason for hiding this commentThe 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(); | ||
} | ||
|
@@ -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(); | ||
|
@@ -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); | ||
} | ||
} | ||
} | ||
} |
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)); | ||
} | ||
} |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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:
Internal
and marking it@Internal
InternalFoo
class.So here you'd create a public
InternalTimeUtils
class that hasconvert()
on it. We do the dance because 1) we hideInternal*
classes from the javadoc, and 2) when we compile with Blaze we build theInternal*
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.