bug #22961 [HttpKernel] Support unknown format in LoggerDataCollector (iltar)

fabpot · fabpot · commit e87994502c3c · 2017-05-31T11:00:08.000-07:00
This PR was merged into the 3.3 branch. Discussion ---------- [HttpKernel] Support unknown format in LoggerDataCollector | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #22952 | License | MIT | Doc PR | ~ The new expected format for the compiler log is `CompilerPassClass: Message`. However, this is not enforced by the old logging method as seen in schmittjoh/JMSDiExtraBundle#276 This PR adds the ability to read those lines without crashing with `Uncaught Notice: Undefined offset: 1`. Please note that I have not tested this in an application so testers are welcome to confirm this fix! Commits ------- a8dfbb1 Support unknown compiler log format
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/LoggerDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/LoggerDataCollector.php
@@ -138,6 +138,9 @@ private function getContainerCompilerLogs()
         $logs = array();
         foreach (file($file, FILE_IGNORE_NEW_LINES) as $log) {
             $log = explode(': ', $log, 2);
+            if (!isset($log[1]) || !preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+(?:\\\\[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+)++$/', $log[0])) {
+                $log = array('Unknown Compiler Pass', implode(': ', $log));
+            }
 
             $logs[$log[0]][] = array('message' => $log[1]);
         }
diff --git a/src/Symfony/Component/HttpKernel/Tests/DataCollector/Compiler.log b/src/Symfony/Component/HttpKernel/Tests/DataCollector/Compiler.log
@@ -0,0 +1,4 @@
+Symfony\Component\DependencyInjection\Compiler\RemovePrivateAliasesPass: Removed service "Psr\Container\ContainerInterface"; reason: private alias.
+Symfony\Component\DependencyInjection\Compiler\RemovePrivateAliasesPass: Removed service "Symfony\Component\DependencyInjection\ContainerInterface"; reason: private alias.
+Some custom logging message
+With ending :
diff --git a/src/Symfony/Component/HttpKernel/Tests/DataCollector/LoggerDataCollectorTest.php b/src/Symfony/Component/HttpKernel/Tests/DataCollector/LoggerDataCollectorTest.php
@@ -17,6 +17,27 @@
 
 class LoggerDataCollectorTest extends TestCase
 {
+    public function testCollectWithUnexpectedFormat()
+    {
+        $logger = $this->getMockBuilder('Symfony\Component\HttpKernel\Log\DebugLoggerInterface')->getMock();
+        $logger->expects($this->once())->method('countErrors')->will($this->returnValue('foo'));
+        $logger->expects($this->exactly(2))->method('getLogs')->will($this->returnValue(array()));
+
+        $c = new LoggerDataCollector($logger, __DIR__.'/');
+        $c->lateCollect();
+        $compilerLogs = $c->getCompilerLogs()->getValue('message');
+
+        $this->assertSame(array(
+            array('message' => 'Removed service "Psr\Container\ContainerInterface"; reason: private alias.'),
+            array('message' => 'Removed service "Symfony\Component\DependencyInjection\ContainerInterface"; reason: private alias.'),
+        ), $compilerLogs['Symfony\Component\DependencyInjection\Compiler\RemovePrivateAliasesPass']);
+
+        $this->assertSame(array(
+            array('message' => 'Some custom logging message'),
+            array('message' => 'With ending :'),
+        ), $compilerLogs['Unknown Compiler Pass']);
+    }
+
     /**
      * @dataProvider getCollectTestData
      */

Original file line number	Diff line number	Diff line change
`@@ -138,6 +138,9 @@ private function getContainerCompilerLogs()`
`138`	`138`	`$logs = array();`
`139`	`139`	`foreach (file($file, FILE_IGNORE_NEW_LINES) as $log) {`
`140`	`140`	`$log = explode(': ', $log, 2);`
	`141`	`+ if (!isset($log[1]) \|\| !preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]+(?:\\\\[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]+)++$/', $log[0])) {`
	`142`	`+ $log = array('Unknown Compiler Pass', implode(': ', $log));`
	`143`	`+ }`
`141`	`144`
`142`	`145`	`$logs[$log[0]][] = array('message' => $log[1]);`
`143`	`146`	`}`