braid-text 0.2.30 → 0.2.31

package/README.md

@@ -105,7 +105,11 @@ http_server.on("request", (req, res) => {
     apply_remote_update: ({ state, patches }) => {
 
       // Apply the incoming state or patches to local text here.
-
+      //
+      // Example data:
+      //   state: "Hello World"                               // The new text
+      //   patches: [{ range: [5, 5], content: " World" }]    // Patches that create the new text
+      //
       // Then return the new state of textarea as a string:
       return new_state
     },
@@ -114,8 +118,8 @@ http_server.on("request", (req, res) => {
       // Compute diff between prev_state ^ and the current textarea string, such as:
       //
       //   var patches = [{
-      //     range: [5:5],
-      //     content: " World"
+      //     range: [5, 5],      // The range from position 5 to position 5
+      //     content: " World"   // is replaced with the string " World"
       //   }]
       //
       // ...to insert something after a prev_state of "Hello".

package/index.js

@@ -176,31 +176,11 @@ braid_text.serve = async (req, res, options = {}) => {
         } catch (e) {
             console.log(`${req.method} ERROR: ${e.stack}`)
             if (e.message?.startsWith(MISSING_PARENT_VERSION)) {
-                // we couldn't apply the version, because we're missing its parents,
-                // we want to send a 4XX error, so the client will resend this request later,
+                // we couldn't apply the version, because we're missing its parents;
+                // we want to send some kind of error that gives the client faith,
+                // that resending this request later may work,
                 // hopefully after we've received the necessary parents.
-
-                // here are some 4XX error code options..
-                //
-                // - 425 Too Early
-                //     - pros: our message is too early
-                //     - cons: associated with some "Early-Data" http thing, which we're not using
-                // - 400 Bad Request
-                //     - pros: pretty generic
-                //     - cons: implies client shouldn't resend as-is
-                // - 409 Conflict
-                //     - pros: doesn't imply modifications needed
-                //     - cons: the message is not conflicting with anything
-                // - 412 Precondition Failed
-                //     - pros: kindof true.. the precondition of having another version has failed..
-                //     - cons: not strictly true, as this code is associated with http's If-Unmodified-Since stuff
-                // - 422 Unprocessable Content
-                //     - pros: it's true
-                //     - cons: implies client shouldn't resend as-is (at least, it says that here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422)
-                // - 428 Precondition Required
-                //     - pros: the name sounds right
-                //     - cons: typically implies that the request was missing an http conditional field like If-Match. that is to say, it implies that the request is missing a precondition, not that the server is missing a precondition
-                return done_my_turn(400, e.message, 'Missing Parents', { 'Retry-After': '1' })
+                return done_my_turn(309, e.message, 'Missing Parents', { 'Retry-After': '1' })
             } else {
                 return done_my_turn(500, "The server failed to apply this version. The error generated was: " + e)
             }

package/package.json

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

package/test/test.html

@@ -61,6 +61,21 @@ async function runTest(testName, testFunction, expectedResult) {
     }
 }
 
+runTest(
+    "test error code when missing parents",
+    async () => {
+        let key = 'test-' + Math.random().toString(36).slice(2)
+        let r = await braid_fetch(`/${key}`, {
+            method: 'PUT',
+            version: ['hi-1'],
+            parents: ['missing-0'],
+            body: 'xx'
+        })
+        return r.status + ' ' + r.ok
+    },
+    '309 false'
+)
+
 runTest(
     "test subscribing starting at a version using simpleton",
     async () => {