From 5d5da57b81f9ac2a71b914b9e05c7e22bfecb920 Mon Sep 17 00:00:00 2001
From: Jonathan Plantey <jonathan.plantey@gmail.com>
Date: Mon, 11 Nov 2024 15:34:03 +0100
Subject: [PATCH] Normalize call normalizeRecord if necessary (#1906)

* Normalize call normalizeRecord if necessary

* Update patch to always go through format()

* Update JsonFormatterTest.php

* Fix implementation

* Fix test expectations

* Update JsonFormatter.php

---------

Co-authored-by: Jordi Boggiano <j.boggiano@seld.be>
---
 src/Monolog/Formatter/JsonFormatter.php       | 46 ++++++++++++-------
 tests/Monolog/Formatter/JsonFormatterTest.php |  3 +-
 2 files changed, 31 insertions(+), 18 deletions(-)

diff --git a/src/Monolog/Formatter/JsonFormatter.php b/src/Monolog/Formatter/JsonFormatter.php
index f5a68a440..4eee4fbcb 100644
--- a/src/Monolog/Formatter/JsonFormatter.php
+++ b/src/Monolog/Formatter/JsonFormatter.php
@@ -74,22 +74,7 @@ public function isAppendingNewlines(): bool
      */
     public function format(LogRecord $record): string
     {
-        $normalized = parent::format($record);
-
-        if (isset($normalized['context']) && $normalized['context'] === []) {
-            if ($this->ignoreEmptyContextAndExtra) {
-                unset($normalized['context']);
-            } else {
-                $normalized['context'] = new \stdClass;
-            }
-        }
-        if (isset($normalized['extra']) && $normalized['extra'] === []) {
-            if ($this->ignoreEmptyContextAndExtra) {
-                unset($normalized['extra']);
-            } else {
-                $normalized['extra'] = new \stdClass;
-            }
-        }
+        $normalized = $this->normalizeRecord($record);
 
         return $this->toJson($normalized, true) . ($this->appendNewline ? "\n" : '');
     }
@@ -115,6 +100,31 @@ public function includeStacktraces(bool $include = true): self
         return $this;
     }
 
+    /**
+     * @return array<array|bool|float|int|stdClass|string|null>
+     */
+    protected function normalizeRecord(LogRecord $record): array
+    {
+        $normalized = parent::normalizeRecord($record);
+
+        if (isset($normalized['context']) && $normalized['context'] === []) {
+            if ($this->ignoreEmptyContextAndExtra) {
+                unset($normalized['context']);
+            } else {
+                $normalized['context'] = new \stdClass;
+            }
+        }
+        if (isset($normalized['extra']) && $normalized['extra'] === []) {
+            if ($this->ignoreEmptyContextAndExtra) {
+                unset($normalized['extra']);
+            } else {
+                $normalized['extra'] = new \stdClass;
+            }
+        }
+
+        return $normalized;
+    }
+
     /**
      * Return a JSON-encoded array of records.
      *
@@ -122,7 +132,9 @@ public function includeStacktraces(bool $include = true): self
      */
     protected function formatBatchJson(array $records): string
     {
-        return $this->toJson($this->normalize($records), true);
+        $formatted = array_map(fn (LogRecord $record) => $this->normalizeRecord($record), $records);
+
+        return $this->toJson($formatted, true);
     }
 
     /**
diff --git a/tests/Monolog/Formatter/JsonFormatterTest.php b/tests/Monolog/Formatter/JsonFormatterTest.php
index 9ce91c696..3e1cee28c 100644
--- a/tests/Monolog/Formatter/JsonFormatterTest.php
+++ b/tests/Monolog/Formatter/JsonFormatterTest.php
@@ -89,7 +89,8 @@ public function testFormatBatch()
             $this->getRecord(Level::Warning),
             $this->getRecord(Level::Debug),
         ];
-        $this->assertEquals(json_encode($records), $formatter->formatBatch($records));
+        $expected = array_map(fn (LogRecord $record) => json_encode($record->toArray(), JSON_FORCE_OBJECT), $records);
+        $this->assertEquals('['.implode(',', $expected).']', $formatter->formatBatch($records));
     }
 
     /**