[DependencyInjection] Parse attributes found on abstract classes for resource definitions

Author: nicolas-grekas

DependencyInjection/StreamablePass.php

@@ -13,6 +13,7 @@
 
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
 
 /**
  * Sets the streamable metadata to the services that need them.
@@ -31,16 +32,20 @@ public function process(ContainerBuilder $container): void
 
         // retrieve concrete services tagged with "json_streamer.streamable" tag
         foreach ($container->getDefinitions() as $id => $definition) {
-            if (!$tag = ($definition->getTag('json_streamer.streamable')[0] ?? null)) {
+            if (!$tag = $definition->getTag('json_streamer.streamable')[0] ?? null) {
                 continue;
             }
-
-            if (($className = $container->getDefinition($id)->getClass()) && !$container->getDefinition($id)->isAbstract()) {
-                $streamable[$className] = [
-                    'object' => $tag['object'],
-                    'list' => $tag['list'],
-                ];
+            if (!$definition->hasTag('container.excluded')) {
+                throw new InvalidArgumentException(\sprintf('The resource "%s" tagged "json_streamer.streamable" is missing the "container.excluded" tag.', $id));
+            }
+            $class = $container->getParameterBag()->resolveValue($definition->getClass());
+            if (!$class || $definition->isAbstract()) {
+                throw new InvalidArgumentException(\sprintf('The resource "%s" tagged "json_streamer.streamable" must have a class and not be abstract.', $id));
             }
+            $streamable[$class] = [
+                'object' => $tag['object'],
+                'list' => $tag['list'],
+            ];
 
             $container->removeDefinition($id);
         }

Tests/DependencyInjection/StreamablePassTest.php

@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
 use Symfony\Component\JsonStreamer\DependencyInjection\StreamablePass;
 
 class StreamablePassTest extends TestCase
@@ -25,8 +26,7 @@ public function testSetStreamable()
         $container->register('.json_streamer.cache_warmer.streamer')->setArguments([null]);
         $container->register('.json_streamer.cache_warmer.lazy_ghost')->setArguments([null]);
 
-        $container->register('streamable')->setClass('Foo')->addTag('json_streamer.streamable', ['object' => true, 'list' => true]);
-        $container->register('abstractStreamable')->setClass('Bar')->addTag('json_streamer.streamable', ['object' => true, 'list' => true])->setAbstract(true);
+        $container->register('streamable')->setClass('Foo')->addTag('json_streamer.streamable', ['object' => true, 'list' => true])->addTag('container.excluded');
         $container->register('notStreamable')->setClass('Baz');
 
         $pass = new StreamablePass();
@@ -37,5 +37,9 @@ public function testSetStreamable()
 
         $this->assertSame(['Foo' => ['object' => true, 'list' => true]], $streamerCacheWarmer->getArgument(0));
         $this->assertSame(['Foo'], $lazyGhostCacheWarmer->getArgument(0));
+
+        $container->register('abstractStreamable')->setClass('Bar')->addTag('json_streamer.streamable', ['object' => true, 'list' => true])->addTag('container.excluded')->setAbstract(true);
+        $this->expectException(InvalidArgumentException::class);
+        $pass->process($container);
     }
 }