core: Make timestamp usage in Channelz use nanos from Java.time.Instant when available (#11604)

When java.time.Instant is available use the timestamp from this class in nano precision rather than using System.currentTimeInMillis and converting it to nanos.

Fixes #5494.
This commit is contained in:
vinodhabib 2024-10-29 10:19:47 +05:30 committed by GitHub
parent 735b3f3fe6
commit 9176b55286
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 217 additions and 8 deletions

View File

@ -0,0 +1,32 @@
/*
* 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.internal;
import java.util.concurrent.TimeUnit;
/**
* {@link ConcurrentTimeProvider} resolves ConcurrentTimeProvider which implements
* {@link TimeProvider}.
*/
final class ConcurrentTimeProvider implements TimeProvider {
@Override
public long currentTimeNanos() {
return TimeUnit.MILLISECONDS.toNanos(System.currentTimeMillis());
}
}

View File

@ -0,0 +1,54 @@
/*
* 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.internal;
import static com.google.common.math.LongMath.saturatedAdd;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.concurrent.TimeUnit;
/**
* {@link InstantTimeProvider} resolves InstantTimeProvider which implements {@link TimeProvider}.
*/
final class InstantTimeProvider implements TimeProvider {
private Method now;
private Method getNano;
private Method getEpochSecond;
public InstantTimeProvider(Class<?> instantClass) {
try {
this.now = instantClass.getMethod("now");
this.getNano = instantClass.getMethod("getNano");
this.getEpochSecond = instantClass.getMethod("getEpochSecond");
} catch (NoSuchMethodException ex) {
throw new AssertionError(ex);
}
}
@Override
public long currentTimeNanos() {
try {
Object instant = now.invoke(null);
int nanos = (int) getNano.invoke(instant);
long epochSeconds = (long) getEpochSecond.invoke(instant);
return saturatedAdd(TimeUnit.SECONDS.toNanos(epochSeconds), nanos);
} catch (IllegalAccessException | InvocationTargetException ex) {
throw new RuntimeException(ex);
}
}
}

View File

@ -16,8 +16,6 @@
package io.grpc.internal;
import java.util.concurrent.TimeUnit;
/**
* Time source representing the current system time in nanos. Used to inject a fake clock
* into unit tests.
@ -26,10 +24,5 @@ public interface TimeProvider {
/** Returns the current nano time. */
long currentTimeNanos();
TimeProvider SYSTEM_TIME_PROVIDER = new TimeProvider() {
@Override
public long currentTimeNanos() {
return TimeUnit.MILLISECONDS.toNanos(System.currentTimeMillis());
}
};
TimeProvider SYSTEM_TIME_PROVIDER = TimeProviderResolverFactory.resolveTimeProvider();
}

View File

@ -0,0 +1,32 @@
/*
* 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.internal;
/**
* {@link TimeProviderResolverFactory} resolves Time providers.
*/
final class TimeProviderResolverFactory {
static TimeProvider resolveTimeProvider() {
try {
Class<?> instantClass = Class.forName("java.time.Instant");
return new InstantTimeProvider(instantClass);
} catch (ClassNotFoundException ex) {
return new ConcurrentTimeProvider();
}
}
}

View File

@ -0,0 +1,48 @@
/*
* 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.internal;
import static com.google.common.truth.Truth.assertThat;
import java.time.Instant;
import java.util.concurrent.TimeUnit;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/**
* Unit tests for {@link ConcurrentTimeProvider}.
*/
@RunWith(JUnit4.class)
public class ConcurrentTimeProviderTest {
@Test
public void testConcurrentCurrentTimeNanos() {
ConcurrentTimeProvider concurrentTimeProvider = new ConcurrentTimeProvider();
// Get the current time from the ConcurrentTimeProvider
long actualTimeNanos = concurrentTimeProvider.currentTimeNanos();
// Get the current time from Instant for comparison
Instant instantNow = Instant.now();
long expectedTimeNanos = TimeUnit.SECONDS.toNanos(instantNow.getEpochSecond())
+ instantNow.getNano();
// Validate the time returned is close to the expected value within a tolerance
// (i,e 10 millisecond tolerance in nanoseconds).
assertThat(actualTimeNanos).isWithin(10_000_000L).of(expectedTimeNanos);
}
}

View File

@ -0,0 +1,50 @@
/*
* 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.internal;
import static com.google.common.truth.Truth.assertThat;
import java.time.Instant;
import java.util.concurrent.TimeUnit;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/**
* Unit tests for {@link InstantTimeProvider}.
*/
@RunWith(JUnit4.class)
public class InstantTimeProviderTest {
@Test
public void testInstantCurrentTimeNanos() throws Exception {
InstantTimeProvider instantTimeProvider = new InstantTimeProvider(
Class.forName("java.time.Instant"));
// Get the current time from the InstantTimeProvider
long actualTimeNanos = instantTimeProvider.currentTimeNanos();
// Get the current time from Instant for comparison
Instant instantNow = Instant.now();
long expectedTimeNanos = TimeUnit.SECONDS.toNanos(instantNow.getEpochSecond())
+ instantNow.getNano();
// Validate the time returned is close to the expected value within a tolerance
// (i,e 10 millisecond tolerance in nanoseconds).
assertThat(actualTimeNanos).isWithin(10_000_000L).of(expectedTimeNanos);
}
}