feat: compress large JSON requests (#980)

When you deploy or test a project, a potentially very large JSON payload is
sent to the API server. In large projects, the time to upload the payload can
be quite significant (depending on connection speed). This PR introduces gzip
compression to payloads sent to relevant endpoints, which should make the
payload easier to upload.

Additionally, those large payload were stringified fully in memory, causing
unnecessarily high memory usage. This PR changes the payload to be
stringified and streamed with json-stream-stringify instead, which should
decrease memory usage. This change only applies to requests that are now
also getting compressed.

Author: sorccu

package-lock.json

@@ -84,6 +84,7 @@
     "git-repo-info": "2.1.1",
     "glob": "10.3.1",
     "indent-string": "4.0.0",
+    "json-stream-stringify": "3.1.6",
     "json5": "2.2.3",
     "jwt-decode": "3.1.2",
     "log-symbols": "4.1.0",

packages/cli/package.json

@@ -1,5 +1,6 @@
 import type { AxiosInstance } from 'axios'
 import type { GitInformation } from '../services/util'
+import { compressJSONPayload } from './util'
 
 export interface Project {
   name: string
@@ -60,6 +61,7 @@ class Projects {
     return this.api.post<ProjectDeployResponse>(
       `/next-v2/projects/deploy?dryRun=${dryRun}&scheduleOnDeploy=${scheduleOnDeploy}`,
       resources,
+      { transformRequest: compressJSONPayload },
     )
   }
 }

packages/cli/src/rest/projects.ts

@@ -1,6 +1,7 @@
 import type { AxiosInstance } from 'axios'
 import { GitInformation } from '../services/util'
 import { RetryStrategy } from '../constructs'
+import { compressJSONPayload } from './util'
 
 type RunTestSessionRequest = {
   name: string,
@@ -38,7 +39,9 @@ class TestSessions {
   }
 
   run (payload: RunTestSessionRequest) {
-    return this.api.post('/next/test-sessions/run', payload)
+    return this.api.post('/next/test-sessions/run', payload, {
+      transformRequest: compressJSONPayload,
+    })
   }
 
   trigger (payload: TriggerTestSessionRequest) {

packages/cli/src/rest/test-sessions.ts

@@ -0,0 +1,14 @@
+import zlib from 'node:zlib'
+
+import { AxiosRequestHeaders } from 'axios'
+import { JsonStreamStringify } from 'json-stream-stringify'
+
+export function compressJSONPayload (data: any, headers: AxiosRequestHeaders) {
+  headers['Content-Type'] = 'application/json'
+  headers['Content-Encoding'] = 'gzip'
+
+  const zipper = zlib.createGzip()
+  const streamer = new JsonStreamStringify(data)
+
+  return streamer.pipe(zipper)
+}