Repository navigation
[LiveComponent][TwigComponent] Skip live-only and data-model listeners for other components
#4107
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\UX\TwigComponent\DependencyInjection\Compiler; | ||
|
|
||
| use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument; | ||
| use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; | ||
| use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
| use Symfony\Component\DependencyInjection\Reference; | ||
| use Symfony\UX\TwigComponent\Event\PostMountEvent; | ||
| use Symfony\UX\TwigComponent\Event\PostRenderEvent; | ||
| use Symfony\UX\TwigComponent\Event\PreCreateForRenderEvent; | ||
| use Symfony\UX\TwigComponent\Event\PreMountEvent; | ||
| use Symfony\UX\TwigComponent\Event\PreRenderEvent; | ||
|
|
||
| /** | ||
| * Finds the component events whose listeners all only care about some components. | ||
| * | ||
| * A listener tagged "ux.twig_component.scoped_listener" declares the components it acts on: with a "metadata" | ||
| * attribute, the components whose metadata holds a truthy value under that key; with a "props" attribute, the | ||
| * components rendered with at least one of these props. When every listener of an event declares a scope, and | ||
| * those with a "metadata" attribute all name the same key, the event is only dispatched for the components in | ||
| * the scope of at least one of them. | ||
| * | ||
| * @author Hugo Alliaume <hugo@alliau.me> | ||
| * | ||
| * @internal | ||
| */ | ||
| final class ComponentListenerScopesPass implements CompilerPassInterface | ||
| { | ||
| public const SCOPED_LISTENER_TAG = 'ux.twig_component.scoped_listener'; | ||
|
|
||
| private const EVENTS = [ | ||
| PreCreateForRenderEvent::class, | ||
| PreMountEvent::class, | ||
| PostMountEvent::class, | ||
| PreRenderEvent::class, | ||
| PostRenderEvent::class, | ||
| ]; | ||
|
|
||
| public function process(ContainerBuilder $container): void | ||
| { | ||
| if (!$container->hasDefinition('ux.twig_component.component_factory') || !$container->has('event_dispatcher')) { | ||
| return; | ||
| } | ||
|
|
||
| $scopes = []; | ||
| foreach ($container->findTaggedServiceIds(self::SCOPED_LISTENER_TAG) as $id => $tags) { | ||
| $scope = array_filter([ | ||
| 'metadata' => $tags[0]['metadata'] ?? null, | ||
| 'props' => (array) ($tags[0]['props'] ?? []), | ||
| ]); | ||
| $scopes[$id] = $scope ?: null; | ||
| } | ||
|
|
||
| if (!$scopes) { | ||
| return; | ||
| } | ||
|
|
||
| $listenerScopes = []; | ||
| foreach ($container->findDefinition('event_dispatcher')->getMethodCalls() as [$method, $arguments]) { | ||
| if ('addListener' !== $method || !\in_array($arguments[0] ?? null, self::EVENTS, true)) { | ||
| continue; | ||
| } | ||
|
|
||
| $listenerScopes[$arguments[0]][] = $this->scopeOf($arguments[1] ?? null, $scopes); | ||
| } | ||
|
|
||
| $eventScopes = []; | ||
| foreach ($listenerScopes as $eventClass => $eventListenerScopes) { | ||
| if (\in_array(null, $eventListenerScopes, true)) { | ||
| continue; | ||
| } | ||
|
|
||
| $metadataKeys = array_unique(array_column($eventListenerScopes, 'metadata')); | ||
| if (\count($metadataKeys) > 1) { | ||
| continue; | ||
| } | ||
|
|
||
| $props = array_fill_keys(array_merge(...array_column($eventListenerScopes, 'props')), true); | ||
| $eventScopes[$eventClass] = [$metadataKeys[0] ?? null, $props, \count($eventListenerScopes)]; | ||
| } | ||
|
|
||
| $container->getDefinition('ux.twig_component.component_factory')->setArgument(7, $eventScopes); | ||
| } | ||
|
|
||
| /** | ||
| * @param array<string, array{metadata?: string, props?: list<string>}|null> $scopes | ||
| * | ||
| * @return array{metadata?: string, props?: list<string>}|null | ||
| */ | ||
| private function scopeOf(mixed $listener, array $scopes): ?array | ||
| { | ||
| if (!\is_array($listener) || !($listener[0] ?? null) instanceof ServiceClosureArgument) { | ||
| return null; | ||
| } | ||
|
|
||
| $reference = $listener[0]->getValues()[0] ?? null; | ||
|
|
||
| return $reference instanceof Reference ? $scopes[(string) $reference] ?? null : null; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,8 +11,10 @@ | |
|
|
||
| namespace Symfony\UX\TwigComponent; | ||
|
|
||
| use Symfony\Component\DependencyInjection\Compiler\PassConfig; | ||
| use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
| use Symfony\Component\HttpKernel\Bundle\Bundle; | ||
| use Symfony\UX\TwigComponent\DependencyInjection\Compiler\ComponentListenerScopesPass; | ||
| use Symfony\UX\TwigComponent\DependencyInjection\Compiler\TwigComponentPass; | ||
|
|
||
| /** | ||
|
|
@@ -23,6 +25,8 @@ final class TwigComponentBundle extends Bundle | |
| public function build(ContainerBuilder $container): void | ||
| { | ||
| $container->addCompilerPass(new TwigComponentPass()); | ||
| // after RegisterListenersPass, which adds the listeners to the event dispatcher | ||
| $container->addCompilerPass(new ComponentListenerScopesPass(), PassConfig::TYPE_BEFORE_REMOVING, -8); | ||
| } | ||
|
|
||
| public function getPath(): string | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\UX\TwigComponent\Tests\Fixtures\EventListener; | ||
|
|
||
| use Symfony\UX\TwigComponent\Event\PostMountEvent; | ||
| use Symfony\UX\TwigComponent\Event\PostRenderEvent; | ||
| use Symfony\UX\TwigComponent\Event\PreCreateForRenderEvent; | ||
| use Symfony\UX\TwigComponent\Event\PreMountEvent; | ||
| use Symfony\UX\TwigComponent\Event\PreRenderEvent; | ||
|
|
||
| final class ComponentEventRecorder | ||
| { | ||
| /** | ||
| * @var list<array{class-string, string}> | ||
| */ | ||
| public array $events = []; | ||
|
|
||
| public function __invoke(object $event): void | ||
| { | ||
| $this->events[] = [$event::class, match (true) { | ||
| $event instanceof PreCreateForRenderEvent => $event->getName(), | ||
| $event instanceof PreMountEvent, $event instanceof PostMountEvent, $event instanceof PreRenderEvent => $event->getMetadata()?->getName(), | ||
| $event instanceof PostRenderEvent => $event->getMountedComponent()->getName(), | ||
| }]; | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.