@electric-sql/client 1.0.14 → 1.1.0

package/src/client.ts

@@ -44,6 +44,7 @@ import {
   FORCE_DISCONNECT_AND_REFRESH,
   PAUSE_STREAM,
   EXPERIMENTAL_LIVE_SSE_QUERY_PARAM,
+  LIVE_SSE_QUERY_PARAM,
   ELECTRIC_PROTOCOL_QUERY_PARAMS,
   LOG_MODE_QUERY_PARAM,
   SUBSET_PARAM_WHERE,
@@ -273,10 +274,15 @@ export interface ShapeStreamOptions<T = never> {
   subscribe?: boolean
 
   /**
-   * Experimental support for Server-Sent Events (SSE) for live updates.
+   * @deprecated No longer experimental, use {@link liveSse} instead.
    */
   experimentalLiveSse?: boolean
 
+  /**
+   * Use Server-Sent Events (SSE) for live updates.
+   */
+  liveSse?: boolean
+
   /**
    * Initial data loading mode
    */
@@ -372,7 +378,7 @@ function canonicalShapeKey(url: URL): string {
  * ```
  * const stream = new ShapeStream({
  *   url: `http://localhost:3000/v1/shape`,
- *   experimentalLiveSse: true
+ *   liveSse: true
  * })
  * ```
  *
@@ -598,7 +604,13 @@ export class ShapeStream<T extends Row<unknown> = Row>
         const newShapeHandle =
           e.headers[SHAPE_HANDLE_HEADER] || `${this.#shapeHandle!}-next`
         this.#reset(newShapeHandle)
-        await this.#publish(e.json as Message<T>[])
+
+        // must refetch control message might be in a list or not depending
+        // on whether it came from an SSE request or long poll - handle both
+        // cases for safety here but worth revisiting 409 handling
+        await this.#publish(
+          (Array.isArray(e.json) ? e.json : [e.json]) as Message<T>[]
+        )
         return this.#requestShape()
       } else {
         // Notify subscribers
@@ -815,13 +827,15 @@ export class ShapeStream<T extends Row<unknown> = Row>
     headers: Record<string, string>
     resumingFromPause?: boolean
   }): Promise<void> {
+    const useSse = this.options.liveSse ?? this.options.experimentalLiveSse
     if (
       this.#isUpToDate &&
-      this.options.experimentalLiveSse &&
+      useSse &&
       !this.#isRefreshing &&
       !opts.resumingFromPause
     ) {
       opts.fetchUrl.searchParams.set(EXPERIMENTAL_LIVE_SSE_QUERY_PARAM, `true`)
+      opts.fetchUrl.searchParams.set(LIVE_SSE_QUERY_PARAM, `true`)
       return this.#requestShapeSSE(opts)
     }
 

package/src/constants.ts

@@ -13,7 +13,11 @@ export const TABLE_QUERY_PARAM = `table`
 export const WHERE_QUERY_PARAM = `where`
 export const REPLICA_PARAM = `replica`
 export const WHERE_PARAMS_PARAM = `params`
+/**
+ * @deprecated Use {@link LIVE_SSE_QUERY_PARAM} instead.
+ */
 export const EXPERIMENTAL_LIVE_SSE_QUERY_PARAM = `experimental_live_sse`
+export const LIVE_SSE_QUERY_PARAM = `live_sse`
 export const FORCE_DISCONNECT_AND_REFRESH = `force-disconnect-and-refresh`
 export const PAUSE_STREAM = `pause-stream`
 export const LOG_MODE_QUERY_PARAM = `log`

package/src/fetch.ts

@@ -59,13 +59,7 @@ export function createFetchWithBackoff(
     let delay = initialDelay
     let attempt = 0
 
-    /* eslint-disable no-constant-condition -- we re-fetch the shape log
-     * continuously until we get a non-ok response. For recoverable errors,
-     * we retry the fetch with exponential backoff. Users can pass in an
-     * AbortController to abort the fetching an any point.
-     * */
     while (true) {
-      /* eslint-enable no-constant-condition */
       try {
         const result = await fetchClient(...args)
         if (result.ok) return result
@@ -118,6 +112,10 @@ export function createFetchWithConsumedMessages(fetchClient: typeof fetch) {
       const text = await res.text()
       return new Response(text, res)
     } catch (err) {
+      if (args[1]?.signal?.aborted) {
+        throw new FetchBackoffAbortError()
+      }
+
       throw new FetchError(
         res.status,
         undefined,