✨ Support Sentry V4

.github/workflows/ci.yml

@@ -24,6 +24,7 @@ jobs:
           - php: 8.1 # should use monolog v3
           - php: 8.2 # should use monolog v3
           - php: 8.3 # should use monolog v3
+          # TODO matrix should support Both versions of Sentry SDK
     steps:
       - uses: actions/checkout@v2
 

composer.json

@@ -37,14 +37,14 @@
     "require": {
         "php": "^7.4 || ^8.0",
         "monolog/monolog": "^1.6 || ^2.0 || ^3.0",
-        "sentry/sentry": "^3.1"
+        "sentry/sentry": "^3.1 || ^4.0"
     },
     "require-dev": {
         "coduo/php-matcher": "^6.0.8",
-        "friendsofphp/php-cs-fixer": "^3.16",
+        "friendsofphp/php-cs-fixer": "3.51.0",
         "jangregor/phpstan-prophecy": "1.0.0",
-        "phpstan/phpstan": "1.10.14",
-        "phpstan/phpstan-phpunit": "1.3.11",
+        "phpstan/phpstan": "1.10.59",
+        "phpstan/phpstan-phpunit": "1.3.16",
         "phpunit/phpunit": "^9.6.7",
         "symfony/phpunit-bridge": "^6.2.10",
         "symfony/var-dumper": ">4.3"

phpstan.neon.dist

@@ -6,6 +6,7 @@ parameters:
     inferPrivatePropertyTypeFromConstructor: true
     tipsOfTheDay: false
     checkMissingIterableValueType: false
+    treatPhpDocTypesAsCertain: false
 
     level: 8
     paths: [ src, tests ]

tests/SentryHandlerTest.php

@@ -4,28 +4,25 @@
 
 namespace BGalati\MonologSentryHandler\Tests;
 
-use BGalati\MonologSentryHandler\SentryHandler;
 use Coduo\PHPMatcher\PHPUnit\PHPMatcherAssertions;
-use GuzzleHttp\Promise\FulfilledPromise;
-use GuzzleHttp\Promise\PromiseInterface;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Level;
 use Monolog\Logger;
 use Monolog\LogRecord;
 use PHPUnit\Framework\TestCase;
 use Sentry\Breadcrumb;
+use Sentry\Client;
 use Sentry\ClientBuilder;
-use Sentry\Event;
 use Sentry\Integration\EnvironmentIntegration;
-use Sentry\Options;
-use Sentry\Response;
-use Sentry\ResponseStatus;
 use Sentry\SentrySdk;
 use Sentry\Severity;
 use Sentry\State\HubInterface;
-use Sentry\State\Scope;
-use Sentry\Transport\TransportFactoryInterface;
-use Sentry\Transport\TransportInterface;
+
+if (defined(Client::class.'::SDK_VERSION') && version_compare(Client::SDK_VERSION, '4.0.0') >= 0) {
+    require __DIR__.'/SentryStubV4.php';
+} else {
+    require __DIR__.'/SentryStubV3.php';
+}
 
 final class SentryHandlerTest extends TestCase
 {
@@ -47,7 +44,12 @@ protected function setUp(): void
                 ],
             ]
         );
-        $clientBuilder->setTransportFactory(new FakeTransportFactory($this->transport));
+
+        if (defined(Client::class.'::SDK_VERSION') && version_compare(Client::SDK_VERSION, '4.0.0') >= 0) {
+            $clientBuilder->setTransport($this->transport);
+        } else {
+            $clientBuilder->setTransportFactory(new FakeTransportFactory($this->transport));
+        }
 
         $client = $clientBuilder->getClient();
 
@@ -492,7 +494,7 @@ private function assertCapturedEvent(Severity $severity, string $message, array
 
         if ($breadcrumbs) {
             $this->assertMatchesPattern(
-                json_encode($breadcrumbs),
+                json_encode($breadcrumbs, JSON_THROW_ON_ERROR),
                 json_encode(
                     array_map(
                         static function (Breadcrumb $breadcrumb) {
@@ -544,88 +546,3 @@ private function createSentryHandler(?int $level = null): SpySentryHandler
         return $handler;
     }
 }
-
-class SpySentryHandler extends SentryHandler
-{
-    /**
-     * @var bool
-     */
-    public $afterWriteCalled = false;
-
-    protected function processScope(Scope $scope, $record, Event $sentryEvent): void
-    {
-        $scope->setExtra('processScope', 'called');
-    }
-
-    protected function afterWrite(): void
-    {
-        $this->afterWriteCalled = true;
-
-        parent::afterWrite();
-    }
-
-    public function resetSpy(): void
-    {
-        $this->afterWriteCalled = false;
-    }
-}
-
-class SpyTransport implements TransportInterface
-{
-    /**
-     * @var Event|null
-     */
-    public $spiedEvent;
-
-    /**
-     * @var bool
-     */
-    public $isFlushed = false;
-
-    public function send(Event $event): PromiseInterface
-    {
-        $this->spiedEvent = $event;
-
-        return new FulfilledPromise(new Response(ResponseStatus::skipped(), $event));
-    }
-
-    public function resetSpy(): void
-    {
-        $this->spiedEvent = null;
-        $this->isFlushed = false;
-    }
-
-    public function getSpiedEvent(): Event
-    {
-        if (null === $this->spiedEvent) {
-            throw new \RuntimeException('No spied scope');
-        }
-
-        return $this->spiedEvent;
-    }
-
-    public function close(?int $timeout = null): PromiseInterface
-    {
-        $this->isFlushed = true;
-
-        return new FulfilledPromise(true);
-    }
-}
-
-class FakeTransportFactory implements TransportFactoryInterface
-{
-    /**
-     * @var SpyTransport
-     */
-    private $transport;
-
-    public function __construct(SpyTransport $transport)
-    {
-        $this->transport = $transport;
-    }
-
-    public function create(Options $options): TransportInterface
-    {
-        return $this->transport;
-    }
-}

tests/SentryStubV3.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BGalati\MonologSentryHandler\Tests;
+
+use GuzzleHttp\Promise\FulfilledPromise;
+use GuzzleHttp\Promise\PromiseInterface;
+use Sentry\Event;
+use Sentry\Options;
+use Sentry\Response;
+use Sentry\ResponseStatus;
+use Sentry\Transport\TransportFactoryInterface;
+use Sentry\Transport\TransportInterface;
+
+class SpyTransport implements TransportInterface
+{
+    /**
+     * @var Event|null
+     */
+    public $spiedEvent;
+
+    /**
+     * @var bool
+     */
+    public $isFlushed = false;
+
+    public function send(Event $event): PromiseInterface
+    {
+        $this->spiedEvent = $event;
+
+        return new FulfilledPromise(new Response(ResponseStatus::skipped(), $event));
+    }
+
+    public function resetSpy(): void
+    {
+        $this->spiedEvent = null;
+        $this->isFlushed = false;
+    }
+
+    public function getSpiedEvent(): Event
+    {
+        if (null === $this->spiedEvent) {
+            throw new \RuntimeException('No spied scope');
+        }
+
+        return $this->spiedEvent;
+    }
+
+    public function close(?int $timeout = null): PromiseInterface
+    {
+        $this->isFlushed = true;
+
+        return new FulfilledPromise(true);
+    }
+}
+
+class FakeTransportFactory implements TransportFactoryInterface
+{
+    /**
+     * @var SpyTransport
+     */
+    private $transport;
+
+    public function __construct(SpyTransport $transport)
+    {
+        $this->transport = $transport;
+    }
+
+    public function create(Options $options): TransportInterface
+    {
+        return $this->transport;
+    }
+}

tests/SentryStubV4.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BGalati\MonologSentryHandler\Tests;
+
+use Sentry\Event;
+use Sentry\Transport\Result;
+use Sentry\Transport\ResultStatus;
+use Sentry\Transport\TransportInterface;
+
+class SpyTransport implements TransportInterface
+{
+    /**
+     * @var Event|null
+     */
+    public $spiedEvent;
+
+    /**
+     * @var bool
+     */
+    public $isFlushed = false;
+
+    public function send(Event $event): Result
+    {
+        $this->spiedEvent = $event;
+
+        return new Result(ResultStatus::skipped(), $event);
+    }
+
+    public function resetSpy(): void
+    {
+        $this->spiedEvent = null;
+        $this->isFlushed = false;
+    }
+
+    public function getSpiedEvent(): Event
+    {
+        if (null === $this->spiedEvent) {
+            throw new \RuntimeException('No spied scope');
+        }
+
+        return $this->spiedEvent;
+    }
+
+    public function close(?int $timeout = null): Result
+    {
+        $this->isFlushed = true;
+
+        return new Result(ResultStatus::success());
+    }
+}

tests/SpySentryHandler.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BGalati\MonologSentryHandler\Tests;
+
+use BGalati\MonologSentryHandler\SentryHandler;
+use Sentry\Event;
+use Sentry\State\Scope;
+
+class SpySentryHandler extends SentryHandler
+{
+    /**
+     * @var bool
+     */
+    public $afterWriteCalled = false;
+
+    protected function processScope(Scope $scope, $record, Event $sentryEvent): void
+    {
+        $scope->setExtra('processScope', 'called');
+    }
+
+    protected function afterWrite(): void
+    {
+        $this->afterWriteCalled = true;
+
+        parent::afterWrite();
+    }
+
+    public function resetSpy(): void
+    {
+        $this->afterWriteCalled = false;
+    }
+}