statebus 6.2.3 → 6.2.5

package/client.js

@@ -461,7 +461,7 @@
     re_rendering = false
     function schedule_re_render() {
         if (!re_render_scheduled) {
-            requestAnimationFrame(function () {
+            requestAnimationFrame(bus.extend_reaction(function () {
                 re_render_scheduled = false
 
                 // Re-renders dirty components
@@ -476,7 +476,7 @@
                             re_rendering = false
                         }
                 }
-            })
+            }))
             re_render_scheduled = true
         }
     }

package/extras/tests.js

@@ -1644,6 +1644,66 @@ test(function common_time (done) {
     delay(50, done)
 })
 
+test(function closed_net_mount_stops_retrying (done) {
+    // Nothing listens on port 1, so the socket never opens, and this fetch
+    // waits in the outbox with a retry timer running
+    var c = require('../statebus')()
+    var mount = c.net_mount('/*', 'statei://localhost:1')
+    c.fetch('/anything')
+    mount.close()
+
+    // Count the retries over the next second
+    var retries = 0
+    var real_setTimeout = setTimeout
+    setTimeout = function (f) {
+        if (f.name == 'flush_outbox') retries++
+        return real_setTimeout.apply(this, arguments)
+    }
+    real_setTimeout(function () {
+        setTimeout = real_setTimeout
+        assert(retries == 0, 'flush_outbox retried ' + retries + ' times after close()')
+        done()
+    }, 1000)
+})
+
+test(function extend_reaction (done) {
+    var forgotten = []
+    function record_forget (key) { forgotten.push(key) }
+    bus('extended/*').to_forget = record_forget
+
+    // Reads two keys, and reacts to a change by leaving its re-run for
+    // later, the way client.js waits for an animation frame.  The re-run
+    // reads only one of the keys.
+    var rerun, reading_b = true
+    var funk = bus.reactive(function () {
+        if (funk.called_directly) {
+            bus.fetch('extended/a')
+            if (reading_b) bus.fetch('extended/b')
+        } else
+            rerun = bus.extend_reaction(function () {
+                reading_b = false
+                funk()
+            })
+    })
+    funk()
+    bus.save({key: 'extended/a', n: 1})
+
+    // While the re-run waits, nothing is forgotten
+    setTimeout(function () {
+        assert(rerun, 'The change did not start a reaction')
+        assert(forgotten.length == 0, 'Forgot ' + forgotten + ' before the re-run')
+        rerun()
+
+        // Within a second after it, the key it stopped reading is forgotten
+        setTimeout(function () {
+            assert.deepEqual(forgotten, ['extended/b'])
+            funk.forget()
+            bus('extended/*').to_forget.delete(record_forget)
+            done()
+        }, 1100)
+    }, 400)
+})
+
 
 // The following tests are unfinished
 if (false) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "statebus",
-  "version": "6.2.3",
+  "version": "6.2.5",
   "description": "Synchronize state.",
   "main": "statebus.js",
   "scripts": {
@@ -11,7 +11,14 @@
     "statebus.js",
     "client.js",
     "server.js",
-    "extras/",
+    "extras/coffee.js",
+    "extras/dash.coffee",
+    "extras/diffsync.js",
+    "extras/getCaretCoordinates.js",
+    "extras/react.js",
+    "extras/sockjs.js",
+    "extras/tcp-bind.js",
+    "extras/tests.js",
     "readme.md"
   ],
   "repository": "invisible-college/statebus",

package/server.js

@@ -981,7 +981,8 @@ function import_server (bus, options)
             // https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/api.md#backupdestination-options---promise
             function backup_db() {
                 if (opts.backups === false) return
-                var backup_dir = opts.backup_dir || 'backups'
+                var path = require('path')
+                var backup_dir = opts.backup_dir || path.join(path.dirname(opts.filename), 'backups')
                 if (fs.existsSync && !fs.existsSync(backup_dir))
                     fs.mkdirSync(backup_dir)
 
@@ -995,7 +996,7 @@ function import_server (bus, options)
 
                 require('child_process').execFile(
                     'sqlite3',
-                    [opts.filename, '.backup '+"'"+backup_dir+'/'+opts.filename+'.'+date+"'"])
+                    [opts.filename, '.backup '+"'"+path.join(backup_dir, path.basename(opts.filename)+'.'+date)+"'"])
             },
             1000 * 60 // Every minute
         )
@@ -2010,7 +2011,7 @@ function import_server (bus, options)
             // Validate that the login/name is not changed to something clobberish
             var old_login = u.login || u.name
             if (old_login.toLowerCase() !== login.toLowerCase()
-                && userpass.hasOwnProperty(login)) {
+                && userpass.hasOwnProperty(login.toLowerCase())) {
                 client.log('The login', login, 'is already taken. Aborting.')
                 client.save.abort(o)         // Abort
 
@@ -2364,7 +2365,6 @@ function import_server (bus, options)
 
             textbus.fetch(req.path) // So that textbus never clears the cache
             textbus.fetch(req.path, function cb (o) {
-                res.setHeader('Cache-Control', 'public')
                 res.setHeader('Cache-Control', 'public, max-age=' + (60 * 60 * 6))  // 6 hours
                 res.setHeader('ETag', o.etag)
                 res.setHeader('Access-Control-Allow-Origin', '*')

package/statebus.js

@@ -3,7 +3,7 @@
     if (typeof module != 'undefined') module.exports = definition()
     else if (typeof define == 'function' && typeof define.amd == 'object') define(definition)
     else this[name] = definition()
-}('statebus', function() {statelog_indent = 0; var busses = {}, executing_funk, global_funk, funks = {}, clean_timer, symbols, nodejs = typeof window === 'undefined'; function make_bus (options) {
+}('statebus', function() {statelog_indent = 0; var busses = {}, executing_funk, global_funk, funks = {}, clean_timer, unfinished_extended_reactions = 0, symbols, nodejs = typeof window === 'undefined'; function make_bus (options) {
     
 
     // ****************
@@ -407,7 +407,14 @@
         // .on_fetch handler.
         if (!fetches_in.has_any(key)) {
             clearTimeout(to_be_forgotten[key])
-            to_be_forgotten[key] = setTimeout(function () {
+            to_be_forgotten[key] = setTimeout(function run_forgetters () {
+                // Wait for any unfinished extended reaction, which may fetch
+                // the key again
+                if (unfinished_extended_reactions) {
+                    to_be_forgotten[key] = setTimeout(run_forgetters, 1000)
+                    return
+                }
+
                 // Send a forget upstream
                 bus.route(key, 'to_forget', key, t)
 
@@ -671,9 +678,9 @@
                 param_names.push(param.slice(1))
                 return prefix + '([^/]+)'
             }
-            var regex = new RegExp('^'
-                                   + pattern.replace(/(^|\/)(:[^/()]+)|(\*)/g, replace_param)
-                                   + '$')
+            var regex = new RegExp(
+                '^' + pattern.replace(/(^|\/)(:[^/()]+)|(\*)/g, replace_param) + '$'
+            )
             
             return function (path) {
                 var match = path.match(regex)
@@ -1190,6 +1197,31 @@
     // Tells you whether the currently executing funk is loading
     function loading () { return executing_funk.loading() }
 
+    // A reaction normally ends when its reactive function returns.  If it
+    // leaves work for code that runs later, such as on the next animation
+    // frame, wrap that code:
+    //
+    //    requestAnimationFrame(bus.extend_reaction(f))
+    //
+    // The reaction then lasts until f has run, and the state it read stays
+    // loaded until then.  f must eventually run, and if it leaves work for
+    // later too, wrap that as well.  Fetches inside f don't make it reactive,
+    // so read state in a reactive function that f calls.
+    function extend_reaction (f) {
+        unfinished_extended_reactions++
+        var finished = false
+        return function () {
+            try {
+                return f.apply(this, arguments)
+            } finally {
+                if (!finished) {
+                    finished = true
+                    unfinished_extended_reactions--
+                }
+            }
+        }
+    }
+
     bus.default = function () {
         bus.deep_map(arguments, function (o) {
             if (o.key && !(bus.cache.hasOwnProperty(o.key)))
@@ -1809,7 +1841,7 @@
                     // But normally we just send the message immediately
                     else
                         sock.send(outbox.shift())
-            else
+            else if (!done)
                 setTimeout(flush_outbox, 400)
         }
         function add_prefix (key) {
@@ -2488,7 +2520,7 @@
 
     // Make these private methods accessible
     var api = ['cache backup_cache fetch save forget del fire dirty fetch_once',
-               'subspace bindings run_handler bind unbind reactive uncallback',
+               'subspace bindings run_handler bind unbind reactive extend_reaction uncallback',
                'versions new_version',
                'make_proxy braid_proxy state sb link',
                'funk_key funk_name funks key_id key_name id',

package/extras/#test_save_delay.js#

@@ -1,11 +0,0 @@
-bus = require('../server.js')({
-    file_store: {save_delay: 1700},
-    full_node: true
-})
-//bus.file_store('*', {save_delay: 1700})
-bus.honk = true
-
-setTimeout(function () {console.log('100 ms happened')}, 100)
-setTimeout(function () {console.log('500 ms happened')}, 500)
-setTimeout(function () {console.log('1000 ms happened')}, 1000)
-bus.save({key: 'foo', 3: 4})

package/extras/abort-test.html

@@ -1,10 +0,0 @@
-<script type=coffee>
-dom.BODY = -> 'hello!'
-bus.honk = 1
-
-fetch('/foo')
-
-
-
-
-</script><script src=https://stateb.us/client6.js server="ws://localhost:9999"></script>

package/extras/abort-test.js

@@ -1,17 +0,0 @@
-bus = require('../statebus').serve({
-    port: 9999,
-    // client: (client) => {
-    //     client('foo').to_save = (obj, t) => {
-    //         client.fetch(obj.key)
-    //         t.abort()
-    //     }
-    // }
-})
-
-bus.honk = true
-
-bus('foo').to_save = (obj, t) => {
-    delete obj.body
-    t.done()
-    t.abort()
-}

package/extras/backups/db.2021-11-13

@@ -1,12 +0,0 @@
-{
- "connections": {
-  "key": "connections"
- },
- "foo": {
-  "3": 4,
-  "key": "foo"
- },
- "users/passwords": {
-  "key": "users/passwords"
- }
-}

package/extras/backups/db.2021-11-14

@@ -1,12 +0,0 @@
-{
- "connections": {
-  "key": "connections"
- },
- "foo": {
-  "3": 4,
-  "key": "foo"
- },
- "users/passwords": {
-  "key": "users/passwords"
- }
-}

package/extras/backups/db.2021-11-15

@@ -1,25 +0,0 @@
-{
- "connections": {
-  "key": "connections"
- },
- "foo": {
-  "3": 4,
-  "key": "foo"
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "_": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "stuff": {
-   "Yeah": "man",
-   "this_is": {
-    "the": "stuff!"
-   }
-  }
- }
-}

package/extras/backups/db.2021-11-16

@@ -1,25 +0,0 @@
-{
- "connections": {
-  "key": "connections"
- },
- "foo": {
-  "3": 4,
-  "key": "foo"
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "_": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "stuff": {
-   "Yeah": "man",
-   "this_is": {
-    "the": "stuff!"
-   }
-  }
- }
-}

package/extras/backups/db.2022-01-14

@@ -1,24 +0,0 @@
-{
- "connections": {
-  "key": "connections"
- },
- "foo": {
-  "key": "foo",
-  "val": {
-   "foo": 9
-  }
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "val": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "val": {
-   "hey man": "hell yeah stuff!"
-  }
- }
-}

package/extras/backups/db.2022-01-15

@@ -1,29 +0,0 @@
-{
- "connections": {
-  "key": "connections"
- },
- "foo": {
-  "key": "foo",
-  "val": {
-   "foo": 9
-  }
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "val": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "val": {
-   "stuff": {
-    "Yeah": "man",
-    "this_is": {
-     "the": "stuff!"
-    }
-   }
-  }
- }
-}

package/extras/backups/db.2022-01-16

@@ -1,29 +0,0 @@
-{
- "connections": {
-  "key": "connections"
- },
- "foo": {
-  "key": "foo",
-  "val": {
-   "foo": 9
-  }
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "val": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "val": {
-   "stuff": {
-    "Yeah": "man",
-    "this_is": {
-     "the": "stuff!"
-    }
-   }
-  }
- }
-}

package/extras/backups/db.2022-01-17

@@ -1,29 +0,0 @@
-{
- "connections": {
-  "key": "connections"
- },
- "foo": {
-  "key": "foo",
-  "val": {
-   "foo": 9
-  }
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "val": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "val": {
-   "stuff": {
-    "Yeah": "man",
-    "this_is": {
-     "the": "stuff!"
-    }
-   }
-  }
- }
-}

package/extras/backups/db.2022-01-18

@@ -1,29 +0,0 @@
-{
- "connections": {
-  "key": "connections"
- },
- "foo": {
-  "key": "foo",
-  "val": {
-   "foo": 9
-  }
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "val": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "val": {
-   "stuff": {
-    "Yeah": "man",
-    "this_is": {
-     "the": "stuff!"
-    }
-   }
-  }
- }
-}

package/extras/backups/db.2022-01-19

@@ -1,29 +0,0 @@
-{
- "connections": {
-  "key": "connections"
- },
- "foo": {
-  "key": "foo",
-  "val": {
-   "foo": 9
-  }
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "val": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "val": {
-   "stuff": {
-    "Yeah": "man",
-    "this_is": {
-     "the": "stuff!"
-    }
-   }
-  }
- }
-}

package/extras/backups/db.2022-01-20

@@ -1,32 +0,0 @@
-{
- "connections": {
-  "key": "connections",
-  "6fab8674-ac94-4ea8-a055-3906d0cf0efd": {
-   "client": "6fab8674-ac94-4ea8-a055-3906d0cf0efd",
-   "id": "6fab8674-ac94-4ea8-a055-3906d0cf0efd"
-  }
- },
- "foo": {
-  "key": "foo",
-  "val": 13
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "val": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "val": {
-   "stuff": {
-    "Yeah": "man",
-    "this_is": {
-     "the": "stuff!"
-    }
-   },
-   "fluff": true
-  }
- }
-}

package/extras/backups/db.2022-01-21

@@ -1,32 +0,0 @@
-{
- "connections": {
-  "key": "connections",
-  "c1eb2211-a43a-4efb-a26f-bf66d3f3f289": {
-   "client": "c1eb2211-a43a-4efb-a26f-bf66d3f3f289",
-   "id": "c1eb2211-a43a-4efb-a26f-bf66d3f3f289"
-  }
- },
- "foo": {
-  "key": "foo",
-  "val": 3
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "val": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "val": {
-   "stuff": {
-    "Yeah": "man",
-    "this_is": {
-     "the": "stuff!"
-    }
-   },
-   "fluff": true
-  }
- }
-}

package/extras/backups/db.2022-01-22

@@ -1,47 +0,0 @@
-{
- "connections": {
-  "key": "connections",
-  "780834b9-8898-407f-aca8-2c16a5b648d9": {
-   "client": "780834b9-8898-407f-aca8-2c16a5b648d9",
-   "id": "780834b9-8898-407f-aca8-2c16a5b648d9"
-  }
- },
- "foo": {
-  "key": "foo",
-  "val": 3
- },
- "users/passwords": {
-  "key": "users/passwords"
- },
- "some_text": {
-  "key": "some_text",
-  "val": "Hello! This is the text."
- },
- "stuff": {
-  "key": "stuff",
-  "val": {
-   "stuff": {
-    "Yeah": "man",
-    "this_is": {
-     "the": "stuff!"
-    }
-   },
-   "fluff": true
-  }
- },
- "bar": {
-  "key": "bar",
-  "val": {
-   "me": "you"
-  }
- },
- "link": {
-  "key": "link",
-  "val": {
-   "key": "bar",
-   "val": {
-    "me": "you"
-   }
-  }
- }
-}