feat(sentry): add SentrySdkAspect for coroutine-safe SDK usage

composer.json

@@ -32,7 +32,7 @@
         "psr/http-factory-implementation": "*",
         "psy/psysh": "^0.10.0 || ^0.11.0",
         "ramsey/uuid": "^4.7",
-        "sentry/sentry": "^4.19.0",
+        "sentry/sentry": "^4.21.0",
         "symfony/console": "^5.3 || ^6.0 || ^7.0",
         "symfony/http-foundation": "^5.3 || ^6.0 || ^7.0",
         "symfony/polyfill-php84": "^1.33",
@@ -330,4 +330,4 @@
         "test:types": "@php vendor/bin/pest --type-coverage",
         "test:unit": "@php vendor/bin/pest"
     }
-}
+}

src/sentry/composer.json

@@ -33,7 +33,7 @@
         "hyperf/http-server": "~3.1.0",
         "hyperf/support": "~3.1.0",
         "hyperf/tappable": "~3.1.0",
-        "sentry/sentry": "^4.19.0",
+        "sentry/sentry": "^4.21.0",
         "symfony/polyfill-php85": "^1.33"
     },
     "suggest": {
@@ -65,4 +65,4 @@
             "config": "FriendsOfHyperf\\Sentry\\ConfigProvider"
         }
     }
-}
+}

src/sentry/src/Aspect/CoroutineAspect.php

@@ -11,7 +11,6 @@
 
 namespace FriendsOfHyperf\Sentry\Aspect;
 
-use FriendsOfHyperf\Sentry\Integration;
 use Hyperf\Context\Context;
 use Hyperf\Di\Aop\AbstractAspect;
 use Hyperf\Di\Aop\ProceedingJoinPoint;
@@ -60,7 +59,7 @@ protected function handleCreate(ProceedingJoinPoint $proceedingJoinPoint): void
             }
 
             // Defer the flushing of events until the coroutine completes.
-            defer(fn () => Integration::flushEvents());
+            defer(fn () => SentrySdk::flush());
 
             // Continue the callable in the new Coroutine.
             $callable();

src/sentry/src/Aspect/SentrySdkAspect.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of friendsofhyperf/components.
+ *
+ * @link     https://github.com/friendsofhyperf/components
+ * @document https://github.com/friendsofhyperf/components/blob/main/README.md
+ * @contact  huangdijia@gmail.com
+ */
+
+namespace FriendsOfHyperf\Sentry\Aspect;
+
+use Closure;
+use Hyperf\Context\Context;
+use Hyperf\Di\Aop\AbstractAspect;
+use Hyperf\Di\Aop\ProceedingJoinPoint;
+use Sentry\SentrySdk;
+use Sentry\State\HubInterface;
+use Sentry\State\RuntimeContextManager;
+
+use function Hyperf\Support\make;
+
+/**
+ * @mixin \Sentry\SentrySdk
+ */
+class SentrySdkAspect extends AbstractAspect
+{
+    public array $classes = [
+        SentrySdk::class . '::init',
+        SentrySdk::class . '::setCurrentHub',
+        SentrySdk::class . '::getRuntimeContextManager',
+    ];
+
+    public function process(ProceedingJoinPoint $proceedingJoinPoint)
+    {
+        return match ($proceedingJoinPoint->methodName) {
+            'init' => $this->handleInit($proceedingJoinPoint),
+            'setCurrentHub' => $this->handleSetCurrentHub($proceedingJoinPoint),
+            'getRuntimeContextManager' => $this->handleGetRuntimeContextManager($proceedingJoinPoint),
+            default => $proceedingJoinPoint->process(),
+        };
+    }
+
+    private function handleInit(ProceedingJoinPoint $proceedingJoinPoint)
+    {
+        Context::set(
+            RuntimeContextManager::class,
+            new RuntimeContextManager(make(HubInterface::class))
+        );
+
+        return SentrySdk::getCurrentHub();
+    }
+
+    private function handleSetCurrentHub(ProceedingJoinPoint $proceedingJoinPoint)
+    {
+        $arguments = $proceedingJoinPoint->arguments['keys'] ?? [];
+        $hub = $arguments['hub'];
+        // @phpstan-ignore-next-line
+        Closure::bind(fn () => static::getRuntimeContextManager()->setCurrentHub($hub), null, SentrySdk::class)();
+
+        return $hub;
+    }
+
+    private function handleGetRuntimeContextManager(ProceedingJoinPoint $proceedingJoinPoint)
+    {
+        return Context::getOrSet(
+            RuntimeContextManager::class,
+            fn () => new RuntimeContextManager(make(HubInterface::class))
+        );
+    }
+}

src/sentry/src/ConfigProvider.php

@@ -28,6 +28,7 @@ public function __invoke(): array
                 Aspect\LoggerAspect::class,
                 Aspect\RedisAspect::class,
                 // Aspect\SingletonAspect::class,
+                Aspect\SentrySdkAspect::class,
                 Metrics\Aspect\CounterAspect::class,
                 Metrics\Aspect\HistogramAspect::class,
                 Tracing\Aspect\AmqpProducerAspect::class,
@@ -75,9 +76,7 @@ public function __invoke(): array
             ],
             'annotations' => [
                 'scan' => [
-                    'class_map' => [
-                        \Sentry\SentrySdk::class => __DIR__ . '/../class_map/SentrySdk.php',
-                    ],
+                    'class_map' => [],
                 ],
             ],
             'publish' => [

src/sentry/src/Integration.php

@@ -14,8 +14,6 @@
 use Sentry\Breadcrumb;
 use Sentry\Event;
 use Sentry\Integration\IntegrationInterface;
-use Sentry\Logs\Logs;
-use Sentry\Metrics\TraceMetrics;
 use Sentry\SentrySdk;
 use Sentry\State\Scope;
 use Sentry\Tracing\Span;
@@ -106,9 +104,7 @@ public static function setTransaction(?string $transaction): void
      */
     public static function flushEvents(): void
     {
-        Logs::getInstance()->flush();
-        TraceMetrics::getInstance()->flush();
-        SentrySdk::getCurrentHub()->getClient()?->flush();
+        SentrySdk::flush();
     }
 
     /**

src/sentry/src/Metrics/Listener/OnBeforeHandle.php

@@ -13,7 +13,6 @@
 
 use FriendsOfHyperf\Sentry\Constants;
 use FriendsOfHyperf\Sentry\Feature;
-use FriendsOfHyperf\Sentry\Integration;
 use FriendsOfHyperf\Sentry\Metrics\Event\MetricFactoryReady;
 use FriendsOfHyperf\Sentry\Metrics\Traits\MetricSetter;
 use FriendsOfHyperf\Sentry\SentryContext;
@@ -22,6 +21,7 @@
 use Hyperf\Event\Contract\ListenerInterface;
 use Psr\Container\ContainerInterface;
 use Psr\EventDispatcher\EventDispatcherInterface;
+use Sentry\SentrySdk;
 use Sentry\Unit;
 
 use function FriendsOfHyperf\Sentry\metrics;
@@ -115,8 +115,7 @@ function () use ($metrics) {
                     Unit::megabyte()
                 );
 
-                // metrics()->flush();
-                Integration::flushEvents();
+                SentrySdk::flush();
             }
         );
     }

src/sentry/src/Metrics/Listener/OnCoroutineServerStart.php

@@ -12,14 +12,14 @@
 namespace FriendsOfHyperf\Sentry\Metrics\Listener;
 
 use FriendsOfHyperf\Sentry\Feature;
-use FriendsOfHyperf\Sentry\Integration;
 use FriendsOfHyperf\Sentry\Metrics\Event\MetricFactoryReady;
 use FriendsOfHyperf\Sentry\Metrics\Traits\MetricSetter;
 use Hyperf\Coordinator\Timer;
 use Hyperf\Event\Contract\ListenerInterface;
 use Hyperf\Server\Event\MainCoroutineServerStart;
 use Psr\Container\ContainerInterface;
 use Psr\EventDispatcher\EventDispatcherInterface;
+use Sentry\SentrySdk;
 use Sentry\Unit;
 
 use function FriendsOfHyperf\Sentry\metrics;
@@ -113,8 +113,7 @@ function () use ($metrics) {
                     Unit::megabyte()
                 );
 
-                // metrics()->flush();
-                Integration::flushEvents();
+                SentrySdk::flush();
             }
         );
     }

src/sentry/src/Metrics/Listener/OnMetricFactoryReady.php

@@ -13,7 +13,6 @@
 
 use FriendsOfHyperf\Sentry\Constants as SentryConstants;
 use FriendsOfHyperf\Sentry\Feature;
-use FriendsOfHyperf\Sentry\Integration;
 use FriendsOfHyperf\Sentry\Metrics\CoroutineServerStats;
 use FriendsOfHyperf\Sentry\Metrics\Event\MetricFactoryReady;
 use FriendsOfHyperf\Sentry\Metrics\Traits\MetricSetter;
@@ -22,6 +21,7 @@
 use Hyperf\Event\Contract\ListenerInterface;
 use Hyperf\Support\System;
 use Psr\Container\ContainerInterface;
+use Sentry\SentrySdk;
 use Sentry\Unit;
 use Swoole\Server as SwooleServer;
 
@@ -130,8 +130,7 @@ function () use ($metrics, $serverStatsFactory, $workerId) {
                     Unit::megabyte()
                 );
 
-                // metrics()->flush();
-                Integration::flushEvents();
+                SentrySdk::flush();
             }
         );
     }

src/sentry/src/Metrics/Listener/OnWorkerStart.php

@@ -12,14 +12,14 @@
 namespace FriendsOfHyperf\Sentry\Metrics\Listener;
 
 use FriendsOfHyperf\Sentry\Feature;
-use FriendsOfHyperf\Sentry\Integration;
 use FriendsOfHyperf\Sentry\Metrics\Event\MetricFactoryReady;
 use FriendsOfHyperf\Sentry\Metrics\Traits\MetricSetter;
 use Hyperf\Coordinator\Timer;
 use Hyperf\Event\Contract\ListenerInterface;
 use Hyperf\Framework\Event\BeforeWorkerStart;
 use Psr\Container\ContainerInterface;
 use Psr\EventDispatcher\EventDispatcherInterface;
+use Sentry\SentrySdk;
 use Sentry\Unit;
 use Swoole\Server;
 
@@ -120,8 +120,7 @@ function () use ($metrics, $event) {
                     Unit::megabyte()
                 );
 
-                // metrics()->flush();
-                Integration::flushEvents();
+                SentrySdk::flush();
             }
         );
     }

src/sentry/src/Metrics/Listener/PoolWatcher.php

@@ -12,13 +12,13 @@
 namespace FriendsOfHyperf\Sentry\Metrics\Listener;
 
 use FriendsOfHyperf\Sentry\Feature;
-use FriendsOfHyperf\Sentry\Integration;
 use Hyperf\Coordinator\Timer;
 use Hyperf\Event\Contract\ListenerInterface;
 use Hyperf\Framework\Event\BeforeWorkerStart;
 use Hyperf\Pool\Pool;
 use Hyperf\Server\Event\MainCoroutineServerStart;
 use Psr\Container\ContainerInterface;
+use Sentry\SentrySdk;
 
 use function FriendsOfHyperf\Sentry\metrics;
 
@@ -90,8 +90,7 @@ function () use ($pool, $workerId, $poolName) {
                     ]
                 );
 
-                // metrics()->flush();
-                Integration::flushEvents();
+                SentrySdk::flush();
             }
         );
     }

src/sentry/src/Metrics/Listener/QueueWatcher.php

@@ -12,13 +12,13 @@
 namespace FriendsOfHyperf\Sentry\Metrics\Listener;
 
 use FriendsOfHyperf\Sentry\Feature;
-use FriendsOfHyperf\Sentry\Integration;
 use FriendsOfHyperf\Sentry\Metrics\Event\MetricFactoryReady;
 use Hyperf\AsyncQueue\Driver\DriverFactory;
 use Hyperf\Contract\ConfigInterface;
 use Hyperf\Coordinator\Timer;
 use Hyperf\Event\Contract\ListenerInterface;
 use Psr\Container\ContainerInterface;
+use Sentry\SentrySdk;
 
 use function FriendsOfHyperf\Sentry\metrics;
 
@@ -84,8 +84,7 @@ function () {
                     );
                 }
 
-                // metrics()->flush();
-                Integration::flushEvents();
+                SentrySdk::flush();
             }
         );
     }

src/sentry/src/Metrics/Timer.php

@@ -11,6 +11,7 @@
 
 namespace FriendsOfHyperf\Sentry\Metrics;
 
+use Sentry\SentrySdk;
 use Sentry\Unit;
 
 use function FriendsOfHyperf\Sentry\metrics;
@@ -55,7 +56,7 @@ public function end(bool $flush = false): void
             $this->unit ?? Unit::second()
         );
 
-        $flush && metrics()->flush();
+        $flush && SentrySdk::flush();
 
         $this->ended = true;
     }