feat: set error cause if available (#1649)

arthurschreiber · web-flow · commit f405eabb8f0c · 2024-08-14T11:51:50.000-07:00
diff --git a/src/connection.ts b/src/connection.ts
@@ -1963,7 +1963,7 @@ class Connection extends EventEmitter {
         }
 
         process.nextTick(() => {
-          this.emit('connect', new ConnectionError(err.message, 'EINSTLOOKUP'));
+          this.emit('connect', new ConnectionError(err.message, 'EINSTLOOKUP', { cause: err }));
         });
       });
     }
@@ -2331,11 +2331,11 @@ class Connection extends EventEmitter {
       const routingMessage = this.routingData ? ` (redirected from ${this.config.server}${hostPostfix})` : '';
       const message = `Failed to connect to ${server}${port}${routingMessage} - ${error.message}`;
       this.debug.log(message);
-      this.emit('connect', new ConnectionError(message, 'ESOCKET'));
+      this.emit('connect', new ConnectionError(message, 'ESOCKET', { cause: error }));
     } else {
       const message = `Connection lost - ${error.message}`;
       this.debug.log(message);
-      this.emit('error', new ConnectionError(message, 'ESOCKET'));
+      this.emit('error', new ConnectionError(message, 'ESOCKET', { cause: error }));
     }
     this.dispatchEvent('socketError', error);
   }
diff --git a/src/errors.ts b/src/errors.ts
@@ -3,8 +3,8 @@ export class ConnectionError extends Error {
 
   declare isTransient: boolean | undefined;
 
-  constructor(message: string, code?: string) {
-    super(message);
+  constructor(message: string, code?: string, options?: ErrorOptions) {
+    super(message, options);
 
     this.code = code;
   }
@@ -20,8 +20,8 @@ export class RequestError extends Error {
   declare procName: string | undefined;
   declare lineNumber: number | undefined;
 
-  constructor(message: string, code?: string) {
-    super(message);
+  constructor(message: string, code?: string, options?: ErrorOptions) {
+    super(message, options);
 
     this.code = code;
   }
diff --git a/src/request.ts b/src/request.ts
@@ -463,7 +463,7 @@ class Request extends EventEmitter {
       try {
         parameter.value = parameter.type.validate(parameter.value, collation);
       } catch (error: any) {
-        throw new RequestError('Validation failed for parameter \'' + parameter.name + '\'. ' + error.message, 'EPARAM');
+        throw new RequestError('Validation failed for parameter \'' + parameter.name + '\'. ' + error.message, 'EPARAM', { cause: error });
       }
     }
   }
diff --git a/test/integration/connection-test.js b/test/integration/connection-test.js
@@ -248,6 +248,10 @@ describe('Initiate Connect Test', function() {
       try {
         assert.instanceOf(err, ConnectionError);
         assert.strictEqual(/** @type {ConnectionError} */(err).code, 'ESOCKET');
+
+        assert.instanceOf(/** @type {ConnectionError} */(err).cause, Error);
+        assert.strictEqual(/** @type {Error} */(/** @type {ConnectionError} */(err).cause).message, 'getaddrinfo ENOTFOUND something.invalid');
+
         assert.strictEqual(connection.connectTimer, undefined);
         done();
       } catch (e) {
@@ -277,6 +281,10 @@ describe('Initiate Connect Test', function() {
     connection.on('connect', (err) => {
       assert.instanceOf(err, ConnectionError);
       assert.strictEqual(/** @type {ConnectionError} */(err).code, 'EINSTLOOKUP');
+
+      assert.instanceOf(/** @type {ConnectionError} */(err).cause, Error);
+      assert.strictEqual(/** @type {Error} */(/** @type {ConnectionError} */(err).cause).message, 'getaddrinfo ENOTFOUND something.invalid');
+
       assert.strictEqual(connection.connectTimer, undefined);
 
       done();
@@ -310,6 +318,10 @@ describe('Initiate Connect Test', function() {
     connection.connect(function(err) {
       assert.instanceOf(err, ConnectionError);
       assert.strictEqual(/** @type {ConnectionError} */(err).code, 'ESOCKET');
+
+      assert.instanceOf(/** @type {ConnectionError} */(err).cause, Error);
+      console.log(/** @type {ConnectionError} */(err).cause);
+      assert.include(/** @type {Error} */(/** @type {ConnectionError} */(err).cause).message, 'no ciphers available');
     });
 
     connection.on('end', function() {

Original file line number	Diff line number	Diff line change
`@@ -1963,7 +1963,7 @@ class Connection extends EventEmitter {`
`1963`	`1963`	`}`
`1964`	`1964`
`1965`	`1965`	`process.nextTick(() => {`
`1966`		`- this.emit('connect', new ConnectionError(err.message, 'EINSTLOOKUP'));`
	`1966`	`+ this.emit('connect', new ConnectionError(err.message, 'EINSTLOOKUP', { cause: err }));`
`1967`	`1967`	`});`
`1968`	`1968`	`});`
`1969`	`1969`	`}`
`@@ -2331,11 +2331,11 @@ class Connection extends EventEmitter {`
`2331`	`2331`	const routingMessage = this.routingData ? ` (redirected from ${this.config.server}${hostPostfix})` : '';
`2332`	`2332`	const message = `Failed to connect to ${server}${port}${routingMessage} - ${error.message}`;
`2333`	`2333`	`this.debug.log(message);`
`2334`		`- this.emit('connect', new ConnectionError(message, 'ESOCKET'));`
	`2334`	`+ this.emit('connect', new ConnectionError(message, 'ESOCKET', { cause: error }));`
`2335`	`2335`	`} else {`
`2336`	`2336`	const message = `Connection lost - ${error.message}`;
`2337`	`2337`	`this.debug.log(message);`
`2338`		`- this.emit('error', new ConnectionError(message, 'ESOCKET'));`
	`2338`	`+ this.emit('error', new ConnectionError(message, 'ESOCKET', { cause: error }));`
`2339`	`2339`	`}`
`2340`	`2340`	`this.dispatchEvent('socketError', error);`
`2341`	`2341`	`}`
Original file line number	Diff line number	Diff line change
`@@ -463,7 +463,7 @@ class Request extends EventEmitter {`
`463`	`463`	`try {`
`464`	`464`	`parameter.value = parameter.type.validate(parameter.value, collation);`
`465`	`465`	`} catch (error: any) {`
`466`		`- throw new RequestError('Validation failed for parameter \'' + parameter.name + '\'. ' + error.message, 'EPARAM');`
	`466`	`+ throw new RequestError('Validation failed for parameter \'' + parameter.name + '\'. ' + error.message, 'EPARAM', { cause: error });`
`467`	`467`	`}`
`468`	`468`	`}`
`469`	`469`	`}`