Skip to content
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

Support BinderChannelBuilder.forTarget. #8633

Merged
merged 3 commits into from Nov 1, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -44,6 +44,7 @@
import io.grpc.stub.ClientCalls;
import io.grpc.stub.ServerCalls;
import io.grpc.stub.StreamObserver;
import io.grpc.testing.FakeNameResolverProvider;
import io.grpc.testing.TestUtils;
import java.io.ByteArrayInputStream;
import java.io.IOException;
Expand Down Expand Up @@ -117,7 +118,7 @@ public void setUp() throws Exception {
.build(),
TestUtils.recordRequestHeadersInterceptor(headersCapture));

AndroidComponentAddress serverAddress = HostServices.allocateService(appContext);
serverAddress = HostServices.allocateService(appContext);
HostServices.configureService(serverAddress,
HostServices.serviceParamsBuilder()
.setServerFactory((service, receiver) ->
Expand Down Expand Up @@ -192,6 +193,14 @@ public void testStreamingCallOptionHeaders() throws Exception {
assertThat(headersCapture.get().get(GrpcUtil.TIMEOUT_KEY)).isGreaterThan(0);
}

@Test
public void testConnectViaTargetUri() throws Exception {
String targetUri = "fake://server";
FakeNameResolverProvider.register(targetUri, serverAddress);
channel = BinderChannelBuilder.forTarget(targetUri, appContext).build();
assertThat(doCall("Hello").get()).isEqualTo("Hello");
}

private static String createLargeString(int size) {
StringBuilder sb = new StringBuilder();
while (sb.length() < size) {
Expand Down
56 changes: 44 additions & 12 deletions binder/src/main/java/io/grpc/binder/BinderChannelBuilder.java
Expand Up @@ -67,13 +67,35 @@ public final class BinderChannelBuilder
* <p>You the caller are responsible for managing the lifecycle of any channels built by the
* resulting builder. They will not be shut down automatically.
*
* @param targetAddress the {@link AndroidComponentAddress} referencing the service to bind to.
* @param directAddress the {@link AndroidComponentAddress} referencing the service to bind to.
* @param sourceContext the context to bind from (e.g. The current Activity or Application).
* @return a new builder
*/
public static BinderChannelBuilder forAddress(
AndroidComponentAddress targetAddress, Context sourceContext) {
return new BinderChannelBuilder(targetAddress, sourceContext);
AndroidComponentAddress directAddress, Context sourceContext) {
return new BinderChannelBuilder(
checkNotNull(directAddress, "directAddress"), null, sourceContext);
}

/**
* Creates a channel builder that will bind to a remote Android service, via a string
* target name which will be resolved.
*
* <p>The underlying Android binding will be torn down when the channel becomes idle. This happens
* after 30 minutes without use by default but can be configured via {@link
* ManagedChannelBuilder#idleTimeout(long, TimeUnit)} or triggered manually with {@link
* ManagedChannel#enterIdle()}.
*
* <p>You the caller are responsible for managing the lifecycle of any channels built by the
* resulting builder. They will not be shut down automatically.
*
* @param target A target uri which should resolve into an {@link AndroidComponentAddress}
* referencing the service to bind to.
* @param sourceContext the context to bind from (e.g. The current Activity or Application).
* @return a new builder
*/
public static BinderChannelBuilder forTarget(String target, Context sourceContext) {
return new BinderChannelBuilder(null, checkNotNull(target, "target"), sourceContext);
}

/**
Expand All @@ -88,7 +110,7 @@ public static BinderChannelBuilder forAddress(String name, int port) {
/**
* Always fails. Call {@link #forAddress(AndroidComponentAddress, Context)} instead.
*/
@DoNotCall("Unsupported. Use forAddress(AndroidComponentAddress, Context) instead")
@DoNotCall("Unsupported. Use forTarget(String, Context) instead")
public static BinderChannelBuilder forTarget(String target) {
throw new UnsupportedOperationException(
"call forAddress(AndroidComponentAddress, Context) instead");
Expand All @@ -104,9 +126,11 @@ public static BinderChannelBuilder forTarget(String target) {
private BindServiceFlags bindServiceFlags;

private BinderChannelBuilder(
AndroidComponentAddress targetAddress,
@Nullable AndroidComponentAddress directAddress,
@Nullable String target,
Context sourceContext) {
mainThreadExecutor = ContextCompat.getMainExecutor(sourceContext);
mainThreadExecutor =
ContextCompat.getMainExecutor(checkNotNull(sourceContext, "sourceContext"));
securityPolicy = SecurityPolicies.internalOnly();
inboundParcelablePolicy = InboundParcelablePolicy.DEFAULT;
bindServiceFlags = BindServiceFlags.DEFAULTS;
Expand All @@ -126,12 +150,20 @@ public ClientTransportFactory buildClientTransportFactory() {
}
}

managedChannelImplBuilder =
new ManagedChannelImplBuilder(
targetAddress,
targetAddress.getAuthority(),
new BinderChannelTransportFactoryBuilder(),
null);
if (directAddress != null) {
managedChannelImplBuilder =
new ManagedChannelImplBuilder(
directAddress,
directAddress.getAuthority(),
new BinderChannelTransportFactoryBuilder(),
null);
} else {
managedChannelImplBuilder =
new ManagedChannelImplBuilder(
target,
new BinderChannelTransportFactoryBuilder(),
null);
}
}

@Override
Expand Down
106 changes: 106 additions & 0 deletions testing/src/main/java/io/grpc/testing/FakeNameResolverProvider.java
@@ -0,0 +1,106 @@
/*
* Copyright 2021 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.testing;

import com.google.common.collect.ImmutableList;
import io.grpc.EquivalentAddressGroup;
import io.grpc.NameResolver;
import io.grpc.NameResolverProvider;
import io.grpc.NameResolverRegistry;
import io.grpc.Status;
import java.net.SocketAddress;
import java.net.URI;

/** A name resolver to always resolve the given URI into the given address. */
public final class FakeNameResolverProvider extends NameResolverProvider {
Copy link
Member

Choose a reason for hiding this comment

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

The testing project is actually published, so this is pubic API. Either we should mark it experimental, or move it to io.grpc.internal.testing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah of course, thanks. I've had cause to use something like this myself internally, so marking experimental.

Copy link
Member

Choose a reason for hiding this comment

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

We may want to discuss when you used this internally, as I expect it was probably with a grpc-maintainer hat on (e.g., when writing a transport). It wouldn't be "against the rules" to have this be internal but let some specific tests access it (I expect we're doing that already).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good point, on consideration moving to io.grpc.internal.testing.


/**
* Register a new resolver.
*
* @param targetUri The URI to resolve when requested.
* @param address The address to return for the target URI.
*/
public static final void register(String targetUri, SocketAddress address) {
Copy link
Member

Choose a reason for hiding this comment

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

I think we should delete this method and instead expose the constructor. This method is a bad pattern. After a test using this is over, it should really deregister the provider. Conceptually (but maybe using @After):

provider = new FakeNameResolverProvider(URI.create(targetUri), address);
NameResolverRegistry.getDefaultRegistry().register(provider);
try {
  ...
} finally {
  NameResolverRegistry.getDefaultRegistry().deregister(provider);
}

I don't think this class needs to make that try-finally easier, but it shouldn't encourage being used in a register-only fashion.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, fixed.

NameResolverRegistry.getDefaultRegistry().register(
new FakeNameResolverProvider(URI.create(targetUri), address));
}

private final URI targetUri;
private final SocketAddress address;

private FakeNameResolverProvider(URI targetUri, SocketAddress address) {
this.targetUri = targetUri;
this.address = address;
}

@Override
public NameResolver newNameResolver(URI targetUri, NameResolver.Args args) {
if (targetUri.equals(this.targetUri)) {
return new FakeNameResolver(address);
}
return null;
}

@Override
protected boolean isAvailable() {
return true;
}

@Override
protected int priority() {
return 5; // Default
}

@Override
public String getDefaultScheme() {
return targetUri.getScheme();
}

/** A single name resolver. */
private static final class FakeNameResolver extends NameResolver {
private static final String AUTHORITY = "fake-authority";

private final SocketAddress address;
private volatile boolean shutdown;

private FakeNameResolver(SocketAddress address) {
this.address = address;
}

@Override
public void start(Listener2 listener) {
if (shutdown) {
listener.onError(Status.FAILED_PRECONDITION.withDescription("Resolver is shutdown"));
} else {
listener.onResult(
ResolutionResult.newBuilder()
.setAddresses(ImmutableList.of(new EquivalentAddressGroup(address)))
.build());
}
}

@Override
public String getServiceAuthority() {
return AUTHORITY;
}

@Override
public void shutdown() {
shutdown = true;
}
}
}