braid-text 0.2.61 → 0.2.63

package/index.js

@@ -40,6 +40,52 @@ braid_text.serve = async (req, res, options = {}) => {
 
     let peer = req.headers["peer"]
 
+    // selection sharing prototype
+    if (req.headers['selection-sharing-prototype']) {
+        res.setHeader('Content-Type', 'application/json')
+
+        if (!resource.selections) resource.selections = {}
+        if (!resource.selection_clients) resource.selection_clients = new Set()
+
+        if (req.method === "GET" || req.method === "HEAD") {
+            if (!req.subscribe) {
+                return my_end(200, JSON.stringify(resource.selections))
+            } else {
+                var client = {peer, res}
+                resource.selection_clients.add(client)
+                res.startSubscription({
+                    onClose: () => resource.selection_clients.delete(client)
+                })
+                res.sendUpdate({ body: JSON.stringify(resource.selections) })
+                return
+            }
+        } else if (req.method == "PUT" || req.method == "POST" || req.method == "PATCH") {
+            var body = (await req.patches())[0].content_text
+            var json = JSON.parse(body)
+
+            // only keep new selections if they are newer
+            for (var [user, selection] of Object.entries(json)) {
+                if (resource.selections[user] && resource.selections[user].time > selection.time) delete json[user]
+                else resource.selections[user] = selection
+            }
+
+            // remove old selections that are too old
+            var long_ago = Date.now() - 1000 * 60 * 5
+            for (var [user, selection] of Object.entries(resource.selections))
+                if (selection.time < long_ago) {
+                    delete resource.selections[user]
+                    delete json[user]
+                }
+
+            body = JSON.stringify(json)
+            if (body.length > 2)
+                for (let client of resource.selection_clients)
+                    if (client.peer !== peer) client.res.sendUpdate({ body })
+            
+            return my_end(200)
+        }
+    }
+
     let merge_type = req.headers["merge-type"]
     if (!merge_type) merge_type = 'simpleton'
     if (merge_type !== 'simpleton' && merge_type !== 'dt') return my_end(400, `Unknown merge type: ${merge_type}`)
@@ -201,7 +247,7 @@ braid_text.serve = async (req, res, options = {}) => {
                     if (!resource.actor_seqs[actor]?.has(seq)) unknowns.push(event)
                 }
                 if (unknowns.length)
-                    return done_my_turn(309, '', "Version Unknown", {
+                    return done_my_turn(309, '', "Version Unknown Here", {
                         Version: ascii_ify(unknowns.map(e => JSON.stringify(e)).join(', ')),
                         'Retry-After': '1'
                     })

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "braid-text",
-  "version": "0.2.61",
+  "version": "0.2.63",
   "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.79"
+    "braid-http": "~1.3.80"
   }
 }

package/test/test.html

@@ -96,6 +96,174 @@ async function runTest(testName, testFunction, expectedResult) {
     }
 }
 
+runTest(
+    "test selection-sharing-prototype PUT and GET",
+    async () => {
+        let key = 'test-' + Math.random().toString(36).slice(2)
+
+        let time = Date.now()
+
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            body: JSON.stringify({
+                hello: {
+                    yo: 'hi',
+                    time
+                }
+            }),
+            headers: {
+                'selection-sharing-prototype': 'true'
+            }
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        let r2 = await braid_fetch(`/${key}`, {
+            method: 'GET',
+            headers: {
+                'selection-sharing-prototype': 'true'
+            }
+        })
+        if (!r2.ok) return 'got: ' + r2.status
+
+        let o = await r2.json()
+        return o.hello.time === time ? 'times match' : 'bad'
+    },
+    'times match'
+)
+
+runTest(
+    "test selection-sharing-prototype GET/subscribe",
+    async () => {
+        let key = 'test-' + Math.random().toString(36).slice(2)
+
+        var a = new AbortController()
+        let r = await braid_fetch(`/${key}`, {
+            method: 'GET',
+            signal: a.signal,
+            subscribe: true,
+            peer: 'abc',
+            headers: {
+                'selection-sharing-prototype': 'true'
+            }
+        })
+        if (!r.ok) return 'got: ' + r.status
+        var p = new Promise(done => {
+            r.subscribe(update => {
+                var body = update.body_text
+                if (body.length > 2) done(body)
+            })
+        })
+
+        var time = Date.now()
+
+        let r2 = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            peer: 'xyz',
+            body: JSON.stringify({
+                hello: {
+                    yo: 'hi',
+                    time
+                }
+            }),
+            headers: {
+                'selection-sharing-prototype': 'true'
+            }
+        })
+        if (!r2.ok) return 'got: ' + r2.status
+
+        var ret_val = JSON.parse(await p).hello.time === time ? 'times match' : 'bad'
+
+        a.abort()
+
+        return ret_val
+    },
+    'times match'
+)
+
+runTest(
+    "test selection-sharing-prototype PUT old cursor",
+    async () => {
+        let key = 'test-' + Math.random().toString(36).slice(2)
+
+        let time = Date.now()
+
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            body: JSON.stringify({
+                hello: {
+                    yo: 'hi',
+                    time
+                }
+            }),
+            headers: {
+                'selection-sharing-prototype': 'true'
+            }
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        let r3 = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            body: JSON.stringify({
+                hello: {
+                    yo: 'hoop',
+                    time: time - 5
+                }
+            }),
+            headers: {
+                'selection-sharing-prototype': 'true'
+            }
+        })
+        if (!r3.ok) return 'got: ' + r3.status
+
+        let r2 = await braid_fetch(`/${key}`, {
+            method: 'GET',
+            headers: {
+                'selection-sharing-prototype': 'true'
+            }
+        })
+        if (!r2.ok) return 'got: ' + r2.status
+
+        let o = await r2.json()
+        return o.hello.yo
+    },
+    'hi'
+)
+
+runTest(
+    "test selection-sharing-prototype PUT really old cursor",
+    async () => {
+        let key = 'test-' + Math.random().toString(36).slice(2)
+
+        let time = Date.now() - 1000 * 60 * 60 * 24
+
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            body: JSON.stringify({
+                hello: {
+                    yo: 'hi',
+                    time
+                }
+            }),
+            headers: {
+                'selection-sharing-prototype': 'true'
+            }
+        })
+        if (!r.ok) return 'got: ' + r.status
+
+        let r2 = await braid_fetch(`/${key}`, {
+            method: 'GET',
+            headers: {
+                'selection-sharing-prototype': 'true'
+            }
+        })
+        if (!r2.ok) return 'got: ' + r2.status
+
+        let o = await r2.json()
+        return JSON.stringify(o)
+    },
+    '{}'
+)
+
 runTest(
     "test PUT digest (good)",
     async () => {
@@ -965,7 +1133,7 @@ runTest(
         })
         return r.status + ' ' + r.ok + ' ' + r.statusText +  ' ' + r.headers.get('Version')
     },
-    '309 false Version Unknown "missing-0", "y\\ud83d\\ude00-0"'
+    '309 false Version Unknown Here "missing-0", "y\\ud83d\\ude00-0"'
 )
 
 runTest(