Allow customizing the expiration time of the automatic JWT created after triggering a task

Author: ericallam

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

@@ -16,6 +16,7 @@ import {
   OffsetLimitPageParams,
   OffsetLimitPageResponse,
 } from "./pagination.js";
+import { TriggerJwtOptions } from "../types/tasks.js";
 
 export const defaultRetryOptions = {
   maxAttempts: 3,
@@ -35,6 +36,7 @@ export type ZodFetchOptions = {
 };
 
 export type ApiRequestOptions = Pick<ZodFetchOptions, "retry">;
+
 type KeysEnum<T> = { [P in keyof Required<T>]: true };
 
 // This is required so that we can determine if a given object matches the ApiRequestOptions

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

@@ -54,6 +54,7 @@ import {
   UpdateEnvironmentVariableParams,
 } from "./types.js";
 import { generateJWT } from "../jwt.js";
+import { TriggerJwtOptions } from "../types/tasks.js";
 
 export type {
   CreateEnvironmentVariableParams,
@@ -65,6 +66,14 @@ export type TriggerOptions = {
   spanParentAsLink?: boolean;
 };
 
+export type TriggerRequestOptions = ZodFetchOptions & {
+  jwt?: TriggerJwtOptions;
+};
+
+export type TriggerApiRequestOptions = ApiRequestOptions & {
+  jwt?: TriggerJwtOptions;
+};
+
 const DEFAULT_ZOD_FETCH_OPTIONS: ZodFetchOptions = {
   retry: {
     maxAttempts: 3,
@@ -155,7 +164,7 @@ export class ApiClient {
     taskId: string,
     body: TriggerTaskRequestBody,
     options?: TriggerOptions,
-    requestOptions?: ZodFetchOptions
+    requestOptions?: TriggerRequestOptions
   ) {
     const encodedTaskId = encodeURIComponent(taskId);
 
@@ -180,7 +189,7 @@ export class ApiClient {
             ...claims,
             permissions: [data.id],
           },
-          expirationTime: "1h",
+          expirationTime: requestOptions?.jwt?.expirationTime ?? "1h",
         });
 
         return {
@@ -194,7 +203,7 @@ export class ApiClient {
     taskId: string,
     body: BatchTriggerTaskRequestBody,
     options?: TriggerOptions,
-    requestOptions?: ZodFetchOptions
+    requestOptions?: TriggerRequestOptions
   ) {
     const encodedTaskId = encodeURIComponent(taskId);
 
@@ -219,7 +228,7 @@ export class ApiClient {
             ...claims,
             permissions: [data.batchId],
           },
-          expirationTime: "1h",
+          expirationTime: requestOptions?.jwt?.expirationTime ?? "1h",
         });
 
         return {

packages/core/src/v3/types/tasks.ts

@@ -11,6 +11,7 @@ import {
 } from "../schemas/index.js";
 import { Prettify } from "./utils.js";
 import { AnySchemaParseFn, inferSchemaOut, Schema } from "./schemas.js";
+import { TriggerApiRequestOptions } from "../apiClient/index.js";
 
 type RequireOne<T, K extends keyof T> = {
   [X in Exclude<keyof T, K>]?: T[X];
@@ -403,7 +404,11 @@ export interface Task<TIdentifier extends string, TInput = void, TOutput = any>
    * @returns RunHandle
    * - `id` - The id of the triggered task run.
    */
-  trigger: (payload: TInput, options?: TaskRunOptions) => Promise<RunHandle<TInput, TOutput>>;
+  trigger: (
+    payload: TInput,
+    options?: TaskRunOptions,
+    requestOptions?: TriggerApiRequestOptions
+  ) => Promise<RunHandle<TInput, TOutput>>;
 
   /**
    * Batch trigger multiple task runs with the given payloads, and continue without waiting for the results. If you want to wait for the results, use `batchTriggerAndWait`. Returns the id of the triggered batch.
@@ -412,7 +417,10 @@ export interface Task<TIdentifier extends string, TInput = void, TOutput = any>
    * - `batchId` - The id of the triggered batch.
    * - `runs` - The ids of the triggered task runs.
    */
-  batchTrigger: (items: Array<BatchItem<TInput>>) => Promise<BatchRunHandle<TInput, TOutput>>;
+  batchTrigger: (
+    items: Array<BatchItem<TInput>>,
+    requestOptions?: TriggerApiRequestOptions
+  ) => Promise<BatchRunHandle<TInput, TOutput>>;
 
   /**
    * Trigger a task with the given payload, and wait for the result. Returns the result of the task run
@@ -485,6 +493,15 @@ export type TaskIdentifier<TTask extends AnyTask> = TTask extends Task<infer TId
   ? TIdentifier
   : never;
 
+export type TriggerJwtOptions = {
+  /**
+   * The expiration time of the JWT. This can be a string like "1h" or a Date object.
+   *
+   * Defaults to 1 hour.
+   */
+  expirationTime?: number | Date | string;
+};
+
 export type TaskRunOptions = {
   /**
    * A unique key that can be used to ensure that a task is only triggered once per key.

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

@@ -55,6 +55,7 @@ import type {
   TaskRunResult,
   TaskSchema,
   TaskWithSchemaOptions,
+  TriggerApiRequestOptions,
 } from "@trigger.dev/core/v3";
 
 export type {
@@ -219,7 +220,7 @@ export function createSchemaTask<
 
   const task: Task<TIdentifier, inferSchemaIn<TSchema>, TOutput> = {
     id: params.id,
-    trigger: async (payload, options) => {
+    trigger: async (payload, options, requestOptions) => {
       const taskMetadata = taskCatalog.getTaskManifest(params.id);
 
       return await trigger_internal<inferSchemaIn<TSchema>, TOutput>(
@@ -232,10 +233,11 @@ export function createSchemaTask<
         {
           queue: customQueue,
           ...options,
-        }
+        },
+        requestOptions
       );
     },
-    batchTrigger: async (items) => {
+    batchTrigger: async (items, requestOptions) => {
       const taskMetadata = taskCatalog.getTaskManifest(params.id);
 
       return await batchTrigger_internal<inferSchemaIn<TSchema>, TOutput>(
@@ -245,7 +247,7 @@ export function createSchemaTask<
         params.id,
         items,
         parsePayload,
-        undefined,
+        requestOptions,
         customQueue
       );
     },
@@ -334,7 +336,7 @@ export async function trigger<TTask extends AnyTask>(
   id: TaskIdentifier<TTask>,
   payload: TaskPayload<TTask>,
   options?: TaskRunOptions,
-  requestOptions?: ApiRequestOptions
+  requestOptions?: TriggerApiRequestOptions
 ): Promise<RunHandle<TaskPayload<TTask>, TaskOutput<TTask>>> {
   return await trigger_internal<TaskPayload<TTask>, TaskOutput<TTask>>(
     "tasks.trigger()",
@@ -445,7 +447,7 @@ export async function triggerAndPoll<TTask extends AnyTask>(
   id: TaskIdentifier<TTask>,
   payload: TaskPayload<TTask>,
   options?: TaskRunOptions & PollOptions,
-  requestOptions?: ApiRequestOptions
+  requestOptions?: TriggerApiRequestOptions
 ): Promise<RetrieveRunResult<RunHandle<TaskPayload<TTask>, TaskOutput<TTask>>>> {
   const handle = await trigger(id, payload, options, requestOptions);
 
@@ -455,7 +457,7 @@ export async function triggerAndPoll<TTask extends AnyTask>(
 export async function batchTrigger<TTask extends AnyTask>(
   id: TaskIdentifier<TTask>,
   items: Array<BatchItem<TaskPayload<TTask>>>,
-  requestOptions?: ApiRequestOptions
+  requestOptions?: TriggerApiRequestOptions
 ): Promise<BatchRunHandle<TaskPayload<TTask>, TaskOutput<TTask>>> {
   return await batchTrigger_internal<TaskPayload<TTask>, TaskOutput<TTask>>(
     "tasks.batchTrigger()",
@@ -472,7 +474,7 @@ async function trigger_internal<TPayload, TOutput>(
   payload: TPayload,
   parsePayload?: SchemaParseFn<TPayload>,
   options?: TaskRunOptions,
-  requestOptions?: ApiRequestOptions
+  requestOptions?: TriggerApiRequestOptions
 ): Promise<RunHandle<TPayload, TOutput>> {
   const apiClient = apiClientManager.clientOrThrow();
 
@@ -531,7 +533,7 @@ async function batchTrigger_internal<TPayload, TOutput>(
   id: string,
   items: Array<BatchItem<TPayload>>,
   parsePayload?: SchemaParseFn<TPayload>,
-  requestOptions?: ApiRequestOptions,
+  requestOptions?: TriggerApiRequestOptions,
   queue?: QueueOptions
 ): Promise<BatchRunHandle<TPayload, TOutput>> {
   const apiClient = apiClientManager.clientOrThrow();

references/nextjs-realtime/src/app/api/uploadthing/core.ts

@@ -29,7 +29,18 @@ export const ourFileRouter = {
 
       console.log("file url", file.url);
 
-      const handle = await tasks.trigger<typeof handleUpload>("handle-upload", file);
+      const handle = await tasks.trigger<typeof handleUpload>(
+        "handle-upload",
+        file,
+        {},
+        {
+          jwt: {
+            expirationTime: "24h",
+          },
+        }
+      );
+
+      console.log("handle", handle);
 
       // !!! Whatever is returned here is sent to the clientside `onClientUploadComplete` callback
       return { uploadedBy: metadata.userId, jwt: handle.jwt, runId: handle.id };