Node.js 12: undefinedを返す関数で、エラー時に付帯情報を返したい

Question

やりたいこと

既存の関数が、エラー時はundefinedを返すようになっています。
エラーになった原因が分からないので、原因を付帯情報として返すようにしたいです。
本来は例外を投げるかObjectを返すように仕様変更するのが筋なのでしょうが、この関数が既に複数箇所で使われており、できればundefinedを返すという仕様のまま、使う側の既存コードを修正せずに対応したいです。
良い方法はありますでしょうか？

試したこと

defineProperty で undefined や null にプロパティを定義できないかと試してみましたが、下記エラーになってしまいました。

> Object.defineProperty(undefined, 'message', { value: 42, writable: true })
Thrown:
TypeError: Object.defineProperty called on non-object
    at Function.defineProperty (<anonymous>)
> Object.defineProperty(null, 'message', { value: 42, writable: true })
Thrown:
TypeError: Object.defineProperty called on non-object
    at Function.defineProperty (<anonymous>)

Answer 1

例外を投げるかObjectを返すように仕様変更するのが筋なのでしょうが、

この関数が既に複数箇所で使われており

ループ内で呼ばれている関数には厳しいのですが、
ループは無関係なら console.trace() を活用してみてはいかがでしょうか。

NodeJS でも スタックトレースを表示させて、呼ばれた関数を遡ることができます。

Comments

[dameo]

Error.prototype.stackがそれっぽいオブジェクトだけど、文字列で環境にも依存しそうです。
node.jsだとそこを吸収してくれる
https://github.com/stacktracejs/stacktrace.js/
というのがあるようですね。
そうまでする必要があるのか知りませんが...

Answer 2

うーん、苦しいと思いますがこんな感じですかね。
JavaScriptは関数はオブジェクトの一種なので、プロパティを付属させることができます。

下記関数では、value が false のときに undefined を返し、
その時だけ、errorNameに文字列が格納されるようにしています。

function aaa(value) {
  aaa.errorName = ''
  if (value === false) {
    aaa.errorName = 'value is false'
    return;
  }
  return value;
};

console.log(aaa(1), aaa.errorName);
console.log(aaa('abc'), aaa.errorName);
console.log(aaa(true), aaa.errorName);
console.log(aaa(false), aaa.errorName);

// 実行結果
// 1 ''
// abc 
// true ''
// undefined 'value is false'