cojson 0.1.4 → 0.1.6

package/src/contentTypes/coList.ts

@@ -1,19 +1,262 @@
-import { JsonObject, JsonValue } from '../jsonValue.js';
-import { CoID } from '../contentType.js';
-import { CoValue } from '../coValue.js';
+import { JsonObject, JsonValue } from "../jsonValue.js";
+import { CoID } from "../contentType.js";
+import { CoValue, accountOrAgentIDfromSessionID } from "../coValue.js";
+import { SessionID, TransactionID } from "../ids.js";
+import { AccountID } from "../index.js";
+import { isAccountID } from "../account.js";
 
-export class CoList<T extends JsonValue, Meta extends JsonObject | null = null> {
+type OpID = TransactionID & { changeIdx: number };
+
+type InsertionOpPayload<T extends JsonValue> =
+    | {
+          op: "pre";
+          value: T;
+          before: OpID | "end";
+      }
+    | {
+          op: "app";
+          value: T;
+          after: OpID | "start";
+      };
+
+type DeletionOpPayload = {
+    op: "del";
+    insertion: OpID;
+};
+
+export type ListOpPayload<T extends JsonValue> =
+    | InsertionOpPayload<T>
+    | DeletionOpPayload;
+
+type InsertionEntry<T extends JsonValue> = {
+    madeAt: number;
+    predecessors: OpID[];
+    successors: OpID[];
+} & InsertionOpPayload<T>;
+
+type DeletionEntry = {
+    madeAt: number;
+    deletionID: OpID;
+} & DeletionOpPayload;
+
+export class CoList<
+    T extends JsonValue,
+    Meta extends JsonObject | null = null
+> {
     id: CoID<CoList<T, Meta>>;
     type = "colist" as const;
     coValue: CoValue;
+    afterStart: OpID[];
+    beforeEnd: OpID[];
+    insertions: {
+        [sessionID: SessionID]: {
+            [txIdx: number]: {
+                [changeIdx: number]: InsertionEntry<T>;
+            };
+        };
+    };
+    deletionsByInsertion: {
+        [deletedSessionID: SessionID]: {
+            [deletedTxIdx: number]: {
+                [deletedChangeIdx: number]: DeletionEntry[];
+            };
+        };
+    };
 
     constructor(coValue: CoValue) {
         this.id = coValue.id as CoID<CoList<T, Meta>>;
         this.coValue = coValue;
+        this.afterStart = [];
+        this.beforeEnd = [];
+        this.insertions = {};
+        this.deletionsByInsertion = {};
+
+        this.fillOpsFromCoValue();
+    }
+
+
+    get meta(): Meta {
+        return this.coValue.header.meta as Meta;
+    }
+
+    protected fillOpsFromCoValue() {
+        this.insertions = {};
+        this.deletionsByInsertion = {};
+        this.afterStart = [];
+        this.beforeEnd = [];
+
+        for (const {
+            txID,
+            changes,
+            madeAt,
+        } of this.coValue.getValidSortedTransactions()) {
+            for (const [changeIdx, changeUntyped] of changes.entries()) {
+                const change = changeUntyped as ListOpPayload<T>;
+
+                if (change.op === "pre" || change.op === "app") {
+                    let sessionEntry = this.insertions[txID.sessionID];
+                    if (!sessionEntry) {
+                        sessionEntry = {};
+                        this.insertions[txID.sessionID] = sessionEntry;
+                    }
+                    let txEntry = sessionEntry[txID.txIndex];
+                    if (!txEntry) {
+                        txEntry = {};
+                        sessionEntry[txID.txIndex] = txEntry;
+                    }
+                    txEntry[changeIdx] = {
+                        madeAt,
+                        predecessors: [],
+                        successors: [],
+                        ...change,
+                    };
+                    if (change.op === "pre") {
+                        if (change.before === "end") {
+                            this.beforeEnd.push({
+                                ...txID,
+                                changeIdx,
+                            });
+                        } else {
+                            const beforeEntry =
+                                this.insertions[change.before.sessionID]?.[
+                                    change.before.txIndex
+                                ]?.[change.before.changeIdx];
+                            if (!beforeEntry) {
+                                throw new Error(
+                                    "Not yet implemented: insertion before missing op " +
+                                        change.before
+                                );
+                            }
+                            beforeEntry.predecessors.splice(0, 0, {
+                                ...txID,
+                                changeIdx,
+                            });
+                        }
+                    } else {
+                        if (change.after === "start") {
+                            this.afterStart.push({
+                                ...txID,
+                                changeIdx,
+                            });
+                        } else {
+                            const afterEntry =
+                                this.insertions[change.after.sessionID]?.[
+                                    change.after.txIndex
+                                ]?.[change.after.changeIdx];
+                            if (!afterEntry) {
+                                throw new Error(
+                                    "Not yet implemented: insertion after missing op " +
+                                        change.after
+                                );
+                            }
+                            afterEntry.successors.push({
+                                ...txID,
+                                changeIdx,
+                            });
+                        }
+                    }
+                } else if (change.op === "del") {
+                    let sessionEntry =
+                        this.deletionsByInsertion[change.insertion.sessionID];
+                    if (!sessionEntry) {
+                        sessionEntry = {};
+                        this.deletionsByInsertion[change.insertion.sessionID] =
+                            sessionEntry;
+                    }
+                    let txEntry = sessionEntry[change.insertion.txIndex];
+                    if (!txEntry) {
+                        txEntry = {};
+                        sessionEntry[change.insertion.txIndex] = txEntry;
+                    }
+                    let changeEntry = txEntry[change.insertion.changeIdx];
+                    if (!changeEntry) {
+                        changeEntry = [];
+                        txEntry[change.insertion.changeIdx] = changeEntry;
+                    }
+                    changeEntry.push({
+                        madeAt,
+                        deletionID: {
+                            ...txID,
+                            changeIdx,
+                        },
+                        ...change,
+                    });
+                } else {
+                    throw new Error(
+                        "Unknown list operation " +
+                            (change as { op: unknown }).op
+                    );
+                }
+            }
+        }
+    }
+
+    entries(): { value: T; madeAt: number; opID: OpID }[] {
+        const arr: { value: T; madeAt: number; opID: OpID }[] = [];
+        for (const opID of this.afterStart) {
+            this.fillArrayFromOpID(opID, arr);
+        }
+        for (const opID of this.beforeEnd) {
+            this.fillArrayFromOpID(opID, arr);
+        }
+        return arr;
+    }
+
+    private fillArrayFromOpID(
+        opID: OpID,
+        arr: { value: T; madeAt: number; opID: OpID }[]
+    ) {
+        const entry =
+            this.insertions[opID.sessionID]?.[opID.txIndex]?.[opID.changeIdx];
+        if (!entry) {
+            throw new Error("Missing op " + opID);
+        }
+        for (const predecessor of entry.predecessors) {
+            this.fillArrayFromOpID(predecessor, arr);
+        }
+        const deleted =
+            (this.deletionsByInsertion[opID.sessionID]?.[opID.txIndex]?.[
+                opID.changeIdx
+            ]?.length || 0) > 0;
+        if (!deleted) {
+            arr.push({
+                value: entry.value,
+                madeAt: entry.madeAt,
+                opID,
+            });
+        }
+        for (const successor of entry.successors) {
+            this.fillArrayFromOpID(successor, arr);
+        }
     }
 
-    toJSON(): JsonObject {
-        throw new Error("Method not implemented.");
+    getLastEditor(idx: number): AccountID | undefined {
+        const entry = this.entries()[idx];
+        if (!entry) {
+            return undefined;
+        }
+        const accountID = accountOrAgentIDfromSessionID(entry.opID.sessionID);
+        if (isAccountID(accountID)) {
+            return accountID;
+        } else {
+            return undefined;
+        }
+    }
+
+    toJSON(): T[] {
+        return this.asArray();
+    }
+
+    asArray(): T[] {
+        return this.entries().map((entry) => entry.value);
+    }
+
+    edit(
+        changer: (editable: WriteableCoList<T, Meta>) => void
+    ): CoList<T, Meta> {
+        const editable = new WriteableCoList<T, Meta>(this.coValue);
+        changer(editable);
+        return new CoList(this.coValue);
     }
 
     subscribe(listener: (coMap: CoList<T, Meta>) => void): () => void {
@@ -22,3 +265,106 @@ export class CoList<T extends JsonValue, Meta extends JsonObject | null = null>
         });
     }
 }
+
+export class WriteableCoList<
+    T extends JsonValue,
+    Meta extends JsonObject | null = null
+> extends CoList<T, Meta> {
+    append(
+        after: number,
+        value: T,
+        privacy: "private" | "trusting" = "private"
+    ): void {
+        const entries = this.entries();
+        let opIDBefore;
+        if (entries.length > 0) {
+            const entryBefore = entries[after];
+            if (!entryBefore) {
+                throw new Error("Invalid index " + after);
+            }
+            opIDBefore = entryBefore.opID;
+        } else {
+            if (after !== 0) {
+                throw new Error("Invalid index " + after);
+            }
+            opIDBefore = "start";
+        }
+        this.coValue.makeTransaction(
+            [
+                {
+                    op: "app",
+                    value,
+                    after: opIDBefore,
+                },
+            ],
+            privacy
+        );
+
+        this.fillOpsFromCoValue();
+    }
+
+    push(value: T, privacy: "private" | "trusting" = "private"): void {
+        // TODO: optimize
+        const entries = this.entries();
+        this.append(entries.length > 0 ? entries.length - 1 : 0, value, privacy);
+    }
+
+    prepend(
+        before: number,
+        value: T,
+        privacy: "private" | "trusting" = "private"
+    ): void {
+        const entries = this.entries();
+        let opIDAfter;
+        if (entries.length > 0) {
+            const entryAfter = entries[before];
+            if (entryAfter) {
+                opIDAfter = entryAfter.opID;
+            } else {
+                if (before !== entries.length) {
+                    throw new Error("Invalid index " + before);
+                }
+                opIDAfter = "end";
+            }
+        } else {
+            if (before !== 0) {
+                throw new Error("Invalid index " + before);
+            }
+            opIDAfter = "end";
+        }
+        this.coValue.makeTransaction(
+            [
+                {
+                    op: "pre",
+                    value,
+                    before: opIDAfter,
+                },
+            ],
+            privacy
+        );
+
+        this.fillOpsFromCoValue();
+    }
+
+    delete(
+        at: number,
+        privacy: "private" | "trusting" = "private"
+    ): void {
+        const entries = this.entries();
+        const entry = entries[at];
+        if (!entry) {
+            throw new Error("Invalid index " + at);
+        }
+        this.coValue.makeTransaction(
+            [
+                {
+                    op: "del",
+                    insertion: entry.opID,
+                },
+            ],
+            privacy
+        );
+
+        this.fillOpsFromCoValue();
+    }
+}

package/src/contentTypes/coMap.ts

@@ -46,6 +46,10 @@ export class CoMap<
         this.fillOpsFromCoValue();
     }
 
+    get meta(): Meta {
+        return this.coValue.header.meta as Meta;
+    }
+
     protected fillOpsFromCoValue() {
         this.ops = {};
 

package/src/group.ts

@@ -24,6 +24,7 @@ import {
 } from "./account.js";
 import { Role } from "./permissions.js";
 import { base58 } from "@scure/base";
+import { CoList } from "./contentTypes/coList.js";
 
 export type GroupContent = {
     profile: CoID<Profile> | null;
@@ -186,10 +187,9 @@ export class Group {
         this.rotateReadKey();
     }
 
-    createMap<
-        M extends { [key: string]: JsonValue },
-        Meta extends JsonObject | null = null
-    >(meta?: Meta): CoMap<M, Meta> {
+    createMap<M extends CoMap<{ [key: string]: JsonValue }, JsonObject | null>>(
+        meta?: M["meta"]
+    ): M {
         return this.node
             .createCoValue({
                 type: "comap",
@@ -200,7 +200,23 @@ export class Group {
                 meta: meta || null,
                 ...createdNowUnique(),
             })
-            .getCurrentContent() as CoMap<M, Meta>;
+            .getCurrentContent() as M;
+    }
+
+    createList<L extends CoList<JsonValue, JsonObject | null>>(
+        meta?: L["meta"]
+    ): L {
+        return this.node
+            .createCoValue({
+                type: "colist",
+                ruleset: {
+                    type: "ownedByGroup",
+                    group: this.groupMap.id,
+                },
+                meta: meta || null,
+                ...createdNowUnique(),
+            })
+            .getCurrentContent() as L;
     }
 
     testWithDifferentAccount(
@@ -230,4 +246,4 @@ export function secretSeedFromInviteSecret(inviteSecret: InviteSecret) {
     }
 
     return base58.decode(inviteSecret.slice("inviteSecret_z".length));
-}
+}

package/src/index.ts

@@ -25,6 +25,7 @@ import type {
     AccountID,
     AccountContent,
     ProfileContent,
+    ProfileMeta,
     Profile,
 } from "./account.js";
 import type { InviteSecret } from "./group.js";
@@ -70,6 +71,7 @@ export type {
     AccountContent,
     Profile,
     ProfileContent,
+    ProfileMeta,
     InviteSecret
 };
 

package/src/node.ts

@@ -31,8 +31,7 @@ import {
     AccountID,
     Profile,
     AccountContent,
-    ProfileContent,
-    ProfileMeta,
+    AccountMap,
 } from "./account.js";
 import { CoMap } from "./index.js";
 
@@ -139,7 +138,7 @@ export class LocalNode {
     }
 
     async loadProfile(id: AccountID): Promise<Profile> {
-        const account = await this.load<CoMap<AccountContent>>(id);
+        const account = await this.load<AccountMap>(id);
         const profileID = account.get("profile");
 
         if (!profileID) {
@@ -307,7 +306,7 @@ export class LocalNode {
             account.node
         );
 
-        const profile = accountAsGroup.createMap<ProfileContent, ProfileMeta>({
+        const profile = accountAsGroup.createMap<Profile>({
             type: "profile",
         });
 

package/src/streamUtils.ts

@@ -1,12 +1,17 @@
-import { ReadableStream, TransformStream, WritableStream } from "isomorphic-streams";
+import {
+    ReadableStream,
+    TransformStream,
+    WritableStream,
+} from "isomorphic-streams";
 import { Peer, PeerID, SyncMessage } from "./sync.js";
 
-
 export function connectedPeers(
     peer1id: PeerID,
     peer2id: PeerID,
     {
-        trace = false, peer1role = "peer", peer2role = "peer",
+        trace = false,
+        peer1role = "peer",
+        peer2role = "peer",
     }: {
         trace?: boolean;
         peer1role?: Peer["role"];
@@ -24,9 +29,13 @@ export function connectedPeers(
             new TransformStream({
                 transform(
                     chunk: SyncMessage,
-                    controller: { enqueue: (msg: SyncMessage) => void; }
+                    controller: { enqueue: (msg: SyncMessage) => void }
                 ) {
-                    trace && console.debug(`${peer2id} -> ${peer1id}`, JSON.stringify(chunk, null, 2));
+                    trace &&
+                        console.debug(
+                            `${peer2id} -> ${peer1id}`,
+                            JSON.stringify(chunk, null, 2)
+                        );
                     controller.enqueue(chunk);
                 },
             })
@@ -38,9 +47,13 @@ export function connectedPeers(
             new TransformStream({
                 transform(
                     chunk: SyncMessage,
-                    controller: { enqueue: (msg: SyncMessage) => void; }
+                    controller: { enqueue: (msg: SyncMessage) => void }
                 ) {
-                    trace && console.debug(`${peer1id} -> ${peer2id}`, JSON.stringify(chunk, null, 2));
+                    trace &&
+                        console.debug(
+                            `${peer1id} -> ${peer2id}`,
+                            JSON.stringify(chunk, null, 2)
+                        );
                     controller.enqueue(chunk);
                 },
             })
@@ -65,39 +78,22 @@ export function connectedPeers(
 }
 
 export function newStreamPair<T>(): [ReadableStream<T>, WritableStream<T>] {
-    const queue: T[] = [];
-    let resolveNextItemReady: () => void = () => { };
-    let nextItemReady: Promise<void> = new Promise((resolve) => {
-        resolveNextItemReady = resolve;
+    let readerClosed = false;
+
+    let resolveEnqueue: (enqueue: (item: T) => void) => void;
+    const enqueuePromise = new Promise<(item: T) => void>((resolve) => {
+        resolveEnqueue = resolve;
     });
 
-    let writerClosed = false;
-    let readerClosed = false;
+    let resolveClose: (close: () => void) => void;
+    const closePromise = new Promise<() => void>((resolve) => {
+        resolveClose = resolve;
+    });
 
     const readable = new ReadableStream<T>({
-        async pull(controller) {
-            let retriesLeft = 3;
-            while (retriesLeft > 0) {
-                if (writerClosed) {
-                    controller.close();
-                    return;
-                }
-                retriesLeft--;
-                if (queue.length > 0) {
-                    controller.enqueue(queue.shift()!);
-                    if (queue.length === 0) {
-                        nextItemReady = new Promise((resolve) => {
-                            resolveNextItemReady = resolve;
-                        });
-                    }
-                    return;
-                } else {
-                    await nextItemReady;
-                }
-            }
-            throw new Error(
-                "Should only use one retry to get next item in queue."
-            );
+        async start(controller) {
+            resolveEnqueue(controller.enqueue.bind(controller));
+            resolveClose(controller.close.bind(controller));
         },
 
         cancel(_reason) {
@@ -107,22 +103,21 @@ export function newStreamPair<T>(): [ReadableStream<T>, WritableStream<T>] {
     });
 
     const writable = new WritableStream<T>({
-        write(chunk) {
+        async write(chunk) {
+            const enqueue = await enqueuePromise;
             if (readerClosed) {
-                console.log("Reader closed, not writing chunk", chunk);
-                throw new Error("Reader closed, not writing chunk");
-            }
-            queue.push(chunk);
-            if (queue.length === 1) {
-                // make sure that await write resolves before corresponding read
-                setTimeout(() => resolveNextItemReady());
+                throw new Error("Reader closed");
+            } else {
+                // make sure write resolves before corresponding read
+                setTimeout(() => {
+                    enqueue(chunk);
+                })
             }
         },
-        abort(_reason) {
-            console.log("Manually closing writer");
-            writerClosed = true;
-            resolveNextItemReady();
-            return Promise.resolve();
+        async abort(reason) {
+            console.debug("Manually closing writer", reason);
+            const close = await closePromise;
+            close();
         },
     });
 

package/src/sync.ts

@@ -268,6 +268,7 @@ export class SyncManager {
                         );
                     }
                 }
+                console.log("DONE!!!");
             } catch (e) {
                 console.error(`Error reading from peer ${peer.id}`, e);
             }
@@ -280,13 +281,32 @@ export class SyncManager {
     }
 
     trySendToPeer(peer: PeerState, msg: SyncMessage) {
-        return peer.outgoing.write(msg).catch((e) => {
-            console.error(
-                new Error(`Error writing to peer ${peer.id}, disconnecting`, {
-                    cause: e,
+        return new Promise<void>((resolve) => {
+            const timeout = setTimeout(() => {
+                console.error(
+                    new Error(
+                        `Writing to peer ${peer.id} took >1s - this should never happen as write should resolve quickly or error`
+                    )
+                );
+                resolve();
+            }, 1000);
+            peer.outgoing
+                .write(msg)
+                .then(() => {
+                    clearTimeout(timeout);
+                    resolve();
                 })
-            );
-            delete this.peers[peer.id];
+                .catch((e) => {
+                    console.error(
+                        new Error(
+                            `Error writing to peer ${peer.id}, disconnecting`,
+                            {
+                                cause: e,
+                            }
+                        )
+                    );
+                    delete this.peers[peer.id];
+                });
         });
     }