-
Notifications
You must be signed in to change notification settings - Fork 180
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expose protocol name at
ConnectionContext API (#955)
Motivation: Users should have a way to determine which application level protocol is used by each connection. Modifications: - Introduce a new `Protocol` interface for `transport-api`; - Add `ConnectionContext.protocol()` method; - Add `HttpProtocol` interface that extends `Protocol` for `http-api`; - `HttpProtocolVersion` implements `HttpProtocol` interface; - Add `HttpConnectionContext` that returns `HttpProtocol` for `#protocol()` method; - Return `HttpConnectionContext` everywhere in `http-api`; - Add `GrpcProtocol` interface that extends `Protocol` for `grpc-api`; - `GrpcServiceContext overrides `HttpServiceContext` and returns `GrpcProtocol` for `#protocol()` method; - Add tests to verify new API; Result: Users can understand the protocol used by each connection.
- Loading branch information
1 parent
231a641
commit 001f579
Showing
65 changed files
with
829 additions
and
235 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
196 changes: 196 additions & 0 deletions
196
...lk-grpc-netty/src/test/java/io/servicetalk/grpc/netty/GrpcServiceContextProtocolTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| /* | ||
| * Copyright © 2020 Apple Inc. and the ServiceTalk project 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.servicetalk.grpc.netty; | ||
|
|
||
| import io.servicetalk.concurrent.BlockingIterable; | ||
| import io.servicetalk.concurrent.BlockingIterator; | ||
| import io.servicetalk.concurrent.api.Publisher; | ||
| import io.servicetalk.concurrent.api.Single; | ||
| import io.servicetalk.concurrent.internal.ServiceTalkTestTimeout; | ||
| import io.servicetalk.grpc.api.GrpcPayloadWriter; | ||
| import io.servicetalk.grpc.api.GrpcServiceContext; | ||
| import io.servicetalk.grpc.netty.TesterProto.TestRequest; | ||
| import io.servicetalk.grpc.netty.TesterProto.TestResponse; | ||
| import io.servicetalk.grpc.netty.TesterProto.Tester.BlockingTesterClient; | ||
| import io.servicetalk.grpc.netty.TesterProto.Tester.BlockingTesterService; | ||
| import io.servicetalk.grpc.netty.TesterProto.Tester.ClientFactory; | ||
| import io.servicetalk.grpc.netty.TesterProto.Tester.ServiceFactory; | ||
| import io.servicetalk.grpc.netty.TesterProto.Tester.TesterService; | ||
| import io.servicetalk.http.api.HttpConnectionContext.HttpProtocol; | ||
| import io.servicetalk.http.api.HttpProtocolConfig; | ||
| import io.servicetalk.transport.api.ServerContext; | ||
|
|
||
| import org.junit.After; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
| import org.junit.rules.Timeout; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.Parameterized; | ||
| import org.junit.runners.Parameterized.Parameters; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| import static io.servicetalk.concurrent.api.Publisher.from; | ||
| import static io.servicetalk.concurrent.api.Single.succeeded; | ||
| import static io.servicetalk.http.api.HttpProtocolVersion.HTTP_1_1; | ||
| import static io.servicetalk.http.api.HttpProtocolVersion.HTTP_2_0; | ||
| import static io.servicetalk.http.netty.HttpProtocolConfigs.h1Default; | ||
| import static io.servicetalk.http.netty.HttpProtocolConfigs.h2Default; | ||
| import static io.servicetalk.transport.netty.internal.AddressUtils.localAddress; | ||
| import static io.servicetalk.transport.netty.internal.AddressUtils.serverHostAndPort; | ||
| import static java.util.Collections.singleton; | ||
| import static org.hamcrest.MatcherAssert.assertThat; | ||
| import static org.hamcrest.Matchers.equalTo; | ||
| import static org.hamcrest.Matchers.is; | ||
| import static org.hamcrest.Matchers.notNullValue; | ||
|
|
||
| @RunWith(Parameterized.class) | ||
| public class GrpcServiceContextProtocolTest { | ||
|
|
||
| @Rule | ||
| public final Timeout timeout = new ServiceTalkTestTimeout(); | ||
|
|
||
| private final String expectedValue; | ||
| private final ServerContext serverContext; | ||
| private final BlockingTesterClient client; | ||
|
|
||
| public GrpcServiceContextProtocolTest(HttpProtocol httpProtocol, boolean streamingService) throws Exception { | ||
| expectedValue = "gRPC over " + httpProtocol; | ||
|
|
||
| serverContext = GrpcServers.forAddress(localAddress(0)) | ||
| .protocols(protocolConfig(httpProtocol)) | ||
| .listenAndAwait(streamingService ? | ||
| new ServiceFactory(new TesterServiceImpl()) : | ||
| new ServiceFactory(new BlockingTesterServiceImpl())); | ||
|
|
||
| client = GrpcClients.forAddress(serverHostAndPort(serverContext)) | ||
| .protocols(protocolConfig(httpProtocol)) | ||
| .buildBlocking(new ClientFactory()); | ||
| } | ||
|
|
||
| @Parameters(name = "httpVersion={0} streamingService={0}") | ||
| public static Object[] params() { | ||
| return new Object[][]{{HTTP_2_0, true}, {HTTP_2_0, false}, {HTTP_1_1, true}, {HTTP_1_1, false}}; | ||
| } | ||
|
|
||
| private static HttpProtocolConfig protocolConfig(HttpProtocol httpProtocol) { | ||
| if (httpProtocol == HTTP_2_0) { | ||
| return h2Default(); | ||
| } | ||
| if (httpProtocol == HTTP_1_1) { | ||
| return h1Default(); | ||
| } | ||
| throw new IllegalArgumentException("Unknown httpProtocol: " + httpProtocol); | ||
| } | ||
|
|
||
| @After | ||
| public void tearDown() throws Exception { | ||
| try { | ||
| client.close(); | ||
| } finally { | ||
| serverContext.close(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testAggregated() throws Exception { | ||
| assertResponse(client.test(newRequest())); | ||
| } | ||
|
|
||
| @Test | ||
| public void testRequestStream() throws Exception { | ||
| assertResponse(client.testRequestStream(singleton(newRequest()))); | ||
| } | ||
|
|
||
| @Test | ||
| public void testBiDiStream() throws Exception { | ||
| try (BlockingIterator<TestResponse> iterator = client.testBiDiStream(singleton(newRequest())).iterator()) { | ||
| assertResponse(iterator.next()); | ||
| assertThat(iterator.hasNext(), is(false)); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testResponseStream() throws Exception { | ||
| try (BlockingIterator<TestResponse> iterator = client.testResponseStream(newRequest()).iterator()) { | ||
| assertResponse(iterator.next()); | ||
| assertThat(iterator.hasNext(), is(false)); | ||
| } | ||
| } | ||
|
|
||
| private void assertResponse(@Nullable TestResponse response) { | ||
| assertThat(response, is(notNullValue())); | ||
| assertThat(response.getMessage(), equalTo(expectedValue)); | ||
| } | ||
|
|
||
| private static TestRequest newRequest() { | ||
| return TestRequest.newBuilder().setName("request").build(); | ||
| } | ||
|
|
||
| private static TestResponse newResponse(GrpcServiceContext ctx) { | ||
| return TestResponse.newBuilder() | ||
| .setMessage(ctx.protocol().name() + " over " + ctx.protocol().httpProtocol()) | ||
| .build(); | ||
| } | ||
|
|
||
| private static class TesterServiceImpl implements TesterService { | ||
|
|
||
| @Override | ||
| public Single<TestResponse> test(GrpcServiceContext ctx, TestRequest request) { | ||
| return succeeded(newResponse(ctx)); | ||
| } | ||
|
|
||
| @Override | ||
| public Single<TestResponse> testRequestStream(GrpcServiceContext ctx, Publisher<TestRequest> request) { | ||
| return succeeded(newResponse(ctx)); | ||
| } | ||
|
|
||
| @Override | ||
| public Publisher<TestResponse> testBiDiStream(GrpcServiceContext ctx, Publisher<TestRequest> request) { | ||
| return from(newResponse(ctx)); | ||
| } | ||
|
|
||
| @Override | ||
| public Publisher<TestResponse> testResponseStream(GrpcServiceContext ctx, TestRequest request) { | ||
| return from(newResponse(ctx)); | ||
| } | ||
| } | ||
|
|
||
| private static class BlockingTesterServiceImpl implements BlockingTesterService { | ||
| @Override | ||
| public TestResponse test(GrpcServiceContext ctx, TestRequest request) { | ||
| return newResponse(ctx); | ||
| } | ||
|
|
||
| @Override | ||
| public TestResponse testRequestStream(GrpcServiceContext ctx, | ||
| BlockingIterable<TestRequest> request) { | ||
| return newResponse(ctx); | ||
| } | ||
|
|
||
| @Override | ||
| public void testBiDiStream(GrpcServiceContext ctx, BlockingIterable<TestRequest> request, | ||
| GrpcPayloadWriter<TestResponse> responseWriter) throws Exception { | ||
| responseWriter.write(newResponse(ctx)); | ||
| } | ||
|
|
||
| @Override | ||
| public void testResponseStream(GrpcServiceContext ctx, TestRequest request, | ||
| GrpcPayloadWriter<TestResponse> responseWriter) throws Exception { | ||
| responseWriter.write(newResponse(ctx)); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.