logger()->info([...]) throws a TypeError although the docs show array messages
Maintainer thường phản hồi trong vòng 1 ngày
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 42/100
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- Ngôn ngữ chính
- PHP
- Star
- 43
- Fork
- 22
- Merge trung bình
- 54 phút
- Pull request đã merge (30 ngày)
- 57
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của quantum-php/framework
-
bug good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
quantum-php/framework#692 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
routing testing
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
quantum-php/framework#547 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 72/100
quantum-php/framework#694 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Raise PHPStan to level 9Đang mởrefactoring tech debt
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
quantum-php/framework#693 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
install:debugbar reads the package folder from the working directory and uses the default storage adapterCó thể đã có người làm @armanist đã nhận hôm nay. Đang mởbug console debugbar good first issue
quantum-php/framework#691 · 1 người được giao ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của quantum-php/framework
Issue tương tự
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 70/100
ajeetraina/awesome-docker-sbx#559 ·
-
dependencies enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
novalo-dev/Prestashop-MCP-Server#329 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 80/100
Maintainer thường phản hồi trong vòng 1 ngày
-
bug origin:interactive status:available
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
Ultimate-Multisite/ultimate-multisite#2131 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
sync-en
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày