@convex-dev/workpool 0.2.7-alpha.3 → 0.2.7-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commonjs/client/index.d.ts +30 -51
- package/dist/commonjs/client/index.d.ts.map +1 -1
- package/dist/commonjs/client/index.js +2 -2
- package/dist/commonjs/client/index.js.map +1 -1
- package/dist/esm/client/index.d.ts +30 -51
- package/dist/esm/client/index.d.ts.map +1 -1
- package/dist/esm/client/index.js +2 -2
- package/dist/esm/client/index.js.map +1 -1
- package/package.json +1 -1
- package/src/client/index.ts +32 -31
|
@@ -30,33 +30,36 @@ export type RetryOption = {
|
|
|
30
30
|
*/
|
|
31
31
|
retry?: boolean | RetryBehavior;
|
|
32
32
|
};
|
|
33
|
+
export type WorkpoolOptions = {
|
|
34
|
+
/** How many actions/mutations can be running at once within this pool.
|
|
35
|
+
* Min 1, Max 300.
|
|
36
|
+
*/
|
|
37
|
+
maxParallelism?: number;
|
|
38
|
+
/** How much to log. This is updated on each call to `enqueue*`,
|
|
39
|
+
* `status`, or `cancel*`.
|
|
40
|
+
* Default is REPORT, which logs warnings, errors, and a periodic report.
|
|
41
|
+
* With INFO, you can also see events for started and completed work.
|
|
42
|
+
* Stats generated can be parsed by tools like
|
|
43
|
+
* [Axiom](https://axiom.co) for monitoring.
|
|
44
|
+
* With DEBUG, you can see timers and internal events for work being
|
|
45
|
+
* scheduled.
|
|
46
|
+
*/
|
|
47
|
+
logLevel?: LogLevel;
|
|
48
|
+
} & WorkpoolRetryOptions;
|
|
49
|
+
export type WorkpoolRetryOptions = {
|
|
50
|
+
/** Default retry behavior for enqueued actions.
|
|
51
|
+
* See {@link RetryBehavior}.
|
|
52
|
+
*/
|
|
53
|
+
defaultRetryBehavior?: RetryBehavior;
|
|
54
|
+
/** Whether to retry actions that fail by default. Default: false.
|
|
55
|
+
* NOTE: Only enable this if your actions are idempotent.
|
|
56
|
+
* See the docs (README.md) for more details.
|
|
57
|
+
*/
|
|
58
|
+
retryActionsByDefault?: boolean;
|
|
59
|
+
};
|
|
33
60
|
export declare class Workpool {
|
|
34
61
|
private component;
|
|
35
|
-
options:
|
|
36
|
-
/** How many actions/mutations can be running at once within this pool.
|
|
37
|
-
* Min 1, Max 300.
|
|
38
|
-
*/
|
|
39
|
-
maxParallelism?: number;
|
|
40
|
-
/** How much to log. This is updated on each call to `enqueue*`,
|
|
41
|
-
* `status`, or `cancel*`.
|
|
42
|
-
* Default is REPORT, which logs warnings, errors, and a periodic report.
|
|
43
|
-
* With INFO, you can also see events for started and completed work.
|
|
44
|
-
* Stats generated can be parsed by tools like
|
|
45
|
-
* [Axiom](https://axiom.co) for monitoring.
|
|
46
|
-
* With DEBUG, you can see timers and internal events for work being
|
|
47
|
-
* scheduled.
|
|
48
|
-
*/
|
|
49
|
-
logLevel?: LogLevel;
|
|
50
|
-
/** Default retry behavior for enqueued actions.
|
|
51
|
-
* See {@link RetryBehavior}.
|
|
52
|
-
*/
|
|
53
|
-
defaultRetryBehavior?: RetryBehavior;
|
|
54
|
-
/** Whether to retry actions that fail by default. Default: false.
|
|
55
|
-
* NOTE: Only enable this if your actions are idempotent.
|
|
56
|
-
* See the docs (README.md) for more details.
|
|
57
|
-
*/
|
|
58
|
-
retryActionsByDefault?: boolean;
|
|
59
|
-
};
|
|
62
|
+
options: WorkpoolOptions;
|
|
60
63
|
/**
|
|
61
64
|
* Initializes a Workpool.
|
|
62
65
|
*
|
|
@@ -66,34 +69,10 @@ export declare class Workpool {
|
|
|
66
69
|
*
|
|
67
70
|
* @param component - The component to use, like `components.workpool` from
|
|
68
71
|
* `./_generated/api.ts`.
|
|
69
|
-
* @param options - The
|
|
72
|
+
* @param options - The {@link WorkpoolOptions} for the Workpool.
|
|
70
73
|
*/
|
|
71
74
|
constructor(component: UseApi<Mounts>, // UseApi<api> for jump to definition
|
|
72
|
-
options:
|
|
73
|
-
/** How many actions/mutations can be running at once within this pool.
|
|
74
|
-
* Min 1, Max 300.
|
|
75
|
-
*/
|
|
76
|
-
maxParallelism?: number;
|
|
77
|
-
/** How much to log. This is updated on each call to `enqueue*`,
|
|
78
|
-
* `status`, or `cancel*`.
|
|
79
|
-
* Default is REPORT, which logs warnings, errors, and a periodic report.
|
|
80
|
-
* With INFO, you can also see events for started and completed work.
|
|
81
|
-
* Stats generated can be parsed by tools like
|
|
82
|
-
* [Axiom](https://axiom.co) for monitoring.
|
|
83
|
-
* With DEBUG, you can see timers and internal events for work being
|
|
84
|
-
* scheduled.
|
|
85
|
-
*/
|
|
86
|
-
logLevel?: LogLevel;
|
|
87
|
-
/** Default retry behavior for enqueued actions.
|
|
88
|
-
* See {@link RetryBehavior}.
|
|
89
|
-
*/
|
|
90
|
-
defaultRetryBehavior?: RetryBehavior;
|
|
91
|
-
/** Whether to retry actions that fail by default. Default: false.
|
|
92
|
-
* NOTE: Only enable this if your actions are idempotent.
|
|
93
|
-
* See the docs (README.md) for more details.
|
|
94
|
-
*/
|
|
95
|
-
retryActionsByDefault?: boolean;
|
|
96
|
-
});
|
|
75
|
+
options: WorkpoolOptions);
|
|
97
76
|
/**
|
|
98
77
|
* Enqueues an action to be run.
|
|
99
78
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,mBAAmB,EAEnB,iBAAiB,EAEjB,kBAAkB,EAEnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,mBAAmB,EAEnB,iBAAiB,EAEjB,kBAAkB,EAEnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,EAAqB,KAAK,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAIL,SAAS,IAAI,eAAe,EAC5B,KAAK,aAAa,EAClB,SAAS,EAET,MAAM,EACP,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,KAAK,SAAS,EAAE,KAAK,aAAa,EAAE,CAAC;AAC/D,OAAO,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,KAAK,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,eAAe,IAAI,gBAAgB,EAAE,CAAC;AAG/C,eAAO,MAAM,sBAAsB,EAAE,aAIpC,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE,CAAC;AACnD,eAAO,MAAM,eAAe,6BAAgC,CAAC;AAC7D,OAAO,EAAE,eAAe,IAAI,gBAAgB,EAAE,CAAC;AAE/C,MAAM,MAAM,UAAU,GAAG;IACvB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,GAAG,oBAAoB,CAAC;AAEzB,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,aAAa,CAAC;IACrC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF,qBAAa,QAAQ;IAajB,OAAO,CAAC,SAAS;IACV,OAAO,EAAE,eAAe;IAbjC;;;;;;;;;;OAUG;gBAEO,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,qCAAqC;IACjE,OAAO,EAAE,eAAe;IAEjC;;;;;;;;;OASG;IACG,aAAa,CAAC,IAAI,SAAS,mBAAmB,EAAE,UAAU,EAC9D,GAAG,EAAE,cAAc,EACnB,EAAE,EAAE,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,IAAI,EAAE,UAAU,CAAC,EACrE,MAAM,EAAE,IAAI,EACZ,OAAO,CAAC,EAAE,WAAW,GAAG,eAAe,GAAG,gBAAgB,GAAG,UAAU,GACtE,OAAO,CAAC,MAAM,CAAC;IAuBlB;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,IAAI,SAAS,mBAAmB,EAAE,UAAU,EAChE,GAAG,EAAE,cAAc,EACnB,EAAE,EAAE,iBAAiB,CAAC,UAAU,EAAE,kBAAkB,EAAE,IAAI,EAAE,UAAU,CAAC,EACvE,MAAM,EAAE,IAAI,EACZ,OAAO,CAAC,EAAE,eAAe,GAAG,gBAAgB,GAAG,UAAU,GACxD,OAAO,CAAC,MAAM,CAAC;IAiBZ,YAAY,CAAC,IAAI,SAAS,mBAAmB,EAAE,UAAU,EAC7D,GAAG,EAAE,cAAc,EACnB,EAAE,EAAE,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,UAAU,CAAC,EACpE,MAAM,EAAE,IAAI,EACZ,OAAO,CAAC,EAAE,eAAe,GAAG,gBAAgB,GAAG,UAAU,GACxD,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;OAMG;IACG,MAAM,CAAC,GAAG,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5D;;;;OAIG;IACG,SAAS,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKnD;;;;;;;;;OASG;IACG,MAAM,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAG5D;AAED,MAAM,MAAM,gBAAgB,GACxB;IACE;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEN,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAC5B,UAAU,EACV,kBAAkB,EAClB,cAAc,CACf,GAAG,IAAI,CAAC;IAET;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { createFunctionHandle, getFunctionName, } from "convex/server";
|
|
2
2
|
import { v } from "convex/values";
|
|
3
|
-
import { DEFAULT_LOG_LEVEL
|
|
3
|
+
import { DEFAULT_LOG_LEVEL } from "../component/logging.js";
|
|
4
4
|
import { DEFAULT_MAX_PARALLELISM, runResult as resultValidator, } from "../component/shared.js";
|
|
5
5
|
export { resultValidator };
|
|
6
6
|
export { retryBehavior as vRetryBehavior } from "../component/shared.js";
|
|
@@ -26,7 +26,7 @@ export class Workpool {
|
|
|
26
26
|
*
|
|
27
27
|
* @param component - The component to use, like `components.workpool` from
|
|
28
28
|
* `./_generated/api.ts`.
|
|
29
|
-
* @param options - The
|
|
29
|
+
* @param options - The {@link WorkpoolOptions} for the Workpool.
|
|
30
30
|
*/
|
|
31
31
|
constructor(component, // UseApi<api> for jump to definition
|
|
32
32
|
options) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EAMpB,eAAe,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAW,MAAM,eAAe,CAAC;AAE3C,OAAO,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EAMpB,eAAe,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAW,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAE,iBAAiB,EAAiB,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAEL,uBAAuB,EAEvB,SAAS,IAAI,eAAe,GAK7B,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,eAAe,EAAsC,CAAC;AAC/D,OAAO,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAiB,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,eAAe,IAAI,gBAAgB,EAAE,CAAC;AAE/C,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;AAC7D,OAAO,EAAE,eAAe,IAAI,gBAAgB,EAAE,CAAC;AAiD/C,MAAM,OAAO,QAAQ;IAaT;IACD;IAbT;;;;;;;;;;OAUG;IACH,YACU,SAAyB,EAAE,qCAAqC;IACjE,OAAwB;QADvB,cAAS,GAAT,SAAS,CAAgB;QAC1B,YAAO,GAAP,OAAO,CAAiB;IAC9B,CAAC;IACJ;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,GAAmB,EACnB,EAAqE,EACrE,MAAY,EACZ,OAAuE;QAEvE,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,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9D,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,OAAyD;QAEzD,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,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9D,MAAM;YACN,MAAM,EAAE,UAAU;YAClB,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;YACxB,UAAU;SACX,CAAC,CAAC;QACH,OAAO,EAAY,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,GAAmB,EACnB,EAAoE,EACpE,MAAY,EACZ,OAAyD;QAEzD,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,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9D,MAAM;YACN,MAAM,EAAE,OAAO;YACf,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;YACxB,UAAU;SACX,CAAC,CAAC;QACH,OAAO,EAAY,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACH,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,iBAAiB;SACrD,CAAC,CAAC;IACL,CAAC;IACD;;;;OAIG;IACH,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,iBAAiB;SACrD,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;OASG;IACH,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;AAkED,uDAAuD;AACvD,MAAM,CAAC,GAAG,EAAmD,CAAC;AAE9D,EAAE;AACF,mBAAmB;AACnB,EAAE;AAEF,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,EAEqD,EACrD,IAAwB,EACxB,EAAE,QAAQ,EAAE,cAAc,EAAmB;IAE7C,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,GACtB,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC;QACpD,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;QAClB,CAAC,CAAC,CAAC,MAAM,oBAAoB,CAAC,EAAE,CAAC,EAAE,IAAI,IAAI,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;IACpE,OAAO;QACL,QAAQ;QACR,MAAM;QACN,MAAM,EAAE;YACN,QAAQ,EAAE,QAAQ,IAAI,iBAAiB;YACvC,cAAc,EAAE,cAAc,IAAI,uBAAuB;SAC1D;KACF,CAAC;AACJ,CAAC;AAED,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"}
|
|
@@ -30,33 +30,36 @@ export type RetryOption = {
|
|
|
30
30
|
*/
|
|
31
31
|
retry?: boolean | RetryBehavior;
|
|
32
32
|
};
|
|
33
|
+
export type WorkpoolOptions = {
|
|
34
|
+
/** How many actions/mutations can be running at once within this pool.
|
|
35
|
+
* Min 1, Max 300.
|
|
36
|
+
*/
|
|
37
|
+
maxParallelism?: number;
|
|
38
|
+
/** How much to log. This is updated on each call to `enqueue*`,
|
|
39
|
+
* `status`, or `cancel*`.
|
|
40
|
+
* Default is REPORT, which logs warnings, errors, and a periodic report.
|
|
41
|
+
* With INFO, you can also see events for started and completed work.
|
|
42
|
+
* Stats generated can be parsed by tools like
|
|
43
|
+
* [Axiom](https://axiom.co) for monitoring.
|
|
44
|
+
* With DEBUG, you can see timers and internal events for work being
|
|
45
|
+
* scheduled.
|
|
46
|
+
*/
|
|
47
|
+
logLevel?: LogLevel;
|
|
48
|
+
} & WorkpoolRetryOptions;
|
|
49
|
+
export type WorkpoolRetryOptions = {
|
|
50
|
+
/** Default retry behavior for enqueued actions.
|
|
51
|
+
* See {@link RetryBehavior}.
|
|
52
|
+
*/
|
|
53
|
+
defaultRetryBehavior?: RetryBehavior;
|
|
54
|
+
/** Whether to retry actions that fail by default. Default: false.
|
|
55
|
+
* NOTE: Only enable this if your actions are idempotent.
|
|
56
|
+
* See the docs (README.md) for more details.
|
|
57
|
+
*/
|
|
58
|
+
retryActionsByDefault?: boolean;
|
|
59
|
+
};
|
|
33
60
|
export declare class Workpool {
|
|
34
61
|
private component;
|
|
35
|
-
options:
|
|
36
|
-
/** How many actions/mutations can be running at once within this pool.
|
|
37
|
-
* Min 1, Max 300.
|
|
38
|
-
*/
|
|
39
|
-
maxParallelism?: number;
|
|
40
|
-
/** How much to log. This is updated on each call to `enqueue*`,
|
|
41
|
-
* `status`, or `cancel*`.
|
|
42
|
-
* Default is REPORT, which logs warnings, errors, and a periodic report.
|
|
43
|
-
* With INFO, you can also see events for started and completed work.
|
|
44
|
-
* Stats generated can be parsed by tools like
|
|
45
|
-
* [Axiom](https://axiom.co) for monitoring.
|
|
46
|
-
* With DEBUG, you can see timers and internal events for work being
|
|
47
|
-
* scheduled.
|
|
48
|
-
*/
|
|
49
|
-
logLevel?: LogLevel;
|
|
50
|
-
/** Default retry behavior for enqueued actions.
|
|
51
|
-
* See {@link RetryBehavior}.
|
|
52
|
-
*/
|
|
53
|
-
defaultRetryBehavior?: RetryBehavior;
|
|
54
|
-
/** Whether to retry actions that fail by default. Default: false.
|
|
55
|
-
* NOTE: Only enable this if your actions are idempotent.
|
|
56
|
-
* See the docs (README.md) for more details.
|
|
57
|
-
*/
|
|
58
|
-
retryActionsByDefault?: boolean;
|
|
59
|
-
};
|
|
62
|
+
options: WorkpoolOptions;
|
|
60
63
|
/**
|
|
61
64
|
* Initializes a Workpool.
|
|
62
65
|
*
|
|
@@ -66,34 +69,10 @@ export declare class Workpool {
|
|
|
66
69
|
*
|
|
67
70
|
* @param component - The component to use, like `components.workpool` from
|
|
68
71
|
* `./_generated/api.ts`.
|
|
69
|
-
* @param options - The
|
|
72
|
+
* @param options - The {@link WorkpoolOptions} for the Workpool.
|
|
70
73
|
*/
|
|
71
74
|
constructor(component: UseApi<Mounts>, // UseApi<api> for jump to definition
|
|
72
|
-
options:
|
|
73
|
-
/** How many actions/mutations can be running at once within this pool.
|
|
74
|
-
* Min 1, Max 300.
|
|
75
|
-
*/
|
|
76
|
-
maxParallelism?: number;
|
|
77
|
-
/** How much to log. This is updated on each call to `enqueue*`,
|
|
78
|
-
* `status`, or `cancel*`.
|
|
79
|
-
* Default is REPORT, which logs warnings, errors, and a periodic report.
|
|
80
|
-
* With INFO, you can also see events for started and completed work.
|
|
81
|
-
* Stats generated can be parsed by tools like
|
|
82
|
-
* [Axiom](https://axiom.co) for monitoring.
|
|
83
|
-
* With DEBUG, you can see timers and internal events for work being
|
|
84
|
-
* scheduled.
|
|
85
|
-
*/
|
|
86
|
-
logLevel?: LogLevel;
|
|
87
|
-
/** Default retry behavior for enqueued actions.
|
|
88
|
-
* See {@link RetryBehavior}.
|
|
89
|
-
*/
|
|
90
|
-
defaultRetryBehavior?: RetryBehavior;
|
|
91
|
-
/** Whether to retry actions that fail by default. Default: false.
|
|
92
|
-
* NOTE: Only enable this if your actions are idempotent.
|
|
93
|
-
* See the docs (README.md) for more details.
|
|
94
|
-
*/
|
|
95
|
-
retryActionsByDefault?: boolean;
|
|
96
|
-
});
|
|
75
|
+
options: WorkpoolOptions);
|
|
97
76
|
/**
|
|
98
77
|
* Enqueues an action to be run.
|
|
99
78
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,mBAAmB,EAEnB,iBAAiB,EAEjB,kBAAkB,EAEnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,mBAAmB,EAEnB,iBAAiB,EAEjB,kBAAkB,EAEnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,EAAqB,KAAK,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAIL,SAAS,IAAI,eAAe,EAC5B,KAAK,aAAa,EAClB,SAAS,EAET,MAAM,EACP,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,KAAK,SAAS,EAAE,KAAK,aAAa,EAAE,CAAC;AAC/D,OAAO,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,KAAK,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,eAAe,IAAI,gBAAgB,EAAE,CAAC;AAG/C,eAAO,MAAM,sBAAsB,EAAE,aAIpC,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE,CAAC;AACnD,eAAO,MAAM,eAAe,6BAAgC,CAAC;AAC7D,OAAO,EAAE,eAAe,IAAI,gBAAgB,EAAE,CAAC;AAE/C,MAAM,MAAM,UAAU,GAAG;IACvB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,GAAG,oBAAoB,CAAC;AAEzB,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,aAAa,CAAC;IACrC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF,qBAAa,QAAQ;IAajB,OAAO,CAAC,SAAS;IACV,OAAO,EAAE,eAAe;IAbjC;;;;;;;;;;OAUG;gBAEO,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,qCAAqC;IACjE,OAAO,EAAE,eAAe;IAEjC;;;;;;;;;OASG;IACG,aAAa,CAAC,IAAI,SAAS,mBAAmB,EAAE,UAAU,EAC9D,GAAG,EAAE,cAAc,EACnB,EAAE,EAAE,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,IAAI,EAAE,UAAU,CAAC,EACrE,MAAM,EAAE,IAAI,EACZ,OAAO,CAAC,EAAE,WAAW,GAAG,eAAe,GAAG,gBAAgB,GAAG,UAAU,GACtE,OAAO,CAAC,MAAM,CAAC;IAuBlB;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,IAAI,SAAS,mBAAmB,EAAE,UAAU,EAChE,GAAG,EAAE,cAAc,EACnB,EAAE,EAAE,iBAAiB,CAAC,UAAU,EAAE,kBAAkB,EAAE,IAAI,EAAE,UAAU,CAAC,EACvE,MAAM,EAAE,IAAI,EACZ,OAAO,CAAC,EAAE,eAAe,GAAG,gBAAgB,GAAG,UAAU,GACxD,OAAO,CAAC,MAAM,CAAC;IAiBZ,YAAY,CAAC,IAAI,SAAS,mBAAmB,EAAE,UAAU,EAC7D,GAAG,EAAE,cAAc,EACnB,EAAE,EAAE,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,UAAU,CAAC,EACpE,MAAM,EAAE,IAAI,EACZ,OAAO,CAAC,EAAE,eAAe,GAAG,gBAAgB,GAAG,UAAU,GACxD,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;OAMG;IACG,MAAM,CAAC,GAAG,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5D;;;;OAIG;IACG,SAAS,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKnD;;;;;;;;;OASG;IACG,MAAM,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAG5D;AAED,MAAM,MAAM,gBAAgB,GACxB;IACE;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEN,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAC5B,UAAU,EACV,kBAAkB,EAClB,cAAc,CACf,GAAG,IAAI,CAAC;IAET;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB,CAAC"}
|
package/dist/esm/client/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { createFunctionHandle, getFunctionName, } from "convex/server";
|
|
2
2
|
import { v } from "convex/values";
|
|
3
|
-
import { DEFAULT_LOG_LEVEL
|
|
3
|
+
import { DEFAULT_LOG_LEVEL } from "../component/logging.js";
|
|
4
4
|
import { DEFAULT_MAX_PARALLELISM, runResult as resultValidator, } from "../component/shared.js";
|
|
5
5
|
export { resultValidator };
|
|
6
6
|
export { retryBehavior as vRetryBehavior } from "../component/shared.js";
|
|
@@ -26,7 +26,7 @@ export class Workpool {
|
|
|
26
26
|
*
|
|
27
27
|
* @param component - The component to use, like `components.workpool` from
|
|
28
28
|
* `./_generated/api.ts`.
|
|
29
|
-
* @param options - The
|
|
29
|
+
* @param options - The {@link WorkpoolOptions} for the Workpool.
|
|
30
30
|
*/
|
|
31
31
|
constructor(component, // UseApi<api> for jump to definition
|
|
32
32
|
options) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EAMpB,eAAe,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAW,MAAM,eAAe,CAAC;AAE3C,OAAO,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EAMpB,eAAe,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAW,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAE,iBAAiB,EAAiB,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAEL,uBAAuB,EAEvB,SAAS,IAAI,eAAe,GAK7B,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,eAAe,EAAsC,CAAC;AAC/D,OAAO,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAiB,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,eAAe,IAAI,gBAAgB,EAAE,CAAC;AAE/C,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;AAC7D,OAAO,EAAE,eAAe,IAAI,gBAAgB,EAAE,CAAC;AAiD/C,MAAM,OAAO,QAAQ;IAaT;IACD;IAbT;;;;;;;;;;OAUG;IACH,YACU,SAAyB,EAAE,qCAAqC;IACjE,OAAwB;QADvB,cAAS,GAAT,SAAS,CAAgB;QAC1B,YAAO,GAAP,OAAO,CAAiB;IAC9B,CAAC;IACJ;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,GAAmB,EACnB,EAAqE,EACrE,MAAY,EACZ,OAAuE;QAEvE,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,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9D,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,OAAyD;QAEzD,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,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9D,MAAM;YACN,MAAM,EAAE,UAAU;YAClB,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;YACxB,UAAU;SACX,CAAC,CAAC;QACH,OAAO,EAAY,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,GAAmB,EACnB,EAAoE,EACpE,MAAY,EACZ,OAAyD;QAEzD,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,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9D,MAAM;YACN,MAAM,EAAE,OAAO;YACf,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;YACxB,UAAU;SACX,CAAC,CAAC;QACH,OAAO,EAAY,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACH,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,iBAAiB;SACrD,CAAC,CAAC;IACL,CAAC;IACD;;;;OAIG;IACH,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,iBAAiB;SACrD,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;OASG;IACH,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;AAkED,uDAAuD;AACvD,MAAM,CAAC,GAAG,EAAmD,CAAC;AAE9D,EAAE;AACF,mBAAmB;AACnB,EAAE;AAEF,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,EAEqD,EACrD,IAAwB,EACxB,EAAE,QAAQ,EAAE,cAAc,EAAmB;IAE7C,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,GACtB,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC;QACpD,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;QAClB,CAAC,CAAC,CAAC,MAAM,oBAAoB,CAAC,EAAE,CAAC,EAAE,IAAI,IAAI,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;IACpE,OAAO;QACL,QAAQ;QACR,MAAM;QACN,MAAM,EAAE;YACN,QAAQ,EAAE,QAAQ,IAAI,iBAAiB;YACvC,cAAc,EAAE,cAAc,IAAI,uBAAuB;SAC1D;KACF,CAAC;AACJ,CAAC;AAED,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"}
|
package/package.json
CHANGED
package/src/client/index.ts
CHANGED
|
@@ -9,11 +9,7 @@ import {
|
|
|
9
9
|
} from "convex/server";
|
|
10
10
|
import { v, VString } from "convex/values";
|
|
11
11
|
import { Mounts } from "../component/_generated/api.js";
|
|
12
|
-
import {
|
|
13
|
-
DEFAULT_LOG_LEVEL,
|
|
14
|
-
type LogLevel,
|
|
15
|
-
logLevel,
|
|
16
|
-
} from "../component/logging.js";
|
|
12
|
+
import { DEFAULT_LOG_LEVEL, type LogLevel } from "../component/logging.js";
|
|
17
13
|
import {
|
|
18
14
|
Config,
|
|
19
15
|
DEFAULT_MAX_PARALLELISM,
|
|
@@ -58,6 +54,35 @@ export type RetryOption = {
|
|
|
58
54
|
retry?: boolean | RetryBehavior;
|
|
59
55
|
};
|
|
60
56
|
|
|
57
|
+
export type WorkpoolOptions = {
|
|
58
|
+
/** How many actions/mutations can be running at once within this pool.
|
|
59
|
+
* Min 1, Max 300.
|
|
60
|
+
*/
|
|
61
|
+
maxParallelism?: number;
|
|
62
|
+
/** How much to log. This is updated on each call to `enqueue*`,
|
|
63
|
+
* `status`, or `cancel*`.
|
|
64
|
+
* Default is REPORT, which logs warnings, errors, and a periodic report.
|
|
65
|
+
* With INFO, you can also see events for started and completed work.
|
|
66
|
+
* Stats generated can be parsed by tools like
|
|
67
|
+
* [Axiom](https://axiom.co) for monitoring.
|
|
68
|
+
* With DEBUG, you can see timers and internal events for work being
|
|
69
|
+
* scheduled.
|
|
70
|
+
*/
|
|
71
|
+
logLevel?: LogLevel;
|
|
72
|
+
} & WorkpoolRetryOptions;
|
|
73
|
+
|
|
74
|
+
export type WorkpoolRetryOptions = {
|
|
75
|
+
/** Default retry behavior for enqueued actions.
|
|
76
|
+
* See {@link RetryBehavior}.
|
|
77
|
+
*/
|
|
78
|
+
defaultRetryBehavior?: RetryBehavior;
|
|
79
|
+
/** Whether to retry actions that fail by default. Default: false.
|
|
80
|
+
* NOTE: Only enable this if your actions are idempotent.
|
|
81
|
+
* See the docs (README.md) for more details.
|
|
82
|
+
*/
|
|
83
|
+
retryActionsByDefault?: boolean;
|
|
84
|
+
};
|
|
85
|
+
|
|
61
86
|
export class Workpool {
|
|
62
87
|
/**
|
|
63
88
|
* Initializes a Workpool.
|
|
@@ -68,35 +93,11 @@ export class Workpool {
|
|
|
68
93
|
*
|
|
69
94
|
* @param component - The component to use, like `components.workpool` from
|
|
70
95
|
* `./_generated/api.ts`.
|
|
71
|
-
* @param options - The
|
|
96
|
+
* @param options - The {@link WorkpoolOptions} for the Workpool.
|
|
72
97
|
*/
|
|
73
98
|
constructor(
|
|
74
99
|
private component: UseApi<Mounts>, // UseApi<api> for jump to definition
|
|
75
|
-
public options:
|
|
76
|
-
/** How many actions/mutations can be running at once within this pool.
|
|
77
|
-
* Min 1, Max 300.
|
|
78
|
-
*/
|
|
79
|
-
maxParallelism?: number;
|
|
80
|
-
/** How much to log. This is updated on each call to `enqueue*`,
|
|
81
|
-
* `status`, or `cancel*`.
|
|
82
|
-
* Default is REPORT, which logs warnings, errors, and a periodic report.
|
|
83
|
-
* With INFO, you can also see events for started and completed work.
|
|
84
|
-
* Stats generated can be parsed by tools like
|
|
85
|
-
* [Axiom](https://axiom.co) for monitoring.
|
|
86
|
-
* With DEBUG, you can see timers and internal events for work being
|
|
87
|
-
* scheduled.
|
|
88
|
-
*/
|
|
89
|
-
logLevel?: LogLevel;
|
|
90
|
-
/** Default retry behavior for enqueued actions.
|
|
91
|
-
* See {@link RetryBehavior}.
|
|
92
|
-
*/
|
|
93
|
-
defaultRetryBehavior?: RetryBehavior;
|
|
94
|
-
/** Whether to retry actions that fail by default. Default: false.
|
|
95
|
-
* NOTE: Only enable this if your actions are idempotent.
|
|
96
|
-
* See the docs (README.md) for more details.
|
|
97
|
-
*/
|
|
98
|
-
retryActionsByDefault?: boolean;
|
|
99
|
-
}
|
|
100
|
+
public options: WorkpoolOptions
|
|
100
101
|
) {}
|
|
101
102
|
/**
|
|
102
103
|
* Enqueues an action to be run.
|