braid-text 0.2.45 → 0.2.47

package/index.js

@@ -293,14 +293,20 @@ braid_text.get = async (key, options) => {
         } else {
 
             if (options.accept_encoding?.match(/updates\s*\((.*)\)/)?.[1].split(',').map(x=>x.trim()).includes('dt')) {
-                var bytes = resource.doc.toBytes()
-                if (options.parents) {
-                    var doc = Doc.fromBytes(bytes)
-                    bytes = doc.getPatchSince(
-                        dt_get_local_version(bytes, options.parents))
-                    doc.free()
+                // optimization: if client wants past current version,
+                //               send empty dt
+                if (options.parents && v_eq(options.parents, version)) {
+                    options.subscribe({ encoding: 'dt', body: new Doc().toBytes() })
+                } else {
+                    var bytes = resource.doc.toBytes()
+                    if (options.parents) {
+                        var doc = Doc.fromBytes(bytes)
+                        bytes = doc.getPatchSince(
+                            dt_get_local_version(bytes, options.parents))
+                        doc.free()
+                    }
+                    options.subscribe({ encoding: 'dt', body: bytes })
                 }
-                options.subscribe({ encoding: 'dt', body: bytes })
             } else {
                 var updates = null
                 if (!options.parents && !options.version) {
@@ -426,7 +432,7 @@ braid_text.put = async (key, options) => {
     // validate version: make sure we haven't seen it already
     if (resource.actor_seqs[v[0]]?.has(v[1])) {
 
-        if (!options.validate_already_seen_versions) return
+        if (!options.validate_already_seen_versions) return { change_count }
 
         // if we have seen it already, make sure it's the same as before
         let updates = dt_get_patches(resource.doc, og_parents)
@@ -483,7 +489,7 @@ braid_text.put = async (key, options) => {
         }
 
         // we already have this version, so nothing left to do
-        return
+        return { change_count: change_count }
     }
     if (!resource.actor_seqs[v[0]]) resource.actor_seqs[v[0]] = new RangeSet()
     resource.actor_seqs[v[0]].add_range(v[1] + 1 - change_count, v[1])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braid-text",
-  "version": "0.2.45",
+  "version": "0.2.47",
   "description": "Library for collaborative text over http using braid.",
   "author": "Braid Working Group",
   "repository": "braid-org/braid-text",

package/test/test.html

@@ -96,6 +96,98 @@ async function runTest(testName, testFunction, expectedResult) {
     }
 }
 
+runTest(
+    "test PUTing a version that the server already has",
+    async () => {
+        var key = 'test-' + Math.random().toString(36).slice(2)
+
+        var r1 = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['hi-0'],
+            parents: [],
+            body: 'x'
+        })
+
+        var r2 = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['hi-0'],
+            parents: [],
+            body: 'x'
+        })
+
+        return r1.status + " " + r2.status
+    },
+    '200 200'
+)
+
+runTest(
+    "test validate_already_seen_versions with same version",
+    async () => {
+        var key = 'test-' + Math.random().toString(36).slice(2)
+
+        var r1 = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                var resource = await braid_text.get_resource('/${key}')
+
+                var {change_count} = await braid_text.put(resource, { peer: "abc", version: ["hi-2"], parents: [], patches: [{unit: "text", range: "[0:0]", content: "XYZ"}], merge_type: "dt" })
+
+                res.end('' + change_count)
+            })()`
+        })
+
+        var r2 = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                var resource = await braid_text.get_resource('/${key}')
+
+                var {change_count} = await braid_text.put(resource, { peer: "abc", version: ["hi-2"], parents: [], patches: [{unit: "text", range: "[0:0]", content: "XYZ"}], merge_type: "dt", validate_already_seen_versions: true })
+
+                res.end('' + change_count)
+            })()`
+        })
+
+        return (await r1.text()) + " " + (await r2.text())
+    },
+    '3 3'
+)
+
+runTest(
+    "test validate_already_seen_versions with modified version",
+    async () => {
+        var key = 'test-' + Math.random().toString(36).slice(2)
+
+        var r1 = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                var resource = await braid_text.get_resource('/${key}')
+
+                var {change_count} = await braid_text.put(resource, { peer: "abc", version: ["hi-2"], parents: [], patches: [{unit: "text", range: "[0:0]", content: "XYZ"}], merge_type: "dt" })
+
+                res.end('' + change_count)
+            })()`
+        })
+
+        var r2 = await braid_fetch(`/eval`, {
+            method: 'PUT',
+            body: `void (async () => {
+                var resource = await braid_text.get_resource('/${key}')
+
+                try {
+                    var {change_count} = await braid_text.put(resource, { peer: "abc", version: ["hi-2"], parents: [], patches: [{unit: "text", range: "[0:0]", content: "ABC"}], merge_type: "dt", validate_already_seen_versions: true })
+
+                    res.end('' + change_count)
+                } catch (e) {
+                    res.end(e.message)
+                }
+            })()`
+        })
+
+        return await r2.text()
+    },
+    'invalid update: different from previous update with same version'
+)
+
 runTest(
     "test loading a previously saved resource",
     async () => {
@@ -582,6 +674,45 @@ runTest(
     'xy'
 )
 
+runTest(
+    "test accept-encoding updates(dt) (with parents which are current version)",
+    async () => {
+        await dt_p
+        let key = 'test-' + Math.random().toString(36).slice(2)
+        var doc = new Doc('hi')
+        doc.ins(0, 'xy')
+
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['hi-1'],
+            parents: [],
+            body: 'xy'
+        })
+        if (!r.ok) throw 'got: ' + r.statusCode
+
+        var a = new AbortController()
+        let r2 = await braid_fetch(`/${key}`, {
+            signal: a.signal,
+            parents: ['hi-1'],
+            subscribe: true,
+            headers: {
+                'merge-type': 'dt',
+                'X-Accept-Encoding': 'updates(dt)'
+            }
+        })
+
+        return await new Promise(done => {
+            r2.subscribe(u => {
+                doc.mergeBytes(u.body)
+                done(doc.get())
+                doc.free()
+                a.abort()
+            })
+        })
+    },
+    'xy'
+)
+
 runTest(
     "test accept-encoding updates(dt)",
     async () => {