Monday, June 3, 2024
 Popular · Latest · Hot · Upcoming
78
rated 0 times [  82] [ 4]  / answers: 1 / hits: 41248  / 7 Years ago, sun, march 12, 2017, 12:00:00

How can I rethrow an error or exception in nodejs/javascript and include a custom message.



I have the following code



var json = JSON.parse(result);


and I wanted to include the result content in the exception message should any parsing error occurs. Something like this.



1.  try {
2. var json = JSON.parse(result);
3. expect(json.messages.length).to.be(1);
4. } catch(ex) {
5. throw new Error(ex.message + . + JSON response: + result);
6. }


The problem here is that I lose my stack trace.



Is there a way to do it similar to java?



throw new Error(JSON response:  + result, ex);

More From » node.js

 Answers
3

ES2022 added the .cause non enumerable property to Error objects which can be set from the constructor


function doThing(){
try {
throw new Error('Internal Error')
}
catch (err) {
throw new Error('Do thing failed!', { cause: err })
}
}

try {
doThing()
}
catch (err) {
console.log('Error: ', err)
console.log('Cause: ', err.cause)
}

Supported in:


Chrome  > 93
Firefox > 91
Safari > 15
Node.js > v16.9.0

From the tc39 proposal, there is an es-shim Error implementation and how the cause property is set.


See Scotty Jamison's answer for more stack trace detail








Answer prior to 2022


I'm not aware of a native method like Java's and I've not found an elegant solution for wrapping errors yet.


The problem with creating a new Error is you can lose metadata that was attached to the original Error that was thrown, the stack trace and type are generally the important items lost.


Making modifications to an existing thrown error is quicker, but it is still possible to modify data from the error out of existence. It also feels wrong to be poking around in an error that was created somewhere else.




Create a new Error and new stack


The .stack property of a new Error is a plain string and can be modified to say what you like before it is thrown. Replacing an errors stack property completely can get really confusing for debugging though.


When the original thrown error and the error handler are in separate locations or files (which is common with promises), you might be able to trace the source of the original error but not trace the handler where the error was actually trapped. To avoid this it's good to keep some references to both the original and new error in the stack. It's also useful to have access to the complete original error if there was additional metadata stored in it.


Here's an example of catching an error, wrapping it in a new error but adding the original stack and storing the error:


try {
throw new Error('First one')
} catch (error) {
let e = new Error(`Rethrowing the "${error.message}" error`)
e.original_error = error
e.stack = e.stack.split('n').slice(0,2).join('n') + 'n' +
error.stack
throw e
}

Which throws:


/so/42754270/test.js:9
throw e
^

Error: Rethrowing the "First one" error
at test (/so/42754270/test.js:5:13)
Error: First one
at test (/so/42754270/test.js:3:11)
at Object.<anonymous> (/so/42754270/test.js:13:1)
at Module._compile (module.js:570:32)
at Object.Module._extensions..js (module.js:579:10)
at Module.load (module.js:487:32)
at tryModuleLoad (module.js:446:12)
at Function.Module._load (module.js:438:3)
at Module.runMain (module.js:604:10)
at run (bootstrap_node.js:394:7)
at startup (bootstrap_node.js:149:9)

So we've created a new generic Error. Unfortunately the type of the original error becomes hidden from the output but the error has been attached as .original_error so it can still be accessed. The new stack has been largely removed except for the generating line which is important, and the original errors stack appended.


Any tools that try to parse stack traces might not work with this change or best case, they detect two errors.


Rethrowing with ES2015+ Error Classes


Making this into a reusable ES2015+ Error class:


class RethrownError extends Error {
constructor(message, error){
super(message)
this.name = this.constructor.name
if (!error) throw new Error('RethrownError requires a message and error')
this.original_error = error
this.stack_before_rethrow = this.stack
const message_lines = (this.message.match(/n/g)||[]).length + 1
this.stack = this.stack.split('n').slice(0, message_lines+1).join('n') + 'n' +
error.stack
}
}

throw new RethrownError(`Oh no a "${error.message}" error`, error)

Results in


/so/42754270/test2.js:31
throw new RethrownError(`Oh no a "${error.message}"" error`, error)
^

RethrownError: Oh no a "First one" error
at test (/so/42754270/test2.js:31:11)
Error: First one
at test (/so/42754270/test2.js:29:11)
at Object.<anonymous> (/so/42754270/test2.js:35:1)
at Module._compile (module.js:570:32)
at Object.Module._extensions..js (module.js:579:10)
at Module.load (module.js:487:32)
at tryModuleLoad (module.js:446:12)
at Function.Module._load (module.js:438:3)
at Module.runMain (module.js:604:10)
at run (bootstrap_node.js:394:7)
at startup (bootstrap_node.js:149:9)

Then you know that whenever you see a RethrownError that the original error will still be available at .original_error.


This method is not perfect but it means I can re-type known errors from underlying modules into generic types that be handled more easily, usually with bluebirds filtered catch .catch(TypeError, handler)


Note stack becomes enumerable here


Same Error with a modified stack


Some times you will need to keep the original error mostly as is.


In this case you can just append/insert the new info onto existing stack.


file = '/home/jim/plumbers'
try {
JSON.parse('k')
} catch (e) {
let message = `JSON parse error in ${file}`
let stack = new Error(message).stack
e.stack = e.stack + 'nFrom previous ' + stack.split('n').slice(0,2).join('n') + 'n'
throw e
}

Which returns


/so/42754270/throw_error_replace_stack.js:13
throw e
^

SyntaxError: Unexpected token k in JSON at position 0
at Object.parse (native)
at Object.<anonymous> (/so/42754270/throw_error_replace_stack.js:8:13)
at Module._compile (module.js:570:32)
at Object.Module._extensions..js (module.js:579:10)
at Module.load (module.js:487:32)
at tryModuleLoad (module.js:446:12)
at Function.Module._load (module.js:438:3)
at Module.runMain (module.js:604:10)
at run (bootstrap_node.js:394:7)
at startup (bootstrap_node.js:149:9)
From previous Error: JSON parse error in "/home/jim/plumbers"
at Object.<anonymous> (/so/42754270/throw_error_replace_stack.js:11:20)

Also note that the stack processing is simple and assumes the error message is a single line. If you run into multi line error messages you might need to look for n at to terminate the message.


[#58579] Thursday, March 9, 2017, 7 Years  [reply] [flag answer]
Only authorized users can answer the question. Please sign in first, or register a free account.
annalise

Total Points: 210
Total Questions: 94
Total Answers: 102

Location: The Bahamas
Member since Tue, Apr 27, 2021
3 Years ago
annalise questions
Mon, May 24, 21, 00:00, 3 Years ago
Wed, May 5, 21, 00:00, 3 Years ago
Sat, Sep 12, 20, 00:00, 4 Years ago
Tue, Jul 28, 20, 00:00, 4 Years ago
;