diff --git a/trpc-proto/trpc-proto-http/src/main/java/com/tencent/trpc/proto/http/client/HttpConsumerInvoker.java b/trpc-proto/trpc-proto-http/src/main/java/com/tencent/trpc/proto/http/client/HttpConsumerInvoker.java index 7a022aea0..7d101e8c6 100644 --- a/trpc-proto/trpc-proto-http/src/main/java/com/tencent/trpc/proto/http/client/HttpConsumerInvoker.java +++ b/trpc-proto/trpc-proto-http/src/main/java/com/tencent/trpc/proto/http/client/HttpConsumerInvoker.java @@ -32,7 +32,6 @@ import java.util.Objects; import org.apache.commons.io.IOUtils; import org.apache.http.Header; -import org.apache.http.HeaderElement; import org.apache.http.HttpHeaders; import org.apache.http.HttpRequest; import org.apache.http.HttpStatus; @@ -93,10 +92,8 @@ private Response handleResponse(Request request, CloseableHttpResponse httpRespo Map respAttachments = new HashMap<>(); for (Header header : httpResponse.getAllHeaders()) { String name = header.getName(); - for (HeaderElement element : header.getElements()) { - String value = element.getName(); - respAttachments.put(name, value.getBytes(StandardCharsets.UTF_8)); - } + String value = header.getValue(); + respAttachments.put(name, value.getBytes(StandardCharsets.UTF_8)); } Header contentLengthHdr = httpResponse.getFirstHeader(HttpHeaders.CONTENT_LENGTH); diff --git a/trpc-proto/trpc-proto-http/src/test/java/com/tencent/trpc/proto/http/client/HttpConsumerInvokerTest.java b/trpc-proto/trpc-proto-http/src/test/java/com/tencent/trpc/proto/http/client/HttpConsumerInvokerTest.java new file mode 100644 index 000000000..9c9949a19 --- /dev/null +++ b/trpc-proto/trpc-proto-http/src/test/java/com/tencent/trpc/proto/http/client/HttpConsumerInvokerTest.java @@ -0,0 +1,394 @@ +/* + * Tencent is pleased to support the open source community by making tRPC available. + * + * Copyright (C) 2023 Tencent. + * All rights reserved. + * + * If you have downloaded a copy of the tRPC source code from Tencent, + * please note that tRPC source code is licensed under the Apache 2.0 License, + * A copy of the Apache 2.0 License can be found in the LICENSE file. + */ + +package com.tencent.trpc.proto.http.client; + +import static org.junit.Assert.assertArrayEquals; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNull; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import com.tencent.trpc.core.common.ConfigManager; +import com.tencent.trpc.core.common.config.BackendConfig; +import com.tencent.trpc.core.common.config.ConsumerConfig; +import com.tencent.trpc.core.common.config.ProtocolConfig; +import com.tencent.trpc.core.rpc.CallInfo; +import com.tencent.trpc.core.rpc.Request; +import com.tencent.trpc.core.rpc.RequestMeta; +import com.tencent.trpc.core.rpc.Response; +import com.tencent.trpc.core.rpc.RpcInvocation; +import com.tencent.trpc.core.rpc.common.RpcMethodInfo; +import com.tencent.trpc.core.worker.spi.WorkerPool; +import java.io.ByteArrayInputStream; +import java.lang.reflect.Method; +import java.nio.charset.StandardCharsets; +import java.util.HashMap; +import org.apache.http.Header; +import org.apache.http.HttpHeaders; +import org.apache.http.HttpStatus; +import org.apache.http.HttpVersion; +import org.apache.http.StatusLine; +import org.apache.http.client.methods.CloseableHttpResponse; +import org.apache.http.entity.BasicHttpEntity; +import org.apache.http.message.BasicHeader; +import org.apache.http.message.BasicStatusLine; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +/** + * 测试 HttpConsumerInvoker 中 handleResponse 的响应头解析逻辑 + */ +public class HttpConsumerInvokerTest { + + private HttpRpcClient mockHttpRpcClient; + private ConsumerConfig mockConsumerConfig; + private ProtocolConfig mockProtocolConfig; + private BackendConfig mockBackendConfig; + private WorkerPool mockWorkerPool; + + private HttpConsumerInvoker invoker; + + @Before + public void setUp() { + ConfigManager.stopTest(); + ConfigManager.startTest(); + + mockHttpRpcClient = mock(HttpRpcClient.class); + mockConsumerConfig = mock(ConsumerConfig.class); + mockProtocolConfig = mock(ProtocolConfig.class); + mockBackendConfig = mock(BackendConfig.class); + mockWorkerPool = mock(WorkerPool.class); + + when(mockConsumerConfig.getBackendConfig()).thenReturn(mockBackendConfig); + when(mockBackendConfig.getWorkerPoolObj()).thenReturn(mockWorkerPool); + when(mockProtocolConfig.getIp()).thenReturn("127.0.0.1"); + when(mockProtocolConfig.getPort()).thenReturn(8080); + when(mockProtocolConfig.getExtMap()).thenReturn(new HashMap<>()); + + invoker = new HttpConsumerInvoker<>(mockHttpRpcClient, mockConsumerConfig, mockProtocolConfig); + } + + @After + public void tearDown() { + AbstractConsumerInvoker.reset(); + ConfigManager.stopTest(); + } + + /** + * 测试简单头值（无分号）能被完整解析。 + * 例如：X-Custom-Header: simple-value + */ + @Test + public void testSimpleHeaderValueParsedCorrectly() throws Exception { + CloseableHttpResponse mockResponse = buildMockResponse( + HttpStatus.SC_OK, + new Header[]{ + new BasicHeader("X-Custom-Header", "simple-value"), + new BasicHeader(HttpHeaders.CONTENT_LENGTH, "0") + }, + null + ); + + Request mockRequest = buildMockRequest(); + + Response response = invokeHandleResponse(mockRequest, mockResponse); + + assertNotNull(response); + assertNotNull(response.getAttachments()); + byte[] headerValue = (byte[]) response.getAttachments().get("X-Custom-Header"); + assertNotNull(headerValue); + assertEquals("simple-value", new String(headerValue, StandardCharsets.UTF_8)); + } + + /** + * 测试含分号的复合头值能被完整解析（这是修复的核心场景）。 + * 原来的 HeaderElement.getName() 只返回分号前的部分（如 "application/json"）， + * 修复后的 header.getValue() 返回完整值（如 "application/json; charset=utf-8"）。 + */ + @Test + public void testComplexHeaderWithSemicolonParsedCompletely() throws Exception { + String fullContentType = "application/json; charset=utf-8"; + CloseableHttpResponse mockResponse = buildMockResponse( + HttpStatus.SC_OK, + new Header[]{ + new BasicHeader(HttpHeaders.CONTENT_TYPE, fullContentType), + new BasicHeader(HttpHeaders.CONTENT_LENGTH, "0") + }, + null + ); + + Request mockRequest = buildMockRequest(); + + Response response = invokeHandleResponse(mockRequest, mockResponse); + + assertNotNull(response); + byte[] contentTypeValue = (byte[]) response.getAttachments().get(HttpHeaders.CONTENT_TYPE); + assertNotNull(contentTypeValue); + // 修复后应返回完整值，而非仅 "application/json" + assertEquals(fullContentType, new String(contentTypeValue, StandardCharsets.UTF_8)); + } + + /** + * 测试含等号的头值能被完整解析。 + * 原来的 HeaderElement.getName() 对含 = 的值也会截断， + * 修复后的 header.getValue() 返回完整值。 + * 例如：X-Token: key=abc123 + */ + @Test + public void testHeaderWithEqualSignParsedCompletely() throws Exception { + String tokenValue = "key=abc123"; + CloseableHttpResponse mockResponse = buildMockResponse( + HttpStatus.SC_OK, + new Header[]{ + new BasicHeader("X-Token", tokenValue), + new BasicHeader(HttpHeaders.CONTENT_LENGTH, "0") + }, + null + ); + + Request mockRequest = buildMockRequest(); + + Response response = invokeHandleResponse(mockRequest, mockResponse); + + assertNotNull(response); + byte[] tokenBytes = (byte[]) response.getAttachments().get("X-Token"); + assertNotNull(tokenBytes); + assertEquals(tokenValue, new String(tokenBytes, StandardCharsets.UTF_8)); + } + + /** + * 测试多个响应头都能被正确解析并存入 attachments。 + */ + @Test + public void testMultipleHeadersAllParsedCorrectly() throws Exception { + CloseableHttpResponse mockResponse = buildMockResponse( + HttpStatus.SC_OK, + new Header[]{ + new BasicHeader("X-Trace-Id", "trace-abc-123"), + new BasicHeader("X-Caller", "service-a"), + new BasicHeader("X-Callee", "service-b"), + new BasicHeader(HttpHeaders.CONTENT_LENGTH, "0") + }, + null + ); + + Request mockRequest = buildMockRequest(); + + Response response = invokeHandleResponse(mockRequest, mockResponse); + + assertNotNull(response); + assertEquals("trace-abc-123", + new String((byte[]) response.getAttachments().get("X-Trace-Id"), StandardCharsets.UTF_8)); + assertEquals("service-a", + new String((byte[]) response.getAttachments().get("X-Caller"), StandardCharsets.UTF_8)); + assertEquals("service-b", + new String((byte[]) response.getAttachments().get("X-Callee"), StandardCharsets.UTF_8)); + } + + /** + * 测试头值以 byte[] 形式存储（与 tRPC 协议保持一致）。 + */ + @Test + public void testHeaderValueStoredAsByteArray() throws Exception { + String expectedValue = "test-value"; + CloseableHttpResponse mockResponse = buildMockResponse( + HttpStatus.SC_OK, + new Header[]{ + new BasicHeader("X-Test", expectedValue), + new BasicHeader(HttpHeaders.CONTENT_LENGTH, "0") + }, + null + ); + + Request mockRequest = buildMockRequest(); + + Response response = invokeHandleResponse(mockRequest, mockResponse); + + assertNotNull(response); + Object storedValue = response.getAttachments().get("X-Test"); + // 验证存储类型为 byte[] + assertNotNull(storedValue); + assertEquals(byte[].class, storedValue.getClass()); + assertArrayEquals(expectedValue.getBytes(StandardCharsets.UTF_8), (byte[]) storedValue); + } + + /** + * 测试 HTTP 状态码非 200 时抛出 TRpcException。 + */ + @Test(expected = com.tencent.trpc.core.exception.TRpcException.class) + public void testNon200StatusCodeThrowsException() throws Exception { + CloseableHttpResponse mockResponse = buildMockResponse( + HttpStatus.SC_NOT_FOUND, + new Header[]{}, + null + ); + + Request mockRequest = buildMockRequest(); + invokeHandleResponse(mockRequest, mockResponse); + } + + /** + * 测试 Content-Length 为 0 时返回空响应体。 + */ + @Test + public void testZeroContentLengthReturnsEmptyResponse() throws Exception { + CloseableHttpResponse mockResponse = buildMockResponse( + HttpStatus.SC_OK, + new Header[]{ + new BasicHeader(HttpHeaders.CONTENT_LENGTH, "0") + }, + null + ); + + Request mockRequest = buildMockRequest(); + + Response response = invokeHandleResponse(mockRequest, mockResponse); + + assertNotNull(response); + assertNull(response.getValue()); + } + + /** + * 测试含多个分号和等号的复杂头值能被完整解析。 + * 例如：Set-Cookie: sessionId=abc; Path=/; HttpOnly + */ + @Test + public void testComplexCookieHeaderParsedCompletely() throws Exception { + String cookieValue = "sessionId=abc; Path=/; HttpOnly"; + CloseableHttpResponse mockResponse = buildMockResponse( + HttpStatus.SC_OK, + new Header[]{ + new BasicHeader("Set-Cookie", cookieValue), + new BasicHeader(HttpHeaders.CONTENT_LENGTH, "0") + }, + null + ); + + Request mockRequest = buildMockRequest(); + + Response response = invokeHandleResponse(mockRequest, mockResponse); + + assertNotNull(response); + byte[] cookieBytes = (byte[]) response.getAttachments().get("Set-Cookie"); + assertNotNull(cookieBytes); + // 修复后应返回完整的 Cookie 值，而非仅 "sessionId" + assertEquals(cookieValue, new String(cookieBytes, StandardCharsets.UTF_8)); + } + + /** + * 测试响应体正常解析（Content-Length 不为 0 时）。 + */ + @Test + public void testResponseBodyParsedWhenContentLengthNonZero() throws Exception { + String jsonBody = "\"hello\""; + CloseableHttpResponse mockResponse = buildMockResponse( + HttpStatus.SC_OK, + new Header[]{ + new BasicHeader("X-Custom", "custom-value"), + new BasicHeader(HttpHeaders.CONTENT_LENGTH, String.valueOf(jsonBody.length())) + }, + jsonBody + ); + + Request mockRequest = buildMockRequest(); + + Response response = invokeHandleResponse(mockRequest, mockResponse); + + assertNotNull(response); + // 验证响应头也被正确解析 + byte[] customValue = (byte[]) response.getAttachments().get("X-Custom"); + assertNotNull(customValue); + assertEquals("custom-value", new String(customValue, StandardCharsets.UTF_8)); + // 验证响应体被正确解析 + assertEquals("hello", response.getValue()); + } + + // ==================== 辅助方法 ==================== + + /** + * 构建 mock HTTP 响应。 + */ + private CloseableHttpResponse buildMockResponse(int statusCode, Header[] headers, String body) { + CloseableHttpResponse mockResponse = mock(CloseableHttpResponse.class); + StatusLine statusLine = new BasicStatusLine(HttpVersion.HTTP_1_1, statusCode, + statusCode == HttpStatus.SC_OK ? "OK" : "Not Found"); + when(mockResponse.getStatusLine()).thenReturn(statusLine); + when(mockResponse.getAllHeaders()).thenReturn(headers); + + // 设置 Content-Length header 查询 + for (Header header : headers) { + if (HttpHeaders.CONTENT_LENGTH.equalsIgnoreCase(header.getName())) { + when(mockResponse.getFirstHeader(HttpHeaders.CONTENT_LENGTH)).thenReturn(header); + } + } + + if (body != null) { + BasicHttpEntity entity = new BasicHttpEntity(); + entity.setContent(new ByteArrayInputStream(body.getBytes(StandardCharsets.UTF_8))); + when(mockResponse.getEntity()).thenReturn(entity); + } + + return mockResponse; + } + + /** + * 构建 mock Request 对象，使用 RpcMethodInfo 返回 String 类型。 + */ + private Request buildMockRequest() throws Exception { + Request mockRequest = mock(Request.class); + RequestMeta mockMeta = mock(RequestMeta.class); + CallInfo mockCallInfo = mock(CallInfo.class); + + // 构建真实的 RpcInvocation 和 RpcMethodInfo + RpcInvocation invocation = new RpcInvocation(); + Method method = TestService.class.getMethod("testMethod", String.class); + RpcMethodInfo methodInfo = new RpcMethodInfo(TestService.class, method); + invocation.setRpcMethodInfo(methodInfo); + + when(mockRequest.getInvocation()).thenReturn(invocation); + when(mockRequest.getMeta()).thenReturn(mockMeta); + when(mockMeta.getCallInfo()).thenReturn(mockCallInfo); + when(mockCallInfo.getCaller()).thenReturn("test-caller"); + when(mockCallInfo.getCallee()).thenReturn("test-callee"); + when(mockRequest.getAttachments()).thenReturn(new HashMap<>()); + + return mockRequest; + } + + /** + * 通过反射调用私有方法 handleResponse。 + */ + private Response invokeHandleResponse(Request request, CloseableHttpResponse httpResponse) + throws Exception { + Method handleResponseMethod = HttpConsumerInvoker.class + .getDeclaredMethod("handleResponse", Request.class, CloseableHttpResponse.class); + handleResponseMethod.setAccessible(true); + try { + return (Response) handleResponseMethod.invoke(invoker, request, httpResponse); + } catch (java.lang.reflect.InvocationTargetException e) { + // 将被包装的异常重新抛出，以便 @Test(expected=...) 能正确捕获 + if (e.getCause() instanceof Exception) { + throw (Exception) e.getCause(); + } + throw e; + } + } + + /** + * 测试用服务接口。 + */ + private interface TestService { + String testMethod(String input); + } +}