cojson 0.7.33 → 0.7.34-neverthrow.0

package/src/localNode.ts

@@ -22,9 +22,11 @@ import {
     AccountID,
     RawProfile,
     RawAccountMigration,
+    InvalidAccountAgentIDError,
 } from "./coValues/account.js";
 import { Profile, RawCoValue } from "./index.js";
 import { expectGroup } from "./typeUtils/expectGroup.js";
+import { err, ok, okAsync, Result, ResultAsync } from "neverthrow";
 
 /** A `LocalNode` represents a local view of a set of loaded `CoValue`s, from the perspective of a particular account (or primitive cryptographic agent).
 
@@ -243,7 +245,9 @@ export class LocalNode {
     /** @internal */
     createCoValue(header: CoValueHeader): CoValueCore {
         if (this.crashed) {
-            throw new Error("Trying to create CoValue after node has crashed", { cause: this.crashed });
+            throw new Error("Trying to create CoValue after node has crashed", {
+                cause: this.crashed,
+            });
         }
 
         const coValue = new CoValueCore(header, this);
@@ -264,7 +268,9 @@ export class LocalNode {
         } = {},
     ): Promise<CoValueCore | "unavailable"> {
         if (this.crashed) {
-            throw new Error("Trying to load CoValue after node has crashed", { cause: this.crashed });
+            throw new Error("Trying to load CoValue after node has crashed", {
+                cause: this.crashed,
+            });
         }
 
         let entry = this.coValues[id];
@@ -529,9 +535,9 @@ export class LocalNode {
     resolveAccountAgent(
         id: AccountID | AgentID,
         expectation?: string,
-    ): AgentID {
+    ): Result<AgentID, ResolveAccountAgentError> {
         if (isAgentID(id)) {
-            return id;
+            return ok(id);
         }
 
         const coValue = this.expectCoValueLoaded(id, expectation);
@@ -543,49 +549,58 @@ export class LocalNode {
             !("type" in coValue.header.meta) ||
             coValue.header.meta.type !== "account"
         ) {
-            throw new Error(
-                `${
-                    expectation ? expectation + ": " : ""
-                }CoValue ${id} is not an account`,
-            );
+            return err({
+                type: "UnexpectedlyNotAccount",
+                expectation,
+                id,
+            } satisfies UnexpectedlyNotAccountError);
         }
 
         return (coValue.getCurrentContent() as RawAccount).currentAgentID();
     }
 
-    async resolveAccountAgentAsync(
+    resolveAccountAgentAsync(
         id: AccountID | AgentID,
         expectation?: string,
-    ): Promise<AgentID> {
+    ): ResultAsync<AgentID, ResolveAccountAgentError> {
         if (isAgentID(id)) {
-            return id;
+            return okAsync(id);
         }
 
-        const coValue = await this.loadCoValueCore(id);
-
-        if (coValue === "unavailable") {
-            throw new Error(
-                `${
-                    expectation ? expectation + ": " : ""
-                }Account ${id} is unavailable from all peers`,
-            );
-        }
+        return ResultAsync.fromPromise(
+            this.loadCoValueCore(id),
+            (e) =>
+                ({
+                    type: "ErrorLoadingCoValueCore",
+                    expectation,
+                    id,
+                    error: e,
+                }) satisfies LoadCoValueCoreError,
+        ).andThen((coValue) => {
+            if (coValue === "unavailable") {
+                return err({
+                    type: "AccountUnavailableFromAllPeers" as const,
+                    expectation,
+                    id,
+                } satisfies AccountUnavailableFromAllPeersError);
+            }
 
-        if (
-            coValue.header.type !== "comap" ||
-            coValue.header.ruleset.type !== "group" ||
-            !coValue.header.meta ||
-            !("type" in coValue.header.meta) ||
-            coValue.header.meta.type !== "account"
-        ) {
-            throw new Error(
-                `${
-                    expectation ? expectation + ": " : ""
-                }CoValue ${id} is not an account`,
-            );
-        }
+            if (
+                coValue.header.type !== "comap" ||
+                coValue.header.ruleset.type !== "group" ||
+                !coValue.header.meta ||
+                !("type" in coValue.header.meta) ||
+                coValue.header.meta.type !== "account"
+            ) {
+                return err({
+                    type: "UnexpectedlyNotAccount" as const,
+                    expectation,
+                    id,
+                } satisfies UnexpectedlyNotAccountError);
+            }
 
-        return (coValue.getCurrentContent() as RawAccount).currentAgentID();
+            return (coValue.getCurrentContent() as RawAccount).currentAgentID();
+        });
     }
 
     /**
@@ -610,7 +625,9 @@ export class LocalNode {
             this.crypto.seal({
                 message: readKey.secret,
                 from: this.account.currentSealerSecret(),
-                to: this.account.currentSealerID(),
+                to: this.account
+                    .currentSealerID()
+                    ._unsafeUnwrap({ withStackTrace: true }),
                 nOnceMaterial: {
                     in: groupCoValue.id,
                     tx: groupCoValue.nextTransactionID(),
@@ -710,6 +727,31 @@ type CoValueState =
           onProgress?: (progress: number) => void;
       };
 
+export type LoadCoValueCoreError = {
+    type: "ErrorLoadingCoValueCore";
+    error: unknown;
+    expectation?: string;
+    id: AccountID;
+};
+
+export type AccountUnavailableFromAllPeersError = {
+    type: "AccountUnavailableFromAllPeers";
+    expectation?: string;
+    id: AccountID;
+};
+
+export type UnexpectedlyNotAccountError = {
+    type: "UnexpectedlyNotAccount";
+    expectation?: string;
+    id: AccountID;
+};
+
+export type ResolveAccountAgentError =
+    | InvalidAccountAgentIDError
+    | LoadCoValueCoreError
+    | AccountUnavailableFromAllPeersError
+    | UnexpectedlyNotAccountError;
+
 /** @internal */
 export function newLoadingState(
     currentPeerIds: Set<PeerID>,

package/src/permissions.ts

@@ -249,8 +249,22 @@ export function determineValidTransactions(
                         const effectiveTransactor =
                             transactor === groupContent.id &&
                             groupAtTime instanceof RawAccount
-                                ? groupAtTime.currentAgentID()
+                                ? groupAtTime.currentAgentID().match(
+                                      (agentID) => agentID,
+                                      (e) => {
+                                          console.error(
+                                              "Error while determining current agent ID in valid transactions",
+                                              e,
+                                          );
+                                          return undefined;
+                                      },
+                                  )
                                 : transactor;
+
+                        if (!effectiveTransactor) {
+                            return false;
+                        }
+
                         const transactorRoleAtTxTime =
                             groupAtTime.get(effectiveTransactor) ||
                             groupAtTime.get(EVERYONE);

package/src/sync.ts

@@ -392,22 +392,31 @@ export class SyncManager {
             }
         };
 
-        processMessages().then(() => {
-            if (peer.crashOnClose) {
-                console.error("Unexepcted close from peer", peer.id);
-                this.local.crashed = new Error("Unexpected close from peer");
-                throw new Error("Unexpected close from peer");
-            }
-        }).catch((e) => {
-            console.error("Error processing messages from peer", peer.id, e);
-            if (peer.crashOnClose) {
-                this.local.crashed = e;
-                throw new Error(e);
-            }
-        }).finally(() => {
-            peer.outgoing.close();
-            delete this.peers[peer.id];
-        });
+        processMessages()
+            .then(() => {
+                if (peer.crashOnClose) {
+                    console.error("Unexepcted close from peer", peer.id);
+                    this.local.crashed = new Error(
+                        "Unexpected close from peer",
+                    );
+                    throw new Error("Unexpected close from peer");
+                }
+            })
+            .catch((e) => {
+                console.error(
+                    "Error processing messages from peer",
+                    peer.id,
+                    e,
+                );
+                if (peer.crashOnClose) {
+                    this.local.crashed = e;
+                    throw new Error(e);
+                }
+            })
+            .finally(() => {
+                peer.outgoing.close();
+                delete this.peers[peer.id];
+            });
     }
 
     trySendToPeer(peer: PeerState, msg: SyncMessage) {
@@ -552,9 +561,10 @@ export class SyncManager {
         let entry = this.local.coValues[msg.id];
 
         if (!entry) {
-            throw new Error(
+            console.error(
                 `Expected coValue entry for ${msg.id} to be created on new content, missing subscribe?`,
             );
+            return;
         }
 
         let resolveAfterDone: ((coValue: CoValueCore) => void) | undefined;
@@ -562,14 +572,16 @@ export class SyncManager {
         const peerOptimisticKnownState = peer.optimisticKnownStates[msg.id];
 
         if (!peerOptimisticKnownState) {
-            throw new Error(
+            console.error(
                 "Expected optimisticKnownState to be set for coValue we receive new content for",
             );
+            return;
         }
 
         if (entry.state === "loading") {
             if (!msg.header) {
-                throw new Error("Expected header to be sent in first message");
+                console.error("Expected header to be sent in first message");
+                return;
             }
 
             const firstPeerStateEntry = entry.firstPeerState[peer.id];
@@ -621,7 +633,8 @@ export class SyncManager {
             }
 
             const before = performance.now();
-            const success = await coValue.tryAddTransactionsAsync(
+            // eslint-disable-next-line neverthrow/must-use-result
+            const result = await coValue.tryAddTransactionsAsync(
                 sessionID,
                 newTransactions,
                 undefined,
@@ -657,13 +670,14 @@ export class SyncManager {
 
             entry.onProgress?.(ourTotalnTxs / theirTotalnTxs);
 
-            if (!success) {
+            if (result.isErr()) {
                 console.error(
                     "Failed to add transactions",
+                    result.error,
                     msg.id,
-                    newTransactions.length + ' new transactions',
-                    'we have' + ourTotalnTxs,
-                    'they have' + theirTotalnTxs,
+                    newTransactions.length + " new transactions",
+                    "we have" + ourTotalnTxs,
+                    "they have" + theirTotalnTxs,
                 );
                 continue;
             }

package/src/tests/coValueCore.test.ts

@@ -36,12 +36,14 @@ test("Can create coValue with new agent credentials and add transaction to it",
     );
 
     expect(
-        coValue.tryAddTransactions(
-            node.currentSessionID,
-            [transaction],
-            expectedNewHash,
-            Crypto.sign(account.currentSignerSecret(), expectedNewHash),
-        ),
+        coValue
+            .tryAddTransactions(
+                node.currentSessionID,
+                [transaction],
+                expectedNewHash,
+                Crypto.sign(account.currentSignerSecret(), expectedNewHash),
+            )
+            ._unsafeUnwrap(),
     ).toBe(true);
 });
 
@@ -72,8 +74,9 @@ test("transactions with wrong signature are rejected", () => {
         [transaction],
     );
 
-    expect(
-        coValue.tryAddTransactions(
+    // eslint-disable-next-line neverthrow/must-use-result
+    coValue
+        .tryAddTransactions(
             node.currentSessionID,
             [transaction],
             expectedNewHash,
@@ -81,8 +84,8 @@ test("transactions with wrong signature are rejected", () => {
                 Crypto.getAgentSignerSecret(wrongAgent),
                 expectedNewHash,
             ),
-        ),
-    ).toBe(false);
+        )
+        ._unsafeUnwrapErr({ withStackTrace: true });
 });
 
 test("transactions with correctly signed, but wrong hash are rejected", () => {
@@ -121,14 +124,15 @@ test("transactions with correctly signed, but wrong hash are rejected", () => {
         ],
     );
 
-    expect(
-        coValue.tryAddTransactions(
+    // eslint-disable-next-line neverthrow/must-use-result
+    coValue
+        .tryAddTransactions(
             node.currentSessionID,
             [transaction],
             expectedNewHash,
             Crypto.sign(account.currentSignerSecret(), expectedNewHash),
-        ),
-    ).toBe(false);
+        )
+        ._unsafeUnwrapErr({ withStackTrace: true });
 });
 
 test("New transactions in a group correctly update owned values, including subscriptions", async () => {
@@ -174,12 +178,14 @@ test("New transactions in a group correctly update owned values, including subsc
 
     expect(map.core.getValidSortedTransactions().length).toBe(1);
 
-    const manuallyAdddedTxSuccess = group.core.tryAddTransactions(
-        node.currentSessionID,
-        [resignationThatWeJustLearnedAbout],
-        expectedNewHash,
-        signature,
-    );
+    const manuallyAdddedTxSuccess = group.core
+        .tryAddTransactions(
+            node.currentSessionID,
+            [resignationThatWeJustLearnedAbout],
+            expectedNewHash,
+            signature,
+        )
+        ._unsafeUnwrap({ withStackTrace: true });
 
     expect(manuallyAdddedTxSuccess).toBe(true);
 

package/src/tests/permissions.test.ts

@@ -354,7 +354,7 @@ test("Admins can set group read key and then use it to create and read private t
     const revelation = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -410,7 +410,7 @@ test("Admins can set group read key and then writers can use it to create and re
     const revelation1 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -422,7 +422,7 @@ test("Admins can set group read key and then writers can use it to create and re
     const revelation2 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: writer.currentSealerID(),
+        to: writer.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -489,7 +489,7 @@ test("Admins can set group read key and then use it to create private transactio
     const revelation1 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -501,7 +501,7 @@ test("Admins can set group read key and then use it to create private transactio
     const revelation2 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: reader.currentSealerID(),
+        to: reader.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -576,7 +576,7 @@ test("Admins can set group read key and then use it to create private transactio
     const revelation1 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -588,7 +588,7 @@ test("Admins can set group read key and then use it to create private transactio
     const revelation2 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: reader1.currentSealerID(),
+        to: reader1.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -627,7 +627,7 @@ test("Admins can set group read key and then use it to create private transactio
     const revelation3 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: reader2.currentSealerID(),
+        to: reader2.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -692,7 +692,7 @@ test("Admins can set group read key, make a private transaction in an owned obje
     const revelation1 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -722,7 +722,7 @@ test("Admins can set group read key, make a private transaction in an owned obje
     const revelation2 = Crypto.seal({
         message: readKey2,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -775,7 +775,7 @@ test("Admins can set group read key, make a private transaction in an owned obje
     const revelation = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -802,7 +802,7 @@ test("Admins can set group read key, make a private transaction in an owned obje
     const revelation2 = Crypto.seal({
         message: readKey2,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -814,7 +814,7 @@ test("Admins can set group read key, make a private transaction in an owned obje
     const revelation3 = Crypto.seal({
         message: readKey2,
         from: admin.currentSealerSecret(),
-        to: reader.currentSealerID(),
+        to: reader.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -910,7 +910,7 @@ test("Admins can set group read rey, make a private transaction in an owned obje
     const revelation1 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -922,7 +922,7 @@ test("Admins can set group read rey, make a private transaction in an owned obje
     const revelation2 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: reader.currentSealerID(),
+        to: reader.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -934,7 +934,7 @@ test("Admins can set group read rey, make a private transaction in an owned obje
     const revelation3 = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: reader2.currentSealerID(),
+        to: reader2.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -980,7 +980,7 @@ test("Admins can set group read rey, make a private transaction in an owned obje
     const newRevelation1 = Crypto.seal({
         message: readKey2,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -996,7 +996,7 @@ test("Admins can set group read rey, make a private transaction in an owned obje
     const newRevelation2 = Crypto.seal({
         message: readKey2,
         from: admin.currentSealerSecret(),
-        to: reader2.currentSealerID(),
+        to: reader2.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -1121,7 +1121,7 @@ test("Admins can create an adminInvite, which can add an admin", () => {
     const revelation = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -1231,7 +1231,7 @@ test("Admins can create a writerInvite, which can add a writer", () => {
     const revelation = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -1334,7 +1334,7 @@ test("Admins can create a readerInvite, which can add a reader", () => {
     const revelation = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -1427,7 +1427,7 @@ test("WriterInvites can not invite admins", () => {
     const revelation = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -1481,7 +1481,7 @@ test("ReaderInvites can not invite admins", () => {
     const revelation = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -1535,7 +1535,7 @@ test("ReaderInvites can not invite writers", () => {
     const revelation = Crypto.seal({
         message: readKey,
         from: admin.currentSealerSecret(),
-        to: admin.currentSealerID(),
+        to: admin.currentSealerID()._unsafeUnwrap(),
         nOnceMaterial: {
             in: groupCore.id,
             tx: groupCore.nextTransactionID(),
@@ -1610,7 +1610,7 @@ test("Can give read permission to 'everyone'", () => {
         childObject
             .testWithDifferentAccount(
                 newAccount,
-                newRandomSessionID(newAccount.currentAgentID()),
+                newRandomSessionID(newAccount.currentAgentID()._unsafeUnwrap()),
             )
             .getCurrentContent(),
     );
@@ -1639,7 +1639,7 @@ test("Can give read permissions to 'everyone' (high-level)", async () => {
         childObject.core
             .testWithDifferentAccount(
                 new ControlledAgent(Crypto.newRandomAgentSecret(), Crypto),
-                newRandomSessionID(newAccount.currentAgentID()),
+                newRandomSessionID(newAccount.currentAgentID()._unsafeUnwrap()),
             )
             .getCurrentContent(),
     );
@@ -1680,7 +1680,7 @@ test("Can give write permission to 'everyone'", async () => {
         childObject
             .testWithDifferentAccount(
                 newAccount,
-                newRandomSessionID(newAccount.currentAgentID()),
+                newRandomSessionID(newAccount.currentAgentID()._unsafeUnwrap()),
             )
             .getCurrentContent(),
     );
@@ -1715,7 +1715,7 @@ test("Can give write permissions to 'everyone' (high-level)", async () => {
         childObject.core
             .testWithDifferentAccount(
                 newAccount,
-                newRandomSessionID(newAccount.currentAgentID()),
+                newRandomSessionID(newAccount.currentAgentID()._unsafeUnwrap()),
             )
             .getCurrentContent(),
     );