Channel-aware GTM container resolution (draft, addresses #151)

config/features/channels.yaml

@@ -0,0 +1,10 @@
+services:
+
+    sylius.google_tag_manager.listener.channels:
+        class: GtmPlugin\EventListener\ChannelGtmListener
+        arguments:
+            - "@google_tag_manager"
+            - "@sylius.context.channel"
+            - "%gtm.channels%"
+        tags:
+            - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest }

config/features/context.yaml

@@ -8,5 +8,6 @@ services:
             - "@sylius.context.channel"
             - "@sylius.context.locale"
             - "@sylius.context.currency"
+            - "@sylius.google_tag_manager.resolver.channel_feature"
         tags:
             - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest }

config/features/environment.yaml

@@ -6,5 +6,6 @@ services:
             - "%gtm.features.environment%"
             - "@google_tag_manager"
             - "%kernel.environment%"
+            - "@sylius.google_tag_manager.resolver.channel_feature"
         tags:
             - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest }

config/features/route.yaml

@@ -5,5 +5,6 @@ services:
         arguments:
             - "%gtm.features.route%"
             - "@google_tag_manager"
+            - "@sylius.google_tag_manager.resolver.channel_feature"
         tags:
             - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest }

config/services.yaml

@@ -1,2 +1,18 @@
 imports:
     - { resource: features/*.yaml }
+
+services:
+
+    sylius.google_tag_manager.resolver.channel_feature:
+        class: GtmPlugin\Resolver\ChannelFeatureResolver
+        arguments:
+            - "@sylius.context.channel"
+            - "%gtm.features%"
+            - "%gtm.channels%"
+
+    sylius.google_tag_manager.twig.channel:
+        class: GtmPlugin\Twig\GtmChannelExtension
+        arguments:
+            - "@sylius.google_tag_manager.resolver.channel_feature"
+        tags:
+            - { name: twig.extension }

src/DependencyInjection/Configuration.php

@@ -26,6 +26,29 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->booleanNode('events')->defaultTrue()->end()
                     ->end()
                 ->end()
+                ->arrayNode('channels')
+                    ->useAttributeAsKey('code')
+                    ->arrayPrototype()
+                        ->validate()
+                            ->ifTrue(static fn (array $v): bool => ($v['id'] ?? null) === null &&
+                                ($v['enabled'] ?? null) === null &&
+                                ($v['features'] ?? []) === [])
+                            ->thenInvalid('Channel entry must define at least one of "id", "enabled" or a "features" override.')
+                        ->end()
+                        ->children()
+                            ->scalarNode('id')->defaultNull()->end()
+                            ->booleanNode('enabled')->defaultNull()->end()
+                            ->arrayNode('features')
+                                ->children()
+                                    ->booleanNode('environment')->end()
+                                    ->booleanNode('route')->end()
+                                    ->booleanNode('context')->end()
+                                    ->booleanNode('events')->end()
+                                ->end()
+                            ->end()
+                        ->end()
+                    ->end()
+                ->end()
             ->end()
         ;
 

src/DependencyInjection/GtmExtension.php

@@ -24,6 +24,9 @@ public function load(array $configs, ContainerBuilder $container): void
             $container->setParameter($parameter, $setting);
         }
 
+        $container->setParameter('gtm.features', $config['features']);
+        $container->setParameter('gtm.channels', $this->normaliseChannels($config['channels'] ?? []));
+
         $loader->load('services.yaml');
     }
 
@@ -32,6 +35,24 @@ public function prepend(ContainerBuilder $container): void
         $this->prependSyliusTwigHooks($container);
     }
 
+    /**
+     * @param array<string, array{id?: ?string, enabled?: ?bool, features?: array<string, bool>}> $channels
+     *
+     * @return array<string, array{id: ?string, enabled: ?bool, features: array<string, bool>}>
+     */
+    private function normaliseChannels(array $channels): array
+    {
+        foreach ($channels as $code => $channel) {
+            $channels[$code] = [
+                'id' => $channel['id'] ?? null,
+                'enabled' => $channel['enabled'] ?? (($channel['id'] ?? null) !== null ? true : null),
+                'features' => $channel['features'] ?? [],
+            ];
+        }
+
+        return $channels;
+    }
+
     protected function prependSyliusTwigHooks(ContainerBuilder $container): void
     {
         if (!$container->hasExtension('sylius_twig_hooks')) {

src/EventListener/AddRouteListener.php

@@ -4,6 +4,7 @@
 
 namespace GtmPlugin\EventListener;
 
+use GtmPlugin\Resolver\ChannelFeatureResolver;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Xynnn\GoogleTagManagerBundle\Service\GoogleTagManagerInterface;
 
@@ -12,12 +13,17 @@ final class AddRouteListener
     public function __construct(
         private readonly bool $enabled,
         private readonly GoogleTagManagerInterface $googleTagManager,
+        private readonly ?ChannelFeatureResolver $featureResolver = null,
     ) {
+        if ($this->featureResolver === null) {
+            trigger_error('Not passing a ChannelFeatureResolver to AddRouteListener is deprecated and it will be required in the next major version.', \E_USER_DEPRECATED);
+        }
     }
 
     public function onKernelRequest(RequestEvent $event): void
     {
-        if (!$this->enabled) {
+        $enabled = $this->featureResolver?->isEnabled('route') ?? $this->enabled;
+        if (!$enabled) {
             return;
         }
 

src/EventListener/ChannelGtmListener.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GtmPlugin\EventListener;
+
+use Sylius\Component\Channel\Context\ChannelContextInterface;
+use Sylius\Component\Channel\Context\ChannelNotFoundException;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+use Xynnn\GoogleTagManagerBundle\Service\GoogleTagManagerInterface;
+
+final class ChannelGtmListener
+{
+    /**
+     * @param array<string, array{id: ?string, enabled: ?bool}> $channels
+     *                                                          Pre-normalised by GtmExtension::load().
+     */
+    public function __construct(
+        private readonly GoogleTagManagerInterface $googleTagManager,
+        private readonly ChannelContextInterface $channelContext,
+        private readonly array $channels,
+    ) {
+    }
+
+    public function onKernelRequest(RequestEvent $event): void
+    {
+        if (!$event->isMainRequest()) {
+            return;
+        }
+
+        try {
+            $code = $this->channelContext->getChannel()->getCode();
+        } catch (ChannelNotFoundException) {
+            return;
+        }
+
+        $config = $this->channels[$code] ?? null;
+        if ($config === null) {
+            return;
+        }
+
+        if ($config['id'] !== null) {
+            $this->googleTagManager->setId($config['id']);
+        }
+
+        if ($config['enabled'] !== null) {
+            $config['enabled'] ? $this->googleTagManager->enable() : $this->googleTagManager->disable();
+        }
+    }
+}

src/EventListener/ContextListener.php

@@ -4,6 +4,7 @@
 
 namespace GtmPlugin\EventListener;
 
+use GtmPlugin\Resolver\ChannelFeatureResolver;
 use Sylius\Component\Channel\Context\ChannelContextInterface;
 use Sylius\Component\Channel\Context\ChannelNotFoundException;
 use Sylius\Component\Currency\Context\CurrencyContextInterface;
@@ -19,12 +20,17 @@ public function __construct(
         private readonly ChannelContextInterface $channelContext,
         private readonly LocaleContextInterface $localeContext,
         private readonly CurrencyContextInterface $currencyContext,
+        private readonly ?ChannelFeatureResolver $featureResolver = null,
     ) {
+        if ($this->featureResolver === null) {
+            trigger_error('Not passing a ChannelFeatureResolver to ContextListener is deprecated and it will be required in the next major version.', \E_USER_DEPRECATED);
+        }
     }
 
     public function onKernelRequest(RequestEvent $event): void
     {
-        if (!$this->enabled) {
+        $enabled = $this->featureResolver?->isEnabled('context') ?? $this->enabled;
+        if (!$enabled) {
             return;
         }
 

src/EventListener/EnvironmentListener.php

@@ -4,6 +4,7 @@
 
 namespace GtmPlugin\EventListener;
 
+use GtmPlugin\Resolver\ChannelFeatureResolver;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Xynnn\GoogleTagManagerBundle\Service\GoogleTagManagerInterface;
 
@@ -13,12 +14,17 @@ public function __construct(
         private readonly bool $enabled,
         private readonly GoogleTagManagerInterface $googleTagManager,
         private readonly string $environment,
+        private readonly ?ChannelFeatureResolver $featureResolver = null,
     ) {
+        if ($this->featureResolver === null) {
+            trigger_error('Not passing a ChannelFeatureResolver to EnvironmentListener is deprecated and it will be required in the next major version.', \E_USER_DEPRECATED);
+        }
     }
 
     public function onKernelRequest(RequestEvent $event): void
     {
-        if (!$this->enabled) {
+        $enabled = $this->featureResolver?->isEnabled('environment') ?? $this->enabled;
+        if (!$enabled) {
             return;
         }
 

src/Resolver/ChannelFeatureResolver.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GtmPlugin\Resolver;
+
+use Sylius\Component\Channel\Context\ChannelContextInterface;
+use Sylius\Component\Channel\Context\ChannelNotFoundException;
+
+final class ChannelFeatureResolver
+{
+    /**
+     * @param array<string, bool>                                                                 $globalFeatures
+     * @param array<string, array{id: ?string, enabled: ?bool, features: array<string, bool>}>    $channels
+     */
+    public function __construct(
+        private readonly ChannelContextInterface $channelContext,
+        private readonly array $globalFeatures,
+        private readonly array $channels,
+    ) {
+    }
+
+    public function isEnabled(string $feature): bool
+    {
+        try {
+            $code = $this->channelContext->getChannel()->getCode();
+
+            return $this->channels[$code]['features'][$feature] ?? $this->globalFeatures[$feature] ?? false;
+        } catch (ChannelNotFoundException) {
+            return $this->globalFeatures[$feature] ?? false;
+        }
+    }
+}

src/Twig/GtmChannelExtension.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GtmPlugin\Twig;
+
+use GtmPlugin\Resolver\ChannelFeatureResolver;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFunction;
+
+final class GtmChannelExtension extends AbstractExtension
+{
+    public function __construct(
+        private readonly ChannelFeatureResolver $featureResolver,
+    ) {
+    }
+
+    public function getFunctions(): array
+    {
+        return [
+            new TwigFunction('gtm_channel_allows', $this->gtmChannelAllows(...)),
+        ];
+    }
+
+    public function gtmChannelAllows(string $feature): bool
+    {
+        return $this->featureResolver->isEnabled($feature);
+    }
+}

templates/events_javascript.html.twig

@@ -1 +1,3 @@
+{% if gtm_channel_allows('events') %}
 <script src="{{ asset('bundles/gtmplugin/prototype.events.js') }}" {{ sylius_test_html_attribute('gtm-events-javascript') }}></script>
+{% endif %}

tests/Application/config/packages/stefandoorn_sylius_gtm.yaml

@@ -5,3 +5,8 @@ gtm:
         route: true
         context: true
         events: true
+    channels:
+        FASHION_WEB:
+            id: "GTM-FASHION"
+        BUSINESS_WEB:
+            enabled: false