Added preview branch support to syncVercelEnvVars()

Author: matt-aitken

packages/build/src/extensions/core/vercelSyncEnvVars.ts

@@ -1,52 +1,49 @@
 import { BuildExtension } from "@trigger.dev/core/v3/build";
 import { syncEnvVars } from "../core.js";
 
-export function syncVercelEnvVars(
-  options?: {
-    projectId?: string;
-    vercelAccessToken?: string;
-    vercelTeamId?: string;
-  },
-): BuildExtension {
+export function syncVercelEnvVars(options?: {
+  projectId?: string;
+  vercelAccessToken?: string;
+  vercelTeamId?: string;
+}): BuildExtension {
   const sync = syncEnvVars(async (ctx) => {
-    const projectId = options?.projectId ?? process.env.VERCEL_PROJECT_ID ??
-      ctx.env.VERCEL_PROJECT_ID;
-    const vercelAccessToken = options?.vercelAccessToken ??
-      process.env.VERCEL_ACCESS_TOKEN ??
-      ctx.env.VERCEL_ACCESS_TOKEN;
-    const vercelTeamId = options?.vercelTeamId ?? process.env.VERCEL_TEAM_ID ??
-      ctx.env.VERCEL_TEAM_ID;
+    const projectId =
+      options?.projectId ?? process.env.VERCEL_PROJECT_ID ?? ctx.env.VERCEL_PROJECT_ID;
+    const vercelAccessToken =
+      options?.vercelAccessToken ?? process.env.VERCEL_ACCESS_TOKEN ?? ctx.env.VERCEL_ACCESS_TOKEN;
+    const vercelTeamId =
+      options?.vercelTeamId ?? process.env.VERCEL_TEAM_ID ?? ctx.env.VERCEL_TEAM_ID;
 
     if (!projectId) {
       throw new Error(
-        "syncVercelEnvVars: you did not pass in a projectId or set the VERCEL_PROJECT_ID env var.",
+        "syncVercelEnvVars: you did not pass in a projectId or set the VERCEL_PROJECT_ID env var."
       );
     }
 
     if (!vercelAccessToken) {
       throw new Error(
-        "syncVercelEnvVars: you did not pass in a vercelAccessToken or set the VERCEL_ACCESS_TOKEN env var.",
+        "syncVercelEnvVars: you did not pass in a vercelAccessToken or set the VERCEL_ACCESS_TOKEN env var."
       );
     }
 
     const environmentMap = {
       prod: "production",
       staging: "preview",
       dev: "development",
+      preview: "preview",
     } as const;
 
-    const vercelEnvironment =
-      environmentMap[ctx.environment as keyof typeof environmentMap];
+    const vercelEnvironment = environmentMap[ctx.environment as keyof typeof environmentMap];
 
     if (!vercelEnvironment) {
       throw new Error(
-        `Invalid environment '${ctx.environment}'. Expected 'prod', 'staging', or 'dev'.`,
+        `Invalid environment '${ctx.environment}'. Expected 'prod', 'staging', or 'dev'.`
       );
     }
     const params = new URLSearchParams({ decrypt: "true" });
     if (vercelTeamId) params.set("teamId", vercelTeamId);
-    const vercelApiUrl =
-      `https://api.vercel.com/v8/projects/${projectId}/env?${params}`;
+    if (ctx.branch) params.set("gitBranch", ctx.branch);
+    const vercelApiUrl = `https://api.vercel.com/v8/projects/${projectId}/env?${params}`;
 
     try {
       const response = await fetch(vercelApiUrl, {
@@ -64,8 +61,7 @@ export function syncVercelEnvVars(
       const filteredEnvs = data.envs
         .filter(
           (env: { type: string; value: string; target: string[] }) =>
-            env.value &&
-            env.target.includes(vercelEnvironment),
+            env.value && env.target.includes(vercelEnvironment)
         )
         .map((env: { key: string; value: string }) => ({
           name: env.key,
@@ -74,10 +70,7 @@ export function syncVercelEnvVars(
 
       return filteredEnvs;
     } catch (error) {
-      console.error(
-        "Error fetching or processing Vercel environment variables:",
-        error,
-      );
+      console.error("Error fetching or processing Vercel environment variables:", error);
       throw error; // Re-throw the error to be handled by the caller
     }
   });