[Asset] Add tag assets.package to register asset packages

GromNaN · GromNaN · commit 0472fd7b3e52 · 2021-01-26T12:47:06.000+01:00
Autoconfiguration with PackageInterface
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGELOG
  * Added the `dispatcher` option to `debug:event-dispatcher`
  * Added the `event_dispatcher.dispatcher` tag
  * Added `assertResponseFormatSame()` in `BrowserKitAssertionsTrait`
+ * Added tag `assets.package` to register asset packages
 
 5.2.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php
@@ -23,6 +23,7 @@ class UnusedTagsPass implements CompilerPassInterface
 {
     private $knownTags = [
         'annotations.cached_reader',
+        'assets.package',
         'auto_alias',
         'cache.pool',
         'cache.pool.clearer',
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -459,6 +459,8 @@ public function load(array $configs, ContainerBuilder $container)
             $loader->load('mime_type.php');
         }
 
+        $container->registerForAutoconfiguration(PackageInterface::class)
+            ->addTag('assets.package');
         $container->registerForAutoconfiguration(Command::class)
             ->addTag('console.command');
         $container->registerForAutoconfiguration(ResourceCheckerInterface::class)
@@ -1079,7 +1081,6 @@ private function registerAssetsConfiguration(array $config, ContainerBuilder $co
         $defaultPackage = $this->createPackageDefinition($config['base_path'], $config['base_urls'], $defaultVersion);
         $container->setDefinition('assets._default_package', $defaultPackage);
 
-        $namedPackages = [];
         foreach ($config['packages'] as $name => $package) {
             if (null !== $package['version_strategy']) {
                 $version = new Reference($package['version_strategy']);
@@ -1093,15 +1094,11 @@ private function registerAssetsConfiguration(array $config, ContainerBuilder $co
                 $version = $this->createVersion($container, $version, $format, $package['json_manifest_path'], $name);
             }
 
-            $container->setDefinition('assets._package_'.$name, $this->createPackageDefinition($package['base_path'], $package['base_urls'], $version));
+            $packageDefinition = $this->createPackageDefinition($package['base_path'], $package['base_urls'], $version)
+                ->addTag('assets.package', ['package' => $name]);
+            $container->setDefinition('assets._package_'.$name, $packageDefinition);
             $container->registerAliasForArgument('assets._package_'.$name, PackageInterface::class, $name.'.package');
-            $namedPackages[$name] = new Reference('assets._package_'.$name);
         }
-
-        $container->getDefinition('assets.packages')
-            ->replaceArgument(0, new Reference('assets._default_package'))
-            ->replaceArgument(1, $namedPackages)
-        ;
     }
 
     /**
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/assets.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/assets.php
@@ -30,8 +30,8 @@
     $container->services()
         ->set('assets.packages', Packages::class)
             ->args([
-                service('assets.empty_package'),
-                [],
+                service('assets._default_package'),
+                tagged_iterator('assets.package', 'package', 'getDefaultName'),
             ])
 
         ->alias(Packages::class, 'assets.packages')
@@ -41,6 +41,8 @@
                 service('assets.empty_version_strategy'),
             ])
 
+        ->alias('assets._default_package', 'assets.empty_package')
+
         ->set('assets.context', RequestStackContext::class)
             ->args([
                 service('request_stack'),
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -596,8 +596,13 @@ public function testAssets()
         $this->assertUrlPackage($container, $defaultPackage, ['http://cdn.example.com'], 'SomeVersionScheme', '%%s?version=%%s');
 
         // packages
-        $packages = $packages->getArgument(1);
-        $this->assertCount(9, $packages);
+        $packageTags = $container->findTaggedServiceIds('assets.package');
+        $this->assertCount(9, $packageTags);
+
+        $packages = [];
+        foreach ($packageTags as $serviceId => $tagAttributes) {
+            $packages[$tagAttributes[0]['package']] = $serviceId;
+        }
 
         $package = $container->getDefinition((string) $packages['images_path']);
         $this->assertPathPackage($container, $package, '/foo', 'SomeVersionScheme', '%%s?version=%%s');
diff --git a/src/Symfony/Component/Asset/CHANGELOG.md b/src/Symfony/Component/Asset/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * deprecated `RemoteJsonManifestVersionStrategy`, use `JsonManifestVersionStrategy` instead.
+ * the `Packages` constructor accepts any iterable.
 
 5.1.0
 -----
diff --git a/src/Symfony/Component/Asset/Packages.php b/src/Symfony/Component/Asset/Packages.php
@@ -28,7 +28,7 @@ class Packages
     /**
      * @param PackageInterface[] $packages Additional packages indexed by name
      */
-    public function __construct(PackageInterface $defaultPackage = null, array $packages = [])
+    public function __construct(PackageInterface $defaultPackage = null, iterable $packages = [])
     {
         $this->defaultPackage = $defaultPackage;
 
diff --git a/src/Symfony/Component/Asset/Tests/PackagesTest.php b/src/Symfony/Component/Asset/Tests/PackagesTest.php
@@ -48,7 +48,7 @@ public function testGetUrl()
     {
         $packages = new Packages(
             new Package(new StaticVersionStrategy('default')),
-            ['a' => new Package(new StaticVersionStrategy('a'))]
+            new \ArrayIterator(['a' => new Package(new StaticVersionStrategy('a'))])
         );
 
         $this->assertSame('/foo?default', $packages->getUrl('/foo'));

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ class UnusedTagsPass implements CompilerPassInterface`
`23`	`23`	`{`
`24`	`24`	`private $knownTags = [`
`25`	`25`	`'annotations.cached_reader',`
	`26`	`+ 'assets.package',`
`26`	`27`	`'auto_alias',`
`27`	`28`	`'cache.pool',`
`28`	`29`	`'cache.pool.clearer',`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class Packages`
`28`	`28`	`/**`
`29`	`29`	`* @param PackageInterface[] $packages Additional packages indexed by name`
`30`	`30`	`*/`
`31`		`- public function __construct(PackageInterface $defaultPackage = null, array $packages = [])`
	`31`	`+ public function __construct(PackageInterface $defaultPackage = null, iterable $packages = [])`
`32`	`32`	`{`
`33`	`33`	`$this->defaultPackage = $defaultPackage;`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public function testGetUrl()`
`48`	`48`	`{`
`49`	`49`	`$packages = new Packages(`
`50`	`50`	`new Package(new StaticVersionStrategy('default')),`
`51`		`- ['a' => new Package(new StaticVersionStrategy('a'))]`
	`51`	`+ new \ArrayIterator(['a' => new Package(new StaticVersionStrategy('a'))])`
`52`	`52`	`);`
`53`	`53`
`54`	`54`	`$this->assertSame('/foo?default', $packages->getUrl('/foo'));`