Adding a way to return ALL CSS and JS files - i.e. disable returned file tracking

Author: weaverryan

src/Asset/EntrypointLookup.php

@@ -33,6 +33,8 @@ class EntrypointLookup implements EntrypointLookupInterface, IntegrityDataProvid
 
     private $strictMode;
 
+    private $trackReturnedFiles = true;
+
     public function __construct(string $entrypointJsonPath, CacheItemPoolInterface $cache = null, string $cacheKey = null, bool $strictMode = true)
     {
         $this->entrypointJsonPath = $entrypointJsonPath;
@@ -70,6 +72,18 @@ public function reset()
         $this->returnedFiles = [];
     }
 
+    /**
+     * Can be used to disable file tracking.
+     *
+     * When file tracking is disabled, *all* CSS and JS files will be
+     * returned from getJavaScriptFiles() and getCssFiles() including
+     * those that were previously returned.
+     */
+    public function enableReturnedFileTracking(bool $shouldTrackReturnedFiles)
+    {
+        $this->trackReturnedFiles = $shouldTrackReturnedFiles;
+    }
+
     private function getEntryFiles(string $entryName, string $key): array
     {
         $this->validateEntryName($entryName);
@@ -81,8 +95,14 @@ private function getEntryFiles(string $entryName, string $key): array
             return [];
         }
 
-        // make sure to not return the same file multiple times
         $entryFiles = $entryData[$key];
+
+        // if tracking is disabled, return everything & do not mutate returnedFiles list
+        if (!$this->trackReturnedFiles) {
+            return $entryFiles;
+        }
+
+        // make sure to not return the same file multiple times
         $newFiles = array_values(array_diff($entryFiles, $this->returnedFiles));
         $this->returnedFiles = array_merge($this->returnedFiles, $newFiles);
 

src/Twig/EntryFilesTwigExtension.php

@@ -10,6 +10,7 @@
 namespace Symfony\WebpackEncoreBundle\Twig;
 
 use Psr\Container\ContainerInterface;
+use Symfony\WebpackEncoreBundle\Asset\EntrypointLookup;
 use Symfony\WebpackEncoreBundle\Asset\EntrypointLookupInterface;
 use Symfony\WebpackEncoreBundle\Asset\TagRenderer;
 use Twig\Extension\AbstractExtension;
@@ -31,6 +32,8 @@ public function getFunctions()
             new TwigFunction('encore_entry_css_files', [$this, 'getWebpackCssFiles']),
             new TwigFunction('encore_entry_script_tags', [$this, 'renderWebpackScriptTags'], ['is_safe' => ['html']]),
             new TwigFunction('encore_entry_link_tags', [$this, 'renderWebpackLinkTags'], ['is_safe' => ['html']]),
+            new TwigFunction('encore_disable_file_tracking', [$this, 'disableReturnedFileTracking']),
+            new TwigFunction('encore_enable_file_tracking', [$this, 'enableReturnedFileTracking']),
         ];
     }
 
@@ -58,6 +61,27 @@ public function renderWebpackLinkTags(string $entryName, string $packageName = n
             ->renderWebpackLinkTags($entryName, $packageName, $entrypointName);
     }
 
+    public function disableReturnedFileTracking(string $entrypointName = '_default')
+    {
+        $this->changeReturnedFileTracking(false, $entrypointName);
+    }
+
+    public function enableReturnedFileTracking(string $entrypointName = '_default')
+    {
+        $this->changeReturnedFileTracking(true, $entrypointName);
+    }
+
+    private function changeReturnedFileTracking(bool $isEnabled, string $entrypointName)
+    {
+        $lookup = $this->getEntrypointLookup($entrypointName);
+
+        if (!$lookup instanceof EntrypointLookup) {
+            throw new \LogicException('In order to use encore_disable_returned_file_tracking/encore_enable_returned_file_tracking, the EntrypointLookupInterface must be an instance of EntrypointLookup.');
+        }
+
+        $lookup->enableReturnedFileTracking($isEnabled);
+    }
+
     private function getEntrypointLookup(string $entrypointName): EntrypointLookupInterface
     {
         return $this->container->get('webpack_encore.entrypoint_lookup_collection')

tests/Asset/EntrypointLookupTest.php

@@ -87,6 +87,33 @@ public function testGetJavaScriptFilesReturnsUniqueFilesOnly()
         );
     }
 
+    public function testGetJavaScriptFilesWithFileTrackingDisabled()
+    {
+        // with file tracking on, grab a few files
+        $this->entrypointLookup->getJavaScriptFiles('my_entry');
+
+        $this->entrypointLookup->enableReturnedFileTracking(false);
+        $this->assertEquals(
+            ['file1.js', 'file3.js'],
+            $this->entrypointLookup->getJavaScriptFiles('other_entry'),
+            'file1.js is returned even though it was also returned above',
+        );
+
+        $this->assertEquals(
+            // file1.js is returned even though it was also returned above
+            ['file1.js', 'file3.js'],
+            $this->entrypointLookup->getJavaScriptFiles('other_entry'),
+            'repeat calls always return all the files'
+        );
+
+        $this->entrypointLookup->enableReturnedFileTracking(true);
+        $this->assertEquals(
+            ['file3.js'],
+            $this->entrypointLookup->getJavaScriptFiles('other_entry'),
+            'file1.js is not returned once tracking is re-enabled'
+        );
+    }
+
     public function testGetCssFiles()
     {
         $this->assertEquals(

tests/EventListener/ExceptionListenerTest.php

@@ -10,6 +10,7 @@
 namespace Symfony\WebpackEncoreBundle\Tests\EventListener;
 
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use PHPUnit\Framework\TestCase;
@@ -39,7 +40,8 @@ public function testItResetsAllEntrypointLookups()
 
         $request = new Request();
         $exception = new \Exception();
-        $event = new GetResponseForExceptionEvent(
+        $exceptionClass = class_exists(ExceptionEvent::class) ? ExceptionEvent::class : GetResponseForExceptionEvent::class;
+        $event = new $exceptionClass(
             $this->createMock(HttpKernelInterface::class),
             $request,
             HttpKernelInterface::MASTER_REQUEST,

tests/IntegrationTest.php

@@ -69,6 +69,22 @@ public function testTwigIntegration()
         );
     }
 
+    public function testTwigIntegrationWithTrackingDisabled()
+    {
+        $kernel = new WebpackEncoreIntegrationTestKernel(true);
+        $kernel->boot();
+        $container = $kernel->getContainer();
+
+        $html = $container->get('twig')->render('@integration_test/template_disable_tracking.twig');
+
+        $this->assertStringContainsStringCount(
+            '/build/file1.js',
+            $html,
+            // 1 time for my_entry, again for other_entry
+            2
+        );
+    }
+
     public function testEntriesAreNotRepeatedWhenAlreadyOutputIntegration()
     {
         $kernel = new WebpackEncoreIntegrationTestKernel(true);
@@ -176,6 +192,23 @@ public function testAutowireDefaultBuildArgument()
         // Testing that it doesn't throw an exception is enough
         $this->assertTrue(true);
     }
+
+    private function assertStringContainsStringCount(string $needle, $haystack, int $expectedCount)
+    {
+        $actualCount = substr_count($haystack, $needle);
+
+        $this->assertSame(
+            $expectedCount,
+            $actualCount,
+            sprintf(
+                'Expected to find string "%s" in haystack "%s" "%d" times but only found it "%d" times',
+                $needle,
+                $haystack,
+                $expectedCount,
+                $actualCount
+            )
+        );
+    }
 }
 
 abstract class AbstractWebpackEncoreIntegrationTestKernel extends Kernel
@@ -208,6 +241,9 @@ protected function configureContainer(ContainerBuilder $container, LoaderInterfa
     {
         $container->loadFromExtension('framework', [
             'secret' => 'foo',
+            'router' => [
+                'utf8' => true,
+            ],
             'assets' => [
                 'enabled' => $this->enableAssets,
             ],
@@ -264,9 +300,9 @@ public function renderFoo()
     }
 }
 
-if (method_exists(AbstractWebpackEncoreIntegrationTestKernel::class, 'configureRouting')) {
+if (Kernel::VERSION_ID >= 50100) {
     class WebpackEncoreIntegrationTestKernel extends AbstractWebpackEncoreIntegrationTestKernel {
-        protected function configureRouting(RoutingConfigurator $routes): void
+        protected function configureRoutes(RoutingConfigurator $routes): void
         {
             $routes->add('/foo', 'kernel:'.(parent::VERSION_ID >= 40100 ? ':' : '').'renderFoo');
         }

tests/fixtures/template_disable_tracking.twig

@@ -0,0 +1,6 @@
+{% do encore_disable_file_tracking() %}
+{{ encore_entry_script_tags('my_entry') }}
+{{ encore_entry_link_tags('my_entry') }}
+{{ encore_entry_script_tags('other_entry') }}
+{{ encore_entry_link_tags('other_entry') }}
+{% do encore_enable_file_tracking() %}