@livestore/sync-cf 0.0.58-dev.6

package/dist/sync-impl/ws-impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-impl.js","sourceRoot":"","sources":["../../src/sync-impl/ws-impl.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAG3B,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAE5C,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAElH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAgB9C,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAAsB,EAAwD,EAAE,CACzG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,KAAK,GAAG,GAAG,OAAO,CAAC,GAAG,mBAAmB,OAAO,CAAC,MAAM,EAAE,CAAA;IAE/D,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAErE,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,EAAE,CAAA;IAE9B,MAAM,GAAG,GAAG;QACV,WAAW;QACX,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAC/B,YAAY;YACV,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,IAAI,CACtC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACf,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAC1F,EACD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,EACjD,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACjB,oBAAoB,EAAE,CAAC,CAAC,oBAAoB;gBAC5C,SAAS,EAAE,CAAC,CAAC,SAAS;gBACtB,QAAQ;aACT,CAAC,CAAC,CACJ;YACH,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAClB,MAAM,SAAS,GAAG,IAAI,EAAE,CAAA;gBACxB,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;gBAElD,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,CAAA;gBAE1D,OAAO,MAAM,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,EAC/C,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACf,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,CAAC,CAAC,IAAI,gBAAgB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAC1F,EACD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAC3C,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,KAAK,CAAC,EAC5C,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAC3B,MAAM,CAAC,gBAAgB,EACvB,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;oBACpC,oBAAoB;oBACpB,QAAQ;oBACR,SAAS,EAAE,IAAI;iBAChB,CAAC,CAAC,CACJ,CAAA;YACH,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,EAAE,CAAC,oBAAoB,EAAE,SAAS,EAAE,EAAE,CACxC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAClB,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,EAA0B,CAAA;YAC5D,MAAM,SAAS,GAAG,IAAI,EAAE,CAAA;YAExB,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,EAC/C,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACf,CAAC,CAAC,IAAI,KAAK,iBAAiB;gBAC1B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,gBAAgB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBACpE,CAAC,CAAC,MAAM,CAAC,IAAI,CAChB,EACD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAC3C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,oBAAoB,CAAC,EAAE,CAAC,EAC9D,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EACd,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACjD,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,iBAAiB,EACxB,MAAM,CAAC,IAAI,CACZ,CAAA;YAED,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,oBAAoB,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC,CAAA;YAEnF,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YAE5B,OAAO,EAAE,QAAQ,EAAE,CAAA;QACrB,CAAC,CAAC;KACuB,CAAA;IAE7B,OAAO,GAAG,CAAA;AACZ,CAAC,CAAC,CAAA;AAEJ,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,EAAE,CAChC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtD,MAAM,KAAK,GAAuC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAA;IAExE,MAAM,gBAAgB,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,SAAS,EAAsD,CAAA;IAEtG,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;IAEzG,MAAM,IAAI,GAAG,CAAC,OAA0B,EAAE,EAAE,CAC1C,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,gCAAgC;QAChC,KAAK,CAAC,CAAC,eAAe,CAAA;QAEtB,KAAK,CAAC,OAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAA;IACtF,CAAC,CAAC,CAAA;IAEJ,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QACvC,4FAA4F;QAC5F,+FAA+F;QAC/F,OAAO,SAAS,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YAClC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC3B,CAAC;QACD,oCAAoC;QACpC,wFAAwF;QACxF,IAAI;QAEJ,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,CAAA;QAC/B,MAAM,gBAAgB,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAQ,CAAA;QAErD,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,SAAS,EAAkB,CAAA;QAE7D,MAAM,cAAc,GAAG,CAAC,KAAwB,EAAQ,EAAE;YACxD,MAAM,eAAe,GAAG,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAE3G,IAAI,eAAe,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBACpC,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,eAAe,CAAC,IAAI,CAAC,CAAA;gBACrE,OAAM;YACR,CAAC;iBAAM,CAAC;gBACN,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;oBACpD,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;gBACvE,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;gBAC9E,CAAC;YACH,CAAC;QACH,CAAC,CAAA;QAED,MAAM,cAAc,GAAG,GAAG,EAAE;YAC1B,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACjE,CAAC,CAAA;QAED,4GAA4G;QAC5G,wGAAwG;QACxG,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;QAEhD,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAC9B,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAClB,EAAE,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;YACjD,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;YACnD,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,CAAA;YACtB,KAAK,CAAC,OAAO,GAAG,SAAS,CAAA;YACzB,KAAK,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;QAChD,CAAC,CAAC,CACH,CAAA;QAED,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;QAE9C,IAAI,EAAE,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;YACrC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAA;YAClB,eAAe,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAC7D,CAAC;aAAM,CAAC;YACN,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE;gBAC/B,KAAK,CAAC,OAAO,GAAG,EAAE,CAAA;gBAClB,eAAe,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAC7D,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;YAChC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACjE,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;YAChC,EAAE,CAAC,KAAK,EAAE,CAAA;YACV,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACjE,CAAC,CAAC,CAAA;QAEF,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACxC,yDAAyD;YACzD,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAA;YAE1D,qFAAqF;YACrF,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;YAE1D,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAC7B,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,0CAA0C,CAAC,CAAC,CAAA;QAEpE,KAAK,CAAC,CAAC,eAAe,CAAC,IAAI,CACzB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAClD,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,CAAC,EACtE,MAAM,CAAC,UAAU,CAClB,CAAA;QAED,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;IACzC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAEtB,KAAK,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;IAErF,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAA;AAChD,CAAC,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@livestore/sync-cf",
+  "version": "0.0.58-dev.6",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/sync-impl/index.d.ts",
+      "default": "./dist/sync-impl/index.js"
+    }
+  },
+  "dependencies": {
+    "@livestore/common": "0.0.58-dev.6",
+    "@livestore/utils": "0.0.58-dev.6"
+  },
+  "devDependencies": {
+    "@cloudflare/workers-types": "4.20240729.0",
+    "wrangler": "^3.68.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "deploy": "wrangler publish",
+    "test": "echo 'No tests yet'"
+  }
+}

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

@@ -0,0 +1,187 @@
+import { makeColumnSpec } from '@livestore/common'
+import { DbSchema, type MutationEvent } from '@livestore/common/schema'
+import { shouldNeverHappen } from '@livestore/utils'
+import { Effect, Schema } from '@livestore/utils/effect'
+import { DurableObject } from 'cloudflare:workers'
+
+import { WSMessage } from '../common/index.js'
+
+export interface Env {
+  WEBSOCKET_SERVER: DurableObjectNamespace<WebSocketServer>
+  DB: D1Database
+  ADMIN_SECRET: string
+}
+
+type WebSocketClient = WebSocket
+
+const encodeMessage = Schema.encodeSync(Schema.parseJson(WSMessage.Message))
+const decodeMessage = Schema.decodeUnknownEither(Schema.parseJson(WSMessage.Message))
+
+export const mutationLogTable = DbSchema.table('__unused', {
+  // TODO add parent ids (see https://vlcn.io/blog/crdt-substrate)
+  id: DbSchema.text({ primaryKey: true }),
+  mutation: DbSchema.text({ nullable: false }),
+  args: DbSchema.text({ nullable: false, schema: Schema.parseJson(Schema.Any) }),
+})
+
+// Durable Object
+export class WebSocketServer extends DurableObject<Env> {
+  dbName = `mutation_log_${this.ctx.id.toString()}`
+  storage = makeStorage(this.ctx, this.env, this.dbName)
+
+  constructor(ctx: DurableObjectState, env: Env) {
+    super(ctx, env)
+  }
+
+  fetch = async (_request: Request) =>
+    Effect.gen(this, function* () {
+      const { 0: client, 1: server } = new WebSocketPair()
+
+      // See https://developers.cloudflare.com/durable-objects/examples/websocket-hibernation-server
+
+      this.ctx.acceptWebSocket(server)
+
+      this.ctx.setWebSocketAutoResponse(
+        new WebSocketRequestResponsePair(
+          encodeMessage(WSMessage.Ping.make({ requestId: 'ping' })),
+          encodeMessage(WSMessage.Pong.make({ requestId: 'ping' })),
+        ),
+      )
+
+      const colSpec = makeColumnSpec(mutationLogTable.sqliteDef.ast)
+      this.env.DB.exec(`CREATE TABLE IF NOT EXISTS ${this.dbName} (${colSpec}) strict`)
+
+      return new Response(null, {
+        status: 101,
+        webSocket: client,
+      })
+    }).pipe(Effect.tapCauseLogPretty, Effect.runPromise)
+
+  webSocketMessage = async (ws: WebSocketClient, message: ArrayBuffer | string) => {
+    const decodedMessageRes = decodeMessage(message)
+
+    if (decodedMessageRes._tag === 'Left') {
+      console.error('Invalid message received', decodedMessageRes.left)
+      return
+    }
+
+    const decodedMessage = decodedMessageRes.right
+    const requestId = decodedMessage.requestId
+
+    switch (decodedMessage._tag) {
+      case 'WSMessage.PullReq': {
+        const cursor = decodedMessage.cursor
+        const CHUNK_SIZE = 100
+
+        // TODO use streaming
+        const remainingEvents = [...(await this.storage.getEvents(cursor))]
+
+        // NOTE we want to make sure the WS server responds at least once with `InitRes` even if `events` is empty
+        while (true) {
+          const events = remainingEvents.splice(0, CHUNK_SIZE)
+          const hasMore = remainingEvents.length > 0
+
+          ws.send(encodeMessage(WSMessage.PullRes.make({ events, hasMore, requestId })))
+
+          if (hasMore === false) {
+            break
+          }
+        }
+
+        break
+      }
+      case 'WSMessage.PushReq': {
+        // NOTE we're currently not blocking on this to allow broadcasting right away
+        // however we should do some mutation validation first (e.g. checking parent event id)
+        const storePromise = decodedMessage.persisted
+          ? this.storage.appendEvent(decodedMessage.mutationEventEncoded)
+          : Promise.resolve()
+
+        ws.send(
+          encodeMessage(WSMessage.PushAck.make({ mutationId: decodedMessage.mutationEventEncoded.id, requestId })),
+        )
+
+        // console.debug(`Broadcasting mutation event to ${this.subscribedWebSockets.size} clients`)
+
+        const connectedClients = this.ctx.getWebSockets()
+
+        if (connectedClients.length > 0) {
+          const broadcastMessage = encodeMessage(
+            WSMessage.PushBroadcast.make({
+              mutationEventEncoded: decodedMessage.mutationEventEncoded,
+              requestId,
+              persisted: decodedMessage.persisted,
+            }),
+          )
+
+          for (const conn of connectedClients) {
+            console.log('Broadcasting to client', conn === ws ? 'self' : 'other')
+            if (conn !== ws) {
+              conn.send(broadcastMessage)
+            }
+          }
+        }
+
+        await storePromise
+
+        break
+      }
+      case 'WSMessage.AdminResetRoomReq': {
+        if (decodedMessage.adminSecret !== this.env.ADMIN_SECRET) {
+          ws.send(encodeMessage(WSMessage.Error.make({ message: 'Invalid admin secret', requestId })))
+          return
+        }
+
+        await this.storage.resetRoom()
+        ws.send(encodeMessage(WSMessage.AdminResetRoomRes.make({ requestId })))
+
+        break
+      }
+      case 'WSMessage.AdminInfoReq': {
+        if (decodedMessage.adminSecret !== this.env.ADMIN_SECRET) {
+          ws.send(encodeMessage(WSMessage.Error.make({ message: 'Invalid admin secret', requestId })))
+          return
+        }
+
+        ws.send(
+          encodeMessage(WSMessage.AdminInfoRes.make({ requestId, info: { durableObjectId: this.ctx.id.toString() } })),
+        )
+
+        break
+      }
+      default: {
+        console.error('unsupported message', decodedMessage)
+        return shouldNeverHappen()
+      }
+    }
+  }
+
+  webSocketClose = async (ws: WebSocketClient, code: number, _reason: string, _wasClean: boolean) => {
+    // If the client closes the connection, the runtime will invoke the webSocketClose() handler.
+    ws.close(code, 'Durable Object is closing WebSocket')
+  }
+}
+
+const makeStorage = (ctx: DurableObjectState, env: Env, dbName: string) => {
+  const getEvents = async (cursor: string | undefined): Promise<ReadonlyArray<MutationEvent.Any>> => {
+    const whereClause = cursor ? `WHERE id > '${cursor}'` : ''
+    // TODO handle case where `cursor` was not found
+    const rawEvents = await env.DB.prepare(`SELECT * FROM ${dbName} ${whereClause} ORDER BY id ASC`).all()
+    if (rawEvents.error) {
+      throw new Error(rawEvents.error)
+    }
+    const events = Schema.decodeUnknownSync(Schema.Array(mutationLogTable.schema))(rawEvents.results)
+    return events
+  }
+
+  const appendEvent = async (event: MutationEvent.Any) => {
+    const sql = `INSERT INTO ${dbName} (id, args, mutation) VALUES (?, ?, ?)`
+    await env.DB.prepare(sql).bind(event.id, JSON.stringify(event.args), event.mutation).run()
+  }
+
+  const resetRoom = async () => {
+    await ctx.storage.deleteAll()
+  }
+
+  return { getEvents, appendEvent, resetRoom }
+}

package/src/cf-worker/index.ts

@@ -0,0 +1,84 @@
+/// <reference no-default-lib="true"/>
+/// <reference lib="esnext" />
+
+// import { mutationEventSchemaEncodedAny } from '@livestore/common/schema'
+// import { Effect, HttpServer, Schema } from '@livestore/utils/effect'
+
+import type { Env } from './durable-object.js'
+
+export * from './durable-object.js'
+
+// const handleRequest = (request: Request, env: Env) =>
+//   HttpServer.router.empty.pipe(
+//     HttpServer.router.get(
+//       '/websocket',
+//       Effect.gen(function* () {
+//         // This example will refer to the same Durable Object instance,
+//         // since the name "foo" is hardcoded.
+//         const id = env.WEBSOCKET_SERVER.idFromName('foo')
+//         const durableObject = env.WEBSOCKET_SERVER.get(id)
+
+//         HttpServer.
+
+//         // Expect to receive a WebSocket Upgrade request.
+//         // If there is one, accept the request and return a WebSocket Response.
+//         const headerRes = yield* HttpServer.request
+//           .schemaHeaders(
+//             Schema.Struct({
+//               Upgrade: Schema.Literal('websocket'),
+//             }),
+//           )
+//           .pipe(Effect.either)
+
+//         if (headerRes._tag === 'Left') {
+//           // return new Response('Durable Object expected Upgrade: websocket', { status: 426 })
+//           return yield* HttpServer.response.text('Durable Object expected Upgrade: websocket', { status: 426 })
+//         }
+
+//         HttpServer.response.empty
+
+//         return yield* Effect.promise(() => durableObject.fetch(request))
+//       }),
+//     ),
+//     HttpServer.router.catchAll((e) => {
+//       console.log(e)
+//       return HttpServer.response.empty({ status: 400 })
+//     }),
+//     (_) => HttpServer.app.toWebHandler(_)(request),
+//     // request
+//   )
+
+// Worker
+export default {
+  fetch: async (request: Request, env: Env, _ctx: ExecutionContext): Promise<Response> => {
+    const url = new URL(request.url)
+    const searchParams = url.searchParams
+    const roomId = searchParams.get('room')
+
+    if (roomId === null) {
+      return new Response('Room ID is required', { status: 400 })
+    }
+
+    // This example will refer to the same Durable Object instance,
+    // since the name "foo" is hardcoded.
+    const id = env.WEBSOCKET_SERVER.idFromName(roomId)
+    const durableObject = env.WEBSOCKET_SERVER.get(id)
+
+    if (url.pathname.endsWith('/websocket')) {
+      const upgradeHeader = request.headers.get('Upgrade')
+      if (!upgradeHeader || upgradeHeader !== 'websocket') {
+        return new Response('Durable Object expected Upgrade: websocket', { status: 426 })
+      }
+
+      return durableObject.fetch(request)
+    }
+
+    return new Response(null, {
+      status: 400,
+      statusText: 'Bad Request',
+      headers: {
+        'Content-Type': 'text/plain',
+      },
+    })
+  },
+}

package/src/common/index.ts

@@ -0,0 +1 @@
+export * as WSMessage from './ws-message-types.js'

package/src/common/ws-message-types.ts

@@ -0,0 +1,109 @@
+import { mutationEventSchemaEncodedAny } from '@livestore/common/schema'
+import { Schema } from '@livestore/utils/effect'
+
+export const PullReq = Schema.TaggedStruct('WSMessage.PullReq', {
+  requestId: Schema.String,
+  /** Omitting the cursor will start from the beginning */
+  cursor: Schema.optional(Schema.String),
+})
+
+export type PullReq = typeof PullReq.Type
+
+export const PullRes = Schema.TaggedStruct('WSMessage.PullRes', {
+  requestId: Schema.String,
+  // /** The  */
+  // cursor: Schema.String,
+  events: Schema.Array(mutationEventSchemaEncodedAny),
+  hasMore: Schema.Boolean,
+})
+
+export type PullRes = typeof PullRes.Type
+
+export const PushBroadcast = Schema.TaggedStruct('WSMessage.PushBroadcast', {
+  requestId: Schema.String,
+  mutationEventEncoded: mutationEventSchemaEncodedAny,
+  persisted: Schema.Boolean,
+})
+
+export type PushBroadcast = typeof PushBroadcast.Type
+
+export const PushReq = Schema.TaggedStruct('WSMessage.PushReq', {
+  requestId: Schema.String,
+  mutationEventEncoded: mutationEventSchemaEncodedAny,
+  persisted: Schema.Boolean,
+})
+
+export type PushReq = typeof PushReq.Type
+
+export const PushAck = Schema.TaggedStruct('WSMessage.PushAck', {
+  requestId: Schema.String,
+  mutationId: Schema.String,
+})
+
+export type PushAck = typeof PushAck.Type
+
+export const Error = Schema.TaggedStruct('WSMessage.Error', {
+  requestId: Schema.String,
+  message: Schema.String,
+})
+
+export const Ping = Schema.TaggedStruct('WSMessage.Ping', {
+  requestId: Schema.Literal('ping'),
+})
+
+export type Ping = typeof Ping.Type
+
+export const Pong = Schema.TaggedStruct('WSMessage.Pong', {
+  requestId: Schema.Literal('ping'),
+})
+
+export type Pong = typeof Pong.Type
+
+export const AdminResetRoomReq = Schema.TaggedStruct('WSMessage.AdminResetRoomReq', {
+  requestId: Schema.String,
+  adminSecret: Schema.String,
+})
+
+export type AdminResetRoomReq = typeof AdminResetRoomReq.Type
+
+export const AdminResetRoomRes = Schema.TaggedStruct('WSMessage.AdminResetRoomRes', {
+  requestId: Schema.String,
+})
+
+export type AdminResetRoomRes = typeof AdminResetRoomRes.Type
+
+export const AdminInfoReq = Schema.TaggedStruct('WSMessage.AdminInfoReq', {
+  requestId: Schema.String,
+  adminSecret: Schema.String,
+})
+
+export type AdminInfoReq = typeof AdminInfoReq.Type
+
+export const AdminInfoRes = Schema.TaggedStruct('WSMessage.AdminInfoRes', {
+  requestId: Schema.String,
+  info: Schema.Struct({
+    durableObjectId: Schema.String,
+  }),
+})
+
+export type AdminInfoRes = typeof AdminInfoRes.Type
+
+export const Message = Schema.Union(
+  PullReq,
+  PullRes,
+  PushBroadcast,
+  PushReq,
+  PushAck,
+  Error,
+  Ping,
+  Pong,
+  AdminResetRoomReq,
+  AdminResetRoomRes,
+  AdminInfoReq,
+  AdminInfoRes,
+)
+export type Message = typeof Message.Type
+export type MessageEncoded = typeof Message.Encoded
+
+export const IncomingMessage = Schema.Union(PullRes, PushBroadcast, PushAck, Error, Pong)
+export type IncomingMessage = typeof IncomingMessage.Type

package/src/sync-impl/index.ts

@@ -0,0 +1 @@
+export * from './ws-impl.js'

package/src/sync-impl/ws-impl.ts

@@ -0,0 +1,210 @@
+/// <reference lib="dom" />
+
+import type { SyncBackend, SyncBackendOptionsBase } from '@livestore/common'
+import { InvalidPullError, InvalidPushError } from '@livestore/common'
+import { cuid } from '@livestore/utils/cuid'
+import type { Scope } from '@livestore/utils/effect'
+import { Deferred, Effect, Option, PubSub, Queue, Schema, Stream, SubscriptionRef } from '@livestore/utils/effect'
+
+import { WSMessage } from '../common/index.js'
+
+export interface WsSyncOptions extends SyncBackendOptionsBase {
+  type: 'cf'
+  url: string
+  roomId: string
+}
+
+interface LiveStoreGlobalCf {
+  syncBackend: WsSyncOptions
+}
+
+declare global {
+  interface LiveStoreGlobal extends LiveStoreGlobalCf {}
+}
+
+export const makeWsSync = (options: WsSyncOptions): Effect.Effect<SyncBackend<null>, never, Scope.Scope> =>
+  Effect.gen(function* () {
+    const wsUrl = `${options.url}/websocket?room=${options.roomId}`
+
+    const { isConnected, incomingMessages, send } = yield* connect(wsUrl)
+
+    const metadata = Option.none()
+
+    const api = {
+      isConnected,
+      pull: (args, { listenForNew }) =>
+        listenForNew
+          ? Stream.fromPubSub(incomingMessages).pipe(
+              Stream.tap((_) =>
+                _._tag === 'WSMessage.Error' ? new InvalidPullError({ message: _.message }) : Effect.void,
+              ),
+              Stream.filter(Schema.is(WSMessage.PushBroadcast)),
+              Stream.map((_) => ({
+                mutationEventEncoded: _.mutationEventEncoded,
+                persisted: _.persisted,
+                metadata,
+              })),
+            )
+          : Effect.gen(function* () {
+              const requestId = cuid()
+              const cursor = Option.getOrUndefined(args)?.cursor
+
+              yield* send(WSMessage.PullReq.make({ cursor, requestId }))
+
+              return Stream.fromPubSub(incomingMessages).pipe(
+                Stream.filter((_) => _.requestId === requestId),
+                Stream.tap((_) =>
+                  _._tag === 'WSMessage.Error' ? new InvalidPullError({ message: _.message }) : Effect.void,
+                ),
+                Stream.filter(Schema.is(WSMessage.PullRes)),
+                Stream.takeUntil((_) => _.hasMore === false),
+                Stream.map((_) => _.events),
+                Stream.flattenIterables,
+                Stream.map((mutationEventEncoded) => ({
+                  mutationEventEncoded,
+                  metadata,
+                  persisted: true,
+                })),
+              )
+            }).pipe(Stream.unwrap),
+      push: (mutationEventEncoded, persisted) =>
+        Effect.gen(function* () {
+          const ready = yield* Deferred.make<void, InvalidPushError>()
+          const requestId = cuid()
+
+          yield* Stream.fromPubSub(incomingMessages).pipe(
+            Stream.filter((_) => _.requestId === requestId),
+            Stream.tap((_) =>
+              _._tag === 'WSMessage.Error'
+                ? Deferred.fail(ready, new InvalidPushError({ message: _.message }))
+                : Effect.void,
+            ),
+            Stream.filter(Schema.is(WSMessage.PushAck)),
+            Stream.filter((_) => _.mutationId === mutationEventEncoded.id),
+            Stream.take(1),
+            Stream.tap(() => Deferred.succeed(ready, void 0)),
+            Stream.runDrain,
+            Effect.tapCauseLogPretty,
+            Effect.fork,
+          )
+
+          yield* send(WSMessage.PushReq.make({ mutationEventEncoded, requestId, persisted }))
+
+          yield* Deferred.await(ready)
+
+          return { metadata }
+        }),
+    } satisfies SyncBackend<null>
+
+    return api
+  })
+
+const connect = (wsUrl: string) =>
+  Effect.gen(function* () {
+    const isConnected = yield* SubscriptionRef.make(false)
+    const wsRef: { current: WebSocket | undefined } = { current: undefined }
+
+    const incomingMessages = yield* PubSub.unbounded<Exclude<WSMessage.IncomingMessage, WSMessage.Pong>>()
+
+    const waitUntilOnline = isConnected.changes.pipe(Stream.filter(Boolean), Stream.take(1), Stream.runDrain)
+
+    const send = (message: WSMessage.Message) =>
+      Effect.gen(function* () {
+        // Wait first until we're online
+        yield* waitUntilOnline
+
+        wsRef.current!.send(Schema.encodeSync(Schema.parseJson(WSMessage.Message))(message))
+      })
+
+    const innerConnect = Effect.gen(function* () {
+      // If the browser already tells us we're offline, then we'll at least wait until the browser
+      // thinks we're online again. (We'll only know for sure once the WS conneciton is established.)
+      while (navigator.onLine === false) {
+        yield* Effect.sleep(1000)
+      }
+      // if (navigator.onLine === false) {
+      //   yield* Effect.async((cb) => self.addEventListener('online', () => cb(Effect.void)))
+      // }
+
+      const ws = new WebSocket(wsUrl)
+      const connectionClosed = yield* Deferred.make<void>()
+
+      const pongMessages = yield* Queue.unbounded<WSMessage.Pong>()
+
+      const messageHandler = (event: MessageEvent<any>): void => {
+        const decodedEventRes = Schema.decodeUnknownEither(Schema.parseJson(WSMessage.IncomingMessage))(event.data)
+
+        if (decodedEventRes._tag === 'Left') {
+          console.error('Sync: Invalid message received', decodedEventRes.left)
+          return
+        } else {
+          if (decodedEventRes.right._tag === 'WSMessage.Pong') {
+            Queue.offer(pongMessages, decodedEventRes.right).pipe(Effect.runSync)
+          } else {
+            PubSub.publish(incomingMessages, decodedEventRes.right).pipe(Effect.runSync)
+          }
+        }
+      }
+
+      const offlineHandler = () => {
+        Deferred.succeed(connectionClosed, void 0).pipe(Effect.runSync)
+      }
+
+      // NOTE it seems that this callback doesn't work reliably on a worker but only via `window.addEventListener`
+      // We might need to proxy the event from the main thread to the worker if we want this to work reliably.
+      self.addEventListener('offline', offlineHandler)
+
+      yield* Effect.addFinalizer(() =>
+        Effect.gen(function* () {
+          ws.removeEventListener('message', messageHandler)
+          self.removeEventListener('offline', offlineHandler)
+          wsRef.current?.close()
+          wsRef.current = undefined
+          yield* SubscriptionRef.set(isConnected, false)
+        }),
+      )
+
+      ws.addEventListener('message', messageHandler)
+
+      if (ws.readyState === WebSocket.OPEN) {
+        wsRef.current = ws
+        SubscriptionRef.set(isConnected, true).pipe(Effect.runSync)
+      } else {
+        ws.addEventListener('open', () => {
+          wsRef.current = ws
+          SubscriptionRef.set(isConnected, true).pipe(Effect.runSync)
+        })
+      }
+
+      ws.addEventListener('close', () => {
+        Deferred.succeed(connectionClosed, void 0).pipe(Effect.runSync)
+      })
+
+      ws.addEventListener('error', () => {
+        ws.close()
+        Deferred.succeed(connectionClosed, void 0).pipe(Effect.runSync)
+      })
+
+      const checkPingPong = Effect.gen(function* () {
+        // TODO include pong latency infomation in network status
+        yield* send({ _tag: 'WSMessage.Ping', requestId: 'ping' })
+
+        // NOTE those numbers might need more fine-tuning to allow for bad network conditions
+        yield* Queue.take(pongMessages).pipe(Effect.timeout(5000))
+
+        yield* Effect.sleep(25_000)
+      }).pipe(Effect.withSpan('@livestore/sync-cf:connect:checkPingPong'))
+
+      yield* waitUntilOnline.pipe(
+        Effect.andThen(checkPingPong.pipe(Effect.forever)),
+        Effect.tapErrorCause(() => Deferred.succeed(connectionClosed, void 0)),
+        Effect.forkScoped,
+      )
+
+      yield* Deferred.await(connectionClosed)
+    }).pipe(Effect.scoped)
+
+    yield* innerConnect.pipe(Effect.forever, Effect.tapCauseLogPretty, Effect.forkScoped)
+
+    return { isConnected, incomingMessages, send }
+  })

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "tsBuildInfoFile": "./dist/.tsbuildinfo",
+    "types": ["@cloudflare/workers-types"]
+  },
+  "include": ["./src"],
+  "references": [{ "path": "../common" }, { "path": "../utils" }]
+}

package/wrangler.toml

@@ -0,0 +1,21 @@
+name = "websocket-server"
+main = "./src/cf-worker/index.ts"
+compatibility_date = "2024-05-12"
+
+[[durable_objects.bindings]]
+name = "WEBSOCKET_SERVER"
+class_name = "WebSocketServer"
+
+[[migrations]]
+tag = "v1"
+new_classes = ["WebSocketServer"]
+
+[[d1_databases]]
+binding = "DB"
+database_name = "livestore-sync-cf-demo"
+database_id = "1c9b5dae-f1fa-49d8-83fa-7bd5b39c4121"
+# database_id = "${LIVESTORE_CF_SYNC_DATABASE_ID}"
+
+[vars]
+# should be set via CF dashboard (as secret)
+# ADMIN_SECRET = "..."