effect-cf 0.8.0 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # effect-cf
 
+## 0.9.0
+
+### Minor Changes
+
+- [#25](https://github.com/danieljvdm/effect-cf/pull/25) [`c7daaff`](https://github.com/danieljvdm/effect-cf/commit/c7daaff779934c83519ad9689e1f98dc100b5251) Thanks [@danieljvdm](https://github.com/danieljvdm)! - Add a Durable Object `initialize` hook for running Effect setup each time Cloudflare loads a Durable Object instance into memory.
+
 ## 0.8.0
 
 ### Minor Changes

package/README.md

@@ -240,6 +240,25 @@ In definition-backed workflows, the `payload` argument is the typed decoded payl
 
 ## Durable Object WebSockets
 
+Use `initialize` for work that should run each time Cloudflare loads a Durable
+Object instance into memory. Yield `state.blockConcurrencyWhile(...)` when
+later events should wait for initialize to finish. If work should happen only once
+for a Durable Object id, store a sentinel in Durable Object storage.
+
+```ts
+export const RoomLive = DurableObject.make(layer, {
+  initialize: Effect.gen(function* () {
+    const state = yield* DurableObjectState.DurableObjectState;
+    yield* state.blockConcurrencyWhile(
+      Effect.gen(function* () {
+        yield* state.storage.put("loadedAt", Date.now());
+      }),
+    );
+  }),
+  fetch,
+});
+```
+
 Durable Object application sockets should use the hibernation-compatible state API. Accept sockets with `DurableObjectWebSocket.acceptUpgrade(...)`; do not call `server.accept()` or attach native `message` listeners in application code.
 
 ```ts

package/dist/index.d.mts

@@ -376,7 +376,7 @@ declare const method$3: {
   <Success extends ServiceFreeSchema$3>(definition: {
     readonly success: Success;
   }): Method$4<readonly [], Success>;
-  <const Args extends ReadonlyArray<ServiceFreeSchema$3>, Success extends ServiceFreeSchema$3>(definition: {
+  <const Args extends readonly ServiceFreeSchema$3[], Success extends ServiceFreeSchema$3>(definition: {
     readonly args: Args;
     readonly success: Success;
   }): Method$4<Args, Success>;
@@ -1288,6 +1288,15 @@ type RpcHandlers<ROut, Api> = { readonly [Key in keyof Api as Key extends keyof
  * Options for creating a Durable Object class backed by Effect handlers.
  */
 interface DurableObjectOptions<ROut, Rpc extends DurableObjectRpc<ROut>> {
+  /**
+   * Effect run when Cloudflare loads this Durable Object instance into memory.
+   *
+   * Use `DurableObjectState.blockConcurrencyWhile` inside this hook when
+   * incoming events should wait for setup to finish. Cloudflare may construct
+   * the same Durable Object id again after eviction or restart; use Durable
+   * Object storage if work must happen only once per id.
+   */
+  readonly initialize?: Effect.Effect<void, unknown, HandlerContext<ROut>>;
   /** Optional RPC methods exposed as Durable Object instance methods. */
   readonly rpc?: Rpc;
   /** Optional fetch handler for HTTP/WebSocket requests. */

package/dist/index.mjs

@@ -1253,6 +1253,8 @@ const make$4 = (layer, options = {}) => {
 			super(state, env);
 			const runtimeLayer = provideEntrypointServices(layer, Layer.mergeAll(Layer.succeed(DurableObjectState, fromDurableObjectState(state)), Layer.succeed(WorkerEnvironment, env)));
 			this.runtime = ManagedRuntime.make(runtimeLayer);
+			const initialize = options.initialize;
+			if (initialize !== void 0) state.waitUntil(this[RunSymbol](initialize));
 		}
 		[RunSymbol](effect) {
 			return this.runtime.runPromise(Effect.scoped(effect));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "effect-cf",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Effect-native primitives for Cloudflare Workers and bindings.",
   "license": "MIT",
   "repository": {

package/src/DurableObject.ts

@@ -73,6 +73,15 @@ export type RpcHandlers<ROut, Api> = {
  * Options for creating a Durable Object class backed by Effect handlers.
  */
 export interface DurableObjectOptions<ROut, Rpc extends DurableObjectRpc<ROut>> {
+  /**
+   * Effect run when Cloudflare loads this Durable Object instance into memory.
+   *
+   * Use `DurableObjectState.blockConcurrencyWhile` inside this hook when
+   * incoming events should wait for setup to finish. Cloudflare may construct
+   * the same Durable Object id again after eviction or restart; use Durable
+   * Object storage if work must happen only once per id.
+   */
+  readonly initialize?: Effect.Effect<void, unknown, HandlerContext<ROut>>;
   /** Optional RPC methods exposed as Durable Object instance methods. */
   readonly rpc?: Rpc;
   /** Optional fetch handler for HTTP/WebSocket requests. */
@@ -137,6 +146,11 @@ export const make = <
       const runtimeLayer = Entrypoint.provideEntrypointServices(layer, services);
 
       this.runtime = ManagedRuntime.make(runtimeLayer);
+
+      const initialize = options.initialize;
+      if (initialize !== undefined) {
+        state.waitUntil(this[RunSymbol](initialize));
+      }
     }
 
     [RunSymbol]<A, E>(effect: Effect.Effect<A, E, HandlerContext<ROut>>): Promise<A> {