chore: misc fixes and refactor

Author: nicktrn

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

@@ -71,7 +71,7 @@ const DeployCommandOptions = CommonCommandOptions.extend({
   saveLogs: z.boolean().default(false),
   skipUpdateCheck: z.boolean().default(false),
   skipPromotion: z.boolean().default(false),
-  noCache: z.boolean().default(false),
+  cache: z.boolean().default(true),
   envFile: z.string().optional(),
   // Local build options
   forceLocalBuild: z.boolean().optional(),
@@ -83,9 +83,10 @@ 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),
+  compression: z.enum(["zstd", "gzip"]).default("zstd"),
+  cacheCompression: z.enum(["zstd", "gzip"]).default("zstd"),
   compressionLevel: z.number().optional(),
+  forceCompression: z.boolean().default(true),
 });
 
 type DeployCommandOptions = z.infer<typeof DeployCommandOptions>;
@@ -162,20 +163,36 @@ export function configureDeployCommand(program: Command) {
       )
       .addOption(
         new CommandOption(
-          "--use-zstd",
-          "Use zstd compression when building the image. This will reduce image size and speed up pull times."
+          "--compression <algorithm>",
+          "Compression algorithm for image layers: zstd or gzip (default: zstd)"
+        )
+          .choices(["zstd", "gzip"])
+          .hideHelp()
+      )
+      .addOption(
+        new CommandOption(
+          "--cache-compression <algorithm>",
+          "Compression algorithm for build cache: zstd or gzip (default: zstd)"
+        )
+          .choices(["zstd", "gzip"])
+          .hideHelp()
+      )
+      .addOption(
+        new CommandOption(
+          "--compression-level <level>",
+          "The compression level to use when building the image."
         ).hideHelp()
       )
       .addOption(
         new CommandOption(
-          "--use-zstd-cache",
-          "Use zstd compression for the build cache. This will reduce cache size and speed up build times."
+          "--force-compression",
+          "Force recompression of all layers. Enabled by default when using zstd."
         ).hideHelp()
       )
       .addOption(
         new CommandOption(
-          "--compression-level <level>",
-          "The compression level to use when building the image. The default is 3."
+          "--no-force-compression",
+          "Disable forced recompression of layers."
         ).hideHelp()
       )
       // Local build options
@@ -501,7 +518,7 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
   const buildResult = await buildImage({
     isLocalBuild,
     useRegistryCache: options.useRegistryCache,
-    noCache: options.noCache,
+    noCache: !options.cache,
     deploymentId: deployment.id,
     deploymentVersion: deployment.version,
     imageTag: deployment.imageTag,
@@ -520,9 +537,10 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
     authAccessToken: authorization.auth.accessToken,
     compilationPath: destination.path,
     buildEnvVars: buildManifest.build.env,
-    useZstd: options.useZstd,
-    useZstdCache: options.useZstdCache,
+    compression: options.compression,
+    cacheCompression: options.cacheCompression,
     compressionLevel: options.compressionLevel,
+    forceCompression: options.forceCompression,
     onLog: (logMessage) => {
       if (options.plain || isCI) {
         console.log(logMessage);

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

@@ -20,9 +20,10 @@ export interface BuildImageOptions {
   imagePlatform: string;
   noCache?: boolean;
   load?: boolean;
-  useZstd?: boolean;
-  useZstdCache?: boolean;
+  compression?: "zstd" | "gzip";
+  cacheCompression?: "zstd" | "gzip";
   compressionLevel?: number;
+  forceCompression?: boolean;
 
   // Local build options
   push?: boolean;
@@ -82,9 +83,10 @@ export async function buildImage(options: BuildImageOptions): Promise<BuildImage
     buildEnvVars,
     network,
     builder,
-    useZstd,
-    useZstdCache,
+    compression,
+    cacheCompression,
     compressionLevel,
+    forceCompression,
     onLog,
   } = options;
 
@@ -111,9 +113,10 @@ export async function buildImage(options: BuildImageOptions): Promise<BuildImage
       buildEnvVars,
       network,
       builder,
-      useZstd,
-      useZstdCache,
+      compression,
+      cacheCompression,
       compressionLevel,
+      forceCompression,
       onLog,
     });
   }
@@ -143,8 +146,9 @@ export async function buildImage(options: BuildImageOptions): Promise<BuildImage
     apiKey,
     branchName,
     buildEnvVars,
-    useZstd,
+    compression,
     compressionLevel,
+    forceCompression,
     onLog,
   });
 }
@@ -168,8 +172,9 @@ export interface DepotBuildImageOptions {
   noCache?: boolean;
   extraCACerts?: string;
   buildEnvVars?: Record<string, string | undefined>;
-  useZstd?: boolean;
+  compression?: "zstd" | "gzip";
   compressionLevel?: number;
+  forceCompression?: boolean;
   onLog?: (log: string) => void;
 }
 
@@ -193,17 +198,19 @@ async function remoteBuildImage(options: DepotBuildImageOptions): Promise<BuildI
     .filter(([key, value]) => value)
     .flatMap(([key, value]) => ["--build-arg", `${key}=${value}`]);
 
+  const outputOptions = getOutputOptions({
+    imageTag: undefined, // This is already handled via the --save flag
+    push: true, // We always push the image to the registry
+    compression: options.compression,
+    compressionLevel: options.compressionLevel,
+    forceCompression: options.forceCompression,
+  });
+
   const args = [
     "build",
     "-f",
     "Containerfile",
     options.noCache ? "--no-cache" : undefined,
-    ...(options.useZstd
-      ? [
-          "--output",
-          `compression=zstd${options.compressionLevel ? `,level=${options.compressionLevel}` : ""}`,
-        ]
-      : []),
     "--platform",
     options.imagePlatform,
     options.load ? "--load" : undefined,
@@ -233,6 +240,8 @@ async function remoteBuildImage(options: DepotBuildImageOptions): Promise<BuildI
     "plain",
     ".",
     "--save",
+    "--output",
+    outputOptions.join(","),
   ].filter(Boolean) as string[];
 
   logger.debug(`depot ${args.join(" ")}`, { cwd: options.cwd });
@@ -335,9 +344,10 @@ interface SelfHostedBuildImageOptions {
   network?: string;
   builder: string;
   load?: boolean;
-  useZstd?: boolean;
-  useZstdCache?: boolean;
+  compression?: "zstd" | "gzip";
+  cacheCompression?: "zstd" | "gzip";
   compressionLevel?: number;
+  forceCompression?: boolean;
   onLog?: (log: string) => void;
 }
 
@@ -348,9 +358,10 @@ async function localBuildImage(options: SelfHostedBuildImageOptions): Promise<Bu
     deploymentId,
     apiClient,
     useRegistryCache,
-    useZstd,
-    useZstdCache,
+    compression,
+    cacheCompression,
     compressionLevel,
+    forceCompression,
   } = options;
 
   // Ensure multi-platform build is supported on the local machine
@@ -520,6 +531,14 @@ async function localBuildImage(options: SelfHostedBuildImageOptions): Promise<Bu
 
   const projectCacheRef = getProjectCacheRefFromImageTag(imageTag);
 
+  const outputOptions = getOutputOptions({
+    imageTag,
+    push,
+    compression,
+    compressionLevel,
+    forceCompression,
+  });
+
   const args = [
     "buildx",
     "build",
@@ -532,20 +551,18 @@ async function localBuildImage(options: SelfHostedBuildImageOptions): Promise<Bu
       ? [
           "--cache-to",
           `type=registry,mode=max,image-manifest=true,oci-mediatypes=true,ref=${projectCacheRef}${
-            useZstdCache ? ",compression=zstd" : ""
+            cacheCompression === "zstd" ? ",compression=zstd" : ""
           }`,
           "--cache-from",
           `type=registry,ref=${projectCacheRef}`,
         ]
       : []),
-    ...(useZstd
-      ? ["--output", `compression=zstd${compressionLevel ? `,level=${compressionLevel}` : ""}`]
-      : []),
+    "--output",
+    outputOptions.join(","),
     "--platform",
     options.imagePlatform,
     options.network ? `--network=${options.network}` : undefined,
     addHost ? `--add-host=${addHost}` : undefined,
-    push ? "--push" : undefined,
     load ? "--load" : undefined,
     "--provenance",
     "false",
@@ -1108,3 +1125,43 @@ function shouldLoad(load?: boolean, push?: boolean) {
     }
   }
 }
+
+function getOutputOptions({
+  imageTag,
+  push,
+  compression,
+  compressionLevel,
+  forceCompression,
+}: {
+  imageTag?: string;
+  push?: boolean;
+  compression?: "zstd" | "gzip";
+  compressionLevel?: number;
+  forceCompression?: boolean;
+}): string[] {
+  // Always use OCI media types for compatibility
+  const outputOptions: string[] = ["type=image", "oci-mediatypes=true"];
+
+  if (imageTag) {
+    outputOptions.push(`name=${imageTag}`);
+  }
+
+  if (push) {
+    outputOptions.push("push=true");
+  }
+
+  // Only add compression args when using zstd (gzip is the default, no args needed)
+  if (compression === "zstd") {
+    outputOptions.push("compression=zstd");
+
+    if (compressionLevel !== undefined) {
+      outputOptions.push(`compression-level=${compressionLevel}`);
+    }
+  }
+
+  if (forceCompression) {
+    outputOptions.push("force-compression=true");
+  }
+
+  return outputOptions;
+}