braid-http 1.0.5 → 1.0.7

package/braid-http-client.js

@@ -169,6 +169,9 @@ async function braid_fetch (url, params = {}) {
         params.headers.set('subscribe', 'true')
     if (params.peer)
         params.headers.set('peer', params.peer)
+    
+    if (params.heartbeats)
+        params.headers.set('heartbeats', typeof params.heartbeats === 'number' ? `${params.heartbeats}s` : params.heartbeats)
 
     // Prevent browsers from going to disk cache
     params.cache = 'no-cache'
@@ -225,8 +228,23 @@ async function braid_fetch (url, params = {}) {
     return await new Promise((done, fail) => {
         connect()
         async function connect() {
+            let on_error = e => {
+                on_error = () => {}
+
+                if (!params.retry || (e.name === "AbortError")) {
+                    subscription_error?.(e)
+                    return fail(e)
+                }
+
+                underlying_aborter.abort()
+
+                console.log(`retrying in ${waitTime}ms: ${url} after error: ${e}`)
+                setTimeout(connect, waitTime)
+                waitTime = Math.min(waitTime * 2, 3000)
+            }
+
             try {
-                if (original_signal?.aborted) return fail(new Error('abort'))
+                if (original_signal?.aborted) throw new DOMException('already aborted', 'AbortError')
 
                 // We need a fresh underlying abort controller each time we connect
                 underlying_aborter = new AbortController()
@@ -257,6 +275,23 @@ async function braid_fetch (url, params = {}) {
                     subscription_cb = cb
                     subscription_error = error
 
+                    // heartbeat
+                    let on_heartbeat = () => {}
+                    if (res.headers.get('heartbeats')) {
+                        let heartbeats = parseFloat(res.headers.get('heartbeats'))
+                        if (isFinite(heartbeats)) {
+                            let timeout = null
+                            on_heartbeat = () => {
+                                clearTimeout(timeout)
+                                let wait_seconds = 1.2 * heartbeats + 3
+                                timeout = setTimeout(() => {
+                                    on_error(new Error(`heartbeat not seen in ${wait_seconds.toFixed(2)}s`))
+                                }, wait_seconds * 1000)
+                            }
+                            on_heartbeat()
+                        }
+                    }
+
                     if (!res.ok)
                         throw new Error('Request returned not ok status:', res.status)
 
@@ -274,20 +309,17 @@ async function braid_fetch (url, params = {}) {
                             if (!err)
                                 // Yay!  We got a new version!  Tell the callback!
                                 cb(result)
-                            else {
+                            else
                                 // This error handling code runs if the connection
                                 // closes, or if there is unparseable stuff in the
                                 // streamed response.
-
-                                // In any case, we want to be sure to abort the
-                                // underlying fetch.
-                                underlying_aborter.abort()
-
                                 on_error(err)
-                            }
                         },
                         !isTextContentType(res.headers.get('content-type')),
-                        params.onBytes
+                        (...args) => {
+                            on_heartbeat()
+                            params.onBytes?.(...args)
+                        }
                     )
                 }
 
@@ -366,16 +398,6 @@ async function braid_fetch (url, params = {}) {
                 waitTime = 10
             } catch (e) { on_error(e) }
         }
-        function on_error(e) {
-            if (!params.retry || (e.name === "AbortError")) {
-                subscription_error?.(e)
-                return fail(e)
-            }
-
-            console.log(`retrying in ${waitTime}ms: ${url} after error: ${e}`)
-            setTimeout(connect, waitTime)
-            waitTime = Math.min(waitTime * 2, 3000)
-        }
     })
 }
 

package/braid-http-server.js

@@ -270,6 +270,22 @@ function braidify (req, res, next) {
             res.on('close',   x => disconnected('close'))
             res.on('finish',  x => disconnected('finish'))
             req.on('abort',   x => disconnected('abort'))
+
+            // Heartbeats
+            if (req.headers['heartbeats']) {
+                let heartbeats = parseFloat(req.headers['heartbeats'])
+                if (isFinite(heartbeats)) {
+                    res.setHeader('heartbeats', req.headers['heartbeats'])
+                    let closed
+                    res.on('close', () => closed = true)
+                    loop()
+                    function loop() {
+                        if (res.writableEnded || closed) return
+                        res.write("\r\n")
+                        setTimeout(loop, 1000 * heartbeats)
+                    }
+                }
+            }
         }
 
     // Check the Useragent to work around Firefox bugs

package/package.json

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