Include default configuration for Contao managed edition (#12)

Co-authored-by: Fritz Michael Gschwantner <[email protected]>
Co-authored-by: David Greminger <[email protected]>

Author: 3 people

README.md

@@ -1,40 +1,34 @@
 Contao Sentry Bundle
 ====================
 
-This Contao bundle provides an easy integration of [sentry.io](https://sentry.io/) for Contao 4.4.x and newer.
+This Contao bundle provides an easy integration of [sentry.io](https://sentry.io/) for Contao 4.13 and 5.x.
 
 [![Author](http://img.shields.io/badge/author-@1upgmbh-blue.svg?style=flat-square)](https://twitter.com/1upgmbh)
 [![Software License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 [![Total Downloads](http://img.shields.io/packagist/dt/oneup/contao-sentry-bundle.svg?style=flat-square)](https://packagist.org/packages/oneup/contao-sentry-bundle)
 
 --
 
-In the first place, this is an "wrapper extension" for the [`sentry/sentry-symfony` bundle][1]. Therefore, you need to
-configure this bundle as you would configure the `sentry/sentry-symfony` bundle: [Documentation][2]
-
-### Recommended configuration
-
-If you also want to report the system log errors to Sentry, this is the recommended configuration:
-
-```yml
-sentry:
-  dsn: "https://xyz@sentry.io/xy"
-  register_error_listener: false
-  
-Sentry\Monolog\Handler:
-    arguments:
-        $hub: '@Sentry\State\HubInterface'
-        $level: !php/const Monolog\Logger::ERROR # Can be one of https://github.com/Seldaek/monolog/blob/master/doc/01-usage.md#log-levels, but System::log() only uses INFO or ERROR
-        $bubble: false
-
-monolog:
-  handlers:
-    sentry:
-      type: service
-      id: Sentry\Monolog\Handler
-      priority: 100 # Higher priority than ContaoTableHandler which will stop handling afterwards (bubbling is set to true)
-      bubble: false # Use bubble: true if you don't want the logs to show up in the system log (bubbling means, no monolog handlers will run afterwards)
-```
+This is a "wrapper extension" for the [`sentry/sentry-symfony` bundle][1].
+
+
+### Setup in the Contao Managed Edition
+
+The basic integration is automatically configured to some sane defaults. To enable
+the integration, configure the `SENTRY_DSN` variable in your `.env.local` file.
+
+Additionally, you can name the `SENTRY_ENV` in your `.env.local` file, which can be useful
+if you e.g. have a `test` and `prod` installation.
+
+If you need to change any of the defaults, simply configure 
+the `sentry/sentry-symfony` bundle according to the [Documentation][2].
+
+
+### Manual configuration
+
+If you do not use the Contao Managed Edition, you need to configure this bundle as you would 
+configure the `sentry/sentry-symfony` bundle: [Documentation][2]
+
 
 ### User feedback
 
@@ -44,7 +38,7 @@ some comments.
 
 In order to integrate this feature, you have to alter the error page template. Place a copy of 
 `vendor/contao/core-bundle/src/Resources/views/Error/layout.html.twig` in the directory 
-`app/Resources/ContaoCoreBundle/views/Error/`.
+`templates/ContaoCoreBundle/views/Error/`.
 
 Modify the copied template and place the following snippet just before the closing `</body>` tag:
 ```twig
@@ -70,6 +64,6 @@ Modify the copied template and place the following snippet just before the closi
 
 
 [1]: https://github.com/getsentry/sentry-symfony/
-[2]: https://github.com/getsentry/sentry-symfony/#configuration-of-the-sdk
+[2]: https://docs.sentry.io/platforms/php/guides/symfony/#install
 [3]: https://docs.sentry.io/learn/user-feedback/
 [4]: https://user-images.githubusercontent.com/1284725/41782120-a06637f0-7639-11e8-96d7-a053e7ddd232.png

composer.json

@@ -20,9 +20,9 @@
     }
   ],
   "require": {
-    "php": "^7.1 || ^8.0",
-    "contao/core-bundle": "^4.4 || ^5.0",
-    "sentry/sentry-symfony": "^4.0 || ^5.0",
+    "php": "^8.1",
+    "contao/core-bundle": "^4.13 || ^5.0",
+    "sentry/sentry-symfony": "^5.0",
     "twig/twig": "^2.7 || ^3.0"
   },
   "require-dev": {
@@ -43,11 +43,11 @@
     }
   },
   "extra": {
-    "contao-manager-plugin": "Oneup\\Contao\\SentryBundle\\ContaoManager\\Plugin"
+    "contao-manager-plugin": "Oneup\\ContaoSentryBundle\\ContaoManager\\Plugin"
   },
   "autoload": {
     "psr-4": {
-      "Oneup\\Contao\\SentryBundle\\": "src"
+      "Oneup\\ContaoSentryBundle\\": "src"
     }
   },
   "support": {

config/services.yaml

@@ -0,0 +1,14 @@
+services:
+    oneup_contao_sentry.twig.extension:
+        class: Oneup\ContaoSentryBundle\Twig\ContaoSentryTwigExtension
+        tags:
+            - { name: twig.extension }
+
+    oneup_contao_sentry.twig.runtime:
+        class: Oneup\ContaoSentryBundle\Twig\ContaoSentryTwigRuntime
+        public: false
+        tags:
+            - { name: twig.runtime }
+
+    oneup_contao_sentry.integration.ignore_previous_exceptions:
+        class: Oneup\ContaoSentryBundle\Integration\IgnorePreviousExceptionsIntegration

config/skeleton.yaml

@@ -0,0 +1,39 @@
+parameters:
+    env(SENTRY_DSN): ''
+    env(SENTRY_ENV): '%kernel.environment%'
+
+sentry:
+    dsn: '%env(SENTRY_DSN)%'
+    register_error_listener: false
+    register_error_handler: false
+    options:
+        environment: "%env(SENTRY_ENV)%"
+        before_send: oneup_contao_sentry.integration.ignore_previous_exceptions
+        ignore_exceptions:
+            - Contao\CoreBundle\Exception\AccessDeniedException
+            - Contao\CoreBundle\Exception\AjaxRedirectResponseException
+            - Contao\CoreBundle\Exception\InsufficientAuthenticationException
+            - Contao\CoreBundle\Exception\InvalidRequestTokenException
+            - Contao\CoreBundle\Exception\NoActivePageFoundException
+            - Contao\CoreBundle\Exception\NoContentResponseException
+            - Contao\CoreBundle\Exception\PageNotFoundException
+            - Contao\CoreBundle\Exception\RedirectResponseException
+            - Contao\CoreBundle\Exception\ResponseException
+            - Contao\CoreBundle\Exception\ServiceUnavailableException
+            - Contao\UnusedArgumentsException
+            - Symfony\Component\Console\Exception\CommandNotFoundException
+            - Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
+            - Symfony\Component\HttpKernel\Exception\NotFoundHttpException
+            - Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
+            - Symfony\Component\Security\Core\Exception\AccessDeniedException
+
+monolog:
+    handlers:
+        sentry:
+            type: sentry
+            level: !php/const Monolog\Logger::ERROR
+            hub_id: Sentry\State\HubInterface
+
+services:
+    Monolog\Processor\PsrLogMessageProcessor:
+        tags: { name: monolog.processor, handler: sentry }

src/ContaoManager/Plugin.php

@@ -2,36 +2,32 @@
 
 declare(strict_types=1);
 
-namespace Oneup\Contao\SentryBundle\ContaoManager;
+namespace Oneup\ContaoSentryBundle\ContaoManager;
 
 use Contao\CoreBundle\ContaoCoreBundle;
 use Contao\ManagerPlugin\Bundle\BundlePluginInterface;
 use Contao\ManagerPlugin\Bundle\Config\BundleConfig;
 use Contao\ManagerPlugin\Bundle\Parser\ParserInterface;
-use Contao\ManagerPlugin\Dependency\DependentPluginInterface;
-use Oneup\Contao\SentryBundle\OneupContaoSentryBundle;
+use Contao\ManagerPlugin\Config\ConfigPluginInterface;
+use Oneup\ContaoSentryBundle\OneupContaoSentryBundle;
 use Sentry\SentryBundle\SentryBundle;
+use Symfony\Component\Config\Loader\LoaderInterface;
 
-class Plugin implements BundlePluginInterface, DependentPluginInterface
+class Plugin implements BundlePluginInterface, ConfigPluginInterface
 {
     public function getBundles(ParserInterface $parser): array
     {
         return [
-            // load SentryBundle (dependency)
-            BundleConfig::create(SentryBundle::class)->setLoadAfter([ContaoCoreBundle::class]),
-
-            // load OneupContaoSentryBundle
+            BundleConfig::create(SentryBundle::class),
             BundleConfig::create(OneupContaoSentryBundle::class)->setLoadAfter([
                 ContaoCoreBundle::class,
                 SentryBundle::class,
             ]),
         ];
     }
 
-    public function getPackageDependencies(): array
+    public function registerContainerConfiguration(LoaderInterface $loader, array $managerConfig): void
     {
-        return [
-            'sentry/sentry-symfony',
-        ];
+        $loader->load(__DIR__.'/../../config/skeleton.yaml');
     }
 }

src/DependencyInjection/OneupContaoSentryExtension.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Oneup\Contao\SentryBundle\DependencyInjection;
+namespace Oneup\ContaoSentryBundle\DependencyInjection;
 
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -18,7 +18,7 @@ class OneupContaoSentryExtension extends Extension
      */
     public function load(array $configs, ContainerBuilder $container): void
     {
-        $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
-        $loader->load('services.yml');
+        $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../../config'));
+        $loader->load('services.yaml');
     }
 }

src/Integration/IgnorePreviousExceptionsIntegration.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Oneup\ContaoSentryBundle\Integration;
+
+use Sentry\Event;
+use Sentry\EventHint;
+use Sentry\SentrySdk;
+
+class IgnorePreviousExceptionsIntegration
+{
+    public function __invoke(Event $event, ?EventHint $hint): ?Event
+    {
+        if (!($exception = $hint?->exception) instanceof \Throwable) {
+            return $event;
+        }
+
+        $sentry = SentrySdk::getCurrentHub();
+
+        foreach ($sentry->getClient()?->getOptions()->getIgnoreExceptions() ?? [] as $class) {
+            while ($exception && $exception = $exception->getPrevious()) {
+                if (\is_a($exception, $class)) {
+                    return null;
+                }
+            }
+        }
+
+        return $event;
+    }
+}

src/OneupContaoSentryBundle.php

@@ -2,10 +2,14 @@
 
 declare(strict_types=1);
 
-namespace Oneup\Contao\SentryBundle;
+namespace Oneup\ContaoSentryBundle;
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 class OneupContaoSentryBundle extends Bundle
 {
+    public function getPath(): string
+    {
+        return \dirname(__DIR__);
+    }
 }

src/Resources/config/services.yml

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Oneup\Contao\SentryBundle\Twig;
+namespace Oneup\ContaoSentryBundle\Twig;
 
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFilter;

src/Twig/ContaoSentryTwigExtension.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Oneup\Contao\SentryBundle\Twig;
+namespace Oneup\ContaoSentryBundle\Twig;
 
 use Sentry\SentrySdk;
 
@@ -22,15 +22,9 @@ public function sentryLastEventIdFilter(): ?string
     public function sentryDsn(): ?string
     {
         if ((null !== $client = SentrySdk::getCurrentHub()->getClient())
-            && (null !== $dsn = $client->getOptions()->getDsn())) {
-
-            return sprintf(
-                '%s://%s@%s/%s',
-                $dsn->getScheme(),
-                $dsn->getPublicKey(),
-                $dsn->getHost(),
-                $dsn->getProjectId()
-            );
+            && (null !== $dsn = $client->getOptions()->getDsn())
+        ) {
+            return (string) $dsn;
         }
 
         return null;