@livestore/sync-cf 0.5.0-dev.0 → 0.5.0

package/src/client/transport/http-rpc-client.ts

@@ -25,6 +25,7 @@ import { MAX_HTTP_REQUEST_BYTES, MAX_PUSH_EVENTS_PER_REQUEST } from '../../commo
 import { SyncHttpRpc } from '../../common/http-rpc-schema.ts'
 import { SearchParamsSchema } from '../../common/mod.ts'
 import type { SyncMetadata } from '../../common/sync-message-types.ts'
+import { mapRpcClientError } from './rpc-client-error.ts'
 
 type PushBatchItem = LiveStoreEvent.Global.Encoded
 
@@ -108,9 +109,13 @@ export const makeHttpSync =
 
         yield* SubscriptionRef.set(isConnected, true)
       }).pipe(
-        UnknownError.mapToUnknownError,
-        Effect.timeout(pingTimeout),
-        Effect.catchTag('TimeoutError', () => SubscriptionRef.set(isConnected, false)),
+        Effect.mapError((cause) =>
+          cause._tag === 'RpcClientError' ? mapRpcClientError(cause) : new UnknownError({ cause }),
+        ),
+        Effect.timeoutOrElse({
+          duration: pingTimeout,
+          orElse: () => SubscriptionRef.set(isConnected, false),
+        }),
       )
 
       const pingInterval = options.ping?.requestInterval ?? 10_000
@@ -178,9 +183,11 @@ export const makeHttpSync =
           Stream.tap((res) => backendIdHelper.lazySet(res.backendId)),
           Stream.map((res) => Struct.omit(res, ['backendId'])),
           Stream.mapError((cause) =>
-            cause._tag === 'UnknownError' || cause._tag === 'BackendIdMismatchError'
-              ? cause
-              : new UnknownError({ cause }),
+            cause._tag === 'RpcClientError'
+              ? mapRpcClientError(cause)
+              : cause._tag === 'UnknownError' || cause._tag === 'BackendIdMismatchError'
+                ? cause
+                : new UnknownError({ cause }),
           ),
           Stream.withSpan('http-sync-client:pull'),
         )
@@ -215,9 +222,13 @@ export const makeHttpSync =
         },
         pushSemaphore.withPermits(1),
         Effect.mapError((cause) =>
-          cause._tag === 'UnknownError' || cause._tag === 'ServerAheadError' || cause._tag === 'BackendIdMismatchError'
-            ? cause
-            : new UnknownError({ cause }),
+          cause._tag === 'RpcClientError'
+            ? mapRpcClientError(cause)
+            : cause._tag === 'UnknownError' ||
+                cause._tag === 'ServerAheadError' ||
+                cause._tag === 'BackendIdMismatchError'
+              ? cause
+              : new UnknownError({ cause }),
         ),
       )
 

package/src/client/transport/rpc-client-error.test.ts

@@ -0,0 +1,41 @@
+import { expect, it } from 'vitest'
+
+import { IsOfflineError, UnknownError } from '@livestore/common'
+import { HttpClientError, RpcClientError, Socket } from '@livestore/utils/effect'
+
+import { mapRpcClientError } from './rpc-client-error.ts'
+
+const socketReasons = [
+  new Socket.SocketCloseError({ code: 1012, closeReason: 'Restart' }),
+  new Socket.SocketReadError({ cause: new Error('Disconnected') }),
+  new Socket.SocketWriteError({ cause: new Error('Disconnected') }),
+  new Socket.SocketOpenError({ kind: 'Timeout', cause: new Error('Unavailable') }),
+  new Socket.SocketUpgradeError({ cause: new Error('Upgrade failed') }),
+]
+
+it.each(socketReasons)('maps $\u005ftag to offline', (reason) => {
+  const result = mapRpcClientError(new RpcClientError.RpcClientError({ reason }))
+  expect(result).toBeInstanceOf(IsOfflineError)
+  expect(result.cause).toBe(reason)
+})
+
+it('maps an HTTP transport failure to offline', () => {
+  const reason = new HttpClientError.HttpClientErrorSchema({ kind: 'TransportError' })
+  const result = mapRpcClientError(new RpcClientError.RpcClientError({ reason }))
+  expect(result).toBeInstanceOf(IsOfflineError)
+  expect(result.cause).toBe(reason)
+})
+
+const protocolReasons = [
+  new RpcClientError.RpcClientDefect({ message: 'Malformed RPC response', cause: new Error('Invalid message') }),
+  ...(['EncodeError', 'DecodeError', 'InvalidUrlError', 'StatusCodeError', 'EmptyBodyError'] as const).map(
+    (kind) => new HttpClientError.HttpClientErrorSchema({ kind }),
+  ),
+]
+
+it.each(protocolReasons)('keeps protocol failure $\u005ftag terminal', (reason) => {
+  const error = new RpcClientError.RpcClientError({ reason })
+  const result = mapRpcClientError(error)
+  expect(result).toBeInstanceOf(UnknownError)
+  expect(result.cause).toBe(error)
+})

package/src/client/transport/rpc-client-error.ts

@@ -0,0 +1,9 @@
+import { IsOfflineError, UnknownError } from '@livestore/common'
+import { type RpcClientError, Schema, Socket } from '@livestore/utils/effect'
+
+/** Only transport loss is retryable. RPC defects and HTTP protocol failures stay terminal. */
+export const mapRpcClientError = (error: RpcClientError.RpcClientError): IsOfflineError | UnknownError =>
+  Schema.is(Socket.SocketErrorReason)(error.reason) === true ||
+  (error.reason._tag === 'HttpError' && error.reason.kind === 'TransportError')
+    ? new IsOfflineError({ cause: error.reason })
+    : new UnknownError({ cause: error })

package/src/client/transport/ws-rpc-client.ts

@@ -1,4 +1,4 @@
-import { IsOfflineError, SyncBackend, UnknownError } from '@livestore/common'
+import { SyncBackend, UnknownError } from '@livestore/common'
 import type { LiveStoreEvent } from '@livestore/common/schema'
 import { splitArrayBySize } from '@livestore/common/sync'
 import {
@@ -24,6 +24,7 @@ import { MAX_PUSH_EVENTS_PER_REQUEST, MAX_WS_MESSAGE_BYTES } from '../../common/
 import { SearchParamsSchema } from '../../common/mod.ts'
 import type { SyncMetadata } from '../../common/sync-message-types.ts'
 import { SyncWsRpc } from '../../common/ws-rpc-schema.ts'
+import { mapRpcClientError } from './rpc-client-error.ts'
 
 export interface WsSyncOptions {
   /**
@@ -121,8 +122,10 @@ export const makeWsSync =
         yield* pinger.ping
         yield* SubscriptionRef.set(isConnected, true)
       }).pipe(
-        Effect.timeout(pingTimeout),
-        Effect.catchTag('TimeoutError', () => SubscriptionRef.set(isConnected, false)),
+        Effect.timeoutOrElse({
+          duration: pingTimeout,
+          orElse: () => SubscriptionRef.set(isConnected, false),
+        }),
         UnknownError.mapToUnknownError,
         Effect.withSpan('ping'),
       )
@@ -147,8 +150,8 @@ export const makeWsSync =
             Stream.tap((res) => backendIdHelper.lazySet(res.backendId)),
             Stream.map((res) => Struct.omit(res, ['backendId'])),
             Stream.mapError((cause) =>
-              cause._tag === 'RpcClientError' && Socket.isSocketError(cause.cause) === true
-                ? new IsOfflineError({ cause: cause.cause })
+              cause._tag === 'RpcClientError'
+                ? mapRpcClientError(cause)
                 : cause._tag === 'UnknownError' || cause._tag === 'BackendIdMismatchError'
                   ? cause
                   : new UnknownError({ cause }),
@@ -184,11 +187,13 @@ export const makeWsSync =
               backendId: backendIdHelper.get(),
             }).pipe(
               Effect.mapError((cause) =>
-                cause._tag === 'UnknownError' ||
-                cause._tag === 'ServerAheadError' ||
-                cause._tag === 'BackendIdMismatchError'
-                  ? cause
-                  : new UnknownError({ cause }),
+                cause._tag === 'RpcClientError'
+                  ? mapRpcClientError(cause)
+                  : cause._tag === 'UnknownError' ||
+                      cause._tag === 'ServerAheadError' ||
+                      cause._tag === 'BackendIdMismatchError'
+                    ? cause
+                    : new UnknownError({ cause }),
               ),
             )
           }

package/src/common/do-rpc-schema.ts

@@ -52,4 +52,14 @@ export class SyncDoRpc extends RpcGroup.make(
     },
     success: Schema.Void,
   }),
+  Rpc.make('SyncDoRpc.Unsubscribe', {
+    payload: {
+      /** Client DO id whose live-pull subscription row to drop. */
+      durableObjectId: Schema.String,
+      /** Request id of the live pull that registered the row; the row is only dropped if it still matches. */
+      requestId: Schema.String,
+      ...commonPayloadFields,
+    },
+    success: Schema.Void,
+  }),
 ) {}

package/src/common/mod.ts

@@ -3,6 +3,7 @@ import { Schema } from '@livestore/utils/effect'
 
 export type { CfTypes } from '@livestore/common-cf'
 export * from './constants.ts'
+export { SyncDoRpc } from './do-rpc-schema.ts'
 export { SyncHttpRpc } from './http-rpc-schema.ts'
 export * as SyncMessage from './sync-message-types.ts'