Fix handling of gRPC trailers-only responses #101
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,7 +33,6 @@ import com.connectrpc.impl.ProtocolClient | |
| import com.connectrpc.okhttp.ConnectOkHttpClient | ||
| import com.connectrpc.protocols.NetworkProtocol | ||
| import com.google.protobuf.ByteString | ||
| import com.google.protobuf.empty | ||
| import kotlinx.coroutines.Dispatchers | ||
| import kotlinx.coroutines.async | ||
|
|
@@ -58,24 +57,25 @@ import java.util.concurrent.TimeUnit | |
|
|
||
| @RunWith(Parameterized::class) | ||
| class Conformance( | ||
| private val protocol: NetworkProtocol, | ||
| private val serverType: ServerType | ||
| ) { | ||
| private lateinit var connectClient: ProtocolClient | ||
| private lateinit var shortTimeoutConnectClient: ProtocolClient | ||
| private lateinit var unimplementedServiceClient: UnimplementedServiceClient | ||
| private lateinit var testServiceConnectClient: TestServiceClient | ||
|
|
||
| companion object { | ||
| private const val CONFORMANCE_VERSION = "0b07f579cb61ad89de24524d62f804a2b03b1acf" | ||
|
|
||
| @JvmStatic | ||
| @Parameters(name = "client={0},server={1}") | ||
| fun data(): Iterable<Array<Any>> { | ||
| return arrayListOf( | ||
| arrayOf(NetworkProtocol.CONNECT, ServerType.CONNECT_GO), | ||
| arrayOf(NetworkProtocol.GRPC, ServerType.CONNECT_GO), | ||
| arrayOf(NetworkProtocol.GRPC_WEB, ServerType.CONNECT_GO), | ||
| arrayOf(NetworkProtocol.GRPC, ServerType.GRPC_GO) | ||
| ) | ||
| } | ||
|
|
||
|
|
@@ -114,7 +114,7 @@ class Conformance( | |
|
|
||
| @Before | ||
| fun before() { | ||
| val serverPort = if (serverType == ServerType.CONNECT_GO) CONFORMANCE_CONTAINER_CONNECT.getMappedPort(8081) else CONFORMANCE_CONTAINER_GRPC.getMappedPort(8081) | ||
|
There was a problem hiding this comment. Not a big deal, but calling out that Swift uses 8083 for grpc-go because that's where it's hosted in the container: https://github.com/connectrpc/connect-swift/blob/f7aab0e53c38f15d5ab62e8e8afa2f984c7e34f3/Tests/ConnectLibraryTests/ConnectConformance/ConformanceConfiguration.swift#L58 There was a problem hiding this comment. We could update to match, however that is coming from https://github.com/connectrpc/connect-swift/blob/f7aab0e53c38f15d5ab62e8e8afa2f984c7e34f3/Makefile#L49-L54. We're no longer needing to spawn containers from the Makefile in this project - we're using testcontainers to do that, so port 8081 is actually ephemeral on the host. |
||
| val host = "https://localhost:$serverPort" | ||
| val (sslSocketFactory, trustManager) = sslContext() | ||
| val client = OkHttpClient.Builder() | ||
|
|
@@ -137,23 +137,23 @@ class Conformance( | |
| ProtocolClientConfig( | ||
| host = host, | ||
| serializationStrategy = GoogleJavaProtobufStrategy(), | ||
| networkProtocol = protocol, | ||
| requestCompression = RequestCompression(10, GzipCompressionPool), | ||
| compressionPools = listOf(GzipCompressionPool) | ||
| ) | ||
| ) | ||
| connectClient = ProtocolClient( | ||
| httpClient = ConnectOkHttpClient(client), | ||
| ProtocolClientConfig( | ||
| host = host, | ||
| serializationStrategy = GoogleJavaProtobufStrategy(), | ||
| networkProtocol = protocol, | ||
| requestCompression = RequestCompression(10, GzipCompressionPool), | ||
| compressionPools = listOf(GzipCompressionPool) | ||
| ) | ||
| ) | ||
| testServiceConnectClient = TestServiceClient(connectClient) | ||
| unimplementedServiceClient = UnimplementedServiceClient(connectClient) | ||
| } | ||
|
|
||
| @Test | ||
|
|
@@ -163,7 +163,7 @@ class Conformance( | |
| reason = "soirée 🎉" | ||
| domain = "connect-conformance" | ||
| } | ||
| val stream = testServiceConnectClient.failStreamingOutputCall() | ||
| val sizes = listOf( | ||
| 31415, | ||
| 9, | ||
|
|
@@ -187,14 +187,17 @@ class Conformance( | |
| for (res in stream.resultChannel()) { | ||
| res.maybeFold( | ||
| onCompletion = { result -> | ||
| try { | ||
|
There was a problem hiding this comment. Wouldn't we want this to explode if any of the asserts fail rather than allowing tests to continue? There was a problem hiding this comment. It will still fail the test, but this will prevent it waiting 5 seconds on the countDownLatch for the failure to register. Verified by adding a failing assert. |
||
| // For some reason we keep timing out on these calls and not actually getting a real response like with grpc? | ||
| assertThat(result.code).isEqualTo(Code.RESOURCE_EXHAUSTED) | ||
| assertThat(result.connectError()!!.code).isEqualTo(Code.RESOURCE_EXHAUSTED) | ||
| assertThat(result.connectError()!!.message).isEqualTo("soirée 🎉") | ||
| assertThat(result.connectError()!!.unpackedDetails(ErrorDetail::class)).containsExactly( | ||
| expectedErrorDetail | ||
| ) | ||
| } finally { | ||
| countDownLatch.countDown() | ||
| } | ||
| } | ||
| ) | ||
| } | ||
|
|
@@ -209,12 +212,12 @@ class Conformance( | |
| @Test | ||
| fun emptyUnary(): Unit = runBlocking { | ||
| val countDownLatch = CountDownLatch(1) | ||
| testServiceConnectClient.emptyCall(empty {}) { response -> | ||
| response.failure { | ||
| fail<Unit>("expected error to be null") | ||
| } | ||
| response.success { success -> | ||
| assertThat(success.message).isEqualTo(empty {}) | ||
| countDownLatch.countDown() | ||
| } | ||
| } | ||
|
|
@@ -232,7 +235,7 @@ class Conformance( | |
| } | ||
| } | ||
| val countDownLatch = CountDownLatch(1) | ||
| testServiceConnectClient.unaryCall(message) { response -> | ||
| response.failure { | ||
| fail<Unit>("expected error to be null") | ||
| } | ||
|
|
@@ -262,7 +265,7 @@ class Conformance( | |
| payload = payload { body = ByteString.copyFrom(ByteArray(size)) } | ||
| } | ||
| val countDownLatch = CountDownLatch(1) | ||
| testServiceConnectClient.unaryCall(message, headers) { response -> | ||
| assertThat(response.code).isEqualTo(Code.OK) | ||
| assertThat(response.headers[leadingKey]).containsExactly(leadingValue) | ||
| assertThat(response.trailers[trailingKey]).containsExactly(b64Encode(trailingValue)) | ||
|
|
@@ -287,7 +290,7 @@ class Conformance( | |
| } | ||
| } | ||
| val countDownLatch = CountDownLatch(1) | ||
| testServiceConnectClient.unaryCall(message) { response -> | ||
| assertThat(response.code).isEqualTo(Code.UNKNOWN) | ||
| response.failure { errorResponse -> | ||
| assertThat(errorResponse.error).isNotNull() | ||
|
|
@@ -325,10 +328,13 @@ class Conformance( | |
| for (res in stream.resultChannel()) { | ||
| res.maybeFold( | ||
| onCompletion = { result -> | ||
| try { | ||
|
|
||
| assertThat(result.error).isNotNull() | ||
| assertThat(result.connectError()!!.code).isEqualTo(Code.DEADLINE_EXCEEDED) | ||
| assertThat(result.code).isEqualTo(Code.DEADLINE_EXCEEDED) | ||
| } finally { | ||
| countDownLatch.countDown() | ||
| } | ||
| } | ||
| ) | ||
| } | ||
|
|
@@ -346,7 +352,7 @@ class Conformance( | |
| val statusMessage = | ||
| "\\t\\ntest with whitespace\\r\\nand Unicode BMP ☺ and non-BMP \uD83D\uDE08\\t\\n" | ||
| val countDownLatch = CountDownLatch(1) | ||
| testServiceConnectClient.unaryCall( | ||
| simpleRequest { | ||
| responseStatus = echoStatus { | ||
| code = 2 | ||
|
|
@@ -372,7 +378,7 @@ class Conformance( | |
| @Test | ||
| fun unimplementedMethod(): Unit = runBlocking { | ||
| val countDownLatch = CountDownLatch(1) | ||
| testServiceConnectClient.unimplementedCall(empty {}) { response -> | ||
| assertThat(response.code).isEqualTo(Code.UNIMPLEMENTED) | ||
| countDownLatch.countDown() | ||
| } | ||
|
|
@@ -383,22 +389,49 @@ class Conformance( | |
| @Test | ||
| fun unimplementedService(): Unit = runBlocking { | ||
| val countDownLatch = CountDownLatch(1) | ||
| unimplementedServiceClient.unimplementedCall(empty {}) { response -> | ||
| assertThat(response.code).isEqualTo(Code.UNIMPLEMENTED) | ||
| countDownLatch.countDown() | ||
| } | ||
| countDownLatch.await(500, TimeUnit.MILLISECONDS) | ||
| assertThat(countDownLatch.count).isZero() | ||
| } | ||
|
|
||
| @Test | ||
| fun unimplementedServerStreamingService(): Unit = runBlocking { | ||
|
There was a problem hiding this comment. Added this test which caught the streaming behavior issue: #101 (comment) |
||
| val countDownLatch = CountDownLatch(1) | ||
| val stream = unimplementedServiceClient.unimplementedStreamingOutputCall() | ||
| stream.send(empty { }) | ||
| withContext(Dispatchers.IO) { | ||
| val job = async { | ||
| for (res in stream.resultChannel()) { | ||
| res.maybeFold( | ||
| onCompletion = { result -> | ||
| try { | ||
|
There was a problem hiding this comment. Same question about |
||
| assertThat(result.code).isEqualTo(Code.UNIMPLEMENTED) | ||
| assertThat(result.connectError()!!.code).isEqualTo(Code.UNIMPLEMENTED) | ||
| } finally { | ||
| countDownLatch.countDown() | ||
| } | ||
| } | ||
| ) | ||
| } | ||
| } | ||
| countDownLatch.await(5, TimeUnit.SECONDS) | ||
| job.cancel() | ||
| assertThat(countDownLatch.count).isZero() | ||
| stream.close() | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun failUnary(): Unit = runBlocking { | ||
| val expectedErrorDetail = errorDetail { | ||
| reason = "soirée 🎉" | ||
| domain = "connect-conformance" | ||
| } | ||
| val countDownLatch = CountDownLatch(1) | ||
| testServiceConnectClient.failUnaryCall(simpleRequest {}) { response -> | ||
| assertThat(response.code).isEqualTo(Code.RESOURCE_EXHAUSTED) | ||
| response.failure { errorResponse -> | ||
| val error = errorResponse.error | ||
|
|
@@ -418,12 +451,12 @@ class Conformance( | |
|
|
||
| @Test | ||
| fun emptyUnaryBlocking(): Unit = runBlocking { | ||
| val response = testServiceConnectClient.emptyCallBlocking(empty {}).execute() | ||
| response.failure { | ||
| fail<Unit>("expected error to be null") | ||
| } | ||
| response.success { success -> | ||
| assertThat(success.message).isEqualTo(empty {}) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -436,7 +469,7 @@ class Conformance( | |
| body = ByteString.copyFrom(ByteArray(size)) | ||
| } | ||
| } | ||
| val response = testServiceConnectClient.unaryCallBlocking(message).execute() | ||
| response.failure { | ||
| fail<Unit>("expected error to be null") | ||
| } | ||
|
|
@@ -461,7 +494,7 @@ class Conformance( | |
| responseSize = size | ||
| payload = payload { body = ByteString.copyFrom(ByteArray(size)) } | ||
| } | ||
| val response = testServiceConnectClient.unaryCallBlocking(message, headers).execute() | ||
| assertThat(response.code).isEqualTo(Code.OK) | ||
| assertThat(response.headers[leadingKey]).containsExactly(leadingValue) | ||
| assertThat(response.trailers[trailingKey]).containsExactly(b64Encode(trailingValue)) | ||
|
|
@@ -481,7 +514,7 @@ class Conformance( | |
| message = "test status message" | ||
| } | ||
| } | ||
| val response = testServiceConnectClient.unaryCallBlocking(message).execute() | ||
| assertThat(response.code).isEqualTo(Code.UNKNOWN) | ||
| response.failure { errorResponse -> | ||
| assertThat(errorResponse.error).isNotNull() | ||
|
|
@@ -497,7 +530,7 @@ class Conformance( | |
| fun specialStatusBlocking(): Unit = runBlocking { | ||
| val statusMessage = | ||
| "\\t\\ntest with whitespace\\r\\nand Unicode BMP ☺ and non-BMP \uD83D\uDE08\\t\\n" | ||
| val response = testServiceConnectClient.unaryCallBlocking( | ||
| simpleRequest { | ||
| responseStatus = echoStatus { | ||
| code = 2 | ||
|
|
@@ -518,13 +551,13 @@ class Conformance( | |
|
|
||
| @Test | ||
| fun unimplementedMethodBlocking(): Unit = runBlocking { | ||
| val response = testServiceConnectClient.unimplementedCallBlocking(empty {}).execute() | ||
| assertThat(response.code).isEqualTo(Code.UNIMPLEMENTED) | ||
| } | ||
|
|
||
| @Test | ||
| fun unimplementedServiceBlocking(): Unit = runBlocking { | ||
| val response = unimplementedServiceClient.unimplementedCallBlocking(empty {}).execute() | ||
| assertThat(response.code).isEqualTo(Code.UNIMPLEMENTED) | ||
| } | ||
|
|
||
|
|
@@ -534,7 +567,7 @@ class Conformance( | |
| reason = "soirée 🎉" | ||
| domain = "connect-conformance" | ||
| } | ||
| val response = testServiceConnectClient.failUnaryCallBlocking(simpleRequest {}).execute() | ||
| assertThat(response.code).isEqualTo(Code.RESOURCE_EXHAUSTED) | ||
| response.failure { errorResponse -> | ||
| val error = errorResponse.error | ||
|
|
||
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,20 @@ | ||
| // Copyright 2022-2023 The Connect 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 com.connectrpc.conformance | ||
|
|
||
| enum class ServerType { | ||
| CONNECT_GO, | ||
| GRPC_GO, | ||
| } |
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Added gRPC web protocol tests as well (and found some issues as a result).