diff --git a/ballerina-tests/http-client-tests/tests/http_client_host_header_test.bal b/ballerina-tests/http-client-tests/tests/http_client_host_header_test.bal new file mode 100644 index 0000000000..a81562d92d --- /dev/null +++ b/ballerina-tests/http-client-tests/tests/http_client_host_header_test.bal @@ -0,0 +1,131 @@ +// Copyright (c) 2024 WSO2 LLC. (http://www.wso2.org). +// +// WSO2 LLC. licenses this file to you 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. + +import ballerina/http; +import ballerina/test; + +final http:Client http2ClientHost1 = check new("localhost:" + http2ClientHostHeaderTestPort.toString()); +final http:Client http2ClientHost2 = check new("localhost:" + httpClientHostHeaderTestPort.toString()); +final http:Client httpClientHost1 = check new("localhost:" + httpClientHostHeaderTestPort.toString(), httpVersion = http:HTTP_1_1); +final http:Client httpClientHost2 = check new("localhost:" + http2ClientHostHeaderTestPort.toString(), httpVersion = http:HTTP_1_1); + +service / on new http:Listener(http2ClientHostHeaderTestPort) { + + resource function 'default host(http:Request req) returns string|error { + return req.getHeader("Host"); + } +} + +service / on new http:Listener(httpClientHostHeaderTestPort, httpVersion = http:HTTP_1_1) { + + resource function 'default host(http:Request req) returns string|error { + return req.getHeader("Host"); + } +} + +@test:Config {} +function testHttpClientHostHeader1() returns error? { + string host = check httpClientHost1->/host; + test:assertEquals(host, "localhost:" + httpClientHostHeaderTestPort.toString()); + + host = check httpClientHost1->get("/host"); + test:assertEquals(host, "localhost:" + httpClientHostHeaderTestPort.toString()); + + host = check httpClientHost2->/host; + test:assertEquals(host, "localhost:" + http2ClientHostHeaderTestPort.toString()); + + host = check httpClientHost2->get("/host"); + test:assertEquals(host, "localhost:" + http2ClientHostHeaderTestPort.toString()); +} + +@test:Config {} +function testHttpClientHostHeader2() returns error? { + string host = check httpClientHost1->/host.get({"Host": "mock.com"}); + test:assertEquals(host, "mock.com"); + + host = check httpClientHost1->get("/host", {"Host": "mock.com"}); + test:assertEquals(host, "mock.com"); + + host = check httpClientHost2->/host.get({"Host": "mock.com"}); + test:assertEquals(host, "mock.com"); + + host = check httpClientHost2->get("/host", {"Host": "mock.com"}); + test:assertEquals(host, "mock.com"); +} + +@test:Config {} +function testHttpClientHostHeader3() returns error? { + http:Request req = new; + req.setHeader("Host", "mock.com"); + string host = check httpClientHost1->/host.post(req); + test:assertEquals(host, "mock.com"); + + host = check httpClientHost1->post("/host", req, {"Host": "mock2.com"}); + test:assertEquals(host, "mock2.com"); + + host = check httpClientHost2->/host.post(req); + test:assertEquals(host, "mock2.com"); + + host = check httpClientHost2->post("/host", req, {"Host": "mock3.com"}); + test:assertEquals(host, "mock3.com"); +} + +@test:Config {} +function testHttp2ClientHostHeader1() returns error? { + string host = check http2ClientHost1->/host; + test:assertEquals(host, "localhost:" + http2ClientHostHeaderTestPort.toString()); + + host = check http2ClientHost1->get("/host"); + test:assertEquals(host, "localhost:" + http2ClientHostHeaderTestPort.toString()); + + host = check http2ClientHost2->/host; + test:assertEquals(host, "localhost:" + httpClientHostHeaderTestPort.toString()); + + host = check http2ClientHost2->get("/host"); + test:assertEquals(host, "localhost:" + httpClientHostHeaderTestPort.toString()); +} + +@test:Config {} +function testHttp2ClientHostHeader2() returns error? { + string host = check http2ClientHost1->/host.get({"Host": "mock.com"}); + test:assertEquals(host, "mock.com"); + + host = check http2ClientHost1->get("/host", {"Host": "mock.com"}); + test:assertEquals(host, "mock.com"); + + host = check http2ClientHost2->/host.get({"Host": "mock.com"}); + test:assertEquals(host, "mock.com"); + + host = check http2ClientHost2->get("/host", {"Host": "mock.com"}); + test:assertEquals(host, "mock.com"); +} + +@test:Config {} +function testHttp2ClientHostHeader3() returns error? { + http:Request req = new; + req.setHeader("Host", "mock.com"); + string host = check http2ClientHost1->/host.post(req); + test:assertEquals(host, "mock.com"); + + host = check http2ClientHost1->post("/host", req, {"Host": "mock2.com"}); + test:assertEquals(host, "mock2.com"); + + host = check http2ClientHost2->/host.post(req); + test:assertEquals(host, "mock2.com"); + + host = check http2ClientHost2->post("/host", req, {"Host": "mock3.com"}); + test:assertEquals(host, "mock3.com"); +} diff --git a/ballerina-tests/http-client-tests/tests/test_service_ports.bal b/ballerina-tests/http-client-tests/tests/test_service_ports.bal index 2955ca91bb..fce33b93e3 100644 --- a/ballerina-tests/http-client-tests/tests/test_service_ports.bal +++ b/ballerina-tests/http-client-tests/tests/test_service_ports.bal @@ -32,3 +32,6 @@ const int clientSchemeTestHttpsListenerTestPort = 9624; const int clientResourceMethodsTestPort = 9631; const int clientFormUrlEncodedTestPort = 9604; + +const int http2ClientHostHeaderTestPort = 9605; +const int httpClientHostHeaderTestPort = 9606; diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml index 3e5e088a5a..e27e64ea79 100644 --- a/ballerina/Ballerina.toml +++ b/ballerina/Ballerina.toml @@ -1,7 +1,7 @@ [package] org = "ballerina" name = "http" -version = "2.10.7" +version = "2.10.8" authors = ["Ballerina"] keywords = ["http", "network", "service", "listener", "client"] repository = "https://github.com/ballerina-platform/module-ballerina-http" @@ -16,8 +16,8 @@ graalvmCompatible = true [[platform.java17.dependency]] groupId = "io.ballerina.stdlib" artifactId = "http-native" -version = "2.10.7" -path = "../native/build/libs/http-native-2.10.7.jar" +version = "2.10.8" +path = "../native/build/libs/http-native-2.10.8-SNAPSHOT.jar" [[platform.java17.dependency]] groupId = "io.ballerina.stdlib" diff --git a/ballerina/CompilerPlugin.toml b/ballerina/CompilerPlugin.toml index d48d4d5249..d6586898cd 100644 --- a/ballerina/CompilerPlugin.toml +++ b/ballerina/CompilerPlugin.toml @@ -3,4 +3,4 @@ id = "http-compiler-plugin" class = "io.ballerina.stdlib.http.compiler.HttpCompilerPlugin" [[dependency]] -path = "../compiler-plugin/build/libs/http-compiler-plugin-2.10.7.jar" +path = "../compiler-plugin/build/libs/http-compiler-plugin-2.10.8-SNAPSHOT.jar" diff --git a/ballerina/Dependencies.toml b/ballerina/Dependencies.toml index b071ba7c4e..9bc6068fbe 100644 --- a/ballerina/Dependencies.toml +++ b/ballerina/Dependencies.toml @@ -25,7 +25,7 @@ modules = [ [[package]] org = "ballerina" name = "cache" -version = "3.7.0" +version = "3.7.1" dependencies = [ {org = "ballerina", name = "constraint"}, {org = "ballerina", name = "jballerina.java"}, @@ -76,7 +76,7 @@ modules = [ [[package]] org = "ballerina" name = "http" -version = "2.10.7" +version = "2.10.8" dependencies = [ {org = "ballerina", name = "auth"}, {org = "ballerina", name = "cache"}, @@ -283,7 +283,7 @@ modules = [ [[package]] org = "ballerina" name = "observe" -version = "1.2.0" +version = "1.2.2" dependencies = [ {org = "ballerina", name = "jballerina.java"} ] diff --git a/changelog.md b/changelog.md index 4d1e0b9b41..48566cc8ce 100644 --- a/changelog.md +++ b/changelog.md @@ -5,6 +5,12 @@ This file contains all the notable changes done to the Ballerina HTTP package th The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +### Added + +- [Make the `Host` header overridable](https://github.com/ballerina-platform/ballerina-library/issues/6133) + ## [2.10.7] - 2024-02-14 ### Fixed diff --git a/native/src/main/java/io/ballerina/stdlib/http/api/client/actions/AbstractHTTPAction.java b/native/src/main/java/io/ballerina/stdlib/http/api/client/actions/AbstractHTTPAction.java index b3c980957e..64bb9c8f0a 100644 --- a/native/src/main/java/io/ballerina/stdlib/http/api/client/actions/AbstractHTTPAction.java +++ b/native/src/main/java/io/ballerina/stdlib/http/api/client/actions/AbstractHTTPAction.java @@ -213,6 +213,9 @@ private static int getStartTime(BObject timestamp) { } private static void setHostHeader(String host, int port, HttpHeaders headers) { + if (headers.contains(HttpHeaderNames.HOST)) { + return; + } if (port == 80 || port == 443) { headers.set(HttpHeaderNames.HOST, host); } else { diff --git a/test-utils/src/main/java/io/ballerina/stdlib/http/testutils/client/HttpClient.java b/test-utils/src/main/java/io/ballerina/stdlib/http/testutils/client/HttpClient.java index ab3b218f69..4288ac9643 100644 --- a/test-utils/src/main/java/io/ballerina/stdlib/http/testutils/client/HttpClient.java +++ b/test-utils/src/main/java/io/ballerina/stdlib/http/testutils/client/HttpClient.java @@ -36,6 +36,7 @@ import io.netty.handler.codec.http.HttpHeaderValues; import io.netty.handler.codec.http.HttpMethod; import io.netty.handler.codec.http.HttpObjectAggregator; +import io.netty.handler.codec.http.HttpRequest; import io.netty.handler.codec.http.HttpResponseStatus; import io.netty.handler.codec.http.HttpVersion; import org.slf4j.Logger; @@ -100,7 +101,7 @@ private FullHttpResponse send(FullHttpRequest httpRequest) { this.responseHandler.setLatch(latch); this.responseHandler.setWaitForConnectionClosureLatch(this.waitForConnectionClosureLatch); - httpRequest.headers().set(HttpHeaderNames.HOST, host + ":" + port); + addHostHeader(httpRequest); this.connectedChannel.writeAndFlush(httpRequest); try { latch.await(); @@ -117,7 +118,7 @@ public List sendExpectContinueRequest(DefaultHttpRequest httpR this.responseHandler.setLatch(latch); this.responseHandler.setWaitForConnectionClosureLatch(this.waitForConnectionClosureLatch); - httpRequest.headers().set(HttpHeaderNames.HOST, host + ":" + port); + addHostHeader(httpRequest); httpRequest.headers().set(HttpHeaderNames.EXPECT, HttpHeaderValues.CONTINUE); this.connectedChannel.writeAndFlush(httpRequest); @@ -149,7 +150,7 @@ public LinkedList sendTwoInPipeline(FullHttpRequest httpReques this.responseHandler.setLatch(latch); this.responseHandler.setWaitForConnectionClosureLatch(this.waitForConnectionClosureLatch); - httpRequest.headers().set(HttpHeaderNames.HOST, host + ":" + port); + addHostHeader(httpRequest); this.connectedChannel.writeAndFlush(httpRequest.copy()); this.connectedChannel.writeAndFlush(httpRequest); @@ -161,6 +162,12 @@ public LinkedList sendTwoInPipeline(FullHttpRequest httpReques return this.responseHandler.getHttpFullResponses(); } + private void addHostHeader(HttpRequest httpRequest) { + if (!httpRequest.headers().contains(HttpHeaderNames.HOST)) { + httpRequest.headers().set(HttpHeaderNames.HOST, host + ":" + port); + } + } + /** * Send pipelined requests to the server. * @@ -236,7 +243,7 @@ public String sendMultiplePipelinedRequests(String path) { */ private FullHttpRequest getFullHttpRequest(String path, String requestId) { FullHttpRequest request = new DefaultFullHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.GET, path); - request.headers().set(HttpHeaderNames.HOST, host + ":" + port); + addHostHeader(request); request.headers().set(HttpHeaderNames.CONNECTION, HttpHeaderValues.KEEP_ALIVE); request.headers().set("message-id", requestId); return request;