effect 4.0.0-beta.66 → 4.0.0-beta.68

package/src/unstable/workflow/DurableDeferred.ts

@@ -1,4 +1,24 @@
 /**
+ * Durable deferreds are named workflow wait points whose result is stored by
+ * the workflow engine as an encoded `Exit`. A workflow can `await` one and
+ * suspend until an activity, worker, timer, or external callback completes it
+ * with `done`, `succeed`, `fail`, or `failCause`.
+ *
+ * Use this module to coordinate work that finishes outside the current
+ * workflow turn: durable races, queues that report worker results, timers,
+ * human approvals, webhooks, and other callback-style integrations. Tokens
+ * encode the workflow name, execution ID, and deferred name so completion can
+ * be routed back to the correct workflow execution without keeping an
+ * in-memory handle.
+ *
+ * Deferred names are part of persisted workflow state, so keep them stable
+ * across replays and unique for each logical wait. Completion is persisted as
+ * an `Exit` and decoded through the success and error schemas when awaited
+ * again; changing schemas or reusing a name for a different result type can
+ * make old completions fail to decode or resume the wrong wait. Complete a
+ * deferred once, and use `withActivityAttempt` when an activity retry needs an
+ * attempt-scoped completion name.
+ *
  * @since 4.0.0
  */
 import * as Arr from "../../Array.ts"
@@ -21,8 +41,11 @@ import type { WorkflowEngine, WorkflowInstance } from "./WorkflowEngine.ts"
 const TypeId = "~effect/workflow/DurableDeferred"
 
 /**
+ * Named durable deferred value whose completion is persisted by the workflow
+ * engine and encoded with success and error schemas.
+ *
+ * @category models
  * @since 4.0.0
- * @category Models
  */
 export interface DurableDeferred<
   Success extends Schema.Top,
@@ -37,8 +60,11 @@ export interface DurableDeferred<
 }
 
 /**
+ * Type-erased durable deferred shape for APIs that only need the deferred
+ * identity and name.
+ *
+ * @category models
  * @since 4.0.0
- * @category Models
  */
 export interface Any {
   readonly [TypeId]: typeof TypeId
@@ -46,8 +72,11 @@ export interface Any {
 }
 
 /**
+ * Type-erased durable deferred shape that also exposes success, error, and
+ * exit schemas.
+ *
+ * @category models
  * @since 4.0.0
- * @category Models
  */
 export interface AnyWithProps {
   readonly [TypeId]: typeof TypeId
@@ -58,8 +87,11 @@ export interface AnyWithProps {
 }
 
 /**
+ * Creates a named durable deferred with optional success and error schemas for
+ * persisted completion.
+ *
+ * @category constructors
  * @since 4.0.0
- * @category Constructors
  */
 export const make = <
   Success extends Schema.Top = Schema.Void,
@@ -136,20 +168,26 @@ const await_: <Success extends Schema.Top, Error extends Schema.Top>(
 
 export {
   /**
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   await_ as await
 }
 
 /**
+ * Runs an effect and records its exit into the durable deferred, resuming
+ * workflows that are waiting on that deferred.
+ *
+ * @category combinators
  * @since 4.0.0
- * @category Combinators
  */
 export const into: {
   /**
+   * Runs an effect and records its exit into the durable deferred, resuming
+   * workflows that are waiting on that deferred.
+   *
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   <Success extends Schema.Top, Error extends Schema.Top>(self: DurableDeferred<Success, Error>): <R>(
     effect: Effect.Effect<Success["Type"], Error["Type"], R>
@@ -163,8 +201,11 @@ export const into: {
     | Error["DecodingServices"]
   >
   /**
+   * Runs an effect and records its exit into the durable deferred, resuming
+   * workflows that are waiting on that deferred.
+   *
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   <Success extends Schema.Top, Error extends Schema.Top, R>(
     effect: Effect.Effect<Success["Type"], Error["Type"], R>,
@@ -226,8 +267,11 @@ export const into: {
 )
 
 /**
- * @since 4.0.0
+ * Runs effects as a durable race, returning a previously persisted result when
+ * present or completing a named deferred with the first result.
+ *
  * @category Racing
+ * @since 4.0.0
  */
 export const raceAll = <
   const Effects extends NonEmptyReadonlyArray<Effect.Effect<any, any, any>>,
@@ -267,30 +311,44 @@ export const raceAll = <
 }
 
 /**
+ * Runtime brand identifier for durable deferred tokens.
+ *
+ * @category type IDs
  * @since 4.0.0
  */
 export const TokenTypeId = "~effect/workflow/DurableDeferred/Token"
 
 /**
+ * Type-level brand identifier for `Token` values.
+ *
+ * @category type IDs
  * @since 4.0.0
  */
 export type TokenTypeId = typeof TokenTypeId
 
 /**
- * @since 4.0.0
+ * Branded string token identifying a durable deferred for a workflow
+ * execution.
+ *
  * @category Token
+ * @since 4.0.0
  */
 export type Token = Brand.Branded<string, TokenTypeId>
 
 /**
- * @since 4.0.0
+ * Schema for branded durable deferred tokens.
+ *
  * @category Token
+ * @since 4.0.0
  */
 export const Token: Schema.brand<Schema.String, TokenTypeId> = Schema.String.pipe(Schema.brand(TokenTypeId))
 
 /**
- * @since 4.0.0
+ * Decoded representation of a durable deferred token containing the workflow
+ * name, execution ID, and deferred name.
+ *
  * @category Token
+ * @since 4.0.0
  */
 export class TokenParsed extends Schema.Class<TokenParsed>(
   "effect/workflow/DurableDeferred/TokenParsed"
@@ -300,6 +358,8 @@ export class TokenParsed extends Schema.Class<TokenParsed>(
   deferredName: Schema.String
 }) {
   /**
+   * Encodes the parsed workflow, execution, and deferred names back into a token.
+   *
    * @since 4.0.0
    */
   get asToken(): Token {
@@ -309,6 +369,8 @@ export class TokenParsed extends Schema.Class<TokenParsed>(
   }
 
   /**
+   * Schema for decoding and encoding durable deferred tokens as strings.
+   *
    * @since 4.0.0
    */
   static readonly FromString = Schema.String.pipe(
@@ -342,19 +404,26 @@ export class TokenParsed extends Schema.Class<TokenParsed>(
   )
 
   /**
+   * Decodes a durable deferred token string into its parsed components.
+   *
    * @since 4.0.0
    */
   static readonly fromString = Schema.decodeSync(TokenParsed.FromString)
 
   /**
+   * Encodes parsed durable deferred token components into a token string.
+   *
    * @since 4.0.0
    */
   static readonly encode = Schema.encodeSync(TokenParsed.FromString)
 }
 
 /**
- * @since 4.0.0
+ * Creates a token for a durable deferred using the current workflow instance's
+ * workflow name and execution ID.
+ *
  * @category Token
+ * @since 4.0.0
  */
 export const token: <Success extends Schema.Top, Error extends Schema.Top>(
   self: DurableDeferred<Success, Error>
@@ -368,13 +437,19 @@ export const token: <Success extends Schema.Top, Error extends Schema.Top>(
 )
 
 /**
- * @since 4.0.0
+ * Creates a durable deferred token from an explicit workflow, execution ID,
+ * and deferred name.
+ *
  * @category Token
+ * @since 4.0.0
  */
 export const tokenFromExecutionId: {
   /**
-   * @since 4.0.0
+   * Creates a durable deferred token from an explicit workflow, execution ID,
+   * and deferred name.
+   *
    * @category Token
+   * @since 4.0.0
    */
   (
     options: {
@@ -385,8 +460,11 @@ export const tokenFromExecutionId: {
     self: DurableDeferred<Success, Error>
   ) => Token
   /**
-   * @since 4.0.0
+   * Creates a durable deferred token from an explicit workflow, execution ID,
+   * and deferred name.
+   *
    * @category Token
+   * @since 4.0.0
    */
   <Success extends Schema.Top, Error extends Schema.Top>(
     self: DurableDeferred<Success, Error>,
@@ -409,13 +487,19 @@ export const tokenFromExecutionId: {
 )
 
 /**
- * @since 4.0.0
+ * Creates a durable deferred token by deriving the workflow execution ID from
+ * the supplied workflow payload.
+ *
  * @category Token
+ * @since 4.0.0
  */
 export const tokenFromPayload: {
   /**
-   * @since 4.0.0
+   * Creates a durable deferred token by deriving the workflow execution ID from
+   * the supplied workflow payload.
+   *
    * @category Token
+   * @since 4.0.0
    */
   <W extends Workflow.Any>(
     options: {
@@ -426,8 +510,11 @@ export const tokenFromPayload: {
     self: DurableDeferred<Success, Error>
   ) => Effect.Effect<Token>
   /**
-   * @since 4.0.0
+   * Creates a durable deferred token by deriving the workflow execution ID from
+   * the supplied workflow payload.
+   *
    * @category Token
+   * @since 4.0.0
    */
   <
     Success extends Schema.Top,
@@ -461,13 +548,19 @@ export const tokenFromPayload: {
 )
 
 /**
+ * Completes the durable deferred identified by a token with the supplied exit,
+ * encoding the result through the deferred schemas.
+ *
+ * @category combinators
  * @since 4.0.0
- * @category Combinators
  */
 export const done: {
   /**
+   * Completes the durable deferred identified by a token with the supplied exit,
+   * encoding the result through the deferred schemas.
+   *
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   <Success extends Schema.Top, Error extends Schema.Top>(
     options: {
@@ -482,8 +575,11 @@ export const done: {
     WorkflowEngine | Success["EncodingServices"] | Error["EncodingServices"]
   >
   /**
+   * Completes the durable deferred identified by a token with the supplied exit,
+   * encoding the result through the deferred schemas.
+   *
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   <Success extends Schema.Top, Error extends Schema.Top>(
     self: DurableDeferred<Success, Error>,
@@ -520,13 +616,19 @@ export const done: {
 )
 
 /**
+ * Completes the durable deferred identified by a token with a successful
+ * value.
+ *
+ * @category combinators
  * @since 4.0.0
- * @category Combinators
  */
 export const succeed: {
   /**
+   * Completes the durable deferred identified by a token with a successful
+   * value.
+   *
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   <Success extends Schema.Top, Error extends Schema.Top>(
     options: {
@@ -537,8 +639,11 @@ export const succeed: {
     self: DurableDeferred<Success, Error>
   ) => Effect.Effect<void, never, WorkflowEngine | Success["EncodingServices"]>
   /**
+   * Completes the durable deferred identified by a token with a successful
+   * value.
+   *
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   <Success extends Schema.Top, Error extends Schema.Top>(
     self: DurableDeferred<Success, Error>,
@@ -563,13 +668,17 @@ export const succeed: {
 )
 
 /**
+ * Completes the durable deferred identified by a token with a typed failure.
+ *
+ * @category combinators
  * @since 4.0.0
- * @category Combinators
  */
 export const fail: {
   /**
+   * Completes the durable deferred identified by a token with a typed failure.
+   *
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   <Success extends Schema.Top, Error extends Schema.Top>(
     options: {
@@ -580,8 +689,10 @@ export const fail: {
     self: DurableDeferred<Success, Error>
   ) => Effect.Effect<void, never, WorkflowEngine | Error["EncodingServices"]>
   /**
+   * Completes the durable deferred identified by a token with a typed failure.
+   *
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   <Success extends Schema.Top, Error extends Schema.Top>(
     self: DurableDeferred<Success, Error>,
@@ -606,13 +717,17 @@ export const fail: {
 )
 
 /**
+ * Completes the durable deferred identified by a token with a failure cause.
+ *
+ * @category combinators
  * @since 4.0.0
- * @category Combinators
  */
 export const failCause: {
   /**
+   * Completes the durable deferred identified by a token with a failure cause.
+   *
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   <Success extends Schema.Top, Error extends Schema.Top>(
     options: {
@@ -623,8 +738,10 @@ export const failCause: {
     self: DurableDeferred<Success, Error>
   ) => Effect.Effect<void, never, WorkflowEngine | Error["EncodingServices"]>
   /**
+   * Completes the durable deferred identified by a token with a failure cause.
+   *
+   * @category combinators
    * @since 4.0.0
-   * @category Combinators
    */
   <Success extends Schema.Top, Error extends Schema.Top>(
     self: DurableDeferred<Success, Error>,

package/src/unstable/workflow/DurableQueue.ts

@@ -1,4 +1,20 @@
 /**
+ * Durable queues bridge workflow executions with persisted background workers.
+ * A workflow calls `process` to enqueue a schema-encoded payload in a named
+ * `PersistedQueue`, attach a durable deferred token, and suspend until a worker
+ * records the handler's `Exit` back through that deferred.
+ *
+ * Use this module for workflow steps that should be delegated to independent
+ * workers: long-running side effects, rate-limited or concurrency-limited
+ * integrations, fan-out jobs, API calls, and other work that must survive
+ * workflow suspension, process restarts, or handoff to another service.
+ *
+ * Queue names, payload schemas, result schemas, and idempotency keys become
+ * persisted coordination state. Keep them deterministic and stable across
+ * deployments; changing them is a persistence migration. Delivery follows the
+ * underlying `PersistedQueue` semantics, so handlers should be idempotent and
+ * prepared for retries, duplicate observations, and worker restarts.
+ *
  * @since 4.0.0
  */
 import * as Effect from "../../Effect.ts"
@@ -12,20 +28,27 @@ import * as DurableDeferred from "./DurableDeferred.ts"
 import type { WorkflowEngine, WorkflowInstance } from "./WorkflowEngine.ts"
 
 /**
+ * Type-level identifier used to recognize `DurableQueue` values.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category Type IDs
  */
 export type TypeId = "~effect/workflow/DurableQueue"
 
 /**
+ * Runtime identifier attached to `DurableQueue` values.
+ *
+ * @category type IDs
  * @since 4.0.0
- * @category Type IDs
  */
 export const TypeId: TypeId = "~effect/workflow/DurableQueue"
 
 /**
+ * Durable workflow queue definition containing a payload schema, idempotency
+ * key, and deferred used to await worker results.
+ *
+ * @category models
  * @since 4.0.0
- * @category Models
  */
 export interface DurableQueue<
   Payload extends Schema.Top,
@@ -43,9 +66,11 @@ export interface DurableQueue<
  * A `DurableQueue` wraps a `PersistedQueue`, providing a way to wait for items
  * to finish processing using a `DurableDeferred`.
  *
+ * **Example** (Defining a durable queue with workers)
+ *
  * ```ts
- * import { DurableQueue, Workflow } from "effect/unstable/workflow"
  * import { Effect, Schema } from "effect"
+ * import { DurableQueue, Workflow } from "effect/unstable/workflow"
  *
  * // Define a DurableQueue that can be used to derive workers and offer items for
  * // processing.
@@ -92,8 +117,8 @@ export interface DurableQueue<
  * )
  * ```
  *
+ * @category constructors
  * @since 4.0.0
- * @category Constructors
  */
 export const make = <
   Payload extends Schema.Top | Schema.Struct.Fields,
@@ -153,8 +178,8 @@ const getQueueSchema = <Payload extends Schema.Top>(
 /**
  * Add an item to the queue and wait for a worker to process it.
  *
- * @since 4.0.0
  * @category Processing
+ * @since 4.0.0
  */
 export const process: <
   Payload extends Schema.Top,
@@ -229,8 +254,8 @@ const defaultRetrySchedule = Schedule.exponential(500, 1.5).pipe(
 /**
  * Create a worker effect that processes items from the durable queue.
  *
- * @since 4.0.0
  * @category Worker
+ * @since 4.0.0
  */
 export const makeWorker: <
   Payload extends Schema.Top,
@@ -316,8 +341,8 @@ export const makeWorker: <
 /**
  * Create a layer that runs workers for the durable queue.
  *
- * @since 4.0.0
  * @category Worker
+ * @since 4.0.0
  */
 export const worker: <
   Payload extends Schema.Top,