replace a not-existing virtual request stack with the real one

symfony · nicolas-grekas · Oct 26, 2023 · Oct 25, 2023 · Oct 26, 2023 · 99a0dba420137e42ad2ad7ce7cd8b18d4f8edf79
commit 99a0dba420137e42ad2ad7ce7cd8b18d4f8edf79
diff --git a/src/Symfony/Bundle/DebugBundle/DependencyInjection/Compiler/DumpDataCollectorPass.php b/src/Symfony/Bundle/DebugBundle/DependencyInjection/Compiler/DumpDataCollectorPass.php
@@ -14,6 +14,7 @@
 use Symfony\Bundle\WebProfilerBundle\EventListener\WebDebugToolbarListener;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;

 /**
 * Registers the file link format for the {@link \Symfony\Component\HttpKernel\DataCollector\DumpDataCollector}.
@@ -33,6 +34,10 @@ public function process(ContainerBuilder $container)

        $definition = $container->getDefinition('data_collector.dump');

+        if (!$container->has('.virtual_request_stack')) {
+            $definition->replaceArgument(3, new Reference('request_stack'));
+        }
+
        if (!$container->hasParameter('web_profiler.debug_toolbar.mode') || WebDebugToolbarListener::DISABLED === $container->getParameter('web_profiler.debug_toolbar.mode')) {
            $definition->replaceArgument(3, null);
        }

diff --git a/...mfony/Bundle/DebugBundle/Tests/DependencyInjection/Compiler/DumpDataCollectorPassTest.php b/...mfony/Bundle/DebugBundle/Tests/DependencyInjection/Compiler/DumpDataCollectorPassTest.php
@@ -16,6 +16,7 @@
 use Symfony\Bundle\WebProfilerBundle\EventListener\WebDebugToolbarListener;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpKernel\DataCollector\DumpDataCollector;

@@ -26,35 +27,51 @@ public function testProcessWithoutFileLinkFormatParameter()
        $container = new ContainerBuilder();
        $container->addCompilerPass(new DumpDataCollectorPass());

-        $definition = new Definition(DumpDataCollector::class, [null, null, null, null]);
+        $definition = new Definition(DumpDataCollector::class, [null, null, new Reference('.virtual_request_stack'), null]);
        $container->setDefinition('data_collector.dump', $definition);

        $container->compile();

        $this->assertNull($definition->getArgument(1));
    }

-    public function testProcessWithToolbarEnabled()
+    public function testProcessWithToolbarEnabledAndVirtualRequestStackPresent()
    {
        $container = new ContainerBuilder();
+        $container->register('request_stack', RequestStack::class);
+        $container->register('.virtual_request_stack', RequestStack::class);
        $container->addCompilerPass(new DumpDataCollectorPass());
-        $requestStack = new RequestStack();

-        $definition = new Definition(DumpDataCollector::class, [null, null, null, $requestStack]);
+        $definition = new Definition(DumpDataCollector::class, [null, null, null, new Reference('.virtual_request_stack')]);
        $container->setDefinition('data_collector.dump', $definition);
        $container->setParameter('web_profiler.debug_toolbar.mode', WebDebugToolbarListener::ENABLED);

        $container->compile();

-        $this->assertSame($requestStack, $definition->getArgument(3));
+        $this->assertEquals(new Reference('.virtual_request_stack'), $definition->getArgument(3));
+    }
+
+    public function testProcessWithToolbarEnabledAndVirtualRequestStackNotPresent()
+    {
+        $container = new ContainerBuilder();
+        $container->register('request_stack', RequestStack::class);
+        $container->addCompilerPass(new DumpDataCollectorPass());
+
+        $definition = new Definition(DumpDataCollector::class, [null, null, null, new Reference('.virtual_request_stack')]);
+        $container->setDefinition('data_collector.dump', $definition);
+        $container->setParameter('web_profiler.debug_toolbar.mode', WebDebugToolbarListener::ENABLED);
+
+        $container->compile();
+
+        $this->assertEquals(new Reference('request_stack'), $definition->getArgument(3));
    }

    public function testProcessWithToolbarDisabled()
    {
        $container = new ContainerBuilder();
        $container->addCompilerPass(new DumpDataCollectorPass());

-        $definition = new Definition(DumpDataCollector::class, [null, null, null, new RequestStack()]);
+        $definition = new Definition(DumpDataCollector::class, [null, null, new Reference('.virtual_request_stack'), new RequestStack()]);
        $container->setDefinition('data_collector.dump', $definition);
        $container->setParameter('web_profiler.debug_toolbar.mode', WebDebugToolbarListener::DISABLED);

@@ -68,7 +85,7 @@ public function testProcessWithoutToolbar()
        $container = new ContainerBuilder();
        $container->addCompilerPass(new DumpDataCollectorPass());

-        $definition = new Definition(DumpDataCollector::class, [null, null, null, new RequestStack()]);
+        $definition = new Definition(DumpDataCollector::class, [null, null, new Reference('.virtual_request_stack'), new RequestStack()]);
        $container->setDefinition('data_collector.dump', $definition);

        $container->compile();