-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat(storage): add support for DirectPath over Interconnect #14006
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
base: main
Are you sure you want to change the base?
Changes from all commits
23147be
213ada7
c1b4f5f
e0177bd
aee5030
fb844cb
618641b
580252a
dfcad40
2a9ed3b
20c37c6
640c499
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 |
|---|---|---|
|
|
@@ -134,6 +134,8 @@ public final class GrpcStorageOptions extends StorageOptions | |
| private static final String GCS_SCOPE = "https://www.googleapis.com/auth/devstorage.full_control"; | ||
| private static final Set<String> SCOPES = ImmutableSet.of(GCS_SCOPE); | ||
| private static final String DEFAULT_HOST = "https://storage.googleapis.com"; | ||
| private static final String DEFAULT_HOST_NO_SCHEME = "storage.googleapis.com"; | ||
|
nidhiii-27 marked this conversation as resolved.
|
||
| private static final String DEFAULT_HOST_DIRECT_PATH_NO_SCHEME = "storage-direct.googleapis.com"; | ||
| // If true, disable the bound-token-by-default feature for DirectPath. | ||
| private static final boolean DIRECT_PATH_BOUND_TOKEN_DISABLED = | ||
| Boolean.parseBoolean( | ||
|
|
@@ -142,6 +144,7 @@ public final class GrpcStorageOptions extends StorageOptions | |
| private final GrpcRetryAlgorithmManager retryAlgorithmManager; | ||
| private final java.time.Duration terminationAwaitDuration; | ||
| private final boolean attemptDirectPath; | ||
| private final boolean attemptDirectPathXdsOverInterconnect; | ||
| private final boolean enableGrpcClientMetrics; | ||
|
|
||
| private final boolean grpcClientMetricsManuallyEnabled; | ||
|
|
@@ -160,6 +163,7 @@ private GrpcStorageOptions(Builder builder, GrpcStorageDefaults serviceDefaults) | |
| builder.terminationAwaitDuration, | ||
| serviceDefaults.getTerminationAwaitDurationJavaTime()); | ||
| this.attemptDirectPath = builder.attemptDirectPath; | ||
| this.attemptDirectPathXdsOverInterconnect = builder.attemptDirectPathXdsOverInterconnect; | ||
| this.enableGrpcClientMetrics = builder.enableGrpcClientMetrics; | ||
| this.grpcClientMetricsManuallyEnabled = builder.grpcMetricsManuallyEnabled; | ||
| this.grpcInterceptorProvider = builder.grpcInterceptorProvider; | ||
|
|
@@ -197,6 +201,23 @@ private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundE | |
| this.openTelemetry = HttpStorageOptions.getDefaultInstance().getOpenTelemetry(); | ||
| } | ||
|
|
||
| private static String rewriteHost(String endpoint, String oldHost, String newHost) { | ||
| String prefix = ""; | ||
| String rest = endpoint; | ||
| int schemeIndex = endpoint.indexOf("://"); | ||
| if (schemeIndex >= 0) { | ||
| prefix = endpoint.substring(0, schemeIndex + 3); | ||
| rest = endpoint.substring(schemeIndex + 3); | ||
| } | ||
| if (rest.startsWith(oldHost)) { | ||
| int len = oldHost.length(); | ||
| if (rest.length() == len || rest.charAt(len) == ':' || rest.charAt(len) == '/') { | ||
|
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. A host/authority component can also be immediately followed by a query delimiter (?) or fragment delimiter (#) (e.g., https://storage.googleapis.com?query=val). Should we include ? and # to ensure full RFC compliance? |
||
| return prefix + newHost + rest.substring(len); | ||
| } | ||
| } | ||
| return endpoint; | ||
| } | ||
|
|
||
| /** | ||
| * We have to perform several introspections and detections to cross-wire/support several features | ||
| * that are either gapic primitives, ServiceOption primitives or GCS semantic requirements. | ||
|
|
@@ -230,6 +251,9 @@ private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundE | |
| */ | ||
| private Tuple<StorageSettings, Opts<UserProject>> resolveSettingsAndOpts() throws IOException { | ||
| String endpoint = getHost(); | ||
| if (attemptDirectPathXdsOverInterconnect) { | ||
| endpoint = rewriteHost(endpoint, DEFAULT_HOST_NO_SCHEME, DEFAULT_HOST_DIRECT_PATH_NO_SCHEME); | ||
| } | ||
| URI uri = URI.create(endpoint); | ||
| String scheme = uri.getScheme(); | ||
| int port = uri.getPort(); | ||
|
|
@@ -322,7 +346,8 @@ private Tuple<StorageSettings, Opts<UserProject>> resolveSettingsAndOpts() throw | |
| InstantiatingGrpcChannelProvider.newBuilder() | ||
| .setEndpoint(endpoint) | ||
| .setAllowNonDefaultServiceAccount(true) | ||
| .setAttemptDirectPath(attemptDirectPath); | ||
| .setAttemptDirectPath(attemptDirectPath || attemptDirectPathXdsOverInterconnect) | ||
| .setAttemptDirectPathXdsOverInterconnect(attemptDirectPathXdsOverInterconnect); | ||
|
|
||
| if (!DIRECT_PATH_BOUND_TOKEN_DISABLED) { | ||
| channelProviderBuilder.setAllowHardBoundTokenTypes( | ||
|
|
@@ -428,6 +453,7 @@ public int hashCode() { | |
| retryAlgorithmManager, | ||
| terminationAwaitDuration, | ||
| attemptDirectPath, | ||
| attemptDirectPathXdsOverInterconnect, | ||
| enableGrpcClientMetrics, | ||
| grpcInterceptorProvider, | ||
| blobWriteSessionConfig, | ||
|
|
@@ -445,6 +471,7 @@ public boolean equals(Object o) { | |
| } | ||
| GrpcStorageOptions that = (GrpcStorageOptions) o; | ||
| return attemptDirectPath == that.attemptDirectPath | ||
| && attemptDirectPathXdsOverInterconnect == that.attemptDirectPathXdsOverInterconnect | ||
| && enableGrpcClientMetrics == that.enableGrpcClientMetrics | ||
| && Objects.equals(retryAlgorithmManager, that.retryAlgorithmManager) | ||
| && Objects.equals(terminationAwaitDuration, that.terminationAwaitDuration) | ||
|
|
@@ -494,6 +521,7 @@ public static final class Builder extends StorageOptions.Builder { | |
| private StorageRetryStrategy storageRetryStrategy; | ||
| private java.time.Duration terminationAwaitDuration; | ||
| private boolean attemptDirectPath = GrpcStorageDefaults.INSTANCE.isAttemptDirectPath(); | ||
| private boolean attemptDirectPathXdsOverInterconnect = false; | ||
| private boolean enableGrpcClientMetrics = | ||
| GrpcStorageDefaults.INSTANCE.isEnableGrpcClientMetrics(); | ||
| private GrpcInterceptorProvider grpcInterceptorProvider = | ||
|
|
@@ -512,6 +540,7 @@ public static final class Builder extends StorageOptions.Builder { | |
| this.storageRetryStrategy = gso.getRetryAlgorithmManager().retryStrategy; | ||
| this.terminationAwaitDuration = gso.getTerminationAwaitDuration(); | ||
| this.attemptDirectPath = gso.attemptDirectPath; | ||
| this.attemptDirectPathXdsOverInterconnect = gso.attemptDirectPathXdsOverInterconnect; | ||
| this.enableGrpcClientMetrics = gso.enableGrpcClientMetrics; | ||
| this.grpcInterceptorProvider = gso.grpcInterceptorProvider; | ||
| this.blobWriteSessionConfig = gso.blobWriteSessionConfig; | ||
|
|
@@ -556,6 +585,19 @@ public GrpcStorageOptions.Builder setAttemptDirectPath(boolean attemptDirectPath | |
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Option for whether this client should attempt to use DirectPath over Interconnect (on-premise | ||
| * xDS name resolution). | ||
| * | ||
| * @since 2.72.0 | ||
| */ | ||
| @BetaApi | ||
| public GrpcStorageOptions.Builder setAttemptDirectPathXdsOverInterconnect( | ||
|
nidhiii-27 marked this conversation as resolved.
|
||
| boolean attemptDirectPathXdsOverInterconnect) { | ||
| this.attemptDirectPathXdsOverInterconnect = attemptDirectPathXdsOverInterconnect; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Option for whether this client should emit internal gRPC client internal metrics to Cloud | ||
| * Monitoring. To disable metric reporting, set this to false. True by default. Emitting metrics | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -69,6 +69,63 @@ public void grpc() throws Exception { | |
| () -> assertThat(rebuilt.hashCode()).isEqualTo(base.hashCode())); | ||
| } | ||
|
|
||
| @Test | ||
| public void grpc_attemptDirectPathXdsOverInterconnect() throws Exception { | ||
| com.google.auth.Credentials mockCreds = com.google.cloud.NoCredentials.getInstance(); | ||
| GrpcStorageOptions options = | ||
| GrpcStorageOptions.grpc() | ||
| .setCredentials(mockCreds) | ||
| .setAttemptDirectPathXdsOverInterconnect(true) | ||
| .build(); | ||
|
|
||
| GrpcStorageOptions rebuilt = options.toBuilder().build(); | ||
| assertAll( | ||
| () -> assertThat(rebuilt).isEqualTo(options), | ||
| () -> assertThat(rebuilt.hashCode()).isEqualTo(options.hashCode())); | ||
|
|
||
| com.google.storage.v2.StorageSettings settings = options.getStorageSettings(); | ||
| assertThat(settings.getEndpoint()).isEqualTo("storage-direct.googleapis.com:443"); | ||
|
|
||
| com.google.api.gax.rpc.TransportChannelProvider tcp = settings.getTransportChannelProvider(); | ||
| assertThat(tcp).isInstanceOf(com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.class); | ||
| com.google.api.gax.grpc.InstantiatingGrpcChannelProvider provider = | ||
| (com.google.api.gax.grpc.InstantiatingGrpcChannelProvider) tcp; | ||
|
|
||
| assertThat(provider.isAttemptDirectPathXdsOverInterconnect()).isTrue(); | ||
| com.google.api.core.ApiFunction<io.grpc.ManagedChannelBuilder, io.grpc.ManagedChannelBuilder> | ||
| configurator = provider.toBuilder().getChannelConfigurator(); | ||
| if (configurator != null) { | ||
| io.grpc.ManagedChannelBuilder<?> fakeBuilder = | ||
| io.grpc.ManagedChannelBuilder.forAddress("foo", 80); | ||
| io.grpc.ManagedChannelBuilder<?> appliedBuilder = configurator.apply(fakeBuilder); | ||
| String authority = extractAuthorityFromChannelBuilder(appliedBuilder); | ||
| assertThat(authority).isNull(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void grpc_fallbackFromDirectPathXdsOverInterconnect_doesNotOverrideAuthority() | ||
| throws Exception { | ||
| GrpcStorageOptions options = | ||
| GrpcStorageOptions.grpc() | ||
| .setHost("https://storage.my-universe.com") | ||
| .setAttemptDirectPathXdsOverInterconnect(true) | ||
| .setCredentials(com.google.cloud.NoCredentials.getInstance()) | ||
| .build(); | ||
| com.google.api.gax.grpc.InstantiatingGrpcChannelProvider provider = | ||
| (com.google.api.gax.grpc.InstantiatingGrpcChannelProvider) | ||
| options.getStorageSettings().getTransportChannelProvider(); | ||
| com.google.api.core.ApiFunction<io.grpc.ManagedChannelBuilder, io.grpc.ManagedChannelBuilder> | ||
| configurator = provider.toBuilder().getChannelConfigurator(); | ||
| if (configurator != null) { | ||
| io.grpc.ManagedChannelBuilder<?> fakeBuilder = | ||
| io.grpc.ManagedChannelBuilder.forAddress("foo", 80); | ||
| io.grpc.ManagedChannelBuilder<?> appliedBuilder = configurator.apply(fakeBuilder); | ||
| String authority = extractAuthorityFromChannelBuilder(appliedBuilder); | ||
| assertThat(authority).isNull(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void useJwtAccessWithScope_defaultsToFalse() { | ||
| HttpStorageOptions httpOptions = HttpStorageOptions.http().build(); | ||
|
|
@@ -90,4 +147,42 @@ public ResultRetryAlgorithm<?> getNonidempotentHandler() { | |
| return null; | ||
| } | ||
| } | ||
|
|
||
| private static String extractAuthorityFromChannelBuilder( | ||
| io.grpc.ManagedChannelBuilder<?> channelBuilder) { | ||
| try { | ||
| Object current = channelBuilder; | ||
| while (current != null) { | ||
| Class<?> clazz = current.getClass(); | ||
| java.lang.reflect.Field field = null; | ||
| while (clazz != null) { | ||
| try { | ||
| field = clazz.getDeclaredField("authority"); | ||
|
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. IIUC, we can eliminate reflection entirely by using Mockito with RETURNS_SELF on ManagedChannelBuilder. |
||
| break; | ||
| } catch (NoSuchFieldException e) { | ||
| try { | ||
| field = clazz.getDeclaredField("overrideAuthority"); | ||
| break; | ||
| } catch (Exception ignored) { | ||
| } | ||
| clazz = clazz.getSuperclass(); | ||
| } | ||
| } | ||
| if (field != null) { | ||
| field.setAccessible(true); | ||
| return (String) field.get(current); | ||
| } | ||
| try { | ||
| java.lang.reflect.Field delegate = current.getClass().getDeclaredField("delegate"); | ||
| delegate.setAccessible(true); | ||
| current = delegate.get(current); | ||
| } catch (Exception e) { | ||
| break; | ||
| } | ||
| } | ||
| return null; | ||
| } catch (Exception e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * 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 com.google.cloud.storage.it; | ||
|
|
||
| import static org.junit.Assume.assumeTrue; | ||
|
|
||
| import com.google.cloud.storage.Storage; | ||
| import com.google.cloud.storage.StorageOptions; | ||
| import com.google.cloud.storage.TransportCompatibility.Transport; | ||
| import com.google.cloud.storage.it.runner.StorageITRunner; | ||
| import com.google.cloud.storage.it.runner.annotations.Backend; | ||
| import com.google.cloud.storage.it.runner.annotations.Inject; | ||
| import com.google.cloud.storage.it.runner.annotations.SingleBackend; | ||
| import com.google.cloud.storage.it.runner.annotations.StorageFixture; | ||
| import org.junit.Ignore; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
|
|
||
| @RunWith(StorageITRunner.class) | ||
| @SingleBackend(Backend.PROD) | ||
| public final class ITGrpcDirectPathTest { | ||
|
|
||
| @Inject | ||
| @StorageFixture(Transport.GRPC) | ||
| public Storage storage; | ||
|
|
||
| @Ignore( | ||
| "Bypassed because DirectPath over Interconnect (GCI) requires a specialized hybrid network environment (Interconnect and Traffic Director configured for storage-direct) and cannot be validated in standard CI or local workstations.") | ||
| @Test | ||
| public void clientShouldWork_directPathXdsOverInterconnect() throws Exception { | ||
| assumeTrue( | ||
|
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.
Contributor
Author
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. We kept Co-authored by AI Agent 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. Could we add a comment in the test noting that assumeTrue is intentionally kept as a second-line dynamic guard so future refactors don't clean it up as redundant? |
||
| "Environment cannot resolve storage-direct.googleapis.com", canResolveDirectPathAddress()); | ||
| StorageOptions options = | ||
| StorageOptions.grpc() | ||
| .setCredentials(storage.getOptions().getCredentials()) | ||
| .setAttemptDirectPathXdsOverInterconnect(true) | ||
| .setEnableGrpcClientMetrics(false) | ||
| .build(); | ||
| try (Storage client = options.getService()) { | ||
| client.list(Storage.BucketListOption.pageSize(1)); | ||
| } | ||
| } | ||
|
|
||
| private static boolean canResolveDirectPathAddress() { | ||
| try { | ||
| java.net.InetAddress.getAllByName("storage-direct.googleapis.com"); | ||
| return true; | ||
| } catch (java.net.UnknownHostException e) { | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.