@effect/workflow 0.13.0 → 0.13.1

package/DurableQueue/package.json

@@ -0,0 +1,6 @@
+{
+  "main": "../dist/cjs/DurableQueue.js",
+  "module": "../dist/esm/DurableQueue.js",
+  "types": "../dist/dts/DurableQueue.d.ts",
+  "sideEffects": []
+}

package/dist/cjs/DurableQueue.js

@@ -0,0 +1,186 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.worker = exports.process = exports.makeWorker = exports.make = exports.TypeId = void 0;
+var PersistedQueue = _interopRequireWildcard(require("@effect/experimental/PersistedQueue"));
+var Context = _interopRequireWildcard(require("effect/Context"));
+var Effect = _interopRequireWildcard(require("effect/Effect"));
+var Layer = _interopRequireWildcard(require("effect/Layer"));
+var Schedule = _interopRequireWildcard(require("effect/Schedule"));
+var Schema = _interopRequireWildcard(require("effect/Schema"));
+var Activity = _interopRequireWildcard(require("./Activity.js"));
+var DurableDeferred = _interopRequireWildcard(require("./DurableDeferred.js"));
+var _crypto = require("./internal/crypto.js");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+/**
+ * @since 1.0.0
+ */
+
+/**
+ * @since 1.0.0
+ * @category Type IDs
+ */
+const TypeId = exports.TypeId = "~@effect/workflow/DurableQueue";
+/**
+ * A `DurableQueue` wraps a `PersistedQueue`, providing a way to wait for items
+ * to finish processing using a `DurableDeferred`.
+ *
+ * ```ts
+ * import { DurableQueue, Workflow } from "@effect/workflow"
+ * import { Effect, Schema } from "effect"
+ *
+ * // Define a DurableQueue that can be used to derive workers and offer items for
+ * // processing.
+ * const ApiQueue = DurableQueue.make({
+ *   name: "ApiQueue",
+ *   payload: {
+ *     id: Schema.String
+ *   },
+ *   success: Schema.Void,
+ *   error: Schema.Never,
+ *   idempotencyKey(payload) {
+ *     return payload.id
+ *   }
+ * })
+ *
+ * const MyWorkflow = Workflow.make({
+ *   name: "MyWorkflow",
+ *   payload: {
+ *     id: Schema.String
+ *   },
+ *   idempotencyKey: ({ id }) => id
+ * })
+ *
+ * const MyWorkflowLayer = MyWorkflow.toLayer(
+ *   Effect.fn(function*() {
+ *     // Add an item to the DurableQueue defined above.
+ *     //
+ *     // When the worker has finished processing the item, the workflow will
+ *     // resume.
+ *     //
+ *     yield* DurableQueue.process(ApiQueue, { id: "api-call-1" })
+ *
+ *     yield* Effect.log("Workflow succeeded!")
+ *   })
+ * )
+ *
+ * // Define a worker layer that can process items from the DurableQueue.
+ * const ApiWorker = DurableQueue.worker(
+ *   ApiQueue,
+ *   Effect.fn(function*({ id }) {
+ *     yield* Effect.log(`Worker processing API call with id: ${id}`)
+ *   }),
+ *   { concurrency: 5 } // Process up to 5 items concurrently
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+const make = options => ({
+  [TypeId]: TypeId,
+  name: options.name,
+  payloadSchema: Schema.isSchema(options.payload) ? options.payload : Schema.Struct(options.payload),
+  idempotencyKey: options.idempotencyKey,
+  deferred: DurableDeferred.make(`DurableQueue/${options.name}`, {
+    success: options.success,
+    error: options.error
+  })
+});
+exports.make = make;
+const queueSchemas = /*#__PURE__*/new WeakMap();
+const getQueueSchema = payload => {
+  let schema = queueSchemas.get(payload);
+  if (!schema) {
+    schema = Schema.Struct({
+      token: Schema.String,
+      traceId: Schema.String,
+      spanId: Schema.String,
+      sampled: Schema.Boolean,
+      payload
+    });
+    queueSchemas.set(payload, schema);
+  }
+  return schema;
+};
+/**
+ * @since 1.0.0
+ * @category Processing
+ */
+const process = exports.process = /*#__PURE__*/Effect.fnUntraced(function* (self, payload, options) {
+  const key = yield* (0, _crypto.makeHashDigest)(self.idempotencyKey(payload));
+  const deferred = DurableDeferred.make(`${self.deferred.name}/${key}`, {
+    success: self.deferred.successSchema,
+    error: self.deferred.errorSchema
+  });
+  yield* Activity.make({
+    name: `DurableQueue/${self.name}/${key}`,
+    execute: Effect.gen(function* () {
+      const span = yield* Effect.orDie(Effect.currentSpan);
+      const queue = yield* PersistedQueue.make({
+        name: `DurableQueue/${self.name}`,
+        schema: getQueueSchema(self.payloadSchema)
+      });
+      const token = yield* DurableDeferred.token(deferred);
+      yield* queue.offer({
+        token,
+        payload,
+        traceId: span.traceId,
+        spanId: span.spanId,
+        sampled: span.sampled
+      }).pipe(Effect.tapErrorCause(Effect.logWarning), Effect.catchTag("ParseError", Effect.die), Effect.retry(options?.retrySchedule ?? defaultRetrySchedule), Effect.orDie, Effect.annotateLogs({
+        package: "@effect/workflow",
+        module: "DurableQueue",
+        fiber: "process",
+        queueName: self.name
+      }));
+    })
+  });
+  return yield* DurableDeferred.await(deferred);
+});
+const defaultRetrySchedule = /*#__PURE__*/Schedule.exponential(500, 1.5).pipe(/*#__PURE__*/Schedule.union(/*#__PURE__*/Schedule.spaced("1 minute")));
+/**
+ * @since 1.0.0
+ * @category Worker
+ */
+const makeWorker = exports.makeWorker = /*#__PURE__*/Effect.fnUntraced(function* (self, f, options) {
+  const queue = yield* PersistedQueue.make({
+    name: `DurableQueue/${self.name}`,
+    schema: getQueueSchema(self.payloadSchema)
+  });
+  const concurrency = options?.concurrency ?? 1;
+  const worker = queue.take(item_ => {
+    const item = item_;
+    return f(item.payload).pipe(Effect.exit, Effect.flatMap(exit => DurableDeferred.done(self.deferred, {
+      token: item.token,
+      exit
+    })), Effect.asVoid, Effect.withSpan(`DurableQueue/${self.name}/worker`, {
+      captureStackTrace: false,
+      parent: {
+        _tag: "ExternalSpan",
+        traceId: item.traceId,
+        spanId: item.spanId,
+        sampled: item.sampled,
+        context: Context.empty()
+      }
+    }));
+  }).pipe(Effect.catchAllCause(Effect.logWarning), Effect.forever, Effect.annotateLogs({
+    package: "@effect/workflow",
+    module: "DurableQueue",
+    fiber: "worker"
+  }));
+  yield* Effect.replicateEffect(worker, concurrency, {
+    concurrency,
+    discard: true
+  });
+  return yield* Effect.never;
+});
+/**
+ * @since 1.0.0
+ * @category Worker
+ */
+const worker = (self, f, options) => Layer.scopedDiscard(Effect.forkScoped(makeWorker(self, f, options)));
+exports.worker = worker;
+//# sourceMappingURL=DurableQueue.js.map

package/dist/cjs/DurableQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DurableQueue.js","names":["PersistedQueue","_interopRequireWildcard","require","Context","Effect","Layer","Schedule","Schema","Activity","DurableDeferred","_crypto","e","t","WeakMap","r","n","__esModule","o","i","f","__proto__","default","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","TypeId","exports","make","options","name","payloadSchema","isSchema","payload","Struct","idempotencyKey","deferred","success","error","queueSchemas","getQueueSchema","schema","token","String","traceId","spanId","sampled","Boolean","process","fnUntraced","self","key","makeHashDigest","successSchema","errorSchema","execute","gen","span","orDie","currentSpan","queue","offer","pipe","tapErrorCause","logWarning","catchTag","die","retry","retrySchedule","defaultRetrySchedule","annotateLogs","package","module","fiber","queueName","await","exponential","union","spaced","makeWorker","concurrency","worker","take","item_","item","exit","flatMap","done","asVoid","withSpan","captureStackTrace","parent","_tag","context","empty","catchAllCause","forever","replicateEffect","discard","never","scopedDiscard","forkScoped"],"sources":["../../src/DurableQueue.ts"],"sourcesContent":[null],"mappings":";;;;;;AAGA,IAAAA,cAAA,GAAAC,uBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAF,uBAAA,CAAAC,OAAA;AACA,IAAAE,MAAA,GAAAH,uBAAA,CAAAC,OAAA;AACA,IAAAG,KAAA,GAAAJ,uBAAA,CAAAC,OAAA;AACA,IAAAI,QAAA,GAAAL,uBAAA,CAAAC,OAAA;AACA,IAAAK,MAAA,GAAAN,uBAAA,CAAAC,OAAA;AACA,IAAAM,QAAA,GAAAP,uBAAA,CAAAC,OAAA;AACA,IAAAO,eAAA,GAAAR,uBAAA,CAAAC,OAAA;AACA,IAAAQ,OAAA,GAAAR,OAAA;AAAqD,SAAAD,wBAAAU,CAAA,EAAAC,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAZ,uBAAA,YAAAA,CAAAU,CAAA,EAAAC,CAAA,SAAAA,CAAA,IAAAD,CAAA,IAAAA,CAAA,CAAAK,UAAA,SAAAL,CAAA,MAAAM,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAC,OAAA,EAAAV,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAQ,CAAA,MAAAF,CAAA,GAAAL,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAG,CAAA,CAAAK,GAAA,CAAAX,CAAA,UAAAM,CAAA,CAAAM,GAAA,CAAAZ,CAAA,GAAAM,CAAA,CAAAO,GAAA,CAAAb,CAAA,EAAAQ,CAAA,gBAAAP,CAAA,IAAAD,CAAA,gBAAAC,CAAA,OAAAa,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAC,CAAA,OAAAM,CAAA,IAAAD,CAAA,GAAAU,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAC,CAAA,OAAAM,CAAA,CAAAK,GAAA,IAAAL,CAAA,CAAAM,GAAA,IAAAP,CAAA,CAAAE,CAAA,EAAAP,CAAA,EAAAM,CAAA,IAAAC,CAAA,CAAAP,CAAA,IAAAD,CAAA,CAAAC,CAAA,WAAAO,CAAA,KAAAR,CAAA,EAAAC,CAAA;AAXrD;;;;AAoBA;;;;AAIO,MAAMkB,MAAM,GAAAC,OAAA,CAAAD,MAAA,GAAW,gCAAgC;AAkB9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwDO,MAAME,IAAI,GAKfC,OAQC,KAKG;EACJ,CAACH,MAAM,GAAGA,MAAM;EAChBI,IAAI,EAAED,OAAO,CAACC,IAAI;EAClBC,aAAa,EAAE5B,MAAM,CAAC6B,QAAQ,CAACH,OAAO,CAACI,OAAO,CAAC,GAAGJ,OAAO,CAACI,OAAO,GAAG9B,MAAM,CAAC+B,MAAM,CAACL,OAAO,CAACI,OAAO,CAAQ;EACzGE,cAAc,EAAEN,OAAO,CAACM,cAAqB;EAC7CC,QAAQ,EAAE/B,eAAe,CAACuB,IAAI,CAAC,gBAAgBC,OAAO,CAACC,IAAI,EAAE,EAAE;IAC7DO,OAAO,EAAER,OAAO,CAACQ,OAAO;IACxBC,KAAK,EAAET,OAAO,CAACS;GAChB;CACF,CAAC;AAAAX,OAAA,CAAAC,IAAA,GAAAA,IAAA;AAEF,MAAMW,YAAY,gBAAG,IAAI9B,OAAO,EAAwC;AACxE,MAAM+B,cAAc,GAClBP,OAAgB,IAOb;EACH,IAAIQ,MAAM,GAAGF,YAAY,CAACpB,GAAG,CAACc,OAAO,CAAC;EACtC,IAAI,CAACQ,MAAM,EAAE;IACXA,MAAM,GAAGtC,MAAM,CAAC+B,MAAM,CAAC;MACrBQ,KAAK,EAAEvC,MAAM,CAACwC,MAAM;MACpBC,OAAO,EAAEzC,MAAM,CAACwC,MAAM;MACtBE,MAAM,EAAE1C,MAAM,CAACwC,MAAM;MACrBG,OAAO,EAAE3C,MAAM,CAAC4C,OAAO;MACvBd;KACD,CAAC;IACFM,YAAY,CAACnB,GAAG,CAACa,OAAO,EAAEQ,MAAM,CAAC;EACnC;EACA,OAAOA,MAAa;AACtB,CAAC;AAED;;;;AAIO,MAAMO,OAAO,GAAArB,OAAA,CAAAqB,OAAA,gBAmBhBhD,MAAM,CAACiD,UAAU,CAAC,WAIpBC,IAA2C,EAAEjB,OAAwB,EAAEJ,OAExE;EACC,MAAMsB,GAAG,GAAG,OAAO,IAAAC,sBAAc,EAACF,IAAI,CAACf,cAAc,CAACF,OAAO,CAAC,CAAC;EAE/D,MAAMG,QAAQ,GAAG/B,eAAe,CAACuB,IAAI,CAAC,GAAGsB,IAAI,CAACd,QAAQ,CAACN,IAAI,IAAIqB,GAAG,EAAE,EAAE;IACpEd,OAAO,EAAEa,IAAI,CAACd,QAAQ,CAACiB,aAAa;IACpCf,KAAK,EAAEY,IAAI,CAACd,QAAQ,CAACkB;GACtB,CAAC;EAEF,OAAOlD,QAAQ,CAACwB,IAAI,CAAC;IACnBE,IAAI,EAAE,gBAAgBoB,IAAI,CAACpB,IAAI,IAAIqB,GAAG,EAAE;IACxCI,OAAO,EAAEvD,MAAM,CAACwD,GAAG,CAAC,aAAS;MAC3B,MAAMC,IAAI,GAAG,OAAOzD,MAAM,CAAC0D,KAAK,CAAC1D,MAAM,CAAC2D,WAAW,CAAC;MACpD,MAAMC,KAAK,GAAG,OAAOhE,cAAc,CAACgC,IAAI,CAAC;QACvCE,IAAI,EAAE,gBAAgBoB,IAAI,CAACpB,IAAI,EAAE;QACjCW,MAAM,EAAED,cAAc,CAACU,IAAI,CAACnB,aAAa;OAC1C,CAAC;MACF,MAAMW,KAAK,GAAG,OAAOrC,eAAe,CAACqC,KAAK,CAACN,QAAQ,CAAC;MACpD,OAAOwB,KAAK,CAACC,KAAK,CAAC;QACjBnB,KAAK;QACLT,OAAO;QACPW,OAAO,EAAEa,IAAI,CAACb,OAAO;QACrBC,MAAM,EAAEY,IAAI,CAACZ,MAAM;QACnBC,OAAO,EAAEW,IAAI,CAACX;OACR,CAAC,CAACgB,IAAI,CACZ9D,MAAM,CAAC+D,aAAa,CAAC/D,MAAM,CAACgE,UAAU,CAAC,EACvChE,MAAM,CAACiE,QAAQ,CAAC,YAAY,EAAEjE,MAAM,CAACkE,GAAG,CAAC,EACzClE,MAAM,CAACmE,KAAK,CAACtC,OAAO,EAAEuC,aAAa,IAAIC,oBAAoB,CAAC,EAC5DrE,MAAM,CAAC0D,KAAK,EACZ1D,MAAM,CAACsE,YAAY,CAAC;QAClBC,OAAO,EAAE,kBAAkB;QAC3BC,MAAM,EAAE,cAAc;QACtBC,KAAK,EAAE,SAAS;QAChBC,SAAS,EAAExB,IAAI,CAACpB;OACjB,CAAC,CACH;IACH,CAAC;GACF,CAAC;EAEF,OAAO,OAAOzB,eAAe,CAACsE,KAAK,CAACvC,QAAQ,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAMiC,oBAAoB,gBAAGnE,QAAQ,CAAC0E,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAACd,IAAI,cAC9D5D,QAAQ,CAAC2E,KAAK,cAAC3E,QAAQ,CAAC4E,MAAM,CAAC,UAAU,CAAC,CAAC,CAC5C;AAED;;;;AAIO,MAAMC,UAAU,GAAApD,OAAA,CAAAoD,UAAA,gBAkBnB/E,MAAM,CAACiD,UAAU,CAAC,WAMpBC,IAA2C,EAC3CnC,CAAiF,EACjFc,OAEC;EAED,MAAM+B,KAAK,GAAG,OAAOhE,cAAc,CAACgC,IAAI,CAAC;IACvCE,IAAI,EAAE,gBAAgBoB,IAAI,CAACpB,IAAI,EAAE;IACjCW,MAAM,EAAED,cAAc,CAACU,IAAI,CAACnB,aAAa;GAC1C,CAAC;EACF,MAAMiD,WAAW,GAAGnD,OAAO,EAAEmD,WAAW,IAAI,CAAC;EAE7C,MAAMC,MAAM,GAAGrB,KAAK,CAACsB,IAAI,CAAEC,KAAK,IAAI;IAClC,MAAMC,IAAI,GAAGD,KAMZ;IACD,OAAOpE,CAAC,CAACqE,IAAI,CAACnD,OAAO,CAAC,CAAC6B,IAAI,CACzB9D,MAAM,CAACqF,IAAI,EACXrF,MAAM,CAACsF,OAAO,CAAED,IAAI,IAClBhF,eAAe,CAACkF,IAAI,CAACrC,IAAI,CAACd,QAAQ,EAAE;MAClCM,KAAK,EAAE0C,IAAI,CAAC1C,KAAK;MACjB2C;KACD,CAAC,CACH,EACDrF,MAAM,CAACwF,MAAM,EACbxF,MAAM,CAACyF,QAAQ,CAAC,gBAAgBvC,IAAI,CAACpB,IAAI,SAAS,EAAE;MAClD4D,iBAAiB,EAAE,KAAK;MACxBC,MAAM,EAAE;QACNC,IAAI,EAAE,cAAc;QACpBhD,OAAO,EAAEwC,IAAI,CAACxC,OAAO;QACrBC,MAAM,EAAEuC,IAAI,CAACvC,MAAM;QACnBC,OAAO,EAAEsC,IAAI,CAACtC,OAAO;QACrB+C,OAAO,EAAE9F,OAAO,CAAC+F,KAAK;;KAEzB,CAAC,CACH;EACH,CAAC,CAAC,CAAChC,IAAI,CACL9D,MAAM,CAAC+F,aAAa,CAAC/F,MAAM,CAACgE,UAAU,CAAC,EACvChE,MAAM,CAACgG,OAAO,EACdhG,MAAM,CAACsE,YAAY,CAAC;IAClBC,OAAO,EAAE,kBAAkB;IAC3BC,MAAM,EAAE,cAAc;IACtBC,KAAK,EAAE;GACR,CAAC,CACH;EAED,OAAOzE,MAAM,CAACiG,eAAe,CAAChB,MAAM,EAAED,WAAW,EAAE;IAAEA,WAAW;IAAEkB,OAAO,EAAE;EAAI,CAAE,CAAC;EAClF,OAAO,OAAOlG,MAAM,CAACmG,KAAK;AAC5B,CAAC,CAAC;AAEF;;;;AAIO,MAAMlB,MAAM,GAoBfA,CAAC/B,IAAI,EAAEnC,CAAC,EAAEc,OAAO,KAAK5B,KAAK,CAACmG,aAAa,CAACpG,MAAM,CAACqG,UAAU,CAACtB,UAAU,CAAC7B,IAAI,EAAEnC,CAAC,EAAEc,OAAO,CAAC,CAAC,CAAC;AAAAF,OAAA,CAAAsD,MAAA,GAAAA,MAAA","ignoreList":[]}

package/dist/cjs/index.js

@@ -3,13 +3,15 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.WorkflowProxyServer = exports.WorkflowProxy = exports.WorkflowEngine = exports.Workflow = exports.DurableRateLimiter = exports.DurableDeferred = exports.DurableClock = exports.Activity = void 0;
+exports.WorkflowProxyServer = exports.WorkflowProxy = exports.WorkflowEngine = exports.Workflow = exports.DurableRateLimiter = exports.DurableQueue = exports.DurableDeferred = exports.DurableClock = exports.Activity = void 0;
 var _Activity = _interopRequireWildcard(require("./Activity.js"));
 exports.Activity = _Activity;
 var _DurableClock = _interopRequireWildcard(require("./DurableClock.js"));
 exports.DurableClock = _DurableClock;
 var _DurableDeferred = _interopRequireWildcard(require("./DurableDeferred.js"));
 exports.DurableDeferred = _DurableDeferred;
+var _DurableQueue = _interopRequireWildcard(require("./DurableQueue.js"));
+exports.DurableQueue = _DurableQueue;
 var _DurableRateLimiter = _interopRequireWildcard(require("./DurableRateLimiter.js"));
 exports.DurableRateLimiter = _DurableRateLimiter;
 var _Workflow = _interopRequireWildcard(require("./Workflow.js"));

package/dist/dts/DurableQueue.d.ts

@@ -0,0 +1,116 @@
+/**
+ * @since 1.0.0
+ */
+import * as PersistedQueue from "@effect/experimental/PersistedQueue";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Schedule from "effect/Schedule";
+import * as Schema from "effect/Schema";
+import * as DurableDeferred from "./DurableDeferred.js";
+import type * as WorkflowEngine from "./WorkflowEngine.js";
+/**
+ * @since 1.0.0
+ * @category Type IDs
+ */
+export type TypeId = "~@effect/workflow/DurableQueue";
+/**
+ * @since 1.0.0
+ * @category Type IDs
+ */
+export declare const TypeId: TypeId;
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export interface DurableQueue<Payload extends Schema.Schema.Any, Success extends Schema.Schema.Any = typeof Schema.Void, Error extends Schema.Schema.All = typeof Schema.Never> {
+    readonly [TypeId]: TypeId;
+    readonly name: string;
+    readonly payloadSchema: Payload;
+    readonly idempotencyKey: (payload: Payload["Type"]) => string;
+    readonly deferred: DurableDeferred.DurableDeferred<Success, Error>;
+}
+/**
+ * A `DurableQueue` wraps a `PersistedQueue`, providing a way to wait for items
+ * to finish processing using a `DurableDeferred`.
+ *
+ * ```ts
+ * import { DurableQueue, Workflow } from "@effect/workflow"
+ * import { Effect, Schema } from "effect"
+ *
+ * // Define a DurableQueue that can be used to derive workers and offer items for
+ * // processing.
+ * const ApiQueue = DurableQueue.make({
+ *   name: "ApiQueue",
+ *   payload: {
+ *     id: Schema.String
+ *   },
+ *   success: Schema.Void,
+ *   error: Schema.Never,
+ *   idempotencyKey(payload) {
+ *     return payload.id
+ *   }
+ * })
+ *
+ * const MyWorkflow = Workflow.make({
+ *   name: "MyWorkflow",
+ *   payload: {
+ *     id: Schema.String
+ *   },
+ *   idempotencyKey: ({ id }) => id
+ * })
+ *
+ * const MyWorkflowLayer = MyWorkflow.toLayer(
+ *   Effect.fn(function*() {
+ *     // Add an item to the DurableQueue defined above.
+ *     //
+ *     // When the worker has finished processing the item, the workflow will
+ *     // resume.
+ *     //
+ *     yield* DurableQueue.process(ApiQueue, { id: "api-call-1" })
+ *
+ *     yield* Effect.log("Workflow succeeded!")
+ *   })
+ * )
+ *
+ * // Define a worker layer that can process items from the DurableQueue.
+ * const ApiWorker = DurableQueue.worker(
+ *   ApiQueue,
+ *   Effect.fn(function*({ id }) {
+ *     yield* Effect.log(`Worker processing API call with id: ${id}`)
+ *   }),
+ *   { concurrency: 5 } // Process up to 5 items concurrently
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const make: <Payload extends Schema.Schema.Any | Schema.Struct.Fields, Success extends Schema.Schema.Any = typeof Schema.Void, Error extends Schema.Schema.All = typeof Schema.Never>(options: {
+    readonly name: string;
+    readonly payload: Payload;
+    readonly idempotencyKey: (payload: Payload extends Schema.Struct.Fields ? Schema.Struct<Payload>["Type"] : Payload["Type"]) => string;
+    readonly success?: Success | undefined;
+    readonly error?: Error | undefined;
+}) => DurableQueue<Payload extends Schema.Struct.Fields ? Schema.Struct<Payload> : Payload, Success, Error>;
+/**
+ * @since 1.0.0
+ * @category Processing
+ */
+export declare const process: <Payload extends Schema.Schema.Any, Success extends Schema.Schema.Any, Error extends Schema.Schema.All>(self: DurableQueue<Payload, Success, Error>, payload: Payload["Type"], options?: {
+    readonly retrySchedule?: Schedule.Schedule<any, PersistedQueue.PersistedQueueError> | undefined;
+}) => Effect.Effect<Success["Type"], Error["Type"], WorkflowEngine.WorkflowEngine | WorkflowEngine.WorkflowInstance | PersistedQueue.PersistedQueueFactory | Success["Context"] | Error["Context"] | Payload["Context"]>;
+/**
+ * @since 1.0.0
+ * @category Worker
+ */
+export declare const makeWorker: <Payload extends Schema.Schema.Any, Success extends Schema.Schema.Any, Error extends Schema.Schema.All, R>(self: DurableQueue<Payload, Success, Error>, f: (payload: Payload["Type"]) => Effect.Effect<Success["Type"], Error["Type"], R>, options?: {
+    readonly concurrency?: number | undefined;
+} | undefined) => Effect.Effect<never, never, WorkflowEngine.WorkflowEngine | PersistedQueue.PersistedQueueFactory | R | Payload["Context"] | Success["Context"] | Error["Context"]>;
+/**
+ * @since 1.0.0
+ * @category Worker
+ */
+export declare const worker: <Payload extends Schema.Schema.Any, Success extends Schema.Schema.Any, Error extends Schema.Schema.All, R>(self: DurableQueue<Payload, Success, Error>, f: (payload: Payload["Type"]) => Effect.Effect<Success["Type"], Error["Type"], R>, options?: {
+    readonly concurrency?: number | undefined;
+} | undefined) => Layer.Layer<never, never, WorkflowEngine.WorkflowEngine | PersistedQueue.PersistedQueueFactory | R | Payload["Context"] | Success["Context"] | Error["Context"]>;
+//# sourceMappingURL=DurableQueue.d.ts.map

package/dist/dts/DurableQueue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DurableQueue.d.ts","sourceRoot":"","sources":["../../src/DurableQueue.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qCAAqC,CAAA;AAErE,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD,OAAO,KAAK,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAE1D;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,gCAAgC,CAAA;AAErD;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,MAAyC,CAAA;AAE9D;;;GAGG;AACH,MAAM,WAAW,YAAY,CAC3B,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACjC,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EACtD,KAAK,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,KAAK;IAErD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAA;IAC/B,QAAQ,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,MAAM,CAAA;IAC7D,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;CACnE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,eAAO,MAAM,IAAI,GACf,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EACxD,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,EACtD,KAAK,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,KAAK,EAErD,SAAS;IACP,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,cAAc,EAAE,CACvB,OAAO,EAAE,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,KAC7F,MAAM,CAAA;IACX,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;CACnC,KACA,YAAY,CACb,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,EACvE,OAAO,EACP,KAAK,CAUL,CAAA;AA0BF;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE,CACpB,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACjC,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACjC,KAAK,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAE/B,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,EAC3C,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,EACxB,OAAO,CAAC,EAAE;IACR,QAAQ,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAA;CAChG,KACE,MAAM,CAAC,MAAM,CAChB,OAAO,CAAC,MAAM,CAAC,EACf,KAAK,CAAC,MAAM,CAAC,EACX,cAAc,CAAC,cAAc,GAC7B,cAAc,CAAC,gBAAgB,GAC/B,cAAc,CAAC,qBAAqB,GACpC,OAAO,CAAC,SAAS,CAAC,GAClB,KAAK,CAAC,SAAS,CAAC,GAChB,OAAO,CAAC,SAAS,CAAC,CA8CpB,CAAA;AAMF;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE,CACvB,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACjC,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACjC,KAAK,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC/B,CAAC,EAED,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,EAC3C,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACjF,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,KAChE,MAAM,CAAC,MAAM,CAChB,KAAK,EACL,KAAK,EACH,cAAc,CAAC,cAAc,GAC7B,cAAc,CAAC,qBAAqB,GACpC,CAAC,GACD,OAAO,CAAC,SAAS,CAAC,GAClB,OAAO,CAAC,SAAS,CAAC,GAClB,KAAK,CAAC,SAAS,CAAC,CA2DlB,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,CACnB,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACjC,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACjC,KAAK,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC/B,CAAC,EAED,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,EAC3C,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACjF,OAAO,CAAC,EAAE;IACR,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1C,GAAG,SAAS,KACV,KAAK,CAAC,KAAK,CACd,KAAK,EACL,KAAK,EACH,cAAc,CAAC,cAAc,GAC7B,cAAc,CAAC,qBAAqB,GACpC,CAAC,GACD,OAAO,CAAC,SAAS,CAAC,GAClB,OAAO,CAAC,SAAS,CAAC,GAClB,KAAK,CAAC,SAAS,CAAC,CAC0E,CAAA"}

package/dist/dts/index.d.ts

@@ -10,6 +10,10 @@ export * as DurableClock from "./DurableClock.js";
  * @since 1.0.0
  */
 export * as DurableDeferred from "./DurableDeferred.js";
+/**
+ * @since 1.0.0
+ */
+export * as DurableQueue from "./DurableQueue.js";
 /**
  * @since 1.0.0
  */

package/dist/dts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAE7D;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAE7D;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA"}

package/dist/esm/DurableQueue.js

@@ -0,0 +1,176 @@
+/**
+ * @since 1.0.0
+ */
+import * as PersistedQueue from "@effect/experimental/PersistedQueue";
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Schedule from "effect/Schedule";
+import * as Schema from "effect/Schema";
+import * as Activity from "./Activity.js";
+import * as DurableDeferred from "./DurableDeferred.js";
+import { makeHashDigest } from "./internal/crypto.js";
+/**
+ * @since 1.0.0
+ * @category Type IDs
+ */
+export const TypeId = "~@effect/workflow/DurableQueue";
+/**
+ * A `DurableQueue` wraps a `PersistedQueue`, providing a way to wait for items
+ * to finish processing using a `DurableDeferred`.
+ *
+ * ```ts
+ * import { DurableQueue, Workflow } from "@effect/workflow"
+ * import { Effect, Schema } from "effect"
+ *
+ * // Define a DurableQueue that can be used to derive workers and offer items for
+ * // processing.
+ * const ApiQueue = DurableQueue.make({
+ *   name: "ApiQueue",
+ *   payload: {
+ *     id: Schema.String
+ *   },
+ *   success: Schema.Void,
+ *   error: Schema.Never,
+ *   idempotencyKey(payload) {
+ *     return payload.id
+ *   }
+ * })
+ *
+ * const MyWorkflow = Workflow.make({
+ *   name: "MyWorkflow",
+ *   payload: {
+ *     id: Schema.String
+ *   },
+ *   idempotencyKey: ({ id }) => id
+ * })
+ *
+ * const MyWorkflowLayer = MyWorkflow.toLayer(
+ *   Effect.fn(function*() {
+ *     // Add an item to the DurableQueue defined above.
+ *     //
+ *     // When the worker has finished processing the item, the workflow will
+ *     // resume.
+ *     //
+ *     yield* DurableQueue.process(ApiQueue, { id: "api-call-1" })
+ *
+ *     yield* Effect.log("Workflow succeeded!")
+ *   })
+ * )
+ *
+ * // Define a worker layer that can process items from the DurableQueue.
+ * const ApiWorker = DurableQueue.worker(
+ *   ApiQueue,
+ *   Effect.fn(function*({ id }) {
+ *     yield* Effect.log(`Worker processing API call with id: ${id}`)
+ *   }),
+ *   { concurrency: 5 } // Process up to 5 items concurrently
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export const make = options => ({
+  [TypeId]: TypeId,
+  name: options.name,
+  payloadSchema: Schema.isSchema(options.payload) ? options.payload : Schema.Struct(options.payload),
+  idempotencyKey: options.idempotencyKey,
+  deferred: DurableDeferred.make(`DurableQueue/${options.name}`, {
+    success: options.success,
+    error: options.error
+  })
+});
+const queueSchemas = /*#__PURE__*/new WeakMap();
+const getQueueSchema = payload => {
+  let schema = queueSchemas.get(payload);
+  if (!schema) {
+    schema = Schema.Struct({
+      token: Schema.String,
+      traceId: Schema.String,
+      spanId: Schema.String,
+      sampled: Schema.Boolean,
+      payload
+    });
+    queueSchemas.set(payload, schema);
+  }
+  return schema;
+};
+/**
+ * @since 1.0.0
+ * @category Processing
+ */
+export const process = /*#__PURE__*/Effect.fnUntraced(function* (self, payload, options) {
+  const key = yield* makeHashDigest(self.idempotencyKey(payload));
+  const deferred = DurableDeferred.make(`${self.deferred.name}/${key}`, {
+    success: self.deferred.successSchema,
+    error: self.deferred.errorSchema
+  });
+  yield* Activity.make({
+    name: `DurableQueue/${self.name}/${key}`,
+    execute: Effect.gen(function* () {
+      const span = yield* Effect.orDie(Effect.currentSpan);
+      const queue = yield* PersistedQueue.make({
+        name: `DurableQueue/${self.name}`,
+        schema: getQueueSchema(self.payloadSchema)
+      });
+      const token = yield* DurableDeferred.token(deferred);
+      yield* queue.offer({
+        token,
+        payload,
+        traceId: span.traceId,
+        spanId: span.spanId,
+        sampled: span.sampled
+      }).pipe(Effect.tapErrorCause(Effect.logWarning), Effect.catchTag("ParseError", Effect.die), Effect.retry(options?.retrySchedule ?? defaultRetrySchedule), Effect.orDie, Effect.annotateLogs({
+        package: "@effect/workflow",
+        module: "DurableQueue",
+        fiber: "process",
+        queueName: self.name
+      }));
+    })
+  });
+  return yield* DurableDeferred.await(deferred);
+});
+const defaultRetrySchedule = /*#__PURE__*/Schedule.exponential(500, 1.5).pipe(/*#__PURE__*/Schedule.union(/*#__PURE__*/Schedule.spaced("1 minute")));
+/**
+ * @since 1.0.0
+ * @category Worker
+ */
+export const makeWorker = /*#__PURE__*/Effect.fnUntraced(function* (self, f, options) {
+  const queue = yield* PersistedQueue.make({
+    name: `DurableQueue/${self.name}`,
+    schema: getQueueSchema(self.payloadSchema)
+  });
+  const concurrency = options?.concurrency ?? 1;
+  const worker = queue.take(item_ => {
+    const item = item_;
+    return f(item.payload).pipe(Effect.exit, Effect.flatMap(exit => DurableDeferred.done(self.deferred, {
+      token: item.token,
+      exit
+    })), Effect.asVoid, Effect.withSpan(`DurableQueue/${self.name}/worker`, {
+      captureStackTrace: false,
+      parent: {
+        _tag: "ExternalSpan",
+        traceId: item.traceId,
+        spanId: item.spanId,
+        sampled: item.sampled,
+        context: Context.empty()
+      }
+    }));
+  }).pipe(Effect.catchAllCause(Effect.logWarning), Effect.forever, Effect.annotateLogs({
+    package: "@effect/workflow",
+    module: "DurableQueue",
+    fiber: "worker"
+  }));
+  yield* Effect.replicateEffect(worker, concurrency, {
+    concurrency,
+    discard: true
+  });
+  return yield* Effect.never;
+});
+/**
+ * @since 1.0.0
+ * @category Worker
+ */
+export const worker = (self, f, options) => Layer.scopedDiscard(Effect.forkScoped(makeWorker(self, f, options)));
+//# sourceMappingURL=DurableQueue.js.map

package/dist/esm/DurableQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DurableQueue.js","names":["PersistedQueue","Context","Effect","Layer","Schedule","Schema","Activity","DurableDeferred","makeHashDigest","TypeId","make","options","name","payloadSchema","isSchema","payload","Struct","idempotencyKey","deferred","success","error","queueSchemas","WeakMap","getQueueSchema","schema","get","token","String","traceId","spanId","sampled","Boolean","set","process","fnUntraced","self","key","successSchema","errorSchema","execute","gen","span","orDie","currentSpan","queue","offer","pipe","tapErrorCause","logWarning","catchTag","die","retry","retrySchedule","defaultRetrySchedule","annotateLogs","package","module","fiber","queueName","await","exponential","union","spaced","makeWorker","f","concurrency","worker","take","item_","item","exit","flatMap","done","asVoid","withSpan","captureStackTrace","parent","_tag","context","empty","catchAllCause","forever","replicateEffect","discard","never","scopedDiscard","forkScoped"],"sources":["../../src/DurableQueue.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,cAAc,MAAM,qCAAqC;AACrE,OAAO,KAAKC,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,QAAQ,MAAM,iBAAiB;AAC3C,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,QAAQ,MAAM,eAAe;AACzC,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AACvD,SAASC,cAAc,QAAQ,sBAAsB;AASrD;;;;AAIA,OAAO,MAAMC,MAAM,GAAW,gCAAgC;AAkB9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwDA,OAAO,MAAMC,IAAI,GAKfC,OAQC,KAKG;EACJ,CAACF,MAAM,GAAGA,MAAM;EAChBG,IAAI,EAAED,OAAO,CAACC,IAAI;EAClBC,aAAa,EAAER,MAAM,CAACS,QAAQ,CAACH,OAAO,CAACI,OAAO,CAAC,GAAGJ,OAAO,CAACI,OAAO,GAAGV,MAAM,CAACW,MAAM,CAACL,OAAO,CAACI,OAAO,CAAQ;EACzGE,cAAc,EAAEN,OAAO,CAACM,cAAqB;EAC7CC,QAAQ,EAAEX,eAAe,CAACG,IAAI,CAAC,gBAAgBC,OAAO,CAACC,IAAI,EAAE,EAAE;IAC7DO,OAAO,EAAER,OAAO,CAACQ,OAAO;IACxBC,KAAK,EAAET,OAAO,CAACS;GAChB;CACF,CAAC;AAEF,MAAMC,YAAY,gBAAG,IAAIC,OAAO,EAAwC;AACxE,MAAMC,cAAc,GAClBR,OAAgB,IAOb;EACH,IAAIS,MAAM,GAAGH,YAAY,CAACI,GAAG,CAACV,OAAO,CAAC;EACtC,IAAI,CAACS,MAAM,EAAE;IACXA,MAAM,GAAGnB,MAAM,CAACW,MAAM,CAAC;MACrBU,KAAK,EAAErB,MAAM,CAACsB,MAAM;MACpBC,OAAO,EAAEvB,MAAM,CAACsB,MAAM;MACtBE,MAAM,EAAExB,MAAM,CAACsB,MAAM;MACrBG,OAAO,EAAEzB,MAAM,CAAC0B,OAAO;MACvBhB;KACD,CAAC;IACFM,YAAY,CAACW,GAAG,CAACjB,OAAO,EAAES,MAAM,CAAC;EACnC;EACA,OAAOA,MAAa;AACtB,CAAC;AAED;;;;AAIA,OAAO,MAAMS,OAAO,gBAmBhB/B,MAAM,CAACgC,UAAU,CAAC,WAIpBC,IAA2C,EAAEpB,OAAwB,EAAEJ,OAExE;EACC,MAAMyB,GAAG,GAAG,OAAO5B,cAAc,CAAC2B,IAAI,CAAClB,cAAc,CAACF,OAAO,CAAC,CAAC;EAE/D,MAAMG,QAAQ,GAAGX,eAAe,CAACG,IAAI,CAAC,GAAGyB,IAAI,CAACjB,QAAQ,CAACN,IAAI,IAAIwB,GAAG,EAAE,EAAE;IACpEjB,OAAO,EAAEgB,IAAI,CAACjB,QAAQ,CAACmB,aAAa;IACpCjB,KAAK,EAAEe,IAAI,CAACjB,QAAQ,CAACoB;GACtB,CAAC;EAEF,OAAOhC,QAAQ,CAACI,IAAI,CAAC;IACnBE,IAAI,EAAE,gBAAgBuB,IAAI,CAACvB,IAAI,IAAIwB,GAAG,EAAE;IACxCG,OAAO,EAAErC,MAAM,CAACsC,GAAG,CAAC,aAAS;MAC3B,MAAMC,IAAI,GAAG,OAAOvC,MAAM,CAACwC,KAAK,CAACxC,MAAM,CAACyC,WAAW,CAAC;MACpD,MAAMC,KAAK,GAAG,OAAO5C,cAAc,CAACU,IAAI,CAAC;QACvCE,IAAI,EAAE,gBAAgBuB,IAAI,CAACvB,IAAI,EAAE;QACjCY,MAAM,EAAED,cAAc,CAACY,IAAI,CAACtB,aAAa;OAC1C,CAAC;MACF,MAAMa,KAAK,GAAG,OAAOnB,eAAe,CAACmB,KAAK,CAACR,QAAQ,CAAC;MACpD,OAAO0B,KAAK,CAACC,KAAK,CAAC;QACjBnB,KAAK;QACLX,OAAO;QACPa,OAAO,EAAEa,IAAI,CAACb,OAAO;QACrBC,MAAM,EAAEY,IAAI,CAACZ,MAAM;QACnBC,OAAO,EAAEW,IAAI,CAACX;OACR,CAAC,CAACgB,IAAI,CACZ5C,MAAM,CAAC6C,aAAa,CAAC7C,MAAM,CAAC8C,UAAU,CAAC,EACvC9C,MAAM,CAAC+C,QAAQ,CAAC,YAAY,EAAE/C,MAAM,CAACgD,GAAG,CAAC,EACzChD,MAAM,CAACiD,KAAK,CAACxC,OAAO,EAAEyC,aAAa,IAAIC,oBAAoB,CAAC,EAC5DnD,MAAM,CAACwC,KAAK,EACZxC,MAAM,CAACoD,YAAY,CAAC;QAClBC,OAAO,EAAE,kBAAkB;QAC3BC,MAAM,EAAE,cAAc;QACtBC,KAAK,EAAE,SAAS;QAChBC,SAAS,EAAEvB,IAAI,CAACvB;OACjB,CAAC,CACH;IACH,CAAC;GACF,CAAC;EAEF,OAAO,OAAOL,eAAe,CAACoD,KAAK,CAACzC,QAAQ,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAMmC,oBAAoB,gBAAGjD,QAAQ,CAACwD,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAACd,IAAI,cAC9D1C,QAAQ,CAACyD,KAAK,cAACzD,QAAQ,CAAC0D,MAAM,CAAC,UAAU,CAAC,CAAC,CAC5C;AAED;;;;AAIA,OAAO,MAAMC,UAAU,gBAkBnB7D,MAAM,CAACgC,UAAU,CAAC,WAMpBC,IAA2C,EAC3C6B,CAAiF,EACjFrD,OAEC;EAED,MAAMiC,KAAK,GAAG,OAAO5C,cAAc,CAACU,IAAI,CAAC;IACvCE,IAAI,EAAE,gBAAgBuB,IAAI,CAACvB,IAAI,EAAE;IACjCY,MAAM,EAAED,cAAc,CAACY,IAAI,CAACtB,aAAa;GAC1C,CAAC;EACF,MAAMoD,WAAW,GAAGtD,OAAO,EAAEsD,WAAW,IAAI,CAAC;EAE7C,MAAMC,MAAM,GAAGtB,KAAK,CAACuB,IAAI,CAAEC,KAAK,IAAI;IAClC,MAAMC,IAAI,GAAGD,KAMZ;IACD,OAAOJ,CAAC,CAACK,IAAI,CAACtD,OAAO,CAAC,CAAC+B,IAAI,CACzB5C,MAAM,CAACoE,IAAI,EACXpE,MAAM,CAACqE,OAAO,CAAED,IAAI,IAClB/D,eAAe,CAACiE,IAAI,CAACrC,IAAI,CAACjB,QAAQ,EAAE;MAClCQ,KAAK,EAAE2C,IAAI,CAAC3C,KAAK;MACjB4C;KACD,CAAC,CACH,EACDpE,MAAM,CAACuE,MAAM,EACbvE,MAAM,CAACwE,QAAQ,CAAC,gBAAgBvC,IAAI,CAACvB,IAAI,SAAS,EAAE;MAClD+D,iBAAiB,EAAE,KAAK;MACxBC,MAAM,EAAE;QACNC,IAAI,EAAE,cAAc;QACpBjD,OAAO,EAAEyC,IAAI,CAACzC,OAAO;QACrBC,MAAM,EAAEwC,IAAI,CAACxC,MAAM;QACnBC,OAAO,EAAEuC,IAAI,CAACvC,OAAO;QACrBgD,OAAO,EAAE7E,OAAO,CAAC8E,KAAK;;KAEzB,CAAC,CACH;EACH,CAAC,CAAC,CAACjC,IAAI,CACL5C,MAAM,CAAC8E,aAAa,CAAC9E,MAAM,CAAC8C,UAAU,CAAC,EACvC9C,MAAM,CAAC+E,OAAO,EACd/E,MAAM,CAACoD,YAAY,CAAC;IAClBC,OAAO,EAAE,kBAAkB;IAC3BC,MAAM,EAAE,cAAc;IACtBC,KAAK,EAAE;GACR,CAAC,CACH;EAED,OAAOvD,MAAM,CAACgF,eAAe,CAAChB,MAAM,EAAED,WAAW,EAAE;IAAEA,WAAW;IAAEkB,OAAO,EAAE;EAAI,CAAE,CAAC;EAClF,OAAO,OAAOjF,MAAM,CAACkF,KAAK;AAC5B,CAAC,CAAC;AAEF;;;;AAIA,OAAO,MAAMlB,MAAM,GAoBfA,CAAC/B,IAAI,EAAE6B,CAAC,EAAErD,OAAO,KAAKR,KAAK,CAACkF,aAAa,CAACnF,MAAM,CAACoF,UAAU,CAACvB,UAAU,CAAC5B,IAAI,EAAE6B,CAAC,EAAErD,OAAO,CAAC,CAAC,CAAC","ignoreList":[]}

package/dist/esm/index.js

@@ -10,6 +10,10 @@ export * as DurableClock from "./DurableClock.js";
  * @since 1.0.0
  */
 export * as DurableDeferred from "./DurableDeferred.js";
+/**
+ * @since 1.0.0
+ */
+export * as DurableQueue from "./DurableQueue.js";
 /**
  * @since 1.0.0
  */

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Activity","DurableClock","DurableDeferred","DurableRateLimiter","Workflow","WorkflowEngine","WorkflowProxy","WorkflowProxyServer"],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB;AAE7D;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Activity","DurableClock","DurableDeferred","DurableQueue","DurableRateLimiter","Workflow","WorkflowEngine","WorkflowProxy","WorkflowProxyServer"],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB;AAE7D;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/workflow",
-  "version": "0.13.0",
+  "version": "0.13.1",
   "description": "Durable workflows for Effect",
   "license": "MIT",
   "repository": {
@@ -11,9 +11,9 @@
   "sideEffects": [],
   "homepage": "https://effect.website",
   "peerDependencies": {
-    "effect": "^3.19.5",
-    "@effect/experimental": "^0.57.3",
-    "@effect/platform": "^0.93.3",
+    "effect": "^3.19.8",
+    "@effect/experimental": "^0.57.7",
+    "@effect/platform": "^0.93.5",
     "@effect/rpc": "^0.72.2"
   },
   "publishConfig": {
@@ -44,6 +44,11 @@
       "import": "./dist/esm/DurableDeferred.js",
       "default": "./dist/cjs/DurableDeferred.js"
     },
+    "./DurableQueue": {
+      "types": "./dist/dts/DurableQueue.d.ts",
+      "import": "./dist/esm/DurableQueue.js",
+      "default": "./dist/cjs/DurableQueue.js"
+    },
     "./DurableRateLimiter": {
       "types": "./dist/dts/DurableRateLimiter.d.ts",
       "import": "./dist/esm/DurableRateLimiter.js",
@@ -81,6 +86,9 @@
       "DurableDeferred": [
         "./dist/dts/DurableDeferred.d.ts"
       ],
+      "DurableQueue": [
+        "./dist/dts/DurableQueue.d.ts"
+      ],
       "DurableRateLimiter": [
         "./dist/dts/DurableRateLimiter.d.ts"
       ],

package/src/DurableQueue.ts

@@ -0,0 +1,332 @@
+/**
+ * @since 1.0.0
+ */
+import * as PersistedQueue from "@effect/experimental/PersistedQueue"
+import * as Context from "effect/Context"
+import * as Effect from "effect/Effect"
+import * as Layer from "effect/Layer"
+import * as Schedule from "effect/Schedule"
+import * as Schema from "effect/Schema"
+import * as Activity from "./Activity.js"
+import * as DurableDeferred from "./DurableDeferred.js"
+import { makeHashDigest } from "./internal/crypto.js"
+import type * as WorkflowEngine from "./WorkflowEngine.js"
+
+/**
+ * @since 1.0.0
+ * @category Type IDs
+ */
+export type TypeId = "~@effect/workflow/DurableQueue"
+
+/**
+ * @since 1.0.0
+ * @category Type IDs
+ */
+export const TypeId: TypeId = "~@effect/workflow/DurableQueue"
+
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export interface DurableQueue<
+  Payload extends Schema.Schema.Any,
+  Success extends Schema.Schema.Any = typeof Schema.Void,
+  Error extends Schema.Schema.All = typeof Schema.Never
+> {
+  readonly [TypeId]: TypeId
+  readonly name: string
+  readonly payloadSchema: Payload
+  readonly idempotencyKey: (payload: Payload["Type"]) => string
+  readonly deferred: DurableDeferred.DurableDeferred<Success, Error>
+}
+
+/**
+ * A `DurableQueue` wraps a `PersistedQueue`, providing a way to wait for items
+ * to finish processing using a `DurableDeferred`.
+ *
+ * ```ts
+ * import { DurableQueue, Workflow } from "@effect/workflow"
+ * import { Effect, Schema } from "effect"
+ *
+ * // Define a DurableQueue that can be used to derive workers and offer items for
+ * // processing.
+ * const ApiQueue = DurableQueue.make({
+ *   name: "ApiQueue",
+ *   payload: {
+ *     id: Schema.String
+ *   },
+ *   success: Schema.Void,
+ *   error: Schema.Never,
+ *   idempotencyKey(payload) {
+ *     return payload.id
+ *   }
+ * })
+ *
+ * const MyWorkflow = Workflow.make({
+ *   name: "MyWorkflow",
+ *   payload: {
+ *     id: Schema.String
+ *   },
+ *   idempotencyKey: ({ id }) => id
+ * })
+ *
+ * const MyWorkflowLayer = MyWorkflow.toLayer(
+ *   Effect.fn(function*() {
+ *     // Add an item to the DurableQueue defined above.
+ *     //
+ *     // When the worker has finished processing the item, the workflow will
+ *     // resume.
+ *     //
+ *     yield* DurableQueue.process(ApiQueue, { id: "api-call-1" })
+ *
+ *     yield* Effect.log("Workflow succeeded!")
+ *   })
+ * )
+ *
+ * // Define a worker layer that can process items from the DurableQueue.
+ * const ApiWorker = DurableQueue.worker(
+ *   ApiQueue,
+ *   Effect.fn(function*({ id }) {
+ *     yield* Effect.log(`Worker processing API call with id: ${id}`)
+ *   }),
+ *   { concurrency: 5 } // Process up to 5 items concurrently
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export const make = <
+  Payload extends Schema.Schema.Any | Schema.Struct.Fields,
+  Success extends Schema.Schema.Any = typeof Schema.Void,
+  Error extends Schema.Schema.All = typeof Schema.Never
+>(
+  options: {
+    readonly name: string
+    readonly payload: Payload
+    readonly idempotencyKey: (
+      payload: Payload extends Schema.Struct.Fields ? Schema.Struct<Payload>["Type"] : Payload["Type"]
+    ) => string
+    readonly success?: Success | undefined
+    readonly error?: Error | undefined
+  }
+): DurableQueue<
+  Payload extends Schema.Struct.Fields ? Schema.Struct<Payload> : Payload,
+  Success,
+  Error
+> => ({
+  [TypeId]: TypeId,
+  name: options.name,
+  payloadSchema: Schema.isSchema(options.payload) ? options.payload : Schema.Struct(options.payload) as any,
+  idempotencyKey: options.idempotencyKey as any,
+  deferred: DurableDeferred.make(`DurableQueue/${options.name}`, {
+    success: options.success,
+    error: options.error
+  })
+})
+
+const queueSchemas = new WeakMap<Schema.Schema.Any, Schema.Schema.Any>()
+const getQueueSchema = <Payload extends Schema.Schema.Any>(
+  payload: Payload
+): Schema.Struct<{
+  token: typeof Schema.String
+  payload: Payload
+  traceId: typeof Schema.String
+  spanId: typeof Schema.String
+  sampled: typeof Schema.Boolean
+}> => {
+  let schema = queueSchemas.get(payload)
+  if (!schema) {
+    schema = Schema.Struct({
+      token: Schema.String,
+      traceId: Schema.String,
+      spanId: Schema.String,
+      sampled: Schema.Boolean,
+      payload
+    })
+    queueSchemas.set(payload, schema)
+  }
+  return schema as any
+}
+
+/**
+ * @since 1.0.0
+ * @category Processing
+ */
+export const process: <
+  Payload extends Schema.Schema.Any,
+  Success extends Schema.Schema.Any,
+  Error extends Schema.Schema.All
+>(
+  self: DurableQueue<Payload, Success, Error>,
+  payload: Payload["Type"],
+  options?: {
+    readonly retrySchedule?: Schedule.Schedule<any, PersistedQueue.PersistedQueueError> | undefined
+  }
+) => Effect.Effect<
+  Success["Type"],
+  Error["Type"],
+  | WorkflowEngine.WorkflowEngine
+  | WorkflowEngine.WorkflowInstance
+  | PersistedQueue.PersistedQueueFactory
+  | Success["Context"]
+  | Error["Context"]
+  | Payload["Context"]
+> = Effect.fnUntraced(function*<
+  Payload extends Schema.Schema.Any,
+  Success extends Schema.Schema.Any,
+  Error extends Schema.Schema.All
+>(self: DurableQueue<Payload, Success, Error>, payload: Payload["Type"], options?: {
+  readonly retrySchedule?: Schedule.Schedule<any, PersistedQueue.PersistedQueueError> | undefined
+}) {
+  const key = yield* makeHashDigest(self.idempotencyKey(payload))
+
+  const deferred = DurableDeferred.make(`${self.deferred.name}/${key}`, {
+    success: self.deferred.successSchema,
+    error: self.deferred.errorSchema
+  })
+
+  yield* Activity.make({
+    name: `DurableQueue/${self.name}/${key}`,
+    execute: Effect.gen(function*() {
+      const span = yield* Effect.orDie(Effect.currentSpan)
+      const queue = yield* PersistedQueue.make({
+        name: `DurableQueue/${self.name}`,
+        schema: getQueueSchema(self.payloadSchema)
+      })
+      const token = yield* DurableDeferred.token(deferred)
+      yield* queue.offer({
+        token,
+        payload,
+        traceId: span.traceId,
+        spanId: span.spanId,
+        sampled: span.sampled
+      } as any).pipe(
+        Effect.tapErrorCause(Effect.logWarning),
+        Effect.catchTag("ParseError", Effect.die),
+        Effect.retry(options?.retrySchedule ?? defaultRetrySchedule),
+        Effect.orDie,
+        Effect.annotateLogs({
+          package: "@effect/workflow",
+          module: "DurableQueue",
+          fiber: "process",
+          queueName: self.name
+        })
+      )
+    })
+  })
+
+  return yield* DurableDeferred.await(deferred)
+})
+
+const defaultRetrySchedule = Schedule.exponential(500, 1.5).pipe(
+  Schedule.union(Schedule.spaced("1 minute"))
+)
+
+/**
+ * @since 1.0.0
+ * @category Worker
+ */
+export const makeWorker: <
+  Payload extends Schema.Schema.Any,
+  Success extends Schema.Schema.Any,
+  Error extends Schema.Schema.All,
+  R
+>(
+  self: DurableQueue<Payload, Success, Error>,
+  f: (payload: Payload["Type"]) => Effect.Effect<Success["Type"], Error["Type"], R>,
+  options?: { readonly concurrency?: number | undefined } | undefined
+) => Effect.Effect<
+  never,
+  never,
+  | WorkflowEngine.WorkflowEngine
+  | PersistedQueue.PersistedQueueFactory
+  | R
+  | Payload["Context"]
+  | Success["Context"]
+  | Error["Context"]
+> = Effect.fnUntraced(function*<
+  Payload extends Schema.Schema.Any,
+  Success extends Schema.Schema.Any,
+  Error extends Schema.Schema.All,
+  R
+>(
+  self: DurableQueue<Payload, Success, Error>,
+  f: (payload: Payload["Type"]) => Effect.Effect<Success["Type"], Error["Type"], R>,
+  options?: {
+    readonly concurrency?: number | undefined
+  }
+) {
+  const queue = yield* PersistedQueue.make({
+    name: `DurableQueue/${self.name}`,
+    schema: getQueueSchema(self.payloadSchema)
+  })
+  const concurrency = options?.concurrency ?? 1
+
+  const worker = queue.take((item_) => {
+    const item = item_ as any as {
+      token: DurableDeferred.Token
+      payload: Payload["Type"]
+      traceId: string
+      spanId: string
+      sampled: boolean
+    }
+    return f(item.payload).pipe(
+      Effect.exit,
+      Effect.flatMap((exit) =>
+        DurableDeferred.done(self.deferred, {
+          token: item.token,
+          exit
+        })
+      ),
+      Effect.asVoid,
+      Effect.withSpan(`DurableQueue/${self.name}/worker`, {
+        captureStackTrace: false,
+        parent: {
+          _tag: "ExternalSpan",
+          traceId: item.traceId,
+          spanId: item.spanId,
+          sampled: item.sampled,
+          context: Context.empty()
+        }
+      })
+    )
+  }).pipe(
+    Effect.catchAllCause(Effect.logWarning),
+    Effect.forever,
+    Effect.annotateLogs({
+      package: "@effect/workflow",
+      module: "DurableQueue",
+      fiber: "worker"
+    })
+  )
+
+  yield* Effect.replicateEffect(worker, concurrency, { concurrency, discard: true })
+  return yield* Effect.never
+})
+
+/**
+ * @since 1.0.0
+ * @category Worker
+ */
+export const worker: <
+  Payload extends Schema.Schema.Any,
+  Success extends Schema.Schema.Any,
+  Error extends Schema.Schema.All,
+  R
+>(
+  self: DurableQueue<Payload, Success, Error>,
+  f: (payload: Payload["Type"]) => Effect.Effect<Success["Type"], Error["Type"], R>,
+  options?: {
+    readonly concurrency?: number | undefined
+  } | undefined
+) => Layer.Layer<
+  never,
+  never,
+  | WorkflowEngine.WorkflowEngine
+  | PersistedQueue.PersistedQueueFactory
+  | R
+  | Payload["Context"]
+  | Success["Context"]
+  | Error["Context"]
+> = (self, f, options) => Layer.scopedDiscard(Effect.forkScoped(makeWorker(self, f, options)))

package/src/index.ts

@@ -13,6 +13,11 @@ export * as DurableClock from "./DurableClock.js"
  */
 export * as DurableDeferred from "./DurableDeferred.js"
 
+/**
+ * @since 1.0.0
+ */
+export * as DurableQueue from "./DurableQueue.js"
+
 /**
  * @since 1.0.0
  */