errWithCause only serializes Error objects

[darcyrush]

Javascript can throw anything, not just Error objects. This includes primitives like strings and numbers;

try {
  throw 42; // completely valid
} catch (e) {
  throw new Error("Nested error", { cause: e });
}

The bundled lib.es2022.error.d.ts TypeScript typings indirectly hints at this;

interface Error {
    cause?: unknown;
}

As such, I believe this is unexpected;

const serialize = require("pino-std-serializers").errWithCause;
const serialized = serialize(new Error("Example", { cause: 42 }));
console.log(serialized.cause); // undefined

I would expect the cause to be populated with 42. Likewise I would expect it to be populated if a string was thrown, or whatever else is legal to be thrown in JavaScript, including objects that don't extend the JS Error class. Instead, the cause is simply lost.

This example may seem like a contrived edge case, but I have come across libraries that throw their own "Error" objects, that do not extend from the native JS Error class,

[jsumners]

Javascript can throw anything, not just Error objects. This includes primitives like strings and numbers;

That is true, but you should NOT do that. You should only throw instances of things that derive from Error.prototype. This library is designed with this principle in mind.

[darcyrush]

That is true, but you should NOT do that. You should only throw instances of things that derive from Error.prototype.

I completely agree, but best practices do not always translate to reality.

While we can enforce this in our own code, we have no way to enforce this in external npm libraries (or even in very old nodejs core code, potentially). Wrapping every single npm library in a try catch is not simply not feasible. The majority of errors that our projects deal with are thrown from npm libraries.

Given that JS allows this - regardless of how insane it is - i think pino serialization should account for this also.

[jsumners]

Would you like to send a Pull Request to address this issue? Remember to add unit tests.

[darcyrush]

Here is a PR with some questions as comments