braid-http 1.3.92 → 1.3.94

package/README.md

@@ -110,6 +110,29 @@ fetch('https://braid.org/chat', {subscribe: true, retry: true, parents: () => {
 )
 ```
 
+You can monitor the subscription's connection status with `onSubscriptionStatus`:
+
+```javascript
+fetch('https://braid.org/chat', {
+    subscribe: true,
+    retry: true,
+    onSubscriptionStatus: ({online, error, status, statusText}) => {
+        if (online)
+            console.log('Connected!')
+        else
+            console.log('Disconnected:', error)
+    }
+}).then(
+    res => res.subscribe(
+        (update) => { console.log('Got update!', update) }
+    )
+)
+```
+
+The callback receives an object with only the fields relevant to the event:
+- `{online: true}` — the subscription is connected
+- `{online: false, error}` — the subscription went offline, with the error/reason for disconnection
+
 ### Example Subscription with Async/Await
 
 ```javascript

package/braid-http-client.js

@@ -231,6 +231,7 @@ async function braid_fetch (url, params = {}) {
         )
 
     var retry_count = 0
+    var subscription_online = false
     var res = null
     var subscription_cb = null
     var subscription_error = null
@@ -265,6 +266,12 @@ async function braid_fetch (url, params = {}) {
                 // and in those cases, we want to make sure to close the fetch
                 underlying_aborter?.abort()
 
+                // Notify subscription went offline
+                if (params.onSubscriptionStatus && subscription_online) {
+                    subscription_online = false
+                    params.onSubscriptionStatus({online: false, error: e})
+                }
+
                 // see if we should retry..
                 var retry = params.retry &&    // only try to reconnect if the user has chosen to
                     e.name !== "AbortError" && // don't retry if the user has chosen to abort
@@ -466,12 +473,21 @@ async function braid_fetch (url, params = {}) {
                             give_up = false
                     }
                     if (give_up) {
+                        if (params.onSubscriptionStatus && subscription_online) {
+                            subscription_online = false
+                            params.onSubscriptionStatus({online: false, error: new Error(`giving up because of http status: ${res.status}`)})
+                        }
                         if (subscription_cb) subscription_error?.(new Error(`giving up because of http status: ${res.status}${(res.status === 401 || res.status === 403) ? ` (access denied)` : ''}`))
                     } else if (!res.ok) throw new Error(`status not ok: ${res.status}`)
                 }
 
                 if (subscription_cb && res.ok) start_subscription(subscription_cb, subscription_error)
 
+                if (subscription_cb && res.ok && params.onSubscriptionStatus) {
+                    subscription_online = true
+                    params.onSubscriptionStatus({online: true})
+                }
+
                 params?.retry?.onRes?.(res)
                 retry_count = 0
 

package/braid-http-server.js

@@ -432,6 +432,7 @@ function braidify (req, res, next) {
             }
         }
         var mw = new MultiplexedWritable(m, request)
+        mw.on('error', () => {})  // EPIPE when client disconnects mid-stream
 
         // then we create a fake server response,
         // that pipes data to our fake socket

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braid-http",
-  "version": "1.3.92",
+  "version": "1.3.94",
   "description": "An implementation of Braid-HTTP for Node.js and Browsers",
   "scripts": {
     "test": "node test/server.js"