api.v1.deployments.$deploymentId.background-workers.ts

import type { ActionFunctionArgs } from "@remix-run/server-runtime";
import { json } from "@remix-run/server-runtime";
import { CreateBackgroundWorkerRequestBody } from "@trigger.dev/core/v3";
import { z } from "zod";
import { authenticateApiKeyWithScope } from "~/services/apiAuth.server";
import { logger } from "~/services/logger.server";
import { ServiceValidationError } from "~/v3/services/baseService.server";
import { CreateDeclarativeScheduleError } from "~/v3/services/createBackgroundWorker.server";
import { CreateDeploymentBackgroundWorkerServiceV4 } from "~/v3/services/createDeploymentBackgroundWorkerV4.server";

const ParamsSchema = z.object({
  deploymentId: z.string(),
});

export async function action({ request, params }: ActionFunctionArgs) {
  // Ensure this is a POST request
  if (request.method.toUpperCase() !== "POST") {
    return { status: 405, body: "Method Not Allowed" };
  }

  const parsedParams = ParamsSchema.safeParse(params);

  if (!parsedParams.success) {
    return json({ error: "Invalid params" }, { status: 400 });
  }

  try {
    // Next authenticate the request
    const authResult = await authenticateApiKeyWithScope(request, {
      action: "write",
      resource: { type: "deployments" },
    });

    if (!authResult.ok) {
      logger.info("Invalid or missing api key", { url: request.url });
      return json({ error: authResult.error }, { status: authResult.status });
    }

    const authenticationResult = authResult.authentication;

    const authenticatedEnv = authenticationResult.environment;

    const { deploymentId } = parsedParams.data;

    const rawBody = await request.json();
    const body = CreateBackgroundWorkerRequestBody.safeParse(rawBody);

    if (!body.success) {
      return json({ error: "Invalid body", issues: body.error.issues }, { status: 400 });
    }

    const service = new CreateDeploymentBackgroundWorkerServiceV4();

    try {
      const backgroundWorker = await service.call(authenticatedEnv, deploymentId, body.data);

      if (!backgroundWorker) {
        return json({ error: "Failed to create background worker" }, { status: 500 });
      }

      return json(
        {
          id: backgroundWorker.friendlyId,
          version: backgroundWorker.version,
          contentHash: backgroundWorker.contentHash,
        },
        { status: 200 }
      );
    } catch (e) {
      // Customer-facing validation failures (invalid task config, customer cron
      // expression, etc.). The handler returns 4xx with the message; system
      // handles it gracefully, no alert needed.
      if (e instanceof ServiceValidationError) {
        logger.warn("Failed to create background worker", { error: e.message });
        return json({ error: e.message }, { status: e.status ?? 400 });
      }
      if (e instanceof CreateDeclarativeScheduleError) {
        logger.warn("Failed to create background worker", { error: e.message });
        return json({ error: e.message }, { status: 400 });
      }

      logger.error("Failed to create background worker", { error: e });

      return json({ error: "Failed to create background worker" }, { status: 500 });
    }
  } catch (error) {
    if (error instanceof Response) throw error;
    logger.error("Failed to create deployment background worker", { error });
    return json({ error: "Internal Server Error" }, { status: 500 });
  }
}