feat: using cause property to establish error chain

When any error is thrown as the result of another error occurring, the original error is now contained within the `cause` property of the new error. #304
MatrixAI · Jun 6, 2022 · 6882759 · 6882759
1 parent bc8a3f7
commit 6882759
Show file tree

Hide file tree

Showing 24 changed files with 77 additions and 20 deletions.
diff --git a/src/bin/keys/CommandDecrypt.ts b/src/bin/keys/CommandDecrypt.ts
@@ -58,6 +58,7 @@ class CommandDecrypt extends CommandPolykey {
               code: e.code,
               path: e.path,
             },
+            cause: e,
           });
         }
         cryptoMessage.setData(cipherText);

diff --git a/src/bin/keys/CommandEncrypt.ts b/src/bin/keys/CommandEncrypt.ts
@@ -58,6 +58,7 @@ class CommandEncypt extends CommandPolykey {
               code: e.code,
               path: e.path,
             },
+            cause: e,
           });
         }
         cryptoMessage.setData(plainText);

diff --git a/src/bin/keys/CommandSign.ts b/src/bin/keys/CommandSign.ts
@@ -58,6 +58,7 @@ class CommandSign extends CommandPolykey {
               code: e.code,
               path: e.path,
             },
+            cause: e,
           });
         }
         cryptoMessage.setData(data);

diff --git a/src/bin/keys/CommandVerify.ts b/src/bin/keys/CommandVerify.ts
@@ -66,6 +66,7 @@ class CommandVerify extends CommandPolykey {
               code: e.code,
               path: e.path,
             },
+            cause: e,
           });
         }
         cryptoMessage.setData(data);

diff --git a/src/bin/nodes/CommandPing.ts b/src/bin/nodes/CommandPing.ts
@@ -59,7 +59,7 @@ class CommandPing extends CommandPolykey {
             error = new binErrors.ErrorNodePingFailed(
               `Failed to resolve node ID ${nodesUtils.encodeNodeId(
                 nodeId,
-              )} to an address.`,
+              )} to an address.`, { cause: err },
             );
           } else {
             throw err;

diff --git a/src/bin/secrets/CommandCreate.ts b/src/bin/secrets/CommandCreate.ts
@@ -71,6 +71,7 @@ class CommandCreate extends CommandPolykey {
               code: e.code,
               path: e.path,
             },
+            cause: e,
           });
         }
         secretMessage.setSecretContent(content);

diff --git a/src/bin/secrets/CommandEdit.ts b/src/bin/secrets/CommandEdit.ts
@@ -80,6 +80,7 @@ class CommandEdit extends CommandPolykey {
               code: e.code,
               path: e.path,
             },
+            cause: e,
           });
         }
         secretMessage.setVault(vaultMessage);

diff --git a/src/bin/secrets/CommandUpdate.ts b/src/bin/secrets/CommandUpdate.ts
@@ -71,6 +71,7 @@ class CommandUpdate extends CommandPolykey {
               code: e.code,
               path: e.path,
             },
+            cause: e,
           });
         }
         secretMessage.setSecretContent(content);

diff --git a/src/bin/utils/processors.ts b/src/bin/utils/processors.ts
@@ -95,6 +95,7 @@ async function processPassword(
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
   } else if (typeof process.env['PK_PASSWORD'] === 'string') {
@@ -139,6 +140,7 @@ async function processNewPassword(
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
   } else if (!existing && typeof process.env['PK_PASSWORD'] === 'string') {
@@ -177,6 +179,7 @@ async function processRecoveryCode(
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
   } else if (typeof process.env['PK_RECOVERY_CODE'] === 'string') {
@@ -384,6 +387,7 @@ async function processAuthentication(
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     meta = clientUtils.encodeAuthFromPassword(password);

diff --git a/src/grpc/GRPCClient.ts b/src/grpc/GRPCClient.ts
@@ -129,7 +129,7 @@ abstract class GRPCClient<T extends Client = Client> {
     } catch (e) {
       // If we fail here then we leak the client object...
       client.close();
-      throw new grpcErrors.ErrorGRPCClientTimeout();
+      throw new grpcErrors.ErrorGRPCClientTimeout(e.message, { cause: e });
     }
     let serverCertChain: Array<Certificate> | undefined;
     if (channelCredentials._isSecure()) {
@@ -151,8 +151,10 @@ abstract class GRPCClient<T extends Client = Client> {
             `Failed GRPC server certificate verification connecting to ${address}`,
           );
           const e_ = new grpcErrors.ErrorGRPCClientVerification(
-            `${e.name}: ${e.message}`,
-            e.data,
+            `${e.name}: ${e.message}`,{
+              data: e.data,
+              cause: e,
+            },
           );
           session.destroy(e_, http2.constants.NGHTTP2_PROTOCOL_ERROR);
         }

diff --git a/src/grpc/GRPCServer.ts b/src/grpc/GRPCServer.ts
@@ -70,7 +70,7 @@ class GRPCServer {
     try {
       this.port = await bindAsync(address, serverCredentials);
     } catch (e) {
-      throw new grpcErrors.ErrorGRPCServerBind(e.message);
+      throw new grpcErrors.ErrorGRPCServerBind(e.message, { cause: e });
     }
     if (serverCredentials._isSecure()) {
       // @ts-ignore hack for private property
@@ -100,8 +100,10 @@ class GRPCServer {
                   `Failed GRPC client certificate verification connecting from ${address}`,
                 );
                 const e_ = new grpcErrors.ErrorGRPCServerVerification(
-                  `${e.name}: ${e.message}`,
-                  e.data,
+                  `${e.name}: ${e.message}`, {
+                    data: e.data,
+                    cause: e,
+                  },
                 );
                 session.destroy(e_, http2.constants.NGHTTP2_PROTOCOL_ERROR);
               } else {
@@ -140,7 +142,7 @@ class GRPCServer {
         ...(timer != null ? [timer.timerP] : []),
       ]);
     } catch (e) {
-      throw new grpcErrors.ErrorGRPCServerShutdown(e.message);
+      throw new grpcErrors.ErrorGRPCServerShutdown(e.message, { cause: e });
     } finally {
       if (timer != null) timerStop(timer);
     }

diff --git a/src/identities/providers/github/GitHubProvider.ts b/src/identities/providers/github/GitHubProvider.ts
@@ -120,7 +120,7 @@ class GitHubProvider extends Provider {
           data = await response.json();
         } catch (e) {
           throw new identitiesErrors.ErrorProviderAuthentication(
-            'Provider access token response is not valid JSON',
+            'Provider access token response is not valid JSON', { cause: e },
           );
         }
         if (data.error) {
@@ -200,6 +200,7 @@ class GitHubProvider extends Provider {
     } catch (e) {
       throw new identitiesErrors.ErrorProviderCall(
         `Provider response body is not valid JSON`,
+        { cause: e },
       );
     }
     return data.login;
@@ -246,6 +247,7 @@ class GitHubProvider extends Provider {
     } catch (e) {
       throw new identitiesErrors.ErrorProviderCall(
         `Provider response body is not valid JSON`,
+        { cause: e },
       );
     }
     return {
@@ -297,6 +299,7 @@ class GitHubProvider extends Provider {
       } catch (e) {
         throw new identitiesErrors.ErrorProviderCall(
           `Provider response body is not valid JSON`,
+          { cause: e },
         );
       }
       for (const item of data) {
@@ -343,6 +346,7 @@ class GitHubProvider extends Provider {
       } catch (e) {
         throw new identitiesErrors.ErrorProviderCall(
           `Provider response body is not valid JSON`,
+          { cause: e },
         );
       }
       for (const item of data) {
@@ -414,6 +418,7 @@ class GitHubProvider extends Provider {
     } catch (e) {
       throw new identitiesErrors.ErrorProviderCall(
         `Provider response body is not valid JSON`,
+        { cause: e },
       );
     }
     return {
@@ -466,6 +471,7 @@ class GitHubProvider extends Provider {
     } catch (e) {
       throw new identitiesErrors.ErrorProviderCall(
         `Provider response body is not valid JSON`,
+        { cause: e },
       );
     }
     const linkClaimData = data.files[this.gistFilename]?.content;

diff --git a/src/keys/KeyManager.ts b/src/keys/KeyManager.ts
@@ -275,6 +275,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     try {
@@ -422,6 +423,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     await this.garbageCollectRootCerts();
@@ -545,6 +547,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
   }
@@ -642,6 +645,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     return true;
@@ -663,6 +667,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     let keyPair;
@@ -675,7 +680,7 @@ class KeyManager {
         password,
       );
     } catch (e) {
-      throw new keysErrors.ErrorRootKeysParse(e.message);
+      throw new keysErrors.ErrorRootKeysParse(e.message, { cause: e });
     }
     return keyPair;
   }
@@ -709,6 +714,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
   }
@@ -735,6 +741,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     const rootKeyPairBits = keysUtils.publicKeyBitSize(
@@ -784,6 +791,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     return true;
@@ -802,6 +810,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     let keysDbKeyPlain;
@@ -811,7 +820,7 @@ class KeyManager {
         keysDbKeyCipher,
       );
     } catch (e) {
-      throw new keysErrors.ErrorDBKeyParse(e.message);
+      throw new keysErrors.ErrorDBKeyParse(e.message, { cause: e });
     }
     return keysDbKeyPlain;
   }
@@ -838,6 +847,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
   }
@@ -881,6 +891,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     return true;
@@ -901,6 +912,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     const rootCert = keysUtils.certFromPem(rootCertPem);
@@ -924,6 +936,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
   }
@@ -945,6 +958,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     rootCertsNames.sort((a, b) => {
@@ -984,6 +998,7 @@ class KeyManager {
           code: e.code,
           path: e.path,
         },
+        cause: e,
       });
     }
     return rootCertsPems;

diff --git a/src/network/ConnectionForward.ts b/src/network/ConnectionForward.ts
@@ -170,6 +170,7 @@ class ConnectionForward extends Connection {
           errno: e.errno,
           syscall: e.syscall,
         },
+        cause: e,
       });
     } finally {
       clearInterval(punchInterval);

diff --git a/src/network/ConnectionReverse.ts b/src/network/ConnectionReverse.ts
@@ -162,6 +162,7 @@ class ConnectionReverse extends Connection {
           errno: e.errno,
           syscall: e.syscall,
         },
+        cause: e,
       });
     } finally {
       clearInterval(punchInterval);
@@ -254,6 +255,7 @@ class ConnectionReverse extends Connection {
             errno: e.errno,
             syscall: e.syscall,
           },
+          cause: e,
         });
       }
       tlsSocket.on('error', async (e) => {

diff --git a/src/network/utils.ts b/src/network/utils.ts
@@ -101,7 +101,7 @@ async function resolveHost(host: Host | Hostname): Promise<Host> {
     // Resolve the hostname and get the IPv4 address
     resolvedHost = await lookup(host, 4);
   } catch (e) {
-    throw new networkErrors.ErrorHostnameResolutionFailed(e.message);
+    throw new networkErrors.ErrorHostnameResolutionFailed(e.message, { cause: e });
   }
   // Returns an array of [ resolved address, family (4 or 6) ]
   return resolvedHost[0] as Host;

diff --git a/src/nodes/NodeConnection.ts b/src/nodes/NodeConnection.ts
@@ -135,7 +135,7 @@ class NodeConnection<T extends GRPCClient> {
       await nodeConnection.destroy();
       // If the connection times out, re-throw this with a higher level nodes exception
       if (e instanceof grpcErrors.ErrorGRPCClientTimeout) {
-        throw new nodesErrors.ErrorNodeConnectionTimeout();
+        throw new nodesErrors.ErrorNodeConnectionTimeout(e.message, { cause: e });
       }
       throw e;
     }

diff --git a/src/notifications/utils.ts b/src/notifications/utils.ts
@@ -78,7 +78,7 @@ async function verifyAndDecodeNotif(notifJWT: string): Promise<Notification> {
       throw err;
     } else {
       // Error came from jose
-      throw new notificationsErrors.ErrorNotificationsParse();
+      throw new notificationsErrors.ErrorNotificationsParse(err.message, { cause: err });
     }
   }
 }