`void/log` serializes `Error` fields as `{}`, losing message and stack
メンテナーはふだん 1 日以内に返信
関連するプルリクエストがすでにマージされています。
- #583 @RaphaelFakhri による — マージ済み
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 75/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- typescript
- 領域
- backend
調査の方向性
まず、format() 内の既存の JSON.stringify 呼び出しを見つけ、logger のフィールドがどのように組み立てられ、テストでどのようにカバーされているかを確認します。ネストされたエラー、cause チェーン、status などのカスタムフィールドを含め、Error 値がどのようにシリアライズされるかを検証します。ログがこれらの詳細を保持しつつ、既存の payload 形式と循環参照時のフォールバックを維持できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
logger.error() is meant for surfacing caught errors (#168), but an Error passed as a field is logged as {}. Its message, stack and cause are non-enumerable, so JSON.stringify drops them. Nothing fails, so this goes unnoticed until someone needs the log.
Reproduction
[email protected] (same code on main):
import { logger } from 'void/log';
logger.error('save failed', { error: new Error('boom') });
// {"msg":"save failed","error":{}}
logger.error('save failed', { error: new Error('wrapped', { cause: new Error('inner') }) });
// {"msg":"save failed","error":{}}
class AppError extends Error {
status = 500;
}
logger.error('save failed', { error: new AppError('boom') });
// {"msg":"save failed","error":{"status":500}}
Expected
The error's details are kept, for example:
{"msg":"save failed","error":{"name":"Error","message":"boom","stack":"Error: boom\n at ..."}}
Suggested fix
Pass a replacer to the existing JSON.stringify call in format(). This also covers nested errors and cause chains, keeps custom enumerable fields such as status, and leaves the { msg, ...fields } shape unchanged:
function replacer(_key: string, value: unknown) {
if (value instanceof Error) {
return { ...value, name: value.name, message: value.message, stack: value.stack, cause: value.cause };
}
return value;
}
return JSON.stringify(payload, replacer);
The existing catch fallback still handles circular references.
If passing Error objects is intentionally unsupported, a note in the logger docs to pass error.message / error.stack as strings would help.
- 主要言語
- TypeScript
- スター
- 580
- フォーク
- 56
- 平均マージ
- 12時間 25分
- マージ済み PR(30日)
- 134
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
voidzero-dev/void のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 66/100
voidzero-dev/void#599 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 82/100
voidzero-dev/void#596 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 56/100
voidzero-dev/void#579 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
voidzero-dev/void#575 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
voidzero-dev/void#573 ·
メンテナーはふだん 1 日以内に返信
voidzero-dev/void の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
juice-shop/juice-shop#3706 ·
メンテナーはふだん 1 日以内に返信
-
sbx up from a subfolder silently pushes the whole work tree対応中かも @pdettori が今日担当しました。 オープンenhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
outline/outline#14348 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
bug needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信