-
Notifications
You must be signed in to change notification settings - Fork 136
feat: add ChannelFinder server interfaces #4293
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
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,28 @@ | ||
| /* | ||
| * 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.spanner.spi.v1; | ||
|
|
||
| import io.grpc.ManagedChannel; | ||
|
|
||
| /** Represents a Spanner server endpoint for location-aware routing. */ | ||
| public interface ChannelFinderServer { | ||
| String getAddress(); | ||
|
|
||
| boolean isHealthy(); | ||
|
|
||
| ManagedChannel getChannel(); // Added to get the underlying channel for RPC calls | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| * 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.spanner.spi.v1; | ||
|
|
||
| /** Factory for creating and caching server connections for location-aware routing. */ | ||
| public interface ChannelFinderServerFactory { | ||
| ChannelFinderServer defaultServer(); | ||
|
|
||
| ChannelFinderServer create(String address); | ||
|
Comment on lines
+21
to
+23
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. The methods in this interface should have Javadoc comments to explain their purpose, expected inputs, and what they return. This will improve the maintainability and usability of this new API. /** Returns the default server that is used if no specific server can be found for a request. */
ChannelFinderServer defaultServer();
/**
* Creates or returns a cached server for the given address.
*
* @param address The address of the server to connect to.
* @return A {@link ChannelFinderServer} for the given address.
*/
ChannelFinderServer create(String address); |
||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /* | ||
| * 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.spanner.spi.v1; | ||
|
|
||
| import com.google.api.gax.grpc.GrpcTransportChannel; | ||
| import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider; | ||
| import io.grpc.ManagedChannel; | ||
| import java.io.IOException; | ||
| import java.util.Map; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
|
|
||
| class GrpcChannelFinderServerFactory implements ChannelFinderServerFactory { | ||
| private final InstantiatingGrpcChannelProvider.Builder channelBuilder; | ||
| private final Map<String, GrpcChannelFinderServer> servers = new ConcurrentHashMap<>(); | ||
| private final GrpcChannelFinderServer defaultServer; | ||
|
|
||
| public GrpcChannelFinderServerFactory(InstantiatingGrpcChannelProvider.Builder channelBuilder) | ||
| throws IOException { | ||
| this.channelBuilder = channelBuilder; | ||
| // The "default" server will use the original endpoint from the builder. | ||
| this.defaultServer = | ||
| new GrpcChannelFinderServer(this.channelBuilder.getEndpoint(), channelBuilder.build()); | ||
| this.servers.put(this.defaultServer.getAddress(), this.defaultServer); | ||
| } | ||
|
|
||
| @Override | ||
| public ChannelFinderServer defaultServer() { | ||
| return defaultServer; | ||
| } | ||
|
|
||
| @Override | ||
| public ChannelFinderServer create(String address) { | ||
| return servers.computeIfAbsent( | ||
| address, | ||
| addr -> { | ||
| try { | ||
| // Modify the builder to use the new address | ||
| synchronized (channelBuilder) { | ||
| InstantiatingGrpcChannelProvider.Builder newBuilder = | ||
| channelBuilder.setEndpoint(addr); | ||
| return new GrpcChannelFinderServer(addr, newBuilder.build()); | ||
| } | ||
|
Comment on lines
+52
to
+56
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. The synchronized (channelBuilder) {
String originalEndpoint = channelBuilder.getEndpoint();
try {
InstantiatingGrpcChannelProvider.Builder newBuilder =
channelBuilder.setEndpoint(addr);
return new GrpcChannelFinderServer(addr, newBuilder.build());
} finally {
channelBuilder.setEndpoint(originalEndpoint);
}
} |
||
| } catch (IOException e) { | ||
| throw new RuntimeException("Failed to create channel for address: " + addr, e); | ||
|
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. Wrapping the throw SpannerExceptionFactory.newSpannerException(ErrorCode.UNAVAILABLE, "Failed to create channel for address: " + addr, e); |
||
| } | ||
| }); | ||
| } | ||
|
|
||
| static class GrpcChannelFinderServer implements ChannelFinderServer { | ||
| private final String address; | ||
| private final ManagedChannel channel; | ||
|
|
||
| public GrpcChannelFinderServer(String address, InstantiatingGrpcChannelProvider provider) | ||
| throws IOException { | ||
| this.address = address; | ||
| // It's assumed that getTransportChannel() returns a ManagedChannel or can be cast to one. | ||
| // For this example, GrpcTransportChannel is used as in KeyAwareChannel. | ||
| GrpcTransportChannel transportChannel = (GrpcTransportChannel) provider.getTransportChannel(); | ||
| this.channel = (ManagedChannel) transportChannel.getChannel(); | ||
| } | ||
|
|
||
| // Constructor for the default server that already has a channel | ||
| public GrpcChannelFinderServer(String address, ManagedChannel channel) { | ||
| this.address = address; | ||
| this.channel = channel; | ||
| } | ||
|
Comment on lines
+76
to
+80
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. This constructor |
||
|
|
||
| @Override | ||
| public String getAddress() { | ||
| return address; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isHealthy() { | ||
| // A simple health check. In a real scenario, this might involve a ping or other checks. | ||
| return !channel.isShutdown() && !channel.isTerminated(); | ||
| } | ||
|
|
||
| @Override | ||
| public ManagedChannel getChannel() { | ||
| return channel; | ||
| } | ||
| } | ||
| } | ||
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.
The methods in this interface should have Javadoc comments to explain their purpose. The inline comment on
getChannelshould also be converted to a Javadoc comment for consistency and clarity.