fix ConsoleFormatter - call to a member function format() on string #31326
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ro0NL
reviewed
Apr 30, 2019
|
|
||
| namespace Symfony\Bridge\Monolog\Tests\Formatter; | ||
|
|
||
| use DateTime; |
There was a problem hiding this comment.
we dont use root classes :) should be prefixed with \
|
The failing tests seem unrelated, they're failing in other PRs too. |
ro0NL
approved these changes
Apr 30, 2019
OskarStark
approved these changes
Apr 30, 2019
fabpot
approved these changes
May 1, 2019
|
Thank you @keksa. |
fabpot
added a commit
that referenced
this pull request
May 1, 2019
…on string (keksa) This PR was merged into the 3.4 branch. Discussion ---------- fix ConsoleFormatter - call to a member function format() on string | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | maybe | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - The ConsoleFormatter crashes when there is not a DateTime object in `$record['datetime']`. As this parameter is not documented anywhere (i.e. `FormatterInterface` does not say it must be a DateTime object), I think the proper fix is to check if there is DateTimeInterface object and only call the `format` method then. We use a custom LogProcessor (https://symfony.com/doc/current/logging/processors.html) to add some extra data and format the DateTime in the `$record['datetime']`. We need to format the DateTime in the processor, because we use `JsonFormatter` in prod environment and it does not support changing the date format. We use `ConsoleFormatter` only in dev environment and as the processor is called before the formatter, we get the crash. There were no tests whatsoever for `ConsoleFormatter`, so I've added a basic one, that passes before and after, and another one that tests the crash (failed before, passed after). There is a theoretical BC break, as someone could have sent an object with a `format` method to the formatter and it would have worked, but I'm not sure if it's considered BC break by Symfony, please let me know, if it is. Commits ------- 6488328 fix ConsoleFormatter - call to a member function format() on string
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The ConsoleFormatter crashes when there is not a DateTime object in
$record['datetime']. As this parameter is not documented anywhere (i.e.FormatterInterfacedoes not say it must be a DateTime object), I think the proper fix is to check if there is DateTimeInterface object and only call theformatmethod then.We use a custom LogProcessor (https://symfony.com/doc/current/logging/processors.html) to add some extra data and format the DateTime in the
$record['datetime']. We need to format the DateTime in the processor, because we useJsonFormatterin prod environment and it does not support changing the date format. We useConsoleFormatteronly in dev environment and as the processor is called before the formatter, we get the crash.There were no tests whatsoever for
ConsoleFormatter, so I've added a basic one, that passes before and after, and another one that tests the crash (failed before, passed after).There is a theoretical BC break, as someone could have sent an object with a
formatmethod to the formatter and it would have worked, but I'm not sure if it's considered BC break by Symfony, please let me know, if it is.