From fa78dd44004221145701cf3fcdf66d61ebbbce7e Mon Sep 17 00:00:00 2001 From: Dino Korah Date: Tue, 4 Aug 2020 12:09:20 +0100 Subject: [PATCH 1/3] Backport PsrLogMessageProcessor from master (2.x) --- .../Processor/PsrLogMessageProcessor.php | 37 +++++++++++++++++-- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/src/Monolog/Processor/PsrLogMessageProcessor.php b/src/Monolog/Processor/PsrLogMessageProcessor.php index 00885054..3d12522f 100644 --- a/src/Monolog/Processor/PsrLogMessageProcessor.php +++ b/src/Monolog/Processor/PsrLogMessageProcessor.php @@ -22,6 +22,24 @@ use Monolog\Utils; */ class PsrLogMessageProcessor implements ProcessorInterface { + const SIMPLE_DATE = "Y-m-d\TH:i:s.uP"; + + /** @var string|null */ + private $dateFormat; + + /** @var bool */ + private $removeUsedContextFields; + + /** + * @param string|null $dateFormat The format of the timestamp: one supported by DateTime::format + * @param bool $removeUsedContextFields If set to true the fields interpolated into message gets unset + */ + public function __construct($dateFormat = null, $removeUsedContextFields = false) + { + $this->dateFormat = $dateFormat; + $this->removeUsedContextFields = $removeUsedContextFields; + } + /** * @param array $record * @return array @@ -34,12 +52,25 @@ class PsrLogMessageProcessor implements ProcessorInterface $replacements = array(); foreach ($record['context'] as $key => $val) { + $placeholder = '{' . $key . '}'; + if (strpos($record['message'], $placeholder) === false) { + continue; + } + if (is_null($val) || is_scalar($val) || (is_object($val) && method_exists($val, "__toString"))) { - $replacements['{'.$key.'}'] = $val; + $replacements[$placeholder] = $val; + } elseif ($val instanceof \DateTime) { + $replacements[$placeholder] = $val->format($this->dateFormat ?: static::SIMPLE_DATE); } elseif (is_object($val)) { - $replacements['{'.$key.'}'] = '[object '.Utils::getClass($val).']'; + $replacements[$placeholder] = '[object '.Utils::getClass($val).']'; + } elseif (is_array($val)) { + $replacements[$placeholder] = 'array'.@json_encode($val); } else { - $replacements['{'.$key.'}'] = '['.gettype($val).']'; + $replacements[$placeholder] = '['.gettype($val).']'; + } + + if ($this->removeUsedContextFields) { + unset($record['context'][$key]); } } From a05c1a973289ac2a9e404329ad122fbca993367b Mon Sep 17 00:00:00 2001 From: Dino Korah Date: Tue, 4 Aug 2020 12:25:34 +0100 Subject: [PATCH 2/3] Fix broken unit tests --- .../Processor/PsrLogMessageProcessorTest.php | 35 ++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/tests/Monolog/Processor/PsrLogMessageProcessorTest.php b/tests/Monolog/Processor/PsrLogMessageProcessorTest.php index 029a0c02..957aebab 100644 --- a/tests/Monolog/Processor/PsrLogMessageProcessorTest.php +++ b/tests/Monolog/Processor/PsrLogMessageProcessorTest.php @@ -27,8 +27,37 @@ class PsrLogMessageProcessorTest extends \PHPUnit_Framework_TestCase $this->assertEquals($expected, $message['message']); } + public function testReplacementWithContextRemoval() + { + $proc = new PsrLogMessageProcessor($dateFormat = null, $removeUsedContextFields = true); + + $message = $proc(array( + 'message' => '{foo}', + 'context' => array('foo' => 'bar', 'lorem' => 'ipsum'), + )); + $this->assertSame('bar', $message['message']); + $this->assertSame(array('lorem' => 'ipsum'), $message['context']); + } + + public function testCustomDateFormat() + { + $format = "Y-m-d"; + $date = new \DateTime(); + + $proc = new PsrLogMessageProcessor($format); + + $message = $proc(array( + 'message' => '{foo}', + 'context' => array('foo' => $date), + )); + $this->assertEquals($date->format($format), $message['message']); + $this->assertSame(array('foo' => $date), $message['context']); + } + public function getPairs() { + $date = new \DateTime(); + return array( array('foo', 'foo'), array('3', '3'), @@ -36,8 +65,12 @@ class PsrLogMessageProcessorTest extends \PHPUnit_Framework_TestCase array(null, ''), array(true, '1'), array(false, ''), + array($date, $date->format(PsrLogMessageProcessor::SIMPLE_DATE)), array(new \stdClass, '[object stdClass]'), - array(array(), '[array]'), + array(array(), 'array[]'), + array(array(1, 2, 3), 'array[1,2,3]'), + array(array('foo' => 'bar'), 'array{"foo":"bar"}'), + array(stream_context_create(), '[resource]'), ); } } From e6e43ca09740d1159aa4f4784092ce8859713dbe Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Thu, 10 Dec 2020 09:57:10 +0100 Subject: [PATCH 3/3] Use Utils::jsonEncode to encode json correctly --- src/Monolog/Processor/PsrLogMessageProcessor.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Monolog/Processor/PsrLogMessageProcessor.php b/src/Monolog/Processor/PsrLogMessageProcessor.php index 3d12522f..a318af7e 100644 --- a/src/Monolog/Processor/PsrLogMessageProcessor.php +++ b/src/Monolog/Processor/PsrLogMessageProcessor.php @@ -64,7 +64,7 @@ class PsrLogMessageProcessor implements ProcessorInterface } elseif (is_object($val)) { $replacements[$placeholder] = '[object '.Utils::getClass($val).']'; } elseif (is_array($val)) { - $replacements[$placeholder] = 'array'.@json_encode($val); + $replacements[$placeholder] = 'array'.Utils::jsonEncode($val, null, true); } else { $replacements[$placeholder] = '['.gettype($val).']'; }