braid-text 0.2.50 → 0.2.52

package/index.js

@@ -70,8 +70,7 @@ braid_text.serve = async (req, res, options = {}) => {
     }
 
     var get_current_version = () => ascii_ify(
-        resource.doc.getRemoteVersion().map(x => x.join("-")).sort()
-            .map(x => JSON.stringify(x)).join(", "))
+        resource.version.map(x => JSON.stringify(x)).join(", "))
 
     if (req.method == "GET" || req.method == "HEAD") {
         // make sure we have the necessary version and parents
@@ -133,7 +132,17 @@ braid_text.serve = async (req, res, options = {}) => {
                 accept_encoding:
                     req.headers['x-accept-encoding'] ??
                     req.headers['accept-encoding'],
-                subscribe: x => res.sendVersion(x),
+                subscribe: x => {
+
+                    // this is a sanity/rhobustness check..
+                    // ..this digest is checked on the client..
+                    // ..it is not strictly necessary
+                    if (x.version && v_eq(x.version, resource.version)) {
+                        x["Repr-Digest"] = `sha-256=:${require('crypto').createHash('sha256').update(Buffer.from(resource.val, "utf8")).digest('base64')}:`
+                    }
+
+                    res.sendVersion(x)
+                },
                 write: (x) => res.write(x)
             }
 
@@ -233,7 +242,7 @@ braid_text.get = async (key, options) => {
     if (options.parents) validate_version_array(options.parents)
 
     let resource = (typeof key == 'string') ? await get_resource(key) : key
-    var version = resource.doc.getRemoteVersion().map((x) => x.join("-")).sort()
+    var version = resource.version
 
     if (!options.subscribe) {
         if (options.transfer_encoding === 'dt') {
@@ -390,7 +399,7 @@ braid_text.put = async (key, options) => {
         }
     }
 
-    let parents = resource.doc.getRemoteVersion().map((x) => x.join("-")).sort()
+    let parents = resource.version
     let og_parents = options_parents || parents
 
     let max_pos = resource.length_cache.get('' + og_parents) ??
@@ -526,6 +535,7 @@ braid_text.put = async (key, options) => {
 
     for (let b of bytes) resource.doc.mergeBytes(b)
     resource.val = resource.doc.get()
+    resource.version = resource.doc.getRemoteVersion().map(x => x.join("-")).sort()
 
     var post_commit_updates = []
 
@@ -533,7 +543,7 @@ braid_text.put = async (key, options) => {
         patches = get_xf_patches(resource.doc, v_before)
         if (braid_text.verbose) console.log(JSON.stringify({ patches }))
 
-        let version = resource.doc.getRemoteVersion().map((x) => x.join("-")).sort()
+        let version = resource.version
 
         for (let client of resource.simpleton_clients) {
             if (peer && client.peer === peer) {
@@ -546,7 +556,7 @@ braid_text.put = async (key, options) => {
                     // if the doc has been freed, exit early
                     if (resource.doc.__wbg_ptr === 0) return
 
-                    let version = resource.doc.getRemoteVersion().map((x) => x.join("-")).sort()
+                    let version = resource.version
                     let x = { version }
                     x.parents = client.my_last_seen_version
 
@@ -609,7 +619,7 @@ braid_text.put = async (key, options) => {
         }
     } else {
         if (resource.simpleton_clients.size) {
-            let version = resource.doc.getRemoteVersion().map((x) => x.join("-")).sort()
+            let version = resource.version
             patches = get_xf_patches(resource.doc, v_before)
             let x = { version, parents, patches }
             if (braid_text.verbose) console.log(`sending: ${JSON.stringify(x)}`)
@@ -681,6 +691,7 @@ async function get_resource(key) {
         })
 
         resource.val = resource.doc.get()
+        resource.version = resource.doc.getRemoteVersion().map(x => x.join("-")).sort()
 
         resource.length_cache = createSimpleCache(braid_text.length_cache_size)
 

package/package.json

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

package/simpleton-client.js

@@ -65,7 +65,7 @@ function simpleton_client(url, {
         signal: ac.signal
     }).then(res => {
         if (on_res) on_res(res)
-        res.subscribe(update => {
+        res.subscribe(async update => {
             // Only accept the update if its parents == our current version
             update.parents.sort()
             if (current_version.length === update.parents.length
@@ -110,6 +110,14 @@ function simpleton_client(url, {
                     } else prev_state = apply_patches(prev_state, patches)
                 }
 
+                // if the server gave us a digest,
+                // go ahead and check it against our new state..
+                if (update.extra_headers &&
+                    update.extra_headers["repr-digest"] &&
+                    update.extra_headers["repr-digest"].startsWith('sha-256=') &&
+                    update.extra_headers["repr-digest"] !== `sha-256=:${btoa(String.fromCharCode(...new Uint8Array(await crypto.subtle.digest('SHA-256', new TextEncoder().encode(prev_state)))))}:`)
+                    throw new Error('repr-digest mismatch')
+
                 if (on_state) on_state(prev_state)
             }
         }, on_error)

package/test/test.html

@@ -96,6 +96,87 @@ async function runTest(testName, testFunction, expectedResult) {
     }
 }
 
+runTest(
+    "test subscribing and verifying digests [simpleton]",
+    async () => {
+        let key = 'test-' + Math.random().toString(36).slice(2)
+
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['hi-1'],
+            parents: [],
+            body: 'xx'
+        })
+        if (!r.ok) throw 'got: ' + r.statusCode
+
+        let r2 = await braid_fetch(`/${key}`, {
+            version: ['hi-0'],
+            subscribe: true
+        })
+        var parts = []
+        var p = new Promise(async (done, fail) => {
+            r2.subscribe(update => {
+                parts.push(update.extra_headers['repr-digest'])
+                if (parts.length > 1) done()
+            }, fail)
+        })
+
+        await new Promise(done => setTimeout(done, 300))
+        let rr = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['hi-2'],
+            parents: ['hi-1'],
+            patches: [{unit: "text", range: "[1:1]", content: "Y"}]
+        })
+        if (!rr.ok) throw 'got: ' + rr.statusCode
+
+        await p
+        return JSON.stringify(parts)
+    },
+    '["sha-256=:Xd6JaIf2dUybFb/jpEGuSAbfL96UABMR4IvxEGIuC74=:","sha-256=:77cl3INcGEtczN0zK3eOgW/YWYAOm8ub73LkVcF2/rA=:"]'
+)
+
+runTest(
+    "test subscribing and verifying digests [dt]",
+    async () => {
+        let key = 'test-' + Math.random().toString(36).slice(2)
+
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['hi-1'],
+            parents: [],
+            body: 'xx'
+        })
+        if (!r.ok) throw 'got: ' + r.statusCode
+
+        let r2 = await braid_fetch(`/${key}`, {
+            version: ['hi-0'],
+            headers: { 'merge-type': 'dt' },
+            subscribe: true
+        })
+        var parts = []
+        var p = new Promise(async (done, fail) => {
+            r2.subscribe(update => {
+                parts.push(update.extra_headers['repr-digest'])
+                if (parts.length > 1) done()
+            }, fail)
+        })
+
+        await new Promise(done => setTimeout(done, 300))
+        let rr = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['hi-2'],
+            parents: ['hi-1'],
+            patches: [{unit: "text", range: "[2:2]", content: "Y"}]
+        })
+        if (!rr.ok) throw 'got: ' + rr.statusCode
+
+        await p
+        return JSON.stringify(parts)
+    },
+    '["sha-256=:Xd6JaIf2dUybFb/jpEGuSAbfL96UABMR4IvxEGIuC74=:","sha-256=:QknHazou37wCCwv3JXnCoAvXcKszP6xBTxLIiUAETgI=:"]'
+)
+
 runTest(
     "test PUTing a version that the server already has",
     async () => {