BAP-14658: LoggerDataCollector called over 500k times in dev mode (#1…

…1598)

- added local cache for a logger collector
- overwrite symfony`s data_collector.logger class
- added tests

src/Oro/Bundle/LoggerBundle/DataCollector/LoggerDataCollector.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Oro\Bundle\LoggerBundle\DataCollector;
+
+use Symfony\Component\HttpKernel\DataCollector\LoggerDataCollector as BaseDataCollector;
+
+class LoggerDataCollector extends BaseDataCollector
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function lateCollect()
+    {
+        // On event kernel.terminate ProfilerListener save profile for each sub-request and calls method lateCollect,
+        // but sets of logs for each sub-request and master-requests are same,
+        // so here added local caching to prevent work on the same data and fix performance in dev mode
+        static $localCache;
+
+        if ($localCache === null) {
+            parent::lateCollect();
+            $localCache = $this->data;
+        } else {
+            $this->data = $localCache;
+        }
+    }
+}

src/Oro/Bundle/LoggerBundle/DependencyInjection/Compiler/LoggerCollectorPass.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Oro\Bundle\LoggerBundle\DependencyInjection\Compiler;
+
+use Oro\Bundle\LoggerBundle\DataCollector\LoggerDataCollector;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class LoggerCollectorPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if ($container->hasDefinition('data_collector.logger')) {
+            $definition = $container->getDefinition('data_collector.logger');
+            $definition->setClass(LoggerDataCollector::class);
+        }
+    }
+}

src/Oro/Bundle/LoggerBundle/OroLoggerBundle.php

@@ -2,6 +2,7 @@
 
 namespace Oro\Bundle\LoggerBundle;
 
+use Oro\Bundle\LoggerBundle\DependencyInjection\Compiler\LoggerCollectorPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -19,5 +20,6 @@ public function build(ContainerBuilder $container)
 
         $container->addCompilerPass(new DetailedLogsHandlerPass());
         $container->addCompilerPass(new SwiftMailerHandlerPass());
+        $container->addCompilerPass(new LoggerCollectorPass());
     }
 }

src/Oro/Bundle/LoggerBundle/Tests/Unit/DataCollector/LoggerDataCollectorTest.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Oro\Bundle\LoggerBundle\Tests\Unit\DataCollector;
+
+use Oro\Bundle\LoggerBundle\DataCollector\LoggerDataCollector;
+use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
+
+class LoggerDataCollectorTest extends \PHPUnit_Framework_TestCase
+{
+    public function testLateCollect()
+    {
+        $logger = $this->createMock(DebugLoggerInterface::class);
+        $logger->expects($this->once())
+            ->method('countErrors');
+        $logger->expects($this->any())
+            ->method('getLogs')
+            ->willReturn([]);
+
+        $collector = new LoggerDataCollector($logger);
+        $collector->lateCollect();
+        $collector->lateCollect();
+    }
+}

src/Oro/Bundle/LoggerBundle/Tests/Unit/DependencyInjection/Compiler/LoggerCollectorPassTest.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Oro\Bundle\LoggerBundle\Tests\Unit\DependencyInjection\Compiler;
+
+use Oro\Bundle\LoggerBundle\DependencyInjection\Compiler\LoggerCollectorPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+
+class LoggerCollectorPassTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var LoggerCollectorPass
+     */
+    protected $compilerPass;
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function setUp()
+    {
+        $this->compilerPass = new LoggerCollectorPass();
+    }
+
+    public function testProcessWhenServiceNotExist()
+    {
+        /** @var \PHPUnit_Framework_MockObject_MockObject|ContainerBuilder $containerBuilder */
+        $containerBuilder = $this->createMock(ContainerBuilder::class);
+        $containerBuilder->expects($this->any())
+            ->method('hasDefinition')
+            ->with('data_collector.logger')
+            ->willReturn(false);
+        $containerBuilder->expects($this->never())->method('getDefinition');
+
+        $this->compilerPass->process($containerBuilder);
+    }
+
+    public function testProcessWhenServiceExist()
+    {
+        /** @var \PHPUnit_Framework_MockObject_MockObject|ContainerBuilder $containerBuilder */
+        $containerBuilder = $this->createMock(ContainerBuilder::class);
+        $containerBuilder->expects($this->any())
+            ->method('hasDefinition')
+            ->with('data_collector.logger')
+            ->willReturn(true);
+        $containerBuilder->expects($this->once())
+            ->method('getDefinition')
+            ->willReturn(new Definition());
+
+        $this->compilerPass->process($containerBuilder);
+    }
+}