chore: move nodes/agent/errors.ts into nodes/errors.ts

aryanjassal · aryanjassal · commit 7d4506e78887 · 2025-04-17T14:40:37.000+10:00
diff --git a/src/nodes/NodeConnectionManager.ts b/src/nodes/NodeConnectionManager.ts
@@ -1710,9 +1710,9 @@ class NodeConnectionManager {
 
         // Write the forward authentication message from this node
         await writer.write(authenticateMessage);
-        const forwardMessageResultPair = await utils.resultOrAbort(
+        const forwardMessageResultPair = await utils.raceSignal(
           reader.read(),
-          ctx,
+          ctx.signal,
         );
         if (forwardMessageResultPair.done) {
           throw new nodesErrors.ErrorNodeAuthenticationInvalidProtocol(
@@ -1727,9 +1727,9 @@ class NodeConnectionManager {
         }
 
         // Read and process the authentication token sent by the connectee
-        const reverseMessageInPair = await utils.resultOrAbort(
+        const reverseMessageInPair = await utils.raceSignal(
           reader.read(),
-          ctx,
+          ctx.signal,
         );
         if (reverseMessageInPair.done) {
           throw new nodesErrors.ErrorNodeAuthenticationInvalidProtocol(
@@ -1750,7 +1750,7 @@ class NodeConnectionManager {
         await writer.write({ type: 'success', success: true });
 
         // Wait for other node to set its state
-        const ackPair = await utils.resultOrAbort(reader.read(), ctx);
+        const ackPair = await utils.raceSignal(reader.read(), ctx.signal);
         if (ackPair.done) {
           throw new nodesErrors.ErrorNodeAuthenticationInvalidProtocol(
             'Stream ended prematurely',
@@ -1920,9 +1920,9 @@ class NodeConnectionManager {
     if (connectionEntry == null) utils.never('Connection should be defined');
 
     try {
-      const reverseMessageInPair = await utils.resultOrAbort(
+      const reverseMessageInPair = await utils.raceSignal(
         inputIterator.next(),
-        ctx,
+        ctx.signal,
       );
       if (reverseMessageInPair.done === true) {
         throw new nodesErrors.ErrorNodeAuthenticationInvalidProtocol(
@@ -1952,9 +1952,9 @@ class NodeConnectionManager {
 
       // Generate and yield the forward token from this node
       yield await this.authenticateNetworkForwardCallback(ctx);
-      const forwardMessageResultPair = await utils.resultOrAbort(
+      const forwardMessageResultPair = await utils.raceSignal(
         inputIterator.next(),
-        ctx,
+        ctx.signal,
       );
       if (forwardMessageResultPair.done === true) {
         throw new nodesErrors.ErrorNodeAuthenticationInvalidProtocol(
diff --git a/src/nodes/agent/errors.ts b/src/nodes/agent/errors.ts
diff --git a/src/nodes/agent/handlers/NodesAuthenticateConnection.ts b/src/nodes/agent/handlers/NodesAuthenticateConnection.ts
@@ -8,8 +8,8 @@ import type {
 import type NodeConnectionManager from '../../../nodes/NodeConnectionManager.js';
 import type { JSONValue } from '../../../types.js';
 import { DuplexHandler } from '@matrixai/rpc';
-import * as agentErrors from '../errors.js';
 import * as agentUtils from '../utils.js';
+import * as nodesErrors from '../../errors.js';
 
 class NodesAuthenticateConnection extends DuplexHandler<
   {
@@ -39,7 +39,7 @@ class NodesAuthenticateConnection extends DuplexHandler<
     // Connections should always be validated
     const requestingNodeId = agentUtils.nodeIdFromMeta(meta);
     if (requestingNodeId == null) {
-      throw new agentErrors.ErrorAgentNodeIdMissing();
+      throw new nodesErrors.ErrorNodeConnectionInvalidIdentity();
     }
 
     // This async generator handles the back-and-forth communication to
diff --git a/src/nodes/agent/handlers/NodesClaimNetworkSign.ts b/src/nodes/agent/handlers/NodesClaimNetworkSign.ts
@@ -6,8 +6,8 @@ import type {
 import type NodeManager from '../../../nodes/NodeManager.js';
 import type { JSONValue } from '../../../types.js';
 import { UnaryHandler } from '@matrixai/rpc';
-import * as agentErrors from '../errors.js';
 import * as agentUtils from '../utils.js';
+import * as nodesErrors from '../../errors.js';
 
 class NodesClaimNetworkSign extends UnaryHandler<
   {
@@ -25,7 +25,7 @@ class NodesClaimNetworkSign extends UnaryHandler<
     // Connections should always be validated
     const requestingNodeId = agentUtils.nodeIdFromMeta(meta);
     if (requestingNodeId == null) {
-      throw new agentErrors.ErrorAgentNodeIdMissing();
+      throw new nodesErrors.ErrorNodeConnectionInvalidIdentity();
     }
     return nodeManager.handleClaimNetwork(requestingNodeId, input);
   };
diff --git a/src/nodes/agent/handlers/NodesClaimNetworkVerify.ts b/src/nodes/agent/handlers/NodesClaimNetworkVerify.ts
@@ -6,8 +6,8 @@ import type {
 import type NodeManager from '../../../nodes/NodeManager.js';
 import type { JSONValue } from '../../../types.js';
 import { UnaryHandler } from '@matrixai/rpc';
-import * as agentErrors from '../errors.js';
 import * as agentUtils from '../utils.js';
+import * as nodesErrors from '../../errors.js';
 
 class NodesClaimNetworkVerify extends UnaryHandler<
   {
@@ -24,7 +24,7 @@ class NodesClaimNetworkVerify extends UnaryHandler<
     const { nodeManager }: { nodeManager: NodeManager } = this.container;
     const requestingNodeId = agentUtils.nodeIdFromMeta(meta);
     if (requestingNodeId == null) {
-      throw new agentErrors.ErrorAgentNodeIdMissing();
+      throw new nodesErrors.ErrorNodeConnectionInvalidIdentity();
     }
     return nodeManager.handleVerifyClaimNetwork(requestingNodeId, input);
   };
diff --git a/src/nodes/agent/handlers/NodesConnectionSignalFinal.ts b/src/nodes/agent/handlers/NodesConnectionSignalFinal.ts
@@ -13,7 +13,6 @@ import { validateSync } from '../../../validation/index.js';
 import { matchSync } from '../../../utils/index.js';
 import * as keysUtils from '../../../keys/utils/index.js';
 import * as ids from '../../../ids/index.js';
-import * as agentErrors from '../errors.js';
 import * as agentUtils from '../utils.js';
 import * as nodesErrors from '../../errors.js';
 
@@ -56,7 +55,7 @@ class NodesConnectionSignalFinal extends UnaryHandler<
     );
     const relayingNodeId = agentUtils.nodeIdFromMeta(meta);
     if (relayingNodeId == null) {
-      throw new agentErrors.ErrorAgentNodeIdMissing();
+      throw new nodesErrors.ErrorNodeConnectionInvalidIdentity();
     }
     const requestSignature = Buffer.from(input.requestSignature, 'base64url');
     // Checking request requestSignature, requestData is just `<sourceNodeId><targetNodeId>` concatenated
diff --git a/src/nodes/agent/handlers/NodesConnectionSignalInitial.ts b/src/nodes/agent/handlers/NodesConnectionSignalInitial.ts
@@ -12,7 +12,6 @@ import { UnaryHandler } from '@matrixai/rpc';
 import { validateSync } from '../../../validation/index.js';
 import { matchSync } from '../../../utils/index.js';
 import { never } from '../../../utils/index.js';
-import * as agentErrors from '../errors.js';
 import * as agentUtils from '../utils.js';
 import * as nodesErrors from '../../errors.js';
 import * as keysUtils from '../../../keys/utils/index.js';
@@ -38,7 +37,7 @@ class NodesConnectionSignalInitial extends UnaryHandler<
     // Connections should always be validated
     const requestingNodeId = agentUtils.nodeIdFromMeta(meta);
     if (requestingNodeId == null) {
-      throw new agentErrors.ErrorAgentNodeIdMissing();
+      throw new nodesErrors.ErrorNodeConnectionInvalidIdentity();
     }
     const { targetNodeId }: { targetNodeId: NodeId } = validateSync(
       (keyPath, value) => {
diff --git a/src/nodes/agent/handlers/NodesCrossSignClaim.ts b/src/nodes/agent/handlers/NodesCrossSignClaim.ts
@@ -7,7 +7,6 @@ import type {
 import type NodeManager from '../../NodeManager.js';
 import type ACL from '../../../acl/ACL.js';
 import { DuplexHandler } from '@matrixai/rpc';
-import * as agentErrors from '../errors.js';
 import * as agentUtils from '../utils.js';
 import * as nodesErrors from '../../errors.js';
 
@@ -36,7 +35,7 @@ class NodesCrossSignClaim extends DuplexHandler<
     } = this.container;
     const requestingNodeId = agentUtils.nodeIdFromMeta(meta);
     if (requestingNodeId == null) {
-      throw new agentErrors.ErrorAgentNodeIdMissing();
+      throw new nodesErrors.ErrorNodeConnectionInvalidIdentity();
     }
     // Check the ACL for permissions
     const permissions = await acl.getNodePerm(requestingNodeId);
diff --git a/src/nodes/agent/handlers/VaultsGitInfoGet.ts b/src/nodes/agent/handlers/VaultsGitInfoGet.ts
@@ -7,11 +7,11 @@ import type VaultManager from '../../../vaults/VaultManager.js';
 import type { JSONValue } from '../../../types.js';
 import { ReadableStream } from 'stream/web';
 import { RawHandler } from '@matrixai/rpc';
-import * as agentErrors from '../errors.js';
+import * as agentUtils from '../utils.js';
+import * as nodesErrors from '../../errors.js';
+import * as nodesUtils from '../../utils.js';
 import * as vaultsUtils from '../../../vaults/utils.js';
 import * as vaultsErrors from '../../../vaults/errors.js';
-import * as nodesUtils from '../../utils.js';
-import * as agentUtils from '../utils.js';
 import * as utils from '../../../utils/index.js';
 
 /**
@@ -65,7 +65,7 @@ class VaultsGitInfoGet extends RawHandler<{
       // Getting the NodeId from the connection metadata
       const requestingNodeId = agentUtils.nodeIdFromMeta(meta);
       if (requestingNodeId == null) {
-        throw new agentErrors.ErrorAgentNodeIdMissing();
+        throw new nodesErrors.ErrorNodeConnectionInvalidIdentity();
       }
       const nodeIdEncoded = nodesUtils.encodeNodeId(requestingNodeId);
       const permissions = await acl.getNodePerm(requestingNodeId, tran);
diff --git a/src/nodes/agent/handlers/VaultsGitPackGet.ts b/src/nodes/agent/handlers/VaultsGitPackGet.ts
@@ -6,8 +6,8 @@ import type ACL from '../../../acl/ACL.js';
 import type VaultManager from '../../../vaults/VaultManager.js';
 import { ReadableStream } from 'stream/web';
 import { RawHandler } from '@matrixai/rpc';
-import * as agentErrors from '../errors.js';
 import * as agentUtils from '../utils.js';
+import * as nodesErrors from '../../errors.js';
 import * as nodesUtils from '../../utils.js';
 import * as vaultsUtils from '../../../vaults/utils.js';
 import * as vaultsErrors from '../../../vaults/errors.js';
@@ -31,7 +31,7 @@ class VaultsGitPackGet extends RawHandler<{
     const [headerMessage, inputStream] = input;
     const requestingNodeId = agentUtils.nodeIdFromMeta(meta);
     if (requestingNodeId == null) {
-      throw new agentErrors.ErrorAgentNodeIdMissing();
+      throw new nodesErrors.ErrorNodeConnectionInvalidIdentity();
     }
     const nodeIdEncoded = nodesUtils.encodeNodeId(requestingNodeId);
     const params = headerMessage.params;
diff --git a/src/nodes/agent/handlers/VaultsScan.ts b/src/nodes/agent/handlers/VaultsScan.ts
@@ -8,8 +8,8 @@ import type {
 import type VaultManager from '../../../vaults/VaultManager.js';
 import type { JSONValue } from '@matrixai/rpc';
 import { ServerHandler } from '@matrixai/rpc';
-import * as agentErrors from '../errors.js';
 import * as agentUtils from '../utils.js';
+import * as nodesErrors from '../../errors.js';
 import * as vaultsUtils from '../../../vaults/utils.js';
 
 /**
@@ -33,7 +33,7 @@ class VaultsScan extends ServerHandler<
       this.container;
     const requestingNodeId = agentUtils.nodeIdFromMeta(meta);
     if (requestingNodeId == null) {
-      throw new agentErrors.ErrorAgentNodeIdMissing();
+      throw new nodesErrors.ErrorNodeConnectionInvalidIdentity();
     }
     yield* db.withTransactionG(async function* (tran): AsyncGenerator<
       AgentRPCResponseResult<VaultsScanMessage>
diff --git a/src/nodes/agent/index.ts b/src/nodes/agent/index.ts
@@ -3,5 +3,4 @@ export { default as manifestServer } from './handlers/index.js';
 export * as callers from './callers/index.js';
 export * as handlers from './handlers/index.js';
 export * as utils from './utils.js';
-export * as errors from './errors.js';
 export * as types from './types.js';
diff --git a/src/nodes/errors.ts b/src/nodes/errors.ts
@@ -284,6 +284,10 @@ class ErrorNodeClaimNetworkVerificationFailed<T> extends ErrorNodes<T> {
   exitCode = sysexits.UNAVAILABLE;
 }
 
+class ErrorNodeConnectionInvalidIdentity<T> extends ErrorNodeConnection<T> {
+  static description = 'Failed to verify connection identity';
+}
+
 export {
   ErrorNodes,
   ErrorNodeManager,
@@ -336,4 +340,5 @@ export {
   ErrorNodeClaimNetworkVerificationFailed,
   ErrorNodeConnectionSignalRelayVerificationFailed,
   ErrorNodeConnectionSignalRequestVerificationFailed,
+  ErrorNodeConnectionInvalidIdentity,
 };
diff --git a/src/utils/utils.ts b/src/utils/utils.ts
@@ -555,19 +555,19 @@ async function importFS(fs?: FileSystem): Promise<FileSystem> {
  * @param ctx The ctx with which to race the promise against
  * @returns A promise which resolves to the prom value or errors if ctx aborts
  */
-async function resultOrAbort<T>(
+async function raceSignal<T>(
   prom: Promise<T>,
-  ctx: ContextTimed,
+  abortSignal: AbortSignal,
 ): Promise<T> {
   // Create an abort promise which rejects when ctx is aborted
   const { p: abortP, rejectP: rejectAbortP } = promise<never>();
   const abortHandler = () => {
-    rejectAbortP(ctx.signal.reason);
+    rejectAbortP(abortSignal.reason);
   };
-  if (ctx.signal.aborted) {
+  if (abortSignal.aborted) {
     abortHandler();
   } else {
-    ctx.signal.addEventListener('abort', abortHandler, { once: true });
+    abortSignal.addEventListener('abort', abortHandler, { once: true });
   }
 
   // Race the original promise and abortP. If the original promise resolves
@@ -579,7 +579,7 @@ async function resultOrAbort<T>(
     Error.captureStackTrace(e);
     throw e;
   } finally {
-    ctx.signal.removeEventListener('abort', abortHandler);
+    abortSignal.removeEventListener('abort', abortHandler);
   }
 }
 
@@ -624,5 +624,5 @@ export {
   yieldMicro,
   setMaxListeners,
   importFS,
-  resultOrAbort,
+  raceSignal,
 };
