feat: allow and deny url support for storefront

README.md

@@ -66,6 +66,14 @@ frosh_sentry:
     storefront:
         # optional: if you want track errors occurs within the browser (javascript/cors/csp)
         enabled: true
+        # optional: if you want track errors only on specific urls/hosts
+        allowUrls:
+          - '"https://example.com"'
+          - /https?:\/\/((cdn|www)\.)?example\.com/
+        # optional: if you want to ignore errors for specific urls/hosts
+        denyUrls:
+          - '"https://example.com"'
+          - /https?:\/\/((cdn|www)\.)?example\.com/
         # optional: if you want record the user sessions. Please aware the GDPR.
         replay_recording:
           enabled: true

src/DependencyInjection/Configuration.php

@@ -6,7 +6,6 @@
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
-use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 
 class Configuration implements ConfigurationInterface
 {
@@ -16,13 +15,20 @@ public function getConfigTreeBuilder(): TreeBuilder
         $rootNode = $treeBuilder->getRootNode();
 
         // @formatter:off
+        /** @phpstan-ignore class.notFound */
         $rootNode
             ->children()
                 ->booleanNode('report_scheduled_tasks')->defaultFalse()->end()
                 ->arrayNode('storefront')
                     ->addDefaultsIfNotSet()
                     ->children()
                         ->booleanNode('enabled')->defaultFalse()->end()
+                        ->arrayNode('allowUrls')
+                            ->scalarPrototype()->end()
+                        ->end()
+                        ->arrayNode('denyUrls')
+                            ->scalarPrototype()->end()
+                        ->end()
                         ->arrayNode('replay_recording')
                             ->addDefaultsIfNotSet()
                             ->children()

src/DependencyInjection/FroshSentryExtension.php

@@ -18,7 +18,7 @@ class FroshSentryExtension extends Extension
      */
     public function load(array $configs, ContainerBuilder $container): void
     {
-        /** @var array{report_scheduled_tasks: bool, storefront?: array{enabled: bool, javascript_sdk_version: string, replay_recording?: array{enabled: bool, sample_rate: float}, tracing?: array{enabled: bool, sample_rate: float}}} $config */
+        /** @var array{report_scheduled_tasks: bool, storefront?: array{enabled: bool, javascript_sdk_version: string, allowUrls?: array{string}, denyUrls?: array{string}, replay_recording?: array{enabled: bool, sample_rate: float}, tracing?: array{enabled: bool, sample_rate: float}}} $config */
         $config = $this->processConfiguration($this->getConfiguration($configs, $container), $configs);
 
         $container->setParameter('frosh_sentry.report_scheduled_tasks', $config['report_scheduled_tasks']);
@@ -35,7 +35,7 @@ public function getConfiguration(array $config, ContainerBuilder $container): Co
     }
 
     /**
-     * @param array{enabled?: bool, javascript_sdk_version?: string, replay_recording?: array{enabled?: bool, sample_rate?: float}, tracing?: array{enabled?: bool, sample_rate?: float}} $config
+     * @param array{enabled?: bool, javascript_sdk_version?: string, allowUrls?: array{string}, denyUrls?: array{string}, replay_recording?: array{enabled?: bool, sample_rate?: float}, tracing?: array{enabled?: bool, sample_rate?: float}} $config
      */
     private function registerStorefrontConfiguration(array $config, ContainerBuilder $container): void
     {
@@ -52,6 +52,8 @@ private function registerStorefrontConfiguration(array $config, ContainerBuilder
                 $config['replay_recording']['sample_rate'] ?? 0.1,
                 $config['tracing']['enabled'] ?? false,
                 $config['tracing']['sample_rate'] ?? 0.1,
+                $config['allowUrls'] ?? [],
+                $config['denyUrls'] ?? [],
             ])
             ->addTag('kernel.event_subscriber');
     }

src/Resources/views/storefront/sentry.html.twig

@@ -6,6 +6,20 @@
                 dsn: '{{ sentry.dsn }}',
                 release: '{{ sentry.release }}',
                 environment: '{{ sentry.environment }}',
+                {% if sentry.allowUrls -%}
+                allowUrls: [
+                    {% for url in sentry.allowUrls -%}
+                        {{ url|raw }},
+                    {% endfor -%}
+                ],
+                {% endif -%}
+                {% if sentry.denyUrls -%}
+                denyUrls: [
+                    {% for url in sentry.denyUrls -%}
+                        {{ url|raw }},
+                    {% endfor -%}
+                ],
+                {% endif -%}
                 integrations: [
                     {% if sentry.tracing.enabled -%}
                     Sentry.browserTracingIntegration({

src/Subscriber/StorefrontPageSubscriber.php

@@ -17,6 +17,10 @@ public function __construct(
         private readonly float $replayRecordingSampleRate,
         private readonly bool $tracingEnabled,
         private readonly float $tracingSampleRate,
+        /** @var array{string} */
+        private readonly array $allowUrls,
+        /** @var array{string} */
+        private readonly array $denyUrls,
     ) {}
 
     public static function getSubscribedEvents(): array
@@ -53,6 +57,8 @@ public function onRender(StorefrontRenderEvent $event): void
                 'enabled' => $this->tracingEnabled,
                 'sample_rate' => $this->tracingSampleRate,
             ],
+            'allowUrls' => $this->allowUrls,
+            'denyUrls' => $this->denyUrls,
             'release' => $this->sentryOptions->getRelease(),
             'environment' => $this->sentryOptions->getEnvironment(),
         ]);