Add support for brotli compression format

ballerina-tests/http-advanced-tests/tests/service_configuration_compression_annotation_test.bal

@@ -112,25 +112,103 @@ function testAutoCompress() {
         test:assertFalse(response.hasHeader(common:CONTENT_ENCODING),
             msg = "The content-encoding header should be null and the identity which means no compression " +
                         "should be done to the response");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
     } else {
         test:assertFail(msg = "Found unexpected output type: " + response.message());
     }
 }
 
-//Test Compression.AUTO, with Accept-Encoding header. 
+//Test Compression.AUTO, with Accept-Encoding header - gzip.
 //The response here means the one that should be sent to transport, not to end user.
 @test:Config {}
-function testAutoCompressWithAcceptEncoding() {
+function testAutoCompressWithAcceptEncoding1() {
     http:Response|error response = compressionClient->get("/autoCompress", {[common:ACCEPT_ENCODING] : [common:ENCODING_GZIP]});
     if response is http:Response {
         test:assertFalse(response.hasHeader(common:CONTENT_ENCODING),
             msg = "The content-encoding header should be null and the original value of Accept-Encoding should " +
                         "be used for compression from the backend");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
     } else {
         test:assertFail(msg = "Found unexpected output type: " + response.message());
     }
 }
 
+//Test Compression.AUTO, with Accept-Encoding header - br.
+//The response here means the one that should be sent to transport, not to end user.
+@test:Config {}
+function testAutoCompressWithAcceptEncoding2() {
+    http:Response|error response = compressionClient->get("/autoCompress", {[common:ACCEPT_ENCODING] : [common:ENCODING_BR]});
+    if response is http:Response {
+        test:assertFalse(response.hasHeader(common:CONTENT_ENCODING),
+            msg = "The content-encoding header should be null and the original value of Accept-Encoding should " +
+                        "be used for compression from the backend");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
+    } else {
+        test:assertFail(msg = "Found unexpected output type: " + response.message());
+    }
+}
+
+//Test Compression.AUTO, with Accept-Encoding header - deflate.
+//The response here means the one that should be sent to transport, not to end user.
+@test:Config {}
+function testAutoCompressWithAcceptEncoding3() {
+    http:Response|error response = compressionClient->get("/autoCompress", {[common:ACCEPT_ENCODING] : [common:ENCODING_DEFLATE]});
+    if response is http:Response {
+        test:assertFalse(response.hasHeader(common:CONTENT_ENCODING),
+            msg = "The content-encoding header should be null and the original value of Accept-Encoding should " +
+                        "be used for compression from the backend");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
+    } else {
+        test:assertFail(msg = "Found unexpected output type: " + response.message());
+    }
+}
+
+//Test Compression.AUTO, with Accept-Encoding header - gzip, deflate.
+//The response here means the one that should be sent to transport, not to end user.
+@test:Config {}
+function testAutoCompressWithAcceptEncoding4() {
+    http:Response|error response = compressionClient->get("/autoCompress", {[common:ACCEPT_ENCODING] : [common:ENCODING_GZIP, common:ENCODING_DEFLATE]});
+    if response is http:Response {
+        test:assertFalse(response.hasHeader(common:CONTENT_ENCODING),
+            msg = "The content-encoding header should be null and the original value of Accept-Encoding should " +
+                        "be used for compression from the backend");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
+    } else {
+        test:assertFail(msg = "Found unexpected output type: " + response.message());
+    }
+}
+
+//Test Compression.AUTO, with Accept-Encoding header - gzip, br.
+//The response here means the one that should be sent to transport, not to end user.
+@test:Config {}
+function testAutoCompressWithAcceptEncoding5() {
+    http:Response|error response = compressionClient->get("/autoCompress", {[common:ACCEPT_ENCODING] : [common:ENCODING_GZIP, common:ENCODING_BR]});
+    if response is http:Response {
+        test:assertFalse(response.hasHeader(common:CONTENT_ENCODING),
+            msg = "The content-encoding header should be null and the original value of Accept-Encoding should " +
+                        "be used for compression from the backend");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
+    } else {
+        test:assertFail(msg = "Found unexpected output type: " + response.message());
+    }
+}
+
+//Test Compression.AUTO, with Accept-Encoding header - gzip, deflate, br.
+//The response here means the one that should be sent to transport, not to end user.
+@test:Config {}
+function testAutoCompressWithAcceptEncoding6() {
+    http:Response|error response = compressionClient->get("/autoCompress", {[common:ACCEPT_ENCODING] : [common:ENCODING_GZIP, common:ENCODING_DEFLATE, common:ENCODING_BR]});
+    if response is http:Response {
+        test:assertFalse(response.hasHeader(common:CONTENT_ENCODING),
+            msg = "The content-encoding header should be null and the original value of Accept-Encoding should " +
+                        "be used for compression from the backend");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
+    } else {
+        test:assertFail(msg = "Found unexpected output type: " + response.message());
+    }
+}
+
+
 //Test Compression.AUTO, with contentTypes and without Accept-Encoding header. 
 //The response here means the one that should be sent to transport, not to end user.
 @test:Config {}
@@ -154,23 +232,52 @@ function testAlwaysCompress() returns error? {
     if response is http:Response {
         test:assertEquals(check response.getHeader(common:CONTENT_ENCODING), common:ENCODING_GZIP,
             msg = "The content-encoding header should be gzip.");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
     } else {
         test:assertFail(msg = "Found unexpected output type: " + response.message());
     }
 }
 
-//Test Compression.ALWAYS, with Accept-Encoding header. 
+//Test Compression.ALWAYS, with Accept-Encoding header - deflate.
 //The response here means the one that should be sent to transport, not to end user.
 @test:Config {}
-function testAlwaysCompressWithAcceptEncoding() {
-    http:Request req = new;
-    req.setTextPayload("hello");
-    req.setHeader(common:ACCEPT_ENCODING, common:ENCODING_DEFLATE);
-    http:Response|error response = compressionClient->post("/alwaysCompress", req);
+function testAlwaysCompressWithAcceptEncoding1() {
+    http:Response|error response = compressionClient->get("/alwaysCompress", {[common:ACCEPT_ENCODING]: common:ENCODING_DEFLATE});
+    if response is http:Response {
+        test:assertFalse(response.hasHeader(common:CONTENT_ENCODING),
+            msg = "The content-encoding header should be set to null and the transport will use the original" +
+                        "Accept-Encoding value for compression.");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
+    } else {
+        test:assertFail(msg = "Found unexpected output type: " + response.message());
+    }
+}
+
+//Test Compression.ALWAYS, with Accept-Encoding header - br.
+//The response here means the one that should be sent to transport, not to end user.
+@test:Config {}
+function testAlwaysCompressWithAcceptEncoding2() {
+    http:Response|error response = compressionClient->get("/alwaysCompress", {[common:ACCEPT_ENCODING]: common:ENCODING_BR});
+    if response is http:Response {
+        test:assertFalse(response.hasHeader(common:CONTENT_ENCODING),
+            msg = "The content-encoding header should be set to null and the transport will use the original" +
+                        "Accept-Encoding value for compression.");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
+    } else {
+        test:assertFail(msg = "Found unexpected output type: " + response.message());
+    }
+}
+
+//Test Compression.ALWAYS, with Accept-Encoding header - deflate, br.
+//The response here means the one that should be sent to transport, not to end user.
+@test:Config {}
+function testAlwaysCompressWithAcceptEncoding3() {
+    http:Response|error response = compressionClient->get("/alwaysCompress", {[common:ACCEPT_ENCODING]: [common:ENCODING_DEFLATE + "," + common:ENCODING_BR]});
     if response is http:Response {
         test:assertFalse(response.hasHeader(common:CONTENT_ENCODING),
             msg = "The content-encoding header should be set to null and the transport will use the original" +
                         "Accept-Encoding value for compression.");
+        common:assertTextPayload(response.getTextPayload(), "Hello World!!!");
     } else {
         test:assertFail(msg = "Found unexpected output type: " + response.message());
     }

ballerina-tests/http-misc-tests/tests/configuration_accept_encoding_test.bal

@@ -53,7 +53,7 @@ function testAcceptEncodingEnabled() {
     http:Response|error response = acceptEncodingEnableEP->post("/", req);
     if response is http:Response {
         test:assertEquals(response.statusCode, 200, msg = "Found unexpected output");
-        common:assertJsonValue(response.getJsonPayload(), "acceptEncoding", "deflate, gzip");
+        common:assertJsonValue(response.getJsonPayload(), "acceptEncoding", "deflate, gzip, br");
         common:assertHeaderValue(response.server, "Mysql");
     } else {
         test:assertFail(msg = "Found unexpected output type: " + response.message());

ballerina-tests/http-test-common/constants.bal

@@ -56,6 +56,7 @@ public const string SERVER = "server";
 
 public const string ENCODING_GZIP = "gzip";
 public const string ENCODING_DEFLATE = "deflate";
+public const string ENCODING_BR = "br";
 public const string HTTP_TRANSFER_ENCODING_IDENTITY = "identity";
 
 public const string HTTP_METHOD_GET = "GET";

ballerina-tests/http2-tests/tests/http2_configuration_accept_encoding_test.bal

@@ -55,7 +55,7 @@ function testHttp2AcceptEncodingEnabled() {
     http:Response|error response = http2AcceptEncodingEnableEP->post("/", req);
     if response is http:Response {
         test:assertEquals(response.statusCode, 200, msg = "Found unexpected output");
-        common:assertJsonValue(response.getJsonPayload(), "acceptEncoding", "deflate, gzip");
+        common:assertJsonValue(response.getJsonPayload(), "acceptEncoding", "deflate, gzip, br");
         common:assertHeaderValue(response.server, "Mysql");
     } else {
         test:assertFail(msg = "Found unexpected output type: " + response.message());

ballerina/build.gradle

@@ -147,6 +147,40 @@ dependencies {
     externalJars(group: 'com.google.protobuf', name: 'protobuf-java', version: "${protobufVersion}") {
         transitive = false
     }
+
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'brotli4j', version: "${brotli4jVersion}") {
+        transitive = false
+    }
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'service', version: "${brotli4jVersion}") {
+        transitive = false
+    }
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'native-linux-ppc64le', version: "${brotli4jVersion}") {
+        transitive = false
+    }
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'native-linux-x86_64', version: "${brotli4jVersion}") {
+        transitive = false
+    }
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'native-linux-aarch64', version: "${brotli4jVersion}") {
+        transitive = false
+    }
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'native-linux-armv7', version: "${brotli4jVersion}") {
+        transitive = false
+    }
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'native-linux-riscv64', version: "${brotli4jVersion}") {
+        transitive = false
+    }
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'native-osx-x86_64', version: "${brotli4jVersion}") {
+        transitive = false
+    }
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'native-osx-aarch64', version: "${brotli4jVersion}") {
+        transitive = false
+    }
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'native-windows-x86_64', version: "${brotli4jVersion}") {
+        transitive = false
+    }
+    externalJars(group: 'com.aayushatharva.brotli4j', name: 'native-windows-aarch64', version: "${brotli4jVersion}") {
+        transitive = false
+    }
 }
 
 task updateTomlFiles {
@@ -164,6 +198,7 @@ task updateTomlFiles {
         def stdlibDependentLz4Version = project.lz4Version
         def stdlibDependentMarshallingVersion = project.marshallingVersion
         def stdlibDependentProtobufVersion = project.protobufVersion
+        def stdlibDependentBrotli4jVersion = project.brotli4jVersion
         def ballerinaToOpenApiVersion = project.ballerinaToOpenApiVersion
 
         def newBallerinaToml = ballerinaTomlFilePlaceHolder.text.replace("@project.version@", project.version)
@@ -181,6 +216,7 @@ task updateTomlFiles {
         newBallerinaToml = newBallerinaToml.replace("@lz4.version@", stdlibDependentLz4Version)
         newBallerinaToml = newBallerinaToml.replace("@marshalling.version@", stdlibDependentMarshallingVersion)
         newBallerinaToml = newBallerinaToml.replace("@protobuf.version@", stdlibDependentProtobufVersion)
+        newBallerinaToml = newBallerinaToml.replace("@brotli4j.version@", stdlibDependentBrotli4jVersion)
         ballerinaTomlFile.text = newBallerinaToml
 
         def newCompilerPluginToml = compilerPluginTomlFilePlaceHolder.text.replace("@project.version@", project.version)

build-config/resources/Ballerina.toml

@@ -171,3 +171,69 @@ groupId = "com.google.protobufl"
 artifactId = "protobuf-java"
 version = "@protobuf.version@"
 path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "brotli4j"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "service"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "native-linux-ppc64le"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "native-linux-x86_64"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "native-linux-aarch64"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "native-linux-armv7"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "native-linux-riscv64"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "native-osx-x86_64"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "native-osx-aarch64"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "native-windows-x86_64"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"
+
+[[platform.java17.dependency]]
+groupId = "com.aayushatharva.brotli4j"
+artifactId = "native-windows-aarch64"
+version = "@brotli4j.version@"
+path = "./lib/[email protected]@.jar"

changelog.md

@@ -16,6 +16,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [Introduce util functions to convert query and header record with the `http:Query` and the `http:Header` annotations](https://github.com/ballerina-platform/ballerina-library/issues/7019)
 - [Migrate client and service data binding lang utils usage into data.jsondata module utils `toJson` and `parserAsType`] (https://github.com/ballerina-platform/ballerina-library/issues/6747)
 - [Add static code rules](https://github.com/ballerina-platform/ballerina-library/issues/7283)
+- [Add compression/decompression support for `brotli` compression format](https://github.com/ballerina-platform/ballerina-library/issues/6547)
 
 ### Fixed
 
@@ -25,6 +26,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ## [2.12.0] - 2024-08-20
 
 ### Added
+
 - [Add support for Server-Sent Events](https://github.com/ballerina-platform/ballerina-library/issues/6687)
 - [Introduce default status code response record](https://github.com/ballerina-platform/ballerina-library/issues/6491)
 - [Add connection eviction feature to handle connections that receive GO_AWAY from the client](https://github.com/ballerina-platform/ballerina-library/issues/6734)

gradle.properties

@@ -23,6 +23,7 @@ lz4Version=1.3.0
 marshallingVersion=2.0.5.Final
 protobufVersion=3.25.5
 jacocoVersion=0.8.10
+brotli4jVersion=1.16.0
 ballerinaToOpenApiVersion=2.1.0
 swaggerCoreVersion=2.2.22
 

native/build.gradle

@@ -66,6 +66,17 @@ dependencies {
     implementation group: 'org.bouncycastle', name: 'bcutil-jdk18on', version: "${bouncycastleVersion}"
     implementation group: 'org.bouncycastle', name: 'bcpkix-jdk18on', version: "${bouncycastleVersion}"
     implementation group: 'jakarta.xml.bind', name: 'jakarta.xml.bind-api', version: "${jakartaXmlBindVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'brotli4j', version: "${brotli4jVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'service', version: "${brotli4jVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'native-linux-ppc64le', version: "${brotli4jVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'native-linux-x86_64', version: "${brotli4jVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'native-linux-aarch64', version: "${brotli4jVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'native-linux-armv7', version: "${brotli4jVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'native-linux-riscv64', version: "${brotli4jVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'native-osx-x86_64', version: "${brotli4jVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'native-osx-aarch64', version: "${brotli4jVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'native-windows-x86_64', version: "${brotli4jVersion}"
+    implementation group: 'com.aayushatharva.brotli4j', name: 'native-windows-aarch64', version: "${brotli4jVersion}"
 
     testImplementation group: 'org.mock-server', name: 'mockserver-netty', version:"${mockserverNettyVersion}"
     testImplementation group: 'com.mashape.unirest', name: 'unirest-java', version:"${unirestVersion}"