braid-http 1.3.57 → 1.3.59

package/README.md

@@ -1,6 +1,11 @@
 # 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), 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.
+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),
+with [HTTP Multiresponse](https://braid.org/meeting-89), and [Multiplexing
+v1.0](https://braid.org/protocol/multiplexing).  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).
 
@@ -143,18 +148,17 @@ var braidify = require('braid-http').http_server
 import {http_server as braidify} from 'braid-http'
 
 require('http').createServer(
-    (req, res) => {
-        // Add braid stuff to req and res
-        braidify(req, res)
+    braidify((req, res) => {
+        // Now braid stuff is available on req and res
 
-        // Now use it
+        // So you can easily handle subscriptions
         if (req.subscribe)
             res.startSubscription({ onClose: _=> null })
             // startSubscription automatically sets statusCode = 209
         else
             res.statusCode = 200
 
-        // Send the current version
+        // And send updates over a subscription
         res.sendUpdate({
             version: ['greg'],
             body: JSON.stringify({greg: 'greg'})
@@ -165,8 +169,8 @@ require('http').createServer(
 
 ### Example Nodejs server with `require('express')`
 
-With `express`, you can simply call `app.use(braidify)` to get braid features
-added to every request and response.
+Or if you're using `express`, you can just call `app.use(braidify)` to get
+braid features added to every request and response.
 
 ```javascript
 var braidify = require('braid-http').http_server

package/braid-http-client.js

@@ -900,14 +900,16 @@ async function multiplex_fetch(url, params, mux_params) {
     var mux_key = params.headers.get('multiplex-through')?.split('/')[3] ?? origin
 
     // create a new multiplexer if it doesn't exist for this origin
-    if (!multiplex_fetch.multiplexers)          multiplex_fetch.multiplexers = {}
+    if (!multiplex_fetch.multiplexers)
+        multiplex_fetch.multiplexers = {}
 
     // this for-loop allows us to retry right away,
     // in case of duplicate ids
     for (let attempt = 1; ; attempt++) {
         await new Promise(done => setTimeout(done, attempt >= 3 ? 1000 : 0))
 
-        if (!multiplex_fetch.multiplexers[mux_key]) multiplex_fetch.multiplexers[mux_key] =
+        // Create a multiplexer if it does not exist yet
+        multiplex_fetch.multiplexers[mux_key] ||=
             create_multiplexer(origin, mux_key, params, mux_params, attempt)
 
         // call the special fetch function for the multiplexer

package/braid-http-server.js

@@ -251,16 +251,23 @@ function braidify (req, res, next) {
     // Multiplexer stuff
     var multiplex_version = '1.0'
     if ((braidify.enable_multiplex ?? true) &&
-        (req.method === 'MULTIPLEX' || req.url.startsWith('/.well-known/multiplexer/')) &&
-        req.headers['multiplex-version'] === multiplex_version) {
-
-        // let the caller know we're handling things
-        req.is_multiplexer = res.is_multiplexer = true
+        (req.method === 'MULTIPLEX' || req.url.startsWith('/.well-known/multiplexer/'))) {
 
         // free the cors
         res.setHeader("Access-Control-Allow-Origin", "*")
         res.setHeader("Access-Control-Allow-Methods", "*")
         res.setHeader("Access-Control-Allow-Headers", "*")
+        res.setHeader("Access-Control-Expose-Headers", "*")
+        if (req.method === 'OPTIONS') return res.end()
+
+        // check the multiplexing protocol version
+        if (req.headers['multiplex-version'] !== multiplex_version) {
+            res.writeHead(400, 'Bad Multiplexer Version')
+            return res.end()
+        }
+
+        // let the caller know we're handling things
+        req.is_multiplexer = res.is_multiplexer = true
 
         // parse the multiplexer id and request id from the url
         var [multiplexer, request] = req.url.split('/').slice(req.method === 'MULTIPLEX' ? 1 : 3)
@@ -293,7 +300,7 @@ function braidify (req, res, next) {
             res.writeHead(200, 'OK', {
                 'Multiplex-Version': multiplex_version,
                 'Incremental': '?1',
-                'Cache-Control': 'no-cache',
+                'Cache-Control': 'no-store',
                 'X-Accel-Buffering': 'no',
                 ...req.httpVersion !== '2.0' && {'Connection': 'keep-alive'}
             })
@@ -373,7 +380,7 @@ function braidify (req, res, next) {
 
             // copy any CORS headers from the user
             var cors_headers = Object.entries(res2.getHeaders()).
-                filter(x => braidify.cors_headers.has(x.key))
+                filter(x => braidify.cors_headers.has(x[0]))
 
             if (og_stream) {
                 og_stream.respond({
@@ -440,6 +447,10 @@ function braidify (req, res, next) {
         // we want to send a special message to the multiplexer saying so
         res2.on('finish', () => m.res.write(`close response ${request}\r\n`))
 
+        // copy over any headers which have already been set on res to res2
+        for (let x of Object.entries(res.getHeaders()))
+            res2.setHeader(...x)
+
         // we want access to "res" to be forwarded to our fake "res2",
         // so that it goes into the multiplexer
         function* get_props(obj) {

package/package.json

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