[HttpKernel] Remove EOL when using error_log() in HttpKernel Logger

symfony · Oct 18, 2022 · abc1357 · abc1357
1 parent 5e94292
commit abc1357
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 9 deletions.
diff --git a/Log/Logger.php b/Log/Logger.php
@@ -44,10 +44,14 @@ public function __construct(string $minLevel = null, $output = null, callable $f
 
             if (isset($_ENV['SHELL_VERBOSITY']) || isset($_SERVER['SHELL_VERBOSITY'])) {
                 switch ((int) ($_ENV['SHELL_VERBOSITY'] ?? $_SERVER['SHELL_VERBOSITY'])) {
-                    case -1: $minLevel = LogLevel::ERROR; break;
-                    case 1: $minLevel = LogLevel::NOTICE; break;
-                    case 2: $minLevel = LogLevel::INFO; break;
-                    case 3: $minLevel = LogLevel::DEBUG; break;
+                    case -1: $minLevel = LogLevel::ERROR;
+                        break;
+                    case 1: $minLevel = LogLevel::NOTICE;
+                        break;
+                    case 2: $minLevel = LogLevel::INFO;
+                        break;
+                    case 3: $minLevel = LogLevel::DEBUG;
+                        break;
                 }
             }
         }
@@ -80,7 +84,7 @@ public function log($level, $message, array $context = [])
 
         $formatter = $this->formatter;
         if ($this->handle) {
-            @fwrite($this->handle, $formatter($level, $message, $context));
+            @fwrite($this->handle, $formatter($level, $message, $context).\PHP_EOL);
         } else {
             error_log($formatter($level, $message, $context, false));
         }
@@ -91,7 +95,7 @@ private function format(string $level, string $message, array $context, bool $pr
         if (str_contains($message, '{')) {
             $replacements = [];
             foreach ($context as $key => $val) {
-                if (null === $val || is_scalar($val) || (\is_object($val) && method_exists($val, '__toString'))) {
+                if (null === $val || \is_scalar($val) || (\is_object($val) && method_exists($val, '__toString'))) {
                     $replacements["{{$key}}"] = $val;
                 } elseif ($val instanceof \DateTimeInterface) {
                     $replacements["{{$key}}"] = $val->format(\DateTime::RFC3339);
@@ -105,7 +109,7 @@ private function format(string $level, string $message, array $context, bool $pr
             $message = strtr($message, $replacements);
         }
 
-        $log = sprintf('[%s] %s', $level, $message).\PHP_EOL;
+        $log = sprintf('[%s] %s', $level, $message);
         if ($prefixDate) {
             $log = date(\DateTime::RFC3339).' '.$log;
         }

diff --git a/Tests/Log/LoggerTest.php b/Tests/Log/LoggerTest.php
@@ -48,7 +48,7 @@ protected function tearDown(): void
     public static function assertLogsMatch(array $expected, array $given)
     {
         foreach ($given as $k => $line) {
-            self::assertThat(1 === preg_match('/[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[\+-][0-9]{2}:[0-9]{2} '.preg_quote($expected[$k]).'/', $line), self::isTrue(), "\"$line\" do not match expected pattern \"$expected[$k]\"");
+            self::assertSame(1, preg_match('/[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[\+-][0-9]{2}:[0-9]{2} '.preg_quote($expected[$k]).'/', $line), "\"$line\" do not match expected pattern \"$expected[$k]\"");
         }
     }
 
@@ -186,7 +186,7 @@ public function testContextExceptionKeyCanBeExceptionOrOtherValues()
     public function testFormatter()
     {
         $this->logger = new Logger(LogLevel::DEBUG, $this->tmpFile, function ($level, $message, $context) {
-            return json_encode(['level' => $level, 'message' => $message, 'context' => $context]).\PHP_EOL;
+            return json_encode(['level' => $level, 'message' => $message, 'context' => $context]);
         });
 
         $this->logger->error('An error', ['foo' => 'bar']);
@@ -196,6 +196,26 @@ public function testFormatter()
             '{"level":"warning","message":"A warning","context":{"baz":"bar"}}',
         ], $this->getLogs());
     }
+
+    public function testLogsWithoutOutput()
+    {
+        $oldErrorLog = ini_set('error_log', $this->tmpFile);
+
+        $logger = new Logger();
+        $logger->error('test');
+        $logger->critical('test');
+
+        $expected = [
+            '[error] test',
+            '[critical] test',
+        ];
+
+        foreach ($this->getLogs() as $k => $line) {
+            $this->assertSame(1, preg_match('/\[[\w\/\-: ]+\] '.preg_quote($expected[$k]).'/', $line), "\"$line\" do not match expected pattern \"$expected[$k]\"");
+        }
+
+        ini_set('error_log', $oldErrorLog);
+    }
 }
 
 class DummyTest