braid-http 0.1.11 → 0.3.0

package/braid-http-client.js

@@ -49,6 +49,7 @@ function braidify_http (http) {
         options.headers.peer = options.headers.peer || peer
 
         // Wrap the callback to provide our new .on('version', ...) feature
+        // on nodejs servers
         var on_version,
             on_error,
             orig_cb = cb
@@ -153,7 +154,7 @@ async function braid_fetch (url, params = {}) {
 
     // We provide some shortcuts for Braid params
     if (params.version)
-        params.headers.set('version', JSON.stringify(params.version))
+        params.headers.set('version', params.version.map(JSON.stringify).join(', '))
     if (params.parents)
         params.headers.set('parents', params.parents.map(JSON.stringify).join(', '))
     if (params.subscribe)
@@ -362,12 +363,19 @@ var subscription_parser = (cb) => ({
 
             // Maybe we parsed a version!  That's cool!
             if (this.state.result === 'success') {
+                let ignore_headers = {
+                    version: true,
+                    parents: true,
+                    patches: true,
+                    'content-length': true,
+                    'content-range': true,
+                }
                 this.cb({
                     version: this.state.version,
                     parents: this.state.parents,
                     body:    this.state.body,
                     patches: this.state.patches,
-                    headers: this.state.headers
+                    ...((x => Object.keys(x).length ? {extra_headers: x} : {})(Object.fromEntries(Object.entries(this.state.headers).filter(([k, v]) => !ignore_headers[k]))))
                 })
 
                 // Reset the parser for the next version!
@@ -479,7 +487,7 @@ function parse_headers (input) {
 
     // Success!  Let's parse special headers
     if ('version' in headers)
-        headers.version = JSON.parse(headers.version)
+        headers.version = JSON.parse('['+headers.version+']')
     if ('parents' in headers)
         headers.parents = JSON.parse('['+headers.parents+']')
     if ('patches' in headers)
@@ -626,6 +634,13 @@ function parse_body (state) {
                 last_patch.range = match.range
                 last_patch.content = state.input.substr(0, content_length)
 
+                // instead of headers, we'll create an "extra_headers" field that ignore the headers we've used
+                last_patch.extra_headers = last_patch.headers
+                delete last_patch.headers
+                delete last_patch.extra_headers['content-length']
+                delete last_patch.extra_headers['content-range']
+                if (!Object.keys(last_patch.extra_headers).length) delete last_patch.extra_headers
+
                 // Consume the parsed input
                 state.input = state.input.substring(content_length)
             }

package/braid-http-server.js

@@ -26,34 +26,37 @@ var assert = require('assert')
 //       {"some": "json object"}
 //
 function generate_patches(res, patches) {
+    var result = ''
+
+    // `patches` must be a patch object or an array of patch objects
+    //  - Object:  {unit, range, content}
+    //  - Array:  [{unit, range, content}, ...]
 
-    // `patches` must be an object or an array
-    assert(typeof patches === 'object')
+    assert(typeof patches === 'object')  // An array is also an object
 
     // An array of one patch behaves like a single patch
-    if (!Array.isArray(patches))
-        var patches = [patches]
+    if (Array.isArray(patches)) {
+
+        // Add `Patches: N` header if array
+        result += `Patches: ${patches.length}\r\n\r\n`
+    } else
+        // Else, we'll out put a single patch
+        patches = [patches]
 
-    for (let patch of patches) {
+    // Generate each patch
+    patches.forEach((patch, i) => {
         assert(typeof patch.unit    === 'string')
         assert(typeof patch.range   === 'string')
         assert(typeof patch.content === 'string')
-    }
 
-    // Build up the string as a result
-    var result = ''
-
-    // Add `Patches: N` header
-    result += `Patches: ${patches.length}\r\n\r\n`
-
-    // Generate each patch
-    patches.forEach((patch, i) => {
         if (i > 0)
             result += '\r\n\r\n'
 
+        let extra_headers = Object.fromEntries(Object.entries(patch).filter(([k, v]) => k != 'unit' && k != 'range' && k != 'content'))
+
         result += `Content-Length: ${patch.content.length}\r
 Content-Range: ${patch.unit} ${patch.range}\r
-\r
+${Object.entries(extra_headers).map(([k, v]) => `${k}: ${v}\r\n`).join('')}\r
 ${patch.content}`
     })
     return result
@@ -237,7 +240,10 @@ function braidify (req, res, next) {
             res.statusCode = 209
             res.setHeader("subscribe", req.headers.subscribe)
             res.setHeader('cache-control', 'no-cache, no-transform')
-            if (req.httpVersionMajor == 1) res.setHeader('transfer-encoding', '')
+            if (req.httpVersionMajor == 1) {
+                // Explicitly disable transfer-encoding chunked for http 1
+                res.setHeader('transfer-encoding', '')
+            }
 
             // Tell nginx not to buffer the subscription
             res.setHeader('X-Accel-Buffering', 'no')
@@ -268,7 +274,7 @@ function braidify (req, res, next) {
 }
 
 function send_version(res, data, url, peer) {
-    var {version, parents, patches, body} = data
+    var {version, parents, patches, patch, body} = data
 
     function set_header (key, val) {
         if (res.isSubscription)
@@ -290,12 +296,34 @@ function send_version(res, data, url, peer) {
     if (body !== undefined)
         assert(typeof body === 'string')
     else {
-        assert(patches !== undefined)
-        assert(patches !== null)
+        // Only one of patch or patches can be set
+        assert(!(patch && patches))
+        assert((patch || patches) !== undefined)
+        assert((patch || patches) !== null)
+
+        // Patches must be an array
+        if (patches)
+            assert(Array.isArray(patches))
+
+        // But if using `patch`, then we set `patches` to just that object
+        if (patch)
+            patches = patch
+
+        // Now `patches` will be an array of patches or a single patch object.
+        //
+        // This distinction is used in generate_patches() to determine whether
+        // to inline a single patch in the update body vs. writing out a
+        // Patches: N block.
         assert(typeof patches === 'object')
         if (Array.isArray(patches))
-            patches.forEach(p => assert(typeof p.content === 'string'))
+            patches.forEach(p => {
+                assert('unit' in p)
+                assert('range' in p)
+                assert('content' in p)
+                assert(typeof p.content === 'string')
+            })
     }
+
     var body_exists = body || body === ''
     assert(body_exists || patches, 'Missing body or patches')
     assert(!(body_exists && patches), 'Cannot send both body and patches')
@@ -307,14 +335,14 @@ function send_version(res, data, url, peer) {
         // Version and Parents get output in the Structured Headers format
         if (header === 'version') {
             header = 'Version'               // Capitalize for prettiness
-            value = JSON.stringify(value)
+            value = value.map(JSON.stringify).join(", ")
         } else if (header === 'parents') {
             header = 'Parents'               // Capitalize for prettiness
-            value = parents.map(JSON.stringify).join(", ")
+            value = value.map(JSON.stringify).join(", ")
         }
 
         // We don't output patches or body yet
-        else if (header === 'patches' || header == 'body')
+        else if (header === 'patches' || header === 'body' || header === 'patch')
             continue
 
         set_header(header, value)

package/package.json

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

package/readme.md

@@ -1,6 +1,6 @@
 # Braid-HTTP
 
-This polyfill library implements the [Braid-HTTP v03 protocol](https://github.com/braid-org/braid-spec/blob/master/draft-toomim-httpbis-braid-http-03.txt) in Javascript.  It gives browsers a `braid_fetch()` drop-in replacement for the `fetch()` API, and gives nodejs an `http` plugin, allowing them to speak Braid in a simple way.
+This polyfill library implements the [Braid-HTTP v04 protocol](https://github.com/braid-org/braid-spec/blob/master/draft-toomim-httpbis-braid-http-04.txt) in Javascript.  It gives browsers a `braid_fetch()` drop-in replacement for the `fetch()` API, and gives nodejs an `http` plugin, allowing them to speak Braid in a simple way.
 
 Developed in [braid.org](https://braid.org).