Remove the config section related to Monolog

getsentry · Jan 6, 2021 · 051c42a · 051c42a
1 parent 7f82f1c
commit 051c42a
Show file tree

Hide file tree

Showing 14 changed files with 23 additions and 183 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@
 - PHP 8 support (#399, thanks to @Yozhef)
 - Retrieve the request from the `RequestStack` when using the `RequestIntegration` integration (#361)
 - Reorganize the folder structure and change CS standard (#405)
+- [BC BREAK] Removed the `monolog` configuration option. Instead, register the service manually (#406)
 
 ## 3.5.3 (2020-10-13)
 

diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -157,6 +157,27 @@
 
 - Removed the `ClientBuilderConfigurator` class.
 - Removed the `SentryBundle::getSdkVersion()` method.
-- Removed `SentryBundle::getCurrentHub()` method, use `SentrySdk::getCurrentHub()` instead.
+- Removed the `SentryBundle::getCurrentHub()` method, use `SentrySdk::getCurrentHub()` instead.
 - Removed the `Sentry\ClientBuilderInterface` and `Sentry\Options` services.
 - Refactorized the `ErrorTypesParser` class and made it `@internal`.
+- Removed the `sentry.monolog` configuration option.
+
+  Before
+
+  ```yaml
+  sentry:
+      monolog:
+          level: !php/const Monolog\Logger::ERROR
+          bubble: false
+  ```
+
+  After
+
+  ```yaml
+  services:
+      Sentry\Monolog\Handler:
+          arguments:
+              $hub: Sentry\State\HubInterface
+              $level: !php/const Monolog\Logger::ERROR
+              $bubble: false
+  ```
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -5,7 +5,6 @@
 namespace Sentry\SentryBundle\DependencyInjection;
 
 use Jean85\PrettyVersions;
-use Monolog\Logger;
 use Sentry\Options;
 use Sentry\SentryBundle\ErrorTypesParser;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
@@ -128,7 +127,6 @@ public function getConfigTreeBuilder(): TreeBuilder
         ;
 
         $this->addMessengerSection($rootNode);
-        $this->addMonologSection($rootNode);
         $this->addListenerSection($rootNode);
 
         return $treeBuilder;
@@ -147,26 +145,6 @@ private function addMessengerSection(ArrayNodeDefinition $rootNode): void
             ->end();
     }
 
-    private function addMonologSection(ArrayNodeDefinition $rootNode): void
-    {
-        $rootNode
-            ->children()
-                ->arrayNode('monolog')
-                    ->addDefaultsIfNotSet()
-                    ->children()
-                        ->arrayNode('error_handler')
-                            ->{class_exists(Logger::class) ? 'canBeDisabled' : 'canBeEnabled'}()
-                        ->end()
-                        ->scalarNode('level')
-                            ->defaultValue(Logger::DEBUG)
-                            ->cannotBeEmpty()
-                        ->end()
-                        ->booleanNode('bubble')->defaultTrue()->end()
-                    ->end()
-                ->end()
-            ->end();
-    }
-
     private function addListenerSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode

diff --git a/src/DependencyInjection/SentryExtension.php b/src/DependencyInjection/SentryExtension.php
@@ -5,14 +5,12 @@
 namespace Sentry\SentryBundle\DependencyInjection;
 
 use Jean85\PrettyVersions;
-use Monolog\Logger as MonologLogger;
 use Sentry\Client;
 use Sentry\ClientBuilder;
 use Sentry\Integration\IgnoreErrorsIntegration;
 use Sentry\Integration\IntegrationInterface;
 use Sentry\Integration\RequestFetcherInterface;
 use Sentry\Integration\RequestIntegration;
-use Sentry\Monolog\Handler;
 use Sentry\Options;
 use Sentry\SentryBundle\EventListener\ErrorListener;
 use Sentry\SentryBundle\EventListener\MessengerListener;
@@ -23,7 +21,6 @@
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
-use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\DependencyInjection\Loader;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\ErrorHandler\Error\FatalError;
@@ -62,7 +59,6 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         $this->registerConfiguration($container, $mergedConfig);
         $this->registerErrorListenerConfiguration($container, $mergedConfig);
         $this->registerMessengerListenerConfiguration($container, $mergedConfig['messenger']);
-        $this->registerMonologHandlerConfiguration($container, $mergedConfig['monolog']);
     }
 
     /**
@@ -155,28 +151,6 @@ private function registerMessengerListenerConfiguration(ContainerBuilder $contai
         $container->getDefinition(MessengerListener::class)->setArgument(1, $config['capture_soft_fails']);
     }
 
-    /**
-     * @param array<string, mixed> $config
-     */
-    private function registerMonologHandlerConfiguration(ContainerBuilder $container, array $config): void
-    {
-        $errorHandlerConfig = $config['error_handler'];
-
-        if (!$errorHandlerConfig['enabled']) {
-            $container->removeDefinition(Handler::class);
-
-            return;
-        }
-
-        if (!class_exists(MonologLogger::class)) {
-            throw new LogicException(sprintf('To use the "%s" class you need to require the "symfony/monolog-bundle" package.', Handler::class));
-        }
-
-        $definition = $container->getDefinition(Handler::class);
-        $definition->setArgument(0, MonologLogger::toMonologLevel($config['level']));
-        $definition->setArgument(1, $config['bubble']);
-    }
-
     /**
      * @param string[]             $integrations
      * @param array<string, mixed> $config

diff --git a/src/Resources/config/schema/sentry-1.0.xsd b/src/Resources/config/schema/sentry-1.0.xsd
@@ -12,7 +12,6 @@
             <xsd:element name="options" type="options" minOccurs="0" maxOccurs="1" />
             <xsd:element name="messenger" type="messenger" minOccurs="0" maxOccurs="1" />
             <xsd:element name="listener-priorities" type="listeners-priorities" minOccurs="0" maxOccurs="1" />
-            <xsd:element name="monolog" type="monolog" minOccurs="0" maxOccurs="1" />
         </xsd:choice>
 
         <xsd:attribute name="register-error-listener" type="xsd:boolean" />
@@ -90,48 +89,4 @@
         <xsd:attribute name="console-terminate" type="xsd:integer" />
         <xsd:attribute name="worker-error" type="xsd:integer" />
     </xsd:complexType>
-
-    <xsd:complexType name="monolog">
-        <xsd:choice maxOccurs="unbounded">
-            <xsd:element name="error-handler" type="monolog-error-handler" minOccurs="0" maxOccurs="1" />
-        </xsd:choice>
-
-        <xsd:attribute name="level" type="monolog-level" />
-        <xsd:attribute name="bubble" type="xsd:boolean" />
-    </xsd:complexType>
-
-    <xsd:complexType name="monolog-error-handler">
-        <xsd:attribute name="enabled" type="xsd:boolean" />
-    </xsd:complexType>
-
-    <xsd:simpleType name="monolog-level">
-        <xsd:restriction base="xsd:string">
-            <xsd:enumeration value="debug" />
-            <xsd:enumeration value="info" />
-            <xsd:enumeration value="notice" />
-            <xsd:enumeration value="warning" />
-            <xsd:enumeration value="error" />
-            <xsd:enumeration value="critical" />
-            <xsd:enumeration value="alert" />
-            <xsd:enumeration value="emergency" />
-
-            <xsd:enumeration value="DEBUG" />
-            <xsd:enumeration value="INFO" />
-            <xsd:enumeration value="NOTICE" />
-            <xsd:enumeration value="WARNING" />
-            <xsd:enumeration value="ERROR" />
-            <xsd:enumeration value="CRITICAL" />
-            <xsd:enumeration value="ALERT" />
-            <xsd:enumeration value="EMERGENCY" />
-
-            <xsd:enumeration value="100" />
-            <xsd:enumeration value="200" />
-            <xsd:enumeration value="250" />
-            <xsd:enumeration value="300" />
-            <xsd:enumeration value="400" />
-            <xsd:enumeration value="500" />
-            <xsd:enumeration value="550" />
-            <xsd:enumeration value="600" />
-        </xsd:restriction>
-    </xsd:simpleType>
 </xsd:schema>
diff --git a/src/Resources/config/services.xml b/src/Resources/config/services.xml
@@ -63,10 +63,6 @@
             <tag name="console.command" />
         </service>
 
-        <service id="Sentry\Monolog\Handler" class="Sentry\Monolog\Handler">
-            <argument type="service" id="Sentry\State\HubInterface" />
-        </service>
-
         <service id="Sentry\Integration\RequestFetcherInterface" class="Sentry\SentryBundle\Integration\RequestFetcher">
             <argument type="service" id="Symfony\Component\HttpFoundation\RequestStack" />
             <argument type="service">

diff --git a/tests/DependencyInjection/ConfigurationTest.php b/tests/DependencyInjection/ConfigurationTest.php
@@ -5,7 +5,6 @@
 namespace Sentry\SentryBundle\Tests\DependencyInjection;
 
 use Jean85\PrettyVersions;
-use Monolog\Logger;
 use PHPUnit\Framework\TestCase;
 use Sentry\SentryBundle\DependencyInjection\Configuration;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
@@ -35,13 +34,6 @@ public function testProcessConfigurationWithDefaultConfiguration(): void
                 'enabled' => interface_exists(MessageBusInterface::class),
                 'capture_soft_fails' => true,
             ],
-            'monolog' => [
-                'error_handler' => [
-                    'enabled' => class_exists(Logger::class),
-                ],
-                'level' => Logger::DEBUG,
-                'bubble' => true,
-            ],
             'register_error_listener' => true,
             'listener_priorities' => [
                 'request' => 1,

diff --git a/tests/DependencyInjection/Fixtures/php/monolog_handler.php b/tests/DependencyInjection/Fixtures/php/monolog_handler.php
diff --git a/tests/DependencyInjection/Fixtures/php/monolog_handler_disabled.php b/tests/DependencyInjection/Fixtures/php/monolog_handler_disabled.php
diff --git a/tests/DependencyInjection/Fixtures/xml/monolog_handler.xml b/tests/DependencyInjection/Fixtures/xml/monolog_handler.xml
diff --git a/tests/DependencyInjection/Fixtures/xml/monolog_handler_disabled.xml b/tests/DependencyInjection/Fixtures/xml/monolog_handler_disabled.xml
diff --git a/tests/DependencyInjection/Fixtures/yml/monolog_handler.yml b/tests/DependencyInjection/Fixtures/yml/monolog_handler.yml
diff --git a/tests/DependencyInjection/Fixtures/yml/monolog_handler_disabled.yml b/tests/DependencyInjection/Fixtures/yml/monolog_handler_disabled.yml
diff --git a/tests/DependencyInjection/SentryExtensionTest.php b/tests/DependencyInjection/SentryExtensionTest.php
@@ -5,11 +5,9 @@
 namespace Sentry\SentryBundle\Tests\DependencyInjection;
 
 use Jean85\PrettyVersions;
-use Monolog\Logger as MonologLogger;
 use PHPUnit\Framework\TestCase;
 use Sentry\ClientInterface;
 use Sentry\Integration\IgnoreErrorsIntegration;
-use Sentry\Monolog\Handler;
 use Sentry\Options;
 use Sentry\SentryBundle\DependencyInjection\SentryExtension;
 use Sentry\SentryBundle\EventListener\ConsoleCommandListener;
@@ -266,22 +264,6 @@ public function subRequestListenerDataProvider(): \Generator
         ];
     }
 
-    public function testMonologHandler(): void
-    {
-        $container = $this->createContainerFromFixture('monolog_handler');
-        $definition = $container->getDefinition(Handler::class);
-
-        $this->assertSame(MonologLogger::ERROR, $definition->getArgument(0));
-        $this->assertFalse($definition->getArgument(1));
-    }
-
-    public function testMonologHandlerIsRemovedWhenDisabled(): void
-    {
-        $container = $this->createContainerFromFixture('monolog_handler_disabled');
-
-        $this->assertFalse($container->hasDefinition(Handler::class));
-    }
-
     public function testClentIsCreatedFromOptions(): void
     {
         $container = $this->createContainerFromFixture('full');