@livestore/sync-cf 0.4.0-dev.1 → 0.4.0-dev.10

package/dist/common/ws-rpc-schema.d.ts

@@ -0,0 +1,55 @@
+import { InvalidPullError, InvalidPushError } from '@livestore/common';
+import { Rpc, RpcGroup, Schema } from '@livestore/utils/effect';
+declare const SyncWsRpc_base: RpcGroup.RpcGroup<Rpc.Rpc<"SyncWsRpc.Pull", Schema.Struct<{
+    cursor: Schema.Option<Schema.Struct<{
+        backendId: Schema.SchemaClass<string, string, never>;
+        eventSequenceNumber: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+    }>>;
+    storeId: typeof Schema.String;
+    payload: Schema.optional<Schema.Schema<Schema.JsonValue, Schema.JsonValue, never>>;
+    /** Whether to keep the pull stream alive and wait for more events */
+    live: typeof Schema.Boolean;
+}>, import("@effect/rpc/RpcSchema").Stream<Schema.Struct<{
+    batch: Schema.Array$<Schema.Struct<{
+        eventEncoded: Schema.Struct<{
+            name: typeof Schema.String;
+            args: typeof Schema.Any;
+            seqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+            parentSeqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+            clientId: typeof Schema.String;
+            sessionId: typeof Schema.String;
+        }>;
+        metadata: Schema.Option<Schema.Struct<{
+            _tag: Schema.tag<"SyncMessage.SyncMetadata">;
+        } & {
+            createdAt: typeof Schema.String;
+        }>>;
+    }>>;
+    pageInfo: Schema.Union<[Schema.TaggedStruct<"MoreUnknown", {}>, Schema.TaggedStruct<"MoreKnown", {
+        remaining: typeof Schema.Number;
+    }>, Schema.TaggedStruct<"NoMore", {}>]>;
+    backendId: Schema.SchemaClass<string, string, never>;
+}>, typeof InvalidPullError>, typeof Schema.Never, never> | Rpc.Rpc<"SyncWsRpc.Push", Schema.Struct<{
+    batch: Schema.Array$<Schema.Struct<{
+        name: typeof Schema.String;
+        args: typeof Schema.Any;
+        seqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+        parentSeqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+        clientId: typeof Schema.String;
+        sessionId: typeof Schema.String;
+    }>>;
+    backendId: Schema.Option<Schema.SchemaClass<string, string, never>>;
+    storeId: typeof Schema.String;
+    payload: Schema.optional<Schema.Schema<Schema.JsonValue, Schema.JsonValue, never>>;
+}>, Schema.Struct<{}>, typeof InvalidPushError, never>>;
+/**
+ * WebSocket RPC Schema for LiveStore CF Sync Provider
+ *
+ * This defines the RPC endpoints available over WebSocket transport.
+ * Unlike HTTP transport which uses request/response patterns for each operation,
+ * WebSocket transport maintains a persistent connection and uses streaming responses.
+ */
+export declare class SyncWsRpc extends SyncWsRpc_base {
+}
+export {};
+//# sourceMappingURL=ws-rpc-schema.d.ts.map

package/dist/common/ws-rpc-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-rpc-schema.d.ts","sourceRoot":"","sources":["../../src/common/ws-rpc-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;;;;;;;;IAezD,qEAAqE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAZ3E;;;;;;GAMG;AACH,qBAAa,SAAU,SAAQ,cAwB9B;CAAG"}

package/dist/common/ws-rpc-schema.js

@@ -0,0 +1,32 @@
+import { InvalidPullError, InvalidPushError } from '@livestore/common';
+import { Rpc, RpcGroup, Schema } from '@livestore/utils/effect';
+import * as SyncMessage from "./sync-message-types.js";
+/**
+ * WebSocket RPC Schema for LiveStore CF Sync Provider
+ *
+ * This defines the RPC endpoints available over WebSocket transport.
+ * Unlike HTTP transport which uses request/response patterns for each operation,
+ * WebSocket transport maintains a persistent connection and uses streaming responses.
+ */
+export class SyncWsRpc extends RpcGroup.make(Rpc.make('SyncWsRpc.Pull', {
+    payload: Schema.Struct({
+        storeId: Schema.String,
+        payload: Schema.optional(Schema.JsonValue),
+        /** Whether to keep the pull stream alive and wait for more events */
+        live: Schema.Boolean,
+        ...SyncMessage.PullRequest.fields,
+    }),
+    success: SyncMessage.PullResponse,
+    error: InvalidPullError,
+    stream: true,
+}), Rpc.make('SyncWsRpc.Push', {
+    payload: Schema.Struct({
+        storeId: Schema.String,
+        payload: Schema.optional(Schema.JsonValue),
+        ...SyncMessage.PushRequest.fields,
+    }),
+    success: SyncMessage.PushAck,
+    error: InvalidPushError,
+})) {
+}
+//# sourceMappingURL=ws-rpc-schema.js.map

package/dist/common/ws-rpc-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-rpc-schema.js","sourceRoot":"","sources":["../../src/common/ws-rpc-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAA;AAEtD;;;;;;GAMG;AACH,MAAM,OAAO,SAAU,SAAQ,QAAQ,CAAC,IAAI,CAC1C,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE;IACzB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC,MAAM;QACtB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;QAC1C,qEAAqE;QACrE,IAAI,EAAE,MAAM,CAAC,OAAO;QACpB,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM;KAClC,CAAC;IACF,OAAO,EAAE,WAAW,CAAC,YAAY;IACjC,KAAK,EAAE,gBAAgB;IACvB,MAAM,EAAE,IAAI;CACb,CAAC,EACF,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE;IACzB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC,MAAM;QACtB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;QAC1C,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM;KAClC,CAAC;IACF,OAAO,EAAE,WAAW,CAAC,OAAO;IAC5B,KAAK,EAAE,gBAAgB;CACxB,CAAC,CAGH;CAAG"}

package/package.json

@@ -1,19 +1,18 @@
 {
   "name": "@livestore/sync-cf",
-  "version": "0.4.0-dev.1",
+  "version": "0.4.0-dev.10",
   "type": "module",
   "sideEffects": false,
   "exports": {
-    ".": "./dist/sync-impl/mod.js",
+    "./client": "./dist/client/mod.js",
     "./common": "./dist/common/mod.js",
-    "./cf-worker": "./dist/cf-worker/mod.js",
-    "./cf-worker/durable-object": "./dist/cf-worker/durable-object.js",
-    "./cf-worker/worker": "./dist/cf-worker/worker.js"
+    "./cf-worker": "./dist/cf-worker/mod.js"
   },
   "dependencies": {
-    "@cloudflare/workers-types": "4.20250807.0",
-    "@livestore/common": "0.4.0-dev.1",
-    "@livestore/utils": "0.4.0-dev.1"
+    "@cloudflare/workers-types": "4.20250923.0",
+    "@livestore/common": "0.4.0-dev.10",
+    "@livestore/utils": "0.4.0-dev.10",
+    "@livestore/common-cf": "0.4.0-dev.10"
   },
   "files": [
     "dist",

package/src/cf-worker/do/durable-object.ts

@@ -0,0 +1,237 @@
+/// <reference types="@cloudflare/workers-types" />
+
+import { DurableObject } from 'cloudflare:workers'
+import { type CfTypes, setupDurableObjectWebSocketRpc } from '@livestore/common-cf'
+import { CfDeclare } from '@livestore/common-cf/declare'
+import {
+  Effect,
+  FetchHttpClient,
+  Layer,
+  Logger,
+  LogLevel,
+  Otlp,
+  RpcMessage,
+  Schema,
+  type Scope,
+} from '@livestore/utils/effect'
+import {
+  type Env,
+  type MakeDurableObjectClassOptions,
+  matchSyncRequest,
+  type SyncBackendRpcInterface,
+  WebSocketAttachmentSchema,
+} from '../shared.ts'
+import { DoCtx } from './layer.ts'
+import { createDoRpcHandler } from './transport/do-rpc-server.ts'
+import { createHttpRpcHandler } from './transport/http-rpc-server.ts'
+import { makeRpcServer } from './transport/ws-rpc-server.ts'
+
+// NOTE We need to redeclare runtime types here to avoid type conflicts with the lib.dom Response type.
+// TODO get rid of those once CF fixed their type mismatch in the worker types
+declare class Request extends CfDeclare.Request {}
+declare class Response extends CfDeclare.Response {}
+declare class WebSocketPair extends CfDeclare.WebSocketPair {}
+declare class WebSocketRequestResponsePair extends CfDeclare.WebSocketRequestResponsePair {}
+
+const DurableObjectBase = DurableObject<Env> as any as new (
+  state: CfTypes.DurableObjectState,
+  env: Env,
+) => CfTypes.DurableObject & { ctx: CfTypes.DurableObjectState; env: Env }
+
+// Type aliases needed to avoid TS bug https://github.com/microsoft/TypeScript/issues/55021
+export type DoState = CfTypes.DurableObjectState
+export type DoObject<T> = CfTypes.DurableObject & T
+
+export type MakeDurableObjectClass = (options?: MakeDurableObjectClassOptions) => {
+  new (ctx: DoState, env: Env): DoObject<SyncBackendRpcInterface>
+}
+
+/**
+ * Creates a Durable Object class for handling WebSocket-based sync.
+ * A sync durable object is uniquely scoped to a specific `storeId`.
+ * 
+ * The sync DO supports 3 transport modes:
+ * - HTTP JSON-RPC
+ * - WebSocket
+ * - Durable Object RPC calls (only works in combination with `@livestore/adapter-cf`)
+ *
+ * Example:
+ * 
+ * ```ts
+ * // In your Cloudflare Worker file
+ * import { makeDurableObject } from '@livestore/sync-cf/cf-worker'
+ *
+ * export class SyncBackendDO extends makeDurableObject({
+ *   onPush: async (message) => {
+ *     console.log('onPush', message.batch)
+ *   },
+ *   onPull: async (message) => {
+ *     console.log('onPull', message)
+ *   },
+ * }) {}
+ * ```
+ *
+ * `wrangler.toml`
+ * ```toml
+ * [[durable_objects.bindings]]
+ * name = "SYNC_BACKEND_DO"
+ * class_name = "SyncBackendDO"
+
+ * [[migrations]]
+ * tag = "v1"
+ * new_sqlite_classes = ["SyncBackendDO"]
+ * ```
+ */
+export const makeDurableObject: MakeDurableObjectClass = (options) => {
+  const enabledTransports = options?.enabledTransports ?? new Set(['http', 'ws', 'do-rpc'])
+
+  const Logging = Logger.consoleWithThread('SyncDo')
+
+  const Observability = options?.otel?.baseUrl
+    ? Otlp.layer({
+        baseUrl: options.otel.baseUrl,
+        tracerExportInterval: 50,
+        resource: {
+          serviceName: options.otel.serviceName ?? 'sync-cf-do',
+        },
+      }).pipe(Layer.provide(FetchHttpClient.layer))
+    : Layer.empty
+
+  return class SyncBackendDOBase extends DurableObjectBase implements SyncBackendRpcInterface {
+    __DURABLE_OBJECT_BRAND = 'SyncBackendDOBase' as never
+
+    constructor(ctx: CfTypes.DurableObjectState, env: Env) {
+      super(ctx, env)
+
+      const WebSocketRpcServerLive = makeRpcServer({ doSelf: this, doOptions: options })
+
+      // This registers the `webSocketMessage` and `webSocketClose` handlers
+      if (enabledTransports.has('ws')) {
+        setupDurableObjectWebSocketRpc({
+          doSelf: this,
+          rpcLayer: WebSocketRpcServerLive,
+          webSocketMode: 'hibernate',
+          // See `pull.ts` for more details how `pull` Effect RPC requests streams are handled
+          // in combination with DO hibernation
+          onMessage: (request, ws) => {
+            if (request._tag === 'Request' && request.tag === 'SyncWsRpc.Pull') {
+              // Is Pull request: add requestId to pullRequestIds
+              const attachment = ws.deserializeAttachment()
+              const { pullRequestIds, ...rest } = Schema.decodeSync(WebSocketAttachmentSchema)(attachment)
+              ws.serializeAttachment(
+                Schema.encodeSync(WebSocketAttachmentSchema)({
+                  ...rest,
+                  pullRequestIds: [...pullRequestIds, request.id],
+                }),
+              )
+            } else if (request._tag === 'Interrupt') {
+              // Is Interrupt request: remove requestId from pullRequestIds
+              const attachment = ws.deserializeAttachment()
+              const { pullRequestIds, ...rest } = Schema.decodeSync(WebSocketAttachmentSchema)(attachment)
+              ws.serializeAttachment(
+                Schema.encodeSync(WebSocketAttachmentSchema)({
+                  ...rest,
+                  pullRequestIds: pullRequestIds.filter((id) => id !== request.requestId),
+                }),
+              )
+              // TODO also emit `Exit` stream RPC message
+            }
+          },
+          mainLayer: Observability,
+        })
+      }
+    }
+
+    fetch = async (request: Request): Promise<Response> =>
+      Effect.gen(this, function* () {
+        const searchParams = matchSyncRequest(request)
+        if (searchParams === undefined) {
+          throw new Error('No search params found in request URL')
+        }
+
+        const { storeId, payload, transport } = searchParams
+
+        if (enabledTransports.has(transport) === false) {
+          throw new Error(`Transport ${transport} is not enabled (based on \`options.enabledTransports\`)`)
+        }
+
+        if (transport === 'http') {
+          return yield* this.handleHttp(request)
+        }
+
+        if (transport === 'ws') {
+          const { 0: client, 1: server } = new WebSocketPair()
+
+          // Since we're using websocket hibernation, we need to remember the storeId for subsequent `webSocketMessage` calls
+          server.serializeAttachment(
+            Schema.encodeSync(WebSocketAttachmentSchema)({ storeId, payload, pullRequestIds: [] }),
+          )
+
+          // See https://developers.cloudflare.com/durable-objects/examples/websocket-hibernation-server
+
+          this.ctx.acceptWebSocket(server)
+
+          // Ping requests are sent by Effect RPC internally
+          this.ctx.setWebSocketAutoResponse(
+            new WebSocketRequestResponsePair(
+              JSON.stringify(RpcMessage.constPing),
+              JSON.stringify(RpcMessage.constPong),
+            ),
+          )
+
+          return new Response(null, {
+            status: 101,
+            webSocket: client,
+          })
+        }
+
+        console.error('Invalid path', request.url)
+
+        return new Response('Invalid path', {
+          status: 400,
+          statusText: 'Bad Request',
+        })
+      }).pipe(
+        Effect.tapCauseLogPretty, // Also log errors to console before catching them
+        Effect.catchAllCause((cause) =>
+          Effect.succeed(new Response('Error', { status: 500, statusText: cause.toString() })),
+        ),
+        Effect.withSpan('@livestore/sync-cf:durable-object:fetch'),
+        Effect.provide(DoCtx.Default({ doSelf: this, doOptions: options, from: request })),
+        this.runEffectAsPromise,
+      )
+
+    /**
+     * Handles DO <-> DO RPC calls
+     */
+    async rpc(payload: Uint8Array<ArrayBuffer>): Promise<Uint8Array<ArrayBuffer> | CfTypes.ReadableStream> {
+      if (enabledTransports.has('do-rpc') === false) {
+        throw new Error('Do RPC transport is not enabled (based on `options.enabledTransports`)')
+      }
+
+      return createDoRpcHandler({ payload, input: { doSelf: this, doOptions: options } }).pipe(
+        Effect.withSpan('@livestore/sync-cf:durable-object:rpc'),
+        this.runEffectAsPromise,
+      )
+    }
+
+    /**
+     * Handles HTTP RPC calls
+     *
+     * Requires the `enable_request_signal` compatibility flag to properly support `pull` streaming responses
+     */
+    private handleHttp = (request: CfTypes.Request) =>
+      createHttpRpcHandler({
+        request,
+      }).pipe(Effect.withSpan('@livestore/sync-cf:durable-object:handleHttp'))
+
+    private runEffectAsPromise = <T, E = never>(effect: Effect.Effect<T, E, Scope.Scope>): Promise<T> =>
+      effect.pipe(
+        Effect.tapCauseLogPretty,
+        Logger.withMinimumLogLevel(LogLevel.Debug),
+        Effect.provide(Layer.mergeAll(Observability, Logging)),
+        Effect.scoped,
+        Effect.runPromise,
+      )
+  }
+}

package/src/cf-worker/do/layer.ts

@@ -0,0 +1,128 @@
+import { UnexpectedError } from '@livestore/common'
+import { EventSequenceNumber, State } from '@livestore/common/schema'
+import type { CfTypes } from '@livestore/common-cf'
+import { shouldNeverHappen } from '@livestore/utils'
+import { Effect, Predicate } from '@livestore/utils/effect'
+import { nanoid } from '@livestore/utils/nanoid'
+import type { Env, MakeDurableObjectClassOptions, RpcSubscription } from '../shared.ts'
+import { contextTable, eventlogTable } from './sqlite.ts'
+import { makeStorage } from './sync-storage.ts'
+
+const CacheSymbol = Symbol('Cache')
+
+export interface DoCtxInput {
+  doSelf: CfTypes.DurableObject & {
+    ctx: CfTypes.DurableObjectState
+    env: Env
+  }
+  doOptions: MakeDurableObjectClassOptions | undefined
+  from: CfTypes.Request | { storeId: string }
+}
+
+export class DoCtx extends Effect.Service<DoCtx>()('DoCtx', {
+  effect: Effect.fn(
+    function* ({ doSelf, doOptions, from }: DoCtxInput) {
+      if ((doSelf as any)[CacheSymbol] !== undefined) {
+        return (doSelf as any)[CacheSymbol] as never
+      }
+
+      const getStoreId = (from: CfTypes.Request | { storeId: string }) => {
+        if (Predicate.hasProperty(from, 'url')) {
+          const url = new URL(from.url)
+          return (
+            url.searchParams.get('storeId') ?? shouldNeverHappen(`No storeId provided in request URL search params`)
+          )
+        }
+        return from.storeId
+      }
+
+      const storeId = getStoreId(from)
+      // Resolve storage engine
+      const makeEngine = Effect.gen(function* () {
+        const opt = doOptions?.storage
+        if (opt?._tag === 'd1') {
+          const db = (doSelf.env as any)[opt.binding]
+          if (!db) {
+            return yield* UnexpectedError.make({ cause: new Error(`D1 binding '${opt.binding}' not found on env`) })
+          }
+          return { _tag: 'd1' as const, db }
+        } else if (opt?._tag === 'do-sqlite' || opt === undefined) {
+          return { _tag: 'do-sqlite' as const }
+        } else return shouldNeverHappen(`Invalid storage engine`, opt)
+      })
+
+      const engine = yield* makeEngine
+
+      const storage = makeStorage(doSelf.ctx, storeId, engine)
+
+      // Initialize database tables
+      {
+        const colSpec = State.SQLite.makeColumnSpec(eventlogTable.sqliteDef.ast)
+        if (engine._tag === 'd1') {
+          // D1 database is async, so we need to use a promise
+          yield* Effect.promise(() =>
+            engine.db.exec(`CREATE TABLE IF NOT EXISTS "${storage.dbName}" (${colSpec}) strict`),
+          )
+        } else {
+          // DO SQLite table lives in Durable Object storage
+          doSelf.ctx.storage.sql.exec(`CREATE TABLE IF NOT EXISTS "${storage.dbName}" (${colSpec}) strict`)
+        }
+      }
+      {
+        const colSpec = State.SQLite.makeColumnSpec(contextTable.sqliteDef.ast)
+        doSelf.ctx.storage.sql.exec(`CREATE TABLE IF NOT EXISTS "${contextTable.sqliteDef.name}" (${colSpec}) strict`)
+      }
+
+      const storageRow = doSelf.ctx.storage.sql
+        .exec(`SELECT * FROM "${contextTable.sqliteDef.name}" WHERE storeId = ?`, storeId)
+        .toArray()[0] as typeof contextTable.rowSchema.Type | undefined
+
+      const currentHeadRef = { current: storageRow?.currentHead ?? EventSequenceNumber.ROOT.global }
+
+      // TODO do concistency check with eventlog table to make sure the head is consistent
+
+      // Should be the same backendId for lifetime of the durable object
+      const backendId = storageRow?.backendId ?? nanoid()
+
+      const updateCurrentHead = (currentHead: EventSequenceNumber.GlobalEventSequenceNumber) => {
+        doSelf.ctx.storage.sql.exec(
+          `INSERT OR REPLACE INTO "${contextTable.sqliteDef.name}" (storeId, currentHead, backendId) VALUES (?, ?, ?)`,
+          storeId,
+          currentHead,
+          backendId,
+        )
+
+        currentHeadRef.current = currentHead
+
+        // I still don't know why we need to re-assign this ref to the `doSelf` object but somehow this seems to be needed 😵‍💫
+        // @ts-expect-error
+        doSelf[CacheSymbol].currentHeadRef = { current: currentHead }
+      }
+
+      const rpcSubscriptions = new Map<string, RpcSubscription>()
+
+      const storageCache = {
+        storeId,
+        backendId,
+        currentHeadRef,
+        updateCurrentHead,
+        storage,
+        doOptions,
+        env: doSelf.env,
+        ctx: doSelf.ctx,
+        rpcSubscriptions,
+      }
+
+      ;(doSelf as any)[CacheSymbol] = storageCache
+
+      // Set initial current head to root
+      if (storageRow === undefined) {
+        updateCurrentHead(EventSequenceNumber.ROOT.global)
+      }
+
+      return storageCache
+    },
+    UnexpectedError.mapToUnexpectedError,
+    Effect.withSpan('@livestore/sync-cf:durable-object:makeDoCtx'),
+  ),
+}) {}

package/src/cf-worker/do/pull.ts

@@ -0,0 +1,77 @@
+import { BackendIdMismatchError, InvalidPullError, SyncBackend, UnexpectedError } from '@livestore/common'
+import { splitChunkBySize } from '@livestore/common/sync'
+import { Chunk, Effect, Option, Schema, Stream } from '@livestore/utils/effect'
+import { MAX_PULL_EVENTS_PER_MESSAGE, MAX_WS_MESSAGE_BYTES } from '../../common/constants.ts'
+import { SyncMessage } from '../../common/mod.ts'
+import { DoCtx } from './layer.ts'
+
+const encodePullResponse = Schema.encodeSync(SyncMessage.PullResponse)
+
+// Notes on stream handling:
+// We're intentionally closing the stream once we've read all existing events
+//
+// WebSocket:
+// - Further chunks will be emitted manually in `push.ts`
+// - If the client sends a `Interrupt` RPC message, it will be handled in the `durable-object.ts` constructor
+// DO RPC:
+// - Further chunks will be emitted manually in `push.ts`
+// - If the client sends a `Interrupt` RPC message, TODO
+export const makeEndingPullStream = (
+  req: SyncMessage.PullRequest,
+  payload: Schema.JsonValue | undefined,
+): Stream.Stream<SyncMessage.PullResponse, InvalidPullError, DoCtx> =>
+  Effect.gen(function* () {
+    const { doOptions, backendId, storeId, storage } = yield* DoCtx
+
+    if (doOptions?.onPull) {
+      yield* Effect.tryAll(() => doOptions!.onPull!(req, { storeId, payload })).pipe(
+        UnexpectedError.mapToUnexpectedError,
+      )
+    }
+
+    if (req.cursor._tag === 'Some' && req.cursor.value.backendId !== backendId) {
+      return yield* new BackendIdMismatchError({ expected: backendId, received: req.cursor.value.backendId })
+    }
+
+    const { stream: storedEvents, total } = yield* storage.getEvents(
+      Option.getOrUndefined(req.cursor)?.eventSequenceNumber,
+    )
+
+    return storedEvents.pipe(
+      Stream.mapChunksEffect(
+        splitChunkBySize({
+          maxItems: MAX_PULL_EVENTS_PER_MESSAGE,
+          maxBytes: MAX_WS_MESSAGE_BYTES,
+          encode: (batch) =>
+            encodePullResponse(
+              SyncMessage.PullResponse.make({ batch, pageInfo: SyncBackend.pageInfoNoMore, backendId }),
+            ),
+        }),
+      ),
+      Stream.mapAccum(total, (remaining, chunk) => {
+        const asArray = Chunk.toReadonlyArray(chunk)
+        const nextRemaining = Math.max(0, remaining - asArray.length)
+
+        return [
+          nextRemaining,
+          SyncMessage.PullResponse.make({
+            batch: asArray,
+            pageInfo: nextRemaining > 0 ? SyncBackend.pageInfoMoreKnown(nextRemaining) : SyncBackend.pageInfoNoMore,
+            backendId,
+          }),
+        ] as const
+      }),
+      Stream.tap(
+        Effect.fn(function* (res) {
+          if (doOptions?.onPullRes) {
+            yield* Effect.tryAll(() => doOptions.onPullRes!(res)).pipe(UnexpectedError.mapToUnexpectedError)
+          }
+        }),
+      ),
+      Stream.emitIfEmpty(SyncMessage.emptyPullResponse(backendId)),
+    )
+  }).pipe(
+    Stream.unwrap,
+    Stream.mapError((cause) => InvalidPullError.make({ cause })),
+    Stream.withSpan('cloudflare-provider:pull'),
+  )