Do not HTML entity encode in PlainTextErrorRenderer

The PlainTextErrorRenderer should not encode exception messages as that's not required for plain text in the same way that it is not required for the JsonErrorRenderer. Closes #3298
slimphp · May 1, 2024 · 9395e43 · 9395e43
1 parent 038fd57
commit 9395e43
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/Slim/Error/Renderers/PlainTextErrorRenderer.php b/Slim/Error/Renderers/PlainTextErrorRenderer.php
@@ -46,7 +46,7 @@ private function formatExceptionFragment(Throwable $exception): string
         /** @var int|string $code */
         $text .= sprintf("Code: %s\n", $code);
 
-        $text .= sprintf("Message: %s\n", htmlentities($exception->getMessage()));
+        $text .= sprintf("Message: %s\n", $exception->getMessage());
 
         $text .= sprintf("File: %s\n", $exception->getFile());
 

diff --git a/tests/Error/AbstractErrorRendererTest.php b/tests/Error/AbstractErrorRendererTest.php
@@ -202,19 +202,24 @@ public function testXMLErrorRendererRenderHttpException()
 
     public function testPlainTextErrorRendererFormatFragmentMethod()
     {
-        $exception = new Exception('Oops..', 500);
+        $message = 'Oops.. <br>';
+        $exception = new Exception($message, 500);
         $renderer = new PlainTextErrorRenderer();
         $reflectionRenderer = new ReflectionClass(PlainTextErrorRenderer::class);
 
         $method = $reflectionRenderer->getMethod('formatExceptionFragment');
         $method->setAccessible(true);
         $output = $method->invoke($renderer, $exception);
+        $this->assertIsString($output);
 
         $this->assertMatchesRegularExpression('/.*Type:*/', $output);
         $this->assertMatchesRegularExpression('/.*Code:*/', $output);
         $this->assertMatchesRegularExpression('/.*Message*/', $output);
         $this->assertMatchesRegularExpression('/.*File*/', $output);
         $this->assertMatchesRegularExpression('/.*Line*/', $output);
+
+        // ensure the renderer doesn't reformat the message
+        $this->assertMatchesRegularExpression("/.*$message/", $output);
     }
 
     public function testPlainTextErrorRendererDisplaysErrorDetails()