Adds CacheAspect (#444)

Co-authored-by: Deeka Wong <[email protected]>

publish/sentry.php

@@ -58,6 +58,7 @@
     ],
 
     'breadcrumbs' => [
+        'cache' => env('SENTRY_BREADCRUMBS_CACHE', true),
         'sql_queries' => env('SENTRY_BREADCRUMBS_SQL_QUERIES', true),
         'sql_bindings' => env('SENTRY_BREADCRUMBS_SQL_BINDINGS', true),
         'sql_transaction' => env('SENTRY_BREADCRUMBS_SQL_TRANSACTION', true),

src/Aspect/CacheAspect.php

@@ -0,0 +1,62 @@
+<?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  [email protected]
+ */
+
+namespace FriendsOfHyperf\Sentry\Aspect;
+
+use FriendsOfHyperf\Sentry\Integration;
+use FriendsOfHyperf\Sentry\Switcher;
+use Hyperf\Di\Aop\AbstractAspect;
+use Hyperf\Di\Aop\ProceedingJoinPoint;
+use Sentry\Breadcrumb;
+
+use function Hyperf\Tappable\tap;
+
+class CacheAspect extends AbstractAspect
+{
+    public array $classes = [
+        'Hyperf\Cache\Driver\*Driver::fetch',
+        'Hyperf\Cache\Driver\*Driver::get',
+        'Hyperf\Cache\Driver\*Driver::getMultiple',
+        'Hyperf\Cache\Driver\*Driver::set',
+        'Hyperf\Cache\Driver\*Driver::setMultiple',
+        'Hyperf\Cache\Driver\*Driver::delete',
+        'Hyperf\Cache\Driver\*Driver::deleteMultiple',
+    ];
+
+    public function __construct(protected Switcher $switcher)
+    {
+    }
+
+    public function process(ProceedingJoinPoint $proceedingJoinPoint)
+    {
+        $startTime = microtime(true);
+
+        return tap($proceedingJoinPoint->process(), function ($result) use ($proceedingJoinPoint, $startTime) {
+            if (! $this->switcher->isBreadcrumbEnable('cache')) {
+                return;
+            }
+            $arguments = $proceedingJoinPoint->arguments['keys'];
+            $method = sprintf('%s::%s()', $proceedingJoinPoint->className, $proceedingJoinPoint->methodName);
+
+            $data['result'] = $result;
+            $data['arguments'] = $arguments;
+            $data['timeMs'] = (microtime(true) - $startTime) * 1000;
+
+            Integration::addBreadcrumb(new Breadcrumb(
+                Breadcrumb::LEVEL_INFO,
+                Breadcrumb::TYPE_DEFAULT,
+                'cache',
+                $method,
+                $data
+            ));
+        });
+    }
+}

src/ConfigProvider.php

@@ -20,6 +20,7 @@ public function __invoke(): array
         return [
             'aspects' => [
                 Aspect\BreadcrumbAspect::class,
+                Aspect\CacheAspect::class,
                 Aspect\CoroutineAspect::class,
                 Aspect\CrontabExecutorAspect::class,
                 Aspect\GuzzleHttpClientAspect::class,