Added support for Livewire 3

.github/workflows/ci.yaml

@@ -130,8 +130,9 @@ jobs:
       - name: Install Composer dependencies
         run: |
           # friendsofphp/php-cs-fixer: No need for this package to run phpunit and it conflicts with older Laravel versions
+          # livewire/livewire: Only supported on Laravel 7.0 and above
           # laravel/folio: Only supported on PHP 8.1 + Laravel 10.0 and above
-          composer remove friendsofphp/php-cs-fixer laravel/folio --dev --no-interaction --no-update
+          composer remove friendsofphp/php-cs-fixer livewire/livewire laravel/folio --dev --no-interaction --no-update
 
           # Require the correct versions we want to run phpunit for
           composer require \

composer.json

@@ -36,6 +36,7 @@
     "require-dev": {
         "phpunit/phpunit": "^8.4 | ^9.3",
         "laravel/framework": "^6.0 | ^7.0 | ^8.0 | ^9.0 | ^10.0",
+        "livewire/livewire": "^2.0 | ^3.0",
         "orchestra/testbench": "^4.7 | ^5.1 | ^6.0 | ^7.0 | ^8.0",
         "friendsofphp/php-cs-fixer": "^3.11",
         "mockery/mockery": "^1.3",

phpstan-baseline.neon

@@ -90,31 +90,6 @@ parameters:
 			count: 1
 			path: src/Sentry/Laravel/EventHandler.php
 
-		-
-			message: "#^Parameter \\$component of method Sentry\\\\Laravel\\\\Features\\\\LivewirePackageIntegration\\:\\:handleComponentBoot\\(\\) has invalid type Livewire\\\\Component\\.$#"
-			count: 1
-			path: src/Sentry/Laravel/Features/LivewirePackageIntegration.php
-
-		-
-			message: "#^Parameter \\$component of method Sentry\\\\Laravel\\\\Features\\\\LivewirePackageIntegration\\:\\:handleComponentBooted\\(\\) has invalid type Livewire\\\\Component\\.$#"
-			count: 1
-			path: src/Sentry/Laravel/Features/LivewirePackageIntegration.php
-
-		-
-			message: "#^Parameter \\$component of method Sentry\\\\Laravel\\\\Features\\\\LivewirePackageIntegration\\:\\:handleComponentDehydrate\\(\\) has invalid type Livewire\\\\Component\\.$#"
-			count: 1
-			path: src/Sentry/Laravel/Features/LivewirePackageIntegration.php
-
-		-
-			message: "#^Parameter \\$component of method Sentry\\\\Laravel\\\\Features\\\\LivewirePackageIntegration\\:\\:handleComponentMount\\(\\) has invalid type Livewire\\\\Component\\.$#"
-			count: 1
-			path: src/Sentry/Laravel/Features/LivewirePackageIntegration.php
-
-		-
-			message: "#^Parameter \\$livewireManager of method Sentry\\\\Laravel\\\\Features\\\\LivewirePackageIntegration\\:\\:onBoot\\(\\) has invalid type Livewire\\\\LivewireManager\\.$#"
-			count: 1
-			path: src/Sentry/Laravel/Features/LivewirePackageIntegration.php
-
 		-
 			message: "#^Parameter \\$request of method Sentry\\\\Laravel\\\\Features\\\\LivewirePackageIntegration\\:\\:handleComponentBooted\\(\\) has invalid type Livewire\\\\Request\\.$#"
 			count: 1

src/Sentry/Laravel/Features/LivewirePackageIntegration.php

@@ -3,11 +3,13 @@
 namespace Sentry\Laravel\Features;
 
 use Livewire\Component;
+use Livewire\EventBus;
 use Livewire\LivewireManager;
 use Livewire\Request;
 use Sentry\Breadcrumb;
 use Sentry\Laravel\Integration;
 use Sentry\SentrySdk;
+use Sentry\State\Scope;
 use Sentry\Tracing\Span;
 use Sentry\Tracing\SpanContext;
 use Sentry\Tracing\TransactionSource;
@@ -16,8 +18,6 @@
 {
     private const FEATURE_KEY = 'livewire';
 
-    private const COMPONENT_SPAN_OP = 'ui.livewire.component';
-
     /** @var array<Span> */
     private $spanStack = [];
 
@@ -32,11 +32,56 @@
     }
 
     public function onBoot(LivewireManager $livewireManager): void
+    {
+        if (class_exists(EventBus::class)) {
+            $this->registerLivewireThreeEventListeners($livewireManager);
+
+            return;
+        }
+
+        $this->registerLivewireTwoEventListeners($livewireManager);
+    }
+
+    private function registerLivewireThreeEventListeners(LivewireManager $livewireManager): void
+    {
+        $livewireManager->listen('mount', function ($component, array $data) {
+            if ($this->isTracingFeatureEnabled(self::FEATURE_KEY)) {
+                $this->handleComponentBoot($component);
+            }
+
+            if ($this->isBreadcrumbFeatureEnabled(self::FEATURE_KEY)) {
+                $this->handleComponentMount($component, $data);
+            }
+        });
+
+        $livewireManager->listen('hydrate', function ($component, array $data) {
+            if ($this->isTracingFeatureEnabled(self::FEATURE_KEY)) {
+                $this->handleComponentBoot($component);
+            }
+
+            if ($this->isBreadcrumbFeatureEnabled(self::FEATURE_KEY)) {
+                $this->handleComponentHydrate($component, $data);
+            }
+        });
+
+        if ($this->isTracingFeatureEnabled(self::FEATURE_KEY)) {
+            $livewireManager->listen('dehydrate', [$this, 'handleComponentDehydrate']);
+        }
+
+        if ($this->isBreadcrumbFeatureEnabled(self::FEATURE_KEY)) {
+            $livewireManager->listen('call', [$this, 'handleComponentCall']);
+        }
+    }
+
+    private function registerLivewireTwoEventListeners(LivewireManager $livewireManager): void
     {
         $livewireManager->listen('component.booted', [$this, 'handleComponentBooted']);
 
         if ($this->isTracingFeatureEnabled(self::FEATURE_KEY)) {
-            $livewireManager->listen('component.boot', [$this, 'handleComponentBoot']);
+            $livewireManager->listen('component.boot', function ($component) {
+                $this->handleComponentBoot($component);
+            });
+
             $livewireManager->listen('component.dehydrate', [$this, 'handleComponentDehydrate']);
         }
 
@@ -45,8 +90,23 @@
         }
     }
 
-    public function handleComponentBoot(Component $component): void
+    public function handleComponentCall(Component $component, string $method, array $data): void
+    {
+        Integration::addBreadcrumb(new Breadcrumb(
+            Breadcrumb::LEVEL_INFO,
+            Breadcrumb::TYPE_DEFAULT,
+            'livewire',
+            "Component call: {$component->getName()}::{$method}",
+            $data
+        ));
+    }
+
+    public function handleComponentBoot(Component $component, ?string $method = null): void
     {
+        if ($this->isLivewireRequest()) {
+            $this->updateTransactionName($component->getName());
+        }
+
         $currentSpan = SentrySdk::getCurrentHub()->getSpan();
 
         if ($currentSpan === null) {
@@ -56,8 +116,12 @@
         $this->spanStack[] = $currentSpan;
 
         $context = new SpanContext;
-        $context->setOp(self::COMPONENT_SPAN_OP);
-        $context->setDescription($component->getName());
+        $context->setOp('ui.livewire.component');
+        $context->setDescription(
+            empty($method)
+                ? $component->getName()
+                : "{$component->getName()}::{$method}"
+        );
 
         $componentSpan = $currentSpan->startChild($context);
 
@@ -92,10 +156,21 @@
         }
 
         if ($this->isTracingFeatureEnabled(self::FEATURE_KEY)) {
-            $this->updateTransactionName($component::getName());
+            $this->updateTransactionName($component->getName());
         }
     }
 
+    public function handleComponentHydrate(Component $component, array $data): void
+    {
+        Integration::addBreadcrumb(new Breadcrumb(
+            Breadcrumb::LEVEL_INFO,
+            Breadcrumb::TYPE_DEFAULT,
+            'livewire',
+            "Component hydrate: {$component->getName()}",
+            $data
+        ));
+    }
+
     public function handleComponentDehydrate(Component $component): void
     {
         $currentSpan = SentrySdk::getCurrentHub()->getSpan();
@@ -113,7 +188,9 @@
 
     private function updateTransactionName(string $componentName): void
     {
-        $transaction = SentrySdk::getCurrentHub()->getTransaction();
+        $hub = SentrySdk::getCurrentHub();
+
+        $transaction = $hub->getTransaction();
 
         if ($transaction === null) {
             return;
@@ -125,6 +202,12 @@
         $transaction->getMetadata()->setSource(TransactionSource::custom());
 
         Integration::setTransaction($transactionName);
+
+        $hub->configureScope(function (Scope $scope) {
+            $livewireManager = $this->container()->make(LivewireManager::class);
+
+            $scope->setTag('livewire.original_url', $livewireManager->originalUrl());
+        });
     }
 
     private function isLivewireRequest(): bool
@@ -137,7 +220,7 @@
                 return false;
             }
 
-            return $request->header('x-livewire') === 'true';
+            return $request->hasHeader('x-livewire');
         } catch (\Throwable $e) {
             // If the request cannot be resolved, it's probably not a Livewire request.
             return false;