logger()->info([...]) throws a TypeError although the docs show array messages
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 42/100
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- PHP
- Estrellas
- 43
- Forks
- 22
- Merge medio
- 54 min
- PR fusionados (30 d)
- 57
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de quantum-php/framework
-
bug good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
quantum-php/framework#692 ·
Los mantenedores suelen responder en 1 día
-
routing testing
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
quantum-php/framework#547 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
quantum-php/framework#694 ·
Los mantenedores suelen responder en 1 día
-
Raise PHPStan to level 9Abiertorefactoring tech debt
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
quantum-php/framework#693 ·
Los mantenedores suelen responder en 1 día
-
install:debugbar reads the package folder from the working directory and uses the default storage adapterPosiblemente ocupada @armanist la tomó hoy. Abiertobug console debugbar good first issue
quantum-php/framework#691 · 1 asignado ·
Los mantenedores suelen responder en 1 día
Todos los issues de quantum-php/framework
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 70/100
ajeetraina/awesome-docker-sbx#559 ·
-
dependencies enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
novalo-dev/Prestashop-MCP-Server#329 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
Los mantenedores suelen responder en 1 día
-
bug origin:interactive status:available
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Ultimate-Multisite/ultimate-multisite#2131 ·
Los mantenedores suelen responder en 1 día
-
sync-en
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día