Uploading env vars in a variety of formats now works

Author: ericallam

.vscode/launch.json

@@ -45,6 +45,14 @@
       "cwd": "${workspaceFolder}/references/v3-catalog",
       "sourceMaps": true
     },
+    {
+      "type": "node-terminal",
+      "request": "launch",
+      "name": "Debug V3 Management",
+      "command": "pnpm run management",
+      "cwd": "${workspaceFolder}/references/v3-catalog",
+      "sourceMaps": true
+    },
     {
       "type": "node",
       "request": "attach",

apps/webapp/app/routes/api.v1.projects.$projectRef.envvars.$slug.import.ts

@@ -58,7 +58,7 @@ async function parseImportBody(request: Request): Promise<ImportEnvironmentVaria
   if (contentType.includes("multipart/form-data")) {
     const formData = await request.formData();
 
-    const file = formData.get("file");
+    const file = formData.get("variables");
     const overwrite = formData.get("overwrite") === "true";
 
     if (file instanceof File) {

apps/webapp/app/v3/environmentVariables/environmentVariablesRepository.server.ts

@@ -122,7 +122,7 @@ export class EnvironmentVariablesRepository implements Repository {
       if (existingVariableKeys.length > 0) {
         return {
           success: false as const,
-          error: `Some of the variables are already set for these environments`,
+          error: `Some of the variables are already set for these environments. Set overwrite to true to overwrite them.`,
           variableErrors: existingVariableKeys.map((val) => ({
             key: val.key,
             error: `Variable already set in ${val.environments

docs/v3-openapi.yaml

@@ -523,7 +523,7 @@ paths:
           source: |-
             import { envvars, configure } from "@trigger.dev/sdk/v3";
 
-            configure({ apiKey: "tr_pat_123456" });
+            configure({ secretKey: "tr_pat_123456" });
 
             const variables = await envvars.list("proj_yubjwjsfkxnylobaqvqz", "dev");
 
@@ -596,7 +596,7 @@ paths:
           source: |-
             import { envvars, configure } from "@trigger.dev/sdk/v3";
 
-            configure({ apiKey: "tr_pat_123456" });
+            configure({ secretKey: "tr_pat_123456" });
 
             await envvars.create("proj_yubjwjsfkxnylobaqvqz", "dev", {
               name: "SLACK_API_KEY",
@@ -690,10 +690,10 @@ paths:
           source: |-
             import { envvars, configure } from "@trigger.dev/sdk/v3";
 
-            configure({ apiKey: "tr_pat_123456" });
+            configure({ secretKey: "tr_pat_123456" });
 
             // Import variables from an array
-            await envvars.import("proj_yubjwjsfkxnylobaqvqz", "dev", {
+            await envvars.upload("proj_yubjwjsfkxnylobaqvqz", "dev", {
               variables: [
                 {
                   name: "SLACK_API_KEY",
@@ -704,7 +704,7 @@ paths:
             });
             
             // Import variables from a .env file
-            await envvars.import("proj_yubjwjsfkxnylobaqvqz", "dev", {
+            await envvars.upload("proj_yubjwjsfkxnylobaqvqz", "dev", {
               file: fs.createReadStream(".env"),
               overwrite: false
             });

packages/core/src/v3/apiClient/index.ts

@@ -27,6 +27,8 @@ import { taskContext } from "../task-context-api";
 import { ZodFetchOptions, isRecordLike, zodfetch, zodupload } from "../zodfetch";
 import { ImportEnvironmentVariablesParams } from "./types";
 
+export type { ImportEnvironmentVariablesParams };
+
 export type TriggerOptions = {
   spanParentAsLink?: boolean;
 };

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

@@ -394,6 +394,8 @@ export const EnvironmentVariableResponseBody = z.object({
   success: z.boolean(),
 });
 
+export type EnvironmentVariableResponseBody = z.infer<typeof EnvironmentVariableResponseBody>;
+
 export const EnvironmentVariableValue = z.object({
   value: z.string(),
 });

packages/core/src/v3/zodfetch.ts

@@ -4,6 +4,7 @@ import { APIConnectionError, APIError } from "./apiErrors";
 import { RetryOptions } from "./schemas";
 import { calculateNextRetryDelay } from "./utils/retries";
 import { FormDataEncoder } from "form-data-encoder";
+import { Readable } from "stream";
 
 export const defaultRetryOptions = {
   maxAttempts: 3,
@@ -26,6 +27,13 @@ export async function zodfetch<TResponseBodySchema extends z.ZodTypeAny>(
   return await _doZodFetch(schema, url, requestInit, options);
 }
 
+export class MultipartBody {
+  constructor(public body: any) {}
+  get [Symbol.toStringTag](): string {
+    return "MultipartBody";
+  }
+}
+
 export async function zodupload<
   TResponseBodySchema extends z.ZodTypeAny,
   TBody = Record<string, unknown>,
@@ -38,22 +46,25 @@ export async function zodupload<
 ): Promise<z.output<TResponseBodySchema>> {
   const form = await createForm(body);
   const encoder = new FormDataEncoder(form);
-  const headers = encoder.headers;
 
   const finalHeaders: Record<string, string> = {};
 
   for (const [key, value] of Object.entries(requestInit?.headers || {})) {
     finalHeaders[key] = value as string;
   }
 
-  for (const [key, value] of Object.entries(headers)) {
+  for (const [key, value] of Object.entries(encoder.headers)) {
     finalHeaders[key] = value;
   }
 
+  finalHeaders["Content-Length"] = String(encoder.contentLength);
+
   const finalRequestInit: RequestInit = {
     ...requestInit,
     headers: finalHeaders,
-    body: form,
+    body: Readable.from(encoder) as any,
+    // @ts-expect-error
+    duplex: "half",
   };
 
   return await _doZodFetch(schema, url, finalRequestInit, options);
@@ -228,7 +239,12 @@ const addFormValue = async (form: FormData, key: string, value: unknown): Promis
   // TODO: make nested formats configurable
   if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
     form.append(key, String(value));
-  } else if (isUploadable(value)) {
+  } else if (
+    isUploadable(value) ||
+    isBlobLike(value) ||
+    value instanceof Buffer ||
+    value instanceof ArrayBuffer
+  ) {
     const file = await toFile(value);
     form.append(key, file as File);
   } else if (Array.isArray(value)) {
@@ -336,9 +352,6 @@ function propsForError(value: any): string {
 const isAsyncIterableIterator = (value: any): value is AsyncIterableIterator<unknown> =>
   value != null && typeof value === "object" && typeof value[Symbol.asyncIterator] === "function";
 
-import { ReadStream as FsReadStream } from "node:fs";
-import { Readable } from "node:stream";
-
 /**
  * Intended to match web.Blob, node.Blob, node-fetch.Blob, etc.
  */
@@ -372,7 +385,7 @@ export interface ResponseLike {
   blob(): Promise<BlobLike>;
 }
 
-export type Uploadable = FileLike | ResponseLike | FsReadStream;
+export type Uploadable = FileLike | ResponseLike | Readable;
 
 export const isResponseLike = (value: any): value is ResponseLike =>
   value != null &&
@@ -402,7 +415,7 @@ export const isBlobLike = (
   typeof value.slice === "function" &&
   typeof value.arrayBuffer === "function";
 
-export const isFsReadStream = (value: any): value is FsReadStream => value instanceof FsReadStream;
+export const isFsReadStream = (value: any): value is Readable => value instanceof Readable;
 
 export const isUploadable = (value: any): value is Uploadable => {
   return isFileLike(value) || isResponseLike(value) || isFsReadStream(value);
@@ -420,4 +433,5 @@ export const isRecordLike = (value: any): value is Record<string, string> =>
   value != null &&
   typeof value === "object" &&
   !Array.isArray(value) &&
+  Object.keys(value).length > 0 &&
   Object.keys(value).every((key) => typeof key === "string" && typeof value[key] === "string");

packages/trigger-sdk/src/v3/envvars.ts

@@ -0,0 +1,78 @@
+import type {
+  ImportEnvironmentVariablesParams,
+  EnvironmentVariableResponseBody,
+} from "@trigger.dev/core/v3";
+import { SemanticInternalAttributes, apiClientManager, taskContext } from "@trigger.dev/core/v3";
+import { apiClientMissingError } from "./shared";
+import { tracer } from "./tracer";
+
+export type { ImportEnvironmentVariablesParams };
+
+export async function upload(
+  projectRef: string,
+  slug: string,
+  params: ImportEnvironmentVariablesParams
+): Promise<EnvironmentVariableResponseBody>;
+export async function upload(
+  params: ImportEnvironmentVariablesParams
+): Promise<EnvironmentVariableResponseBody>;
+export async function upload(
+  projectRefOrParams: string | ImportEnvironmentVariablesParams,
+  slug?: string,
+  params?: ImportEnvironmentVariablesParams
+): Promise<EnvironmentVariableResponseBody> {
+  let $projectRef: string;
+  let $params: ImportEnvironmentVariablesParams;
+  let $slug: string;
+
+  if (taskContext.ctx) {
+    if (typeof projectRefOrParams === "string") {
+      $projectRef = projectRefOrParams;
+      $slug = slug ?? taskContext.ctx.environment.slug;
+
+      if (!params) {
+        throw new Error("params is required");
+      }
+
+      $params = params;
+    } else {
+      $params = projectRefOrParams;
+      $projectRef = taskContext.ctx.project.ref;
+      $slug = taskContext.ctx.environment.slug;
+    }
+  } else {
+    if (typeof projectRefOrParams !== "string") {
+      throw new Error("projectRef is required");
+    }
+
+    if (!slug) {
+      throw new Error("slug is required");
+    }
+
+    if (!params) {
+      throw new Error("params is required");
+    }
+
+    $projectRef = projectRefOrParams;
+    $slug = slug;
+    $params = params;
+  }
+
+  const apiClient = apiClientManager.client;
+
+  if (!apiClient) {
+    throw apiClientMissingError();
+  }
+
+  return await tracer.startActiveSpan(
+    "envvars.upload",
+    async (span) => {
+      return await apiClient.importEnvVars($projectRef, $slug, $params);
+    },
+    {
+      attributes: {
+        [SemanticInternalAttributes.STYLE_ICON]: "file-upload",
+      },
+    }
+  );
+}

packages/trigger-sdk/src/v3/index.ts

@@ -27,8 +27,10 @@ export {
   type LogLevel,
 } from "@trigger.dev/core/v3";
 
-export { runs } from "./management";
+export { runs } from "./runs";
 export * as schedules from "./schedules";
+export * as envvars from "./envvars";
+export type { ImportEnvironmentVariablesParams } from "./envvars";
 
 /**
  * Register the global API client configuration. Alternatively, you can set the `TRIGGER_SECRET_KEY` and `TRIGGER_API_URL` environment variables.

packages/trigger-sdk/src/v3/management.ts renamed to packages/trigger-sdk/src/v3/runs.ts

@@ -0,0 +1,2 @@
+THIS_IS_MY_KEY=1234567890
+ANOTHER_KEY=0987654321

references/v3-catalog/.uploadable-env

@@ -1,11 +1,64 @@
 import { tracer } from "./tracer";
-import { APIError, configure, runs, schedules } from "@trigger.dev/sdk/v3";
+import { APIError, configure, runs, schedules, envvars } from "@trigger.dev/sdk/v3";
 import { simpleChildTask } from "./trigger/subtasks";
 import dotenv from "dotenv";
 import { firstScheduledTask } from "./trigger/scheduled";
+import { createReadStream } from "node:fs";
 
 dotenv.config();
 
+async function uploadEnvVars() {
+  configure({
+    secretKey: process.env.TRIGGER_ACCESS_TOKEN,
+  });
+
+  const response1 = await envvars.upload("yubjwjsfkxnylobaqvqz", "dev", {
+    variables: {
+      MY_ENV_VAR: "MY_ENV_VAR_VALUE",
+    },
+    overwrite: true,
+  });
+
+  console.log("response1", response1);
+
+  const response2 = await envvars.upload("yubjwjsfkxnylobaqvqz", "dev", {
+    variables: createReadStream(".uploadable-env"),
+    overwrite: true,
+  });
+
+  console.log("response2", response2);
+
+  const response3 = await envvars.upload("yubjwjsfkxnylobaqvqz", "prod", {
+    variables: createReadStream(".uploadable-env"),
+    overwrite: true,
+  });
+
+  console.log("response3", response3);
+
+  const response4 = await envvars.upload("yubjwjsfkxnylobaqvqz", "prod", {
+    variables: await fetch(
+      "https://gist.githubusercontent.com/ericallam/7a1001c6b03986a74d0f8aad4fd890aa/raw/fe2bc4da82f3b17178d47f58ec1458af47af5035/.env"
+    ),
+    overwrite: true,
+  });
+
+  console.log("response4", response4);
+
+  const response5 = await envvars.upload("yubjwjsfkxnylobaqvqz", "prod", {
+    variables: new File(["IM_A_FILE=GREAT_FOR_YOU"], ".env"),
+    overwrite: true,
+  });
+
+  console.log("response5", response5);
+
+  const response6 = await envvars.upload("yubjwjsfkxnylobaqvqz", "prod", {
+    variables: Buffer.from("IN_BUFFER=TRUE"),
+    overwrite: true,
+  });
+
+  console.log("response6", response6);
+}
+
 export async function run() {
   await tracer.startActiveSpan("run", async (span) => {
     try {
@@ -88,4 +141,5 @@ export async function run() {
   });
 }
 
-run();
+// run();
+uploadEnvVars().catch(console.error);

references/v3-catalog/src/management.ts

@@ -1,5 +1,5 @@
 import "server-only";
-import { logger, task, wait } from "@trigger.dev/sdk/v3";
+import { envvars, logger, task, wait } from "@trigger.dev/sdk/v3";
 import { traceAsync } from "@/telemetry";
 
 export const simplestTask = task({
@@ -31,6 +31,18 @@ export const taskWithSpecialCharacters = task({
   },
 });
 
+export const updateEnvVars = task({
+  id: "update-env-vars",
+  run: async () => {
+    return await envvars.upload({
+      variables: await fetch(
+        "https://gist.githubusercontent.com/ericallam/7a1001c6b03986a74d0f8aad4fd890aa/raw/fe2bc4da82f3b17178d47f58ec1458af47af5035/.env"
+      ),
+      overwrite: true,
+    });
+  },
+});
+
 export const createJsonHeroDoc = task({
   id: "create-jsonhero-doc",
   run: async (payload: { title: string; content: any }, { ctx }) => {