feat: allow prepend on adapter definition builder

Author: maxhelias

src/DependencyInjection/FlysystemExtension.php

@@ -26,6 +26,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Extension\Extension;
+use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -36,14 +37,23 @@
  *
  * @internal
  */
-final class FlysystemExtension extends Extension
+final class FlysystemExtension extends Extension implements PrependExtensionInterface
 {
     /** @var list<AdapterDefinitionBuilderInterface> */
     private array $adapterDefinitionBuilders = [];
 
     /** @var array<string, AdapterDefinitionBuilderInterface>|null */
     private ?array $adapterDefinitionBuildersCache = null;
 
+    public function prepend(ContainerBuilder $container): void
+    {
+        foreach ($this->getAdapterDefinitionBuilders() as $builder) {
+            if ($builder instanceof PrependExtensionInterface) {
+                $builder->prepend($container);
+            }
+        }
+    }
+
     public function getConfiguration(array $config, ContainerBuilder $container): ?ConfigurationInterface
     {
         return new Configuration($this->getAdapterDefinitionBuilders());
@@ -68,9 +78,11 @@ public function load(array $configs, ContainerBuilder $container): void
 
     public function addAdapterDefinitionBuilder(AdapterDefinitionBuilderInterface $builder): void
     {
+        if (null !== $this->adapterDefinitionBuildersCache) {
+            throw new \LogicException(sprintf('Cannot add adapter definition builder "%s" after the builders cache has been computed. Builders must be registered before the container is compiled.', $builder::class));
+        }
+
         $this->adapterDefinitionBuilders[] = $builder;
-        // Invalidate cache when adding new builder
-        $this->adapterDefinitionBuildersCache = null;
     }
 
     private function registerPushCommand(ContainerBuilder $container): void

tests/DependencyInjection/FlysystemExtensionTest.php

@@ -18,8 +18,13 @@
 use League\Flysystem\Filesystem;
 use League\Flysystem\FilesystemOperator;
 use League\Flysystem\UnableToWriteFile;
+use League\FlysystemBundle\Adapter\Builder\AdapterDefinitionBuilderInterface;
+use League\FlysystemBundle\DependencyInjection\FlysystemExtension;
 use MicrosoftAzure\Storage\Blob\BlobRestProxy;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Config\Definition\Builder\NodeDefinition;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\Dotenv\Dotenv;
 use Tests\League\FlysystemBundle\Kernel\FlysystemAppKernel;
 
@@ -51,9 +56,9 @@ public function testFilesystems(string $fsName): void
         $kernel = $this->createFlysystemKernel();
         $container = $kernel->getContainer()->get('test.service_container');
 
-        $fs = $container->get('flysystem.test.'.$fsName);
+        $fs = $container->get('flysystem.test.' . $fsName);
 
-        $this->assertInstanceOf(FilesystemOperator::class, $fs, 'Filesystem "'.$fsName.'" should be an instance of FilesystemOperator');
+        $this->assertInstanceOf(FilesystemOperator::class, $fs, 'Filesystem "' . $fsName . '" should be an instance of FilesystemOperator');
     }
 
     /**
@@ -137,6 +142,39 @@ public function testNotRetainingVisibilityPreventsAclCommandInvocation(): void
         self::assertFalse($calledGetObjectAcl, 'The ACL command should not be called when `retain_visibility` is set to `false`.');
     }
 
+    public function testPrependCallsPrependOnBuildersThatImplementIt(): void
+    {
+        $container = new ContainerBuilder();
+        $prepended = false;
+
+        $builder = new class($prepended) implements AdapterDefinitionBuilderInterface, PrependExtensionInterface {
+            public function __construct(private bool &$prepended) {}
+            public function getName(): string
+            {
+                return 'test';
+            }
+            public function getRequiredPackages(): array
+            {
+                return [];
+            }
+            public function addConfiguration(NodeDefinition $node): void {}
+            public function createAdapter(ContainerBuilder $container, string $storageName, array $options, ?string $defaultVisibilityForDirectories): ?string
+            {
+                return null;
+            }
+            public function prepend(ContainerBuilder $container): void
+            {
+                $this->prepended = true;
+            }
+        };
+
+        $extension = new FlysystemExtension();
+        $extension->addAdapterDefinitionBuilder($builder);
+        $extension->prepend($container);
+
+        $this->assertTrue($prepended);
+    }
+
     private function createFlysystemKernel(): FlysystemAppKernel
     {
         (new Dotenv())->populate([