import { createFunctionHandle, type DefaultFunctionArgs, type FunctionArgs, type FunctionHandle, type FunctionReference, type FunctionType, type FunctionVisibility, type GenericDataModel, type GenericMutationCtx, internalMutationGeneric, type RegisteredMutation, } from "convex/server"; import { getConvexSize, type Infer, v, type Validator, type Value, type VAny, type VString, } from "convex/values"; import type { ComponentApi } from "../component/_generated/component.js"; import { type LogLevel } from "../component/logging.js"; import { type Config, DEFAULT_RETRY_BEHAVIOR, type RetryBehavior, type RunResult, type OnCompleteArgs as SharedOnCompleteArgs, type Status, vResult, } from "../component/shared.js"; import { type RunMutationCtx, type RunQueryCtx, safeFunctionName, } from "./utils.js"; export { logLevel as vLogLevel, type LogLevel } from "../component/logging.js"; export { retryBehavior as vRetryBehavior } from "../component/shared.js"; export type WorkId = string & { __isWorkId: true }; export const vWorkId = v.string() as VString; export { vResult, DEFAULT_RETRY_BEHAVIOR, /** @deprecated Use `vResult` instead. */ vResult as resultValidator, /** @deprecated Use `vWorkId` instead. */ vWorkId as workIdValidator, // Older name, not deprecated yet vWorkId as vWorkIdValidator, vResult as vResultValidator, type RetryBehavior, type RunResult, }; /** Equivalent to `vOnCompleteArgs()`. */ export const vOnComplete = vOnCompleteArgs(v.any()); /** @deprecated Use `vOnCompleteArgs()` instead. */ export const vOnCompleteValidator = vOnCompleteArgs; export type WorkpoolComponent = ComponentApi; export class Workpool { /** * Initializes a Workpool. * * Note: if you want different pools, you need to *create different instances* * of Workpool in convex.config.ts. It isn't sufficient to have different * instances of this class. * * @param component - The component to use, like `components.workpool` from * `./_generated/api.ts`. * @param options - The {@link WorkpoolOptions} for the Workpool. */ constructor( public component: WorkpoolComponent, public options: WorkpoolOptions, ) {} /** * Enqueues an action to be run. * * @param ctx - The mutation or action context that can call ctx.runMutation. * @param fn - The action to run, like `internal.example.myAction`. * @param fnArgs - The arguments to pass to the action. * @param options - The options for the action to specify retry behavior, * onComplete handling, and scheduling via `runAt` or `runAfter`. * @returns The ID of the work that was enqueued. */ async enqueueAction( ctx: RunMutationCtx, fn: FunctionReference<"action", FunctionVisibility, Args, ReturnType>, fnArgs: Args, options?: RetryOption & EnqueueOptions, ): Promise { const retryBehavior = getRetryBehavior( this.options.defaultRetryBehavior, this.options.retryActionsByDefault, options?.retry, ); return enqueue(this.component, ctx, "action", fn, fnArgs, { retryBehavior, ...this.options, ...options, }); } /** * Enqueues a batch of actions to be run. * Each action will be run independently, and the onComplete handler will * be called for each action. * * @param ctx - The mutation or action ctx that can call ctx.runMutation. * @param fn - The action to run, like `internal.example.myAction`. * @param argsArray - The arguments to pass to the action. * @param options - The options for the actions to specify retry behavior, * onComplete handling, and scheduling via `runAt` or `runAfter`. * @returns The IDs of the work that was enqueued. */ async enqueueActionBatch( ctx: RunMutationCtx, fn: FunctionReference<"action", FunctionVisibility, Args, ReturnType>, argsArray: Array, options?: RetryOption & EnqueueOptions, ): Promise { const retryBehavior = getRetryBehavior( this.options.defaultRetryBehavior, this.options.retryActionsByDefault, options?.retry, ); return enqueueBatch(this.component, ctx, "action", fn, argsArray, { retryBehavior, ...this.options, ...options, }); } /** * Enqueues a mutation to be run. * * Note: mutations are not retried by the workpool. Convex automatically * retries them on database conflicts and transient failures. * Because they're deterministic, external retries don't provide any benefit. * * @param ctx - The mutation or action context that can call ctx.runMutation. * @param fn - The mutation to run, like `internal.example.myMutation`. * @param fnArgs - The arguments to pass to the mutation. * @param options - The options for the mutation to specify onComplete handling * and scheduling via `runAt` or `runAfter`. */ async enqueueMutation( ctx: RunMutationCtx, fn: FunctionReference<"mutation", FunctionVisibility, Args, ReturnType>, fnArgs: Args, options?: EnqueueOptions, ): Promise { return enqueue(this.component, ctx, "mutation", fn, fnArgs, { ...this.options, ...options, }); } /** * Enqueues a batch of mutations to be run. * Each mutation will be run independently, and the onComplete handler will * be called for each mutation. * * @param ctx - The mutation or action context that can call ctx.runMutation. * @param fn - The mutation to run, like `internal.example.myMutation`. * @param argsArray - The arguments to pass to the mutations. * @param options - The options for the mutations to specify onComplete handling * and scheduling via `runAt` or `runAfter`. */ async enqueueMutationBatch( ctx: RunMutationCtx, fn: FunctionReference<"mutation", FunctionVisibility, Args, ReturnType>, argsArray: Array, options?: EnqueueOptions, ): Promise { return enqueueBatch(this.component, ctx, "mutation", fn, argsArray, { ...this.options, ...options, }); } /** * Enqueues a query to be run. * Usually not what you want, but it can be useful during workflows. * The query is run in a mutation and the result is returned to the caller, * so it can conflict if other mutations are writing the value. * * @param ctx - The mutation or action context that can call ctx.runMutation. * @param fn - The query to run, like `internal.example.myQuery`. * @param fnArgs - The arguments to pass to the query. * @param options - The options for the query to specify onComplete handling * and scheduling via `runAt` or `runAfter`. */ async enqueueQuery( ctx: RunMutationCtx, fn: FunctionReference<"query", FunctionVisibility, Args, ReturnType>, fnArgs: Args, options?: EnqueueOptions, ): Promise { return enqueue(this.component, ctx, "query", fn, fnArgs, { ...this.options, ...options, }); } /** * Enqueues a batch of queries to be run. * Each query will be run independently, and the onComplete handler will * be called for each query. * * @param ctx - The mutation or action context that can call ctx.runMutation. * @param fn - The query to run, like `internal.example.myQuery`. * @param argsArray - The arguments to pass to the queries. * @param options - The options for the queries to specify onComplete handling * and scheduling via `runAt` or `runAfter`. */ async enqueueQueryBatch( ctx: RunMutationCtx, fn: FunctionReference<"query", FunctionVisibility, Args, ReturnType>, argsArray: Array, options?: EnqueueOptions, ): Promise { return enqueueBatch(this.component, ctx, "query", fn, argsArray, { ...this.options, ...options, }); } /** * Cancels a work item. If it's already started, it will be allowed to finish * but will not be retried. * * @param ctx - The mutation or action context that can call ctx.runMutation. * @param id - The ID of the work to cancel. */ async cancel(ctx: RunMutationCtx, id: WorkId): Promise { await ctx.runMutation(this.component.lib.cancel, { id, logLevel: this.options.logLevel, }); } /** * Cancels all pending work items. See {@link cancel}. * * @param ctx - The mutation or action context that can call ctx.runMutation. */ async cancelAll( ctx: RunMutationCtx, options?: { limit?: number }, ): Promise { await ctx.runMutation(this.component.lib.cancelAll, { logLevel: this.options.logLevel, ...options, }); } /** * Gets the status of a work item. * * @param ctx - The query context that can call ctx.runQuery. * @param id - The ID of the work to get the status of. * @returns The status of the work item. One of: * - `{ state: "pending", previousAttempts: number }` * - `{ state: "running", previousAttempts: number }` * - `{ state: "finished" }` */ async status(ctx: RunQueryCtx, id: WorkId): Promise { return ctx.runQuery(this.component.lib.status, { id }); } /** * Gets the status of a batch of work items. * * @param ctx - The query context that can call ctx.runQuery. * @param ids - The IDs of the work to get the status of. * @returns The status of the work items. */ async statusBatch(ctx: RunQueryCtx, ids: WorkId[]): Promise { return ctx.runQuery(this.component.lib.statusBatch, { ids }); } /** * Defines a mutation that will be run after a work item completes. * You can pass this to a call to enqueue* like so: * ```ts * export const myOnComplete = workpool.defineOnComplete({ * context: v.literal("myContextValue"), // optional * handler: async (ctx, {workId, context, result}) => { * // ... do something with the result * }, * }); * * // in some other function: * const workId = await workpool.enqueueAction(ctx, internal.foo.bar, { * // ... args to action * }, { * onComplete: internal.foo.myOnComplete, * }); * ``` */ defineOnComplete< DataModel extends GenericDataModel, V extends Validator = VAny, >({ context, handler, }: { context?: V; handler: ( ctx: GenericMutationCtx, args: { workId: WorkId; context: Infer; result: RunResult; }, ) => Promise; }): RegisteredMutation<"internal", OnCompleteArgs, null> { return internalMutationGeneric({ args: vOnCompleteArgs(context), handler, }); } } /** * Returns a validator to use for the onComplete mutation. * To be used like: * ```ts * export const myOnComplete = internalMutation({ * args: vOnCompleteArgs(v.string()), * handler: async (ctx, {workId, context, result}) => { * // context has been validated as a string * // ... do something with the result * }, * }); * @param context - The context validator. If not provided, it will be `v.any()`. * @returns The validator for the onComplete mutation. */ export function vOnCompleteArgs< V extends Validator = VAny, >(context?: V) { return v.object({ workId: vWorkId, context: (context ?? v.optional(v.any())) as V, result: vResult, }); } export type RetryOption = { /** Whether to retry the action if it fails. * If false, the action won’t be retried. * If true, it will use the default retry behavior. * If custom behavior is provided, it will retry using that behavior. * If unset, it will use the Workpool's configured default. */ retry?: boolean | RetryBehavior; }; export type WorkpoolOptions = { /** How many actions/mutations can be running at once within this pool. * Suggested max: 100 on Pro, 20 on free plan. * If set to 0, no new work will be started. */ maxParallelism?: number; /** How much to log. This is updated on each call to `enqueue*`, * `status`, or `cancel*`. * Default is REPORT, which logs warnings, errors, and a periodic report. * With INFO, you can also see events for started and completed work. * Stats generated can be parsed by tools like * [Axiom](https://axiom.co) for monitoring. * With DEBUG, you can see timers and internal events for work being * scheduled. */ logLevel?: LogLevel; } & WorkpoolRetryOptions; export type WorkpoolRetryOptions = { /** Default retry behavior for enqueued actions. * Note: setting this doesn't mean actions will be retried by default. * To retry actions by default, set `retryActionsByDefault: true`. * See {@link RetryBehavior}. */ defaultRetryBehavior?: RetryBehavior; /** Whether to retry actions that fail by default. Default: false. * NOTE: Only enable this if your actions are idempotent. * See the docs (README.md) for more details. */ retryActionsByDefault?: boolean; }; export type EnqueueOptions = { /** * The name of the function. By default, if you pass in api.foo.bar.baz, * it will use "foo/bar:baz" as the name. If you pass in a function handle, * it will use the function handle directly. */ name?: string; /** * A mutation to run after the function succeeds, fails, or is canceled. * The context type is for your use, feel free to provide a validator for it. * e.g. * ```ts * export const completion = workpool.defineOnComplete({ * context: v.string(), * handler: async (ctx, {workId, context, result}) => { * // context has been validated as a string * // ... do something with the result * }, * }); * ``` * or more manually: * ```ts * export const completion = internalMutation({ * args: vOnCompleteArgs(v.string()), * handler: async (ctx, args) => { * console.log(args.result, "Got Context back -> ", args.context, Date.now() - args.context); * }, * }); * ``` */ onComplete?: FunctionReference< "mutation", FunctionVisibility, OnCompleteArgs > | null; /** * A context object to pass to the `onComplete` mutation. * Useful for passing data from the enqueue site to the onComplete site. */ context?: unknown; } & ( | { /** * The time (ms since epoch) to run the action at. * If not provided, the action will be run as soon as possible. * Note: this is advisory only. It may run later. */ runAt?: number; } | { /** * The number of milliseconds to run the action after. * If not provided, the action will be run as soon as possible. * Note: this is advisory only. It may run later. */ runAfter?: number; } ); export type OnCompleteArgs = { /** * The ID of the work that completed. */ workId: string; /** * The context object passed when enqueuing the work. * Useful for passing data from the enqueue site to the onComplete site. */ context: unknown; /** * The result of the run that completed. */ result: RunResult; }; // ensure OnCompleteArgs satisfies SharedOnCompleteArgs const _ = {} as OnCompleteArgs satisfies SharedOnCompleteArgs; // // Helper functions // function getRetryBehavior( defaultRetryBehavior: RetryBehavior | undefined, retryActionsByDefault: boolean | undefined, retryOverride: boolean | RetryBehavior | undefined, ): RetryBehavior | undefined { const defaultRetry = defaultRetryBehavior ?? DEFAULT_RETRY_BEHAVIOR; const retryByDefault = retryActionsByDefault ?? false; if (retryOverride === true) { return defaultRetry; } if (retryOverride === false) { return undefined; } return retryOverride ?? (retryByDefault ? defaultRetry : undefined); } async function enqueueArgs( fn: | FunctionReference | FunctionHandle, opts: | (EnqueueOptions & Partial & { retryBehavior?: RetryBehavior }) | undefined, ) { const [fnHandle, fnName] = typeof fn === "string" && fn.startsWith("function://") ? [fn, opts?.name ?? fn] : [await createFunctionHandle(fn), opts?.name ?? safeFunctionName(fn)]; return { fnHandle, fnName, onComplete: opts?.onComplete ? { fnHandle: await createFunctionHandle(opts.onComplete), context: opts.context, } : undefined, runAt: getRunAt(opts), retryBehavior: opts?.retryBehavior, config: { logLevel: opts?.logLevel, maxParallelism: opts?.maxParallelism, }, } satisfies Omit< FunctionArgs, "fnArgs" | "fnType" >; } function getRunAt( options: | { runAt?: number; runAfter?: number; } | undefined, ): number { if (!options) { return Date.now(); } if (options.runAt !== undefined) { return options.runAt; } if (options.runAfter !== undefined) { return Date.now() + options.runAfter; } return Date.now(); } export async function enqueueBatch< FnType extends FunctionType, Args extends DefaultFunctionArgs, ReturnType, >( component: WorkpoolComponent, ctx: RunMutationCtx, fnType: FnType, fn: FunctionReference, fnArgsArray: Array, options: EnqueueOptions & { retryBehavior?: RetryBehavior; maxParallelism?: number; logLevel?: LogLevel; }, ): Promise { const { config, ...defaults } = await enqueueArgs(fn, options); const batches = []; const MAX_BATCH_SIZE = 8_000_000; let currentBatch = []; let currentBatchSize = 0; for (const fnArgs of fnArgsArray) { const item = { ...defaults, fnArgs, fnType, }; const itemSize = getConvexSize(item as Value); // If adding this item would exceed the limit, start a new batch if ( currentBatch.length > 0 && currentBatchSize + itemSize > MAX_BATCH_SIZE ) { batches.push({ items: currentBatch }); currentBatch = []; currentBatchSize = 0; } currentBatch.push(item); currentBatchSize += itemSize; } // Add the last batch if it has items if (currentBatch.length > 0) { batches.push({ items: currentBatch }); } // Process all batches and collect IDs const allIds: WorkId[] = []; for (const batch of batches) { const ids = await ctx.runMutation(component.lib.enqueueBatch, { items: batch.items, config, }); allIds.push(...(ids as WorkId[])); } return allIds; } export async function enqueue< FnType extends FunctionType, Args extends DefaultFunctionArgs, ReturnType, >( component: WorkpoolComponent, ctx: RunMutationCtx, fnType: FnType, fn: FunctionReference, fnArgs: Args, options: EnqueueOptions & { retryBehavior?: RetryBehavior; maxParallelism?: number; logLevel?: LogLevel; }, ): Promise { const id = await ctx.runMutation(component.lib.enqueue, { ...(await enqueueArgs(fn, options)), fnArgs, fnType, }); return id as WorkId; }