braid-text 0.0.4 → 0.0.6

package/README.md

@@ -105,7 +105,11 @@ server.on("request", (req, res) => {
     },
     generate_local_diff_update: (prev_state) => {
 
-      // Compute diff between prev_state ^ and the current textarea string...
+      // Compute diff between prev_state ^ and the current textarea string,
+      // which might look like [{
+      //   range: [5:5],
+      //   content: " World"
+      // }] to insert something after a prev_state of "Hello"
 
       // Then return the new state (as a string) and the diff (as `patches`)
       return {new_state, patches}

package/index.js

@@ -167,7 +167,13 @@ braid_text.serve = async (req, res, options = {}) => {
 }
 
 braid_text.get = async (key, options) => {
-    if (!options) return get_resource.cache?.[key]?.doc.get()
+    if (!options) {
+        let x = get_resource.cache?.[key]?.doc.get()
+        if (x !== undefined) return x
+        // if it doesn't exist on disk, don't create it in this case
+        if (!(await get_files_for_key(key)).length) return
+        return (await get_resource(key)).doc.get()
+    }
 
     let resource = (typeof key == 'string') ? await get_resource(key) : key
 
@@ -483,6 +489,15 @@ braid_text.put = async (key, options) => {
     await resource.db_delta(resource.doc.getPatchSince(v_before))
 }
 
+braid_text.list = async () => {
+    var pages = new Set()
+    for (let x of await require('fs').promises.readdir(braid_text.db_folder)) {
+        let m = x.match(/^(.*)\.\d+$/)
+        if (m) pages.add(decode_filename(m[1]))
+    }
+    return [...pages.keys()]
+}
+
 async function get_resource(key) {
     let cache = get_resource.cache || (get_resource.cache = {})
     if (cache[key]) return cache[key]
@@ -494,12 +509,9 @@ async function get_resource(key) {
     resource.doc = new Doc("server")
 
     let { change, delete_me } = braid_text.db_folder
-        ? await file_sync(
-            braid_text.db_folder,
-            encodeURIComponent(key),
+        ? await file_sync(key,
             (bytes) => resource.doc.mergeBytes(bytes),
-            () => resource.doc.toBytes()
-        )
+            () => resource.doc.toBytes())
         : { change: () => { }, delete_me: () => { } }
 
     resource.db_delta = change
@@ -515,32 +527,30 @@ async function get_resource(key) {
     return (cache[key] = resource)
 }
 
-async function file_sync(db_folder, filename_base, process_delta, get_init) {
+async function get_files_for_key(key) {
+    try {
+        let re = new RegExp("^" + encode_filename(key).replace(/[^a-zA-Z0-9]/g, "\\$&") + "\\.\\d+$")
+        return (await fs.promises.readdir(braid_text.db_folder))
+            .filter((a) => re.test(a))
+            .map((a) => `${braid_text.db_folder}/${a}`)
+    } catch (e) { return [] }    
+}
+
+async function file_sync(key, process_delta, get_init) {
     let currentNumber = 0
     let currentSize = 0
     let threshold = 0
 
     // Ensure the existence of db_folder
     try {
-        await fs.promises.access(db_folder);
+        await fs.promises.access(braid_text.db_folder);
     } catch (err) {
-        if (err.code === 'ENOENT') {
-            await fs.promises.mkdir(db_folder, { recursive: true });
-        } else {
-            throw err;
-        }
+        await fs.promises.mkdir(braid_text.db_folder, { recursive: true });
     }
 
     // Read existing files and sort by numbers.
-    async function get_sorted_files() {
-        let re = new RegExp("^" + filename_base.replace(/[^a-zA-Z0-9]/g, "\\$&") + "\\.\\d+$")
-        return (await fs.promises.readdir(db_folder))
-            .filter((a) => re.test(a))
-            .sort((a, b) => parseInt(a.match(/\d+$/)[0]) - parseInt(b.match(/\d+$/)[0]))
-            .map((a) => `${db_folder}/${a}`)
-    }
-
-    const files = await get_sorted_files()
+    const files = (await get_files_for_key(key))
+        .sort((a, b) => parseInt(a.match(/\d+$/)[0]) - parseInt(b.match(/\d+$/)[0]))
 
     // Try to process files starting from the highest number.
     let done = false
@@ -581,7 +591,7 @@ async function file_sync(db_folder, filename_base, process_delta, get_init) {
     return {
         change: async (bytes) => {
             currentSize += bytes.length + 4 // we account for the extra 4 bytes for uint32
-            const filename = `${db_folder}/${filename_base}.${currentNumber}`
+            const filename = `${braid_text.db_folder}/${encode_filename(key)}.${currentNumber}`
             if (currentSize < threshold) {
                 console.log(`appending to db..`)
 
@@ -600,7 +610,7 @@ async function file_sync(db_folder, filename_base, process_delta, get_init) {
                     const buffer = Buffer.allocUnsafe(4)
                     buffer.writeUInt32LE(init.length, 0)
 
-                    const newFilename = `${db_folder}/${filename_base}.${currentNumber}`
+                    const newFilename = `${braid_text.db_folder}/${encode_filename(key)}.${currentNumber}`
                     await fs.promises.writeFile(newFilename, buffer)
                     await fs.promises.appendFile(newFilename, init)
 
@@ -619,7 +629,7 @@ async function file_sync(db_folder, filename_base, process_delta, get_init) {
         delete_me: async () => {
             await Promise.all(
                 (
-                    await get_sorted_files()
+                    await get_files_for_key(key)
                 ).map((file) => {
                     return new Promise((resolve, reject) => {
                         fs.unlink(file, (err) => {
@@ -1260,4 +1270,30 @@ function codePoints_to_index(str, codePoints) {
     return i
 }
 
+function encode_filename(filename) {
+  // Replace all '!' with '%21'
+  let encoded = filename.replace(/!/g, '%21');
+  
+  // Encode the filename using encodeURIComponent()
+  encoded = encodeURIComponent(encoded);
+  
+  // Replace all '%2F' (for '/') with '!'
+  encoded = encoded.replace(/%2F/g, '!');
+  
+  return encoded;
+}
+
+function decode_filename(encodedFilename) {
+  // Replace all '!' with '%2F'
+  let decoded = encodedFilename.replace(/!/g, '%2F');
+  
+  // Decode the filename using decodeURIComponent()
+  decoded = decodeURIComponent(decoded);
+  
+  // Replace all '%21' with '!'
+  decoded = decoded.replace(/%21/g, '!');
+  
+  return decoded;
+}
+
 module.exports = braid_text

package/package.json

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

package/server-demo.js

@@ -27,11 +27,7 @@ var server = require("http").createServer(async (req, res) => {
     // which displays all the currently used keys
     // 
     // if (req.url === '/pages') {
-    //     var pages = new Set()
-    //     for (let x of await require('fs').promises.readdir(db_folder)) {
-    //         let m = x.match(/^(.*)\.\d+$/)
-    //         if (m) pages.add(decodeURIComponent(m[1]))
-    //     }
+    //     var pages = await braid_text.list()
     //     res.writeHead(200, {
     //         "Content-Type": "application/json",
     //         "Access-Control-Allow-Origin": "*",
@@ -39,7 +35,7 @@ var server = require("http").createServer(async (req, res) => {
     //         "Access-Control-Allow-Headers": "*",
     //         "Access-Control-Expose-Headers": "*"
     //     })
-    //     res.end(JSON.stringify([...pages.keys()]))
+    //     res.end(JSON.stringify(pages))
     //     return
     // }