braid-text 0.2.71 → 0.2.73

package/AI-README.md

@@ -0,0 +1,81 @@
+# AI-README for braid-text
+
+This document provides AI assistants with key information about the braid-text project, including development procedures and architecture notes.
+
+## Release Procedure
+
+Follow these steps to create a new release:
+
+1. **Version Bump**
+   - Update the version in `package.json` (use smallest version bump: patch level)
+   - Current version format: `0.2.x`
+
+2. **Run Tests**
+   - Run `node test/test.js` - should show all 74 tests passing
+   - Run `node test/fuzz-test.js` - should run without errors (best_n = Infinity @ NaN indicates success)
+   - Both tests must pass before proceeding
+
+3. **Commit Changes**
+   - Use commit message format: `VERSION - description`
+   - Example: `0.2.73 - adds automatic test cleanup`
+   - Keep description concise and descriptive
+
+4. **Push to Remote**
+   - Run `git push` to push to the remote repository
+
+5. **Publish to npm**
+   - Run `npm publish` to publish the new version
+
+## Test Suite
+
+### test/test.js
+- Main test suite with 74 tests
+- Tests Braid protocol, version control, syncing, and collaboration features
+- Automatically cleans up `test_db_folder` after completion
+- Run with: `node test/test.js`
+- Filter tests with: `node test/test.js --filter="sync"`
+
+### test/fuzz-test.js
+- Fuzz testing suite that generates random edits and verifies correctness
+- Tests diamond-types integration and merge operations
+- Runs 10,000 iterations by default
+- Success indicated by `best_n = Infinity @ NaN` (no failures found)
+- Run with: `node test/fuzz-test.js`
+
+## Project Structure
+
+- **index.js** - Main library file implementing Braid protocol for collaborative text
+- **package.json** - Package configuration and dependencies
+- **test/** - Test suite directory
+  - **test.js** - Main test runner (supports both console and browser modes)
+  - **tests.js** - Test definitions (shared between console and browser)
+  - **fuzz-test.js** - Fuzz testing suite
+  - **test.html** - Browser test interface
+
+## Key Dependencies
+
+- **@braid.org/diamond-types-node** - CRDT implementation for conflict-free text editing
+- **braid-http** - Braid protocol HTTP implementation
+- **url-file-db** - File-based database for persistent storage
+
+## Architecture Notes
+
+- Implements the Braid protocol for synchronizing collaborative text over HTTP
+- Uses diamond-types CRDT for conflict-free merging
+- Supports both simpleton and dt (diamond-types) merge strategies
+- Provides version control with parents tracking and version history
+- File-based persistence with case-insensitive filesystem support
+
+## Common Operations
+
+### Running Tests Locally
+```bash
+node test/test.js              # Run all tests
+node test/test.js --filter="sync"  # Run tests matching "sync"
+node test/fuzz-test.js         # Run fuzz tests
+```
+
+### Test Cleanup
+The test suite automatically cleans up temporary files and databases. If manual cleanup is needed:
+- Test database is created at `test/test_db_folder` during tests
+- Automatically removed after test completion

package/index.js

@@ -304,6 +304,17 @@ function create_braid_text() {
             if (!req.subscribe) {
                 res.setHeader("Accept-Subscribe", "true")
 
+                // Set headers based on request type
+                // Current-Version: always for dt encoding, or when version/parents present
+                if (req.headers['accept-transfer-encoding'] === 'dt' || req.version || req.parents) {
+                    res.setHeader("Current-Version", get_current_version())
+                }
+
+                // Merge-Type: only when version/parents present
+                if (req.version || req.parents) {
+                    res.setHeader("Merge-Type", merge_type)
+                }
+
                 // special case for HEAD asking for version/parents,
                 // to be faster by not reconstructing body
                 if (req.method === "HEAD" && (req.version || req.parents))
@@ -321,13 +332,10 @@ function create_braid_text() {
                 }
 
                 if (req.headers['accept-transfer-encoding'] === 'dt') {
-                    res.setHeader("Current-Version", get_current_version())
                     res.setHeader("X-Transfer-Encoding", 'dt')
                     res.setHeader("Content-Length", x.body.length)
                     return my_end(209, req.method === "HEAD" ? null : x.body, 'Multiresponse')
                 } else {
-                    if (req.version || req.parents)
-                        res.setHeader("Current-Version", get_current_version())
                     res.setHeader("Version", ascii_ify(x.version.map((x) => JSON.stringify(x)).join(", ")))
                     var buffer = Buffer.from(x.body, "utf8")
                     res.setHeader("Repr-Digest", get_digest(buffer))
@@ -2258,7 +2266,13 @@ function create_braid_text() {
             if (!key_to_filename.has(key)) {
                 key_to_filename.set(key, encoded)
                 ifilenames.add(encoded.toLowerCase())
-            } else throw new Error('filename conflict detected')
+            } else {
+                // Already have this key mapped - verify it maps to the same encoding
+                if (key_to_filename.get(key) !== encoded) {
+                    throw new Error(`filename conflict detected: key "${key}" maps to both "${key_to_filename.get(key)}" and "${encoded}"`)
+                }
+                // Otherwise it's just a re-initialization, skip it
+            }
         }
     }
 

package/package.json

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

package/test/tests.js

@@ -2146,6 +2146,59 @@ runTest(
     'ok'
 )
 
+runTest(
+    "test Merge-Type header per Braid spec",
+    async () => {
+        let key = 'test-merge-type-' + Math.random().toString(36).slice(2)
+
+        // First PUT some content (15 characters, so version is alice-14)
+        await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['alice-14'],
+            parents: [],
+            body: 'initial content'
+        })
+
+        // Test 1: GET with Version header should include Merge-Type
+        let r1 = await braid_fetch(`/${key}`, {
+            version: ['alice-14']
+        })
+        if (!r1.headers.get('merge-type')) return 'Missing Merge-Type with Version header'
+
+        // Test 2: GET with empty Version header should still include Merge-Type
+        let r2 = await braid_fetch(`/${key}`, {
+            headers: {
+                'Version': ''
+            }
+        })
+        if (!r2.headers.get('merge-type')) return 'Missing Merge-Type with empty Version header'
+
+        // Test 3: GET with Parents header should include Merge-Type
+        let r3 = await braid_fetch(`/${key}`, {
+            parents: []
+        })
+        if (!r3.headers.get('merge-type')) return 'Missing Merge-Type with Parents header'
+
+        // Test 4: Regular GET without Version/Parents should NOT include Merge-Type
+        let r4 = await braid_fetch(`/${key}`)
+        if (r4.headers.get('merge-type')) return 'Unexpected Merge-Type without Version/Parents'
+
+        // Test 5: GET with Subscribe should include Merge-Type
+        let a = new AbortController()
+        let r5 = await braid_fetch(`/${key}`, {
+            signal: a.signal,
+            subscribe: true
+        })
+        if (!r5.headers.get('merge-type')) return 'Missing Merge-Type with Subscribe'
+
+        // Close subscription
+        a.abort()
+
+        return 'ok'
+    },
+    'ok'
+)
+
 runTest(
     "test filename conflict detection (different encodings of same key)",
     async () => {