@convex-dev/workpool 0.1.3-alpha.0 → 0.2.0-beta.0

package/dist/esm/client/index.js

@@ -1,40 +1,147 @@
 import { createFunctionHandle, getFunctionName, } from "convex/server";
-import { completionStatus, } from "../component/schema.js";
-export { completionStatus };
+import { v } from "convex/values";
+import { runResult as runResultValidator, } from "../component/shared.js";
+import { logLevel } from "../component/logging.js";
+import { DEFAULT_LOG_LEVEL } from "../component/logging.js";
+import { DEFAULT_MAX_PARALLELISM } from "../component/kick.js";
+export { runResultValidator };
+// Attempts will run with delay [0, 250, 500, 1000, 2000] (ms)
+export const DEFAULT_RETRY_BEHAVIOR = {
+    maxAttempts: 5,
+    initialBackoffMs: 250,
+    base: 2,
+};
+export const workIdValidator = v.string();
 export class Workpool {
     component;
     options;
-    constructor(component, options) {
+    /**
+     * 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 options for the Workpool.
+     */
+    constructor(component, // UseApi<api> for jump to definition
+    options) {
         this.component = component;
         this.options = options;
     }
-    async enqueueAction(ctx, fn, fnArgs) {
-        const fnHandle = await createFunctionHandle(fn);
+    /**
+     * 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, fn, fnArgs, options) {
+        const retryBehavior = getRetryBehavior(this.options.defaultRetryBehavior, this.options.retryActionsByDefault, options?.retry);
+        const onComplete = options?.onComplete
+            ? {
+                fnHandle: await createFunctionHandle(options.onComplete),
+                context: options.context,
+            }
+            : undefined;
         const id = await ctx.runMutation(this.component.lib.enqueue, {
-            fnHandle,
-            fnName: getFunctionName(fn),
+            ...(await defaultEnqueueArgs(fn, this.options)),
             fnArgs,
             fnType: "action",
-            options: this.options,
+            runAt: getRunAt(options),
+            onComplete,
+            retryBehavior,
         });
         return id;
     }
-    async enqueueMutation(ctx, fn, fnArgs) {
-        const fnHandle = await createFunctionHandle(fn);
+    /**
+     * 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, fn, fnArgs, options) {
         const id = await ctx.runMutation(this.component.lib.enqueue, {
-            fnHandle,
-            fnName: getFunctionName(fn),
+            ...(await defaultEnqueueArgs(fn, this.options)),
             fnArgs,
             fnType: "mutation",
-            options: this.options,
+            runAt: getRunAt(options),
         });
         return id;
     }
     async cancel(ctx, id) {
-        await ctx.runMutation(this.component.lib.cancel, { id });
+        await ctx.runMutation(this.component.lib.cancel, {
+            id,
+            logLevel: this.options.logLevel ?? getDefaultLogLevel(),
+        });
+    }
+    async cancelAll(ctx) {
+        await ctx.runMutation(this.component.lib.cancelAll, {
+            logLevel: this.options.logLevel ?? getDefaultLogLevel(),
+        });
     }
     async status(ctx, id) {
-        return await ctx.runQuery(this.component.lib.status, { id });
+        return ctx.runQuery(this.component.lib.status, { id });
+    }
+}
+function getRetryBehavior(defaultRetryBehavior, retryActionsByDefault, retryOverride) {
+    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 defaultEnqueueArgs(fn, { logLevel, maxParallelism }) {
+    return {
+        fnHandle: await createFunctionHandle(fn),
+        fnName: getFunctionName(fn),
+        config: {
+            logLevel: logLevel ?? getDefaultLogLevel(),
+            maxParallelism: maxParallelism ?? DEFAULT_MAX_PARALLELISM,
+        },
+    };
+}
+// ensure OnCompleteArgs satisfies SharedOnCompleteArgs
+const _ = {};
+function getRunAt(options) {
+    if (!options) {
+        return Date.now();
+    }
+    if ("runAt" in options && options.runAt !== undefined) {
+        return options.runAt;
+    }
+    if ("runAfter" in options && options.runAfter !== undefined) {
+        return Date.now() + options.runAfter;
+    }
+    return Date.now();
+}
+function getDefaultLogLevel() {
+    if (process.env.WORKPOOL_LOG_LEVEL) {
+        if (!logLevel.members
+            .map((m) => m.value)
+            .includes(process.env.WORKPOOL_LOG_LEVEL)) {
+            console.warn(`Invalid log level (${process.env.WORKPOOL_LOG_LEVEL}), defaulting to "INFO"`);
+        }
+        else {
+            return process.env.WORKPOOL_LOG_LEVEL;
+        }
     }
+    return DEFAULT_LOG_LEVEL;
 }
 //# sourceMappingURL=index.js.map

package/dist/esm/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EAQpB,eAAe,GAChB,MAAM,eAAe,CAAC;AAIvB,OAAO,EACL,gBAAgB,GAEjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAyB,CAAC;AAInD,MAAM,OAAO,QAAQ;IAET;IACA;IAFV,YACU,SAA6B,EAC7B,OAiBP;QAlBO,cAAS,GAAT,SAAS,CAAoB;QAC7B,YAAO,GAAP,OAAO,CAiBd;IACA,CAAC;IACJ,KAAK,CAAC,aAAa,CACjB,GAAmB,EACnB,EAAqE,EACrE,MAAY;QAEZ,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE;YAC3D,QAAQ;YACR,MAAM,EAAE,eAAe,CAAC,EAAE,CAAC;YAC3B,MAAM;YACN,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;QACH,OAAO,EAAY,CAAC;IACtB,CAAC;IACD,KAAK,CAAC,eAAe,CACnB,GAAmB,EACnB,EAAuE,EACvE,MAAY;QAEZ,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE;YAC3D,QAAQ;YACR,MAAM,EAAE,eAAe,CAAC,EAAE,CAAC;YAC3B,MAAM;YACN,MAAM,EAAE,UAAU;YAClB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;QACH,OAAO,EAAY,CAAC;IACtB,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,GAAmB,EAAE,EAAU;QAC1C,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC;IACD,KAAK,CAAC,MAAM,CACV,GAAgB,EAChB,EAAU;QAMV,OAAO,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EAIpB,eAAe,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAW,MAAM,eAAe,CAAC;AAE3C,OAAO,EAEL,SAAS,IAAI,kBAAkB,GAMhC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAiB,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAkB,CAAC;AAE9C,8DAA8D;AAC9D,MAAM,CAAC,MAAM,sBAAsB,GAAkB;IACnD,WAAW,EAAE,CAAC;IACd,gBAAgB,EAAE,GAAG;IACrB,IAAI,EAAE,CAAC;CACR,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,EAAqB,CAAC;AAE7D,MAAM,OAAO,QAAQ;IAaT;IACA;IAbV;;;;;;;;;;OAUG;IACH,YACU,SAAyB,EAAE,qCAAqC;IAChE,OAqBP;QAtBO,cAAS,GAAT,SAAS,CAAgB;QACzB,YAAO,GAAP,OAAO,CAqBd;IACA,CAAC;IACJ;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,GAAmB,EACnB,EAAqE,EACrE,MAAY,EACZ,OAQkB;QAElB,MAAM,aAAa,GAAG,gBAAgB,CACpC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EACjC,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAClC,OAAO,EAAE,KAAK,CACf,CAAC;QACF,MAAM,UAAU,GAA2B,OAAO,EAAE,UAAU;YAC5D,CAAC,CAAC;gBACE,QAAQ,EAAE,MAAM,oBAAoB,CAAC,OAAO,CAAC,UAAU,CAAC;gBACxD,OAAO,EAAE,OAAO,CAAC,OAAO;aACzB;YACH,CAAC,CAAC,SAAS,CAAC;QACd,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE;YAC3D,GAAG,CAAC,MAAM,kBAAkB,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM;YACN,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;YACxB,UAAU;YACV,aAAa;SACd,CAAC,CAAC;QACH,OAAO,EAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,eAAe,CACnB,GAAmB,EACnB,EAAuE,EACvE,MAAY,EACZ,OAA4C;QAE5C,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE;YAC3D,GAAG,CAAC,MAAM,kBAAkB,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM;YACN,MAAM,EAAE,UAAU;YAClB,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;SACzB,CAAC,CAAC;QACH,OAAO,EAAY,CAAC;IACtB,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,GAAmB,EAAE,EAAU;QAC1C,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE;YAC/C,EAAE;YACF,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,kBAAkB,EAAE;SACxD,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,SAAS,CAAC,GAAmB;QACjC,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE;YAClD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,kBAAkB,EAAE;SACxD,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,GAAgB,EAAE,EAAU;QACvC,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACzD,CAAC;CACF;AAED,SAAS,gBAAgB,CACvB,oBAA+C,EAC/C,qBAA0C,EAC1C,aAAkD;IAElD,MAAM,YAAY,GAAG,oBAAoB,IAAI,sBAAsB,CAAC;IACpE,MAAM,cAAc,GAAG,qBAAqB,IAAI,KAAK,CAAC;IACtD,IAAI,aAAa,KAAK,IAAI,EAAE;QAC1B,OAAO,YAAY,CAAC;KACrB;IACD,IAAI,aAAa,KAAK,KAAK,EAAE;QAC3B,OAAO,SAAS,CAAC;KAClB;IACD,OAAO,aAAa,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACtE,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,EAAgE,EAChE,EAAE,QAAQ,EAAE,cAAc,EAAmB;IAE7C,OAAO;QACL,QAAQ,EAAE,MAAM,oBAAoB,CAAC,EAAE,CAAC;QACxC,MAAM,EAAE,eAAe,CAAC,EAAE,CAAC;QAC3B,MAAM,EAAE;YACN,QAAQ,EAAE,QAAQ,IAAI,kBAAkB,EAAE;YAC1C,cAAc,EAAE,cAAc,IAAI,uBAAuB;SAC1D;KACF,CAAC;AACJ,CAAC;AAkED,uDAAuD;AACvD,MAAM,CAAC,GAAG,EAAmD,CAAC;AAE9D,SAAS,QAAQ,CAAC,OAA0B;IAC1C,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;KACnB;IACD,IAAI,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE;QACrD,OAAO,OAAO,CAAC,KAAK,CAAC;KACtB;IACD,IAAI,UAAU,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE;QAC3D,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;KACtC;IACD,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;AACpB,CAAC;AAED,SAAS,kBAAkB;IACzB,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE;QAClC,IACE,CAAC,QAAQ,CAAC,OAAO;aACd,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAe,CAAC;aAC7B,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAC3C;YACA,OAAO,CAAC,IAAI,CACV,sBAAsB,OAAO,CAAC,GAAG,CAAC,kBAAkB,yBAAyB,CAC9E,CAAC;SACH;aAAM;YACL,OAAO,OAAO,CAAC,GAAG,CAAC,kBAA8B,CAAC;SACnD;KACF;IACD,OAAO,iBAAiB,CAAC;AAC3B,CAAC"}

package/dist/esm/client/utils.d.ts

@@ -0,0 +1,16 @@
+import { Expand, FunctionReference, GenericMutationCtx, GenericQueryCtx } from "convex/server";
+import { GenericId } from "convex/values";
+import { GenericDataModel } from "convex/server";
+export type RunQueryCtx = {
+    runQuery: GenericQueryCtx<GenericDataModel>["runQuery"];
+};
+export type RunMutationCtx = {
+    runMutation: GenericMutationCtx<GenericDataModel>["runMutation"];
+};
+export type OpaqueIds<T> = T extends GenericId<infer _T> ? string : T extends (infer U)[] ? OpaqueIds<U>[] : T extends object ? {
+    [K in keyof T]: OpaqueIds<T[K]>;
+} : T;
+export type UseApi<API> = Expand<{
+    [mod in keyof API]: API[mod] extends FunctionReference<infer FType, "public", infer FArgs, infer FReturnType, infer FComponentPath> ? FunctionReference<FType, "internal", OpaqueIds<FArgs>, OpaqueIds<FReturnType>, FComponentPath> : UseApi<API[mod]>;
+}>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/esm/client/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/client/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAIjD,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;CACzD,CAAC;AACF,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,CAAC;CAClE,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,IACrB,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,CAAC,GACzB,MAAM,GACN,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACnB,SAAS,CAAC,CAAC,CAAC,EAAE,GACd,CAAC,SAAS,MAAM,GACd;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACnC,CAAC,CAAC;AAEZ,MAAM,MAAM,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC;KAC9B,GAAG,IAAI,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,SAAS,iBAAiB,CACpD,MAAM,KAAK,EACX,QAAQ,EACR,MAAM,KAAK,EACX,MAAM,WAAW,EACjB,MAAM,cAAc,CACrB,GACG,iBAAiB,CACf,KAAK,EACL,UAAU,EACV,SAAS,CAAC,KAAK,CAAC,EAChB,SAAS,CAAC,WAAW,CAAC,EACtB,cAAc,CACf,GACD,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACrB,CAAC,CAAC"}

package/dist/esm/client/utils.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=utils.js.map

package/dist/esm/client/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/client/utils.ts"],"names":[],"mappings":""}

package/dist/esm/component/convex.config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"convex.config.d.ts","sourceRoot":"","sources":["../../../src/component/convex.config.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,SAAS,kDAA8B,CAAC;AAI9C,eAAe,SAAS,CAAC"}
+{"version":3,"file":"convex.config.d.ts","sourceRoot":"","sources":["../../../src/component/convex.config.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,SAAS,kDAA8B,CAAC;AAE9C,eAAe,SAAS,CAAC"}

package/dist/esm/component/convex.config.js

@@ -1,6 +1,4 @@
 import { defineComponent } from "convex/server";
-import crons from "@convex-dev/crons/convex.config";
 const component = defineComponent("workpool");
-component.use(crons);
 export default component;
 //# sourceMappingURL=convex.config.js.map

package/dist/esm/component/convex.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"convex.config.js","sourceRoot":"","sources":["../../../src/component/convex.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,MAAM,iCAAiC,CAAC;AAEpD,MAAM,SAAS,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;AAE9C,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AAErB,eAAe,SAAS,CAAC"}
+{"version":3,"file":"convex.config.js","sourceRoot":"","sources":["../../../src/component/convex.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,MAAM,SAAS,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;AAE9C,eAAe,SAAS,CAAC"}

package/dist/esm/component/kick.d.ts

@@ -0,0 +1,9 @@
+import { MutationCtx } from "./_generated/server.js";
+import { Config } from "./shared.js";
+export declare const DEFAULT_MAX_PARALLELISM = 10;
+/**
+ * Called from outside the loop:
+ */
+export declare function kickMainLoop(ctx: MutationCtx, source: "enqueue" | "cancel" | "saveResult" | "recovery", config?: Partial<Config>): Promise<void>;
+export declare const forceKick: import("convex/server").RegisteredMutation<"internal", {}, Promise<void>>;
+//# sourceMappingURL=kick.d.ts.map

package/dist/esm/component/kick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kick.d.ts","sourceRoot":"","sources":["../../../src/component/kick.ts"],"names":[],"mappings":"AACA,OAAO,EAAoB,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAGvE,OAAO,EAAE,MAAM,EAAe,MAAM,aAAa,CAAC;AAElD,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAC1C;;GAEG;AAEH,wBAAsB,YAAY,CAChC,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,YAAY,GAAG,UAAU,EACxD,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,GACvB,OAAO,CAAC,IAAI,CAAC,CA+Cf;AAED,eAAO,MAAM,SAAS,2EAOpB,CAAC"}

package/dist/esm/component/kick.js

@@ -0,0 +1,97 @@
+import { internal } from "./_generated/api.js";
+import { internalMutation } from "./_generated/server.js";
+import { createLogger, DEFAULT_LOG_LEVEL } from "./logging.js";
+import { INITIAL_STATE } from "./loop.js";
+import { nextSegment } from "./shared.js";
+export const DEFAULT_MAX_PARALLELISM = 10;
+/**
+ * Called from outside the loop:
+ */
+export async function kickMainLoop(ctx, source, config) {
+    const globals = await getOrUpdateGlobals(ctx, config);
+    const console = createLogger(globals.logLevel);
+    const runStatus = await getOrCreateRunStatus(ctx);
+    // Only kick to run now if we're scheduled or idle.
+    if (runStatus.state.kind === "running") {
+        console.debug(`[${source}] main is actively running, so we don't need to kick it`);
+        return;
+    }
+    const segment = nextSegment();
+    // main is scheduled to run later, so we should cancel it and reschedule.
+    if (runStatus.state.kind === "scheduled") {
+        if (source === "enqueue" && runStatus.state.saturated) {
+            console.debug(`[${source}] main is saturated, so we don't need to kick it`);
+            return;
+        }
+        if (runStatus.state.segment <= segment) {
+            console.debug(`[${source}] main is scheduled to run soon enough, so we don't need to kick it`);
+            return;
+        }
+        console.debug(`[${source}] main is scheduled to run later, so reschedule it to run now`);
+        const scheduled = await ctx.db.system.get(runStatus.state.scheduledId);
+        if (scheduled && scheduled.state.kind === "pending") {
+            await ctx.scheduler.cancel(runStatus.state.scheduledId);
+        }
+        else {
+            console.warn(`[${source}] main is marked as scheduled, but it's status is ${scheduled?.state.kind}`);
+        }
+    }
+    console.debug(`[${source}] main was scheduled later, so reschedule it to run now`);
+    await ctx.db.patch(runStatus._id, { state: { kind: "running" } });
+    await ctx.scheduler.runAfter(0, internal.loop.main, {
+        generation: runStatus.state.generation,
+        segment,
+    });
+}
+export const forceKick = internalMutation({
+    args: {},
+    handler: async (ctx) => {
+        const runStatus = await getOrCreateRunStatus(ctx);
+        await ctx.db.delete(runStatus._id);
+        await kickMainLoop(ctx, "recovery");
+    },
+});
+async function getOrCreateRunStatus(ctx) {
+    let runStatus = await ctx.db.query("runStatus").unique();
+    if (!runStatus) {
+        const state = await ctx.db.query("internalState").unique();
+        const id = await ctx.db.insert("runStatus", {
+            state: {
+                kind: "idle",
+                generation: state?.generation ?? INITIAL_STATE.generation,
+            },
+        });
+        runStatus = (await ctx.db.get(id));
+        if (!state) {
+            await ctx.db.insert("internalState", INITIAL_STATE);
+        }
+    }
+    return runStatus;
+}
+async function getOrUpdateGlobals(ctx, config) {
+    const globals = await ctx.db.query("globals").unique();
+    if (!globals) {
+        const id = await ctx.db.insert("globals", {
+            maxParallelism: config?.maxParallelism ?? DEFAULT_MAX_PARALLELISM,
+            logLevel: config?.logLevel ?? DEFAULT_LOG_LEVEL,
+        });
+        return (await ctx.db.get(id));
+    }
+    else if (config) {
+        let updated = false;
+        if (config.maxParallelism &&
+            config.maxParallelism !== globals.maxParallelism) {
+            globals.maxParallelism = config.maxParallelism;
+            updated = true;
+        }
+        if (config.logLevel && config.logLevel !== globals.logLevel) {
+            globals.logLevel = config.logLevel;
+            updated = true;
+        }
+        if (updated) {
+            await ctx.db.replace(globals._id, globals);
+        }
+    }
+    return globals;
+}
+//# sourceMappingURL=kick.js.map

package/dist/esm/component/kick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kick.js","sourceRoot":"","sources":["../../../src/component/kick.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAe,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAU,WAAW,EAAE,MAAM,aAAa,CAAC;AAElD,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAC1C;;GAEG;AAEH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,GAAgB,EAChB,MAAwD,EACxD,MAAwB;IAExB,MAAM,OAAO,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC/C,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAElD,mDAAmD;IACnD,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE;QACtC,OAAO,CAAC,KAAK,CACX,IAAI,MAAM,yDAAyD,CACpE,CAAC;QACF,OAAO;KACR;IACD,MAAM,OAAO,GAAG,WAAW,EAAE,CAAC;IAC9B,yEAAyE;IACzE,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE;QACxC,IAAI,MAAM,KAAK,SAAS,IAAI,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE;YACrD,OAAO,CAAC,KAAK,CACX,IAAI,MAAM,kDAAkD,CAC7D,CAAC;YACF,OAAO;SACR;QACD,IAAI,SAAS,CAAC,KAAK,CAAC,OAAO,IAAI,OAAO,EAAE;YACtC,OAAO,CAAC,KAAK,CACX,IAAI,MAAM,qEAAqE,CAChF,CAAC;YACF,OAAO;SACR;QACD,OAAO,CAAC,KAAK,CACX,IAAI,MAAM,+DAA+D,CAC1E,CAAC;QACF,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,SAAS,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE;YACnD,MAAM,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;SACzD;aAAM;YACL,OAAO,CAAC,IAAI,CACV,IAAI,MAAM,qDAAqD,SAAS,EAAE,KAAK,CAAC,IAAI,EAAE,CACvF,CAAC;SACH;KACF;IACD,OAAO,CAAC,KAAK,CACX,IAAI,MAAM,yDAAyD,CACpE,CAAC;IACF,MAAM,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IAClE,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;QAClD,UAAU,EAAE,SAAS,CAAC,KAAK,CAAC,UAAU;QACtC,OAAO;KACR,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,gBAAgB,CAAC;IACxC,IAAI,EAAE,EAAE;IACR,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACrB,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAClD,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,YAAY,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC;CACF,CAAC,CAAC;AAEH,KAAK,UAAU,oBAAoB,CAAC,GAAgB;IAClD,IAAI,SAAS,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE,CAAC;IACzD,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC;QAC3D,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE;YAC1C,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE,KAAK,EAAE,UAAU,IAAI,aAAa,CAAC,UAAU;aAC1D;SACF,CAAC,CAAC;QACH,SAAS,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAE,CAAC;QACpC,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;SACrD;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,kBAAkB,CAAC,GAAgB,EAAE,MAAwB;IAC1E,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,CAAC;IACvD,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE;YACxC,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,uBAAuB;YACjE,QAAQ,EAAE,MAAM,EAAE,QAAQ,IAAI,iBAAiB;SAChD,CAAC,CAAC;QACH,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAE,CAAC;KAChC;SAAM,IAAI,MAAM,EAAE;QACjB,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IACE,MAAM,CAAC,cAAc;YACrB,MAAM,CAAC,cAAc,KAAK,OAAO,CAAC,cAAc,EAChD;YACA,OAAO,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;YAC/C,OAAO,GAAG,IAAI,CAAC;SAChB;QACD,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ,EAAE;YAC3D,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;YACnC,OAAO,GAAG,IAAI,CAAC;SAChB;QACD,IAAI,OAAO,EAAE;YACX,MAAM,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SAC5C;KACF;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/esm/component/lib.d.ts

@@ -1,50 +1,41 @@
 export declare const enqueue: import("convex/server").RegisteredMutation<"public", {
-    fnType: "action" | "mutation";
+    onComplete?: {
+        context?: any;
+        fnHandle: string;
+    } | undefined;
+    retryBehavior?: {
+        maxAttempts: number;
+        initialBackoffMs: number;
+        base: number;
+    } | undefined;
     fnHandle: string;
+    fnType: "action" | "mutation";
     fnName: string;
     fnArgs: any;
-    options: {
-        statusTtl?: number | undefined;
-        logLevel?: "DEBUG" | "INFO" | "WARN" | "ERROR" | undefined;
+    runAt: number;
+    config: {
         maxParallelism: number;
+        logLevel: "DEBUG" | "INFO" | "WARN" | "ERROR";
     };
 }, Promise<import("convex/values").GenericId<"work">>>;
 export declare const cancel: import("convex/server").RegisteredMutation<"public", {
     id: import("convex/values").GenericId<"work">;
+    logLevel: "DEBUG" | "INFO" | "WARN" | "ERROR";
 }, Promise<void>>;
-export declare const mainLoop: import("convex/server").RegisteredMutation<"internal", {
-    generation: number;
-}, Promise<void>>;
-export declare const runActionWrapper: import("convex/server").RegisteredAction<"internal", {
-    fnHandle: string;
-    fnArgs: any;
-    workId: import("convex/values").GenericId<"work">;
-}, Promise<void>>;
-export declare const saveResult: import("convex/server").RegisteredMutation<"internal", {
-    workId: import("convex/values").GenericId<"work">;
-    completionStatus: "success" | "error" | "canceled" | "timeout";
+export declare const cancelAll: import("convex/server").RegisteredMutation<"public", {
+    before?: number | undefined;
+    logLevel: "DEBUG" | "INFO" | "WARN" | "ERROR";
 }, Promise<void>>;
-export declare const bumpGeneration: import("convex/server").RegisteredMutation<"internal", {}, Promise<void>>;
-export declare const runMutationWrapper: import("convex/server").RegisteredMutation<"internal", {
-    fnHandle: string;
-    fnArgs: any;
-    workId: import("convex/values").GenericId<"work">;
-}, Promise<void>>;
-export declare const stopCleanup: import("convex/server").RegisteredMutation<"public", {}, Promise<void>>;
 export declare const status: import("convex/server").RegisteredQuery<"public", {
     id: import("convex/values").GenericId<"work">;
 }, Promise<{
-    readonly kind: "completed";
-    readonly completionStatus: "success" | "error" | "canceled" | "timeout";
+    readonly state: "finished";
+    readonly attempt?: undefined;
 } | {
-    readonly kind: "pending";
-    readonly completionStatus?: undefined;
+    readonly state: "pending";
+    readonly attempt: number;
 } | {
-    readonly kind: "inProgress";
-    readonly completionStatus?: undefined;
+    readonly state: "running";
+    readonly attempt: number;
 }>>;
-export declare const MAX_CLEANUP_DOCS = 1000;
-export declare const cleanup: import("convex/server").RegisteredMutation<"public", {
-    maxAgeMs: number;
-}, Promise<void>>;
 //# sourceMappingURL=lib.d.ts.map

package/dist/esm/component/lib.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../../src/component/lib.ts"],"names":[],"mappings":"AAuBA,eAAO,MAAM,OAAO;;;;;;;;;;sDAiClB,CAAC;AAEH,eAAO,MAAM,MAAM;;iBAOjB,CAAC;AAiBH,eAAO,MAAM,QAAQ;;iBA8OnB,CAAC;AA+EH,eAAO,MAAM,gBAAgB;;;;iBAyB3B,CAAC;AAEH,eAAO,MAAM,UAAU;;;iBAiBrB,CAAC;AAEH,eAAO,MAAM,cAAc,2EAczB,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;iBAyB7B,CAAC;AAUH,eAAO,MAAM,WAAW,yEAQtB,CAAC;AAiEH,eAAO,MAAM,MAAM;;;;;;;;;;;GAuCjB,CAAC;AAEH,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAErC,eAAO,MAAM,OAAO;;iBA2BlB,CAAC"}
+{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../../src/component/lib.ts"],"names":[],"mappings":"AAkBA,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;sDAkClB,CAAC;AAEH,eAAO,MAAM,MAAM;;;iBAajB,CAAC;AAGH,eAAO,MAAM,SAAS;;;iBA+BpB,CAAC;AAEH,eAAO,MAAM,MAAM;;;;;;;;;;;GAkBjB,CAAC"}