feature #50291 [AssetMapper] Adding "excluded_patterns" option (weaverryan)

fabpot · fabpot · commit 9e823012c368 · 2023-05-12T16:32:50.000+02:00
This PR was squashed before being merged into the 6.3 branch. Discussion ---------- [AssetMapper] Adding "excluded_patterns" option | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | None | License | MIT | Doc PR | Still TODO Hi! Invariably, some people will use AssetMapper with certain files that will need to be "built". Examples might be: A) An `assets/app.css` that uses Tailwind, and the user builds this manually to `assets/build/app.css` and includes *that* file in their pipeline. The source `assets/app.css` should not be published to `public/assets`. B) Similar with SCSS - e.g. all `*.scss` might be ignored because you are building them yourself. The new `excluded_patterns` is a glob, for simplicity, and must match the entire file path - hence examples like `*/assets/*.scss` Cheers! Commits ------- 1c5a1e0 [AssetMapper] Adding "excluded_patterns" option
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -821,6 +821,7 @@ private function addAssetMapperSection(ArrayNodeDefinition $rootNode, callable $
                     ->info('Asset Mapper configuration')
                     ->{$enableIfStandalone('symfony/asset-mapper', AssetMapper::class)}()
                     ->fixXmlConfig('path')
+                    ->fixXmlConfig('excluded_pattern')
                     ->fixXmlConfig('extension')
                     ->fixXmlConfig('importmap_script_attribute')
                     ->children()
@@ -856,6 +857,11 @@ private function addAssetMapperSection(ArrayNodeDefinition $rootNode, callable $
                             ->end()
                             ->prototype('scalar')->end()
                         ->end()
+                        ->arrayNode('excluded_patterns')
+                            ->info('Array of glob patterns of asset file paths that should not be in the asset mapper')
+                            ->prototype('scalar')->end()
+                            ->example(['*/assets/build/*', '*/*_.scss'])
+                        ->end()
                         ->booleanNode('server')
                             ->info('If true, a "dev server" will return the assets from the public directory (true in "debug" mode only by default)')
                             ->defaultValue($this->debug)
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -72,6 +72,7 @@
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Symfony\Component\Finder\Finder;
+use Symfony\Component\Finder\Glob;
 use Symfony\Component\Form\ChoiceList\Factory\CachingFactoryDecorator;
 use Symfony\Component\Form\Extension\HtmlSanitizer\Type\TextTypeHtmlSanitizerExtension;
 use Symfony\Component\Form\Form;
@@ -1277,8 +1278,14 @@ private function registerAssetMapperConfiguration(array $config, ContainerBuilde
                 $paths[$dir] = sprintf('bundles/%s', preg_replace('/bundle$/', '', strtolower($name)));
             }
         }
+        $excludedPathPatterns = [];
+        foreach ($config['excluded_patterns'] as $path) {
+            $excludedPathPatterns[] = Glob::toRegex($path, true, false);
+        }
+
         $container->getDefinition('asset_mapper.repository')
-            ->setArgument(0, $paths);
+            ->setArgument(0, $paths)
+            ->setArgument(2, $excludedPathPatterns);
 
         $publicDirName = $this->getPublicDirectoryName($container);
         $container->getDefinition('asset_mapper.public_assets_path_resolver')
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/asset_mapper.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/asset_mapper.php
@@ -45,6 +45,7 @@
             ->args([
                 abstract_arg('array of asset mapper paths'),
                 param('kernel.project_dir'),
+                abstract_arg('array of excluded path patterns'),
             ])
 
         ->set('asset_mapper.public_assets_path_resolver', PublicAssetsPathResolver::class)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -190,6 +190,7 @@
     <xsd:complexType name="asset_mapper">
         <xsd:sequence>
             <xsd:element name="path" type="asset_mapper_path" minOccurs="0" maxOccurs="unbounded" />
+            <xsd:element name="excluded-pattern" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
             <xsd:element name="server" type="xsd:boolean" minOccurs="0" />
             <xsd:element name="public_prefix" type="xsd:string" minOccurs="0" />
             <xsd:element name="strict-mode" type="xsd:boolean" minOccurs="0" />
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -104,6 +104,7 @@ public function testAssetMapperCanBeEnabled()
         $defaultConfig = [
             'enabled' => true,
             'paths' => [],
+            'excluded_patterns' => [],
             'server' => true,
             'public_prefix' => '/assets/',
             'strict_mode' => true,
@@ -615,6 +616,7 @@ protected static function getBundleDefaultConfig()
             'asset_mapper' => [
                 'enabled' => !class_exists(FullStack::class),
                 'paths' => [],
+                'excluded_patterns' => [],
                 'server' => true,
                 'public_prefix' => '/assets/',
                 'strict_mode' => true,
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/asset_mapper.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/asset_mapper.xml
@@ -10,6 +10,7 @@
         <framework:asset-mapper>
             <framework:path>assets/</framework:path>
             <framework:path namespace="my_namespace">assets2/</framework:path>
+            <framework:excluded-pattern>*/*.scss</framework:excluded-pattern>
             <framework:server>true</framework:server>
             <framework:public_prefix>/assets_path/</framework:public_prefix>
             <framework:strict-mode>true</framework:strict-mode>
diff --git a/src/Symfony/Component/AssetMapper/AssetMapperRepository.php b/src/Symfony/Component/AssetMapper/AssetMapperRepository.php
@@ -33,7 +33,8 @@ class AssetMapperRepository
      */
     public function __construct(
         private readonly array $paths,
-        private readonly string $projectRootDir
+        private readonly string $projectRootDir,
+        private readonly array $excludedPathPatterns = [],
     ) {
     }
 
@@ -54,7 +55,7 @@ public function find(string $logicalPath): ?string
             }
 
             $file = rtrim($path, '/').'/'.$localLogicalPath;
-            if (is_file($file)) {
+            if (is_file($file) && !$this->isExcluded($file)) {
                 return realpath($file);
             }
         }
@@ -70,6 +71,10 @@ public function findLogicalPath(string $filesystemPath): ?string
 
         $filesystemPath = realpath($filesystemPath);
 
+        if ($this->isExcluded($filesystemPath)) {
+            return null;
+        }
+
         foreach ($this->getDirectories() as $path => $namespace) {
             if (!str_starts_with($filesystemPath, $path)) {
                 continue;
@@ -104,6 +109,10 @@ public function all(): array
                     continue;
                 }
 
+                if ($this->isExcluded($file->getPathname())) {
+                    continue;
+                }
+
                 /** @var RecursiveDirectoryIterator $innerIterator */
                 $innerIterator = $iterator->getInnerIterator();
                 $logicalPath = ($namespace ? rtrim($namespace, '/').'/' : '').$innerIterator->getSubPathName();
@@ -160,4 +169,18 @@ private function normalizeLogicalPath(string $logicalPath): string
     {
         return ltrim(str_replace('\\', '/', $logicalPath), '/\\');
     }
+
+    private function isExcluded(string $filesystemPath): bool
+    {
+        // normalize Windows slashes and remove trailing slashes
+        $filesystemPath = rtrim(str_replace('\\', '/', $filesystemPath), '/');
+
+        foreach ($this->excludedPathPatterns as $pattern) {
+            if (preg_match($pattern, $filesystemPath)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }
diff --git a/src/Symfony/Component/AssetMapper/Tests/AssetMapperRepositoryTest.php b/src/Symfony/Component/AssetMapper/Tests/AssetMapperRepositoryTest.php
@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\AssetMapper\AssetMapperRepository;
+use Symfony\Component\Finder\Glob;
 
 class AssetMapperRepositoryTest extends TestCase
 {
@@ -128,4 +129,36 @@ public function testAllWithNamespaces()
 
         $this->assertEquals($normalizedExpectedAllAssets, $normalizedActualAssets);
     }
+
+    public function testExcludedPaths()
+    {
+        $excludedPatterns = [
+            '*/subdir/*',
+            '*/*3.css',
+            '*/*.digested.*',
+        ];
+        $excludedGlobs = array_map(function ($pattern) {
+            // globbed equally in FrameworkExtension
+            return Glob::toRegex($pattern, true, false);
+        }, $excludedPatterns);
+        $repository = new AssetMapperRepository([
+            'dir1' => '',
+            'dir2' => '',
+            'dir3' => '',
+        ], __DIR__.'/fixtures', $excludedGlobs);
+
+        $expectedAssets = [
+            'file1.css',
+            'file2.js',
+            'file4.js',
+            'test.gif.foo',
+        ];
+
+        $actualAssets = array_keys($repository->all());
+        sort($actualAssets);
+        $this->assertEquals($expectedAssets, $actualAssets);
+
+        $this->assertNull($repository->find('file3.css'));
+        $this->assertNull($repository->findLogicalPath(__DIR__.'/fixtures/dir2/file3.css'));
+    }
 }
diff --git a/src/Symfony/Component/AssetMapper/composer.json b/src/Symfony/Component/AssetMapper/composer.json
@@ -24,6 +24,7 @@
         "symfony/asset": "^5.4|^6.0",
         "symfony/browser-kit": "^5.4|^6.0",
         "symfony/console": "^5.4|^6.0",
+        "symfony/finder": "^5.4|^6.0",
         "symfony/framework-bundle": "^6.3",
         "symfony/http-foundation": "^5.4|^6.0",
         "symfony/http-kernel": "^5.4|^6.0"
