fix(deployments): external build token generation issue (#3070)

Fixes an issue introduced in #3024.

The behavior for local builds in older CLI versions relies on
`externalBuildData` to be defined to distinguish from the self-hosting
local build path, even though it doesn't actually use the token.

Author: myftija

.changeset/tricky-suits-design.md

@@ -0,0 +1,7 @@
+---
+"@trigger.dev/sdk": patch
+"trigger.dev": patch
+"@trigger.dev/core": patch
+---
+
+Fixed a minor issue in the deployment command on distinguishing between local builds for the cloud vs local builds for self-hosting setups.

apps/webapp/app/v3/services/deployment.server.ts

@@ -110,9 +110,9 @@ export class DeploymentService extends BaseService {
       const createRemoteBuildIfNeeded = deployment.buildServerMetadata?.isNativeBuild
         ? okAsync(undefined)
         : fromPromise(createRemoteImageBuild(authenticatedEnv.project), (error) => ({
-          type: "failed_to_create_remote_build" as const,
-          cause: error,
-        }));
+            type: "failed_to_create_remote_build" as const,
+            cause: error,
+          }));
 
       const existingBuildServerMetadata = deployment.buildServerMetadata as
         | BuildServerMetadata
@@ -134,7 +134,7 @@ export class DeploymentService extends BaseService {
                       },
                     }
                   : {}),
-                externalBuildData,
+                ...(externalBuildData ? { externalBuildData } : {}),
                 status: "BUILDING",
                 installedAt: new Date(),
               },
@@ -496,14 +496,16 @@ export class DeploymentService extends BaseService {
         type: "other" as const,
         cause: error,
       })
-    ).andThen((deployment) => {
-      if (!deployment) {
-        return errAsync({ type: "deployment_not_found" as const });
-      }
-      return okAsync(deployment);
-    }).map((deployment) => ({
-      ...deployment,
-      buildServerMetadata: BuildServerMetadata.safeParse(deployment.buildServerMetadata).data,
-    }));
+    )
+      .andThen((deployment) => {
+        if (!deployment) {
+          return errAsync({ type: "deployment_not_found" as const });
+        }
+        return okAsync(deployment);
+      })
+      .map((deployment) => ({
+        ...deployment,
+        buildServerMetadata: BuildServerMetadata.safeParse(deployment.buildServerMetadata).data,
+      }));
   }
 }

apps/webapp/app/v3/services/initializeDeployment.server.ts

@@ -1,4 +1,8 @@
-import { BuildServerMetadata, type InitializeDeploymentRequestBody } from "@trigger.dev/core/v3";
+import {
+  BuildServerMetadata,
+  type InitializeDeploymentRequestBody,
+  type ExternalBuildData,
+} from "@trigger.dev/core/v3";
 import { customAlphabet } from "nanoid";
 import { env } from "~/env.server";
 import { type AuthenticatedEnvironment } from "~/services/apiAuth.server";
@@ -89,12 +93,18 @@ export class InitializeDeploymentService extends BaseService {
         );
       }
 
-      // For the `PENDING` initial status, defer the creation of the Depot build until the deployment is started.
-      // This helps avoid Depot token expiration issues.
-      const externalBuildData =
-        payload.initialStatus === "PENDING" || payload.isNativeBuild
-          ? undefined
-          : await createRemoteImageBuild(environment.project);
+      // For the `PENDING` initial status, defer the creation of the Depot build until the deployment is started to avoid token expiration issues.
+      // For local and native builds we don't need to generate the Depot tokens. We still need to create an empty object sadly due to a bug in older CLI versions.
+      const generateExternalBuildToken =
+        payload.initialStatus === "PENDING" || payload.isNativeBuild || payload.isLocalBuild;
+
+      const externalBuildData = generateExternalBuildToken
+        ? ({
+            projectId: "-",
+            buildToken: "-",
+            buildId: "-",
+          } satisfies ExternalBuildData)
+        : await createRemoteImageBuild(environment.project);
 
       const triggeredBy = payload.userId
         ? await this._prisma.user.findFirst({

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

@@ -197,11 +197,18 @@ export function configureDeployCommand(program: Command) {
       )
       // Local build options
       .addOption(
-        new CommandOption("--force-local-build", "Deprecated alias for --local-build").implies({
-          localBuild: true,
-        })
+        new CommandOption("--force-local-build", "Deprecated alias for --local-build")
+          .implies({
+            localBuild: true,
+          })
+          .conflicts("nativeBuildServer")
+          .hideHelp()
+      )
+      .addOption(
+        new CommandOption("--local-build", "Build the deployment image locally").conflicts(
+          "nativeBuildServer"
+        )
       )
-      .addOption(new CommandOption("--local-build", "Build the deployment image locally"))
       .addOption(new CommandOption("--push", "Push the image after local builds").hideHelp())
       .addOption(
         new CommandOption("--no-push", "Do not push the image after local builds").hideHelp()
@@ -420,14 +427,19 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
       gitMeta,
       type: features.run_engine_v2 ? "MANAGED" : "V1",
       runtime: buildManifest.runtime,
+      isLocalBuild: options.localBuild,
       isNativeBuild: false,
       triggeredVia: getTriggeredVia(),
     },
     envVars.TRIGGER_EXISTING_DEPLOYMENT_ID
   );
+
+  // When `externalBuildData` is not present the deployment implicitly goes into the local build path
+  // which is used in self-hosted setups. There are a few subtle differences between local builds for the cloud
+  // and local builds for self-hosted setups. We need to make the separation of the two paths clearer to avoid confusion.
   const isLocalBuild = options.localBuild || !deployment.externalBuildData;
-  // Would be best to actually store this separately in the deployment object. This is an okay proxy for now.
-  const remoteBuildExplicitlySkipped = options.localBuild && !!deployment.externalBuildData;
+  const authenticateToTriggerRegistry = options.localBuild;
+  const skipServerSideRegistryPush = options.localBuild;
 
   // Fail fast if we know local builds will fail
   if (isLocalBuild) {
@@ -559,7 +571,7 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
     network: options.network,
     builder: options.builder,
     push: options.push,
-    authenticateToRegistry: remoteBuildExplicitlySkipped,
+    authenticateToRegistry: authenticateToTriggerRegistry,
   });
 
   logger.debug("Build result", buildResult);
@@ -657,7 +669,7 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
     {
       imageDigest: buildResult.digest,
       skipPromotion: options.skipPromotion,
-      skipPushToRegistry: remoteBuildExplicitlySkipped,
+      skipPushToRegistry: skipServerSideRegistryPush,
     },
     (logMessage) => {
       if (options.plain || isCI) {

packages/core/src/v3/schemas/api.ts

@@ -601,8 +601,9 @@ const InitializeDeploymentRequestBodyBase = z.object({
   type: z.enum(["MANAGED", "UNMANAGED", "V1"]).optional(),
   runtime: z.string().optional(),
   initialStatus: z.enum(["PENDING", "BUILDING"]).optional(),
+  isLocalBuild: z.boolean().optional(),
   triggeredVia: DeploymentTriggeredVia.optional(),
-  buildId: z.string().optional()
+  buildId: z.string().optional(),
 });
 type BaseOutput = z.output<typeof InitializeDeploymentRequestBodyBase>;