braid-text 0.2.67 → 0.2.68

package/index.js

@@ -16,6 +16,15 @@ function create_braid_text() {
 
     let max_encoded_key_size = 240
 
+    braid_text.sync = async (a, b, options) => {
+        braid_text.get(a, {
+            subscribe: update => braid_text.put(b, update)
+        })
+        braid_text.get(b, {
+            subscribe: update => braid_text.put(a, update)
+        })
+    }
+
     braid_text.serve = async (req, res, options = {}) => {
         options = {
             key: req.url.split('?')[0], // Default key
@@ -237,7 +246,7 @@ function create_braid_text() {
                         req.parents,
                         resource.actor_seqs,
                         // approximation of memory usage for this update
-                        body ? body.length :
+                        body != null ? body.length :
                             patches.reduce((a, b) => a + b.range.length + b.content.length, 0),
                         options.recv_buffer_max_time,
                         options.recv_buffer_max_space)
@@ -270,7 +279,8 @@ function create_braid_text() {
                     return done_my_turn(550, "repr-digest mismatch!")
                 }
 
-                if (req.version) got_event(options.key, req.version[0], change_count)
+                if (req.version?.length)
+                    got_event(options.key, req.version[0], change_count)
             
                 res.setHeader("Version", get_current_version())
 
@@ -308,7 +318,12 @@ function create_braid_text() {
             var res = await braid_fetch(key.href, params)
 
             if (options.subscribe) {
-                res.subscribe(options.subscribe)
+                res.subscribe(update => {
+                    update.body = update.body_text
+                    if (update.patches)
+                        for (var p of update.patches) p.content = p.content_text
+                    options.subscribe(update)
+                })
                 return res
             } else return await res.text()
         }
@@ -452,7 +467,7 @@ function create_braid_text() {
                 signal: options.my_abort.signal,
                 retry: () => true,
             }
-            for (var x of ['headers', 'parents', 'version', 'peer', 'body'])
+            for (var x of ['headers', 'parents', 'version', 'peer', 'body', 'patches'])
                 if (options[x] != null) params[x] = options[x]
 
             return await braid_fetch(key.href, params)
@@ -494,6 +509,12 @@ function create_braid_text() {
         }
 
         if (version) validate_version_array(version)
+        if (version && !version.length) {
+            console.log(`warning: ignoring put with empty version`)
+            return { change_count: 0 }
+        }
+        if (version && version.length > 1)
+            throw new Error(`cannot put a version with multiple ids`)
 
         // translate a single parent of "root" to the empty array (same meaning)
         let options_parents = options.parents

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "braid-text",
-  "version": "0.2.67",
+  "version": "0.2.68",
   "description": "Library for collaborative text over http using braid.",
   "author": "Braid Working Group",
   "repository": "braid-org/braid-text",
   "homepage": "https://braid.org",
   "dependencies": {
     "@braid.org/diamond-types-node": "^2.0.0",
-    "braid-http": "~1.3.80"
+    "braid-http": "~1.3.83"
   }
 }

package/test/test.html

@@ -96,105 +96,275 @@ async function runTest(testName, testFunction, expectedResult) {
     }
 }
 
-// runTest(
-//     "test braid_text.get(url), with no options",
-//     async () => {
-//         var key = 'test-' + Math.random().toString(36).slice(2)
-//         let r = await braid_fetch(`/${key}`, {
-//             method: 'PUT',
-//             body: 'hi'
-//         })
-//         if (!r.ok) return 'got: ' + r.status
-
-//         var r1 = await braid_fetch(`/eval`, {
-//             method: 'PUT',
-//             body: `void (async () => {
-//                 res.end(await braid_text.get(new URL('http://localhost:8889/${key}')))
-//             })()`
-//         })
-
-//         return 'got: ' + (await r1.text())
-//     },
-//     'got: hi'
-// )
-
-// runTest(
-//     "test braid_text.get(url), with headers",
-//     async () => {
-//         var key = 'test-' + Math.random().toString(36).slice(2)
-//         let r = await braid_fetch(`/${key}`, {
-//             method: 'PUT',
-//             version: ['xyz-1'],
-//             body: 'hi'
-//         })
-//         if (!r.ok) return 'got: ' + r.status
-
-//         var r1 = await braid_fetch(`/eval`, {
-//             method: 'PUT',
-//             body: `void (async () => {
-//                 res.end(await braid_text.get(new URL('http://localhost:8889/${key}'), {
-//                     headers: {
-//                         version: '"xyz-0"'
-//                     }
-//                 }))
-//             })()`
-//         })
-
-//         return 'got: ' + (await r1.text())
-//     },
-//     'got: h'
-// )
-
-// runTest(
-//     "test braid_text.get(url), with parents",
-//     async () => {
-//         var key = 'test-' + Math.random().toString(36).slice(2)
-//         let r = await braid_fetch(`/${key}`, {
-//             method: 'PUT',
-//             version: ['xyz-1'],
-//             body: 'hi'
-//         })
-//         if (!r.ok) return 'got: ' + r.status
-
-//         var r1 = await braid_fetch(`/eval`, {
-//             method: 'PUT',
-//             body: `void (async () => {
-//                 res.end(await braid_text.get(new URL('http://localhost:8889/${key}'), {
-//                     parents: ['xyz-0']
-//                 }))
-//             })()`
-//         })
-
-//         return 'got: ' + (await r1.text())
-//     },
-//     'got: h'
-// )
-
-// runTest(
-//     "test braid_text.get(url), with version and peer",
-//     async () => {
-//         var key = 'test-' + Math.random().toString(36).slice(2)
-//         let r = await braid_fetch(`/${key}`, {
-//             method: 'PUT',
-//             version: ['xyz-1'],
-//             body: 'hi'
-//         })
-//         if (!r.ok) return 'got: ' + r.status
-
-//         var r1 = await braid_fetch(`/eval`, {
-//             method: 'PUT',
-//             body: `void (async () => {
-//                 res.end(await braid_text.get(new URL('http://localhost:8889/${key}'), {
-//                     version: ['xyz-0'],
-//                     peer: 'xyz'
-//                 }))
-//             })()`
-//         })
-
-//         return 'got: ' + (await r1.text())
-//     },
-//     'got: h'
-// )
+runTest(
+    "test subscribe update with body_text",
+    async () => {
+        var key = 'test' + Math.random().toString(36).slice(2)
+
+        var r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            body: 'hi'
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        var r1p = braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                var x = await new Promise(done => {
+                    braid_text.get(new URL('http://localhost:8889/${key}'), {
+                        subscribe: update => {
+                            if (update.body_text) done(update.body_text)
+                        }
+                    })
+                })
+                res.end(x)
+            })()`
+        })
+
+        var r2 = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            body: 'yo'
+        })
+
+        var r1 = await r1p
+        if (!r1.ok) return 'got: ' + r.status
+
+        return await r1.text()
+    },
+    'yo'
+)
+
+runTest(
+    "test braid_text.sync, url to key",
+    async () => {
+        var key_a = 'test-a-' + Math.random().toString(36).slice(2)
+        var key_b = 'test-b-' + Math.random().toString(36).slice(2)
+
+        var r = await braid_fetch(`/${key_a}`, {
+            method: 'PUT',
+            body: 'hi'
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        var r = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                braid_text.sync(new URL('http://localhost:8889/${key_a}'), '/${key_b}')
+                res.end('')
+            })()`
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        await new Promise(done => setTimeout(done, 100))
+
+        var r = await braid_fetch(`/${key_b}`)
+        return 'got: ' + (await r.text())
+    },
+    'got: hi'
+)
+
+runTest(
+    "test braid_text.sync, with two urls",
+    async () => {
+        var key_a = 'test-a-' + Math.random().toString(36).slice(2)
+        var key_b = 'test-b-' + Math.random().toString(36).slice(2)
+
+        var r = await braid_fetch(`/${key_a}`, {
+            method: 'PUT',
+            body: 'hi'
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        var r = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                braid_text.sync(new URL('http://localhost:8889/${key_a}'),
+                    new URL('http://localhost:8889/${key_b}'))
+                res.end('')
+            })()`
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        await new Promise(done => setTimeout(done, 100))
+
+        var r = await braid_fetch(`/${key_b}`)
+        return 'got: ' + (await r.text())
+    },
+    'got: hi'
+)
+
+runTest(
+    "test braid_text.sync, key to url",
+    async () => {
+        var key_a = 'test-a-' + Math.random().toString(36).slice(2)
+        var key_b = 'test-b-' + Math.random().toString(36).slice(2)
+
+        var r = await braid_fetch(`/${key_a}`, {
+            method: 'PUT',
+            body: 'hi'
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        var r = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                braid_text.sync('/${key_a}', new URL('http://localhost:8889/${key_b}'))
+                res.end('')
+            })()`
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        await new Promise(done => setTimeout(done, 100))
+
+        var r = await braid_fetch(`/${key_b}`)
+        return 'got: ' + (await r.text())
+    },
+    'got: hi'
+)
+
+runTest(
+    "test braid_text.sync, with two keys",
+    async () => {
+        var key_a = 'test-a-' + Math.random().toString(36).slice(2)
+        var key_b = 'test-b-' + Math.random().toString(36).slice(2)
+
+        var r = await braid_fetch(`/${key_a}`, {
+            method: 'PUT',
+            body: 'hi'
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        var r = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                braid_text.sync('/${key_a}', '/${key_b}')
+                res.end('')
+            })()`
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        await new Promise(done => setTimeout(done, 100))
+
+        var r = await braid_fetch(`/${key_b}`)
+        return 'got: ' + (await r.text())
+    },
+    'got: hi'
+)
+
+runTest(
+    "test putting version with multiple event ids, should have error",
+    async () => {
+        var key_a = 'test-a-' + Math.random().toString(36).slice(2)
+
+        var r = await braid_fetch(`/${key_a}`, {
+            method: 'PUT',
+            version: ['abc-1', 'xyz-2'],
+            body: 'hi'
+        })
+        return '' + (await r.text()).includes('cannot put a version with multiple ids')
+    },
+    'true'
+)
+
+runTest(
+    "test braid_text.get(url), with no options",
+    async () => {
+        var key = 'test-' + Math.random().toString(36).slice(2)
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            body: 'hi'
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        var r1 = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                res.end(await braid_text.get(new URL('http://localhost:8889/${key}')))
+            })()`
+        })
+
+        return 'got: ' + (await r1.text())
+    },
+    'got: hi'
+)
+
+runTest(
+    "test braid_text.get(url), with headers",
+    async () => {
+        var key = 'test-' + Math.random().toString(36).slice(2)
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['xyz-1'],
+            body: 'hi'
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        var r1 = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                res.end(await braid_text.get(new URL('http://localhost:8889/${key}'), {
+                    headers: {
+                        version: '"xyz-0"'
+                    }
+                }))
+            })()`
+        })
+
+        return 'got: ' + (await r1.text())
+    },
+    'got: h'
+)
+
+runTest(
+    "test braid_text.get(url), with parents",
+    async () => {
+        var key = 'test-' + Math.random().toString(36).slice(2)
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['xyz-1'],
+            body: 'hi'
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        var r1 = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                res.end(await braid_text.get(new URL('http://localhost:8889/${key}'), {
+                    parents: ['xyz-0']
+                }))
+            })()`
+        })
+
+        return 'got: ' + (await r1.text())
+    },
+    'got: h'
+)
+
+runTest(
+    "test braid_text.get(url), with version and peer",
+    async () => {
+        var key = 'test-' + Math.random().toString(36).slice(2)
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['xyz-1'],
+            body: 'hi'
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        var r1 = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                res.end(await braid_text.get(new URL('http://localhost:8889/${key}'), {
+                    version: ['xyz-0'],
+                    peer: 'xyz'
+                }))
+            })()`
+        })
+
+        return 'got: ' + (await r1.text())
+    },
+    'got: h'
+)
 
 runTest(
     "test braid_text.get(url) with subscription",
@@ -220,7 +390,7 @@ runTest(
                     }
                     braid_text.get(url, o)
                 })
-                res.end(update.body_text)
+                res.end(update.body)
             })()`
         })