Make it possible to overwrite serializer string limit of 1024 (#559)

getsentry · Apr 20, 2018 · b2b6a4e · b2b6a4e
1 parent 625d5e5
commit b2b6a4e
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 3 deletions.
diff --git a/lib/Raven/Serializer.php b/lib/Raven/Serializer.php
@@ -45,14 +45,26 @@ class Raven_Serializer
      */
     protected $mb_detect_order = self::DEFAULT_MB_DETECT_ORDER;
 
+    /**
+     * The default maximum message lengths. Longer strings will be truncated
+     *
+     * @var int
+     */
+    protected $message_limit = Raven_Client::MESSAGE_LIMIT;
+
     /**
      * @param null|string $mb_detect_order
+     * @param null|int    $message_limit
      */
-    public function __construct($mb_detect_order = null)
+    public function __construct($mb_detect_order = null, $message_limit = null)
     {
         if ($mb_detect_order != null) {
             $this->mb_detect_order = $mb_detect_order;
         }
+
+        if ($message_limit != null) {
+            $this->message_limit = (int) $message_limit;
+        }
     }
 
     /**
@@ -93,8 +105,8 @@ protected function serializeString($value)
             }
         }
 
-        if (strlen($value) > 1024) {
-            $value = substr($value, 0, 1014) . ' {clipped}';
+        if (strlen($value) > $this->message_limit) {
+            $value = substr($value, 0, $this->message_limit - 10) . ' {clipped}';
         }
 
         return $value;
@@ -141,4 +153,22 @@ public function setMbDetectOrder($mb_detect_order)
 
         return $this;
     }
+
+    /**
+     * @return int
+     * @codeCoverageIgnore
+     */
+    public function getMessageLimit()
+    {
+        return $this->message_limit;
+    }
+
+    /**
+     * @param int $message_limit
+     * @codeCoverageIgnore
+     */
+    public function setMessageLimit($message_limit)
+    {
+        $this->message_limit = (int)$message_limit;
+    }
 }
diff --git a/test/Raven/Tests/SerializerTest.php b/test/Raven/Tests/SerializerTest.php
@@ -131,6 +131,26 @@ public function testLongString()
         }
     }
 
+    /**
+     * @covers Raven_Serializer::serializeString
+     */
+    public function testLongStringWithOverwrittenMessageLength()
+    {
+        $serializer = new Raven_Serializer();
+        $serializer->setMessageLimit(500);
+        for ($i = 0; $i < 100; $i++) {
+            foreach (array(100, 490, 499, 500, 501, 1000, 10000) as $length) {
+                $input = '';
+                for ($i = 0; $i < $length; $i++) {
+                    $input .= chr(mt_rand(0, 255));
+                }
+                $result = $serializer->serialize($input);
+                $this->assertInternalType('string', $result);
+                $this->assertLessThanOrEqual(500, strlen($result));
+            }
+        }
+    }
+
     /**
      * @covers Raven_Serializer::serializeValue
      */