fix: service handlers check for client error chains

Sometimes an error is only considered a client error when part of the chain of another error (for example ErrorPolykeyRemote) so it is now possible to specify this array. #304
MatrixAI · Jun 6, 2022 · 489599c · 489599c
1 parent adf7dbd
commit 489599c
Show file tree

Hide file tree

Showing 78 changed files with 345 additions and 458 deletions.
diff --git a/src/agent/service/nodesChainDataGet.ts b/src/agent/service/nodesChainDataGet.ts
@@ -51,7 +51,7 @@ function nodesChainDataGet({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e, true));
-      !agentUtils.isClientError(e) && logger.error(e);
+      !agentUtils.isAgentClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/agent/service/nodesClosestLocalNodesGet.ts b/src/agent/service/nodesClosestLocalNodesGet.ts
@@ -67,7 +67,7 @@ function nodesClosestLocalNodesGet({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e, true));
-      !agentUtils.isClientError(e) && logger.error(e);
+      !agentUtils.isAgentClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/agent/service/nodesCrossSignClaim.ts b/src/agent/service/nodesCrossSignClaim.ts
@@ -173,7 +173,7 @@ function nodesCrossSignClaim({
       });
     } catch (e) {
       await genClaims.throw(e);
-      !agentUtils.isClientError(e, [
+      !agentUtils.isAgentClientError(e, [
         claimsErrors.ErrorEmptyStream,
         claimsErrors.ErrorUndefinedSinglySignedClaim,
         claimsErrors.ErrorUndefinedSignature,

diff --git a/src/agent/service/nodesHolePunchMessageSend.ts b/src/agent/service/nodesHolePunchMessageSend.ts
@@ -74,7 +74,7 @@ function nodesHolePunchMessageSend({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e, true));
-      !agentUtils.isClientError(e) && logger.error(e);
+      !agentUtils.isAgentClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/agent/service/notificationsSend.ts b/src/agent/service/notificationsSend.ts
@@ -36,7 +36,7 @@ function notificationsSend({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e, true));
-      !agentUtils.isClientError(e, [
+      !agentUtils.isAgentClientError(e, [
         notificationsErrors.ErrorNotificationsInvalidType,
         notificationsErrors.ErrorNotificationsValidationFailed,
         notificationsErrors.ErrorNotificationsParse,

diff --git a/src/agent/service/vaultsGitInfoGet.ts b/src/agent/service/vaultsGitInfoGet.ts
@@ -1,5 +1,5 @@
 import type { DB } from '@matrixai/db';
-import type { VaultName, VaultId, VaultAction } from '../../vaults/types';
+import type { VaultName, VaultAction } from '../../vaults/types';
 import type VaultManager from '../../vaults/VaultManager';
 import type ACL from '../../acl/ACL';
 import type { ConnectionInfoGet } from '../../agent/types';
@@ -39,25 +39,24 @@ function vaultsGitInfoGet({
           call.request.getVault()?.getNameOrId() as VaultName,
           tran,
         );
+        const vaultId =
+          vaultIdFromName ??
+          vaultsUtils.decodeVaultId(call.request.getVault()?.getNameOrId());
+        if (vaultId == null) {
+          throw new vaultsErrors.ErrorVaultsVaultUndefined();
+        }
         const {
-          vaultId,
           actionType,
         }: {
-          vaultId: VaultId;
           actionType: VaultAction;
         } = validateSync(
           (keyPath, value) => {
             return matchSync(keyPath)(
-              [
-                ['vaultId'],
-                () => vaultIdFromName ?? validationUtils.parseVaultId(value),
-              ],
               [['actionType'], () => validationUtils.parseVaultAction(value)],
               () => value,
             );
           },
           {
-            vaultId: call.request.getVault()?.getNameOrId(),
             actionType: call.request.getAction(),
           },
         );
@@ -108,7 +107,7 @@ function vaultsGitInfoGet({
       return;
     } catch (e) {
       await genWritable.throw(e);
-      !agentUtils.isClientError(e, [
+      !agentUtils.isAgentClientError(e, [
         vaultsErrors.ErrorVaultsVaultUndefined,
         agentErrors.ErrorConnectionInfoMissing,
         vaultsErrors.ErrorVaultsPermissionDenied,

diff --git a/src/agent/service/vaultsGitPackGet.ts b/src/agent/service/vaultsGitPackGet.ts
@@ -1,6 +1,6 @@
 import type * as grpc from '@grpc/grpc-js';
 import type { DB } from '@matrixai/db';
-import type { VaultName, VaultId, VaultAction } from '../../vaults/types';
+import type { VaultName, VaultAction } from '../../vaults/types';
 import type VaultManager from '../../vaults/VaultManager';
 import type { ConnectionInfoGet } from '../../agent/types';
 import type ACL from '../../acl/ACL';
@@ -62,25 +62,22 @@ function vaultsGitPackGet({
           nameOrId as VaultName,
           tran,
         );
+        const vaultId = vaultIdFromName ?? vaultsUtils.decodeVaultId(nameOrId);
+        if (vaultId == null) {
+          throw new vaultsErrors.ErrorVaultsVaultUndefined();
+        }
         const {
-          vaultId,
           actionType,
         }: {
-          vaultId: VaultId;
           actionType: VaultAction;
         } = validateSync(
           (keyPath, value) => {
             return matchSync(keyPath)(
-              [
-                ['vaultId'],
-                () => vaultIdFromName ?? validationUtils.parseVaultId(value),
-              ],
               [['actionType'], () => validationUtils.parseVaultAction(value)],
               () => value,
             );
           },
           {
-            vaultId: nameOrId,
             actionType: meta.get('vaultAction').pop()!.toString(),
           },
         );
@@ -123,7 +120,7 @@ function vaultsGitPackGet({
       return;
     } catch (e) {
       await genDuplex.throw(e);
-      !agentUtils.isClientError(e, [
+      !agentUtils.isAgentClientError(e, [
         agentErrors.ErrorConnectionInfoMissing,
         vaultsErrors.ErrorVaultsPermissionDenied,
         vaultsErrors.ErrorVaultsVaultUndefined,

diff --git a/src/agent/service/vaultsScan.ts b/src/agent/service/vaultsScan.ts
@@ -53,7 +53,7 @@ function vaultsScan({
       return;
     } catch (e) {
       await genWritable.throw(e);
-      !agentUtils.isClientError(e, [
+      !agentUtils.isAgentClientError(e, [
         agentErrors.ErrorConnectionInfoMissing,
         vaultsErrors.ErrorVaultsPermissionDenied,
       ]) && logger.error(e);

diff --git a/src/agent/types.ts b/src/agent/types.ts
@@ -1,8 +1,14 @@
-import type { ConnectionInfo } from 'network/types';
 import type { ServerSurfaceCall } from '@grpc/grpc-js/build/src/server-call';
+import type { Class } from '@matrixai/errors';
+import type { ConnectionInfo } from '../network/types';
+import type ErrorPolykey from '../ErrorPolykey';
 
 type ConnectionInfoGet = (
   call: ServerSurfaceCall,
 ) => ConnectionInfo | undefined;
 
-export type { ConnectionInfoGet };
+type AgentClientErrors = Array<
+  Class<ErrorPolykey<any>> | Array<Class<ErrorPolykey<any>>>
+>;
+
+export type { ConnectionInfoGet, AgentClientErrors };
diff --git a/src/agent/utils.ts b/src/agent/utils.ts
@@ -1,15 +1,15 @@
 import type { ServerSurfaceCall } from '@grpc/grpc-js/build/src/server-call';
-import type { Class } from '@matrixai/errors';
-import type { Host, Port } from 'network/types';
-import type Proxy from 'network/Proxy';
-import type { ConnectionInfoGet } from './types';
+import type ErrorPolykey from '../ErrorPolykey';
+import type { Host, Port } from '../network/types';
+import type Proxy from '../network/Proxy';
+import type { ConnectionInfoGet, AgentClientErrors } from './types';
 import * as validationErrors from '../validation/errors';
 
 /**
  * Array of errors that are always considered to be "client errors"
  * (4xx errors in HTTP) in the context of the agent service
  */
-const defaultClientErrors: Array<Class<Error>> = [
+const defaultClientErrors: AgentClientErrors = [
   validationErrors.ErrorValidation,
 ];
 
@@ -33,19 +33,53 @@ function connectionInfoGetter(proxy: Proxy): ConnectionInfoGet {
  * context of a given handler can be supplied in the `extraClientErrors`
  * argument
  */
-function isClientError(
-  e: Error,
-  extraClientErrors?: Array<Class<Error>>,
+function isAgentClientError(
+  thrownError: ErrorPolykey<any>,
+  extraClientErrors?: AgentClientErrors,
 ): boolean {
   for (const error of defaultClientErrors) {
-    if (e instanceof error) return true;
+    if (Array.isArray(error)) {
+      let e = thrownError;
+      let matches = true;
+      for (const eType of error) {
+        if (e == null) {
+          matches = false;
+          break;
+        }
+        if (!(e instanceof eType)) {
+          matches = false;
+          break;
+        }
+        e = e.cause;
+      }
+      if (matches) return true;
+    } else if (thrownError instanceof error) {
+      return true;
+    }
   }
   if (extraClientErrors) {
     for (const error of extraClientErrors) {
-      if (e instanceof error) return true;
+      if (Array.isArray(error)) {
+        let e = thrownError;
+        let matches = true;
+        for (const eType of error) {
+          if (e == null) {
+            matches = false;
+            break;
+          }
+          if (!(e instanceof eType)) {
+            matches = false;
+            break;
+          }
+          e = e.cause;
+        }
+        if (matches) return true;
+      } else if (thrownError instanceof error) {
+        return true;
+      }
     }
   }
   return false;
 }
 
-export { connectionInfoGetter, isClientError };
+export { connectionInfoGetter, isAgentClientError };
diff --git a/src/client/service/agentLockAll.ts b/src/client/service/agentLockAll.ts
@@ -33,7 +33,7 @@ function agentLockAll({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/client/service/agentStatus.ts b/src/client/service/agentStatus.ts
@@ -50,7 +50,7 @@ function agentStatus({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/client/service/agentStop.ts b/src/client/service/agentStop.ts
@@ -33,7 +33,7 @@ function agentStop({
       callback(null, response);
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
     // Stop is called after GRPC resources are cleared

diff --git a/src/client/service/agentUnlock.ts b/src/client/service/agentUnlock.ts
@@ -24,7 +24,7 @@ function agentUnlock({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/client/service/gestaltsActionsGetByIdentity.ts b/src/client/service/gestaltsActionsGetByIdentity.ts
@@ -63,7 +63,7 @@ function gestaltsActionsGetByIdentity({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/client/service/gestaltsActionsGetByNode.ts b/src/client/service/gestaltsActionsGetByNode.ts
@@ -57,7 +57,7 @@ function gestaltsActionsGetByNode({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/client/service/gestaltsActionsSetByIdentity.ts b/src/client/service/gestaltsActionsSetByIdentity.ts
@@ -68,7 +68,7 @@ function gestaltsActionsSetByIdentity({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e, [
+      !clientUtils.isClientClientError(e, [
         gestaltsErrors.ErrorGestaltsGraphIdentityIdMissing,
         gestaltsErrors.ErrorGestaltsGraphNodeIdMissing,
       ]) && logger.error(e);

diff --git a/src/client/service/gestaltsActionsSetByNode.ts b/src/client/service/gestaltsActionsSetByNode.ts
@@ -54,7 +54,7 @@ function gestaltsActionsSetByNode({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e, [
+      !clientUtils.isClientClientError(e, [
         gestaltsErrors.ErrorGestaltsGraphNodeIdMissing,
       ]) && logger.error(e);
       return;

diff --git a/src/client/service/gestaltsActionsUnsetByIdentity.ts b/src/client/service/gestaltsActionsUnsetByIdentity.ts
@@ -68,7 +68,7 @@ function gestaltsActionsUnsetByIdentity({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e, [
+      !clientUtils.isClientClientError(e, [
         gestaltsErrors.ErrorGestaltsGraphIdentityIdMissing,
         gestaltsErrors.ErrorGestaltsGraphNodeIdMissing,
       ]) && logger.error(e);

diff --git a/src/client/service/gestaltsActionsUnsetByNode.ts b/src/client/service/gestaltsActionsUnsetByNode.ts
@@ -54,7 +54,7 @@ function gestaltsActionsUnsetByNode({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e, [
+      !clientUtils.isClientClientError(e, [
         gestaltsErrors.ErrorGestaltsGraphNodeIdMissing,
       ]) && logger.error(e);
       return;

diff --git a/src/client/service/gestaltsDiscoveryByIdentity.ts b/src/client/service/gestaltsDiscoveryByIdentity.ts
@@ -52,7 +52,7 @@ function gestaltsDiscoveryByIdentity({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/client/service/gestaltsDiscoveryByNode.ts b/src/client/service/gestaltsDiscoveryByNode.ts
@@ -48,7 +48,7 @@ function gestaltsDiscoveryByNode({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/client/service/gestaltsGestaltGetByIdentity.ts b/src/client/service/gestaltsGestaltGetByIdentity.ts
@@ -60,7 +60,7 @@ function gestaltsGestaltGetByIdentity({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/client/service/gestaltsGestaltGetByNode.ts b/src/client/service/gestaltsGestaltGetByNode.ts
@@ -56,7 +56,7 @@ function gestaltsGestaltGetByNode({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/client/service/gestaltsGestaltList.ts b/src/client/service/gestaltsGestaltList.ts
@@ -40,7 +40,7 @@ function gestaltsGestaltList({
       return;
     } catch (e) {
       await genWritable.throw(e);
-      !clientUtils.isClientError(e) && logger.error(e);
+      !clientUtils.isClientClientError(e) && logger.error(e);
       return;
     }
   };

diff --git a/src/client/service/gestaltsGestaltTrustByIdentity.ts b/src/client/service/gestaltsGestaltTrustByIdentity.ts
@@ -84,7 +84,7 @@ function gestaltsGestaltTrustByIdentity({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e, [
+      !clientUtils.isClientClientError(e, [
         gestaltsErrors.ErrorGestaltsGraphIdentityIdMissing,
         gestaltsErrors.ErrorGestaltsGraphNodeIdMissing,
       ]) && logger.error(e);

diff --git a/src/client/service/gestaltsGestaltTrustByNode.ts b/src/client/service/gestaltsGestaltTrustByNode.ts
@@ -71,7 +71,7 @@ function gestaltsGestaltTrustByNode({
       return;
     } catch (e) {
       callback(grpcUtils.fromError(e));
-      !clientUtils.isClientError(e, [
+      !clientUtils.isClientClientError(e, [
         gestaltsErrors.ErrorGestaltsGraphNodeIdMissing,
       ]) && logger.error(e);
       return;