enable gzip encoding for capcitor http

android/build.gradle

@@ -0,0 +1 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.

android/capacitor/src/main/java/com/getcapacitor/plugin/util/CapacitorHttpUrlConnection.java

@@ -24,6 +24,7 @@
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
+import java.util.zip.GZIPOutputStream;
 import javax.net.ssl.HttpsURLConnection;
 import javax.net.ssl.SSLSocketFactory;
 import org.json.JSONException;
@@ -191,6 +192,7 @@ public void setRequestBody(PluginCall call, JSValue body) throws JSONException,
      */
     public void setRequestBody(PluginCall call, JSValue body, String bodyType) throws JSONException, IOException {
         String contentType = connection.getRequestProperty("Content-Type");
+        Boolean gzipCompression = call.getBoolean("gzipCompression", false);
         String dataString = "";
 
         if (contentType == null || contentType.isEmpty()) return;
@@ -207,7 +209,7 @@ public void setRequestBody(PluginCall call, JSValue body, String bodyType) throw
             } else if (body == null) {
                 dataString = call.getString("data");
             }
-            this.writeRequestBody(dataString != null ? dataString : "");
+            this.writeRequestBody(dataString != null ? dataString : "", gzipCompression);
         } else if (bodyType != null && bodyType.equals("file")) {
             try (DataOutputStream os = new DataOutputStream(connection.getOutputStream())) {
                 if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
@@ -221,12 +223,12 @@ public void setRequestBody(PluginCall call, JSValue body, String bodyType) throw
                 this.writeObjectRequestBody(obj);
             } catch (Exception e) {
                 // Body is not a valid JSON, treat it as an already formatted string
-                this.writeRequestBody(body.toString());
+                this.writeRequestBody(body.toString(), false);
             }
         } else if (bodyType != null && bodyType.equals("formData")) {
             this.writeFormDataRequestBody(contentType, body.toJSArray());
         } else {
-            this.writeRequestBody(body.toString());
+            this.writeRequestBody(body.toString(), gzipCompression);
         }
     }
 
@@ -235,10 +237,17 @@ public void setRequestBody(PluginCall call, JSValue body, String bodyType) throw
      *
      * @param body The string value to write to the connection stream.
      */
-    private void writeRequestBody(String body) throws IOException {
-        try (DataOutputStream os = new DataOutputStream(connection.getOutputStream())) {
-            os.write(body.getBytes(StandardCharsets.UTF_8));
-            os.flush();
+    private void writeRequestBody(String body, boolean gzipCompression) throws IOException {
+        if (gzipCompression) {
+            try (GZIPOutputStream gos = new GZIPOutputStream(connection.getOutputStream())) {
+                gos.write(body.getBytes(StandardCharsets.UTF_8));
+                gos.flush();
+            }
+        } else {
+            try (DataOutputStream dos = new DataOutputStream(connection.getOutputStream())) {
+                dos.write(body.getBytes(StandardCharsets.UTF_8));
+                dos.flush();
+            }
         }
     }
 

android/capacitor/src/main/java/com/getcapacitor/plugin/util/HttpRequestHandler.java

@@ -382,13 +382,19 @@ public static JSObject request(PluginCall call, String httpMethod, Bridge bridge
         Integer readTimeout = call.getInt("readTimeout");
         Boolean disableRedirects = call.getBoolean("disableRedirects");
         Boolean shouldEncode = call.getBoolean("shouldEncodeUrlParams", true);
+        Boolean gzipCompression = call.getBoolean("gzipCompression", false);
         ResponseType responseType = ResponseType.parse(call.getString("responseType"));
         String dataType = call.getString("dataType");
 
         String method = httpMethod != null ? httpMethod.toUpperCase(Locale.ROOT) : call.getString("method", "GET").toUpperCase(Locale.ROOT);
 
         boolean isHttpMutate = method.equals("DELETE") || method.equals("PATCH") || method.equals("POST") || method.equals("PUT");
 
+        // Set gzip header if compression is enabled
+        if (gzipCompression) {
+            headers.put("Content-Encoding", "gzip");
+        }
+
         URL url = new URL(urlString);
         HttpURLConnectionBuilder connectionBuilder = new HttpURLConnectionBuilder()
             .setUrl(url)

core/src/core-plugins.ts

@@ -1,3 +1,5 @@
+import * as Pako from 'pako';
+
 import type { Plugin } from './definitions';
 import { registerPlugin } from './global';
 import { WebPlugin } from './web-plugin';
@@ -208,6 +210,11 @@ export interface HttpOptions {
    * special handling in the native layer
    */
   dataType?: 'file' | 'formData';
+  /**
+   * Use this option if you need a gzip compression of the data payload
+   * A compatible consumer interface must be ensured. The default is _false_.
+   */
+  gzipCompression?: boolean;
 }
 
 export interface HttpParams {
@@ -318,7 +325,15 @@ export const buildRequestInit = (
 
   // If body is already a string, then pass it through as-is.
   if (typeof options.data === 'string') {
-    output.body = options.data;
+    if (options?.gzipCompression && options.headers) {
+      options.headers['Content-Encoding'] = 'gzip';
+      output.headers = options.headers;
+
+      const gzippedData: Uint8Array = Pako.gzip(options.data);
+      output.body = gzippedData.buffer;
+    } else {
+      output.body = options.data;
+    }
   }
   // Build request initializers based off of content-type
   else if (type.includes('application/x-www-form-urlencoded')) {

ios/Capacitor/Capacitor.xcodeproj/project.pbxproj

@@ -16,6 +16,7 @@
 		501CBAA71FC0A723009B0D4D /* WebKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 501CBAA61FC0A723009B0D4D /* WebKit.framework */; };
 		50503EE91FC08595003606DC /* Capacitor.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 50503EDF1FC08594003606DC /* Capacitor.framework */; };
 		50503EEE1FC08595003606DC /* CapacitorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 50503EED1FC08595003606DC /* CapacitorTests.swift */; };
+		5405D8B329C0949F008F945E /* Data+Gzip.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5405D8B129C0949F008F945E /* Data+Gzip.swift */; };
 		6214934725509C3F006C36F9 /* CAPInstanceConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6214934625509C3F006C36F9 /* CAPInstanceConfiguration.swift */; };
 		621ECCB72542045900D3D615 /* CAPBridgedJSTypes.m in Sources */ = {isa = PBXBuildFile; fileRef = 621ECCB42542045900D3D615 /* CAPBridgedJSTypes.m */; };
 		621ECCB82542045900D3D615 /* CAPBridgedJSTypes.h in Headers */ = {isa = PBXBuildFile; fileRef = 621ECCB62542045900D3D615 /* CAPBridgedJSTypes.h */; settings = {ATTRIBUTES = (Private, ); }; };
@@ -160,6 +161,7 @@
 		50503EDF1FC08594003606DC /* Capacitor.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Capacitor.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		50503EE81FC08595003606DC /* CapacitorTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = CapacitorTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
 		50503EED1FC08595003606DC /* CapacitorTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CapacitorTests.swift; sourceTree = "<group>"; };
+		5405D8B129C0949F008F945E /* Data+Gzip.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Data+Gzip.swift"; sourceTree = "<group>"; };
 		6214934625509C3F006C36F9 /* CAPInstanceConfiguration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CAPInstanceConfiguration.swift; sourceTree = "<group>"; };
 		621ECCB42542045900D3D615 /* CAPBridgedJSTypes.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CAPBridgedJSTypes.m; sourceTree = "<group>"; };
 		621ECCB62542045900D3D615 /* CAPBridgedJSTypes.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CAPBridgedJSTypes.h; sourceTree = "<group>"; };
@@ -408,6 +410,7 @@
 		62959AEA2524DA7700A3D7F1 /* Plugins */ = {
 			isa = PBXGroup;
 			children = (
+			    5405D8B129C0949F008F945E /* Data+Gzip.swift */,
 				A327E6B428DB8B2900CA8B0A /* CapacitorHttp.swift */,
 				A327E6B528DB8B2900CA8B0A /* CapacitorUrlRequest.swift */,
 				A327E6B228DB8B2800CA8B0A /* HttpRequestHandler.swift */,
@@ -692,6 +695,7 @@
 				62959B362524DA7800A3D7F1 /* CAPBridgeViewController.swift in Sources */,
 				621ECCB72542045900D3D615 /* CAPBridgedJSTypes.m in Sources */,
 				62959B402524DA7800A3D7F1 /* TmpViewController.swift in Sources */,
+				5405D8B329C0949F008F945E /* Data+Gzip.swift in Sources */,
 				621ECCD6254205BD00D3D615 /* CAPBridgeProtocol.swift in Sources */,
 				62D43AF02581817500673C24 /* WKWebView+Capacitor.swift in Sources */,
 				62959B432524DA7800A3D7F1 /* Data+Capacitor.swift in Sources */,

ios/Capacitor/Capacitor/Plugins/CapacitorUrlRequest.swift

@@ -185,11 +185,24 @@ open class CapacitorUrlRequest: NSObject, URLSessionTaskDelegate {
         }
     }
 
-    public func setRequestBody(_ body: JSValue, _ dataType: String? = nil) throws {
+    private func getRequestDataAsGzip(_ body: JSValue) throws -> Data? {
+        // string to Data
+        let dataBody = try getRequestDataAsString(body)
+
+        // gzip compression
+        let compressedData: Data = try dataBody.gzipped()
+        return compressedData
+    }
+
+    public func setRequestBody(_ body: JSValue, _ gzipCompression: Bool, _ dataType: String? = nil) throws {
         let contentType = self.getRequestHeader("Content-Type") as? String
 
         if contentType != nil {
-            request.httpBody = try getRequestData(body, contentType!, dataType)
+            if gzipCompression {
+                request.httpBody = try getRequestDataAsGzip(body)
+            } else {
+                request.httpBody = try getRequestData(body, contentType!, dataType)
+            }
         }
     }