Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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);
}
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

Choose a reason for hiding this comment

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

critical

The create method has a concurrency issue. It modifies the shared channelBuilder by calling setEndpoint(), but it doesn't restore the original endpoint. This can lead to other threads creating channels for incorrect endpoints. You should save and restore the original endpoint within the synchronized block to ensure thread safety.

            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);
}
});
}

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;
}

@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;
}
}
}
Loading
Loading