logger()->info([...]) throws a TypeError although the docs show array messages
メンテナーはふだん 1 日以内に返信
評価
調査の方向性
Read Logger::log(), the nine level methods, ReportableInterface::report(), and LoggerTrait::report() to trace where the array is rejected; compare that behavior with packages/logger/usage.md, packages/logger/adapters.md, architecture.md, and packages/logger/helpers.md. The issue leaves two incompatible approaches open, so first clarify which behavior should be supported. Done means the chosen behavior and docs agree, the corresponding file-adapter test passes, and the listed checks pass on PHP 8.1–8.3 with a changelog entry.
索引モデルが issue の本文から書いたものです。
説明
Summary
Passing an array to a Logger method throws a TypeError, but the Logger docs describe array messages as a supported way to log structured data.
What happens
logger()->info(['order' => 1042, 'status' => 'paid']);
TypeError: Quantum\Logger\Logger::info(): Argument #1 ($message) must be of type Stringable|string, array given
I reproduced it on 3.1.0 with a stub adapter. Before 3.1 the Logger methods had no parameter type, but ReportableInterface::report() already required string|Stringable, so the same call could not have worked there either.
What the docs say
packages/logger/usage.md, "Log a structured payload": the example callslogger()->info([...]).packages/logger/adapters.mdandarchitecture.md: "If you pass an array message, the package JSON-encodes it with pretty printing before writing."packages/logger/helpers.md: uselogger()for "structured array messages".
Cause
Logger::log()and the nine level methods takestring|Stringable $message, and so doesReportableInterface::report().LoggerTrait::report()still containsis_array($message) ? json_encode($message, JSON_PRETTY_PRINT) : (string) $message. That branch can never run, because the parameter type rejects an array first.LoggerimplementsPsr\Log\LoggerInterface, where the message isstring|Stringable. PSR-3 puts structured data in$context, but the docs state that no context rendering happens ("No placeholder interpolation or structured context rendering happens").
Options
- Accept arrays. Widen the message type to
string|Stringable|arrayonLoggerandReportableInterface::report(), so the existing JSON branch works. PHP allows widening a parameter type in an override, so the PSR-3 interface still holds. This keeps the docs as they are. - Keep the PSR-3 shape. Remove the array promises from the docs and the dead branch from
LoggerTrait, and decide how structured data should be written, for example by rendering$contextin the file adapters.
Acceptance criteria
- the behavior and the docs agree, whichever option is chosen
- a test logs an array through
logger()with a file adapter and checks what is written (option 1), or a test checks that the chosen alternative works (option 2) composer test,composer cs:check,composer phpstanandcomposer rector:checkpass on PHP 8.1 to 8.3- the changelog lists the change
- 主要言語
- PHP
- スター
- 43
- フォーク
- 22
- 平均マージ
- 54分
- マージ済み PR(30日)
- 57
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
quantum-php/framework のほかの issue
-
bug good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
quantum-php/framework#692 ·
メンテナーはふだん 1 日以内に返信
-
routing testing
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
quantum-php/framework#547 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
quantum-php/framework#694 ·
メンテナーはふだん 1 日以内に返信
-
refactoring tech debt
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
quantum-php/framework#693 ·
メンテナーはふだん 1 日以内に返信
-
install:debugbar reads the package folder from the working directory and uses the default storage adapter対応中かも @armanist が今日担当しました。 オープンbug console debugbar good first issue
quantum-php/framework#691 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
quantum-php/framework の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 70/100
ajeetraina/awesome-docker-sbx#559 ·
-
dependencies enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
novalo-dev/Prestashop-MCP-Server#329 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
メンテナーはふだん 1 日以内に返信
-
bug origin:interactive status:available
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
Ultimate-Multisite/ultimate-multisite#2131 ·
メンテナーはふだん 1 日以内に返信
-
sync-en
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信