braid-blob 0.0.17 → 0.0.18

package/index.js

@@ -1,4 +1,4 @@
-var {http_server: braidify, free_cors} = require('braid-http'),
+var {http_server: braidify} = require('braid-http'),
     {url_file_db} = require('url-file-db'),
     fs = require('fs'),
     path = require('path')
@@ -10,7 +10,8 @@ function create_braid_blob() {
         cache: {},
         key_to_subs: {},
         peer: null, // we'll try to load this from a file, if not set by the user
-        db: null // url-file-db instance
+        db: null, // url-file-db instance for blob storage
+        meta_db: null // url-file-db instance for meta storage
     }
 
     braid_blob.init = async () => {
@@ -27,10 +28,11 @@ function create_braid_blob() {
                 await braid_blob.put(key, body, { skip_write: true })
             })
 
-            // Create meta folder
-            await fs.promises.mkdir(braid_blob.meta_folder, { recursive: true })
+            // Create url-file-db instance for meta storage (in a subfolder)
+            // This will create both meta_folder and the db subfolder with recursive: true
+            braid_blob.meta_db = await url_file_db.create(`${braid_blob.meta_folder}/db`)
 
-            // establish a peer id
+            // establish a peer id (stored at root of meta_folder, sibling to db subfolder)
             if (!braid_blob.peer)
                 try {
                     braid_blob.peer = await fs.promises.readFile(`${braid_blob.meta_folder}/peer.txt`, 'utf8')
@@ -44,12 +46,11 @@ function create_braid_blob() {
     braid_blob.put = async (key, body, options = {}) => {
         await braid_blob.init()
 
-        // Read the meta file
-        const metaname = `${braid_blob.meta_folder}/${encode_filename(key)}`
+        // Read the meta data from meta_db
         var meta = {}
-        try {
-            meta = JSON.parse(await fs.promises.readFile(metaname, 'utf8'))
-        } catch (e) {}
+        var meta_content = await braid_blob.meta_db.read(key)
+        if (meta_content)
+            meta = JSON.parse(meta_content.toString('utf8'))
 
         var their_e =
             !options.version ?
@@ -69,11 +70,11 @@ function create_braid_blob() {
             if (!options.skip_write)
                 await braid_blob.db.write(key, body)
 
-            // Write the meta file
+            // Write the meta data
             if (options.content_type)
                 meta.content_type = options.content_type
 
-            await fs.promises.writeFile(metaname, JSON.stringify(meta))
+            await braid_blob.meta_db.write(key, JSON.stringify(meta))
 
             // Notify all subscriptions of the update
             // (except the peer which made the PUT request itself)
@@ -93,12 +94,11 @@ function create_braid_blob() {
     braid_blob.get = async (key, options = {}) => {
         await braid_blob.init()
 
-        // Read the meta file
-        const metaname = `${braid_blob.meta_folder}/${encode_filename(key)}`
+        // Read the meta data from meta_db
         var meta = {}
-        try {
-            meta = JSON.parse(await fs.promises.readFile(metaname, 'utf8'))
-        } catch (e) {}
+        var meta_content = await braid_blob.meta_db.read(key)
+        if (meta_content)
+            meta = JSON.parse(meta_content.toString('utf8'))
         if (meta.event == null) return null
 
         var result = {
@@ -171,13 +171,11 @@ function create_braid_blob() {
         var body = req.method === 'PUT' && await slurp(req)
 
         await within_fiber(options.key, async () => {
-            const metaname = `${braid_blob.meta_folder}/${encode_filename(options.key)}`
-
-            // Read the meta file
+            // Read the meta data from meta_db
             var meta = {}
-            try {
-                meta = JSON.parse(await fs.promises.readFile(metaname, 'utf8'))
-            } catch (e) {}
+            var meta_content = await braid_blob.meta_db.read(options.key)
+            if (meta_content)
+                meta = JSON.parse(meta_content.toString('utf8'))
 
             if (req.method === 'GET') {
                 if (!res.hasHeader("editable")) res.setHeader("Editable", "true")
@@ -234,12 +232,8 @@ function create_braid_blob() {
                 res.setHeader("Version", version_to_header(meta.event != null ? [meta.event] : []))
                 res.end('')
             } else if (req.method === 'DELETE') {
-                try {
-                    await braid_blob.db.delete(options.key)
-                } catch (e) {}
-                try {
-                    await fs.promises.unlink(metaname)
-                } catch (e) {}
+                await braid_blob.db.delete(options.key)
+                await braid_blob.meta_db.delete(options.key)
                 res.statusCode = 204 // No Content
                 res.end('')
             }
@@ -275,16 +269,6 @@ function create_braid_blob() {
         return ascii_ify(version.map(v => JSON.stringify(v)).join(', '))
     }
 
-    function encode_filename(filename) {
-        // Swap all "!" and "/" characters
-        let swapped = filename.replace(/[!/]/g, (match) => (match === "!" ? "/" : "!"))
-
-        // Encode the filename using encodeURIComponent()
-        let encoded = encodeURIComponent(swapped)
-
-        return encoded
-    }
-
     function within_fiber(id, func) {
         if (!within_fiber.chains) within_fiber.chains = {}
         var prev = within_fiber.chains[id] || Promise.resolve()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braid-blob",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "Library for collaborative blobs over http using braid.",
   "author": "Braid Working Group",
   "repository": "braid-org/braid-blob",
@@ -11,6 +11,6 @@
   },
   "dependencies": {
     "braid-http": "~1.3.82",
-    "url-file-db": "~0.0.7"
+    "url-file-db": "~0.0.8"
   }
 }

package/server-demo.js

@@ -8,6 +8,8 @@ var braid_blob = require(`${__dirname}/index.js`)
 // braid_blob.db_folder = './custom_files_folder'
 // braid_blob.meta_folder = './custom_meta_folder'
 
+braid_blob.init()
+
 var server = require("http").createServer(async (req, res) => {
     console.log(`${req.method} ${req.url}`)
 
@@ -19,5 +21,5 @@ server.listen(port, () => {
     console.log(`files stored in: ${braid_blob.db_folder}`)
 })
 
-// curl -X PUT --data-binary @blob.png http://localhost:8888/blob.png
+// curl -X PUT -H "Content-Type: image/png" --data-binary @blob.png http://localhost:8888/blob.png
 // curl http://localhost:8888/blob.png --output new-blob.png

package/test/tests.js

@@ -688,6 +688,43 @@ runTest(
     'false'
 )
 
+runTest(
+    "test that meta filenames distinguish between 'a' and 'A' on case-insensitive filesystems",
+    async () => {
+        var suffix = Math.random().toString(36).slice(2)
+        var key1 = 'test-' + suffix + '-a'
+        var key2 = 'test-' + suffix + '-A'
+
+        // PUT to lowercase key with version 100
+        var r = await braid_fetch(`/${key1}`, {
+            method: 'PUT',
+            version: ['100'],
+            body: 'lowercase content'
+        })
+        if (!r.ok) throw 'PUT to lowercase key failed: ' + r.status
+
+        // PUT to uppercase key with version 200
+        var r = await braid_fetch(`/${key2}`, {
+            method: 'PUT',
+            version: ['200'],
+            body: 'uppercase content'
+        })
+        if (!r.ok) throw 'PUT to uppercase key failed: ' + r.status
+
+        // GET both and verify they have different versions (stored in meta files)
+        var r1 = await braid_fetch(`/${key1}`)
+        if (!r1.ok) throw 'GET lowercase key failed: ' + r1.status
+        var version1 = r1.headers.get('version')
+
+        var r2 = await braid_fetch(`/${key2}`)
+        if (!r2.ok) throw 'GET uppercase key failed: ' + r2.status
+        var version2 = r2.headers.get('version')
+
+        return version1 + '|' + version2
+    },
+    '"100"|"200"'
+)
+
 }
 
 // Export for Node.js (CommonJS)