feat(cli): use zstd for deployment images and cache

Author: nicktrn

packages/cli-v3/src/commands/deploy.ts

@@ -83,6 +83,9 @@ const DeployCommandOptions = CommonCommandOptions.extend({
   nativeBuildServer: z.boolean().default(false),
   detach: z.boolean().default(false),
   plain: z.boolean().default(false),
+  useZstd: z.boolean().default(true),
+  useZstdCache: z.boolean().default(true),
+  compressionLevel: z.number().optional(),
 });
 
 type DeployCommandOptions = z.infer<typeof DeployCommandOptions>;
@@ -157,6 +160,24 @@ export function configureDeployCommand(program: Command) {
           "If provided, will save logs even for successful builds"
         ).hideHelp()
       )
+      .addOption(
+        new CommandOption(
+          "--use-zstd",
+          "Use zstd compression when building the image. This will reduce image size and speed up pull times."
+        ).hideHelp()
+      )
+      .addOption(
+        new CommandOption(
+          "--use-zstd-cache",
+          "Use zstd compression for the build cache. This will reduce cache size and speed up build times."
+        ).hideHelp()
+      )
+      .addOption(
+        new CommandOption(
+          "--compression-level <level>",
+          "The compression level to use when building the image. The default is 3."
+        ).hideHelp()
+      )
       // Local build options
       .addOption(
         new CommandOption("--force-local-build", "Deprecated alias for --local-build").implies({
@@ -499,6 +520,9 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
     authAccessToken: authorization.auth.accessToken,
     compilationPath: destination.path,
     buildEnvVars: buildManifest.build.env,
+    useZstd: options.useZstd,
+    useZstdCache: options.useZstdCache,
+    compressionLevel: options.compressionLevel,
     onLog: (logMessage) => {
       if (options.plain || isCI) {
         console.log(logMessage);

packages/cli-v3/src/deploy/buildImage.ts

@@ -20,6 +20,9 @@ export interface BuildImageOptions {
   imagePlatform: string;
   noCache?: boolean;
   load?: boolean;
+  useZstd?: boolean;
+  useZstdCache?: boolean;
+  compressionLevel?: number;
 
   // Local build options
   push?: boolean;
@@ -79,6 +82,9 @@ export async function buildImage(options: BuildImageOptions): Promise<BuildImage
     buildEnvVars,
     network,
     builder,
+    useZstd,
+    useZstdCache,
+    compressionLevel,
     onLog,
   } = options;
 
@@ -105,6 +111,9 @@ export async function buildImage(options: BuildImageOptions): Promise<BuildImage
       buildEnvVars,
       network,
       builder,
+      useZstd,
+      useZstdCache,
+      compressionLevel,
       onLog,
     });
   }
@@ -134,6 +143,8 @@ export async function buildImage(options: BuildImageOptions): Promise<BuildImage
     apiKey,
     branchName,
     buildEnvVars,
+    useZstd,
+    compressionLevel,
     onLog,
   });
 }
@@ -157,6 +168,8 @@ export interface DepotBuildImageOptions {
   noCache?: boolean;
   extraCACerts?: string;
   buildEnvVars?: Record<string, string | undefined>;
+  useZstd?: boolean;
+  compressionLevel?: number;
   onLog?: (log: string) => void;
 }
 
@@ -185,6 +198,12 @@ async function remoteBuildImage(options: DepotBuildImageOptions): Promise<BuildI
     "-f",
     "Containerfile",
     options.noCache ? "--no-cache" : undefined,
+    options.useZstd
+      ? [
+          "--output",
+          `compression=zstd${options.compressionLevel ? `,level=${options.compressionLevel}` : ""}`,
+        ]
+      : undefined,
     "--platform",
     options.imagePlatform,
     options.load ? "--load" : undefined,
@@ -316,11 +335,23 @@ interface SelfHostedBuildImageOptions {
   network?: string;
   builder: string;
   load?: boolean;
+  useZstd?: boolean;
+  useZstdCache?: boolean;
+  compressionLevel?: number;
   onLog?: (log: string) => void;
 }
 
 async function localBuildImage(options: SelfHostedBuildImageOptions): Promise<BuildImageResults> {
-  const { builder, imageTag, deploymentId, apiClient, useRegistryCache } = options;
+  const {
+    builder,
+    imageTag,
+    deploymentId,
+    apiClient,
+    useRegistryCache,
+    useZstd,
+    useZstdCache,
+    compressionLevel,
+  } = options;
 
   // Ensure multi-platform build is supported on the local machine
   let builderExists = false;
@@ -500,11 +531,16 @@ async function localBuildImage(options: SelfHostedBuildImageOptions): Promise<Bu
     ...(useRegistryCache
       ? [
           "--cache-to",
-          `type=registry,mode=max,image-manifest=true,oci-mediatypes=true,ref=${projectCacheRef}`,
+          `type=registry,mode=max,image-manifest=true,oci-mediatypes=true,ref=${projectCacheRef}${
+            useZstdCache ? ",compression=zstd" : ""
+          }`,
           "--cache-from",
           `type=registry,ref=${projectCacheRef}`,
         ]
       : []),
+    ...(useZstd
+      ? ["--output", `compression=zstd${compressionLevel ? `,level=${compressionLevel}` : ""}`]
+      : []),
     "--platform",
     options.imagePlatform,
     options.network ? `--network=${options.network}` : undefined,