Normalization of arrays containing self references (#1050)

Backport normalization fix from master to 1.x

Author: deviantintegral

src/Monolog/Formatter/JsonFormatter.php

@@ -138,8 +138,12 @@ protected function formatBatchNewlines(array $records)
      *
      * @return mixed
      */
-    protected function normalize($data)
+    protected function normalize($data, $depth = 0)
     {
+        if ($depth > 9) {
+            return 'Over 9 levels deep, aborting normalization';
+        }
+
         if (is_array($data) || $data instanceof \Traversable) {
             $normalized = array();
 
@@ -150,7 +154,7 @@ protected function normalize($data)
                     break;
                 }
 
-                $normalized[$key] = $this->normalize($value);
+                $normalized[$key] = $this->normalize($value, $depth+1);
             }
 
             return $normalized;

src/Monolog/Formatter/NormalizerFormatter.php

@@ -55,8 +55,12 @@ public function formatBatch(array $records)
         return $records;
     }
 
-    protected function normalize($data)
+    protected function normalize($data, $depth = 0)
     {
+        if ($depth > 9) {
+            return 'Over 9 levels deep, aborting normalization';
+        }
+
         if (null === $data || is_scalar($data)) {
             if (is_float($data)) {
                 if (is_infinite($data)) {
@@ -80,7 +84,7 @@ protected function normalize($data)
                     break;
                 }
 
-                $normalized[$key] = $this->normalize($value);
+                $normalized[$key] = $this->normalize($value, $depth+1);
             }
 
             return $normalized;

src/Monolog/Formatter/WildfireFormatter.php

@@ -102,12 +102,12 @@ public function formatBatch(array $records)
         throw new \BadMethodCallException('Batch formatting does not make sense for the WildfireFormatter');
     }
 
-    protected function normalize($data)
+    protected function normalize($data, $depth = 0)
     {
         if (is_object($data) && !$data instanceof \DateTime) {
             return $data;
         }
 
-        return parent::normalize($data);
+        return parent::normalize($data, $depth);
     }
 }

tests/Monolog/Formatter/NormalizerFormatterTest.php

@@ -193,6 +193,15 @@ public function testIgnoresRecursiveObjectReferences()
         $this->assertEquals(@json_encode(array($foo, $bar)), $res);
     }
 
+    public function testCanNormalizeReferences()
+    {
+        $formatter = new NormalizerFormatter();
+        $x = array('foo' => 'bar');
+        $y = array('x' => &$x);
+        $x['y'] = &$y;
+        $formatter->format($y);
+    }
+
     public function testIgnoresInvalidTypes()
     {
         // set up the recursion