feat: add gzip compression support for HTTP requests in ClickHouse adapter

Author: lohanidamodar

src/Usage/Adapter/ClickHouse.php

@@ -69,6 +69,9 @@ class ClickHouse extends SQL
     /** @var array<array{sql: string, params: array<string, mixed>, duration: float, timestamp: float, success: bool, error?: string}> Query execution log */
     private array $queryLog = [];
 
+    /** @var bool Whether to enable gzip compression for HTTP requests/responses */
+    private bool $enableCompression = false;
+
     /**
      * @param  string  $host  ClickHouse host
      * @param  string  $username  ClickHouse username (default: 'default')
@@ -139,6 +142,19 @@ public function enableQueryLogging(bool $enable = true): self
         return $this;
     }
 
+    /**
+     * Enable or disable gzip compression for HTTP requests/responses.
+     * When enabled, responses from ClickHouse will be gzip-compressed, reducing bandwidth usage.
+     *
+     * @param bool $enable Whether to enable compression
+     * @return self
+     */
+    public function setCompression(bool $enable): self
+    {
+        $this->enableCompression = $enable;
+        return $this;
+    }
+
     /**
      * Get the query execution log.
      *
@@ -490,6 +506,11 @@ private function query(string $sql, array $params = []): string
         // Update the database header for each query (in case setDatabase was called)
         $this->client->addHeader('X-ClickHouse-Database', $this->database);
 
+        // Enable compression if configured
+        if ($this->enableCompression) {
+            $this->client->addHeader('Accept-Encoding', 'gzip');
+        }
+
         // Build multipart form data body with query and parameters
         // The Fetch client will automatically encode arrays as multipart/form-data
         $body = ['query' => $sql];
@@ -554,6 +575,11 @@ private function insert(string $table, array $data): void
         $this->client->addHeader('X-ClickHouse-Database', $this->database);
         $this->client->addHeader('Content-Type', 'application/x-ndjson');
 
+        // Enable compression if configured
+        if ($this->enableCompression) {
+            $this->client->addHeader('Accept-Encoding', 'gzip');
+        }
+
         // Join JSON strings with newlines
         $body = implode("\n", $data);
 

tests/Usage/Adapter/ClickHouseTest.php

@@ -539,4 +539,59 @@ public function testSetTimeoutAboveMaximum(): void
         $adapter = new ClickHouseAdapter($host, $username, $password, $port);
         $adapter->setTimeout(600001); // Above maximum
     }
+
+    /**
+     * Test compression functionality
+     */
+    public function testCompression(): void
+    {
+        // Create a new adapter instance with compression enabled
+        $host = getenv('CLICKHOUSE_HOST') ?: 'clickhouse';
+        $username = getenv('CLICKHOUSE_USER') ?: 'default';
+        $password = getenv('CLICKHOUSE_PASSWORD') ?: 'clickhouse';
+        $port = (int) (getenv('CLICKHOUSE_PORT') ?: 8123);
+        $secure = (bool) (getenv('CLICKHOUSE_SECURE') ?: false);
+
+        $adapter = new ClickHouseAdapter($host, $username, $password, $port, $secure);
+        $adapter->setNamespace('utopia_usage_compression_test');
+        $adapter->setTenant(1);
+
+        if ($database = getenv('CLICKHOUSE_DATABASE')) {
+            $adapter->setDatabase($database);
+        }
+
+        $usage = new Usage($adapter);
+        $usage->setup();
+
+        // Test enabling compression
+        $result = $adapter->setCompression(true);
+        $this->assertInstanceOf(ClickHouseAdapter::class, $result);
+
+        // Test disabling compression
+        $result = $adapter->setCompression(false);
+        $this->assertInstanceOf(ClickHouseAdapter::class, $result);
+
+        // Enable compression for all subsequent operations
+        $adapter->setCompression(true);
+
+        // Insert data using logBatch with compression enabled
+        $batchResult = $usage->logBatch([
+            ['metric' => 'compression.test.batch', 'value' => 50, 'period' => '1h', 'tags' => ['type' => 'batch']],
+            ['metric' => 'compression.test.batch', 'value' => 75, 'period' => '1h', 'tags' => ['type' => 'batch']],
+            ['metric' => 'compression.test.single', 'value' => 100, 'period' => '1h', 'tags' => ['type' => 'single']],
+        ]);
+        $this->assertTrue($batchResult);
+
+        // Verify find query works with compression (returns array)
+        $metrics = $usage->find([]);
+        $this->assertIsArray($metrics);
+
+        // Verify count query works with compression (returns int)
+        $count = $usage->count([]);
+        $this->assertIsInt($count);
+
+        // Verify sum operation works with compression (returns int)
+        $sum = $usage->sumByPeriod('compression.test.batch', '1h');
+        $this->assertIsInt($sum);
+    }
 }