@openlfcp/shared-objects 0.1.4 → 0.1.5

package/dist/index.d.ts

@@ -7,7 +7,7 @@ export declare const PACKAGE = "@openlfcp/shared-objects";
 export { type CheckedChange, checkChange, checkSaveHeader, frameChange, frameSnapshot, unframeChange, unframeSnapshot, } from "./automerge-bytes.js";
 export { CHANGE_LIMITS, type ChunkExpansion, checkChangeExpansion, checkSnapshotExpansion, MAX_DOCUMENT_DEPTH, SNAPSHOT_LIMITS_FLOOR, type SnapshotLimits, } from "./chunk-limits.js";
 export { type SharedObjectsApplyResult, type SharedObjectsBatchResult, type SharedObjectsCheckpoint, type SharedObjectsCodec, SharedObjectsDataProfile, type SharedObjectsDiagnostic, type SharedObjectsExcludeResult, type SharedObjectsSnapshotCodec, type SharedObjectsUnit, } from "./data-profile.js";
-export { type BatchReceiveResult, type BuiltReplica, type LocalChange, type ObjectChange, ObjectIdCollisionError, type ObjectStatus, type ReceiveResult, type ReplicaIntent, type ReplicaOptions, type ReplicaValidation, type ResolveFieldConflict, resolveFieldConflict, SCALAR_FIELDS, type ScalarField, type ScalarView, SharedObjectsReplica, type TaskView, } from "./replica.js";
+export { applyBatchChecked, applyChecked, type BatchReceiveResult, type BuiltReplica, isWasmTrap, type LocalChange, type ObjectChange, ObjectIdCollisionError, type ObjectStatus, type ReceiveResult, type ReplicaIntent, type ReplicaOptions, type ReplicaValidation, type ResolveFieldConflict, resolveFieldConflict, SCALAR_FIELDS, type ScalarField, type ScalarView, SharedObjectsReplica, type TaskView, } from "./replica.js";
 export { addTag, assign, cancel, clearDue, clearScheduled, complete, createTask, deleteTask, type NewTask, type ParsedTask, ProfileError, parseTask, removeTag, reopen, restoreTask, setDue, setPriority, setScheduled, setStatus, setTitle, type Task, type TaskChange, type TaskIntent, type TaskPriority, type TaskStatus, taskToJson, unassign, } from "./task.js";
 export { DIAGNOSTIC_ORDER, firstPerField, isMap, type Json, objectProblems, type ProfileDiagnostic, ProfileInvalidError, type ProfileProblem, pointerToken, type RootValidation, validateRoot, validateTransition, } from "./validate.js";
 export { deriveActorId, FRAMING_VERSION, frameProfilePayload, isLocalDate, isNamespacedValue, isPrincipalRef, isReverseDomain, isUtcTimestamp, PROFILE_ID, type PrincipalRef, parsePrincipalRef, principalRef, unframeProfilePayload, } from "./values.js";

package/dist/index.js

@@ -7,7 +7,7 @@ export const PACKAGE = "@openlfcp/shared-objects";
 export { checkChange, checkSaveHeader, frameChange, frameSnapshot, unframeChange, unframeSnapshot, } from "./automerge-bytes.js";
 export { CHANGE_LIMITS, checkChangeExpansion, checkSnapshotExpansion, MAX_DOCUMENT_DEPTH, SNAPSHOT_LIMITS_FLOOR, } from "./chunk-limits.js";
 export { SharedObjectsDataProfile, } from "./data-profile.js";
-export { ObjectIdCollisionError, resolveFieldConflict, SCALAR_FIELDS, SharedObjectsReplica, } from "./replica.js";
+export { applyBatchChecked, applyChecked, isWasmTrap, ObjectIdCollisionError, resolveFieldConflict, SCALAR_FIELDS, SharedObjectsReplica, } from "./replica.js";
 export { addTag, assign, cancel, clearDue, clearScheduled, complete, createTask, deleteTask, ProfileError, parseTask, removeTag, reopen, restoreTask, setDue, setPriority, setScheduled, setStatus, setTitle, taskToJson, unassign, } from "./task.js";
 export { DIAGNOSTIC_ORDER, firstPerField, isMap, objectProblems, ProfileInvalidError, pointerToken, validateRoot, validateTransition, } from "./validate.js";
 export { deriveActorId, FRAMING_VERSION, frameProfilePayload, isLocalDate, isNamespacedValue, isPrincipalRef, isReverseDomain, isUtcTimestamp, PROFILE_ID, parsePrincipalRef, principalRef, unframeProfilePayload, } from "./values.js";

package/dist/references.d.ts

@@ -1,7 +1,7 @@
 import * as A from "@automerge/automerge";
 import { type ParsedChange } from "./canonical.js";
 /** A §11.4 rule a change breaks. */
-export type ReferenceRule = "R1" | "R2" | "R3" | "R4" | "R5" | "R6" | "R7";
+export type ReferenceRule = "R1" | "R2" | "R3" | "R4" | "R5" | "R6" | "R7" | "R10";
 /**
  * The changes of a document as §11.4 reads them. A replica keeps it current
  * as changes are admitted and committed, or builds it again from its

package/dist/references.js

@@ -137,6 +137,11 @@ export class ReferenceHistory {
         };
         for (const [i, op] of change.ops.entries()) {
             const id = `${change.startOp + i}@${change.actor}`;
+            // R10: no operation makes a table. Automerge JS 3.5.0 cannot write a
+            // table back out and aborts applying one (differential fuzzing D1); a
+            // writer of this profile never makes one.
+            if (op.action === 6)
+                return "R10";
             // R3: the root, or an object an operation made; its key form.
             let sequence;
             if (op.obj === "_root")

package/dist/replica.d.ts

@@ -143,6 +143,12 @@ export interface BuiltReplica {
 type Doc = A.Doc<Record<string, unknown>>;
 /** §30: an object's maps and lists nest at most this many levels (the field's own map is 1). */
 export declare const MAX_VALUE_DEPTH = 64;
+/**
+ * Whether a thrown value is a wasm trap (the engine's module is dead, not
+ * the change refused): it is rethrown as it is, never turned into
+ * INVALID_AUTOMERGE_BYTES, so a crash-loop breaker sees it.
+ */
+export declare function isWasmTrap(e: unknown): boolean;
 /**
  * Applies one change that passed the receive checks. Automerge can throw
  * after changing the document in place (a change that skips a sequence

package/dist/replica.js

@@ -314,7 +314,7 @@ const actorHex = (opts) => toHex(deriveActorId(opts.resource, opts.principal));
  * the change refused): it is rethrown as it is, never turned into
  * INVALID_AUTOMERGE_BYTES, so a crash-loop breaker sees it.
  */
-function isWasmTrap(e) {
+export function isWasmTrap(e) {
     const trap = globalThis
         .WebAssembly?.RuntimeError;
     if (trap !== undefined && e instanceof trap)
@@ -330,7 +330,18 @@ function isWasmTrap(e) {
  * is: the module is dead, and only a restart recovers. Exported for tests.
  */
 export function applyChecked(doc, bytes) {
+    // Capture the document's changes BEFORE the apply: a change the engine
+    // aborts on (D1: a makeTable it cannot write back) stays in the document's
+    // graph or aborts the apply mid-way, so A.getAllChanges(doc) AFTER the
+    // error still holds the bad change and rebuilding from it re-aborts
+    // ("could not be restored"). Rebuilding from the changes it held before
+    // always gives its prior state.
+    //
+    // Do NOT "simplify" this by applying to A.clone(doc): A.clone gives the
+    // clone a new actor id, which breaks local writes (§8) and convergence.
     const before = [...A.getHeads(doc)].sort().join();
+    const actor = A.getActorId(doc);
+    const good = A.getAllChanges(doc);
     try {
         return { next: A.applyChanges(doc, [bytes])[0] };
     }
@@ -338,17 +349,21 @@ export function applyChecked(doc, bytes) {
         if (isWasmTrap(e))
             throw e;
         const error = e instanceof Error ? e : new Error(String(e));
-        let restored;
-        try {
-            [restored] = A.applyChanges(A.init({ actor: A.getActorId(doc) }), A.getAllChanges(doc));
-        }
-        catch (r) {
-            throw new Error(`the replica could not be restored after an Automerge error: ${String(r)}`);
-        }
-        if ([...A.getHeads(restored)].sort().join() !== before)
-            throw new Error("the replica could not be restored after an Automerge error: heads differ");
-        return { restored, error };
+        return { restored: restoreFrom(good, actor, before), error };
+    }
+}
+/** Rebuilds a document from the changes it held before an aborted apply (never from the aborted one). */
+function restoreFrom(good, actor, before) {
+    let restored;
+    try {
+        [restored] = A.applyChanges(A.init({ actor }), [...good]);
+    }
+    catch (r) {
+        throw new Error(`the replica could not be restored after an Automerge error: ${String(r)}`);
     }
+    if ([...A.getHeads(restored)].sort().join() !== before)
+        throw new Error("the replica could not be restored after an Automerge error: heads differ");
+    return restored;
 }
 /**
  * applyChecked for a batch of admitted changes, in one engine call. On any
@@ -357,7 +372,10 @@ export function applyChecked(doc, bytes) {
  * heads it had. Exported for tests.
  */
 export function applyBatchChecked(doc, batch) {
-    const heads = A.getHeads(doc);
+    // See applyChecked: capture the changes before the apply, restore from them.
+    const before = [...A.getHeads(doc)].sort().join();
+    const actor = A.getActorId(doc);
+    const good = A.getAllChanges(doc);
     try {
         return {
             next: A.applyChanges(doc, batch.map((c) => c.bytes))[0],
@@ -367,22 +385,8 @@ export function applyBatchChecked(doc, batch) {
         if (isWasmTrap(e))
             throw e;
         const error = e instanceof Error ? e : new Error(String(e));
-        return { restored: restoreWithout(doc, batch, heads), error };
-    }
-}
-function restoreWithout(doc, batch, heads) {
-    const out = new Set(batch.map((c) => c.hash));
-    const kept = A.getAllChanges(doc).filter((c) => !out.has(A.decodeChange(c).hash));
-    let restored;
-    try {
-        [restored] = A.applyChanges(A.init({ actor: A.getActorId(doc) }), kept);
+        return { restored: restoreFrom(good, actor, before), error };
     }
-    catch (r) {
-        throw new Error(`the replica could not be restored after an Automerge error: ${String(r)}`);
-    }
-    if ([...A.getHeads(restored)].sort().join() !== [...heads].sort().join())
-        throw new Error("the replica could not be restored after an Automerge error: heads differ");
-    return restored;
 }
 function loadFailure(e, what) {
     if (e instanceof LfcpError)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openlfcp/shared-objects",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "SHARED-OBJECTS-PROFILE-01 (org.openlfcp.shared-objects.v1) implementation.",
   "keywords": [
     "openlfcp",
@@ -45,8 +45,8 @@
   "dependencies": {
     "@automerge/automerge": "3.5.0",
     "fflate": "0.8.3",
-    "@openlfcp/crypto": "^0.1.4",
-    "@openlfcp/core": "^0.1.4"
+    "@openlfcp/core": "^0.1.5",
+    "@openlfcp/crypto": "^0.1.5"
   },
   "devDependencies": {
     "fast-check": "4.10.2"