finalize deployment now SSE and won't timeout

Author: ericallam

apps/webapp/app/routes/api.v3.deployments.$deploymentId.finalize.ts

@@ -58,9 +58,15 @@ export async function action({ request, params }: ActionFunctionArgs) {
       },
     });
 
+    const pingInterval = setInterval(() => {
+      writer.write("event: ping\ndata: {}\n\n");
+    }, 10000); // 10 seconds
+
     service
       .call(authenticatedEnv, deploymentId, body.data, writer)
       .then(async () => {
+        clearInterval(pingInterval);
+
         await writer.write(`event: complete\ndata: ${JSON.stringify({ id: deploymentId })}\n\n`);
         await writer.close();
       })
@@ -77,6 +83,8 @@ export async function action({ request, params }: ActionFunctionArgs) {
           errorMessage = { error: "Internal server error" };
         }
 
+        clearInterval(pingInterval);
+
         await writer.write(`event: error\ndata: ${JSON.stringify(errorMessage)}\n\n`);
         await writer.close();
       });

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

@@ -43,6 +43,12 @@ export class FinalizeDeploymentService extends BaseService {
       throw new ServiceValidationError("Worker deployment does not have a worker");
     }
 
+    if (deployment.status === "DEPLOYED") {
+      logger.debug("Worker deployment is already deployed", { id });
+
+      return deployment;
+    }
+
     if (deployment.status !== "DEPLOYING") {
       logger.error("Worker deployment is not in DEPLOYING status", { id });
       throw new ServiceValidationError("Worker deployment is not in DEPLOYING status");

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

@@ -84,24 +84,27 @@ export class FinalizeDeploymentV2Service extends BaseService {
       throw new ServiceValidationError("Missing depot token");
     }
 
-    const pushResult = await executePushToRegistry({
-      depot: {
-        buildId: externalBuildData.data.buildId,
-        orgToken: env.DEPOT_TOKEN,
-        projectId: externalBuildData.data.projectId,
-      },
-      registry: {
-        host: env.DEPLOY_REGISTRY_HOST,
-        namespace: env.DEPLOY_REGISTRY_NAMESPACE,
-        username: env.DEPLOY_REGISTRY_USERNAME,
-        password: env.DEPLOY_REGISTRY_PASSWORD,
-      },
-      deployment: {
-        version: deployment.version,
-        environmentSlug: deployment.environment.slug,
-        projectExternalRef: deployment.worker.project.externalRef,
+    const pushResult = await executePushToRegistry(
+      {
+        depot: {
+          buildId: externalBuildData.data.buildId,
+          orgToken: env.DEPOT_TOKEN,
+          projectId: externalBuildData.data.projectId,
+        },
+        registry: {
+          host: env.DEPLOY_REGISTRY_HOST,
+          namespace: env.DEPLOY_REGISTRY_NAMESPACE,
+          username: env.DEPLOY_REGISTRY_USERNAME,
+          password: env.DEPLOY_REGISTRY_PASSWORD,
+        },
+        deployment: {
+          version: deployment.version,
+          environmentSlug: deployment.environment.slug,
+          projectExternalRef: deployment.worker.project.externalRef,
+        },
       },
-    });
+      writer
+    );
 
     if (!pushResult.ok) {
       throw new ServiceValidationError(pushResult.error);

packages/cli-v3/src/apiClient.ts

@@ -21,7 +21,7 @@ import {
   FailDeploymentResponseBody,
   FinalizeDeploymentRequestBody,
 } from "@trigger.dev/core/v3";
-import { zodfetch, ApiError } from "@trigger.dev/core/v3/zodfetch";
+import { zodfetch, ApiError, zodfetchSSE } from "@trigger.dev/core/v3/zodfetch";
 
 export class CliApiClient {
   constructor(
@@ -247,23 +247,65 @@ export class CliApiClient {
     );
   }
 
-  async finalizeDeployment(id: string, body: FinalizeDeploymentRequestBody) {
+  async finalizeDeployment(
+    id: string,
+    body: FinalizeDeploymentRequestBody,
+    onLog?: (message: string) => void
+  ): Promise<ApiResult<FailDeploymentResponseBody>> {
     if (!this.accessToken) {
       throw new Error("finalizeDeployment: No access token");
     }
 
-    return wrapZodFetch(
-      FailDeploymentResponseBody,
-      `${this.apiURL}/api/v2/deployments/${id}/finalize`,
-      {
+    let resolvePromise: (value: ApiResult<FailDeploymentResponseBody>) => void;
+    let rejectPromise: (reason: any) => void;
+
+    const promise = new Promise<ApiResult<FailDeploymentResponseBody>>((resolve, reject) => {
+      resolvePromise = resolve;
+      rejectPromise = reject;
+    });
+
+    const source = zodfetchSSE({
+      url: `${this.apiURL}/api/v3/deployments/${id}/finalize`,
+      request: {
         method: "POST",
         headers: {
           Authorization: `Bearer ${this.accessToken}`,
           "Content-Type": "application/json",
         },
         body: JSON.stringify(body),
-      }
-    );
+      },
+      messages: {
+        error: z.object({ error: z.string() }),
+        log: z.object({ message: z.string() }),
+        complete: FailDeploymentResponseBody,
+      },
+    });
+
+    source.onMessage("complete", (message) => {
+      resolvePromise({
+        success: true,
+        data: message,
+      });
+    });
+
+    source.onMessage("error", ({ error }) => {
+      rejectPromise({
+        success: false,
+        error,
+      });
+    });
+
+    if (onLog) {
+      source.onMessage("log", ({ message }) => {
+        onLog(message);
+      });
+    }
+
+    const result = await promise;
+
+    source.stop();
+
+    return result;
   }
 
   async startDeploymentIndexing(deploymentId: string, body: StartDeploymentIndexingRequestBody) {

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

@@ -222,10 +222,10 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
     forcedExternals,
     listener: {
       onBundleStart() {
-        $buildSpinner.start("Building project");
+        $buildSpinner.start("Building trigger code");
       },
       onBundleComplete(result) {
-        $buildSpinner.stop("Successfully built project");
+        $buildSpinner.stop("Successfully built code");
 
         logger.debug("Bundle result", result);
       },
@@ -328,9 +328,9 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
   const $spinner = spinner();
 
   if (isLinksSupported) {
-    $spinner.start(`Deploying version ${version} ${deploymentLink}`);
+    $spinner.start(`Building version ${version} ${deploymentLink}`);
   } else {
-    $spinner.start(`Deploying version ${version}`);
+    $spinner.start(`Building version ${version}`);
   }
 
   const selfHostedRegistryHost = deployment.registryHost ?? options.registry;
@@ -359,6 +359,13 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
     compilationPath: destination.path,
     buildEnvVars: buildManifest.build.env,
     network: options.network,
+    onLog: (logMessage) => {
+      if (isLinksSupported) {
+        $spinner.message(`Building version ${version} ${deploymentLink}: ${logMessage}`);
+      } else {
+        $spinner.message(`Building version ${version}: ${logMessage}`);
+      }
+    },
   });
 
   logger.debug("Build result", buildResult);
@@ -426,10 +433,26 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
       }`
     : `${buildResult.image}${buildResult.digest ? `@${buildResult.digest}` : ""}`;
 
-  const finalizeResponse = await projectClient.client.finalizeDeployment(deployment.id, {
-    imageReference,
-    selfHosted: options.selfHosted,
-  });
+  if (isLinksSupported) {
+    $spinner.message(`Deploying version ${version} ${deploymentLink}`);
+  } else {
+    $spinner.message(`Deploying version ${version}`);
+  }
+
+  const finalizeResponse = await projectClient.client.finalizeDeployment(
+    deployment.id,
+    {
+      imageReference,
+      selfHosted: options.selfHosted,
+    },
+    (logMessage) => {
+      if (isLinksSupported) {
+        $spinner.message(`Deploying version ${version} ${deploymentLink}: ${logMessage}`);
+      } else {
+        $spinner.message(`Deploying version ${version}: ${logMessage}`);
+      }
+    }
+  );
 
   if (!finalizeResponse.success) {
     await failDeploy(

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

@@ -36,6 +36,7 @@ export interface BuildImageOptions {
   apiUrl: string;
   apiKey: string;
   buildEnvVars?: Record<string, string | undefined>;
+  onLog?: (log: string) => void;
 
   // Optional deployment spinner
   deploymentSpinner?: any; // Replace 'any' with the actual type if known
@@ -65,6 +66,7 @@ export async function buildImage(options: BuildImageOptions) {
     apiUrl,
     apiKey,
     buildEnvVars,
+    onLog,
   } = options;
 
   if (selfHosted) {
@@ -86,6 +88,7 @@ export async function buildImage(options: BuildImageOptions) {
       apiKey,
       buildEnvVars,
       network: options.network,
+      onLog,
     });
   }
 
@@ -115,6 +118,7 @@ export async function buildImage(options: BuildImageOptions) {
     apiUrl,
     apiKey,
     buildEnvVars,
+    onLog,
   });
 }
 
@@ -138,6 +142,7 @@ export interface DepotBuildImageOptions {
   noCache?: boolean;
   extraCACerts?: string;
   buildEnvVars?: Record<string, string | undefined>;
+  onLog?: (log: string) => void;
 }
 
 type BuildImageSuccess = {
@@ -225,6 +230,10 @@ async function depotBuildImage(options: DepotBuildImageOptions): Promise<BuildIm
         // Emitted data chunks can contain multiple lines. Remove empty lines.
         const lines = text.split("\n").filter(Boolean);
 
+        for (const line of lines) {
+          options.onLog?.(line);
+        }
+
         errors.push(...lines);
         logger.debug(text);
       });
@@ -278,6 +287,7 @@ interface SelfHostedBuildImageOptions {
   extraCACerts?: string;
   buildEnvVars?: Record<string, string | undefined>;
   network?: string;
+  onLog?: (log: string) => void;
 }
 
 async function selfHostedBuildImage(
@@ -336,6 +346,7 @@ async function selfHostedBuildImage(
     // line will be from stderr/stdout in the order you'd see it in a term
     errors.push(line);
     logger.debug(line);
+    options.onLog?.(line);
   }
 
   if (buildProcess.exitCode !== 0) {

packages/core/package.json

@@ -197,6 +197,7 @@
     "@opentelemetry/sdk-trace-node": "1.25.1",
     "@opentelemetry/semantic-conventions": "1.25.1",
     "dequal": "^2.0.3",
+    "eventsource": "^3.0.5",
     "eventsource-parser": "^3.0.0",
     "execa": "^8.0.1",
     "humanize-duration": "^3.27.3",