braid-http 1.3.7 → 1.3.9

package/README.md

@@ -1,6 +1,6 @@
 # Braid-HTTP
 
-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.
+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), modified slightly to follow the HTTP Multiresponse concept discussed at [braid.org/meeting-89](https://braid.org/meeting-89). It provides browsers with a `braid_fetch()` drop-in replacement for the `fetch()` API, and offers nodejs an `http` plugin, enabling simple Braid communication.
 
 Developed in [braid.org](https://braid.org).
 
@@ -53,8 +53,14 @@ fetch('https://braid.org/chat', {subscribe: true}).then(
             // {
             //   version: ["me"],
             //   parents: ["mom", "dad"],
-            //   patches: [{unit: "json", range: ".foo", content: "3"}]
-            //   body:    "3"
+            //   patches: [{
+            //.      unit: "json",
+            //       range: ".foo",
+            //       content: new Uint8Array([51]),
+            //       content_text: "3" <-- getter
+            //.  }],
+            //   body: new Uint8Array([51]),
+            //   body_text: "3" <-- getter
             // }
             //
             // Note that `update` will contain either patches *or* body
@@ -113,7 +119,7 @@ for await (var update of subscription_iterator) {
     // Or complete snapshots:
     else
         // Beware the server doesn't send these yet.
-        chat = JSON.parse(update.body)
+        chat = JSON.parse(update.body_text)
 
     render_stuff()
 }
@@ -233,10 +239,16 @@ function connect () {
                 // {
                 //   version: ["me"],
                 //   parents: ["mom", "dad"],
-                //   patches: [{unit: "json", range: ".foo", content: "3"}]
-                //   body:    "3"
+                //   patches: [{
+                //.      unit: "json",
+                //       range: ".foo",
+                //       content: new Uint8Array([51]),
+                //       content_text: "3" <-- getter
+                //.  }],
+                //   body: new Uint8Array([51]),
+                //   body_text: "3" <-- getter
                 // }
-                //   // Update will contain either patches *or* body, but not both
+                // Update will contain either patches *or* body, but not both
                 console.log('We got a new update!', update)
             })
 

package/braid-http-client.js

@@ -489,6 +489,7 @@ var subscription_parser = (cb) => ({
                     parents: this.state.parents,
                     body:    this.state.body,
                     patches: this.state.patches,
+                    status:  this.state.status,
 
                     // Output extra_headers if there are some
                     extra_headers: extra_headers(this.state.headers)
@@ -563,6 +564,7 @@ function parse_update (state) {
         state.headers = parsed.headers
         state.version = state.headers.version
         state.parents = state.headers.parents
+        state.status  = state.headers[':status']
 
         // Take the parsed headers out of the buffer
         state.input = parsed.input
@@ -576,22 +578,24 @@ function parse_update (state) {
 function parse_headers (input) {
 
     // Find the start of the headers
-    let s = 0;
-    while (input[s] === 13 || input[s] === 10) s++
-    if (s === input.length) return {result: 'waiting'}
+    let start = 0;
+    while (input[start] === 13 || input[start] === 10) start++
+    if (start === input.length) return {result: 'waiting'}
 
     // Look for the double-newline at the end of the headers.
-    let e = s;
-    while (++e) {
-        if (e > input.length) return {result: 'waiting'}
-        if (input[e - 1] === 10 && (input[e - 2] === 10 || (input[e - 2] === 13 && input[e - 3] === 10))) break
+    let end = start;
+    while (++end) {
+        if (end > input.length) return {result: 'waiting'}
+        if (    input[end - 1] === 10
+            && (input[end - 2] === 10 || (input[end - 2] === 13 && input[end - 3] === 10)))
+            break
     }
 
     // Extract the header string
-    var headers_source = new TextDecoder('utf-8').decode(new Uint8Array(input.slice(s, e)))
+    var headers_source = new TextDecoder('utf-8').decode(new Uint8Array(input.slice(start, end)))
 
-    // Skip "HTTP 200 OK"
-    headers_source = headers_source.replace(/^HTTP 200.*\r?\n/, '')
+    // Convert "HTTP 200 OK" to a :status: 200 header
+    headers_source = headers_source.replace(/^HTTP\/?\d*\.?\d* (\d\d\d).*\r?\n/, ':status: $1\r\n')
 
     var headers_length = headers_source.length
     
@@ -630,7 +634,7 @@ function parse_headers (input) {
         headers.patches = JSON.parse(headers.patches)
 
     // Update the input
-    input = input.slice(e)
+    input = input.slice(end)
 
     // And return the parsed result
     return { result: 'success', headers, input }
@@ -787,7 +791,7 @@ function extra_headers (headers) {
 
     // Remove the non-extra parts
     var known_headers = ['version', 'parents', 'patches',
-                         'content-length', 'content-range']
+                         'content-length', 'content-range', ':status']
     for (var i = 0; i < known_headers.length; i++)
         delete result[known_headers[i]]
 
@@ -807,7 +811,8 @@ function get_binary_length(x) {
 function deep_copy(x) {
     if (x === null || typeof x !== 'object') return x
     if (Array.isArray(x)) return x.map(x => deep_copy(x))
-    if (Object.prototype.toString.call(x) === '[object Object]') return Object.fromEntries(Object.entries(x).map(([k, x]) => [k, deep_copy(x)]))
+    if (Object.prototype.toString.call(x) === '[object Object]')
+        return Object.fromEntries(Object.entries(x).map(([k, x]) => [k, deep_copy(x)]))
     return x
 }
 

package/braid-http-server.js

@@ -325,7 +325,14 @@ function braidify (req, res, next) {
 }
 
 async function send_update(res, data, url, peer) {
-    var {version, parents, patches, patch, body} = data
+    var {version, parents, patches, patch, body, status} = data
+
+    if (status) {
+        assert(typeof status === 'number', 'sendUpdate: status must be a number')
+        assert(status > 100 && status < 600, 'sendUpdate: status must be a number between 100 and 600')
+    }
+    else
+        status = 200
 
     function set_header (key, val) {
         if (res.isSubscription)
@@ -379,7 +386,7 @@ async function send_update(res, data, url, peer) {
     assert(body_exists || patches, 'Missing body or patches')
     assert(!(body_exists && patches), 'Cannot send both body and patches')
 
-    if (res.isSubscription) res.write(`HTTP 200 OK\r\n`)
+    if (res.isSubscription) res.write(`HTTP ${status} OK\r\n`)
 
     // Write the headers or virtual headers
     for (var [header, value] of Object.entries(data)) {

package/package.json

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