@workflow/core 5.0.0-beta.44 → 5.0.0-beta.46

package/dist/runtime/resume-hook.d.ts

@@ -15,18 +15,13 @@ export declare function getHookByToken(token: string): Promise<Hook>;
  * The result of {@link resumeHook}: a {@link Hook} augmented with an optional
  * resilience signal.
  *
- * On the parallel fast path, `resumeHook()` writes the `hook_received` event and
- * dispatches the workflow queue message concurrently. When the direct event
- * write fails *transiently* (a 429/5xx, a transport error, or an expected
- * `(runId, resumeId)` conflict with its own re-ensuring consumer) but the queue
- * dispatch succeeds, the resume is still guaranteed: the queue consumer
- * idempotently materializes the `hook_received` event from the payload carried
- * on the message before replay. In that recovered case the returned hook carries
- * `resilientResume: true`.
- *
- * On the happy path (the direct write landed) and on the sequential fallback
- * path, the flag is absent (`undefined`). Callers that don't care about the
- * distinction can treat the result as a plain {@link Hook}.
+ * `resilientResume` is retained for source compatibility and is never set. It
+ * signalled a resume whose direct `hook_received` write had failed while the
+ * queue dispatch succeeded, back when the lazy path raced the two. The lazy
+ * path no longer writes the event at all (the queue consumer materializes it
+ * from `hookInput`), so there is no longer a distinction to report, and the
+ * sequential path never set the flag either. Treat the result as a plain
+ * {@link Hook}.
  */
 export type ResumedHook = Hook & {
     resilientResume?: boolean;
@@ -61,6 +56,26 @@ export type ResumedHook = Hook & {
  * ```
  */
 export declare function resumeHook<T = any>(tokenOrHook: string | Hook, payload: T, encryptionKeyOverride?: PayloadKey): Promise<ResumedHook>;
+/**
+ * {@link resumeHook} with the `hook_received` event written BEFORE this
+ * resolves, for the one caller that needs the resume to be durable at that
+ * instant rather than merely dispatched.
+ *
+ * The lazy path leaves the write to the queue consumer, so a normal
+ * `resumeHook()` resolves while the event is still in flight. That is fine for
+ * an external resume, whose caller has nothing racing it. It is NOT fine for a
+ * resume the runtime itself issues as a barrier: a step that aborts a shared
+ * `AbortController` resumes the hook that records the abort in the event log,
+ * and that write has to land before the step completes, or the workflow
+ * continuation `step_completed` enqueues can dispatch the next step with a
+ * stale, non-aborted signal (see `reviveAbortController` in serialization.ts).
+ *
+ * Forcing the eager write costs the round trip the lazy path removes, which is
+ * the right trade here: this is an internal ordering barrier, not the
+ * latency-sensitive external resume the optimization targets. The resume span
+ * reports `resume_fallback_reason: durable_required`.
+ */
+export declare function resumeHookDurable<T = any>(tokenOrHook: string | Hook, payload: T, encryptionKeyOverride?: PayloadKey): Promise<ResumedHook>;
 /**
  * Resumes a webhook by sending a {@link https://developer.mozilla.org/en-US/docs/Web/API/Request | Request}
  * object to a hook identified by its token.

package/dist/runtime/resume-hook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resume-hook.d.ts","sourceRoot":"","sources":["../../src/runtime/resume-hook.ts"],"names":[],"mappings":"AAOA,OAAO,EAGL,KAAK,IAAI,EAUV,MAAM,iBAAiB,CAAC;AAQzB,OAAO,EAGL,KAAK,UAAU,EAGhB,MAAM,qBAAqB,CAAC;AAwJ7B;;;;;;;;;GASG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG;IAAE,eAAe,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,UAAU,CAAC,CAAC,GAAG,GAAG,EACtC,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,OAAO,EAAE,CAAC,EACV,qBAAqB,CAAC,EAAE,UAAU,GACjC,OAAO,CAAC,WAAW,CAAC,CAmBtB;AAkcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAsB,aAAa,CACjC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,QAAQ,CAAC,CAqEnB"}
+{"version":3,"file":"resume-hook.d.ts","sourceRoot":"","sources":["../../src/runtime/resume-hook.ts"],"names":[],"mappings":"AAOA,OAAO,EAGL,KAAK,IAAI,EAUV,MAAM,iBAAiB,CAAC;AAOzB,OAAO,EAGL,KAAK,UAAU,EAGhB,MAAM,qBAAqB,CAAC;AA0J7B;;;;;;;;;GASG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGjE;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG;IAAE,eAAe,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,UAAU,CAAC,CAAC,GAAG,GAAG,EACtC,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,OAAO,EAAE,CAAC,EACV,qBAAqB,CAAC,EAAE,UAAU,GACjC,OAAO,CAAC,WAAW,CAAC,CAoBtB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,GAAG,GAAG,EAC7C,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,OAAO,EAAE,CAAC,EACV,qBAAqB,CAAC,EAAE,UAAU,GACjC,OAAO,CAAC,WAAW,CAAC,CAStB;AA+ZD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAsB,aAAa,CACjC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,QAAQ,CAAC,CA4EnB"}