braid-http 0.3.22 → 1.0.1

package/braid-http-client.js

@@ -154,8 +154,8 @@ async function braid_fetch (url, params = {}) {
         console.assert(Array.isArray(params.version),
                        'fetch(): `version` must be an array')
     if (params.parents)
-        console.assert(Array.isArray(params.parents),
-                       'fetch(): `parents` must be an array')
+        console.assert(Array.isArray(params.parents) || (typeof params.parents === 'function'),
+                       'fetch(): `parents` must be an array or function')
 
     // // Always set the peer
     // params.headers.set('peer', peer)
@@ -163,7 +163,7 @@ async function braid_fetch (url, params = {}) {
     // We provide some shortcuts for Braid params
     if (params.version)
         params.headers.set('version', params.version.map(JSON.stringify).join(', '))
-    if (params.parents)
+    if (Array.isArray(params.parents))
         params.headers.set('parents', params.parents.map(JSON.stringify).join(', '))
     if (params.subscribe)
         params.headers.set('subscribe', 'true')
@@ -210,115 +210,177 @@ async function braid_fetch (url, params = {}) {
     // `controller` to abort the fetch itself.
 
     var original_signal = params.signal
-    var underlying_aborter = new AbortController()
-    params.signal = underlying_aborter.signal
+    var underlying_aborter = null
     if (original_signal)
         original_signal.addEventListener(
             'abort',
             () => underlying_aborter.abort()
         )
 
-    // Now we run the original fetch....
-    var res = await normal_fetch(url, params)
-
-    // And customize the response with a couple methods for getting
-    // the braid subscription data:
-    res.subscribe    = start_subscription
-    res.subscription = {[Symbol.asyncIterator]: iterator}
-
-
-    // Now we define the subscription function we just used:
-    function start_subscription (cb, error) {
-        if (!res.ok)
-            throw new Error('Request returned not ok status:', res.status)
-
-        if (res.bodyUsed)
-            // TODO: check if this needs a return
-            throw new Error('This response\'s body has already been read', res)
-
-        // Parse the streamed response
-        handle_fetch_stream(
-            res.body,
-
-            // Each time something happens, we'll either get a new
-            // version back, or an error.
-            (result, err) => {
-                if (!err)
-                    // Yay!  We got a new version!  Tell the callback!
-                    cb(result)
-                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()
-
-                    // Then send the error upstream.
-                    if (error)
-                        error(err)
-                    else
-                        throw 'Unhandled network error in subscription'
+    var waitTime = 10
+    var res = null
+    var subscription_cb = null
+    var subscription_error = null
+
+    return await new Promise((done, fail) => {
+        connect()
+        async function connect() {
+            try {
+                if (original_signal?.aborted) return fail(new Error('abort'))
+
+                // We need a fresh underlying abort controller each time we connect
+                underlying_aborter = new AbortController()
+                params.signal = underlying_aborter.signal
+
+                // If parents is a function,
+                // call it now to get the latest parents
+                if (typeof params.parents === 'function')
+                    params.headers.set('parents', params.parents().map(JSON.stringify).join(', '))
+
+                // undocumented feature used by braid-chrome
+                // to see the fetch args as they are right before it is actually called,
+                // to display them for the user in the dev panel
+                params.onFetch?.(url, params)
+
+                // Now we run the original fetch....
+                res = await normal_fetch(url, params)
+
+                // And customize the response with a couple methods for getting
+                // the braid subscription data:
+                res.subscribe    = start_subscription
+                res.subscription = {[Symbol.asyncIterator]: iterator}
+
+                // Now we define the subscription function we just used:
+                function start_subscription (cb, error) {
+                    subscription_cb = cb
+                    subscription_error = error
+
+                    if (!res.ok)
+                        throw new Error('Request returned not ok status:', res.status)
+
+                    if (res.bodyUsed)
+                        // TODO: check if this needs a return
+                        throw new Error('This response\'s body has already been read', res)
+
+                    // Parse the streamed response
+                    handle_fetch_stream(
+                        res.body,
+
+                        // Each time something happens, we'll either get a new
+                        // version back, or an error.
+                        (result, err) => {
+                            if (!err)
+                                // Yay!  We got a new version!  Tell the callback!
+                                cb(result)
+                            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
+                    )
                 }
-            }
-        )
-    }
 
+                // And the iterator for use with "for async (...)"
+                function iterator () {
+                    // We'll keep this state while our iterator runs
+                    var initialized = false,
+                        inbox = [],
+                        resolve = null,
+                        reject = null,
+                        last_error = null
 
-    // And the iterator for use with "for async (...)"
-    function iterator () {
-        // We'll keep this state while our iterator runs
-        var initialized = false,
-            inbox = [],
-            resolve = null,
-            reject = null
+                    return {
+                        async next() {
+                            // If we got an error, throw it
+                            if (last_error) throw last_error
+
+                            // If we've already received a version, return it
+                            if (inbox.length > 0)
+                                return {done: false, value: inbox.shift()}
+
+                            // Otherwise, let's set up a promise to resolve when we get the next item
+                            var promise = new Promise((_resolve, _reject) => {
+                                resolve = _resolve
+                                reject  = _reject
+                            })
+
+                            // Start the subscription, if we haven't already
+                            if (!initialized) {
+                                initialized = true
+
+                                // The subscription will call whichever resolve and
+                                // reject functions the current promise is waiting for
+                                start_subscription(x => {
+                                    inbox.push(x)
+                                    resolve()
+                                }, x => reject(x) )
+                            }
+
+                            // Now wait for the subscription to resolve or reject the promise.
+                            await promise
+
+                            // From here on out, we'll redirect the reject,
+                            // since that promise is already done
+                            reject = (err) => {last_error = err}
+
+                            return {done: false, value: inbox.shift()}
+                        }
+                    }
+                }
 
-        return {
-            async next() {
-                // If we've already received a version, return it
-                if (inbox.length > 0)
-                    return {done: false, value: inbox.shift()}
-
-                // Otherwise, let's set up a promise to resolve when we get the next item
-                var promise = new Promise((_resolve, _reject) => {
-                    resolve = _resolve
-                    reject  = _reject
-                })
-
-                // Start the subscription, if we haven't already
-                if (!initialized) {
-                    initialized = true
-
-                    // The subscription will call whichever resolve and
-                    // reject functions the current promise is waiting for
-                    start_subscription(x => resolve(x),
-                                       x => reject(x) )
+                if (params.retry) {
+                    let give_up = res.status >= 400 && res.status < 600
+                    switch (res.status) {
+                        case 408: // Request Timeout
+                        case 425: // Too Early
+                        case 429: // Too Many Requests
+
+                        case 502: // Bad Gateway
+                        case 504: // Gateway Timeout
+                            give_up = false;
+                    }
+                    if (give_up) return fail(new Error(`giving up because of http status: ${res.status}${(res.status === 401 || res.status === 403) ? ` (access denied)` : ''}`))
+                    if (!res.ok) throw new Error(`status not ok: ${res.status}`)
                 }
 
-                // Now wait for the subscription to resolve or reject the promise.
-                var result = await promise
+                if (subscription_cb) start_subscription(subscription_cb, subscription_error)
 
-                // Anything we get from here out we should add to the inbox
-                resolve = (new_version) => inbox.push(new_version)
-                reject  = (err) => {throw err}
+                done(res)
 
-                return { done: false, value: result }
-            }
+                params?.retry?.onRes?.(res)
+                waitTime = 10
+            } catch (e) { on_error(e) }
         }
-    }
+        function on_error(e) {
+            if (!params.retry || (e.name === "AbortError")) {
+                subscription_error?.(e)
+                return fail(e)
+            }
 
-    return res
+            console.log(`retrying in ${waitTime}ms: ${url} after error: ${e}`)
+            setTimeout(connect, waitTime)
+            waitTime = Math.min(waitTime * 2, 3000)
+        }
+    })
 }
 
 // Parse a stream of versions from the incoming bytes
-async function handle_fetch_stream (stream, cb) {
+async function handle_fetch_stream (stream, cb, binary, on_bytes) {
     if (is_nodejs)
         stream = to_whatwg_stream(stream)
 
     // Set up a reader
     var reader = stream.getReader(),
-        parser = subscription_parser(cb)
+        parser = subscription_parser(cb, binary)
     
     while (true) {
         var versions = []
@@ -339,6 +401,8 @@ async function handle_fetch_stream (stream, cb) {
             return
         }
 
+        on_bytes?.(value)
+
         // Tell the parser to process some more stream
         parser.read(value)
     }
@@ -350,7 +414,7 @@ async function handle_fetch_stream (stream, cb) {
 // Braid-HTTP Subscription Parser
 // ****************************
 
-var subscription_parser = (cb) => ({
+var subscription_parser = (cb, binary) => ({
     // A parser keeps some parse state
     state: {input: []},
 
@@ -370,6 +434,9 @@ var subscription_parser = (cb) => ({
             // Try to parse an update
             try {
                 this.state = parse_update (this.state)
+
+                // Parse UTF-8 if it isn't binary
+                if (!binary && this.state.body) this.state.body = (new TextDecoder('utf-8')).decode(this.state.body)
             } catch (e) {
                 this.cb(null, e)
                 return
@@ -541,8 +608,7 @@ function parse_body (state) {
         }
 
         // Otherwise, this is a snapshot body
-        else
-            state.body = (new TextDecoder('utf-8')).decode(new Uint8Array(state.input.slice(0, content_length)))
+        else state.body = new Uint8Array(state.input.slice(0, content_length))
 
         state.input = state.input.slice(content_length)
         return state
@@ -714,6 +780,29 @@ function extractHeader(input) {
     };
 }
 
+function isTextContentType(contentType) {
+    if (!contentType) return false
+
+    contentType = contentType.toLowerCase().trim()
+
+    // Check if it starts with "text/"
+    if (contentType.startsWith("text/")) return true
+
+    // Initialize the Map if it doesn't exist yet
+    if (!isTextContentType.textApplicationTypes) {
+        isTextContentType.textApplicationTypes = new Map([
+            ["application/json", true],
+            ["application/xml", true],
+            ["application/javascript", true],
+            ["application/ecmascript", true],
+            ["application/x-www-form-urlencoded", true],
+        ])
+    }
+
+    // Use the cached map of text-based application types
+    return isTextContentType.textApplicationTypes.has(contentType)
+}
+
 // ****************************
 // Exports
 // ****************************

package/braid-http-server.js

@@ -291,18 +291,22 @@ function send_update(res, data, url, peer) {
             res.setHeader(key, val)
     }
     function write_body (body) {
-        if (res.isSubscription)
-            res.write('\r\n' + body)
-        else
-            res.write(body)
+        if (res.isSubscription) res.write('\r\n')
+        res.write(body)
     }
 
     // console.log('sending version', {url, peer, version, parents, patches, body,
     //                                 subscription: res.isSubscription})
 
-    // Validate that the body and patches are strings
+    // Validate that the body and patches are strings,
+    // or in the case of body, it could be binary
     if (body !== undefined)
-        assert(typeof body === 'string')
+        assert(typeof body === 'string' ||
+            body instanceof ArrayBuffer ||
+            body instanceof Uint8Array ||
+            body instanceof Blob ||
+            body instanceof Buffer
+        )
     else {
         // Only one of patch or patches can be set
         assert(!(patch && patches))
@@ -362,9 +366,14 @@ function send_update(res, data, url, peer) {
     }
 
     // Write the patches or body
-    if (typeof body === 'string') {
-        set_header('Content-Length', (new TextEncoder().encode(body)).length)
-        write_body(body)
+    if (body_exists) {
+        let x = typeof body === 'string' ? new TextEncoder().encode(body) : body
+        set_header('Content-Length',
+            x instanceof ArrayBuffer ? x.byteLength :
+            x instanceof Uint8Array ? x.length :
+            x instanceof Blob ? x.size :
+            x instanceof Buffer ? x.length : null)
+        write_body(x)
     } else
         res.write(generate_patches(res, patches))
 

package/package.json

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