Refactor logger option

phpstan-baseline.neon

@@ -30,6 +30,16 @@ parameters:
 			count: 1
 			path: src/Integration/RequestIntegration.php
 
+		-
+			message: "#^Parameter \\#2 \\.\\.\\.\\$values of function sprintf expects bool\\|float\\|int\\|string\\|null, mixed given\\.$#"
+			count: 1
+			path: src/Logger/DebugFileLogger.php
+
+		-
+			message: "#^Parameter \\#2 \\.\\.\\.\\$values of function sprintf expects bool\\|float\\|int\\|string\\|null, mixed given\\.$#"
+			count: 1
+			path: src/Logger/DebugStdOutLogger.php
+
 		-
 			message: "#^Parameter \\#1 \\$level of method Monolog\\\\Handler\\\\AbstractHandler\\:\\:__construct\\(\\) expects 100\\|200\\|250\\|300\\|400\\|500\\|550\\|600\\|'ALERT'\\|'alert'\\|'CRITICAL'\\|'critical'\\|'DEBUG'\\|'debug'\\|'EMERGENCY'\\|'emergency'\\|'ERROR'\\|'error'\\|'INFO'\\|'info'\\|'NOTICE'\\|'notice'\\|'WARNING'\\|'warning'\\|Monolog\\\\Level, int\\|Monolog\\\\Level\\|string given\\.$#"
 			count: 1
@@ -136,7 +146,7 @@ parameters:
 			path: src/Options.php
 
 		-
-			message: "#^Method Sentry\\\\Options\\:\\:getLogger\\(\\) should return string but returns mixed\\.$#"
+			message: "#^Method Sentry\\\\Options\\:\\:getLogger\\(\\) should return Psr\\\\Log\\\\LoggerInterface\\|null but returns mixed\\.$#"
 			count: 1
 			path: src/Options.php
 

src/Client.php

@@ -93,11 +93,12 @@ public function __construct(
     ) {
         $this->options = $options;
         $this->transport = $transport;
-        $this->logger = $logger ?? new NullLogger();
-        $this->integrations = IntegrationRegistry::getInstance()->setupIntegrations($options, $this->logger);
-        $this->stacktraceBuilder = new StacktraceBuilder($options, $representationSerializer ?? new RepresentationSerializer($this->options));
         $this->sdkIdentifier = $sdkIdentifier ?? self::SDK_IDENTIFIER;
         $this->sdkVersion = $sdkVersion ?? self::SDK_VERSION;
+        $this->stacktraceBuilder = new StacktraceBuilder($options, $representationSerializer ?? new RepresentationSerializer($this->options));
+        $this->logger = $logger ?? new NullLogger();
+
+        $this->integrations = IntegrationRegistry::getInstance()->setupIntegrations($options, $this->logger);
     }
 
     /**
@@ -269,10 +270,6 @@ private function prepareEvent(Event $event, ?EventHint $hint = null, ?Scope $sco
             $event->setEnvironment($this->options->getEnvironment() ?? Event::DEFAULT_ENVIRONMENT);
         }
 
-        if ($event->getLogger() === null) {
-            $event->setLogger($this->options->getLogger(false));
-        }
-
         $isTransaction = EventType::transaction() === $event->getType();
         $sampleRate = $this->options->getSampleRate();
 

src/ClientBuilder.php

@@ -63,6 +63,8 @@ public function __construct(?Options $options = null)
     {
         $this->options = $options ?? new Options();
 
+        $this->logger = $this->options->getLogger() ?? null;
+
         $this->httpClient = $this->options->getHttpClient() ?? new HttpClient($this->sdkIdentifier, $this->sdkVersion);
         $this->transport = $this->options->getTransport() ?? new HttpTransport(
             $this->options,
@@ -92,6 +94,11 @@ public function setRepresentationSerializer(RepresentationSerializerInterface $r
         return $this;
     }
 
+    public function getLogger(): ?LoggerInterface
+    {
+        return $this->logger;
+    }
+
     public function setLogger(LoggerInterface $logger): self
     {
         $this->logger = $logger;

src/Logger/DebugFileLogger.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Logger;
+
+use Psr\Log\AbstractLogger;
+
+class DebugFileLogger extends AbstractLogger
+{
+    /**
+     * @var string
+     */
+    private $filePath;
+
+    public function __construct(string $filePath)
+    {
+        $this->filePath = $filePath;
+    }
+
+    /**
+     * @param mixed   $level
+     * @param mixed[] $context
+     */
+    public function log($level, \Stringable|string $message, array $context = []): void
+    {
+        file_put_contents($this->filePath, sprintf("sentry/sentry: [%s] %s\n", $level, (string) $message), \FILE_APPEND);
+    }
+}

src/Logger/DebugStdOutLogger.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Logger;
+
+use Psr\Log\AbstractLogger;
+
+class DebugStdOutLogger extends AbstractLogger
+{
+    /**
+     * @param mixed   $level
+     * @param mixed[] $context
+     */
+    public function log($level, \Stringable|string $message, array $context = []): void
+    {
+        file_put_contents('php://stdout', sprintf("sentry/sentry: [%s] %s\n", $level, (string) $message));
+    }
+}

src/Options.php

@@ -4,6 +4,7 @@
 
 namespace Sentry;
 
+use Psr\Log\LoggerInterface;
 use Sentry\HttpClient\HttpClientInterface;
 use Sentry\Integration\ErrorListenerIntegration;
 use Sentry\Integration\IntegrationInterface;
@@ -309,30 +310,18 @@ public function setInAppIncludedPaths(array $paths): self
     }
 
     /**
-     * Gets the logger used by Sentry.
-     *
-     * @deprecated since version 3.2, to be removed in 4.0
+     * Gets a PSR-3 compatible logger to log internal debug messages.
      */
-    public function getLogger(/* bool $triggerDeprecation = true */): string
+    public function getLogger(): ?LoggerInterface
     {
-        if (\func_num_args() === 0 || func_get_arg(0) !== false) {
-            @trigger_error(sprintf('Method %s() is deprecated since version 3.2 and will be removed in 4.0.', __METHOD__), \E_USER_DEPRECATED);
-        }
-
         return $this->options['logger'];
     }
 
     /**
-     * Sets the logger used by Sentry.
-     *
-     * @param string $logger The logger
-     *
-     * @deprecated since version 3.2, to be removed in 4.0
+     * Sets a PSR-3 compatible logger to log internal debug messages.
      */
-    public function setLogger(string $logger): self
+    public function setLogger(LoggerInterface $logger): self
     {
-        @trigger_error(sprintf('Method %s() is deprecated since version 3.2 and will be removed in 4.0.', __METHOD__), \E_USER_DEPRECATED);
-
         $options = array_merge($this->options, ['logger' => $logger]);
 
         $this->options = $this->resolver->resolve($options);
@@ -994,7 +983,7 @@ private function configureOptions(OptionsResolver $resolver): void
             'attach_stacktrace' => false,
             'context_lines' => 5,
             'environment' => $_SERVER['SENTRY_ENVIRONMENT'] ?? null,
-            'logger' => 'php',
+            'logger' => null,
             'release' => $_SERVER['SENTRY_RELEASE'] ?? null,
             'dsn' => $_SERVER['SENTRY_DSN'] ?? null,
             'server_name' => gethostname(),
@@ -1041,7 +1030,7 @@ private function configureOptions(OptionsResolver $resolver): void
         $resolver->setAllowedTypes('environment', ['null', 'string']);
         $resolver->setAllowedTypes('in_app_exclude', 'string[]');
         $resolver->setAllowedTypes('in_app_include', 'string[]');
-        $resolver->setAllowedTypes('logger', ['null', 'string']);
+        $resolver->setAllowedTypes('logger', ['null', LoggerInterface::class]);
         $resolver->setAllowedTypes('release', ['null', 'string']);
         $resolver->setAllowedTypes('dsn', ['null', 'string', 'bool', Dsn::class]);
         $resolver->setAllowedTypes('server_name', 'string');
@@ -1089,14 +1078,6 @@ private function configureOptions(OptionsResolver $resolver): void
         $resolver->setNormalizer('in_app_include', function (SymfonyOptions $options, array $value) {
             return array_map([$this, 'normalizeAbsolutePath'], $value);
         });
-
-        $resolver->setNormalizer('logger', function (SymfonyOptions $options, ?string $value): ?string {
-            if ($value !== 'php') {
-                @trigger_error('The option "logger" is deprecated.', \E_USER_DEPRECATED);
-            }
-
-            return $value;
-        });
     }
 
     /**

src/Transport/Result.php

@@ -9,8 +9,10 @@
 /**
  * This class contains the details of the sending operation of an event, e.g.
  * if it was sent successfully or if it was skipped because of some reason.
+ *
+ * @internal
  */
-final class Result
+class Result
 {
     /**
      * @var ResultStatus The status of the sending operation of the event

tests/ClientTest.php

@@ -217,7 +217,6 @@ public static function captureEventDataProvider(): \Generator
     {
         $event = Event::createEvent();
         $expectedEvent = clone $event;
-        $expectedEvent->setLogger('php');
         $expectedEvent->setServerName('example.com');
         $expectedEvent->setRelease('0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33');
         $expectedEvent->setEnvironment('development');
@@ -241,7 +240,6 @@ public static function captureEventDataProvider(): \Generator
         $event->setTags(['context' => 'production']);
 
         $expectedEvent = clone $event;
-        $expectedEvent->setLogger('php');
         $expectedEvent->setTags(['context' => 'production', 'ios_version' => '14.0']);
 
         yield 'Options set && event properties set => event properties override options' => [
@@ -259,7 +257,6 @@ public static function captureEventDataProvider(): \Generator
         $event->setServerName('example.com');
 
         $expectedEvent = clone $event;
-        $expectedEvent->setLogger('php');
         $expectedEvent->setEnvironment('production');
 
         yield 'Environment option set to null && no event property set => fallback to default value' => [
@@ -274,7 +271,6 @@ public static function captureEventDataProvider(): \Generator
         $event->setExceptions([new ExceptionDataBag(new \ErrorException())]);
 
         $expectedEvent = clone $event;
-        $expectedEvent->setLogger('php');
         $expectedEvent->setEnvironment('production');
 
         yield 'Error level is set && exception is instance of ErrorException => preserve the error level set by the user' => [