feat(clients): response decompression (#6095)

eric-zaharia · web-flow · commit a196c9cf7341 · 2026-03-12T15:35:59.000+01:00
diff --git a/clients/algoliasearch-client-javascript/packages/requester-node-http/src/createHttpRequester.ts b/clients/algoliasearch-client-javascript/packages/requester-node-http/src/createHttpRequester.ts
@@ -1,6 +1,7 @@
 import http from 'http';
 import https from 'https';
 import { URL } from 'url';
+import zlib from 'zlib';
 
 import type { EndRequest, Requester, Response } from '@algolia/client-common';
 
@@ -41,6 +42,7 @@ export function createHttpRequester({
         method: request.method,
         ...requesterOptions,
         headers: {
+          'accept-encoding': 'gzip',
           ...request.headers,
           ...requesterOptions.headers,
         },
@@ -61,9 +63,14 @@ export function createHttpRequester({
           clearTimeout(connectTimeout as NodeJS.Timeout);
           clearTimeout(responseTimeout as NodeJS.Timeout);
 
+          let buffer = Buffer.concat(contentBuffers);
+          if (response.headers['content-encoding'] === 'gzip') {
+            buffer = zlib.gunzipSync(buffer);
+          }
+
           resolve({
             status: response.statusCode || 0,
-            content: Buffer.concat(contentBuffers).toString(),
+            content: buffer.toString(),
             isTimedOut: false,
           });
         });
diff --git a/clients/algoliasearch-client-ruby/lib/algolia/transport/transport.rb b/clients/algoliasearch-client-ruby/lib/algolia/transport/transport.rb
@@ -136,7 +136,6 @@ def build_body(body, request_options)
       def generate_header_params(body, request_options)
         header_params = request_options.header_params.transform_keys(&:downcase)
         header_params = @config.header_params.merge(header_params)
-        header_params["accept-encoding"] = "gzip" if request_options.compression_type == "gzip"
         if request_options.compression_type == "gzip" && body.is_a?(String) && !body.to_s.strip.empty?
           header_params["content-encoding"] = "gzip"
         end
diff --git a/scripts/cts/testServer/gzipResponse.ts b/scripts/cts/testServer/gzipResponse.ts
@@ -0,0 +1,40 @@
+import type { Server } from 'http';
+
+import zlib from 'node:zlib';
+
+import type { Express } from 'express';
+
+import { setupServer } from './index.ts';
+
+const RESPONSE_BODY = {
+  message: 'ok decompression test server response',
+  data: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+};
+
+function addRoutes(app: Express): void {
+  app.get('/1/test/gzip-response', (req, res) => {
+    const acceptEncoding = req.headers['accept-encoding'] || '';
+    if (!acceptEncoding.includes('gzip')) {
+      res.status(400).json({ message: 'client did not send accept-encoding: gzip' });
+      return;
+    }
+
+    const body = JSON.stringify(RESPONSE_BODY);
+    zlib.gzip(Buffer.from(body, 'utf-8'), (err, compressed) => {
+      if (err) {
+        res.status(500).json({ message: `error compressing response: ${err}` });
+        return;
+      }
+
+      res.writeHead(200, {
+        'Content-Type': 'application/json',
+        'Content-Encoding': 'gzip',
+      });
+      res.end(compressed);
+    });
+  });
+}
+
+export function gzipResponseServer(): Promise<Server> {
+  return setupServer('gzipResponse', 6691, addRoutes);
+}
diff --git a/scripts/cts/testServer/index.ts b/scripts/cts/testServer/index.ts
@@ -14,6 +14,7 @@ import { benchmarkServer } from './benchmark.ts';
 import { chunkWrapperServer } from './chunkWrapper.ts';
 import { errorServer, errorServerRetriedOnce, errorServerRetriedTwice, neverCalledServer } from './error.ts';
 import { gzipServer } from './gzip.ts';
+import { gzipResponseServer } from './gzipResponse.ts';
 import { pushMockServer, pushMockServerRetriedOnce } from './pushMock.ts';
 import { replaceAllObjectsServer } from './replaceAllObjects.ts';
 import { replaceAllObjectsServerFailed } from './replaceAllObjectsFailed.ts';
@@ -35,6 +36,7 @@ export async function startTestServer(suites: Record<CTSType, boolean>): Promise
       neverCalledServer(),
       successServer(),
       gzipServer(),
+      gzipResponseServer(),
       timeoutServerBis(),
       accountCopyIndexServer(),
       replaceAllObjectsServer(),
diff --git a/tests/CTS/client/composition/api.json b/tests/CTS/client/composition/api.json
@@ -85,5 +85,37 @@
         }
       }
     ]
+  },
+  {
+    "testName": "test the response decompression strategy",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "test-app-id",
+          "apiKey": "test-api-key",
+          "customHosts": [
+            {
+              "port": 6691
+            }
+          ]
+        }
+      },
+      {
+        "type": "method",
+        "method": "customGet",
+        "parameters": {
+          "path": "1/test/gzip-response"
+        },
+        "expected": {
+          "type": "response",
+          "match": {
+            "message": "ok decompression test server response",
+            "data": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
+          }
+        }
+      }
+    ]
   }
 ]
diff --git a/tests/CTS/client/search/api.json b/tests/CTS/client/search/api.json
@@ -224,6 +224,38 @@
       }
     ]
   },
+  {
+    "testName": "test the response decompression strategy",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "test-app-id",
+          "apiKey": "test-api-key",
+          "customHosts": [
+            {
+              "port": 6691
+            }
+          ]
+        }
+      },
+      {
+        "type": "method",
+        "method": "customGet",
+        "parameters": {
+          "path": "1/test/gzip-response"
+        },
+        "expected": {
+          "type": "response",
+          "match": {
+            "message": "ok decompression test server response",
+            "data": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
+          }
+        }
+      }
+    ]
+  },
   {
     "testName": "calls api with default read timeouts",
     "steps": [
