Expose endpoint to start deployments

Author: myftija

apps/webapp/app/routes/api.v1.deployments.$deploymentId.start.ts

@@ -0,0 +1,64 @@
+import { type ActionFunctionArgs, json } from "@remix-run/server-runtime";
+import { StartDeploymentRequestBody } from "@trigger.dev/core/v3";
+import { z } from "zod";
+import { authenticateRequest } from "~/services/apiAuth.server";
+import { logger } from "~/services/logger.server";
+import { DeploymentService } from "~/v3/services/deployment.server";
+
+const ParamsSchema = z.object({
+  deploymentId: z.string(),
+});
+
+export async function action({ request, params }: ActionFunctionArgs) {
+  if (request.method.toUpperCase() !== "POST") {
+    return json({ error: "Method Not Allowed" }, { status: 405 });
+  }
+
+  const parsedParams = ParamsSchema.safeParse(params);
+
+  if (!parsedParams.success) {
+    return json({ error: "Invalid params" }, { status: 400 });
+  }
+
+  const authenticationResult = await authenticateRequest(request, {
+    apiKey: true,
+    organizationAccessToken: false,
+    personalAccessToken: false,
+  });
+
+  if (!authenticationResult || !authenticationResult.result.ok) {
+    logger.info("Invalid or missing api key", { url: request.url });
+    return json({ error: "Invalid or Missing API key" }, { status: 401 });
+  }
+
+  const { environment: authenticatedEnv } = authenticationResult.result;
+  const { deploymentId } = parsedParams.data;
+
+  const rawBody = await request.json();
+  const body = StartDeploymentRequestBody.safeParse(rawBody);
+
+  if (!body.success) {
+    return json({ error: "Invalid request body", issues: body.error.issues }, { status: 400 });
+  }
+
+  const deploymentService = new DeploymentService();
+
+  const result = await deploymentService.startDeployment(authenticatedEnv, deploymentId, body.data);
+  return result.match(
+    () => {
+      return json(null, { status: 204 });
+    },
+    (error) => {
+      switch (error.type) {
+        case "deployment_not_found":
+          return json({ error: "Deployment not found" }, { status: 404 });
+        case "deployment_not_pending":
+          return json({ error: "Deployment is not pending" }, { status: 409 });
+        case "other":
+        default:
+          error.type satisfies "other";
+          return json({ error: "Internal server error" }, { status: 500 });
+      }
+    }
+  );
+}

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

@@ -0,0 +1,63 @@
+import { type AuthenticatedEnvironment } from "~/services/apiAuth.server";
+import { BaseService } from "./baseService.server";
+import { errAsync, fromPromise, okAsync } from "neverthrow";
+import { type WorkerDeployment } from "@trigger.dev/database";
+import { type GitMeta } from "@trigger.dev/core/v3";
+
+export class DeploymentService extends BaseService {
+  public async startDeployment(
+    authenticatedEnv: AuthenticatedEnvironment,
+    friendlyId: string,
+    updates: Partial<Pick<WorkerDeployment, "contentHash" | "runtime"> & { git: GitMeta }>
+  ) {
+    const getDeployment = () =>
+      fromPromise(
+        this._prisma.workerDeployment.findFirst({
+          where: {
+            friendlyId,
+            environmentId: authenticatedEnv.id,
+          },
+          select: {
+            status: true,
+            id: true,
+          },
+        }),
+        (error) => ({
+          type: "other" as const,
+          cause: error,
+        })
+      ).andThen((deployment) => {
+        if (!deployment) {
+          return errAsync({ type: "deployment_not_found" as const });
+        }
+        return okAsync(deployment);
+      });
+
+    const validateDeployment = (deployment: Pick<WorkerDeployment, "id" | "status">) => {
+      if (deployment.status !== "PENDING") {
+        return errAsync({ type: "deployment_not_pending" as const });
+      }
+
+      return okAsync(deployment);
+    };
+
+    const updateDeployment = (deployment: Pick<WorkerDeployment, "id">) =>
+      fromPromise(
+        this._prisma.workerDeployment.updateMany({
+          where: { id: deployment.id, status: "PENDING" }, // status could've changed in the meantime, we're not locking the row
+          data: { ...updates, status: "BUILDING" },
+        }),
+        (error) => ({
+          type: "other" as const,
+          cause: error,
+        })
+      ).andThen((result) => {
+        if (result.count === 0) {
+          return errAsync({ type: "deployment_not_pending" as const });
+        }
+        return okAsync(undefined);
+      });
+
+    return getDeployment().andThen(validateDeployment).andThen(updateDeployment);
+  }
+}

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

@@ -377,6 +377,14 @@ export const FinalizeDeploymentRequestBody = z.object({
 
 export type FinalizeDeploymentRequestBody = z.infer<typeof FinalizeDeploymentRequestBody>;
 
+export const StartDeploymentRequestBody = z.object({
+  contentHash: z.string().optional(),
+  gitMeta: GitMeta.optional(),
+  runtime: z.string().optional(),
+});
+
+export type StartDeploymentRequestBody = z.infer<typeof StartDeploymentRequestBody>;
+
 export const ExternalBuildData = z.object({
   buildId: z.string(),
   buildToken: z.string(),