feat(view): remove empty slots in production (#950)

brendt · web-flow · commit 64b1ff096767 · 2025-03-05T06:52:56.000+01:00
diff --git a/src/Tempest/View/src/Elements/ElementFactory.php b/src/Tempest/View/src/Elements/ElementFactory.php
@@ -10,6 +10,7 @@
 use Dom\Node;
 use Dom\Text;
 use Tempest\Container\Container;
+use Tempest\Core\AppConfig;
 use Tempest\View\Element;
 use Tempest\View\Renderers\TempestViewCompiler;
 use Tempest\View\ViewComponent;
@@ -21,6 +22,7 @@ final class ElementFactory
     private TempestViewCompiler $compiler;
 
     public function __construct(
+        private readonly AppConfig $appConfig,
         private readonly ViewConfig $viewConfig,
         private readonly Container $container,
     ) {}
@@ -97,9 +99,10 @@ private function makeElement(Node $node, ?Element $parent): ?Element
             }
 
             $element = new ViewComponentElement(
-                $this->compiler,
-                $viewComponentClass,
-                $attributes,
+                environment: $this->appConfig->environment,
+                compiler: $this->compiler,
+                viewComponent: $viewComponentClass,
+                attributes: $attributes,
             );
         } elseif ($tagName === 'x-template') {
             $element = new TemplateElement(
diff --git a/src/Tempest/View/src/Elements/ViewComponentElement.php b/src/Tempest/View/src/Elements/ViewComponentElement.php
@@ -4,6 +4,7 @@
 
 namespace Tempest\View\Elements;
 
+use Tempest\Core\Environment;
 use Tempest\View\Element;
 use Tempest\View\Renderers\TempestViewCompiler;
 use Tempest\View\Slot;
@@ -16,6 +17,7 @@ final class ViewComponentElement implements Element
     use IsElement;
 
     public function __construct(
+        private readonly Environment $environment,
         private readonly TempestViewCompiler $compiler,
         private readonly ViewComponent $viewComponent,
         array $attributes,
@@ -106,7 +108,7 @@ public function compile(): string
                     if ($slot === null) {
                         // A slot doesn't have any content, so we'll comment it out.
                         // This is to prevent DOM parsing errors (slots in <head> tags is one example, see #937)
-                        return '<!--' . $matches[0] . '-->';
+                        return $this->environment->isProduction() ? '' : '<!--' . $matches[0] . '-->';
                     }
 
                     return $slot->compile();
diff --git a/tests/Integration/View/ViewComponentTest.php b/tests/Integration/View/ViewComponentTest.php
@@ -6,6 +6,8 @@
 
 use Generator;
 use PHPUnit\Framework\Attributes\DataProvider;
+use Tempest\Core\AppConfig;
+use Tempest\Core\Environment;
 use Tempest\Router\Session\Session;
 use Tempest\Validation\Rules\AlphaNumeric;
 use Tempest\Validation\Rules\Between;
@@ -503,4 +505,27 @@ public function test_empty_slots_are_commented_out(): void
         <html lang="en"><head><!--<x-slot name="styles" ></x-slot>--><link rel="stylesheet" href="#"></link></head></html>
         HTML, $html);
     }
+
+    public function test_empty_slots_are_removed_in_production(): void
+    {
+        $this->container->get(AppConfig::class)->environment = Environment::PRODUCTION;
+
+        $this->registerViewComponent('x-layout', <<<'HTML'
+        <html lang="en">
+        <head>
+            <x-slot name="styles" />
+            <link rel="stylesheet" href="#" />
+        </head>
+        </html>
+        HTML);
+
+        $html = $this->render(<<<'HTML'
+        <x-layout>
+        </x-layout>
+        HTML);
+
+        $this->assertStringEqualsStringIgnoringLineEndings(<<<'HTML'
+        <html lang="en"><head><link rel="stylesheet" href="#"></link></head></html>
+        HTML, $html);
+    }
 }
