Merge pull request #19 from spatie/livewire-tracing

Add support for livewire tracing

Author: rubenvanassche

composer.json

@@ -22,7 +22,7 @@
         "ext-mbstring": "*",
         "illuminate/support": "^11.46|^12.0",
         "spatie/error-solutions": "^2.0",
-        "spatie/flare-client-php": "^2.3",
+        "spatie/flare-client-php": "^2.3.3",
         "spatie/laravel-error-share": "^1.0.3",
         "symfony/console": "^7.2.1",
         "symfony/var-dumper": "^7.2.3"

config/flare.php

@@ -186,7 +186,7 @@
     'sampler' => [
         'class' => \Spatie\FlareClient\Sampling\RateSampler::class,
         'config' => [
-            'rate' => 0.1,
+            'rate' => env('FLARE_SAMPLER_RATE', 0.1),
         ],
     ],
 

config/flare.php.stub

@@ -138,7 +138,7 @@ return [
         'sampler' => [
             'class' => \Spatie\FlareClient\Sampling\RateSampler::class,
             'config' => [
-                'rate' => 0.1,
+                'rate' => env('FLARE_SAMPLER_RATE', 0.1),
             ],
         ],
 ];

phpstan-baseline.neon

@@ -93,7 +93,7 @@ parameters:
 		-
 			message: '#^Property Spatie\\FlareClient\\Support\\CollectsResolver\:\:\$middlewares \(array\<class\-string\<Spatie\\FlareClient\\FlareMiddleware\\FlareMiddleware\>, array\<string, mixed\>\>\) does not accept array\<string, array\<string, mixed\>\>\.$#'
 			identifier: assign.propertyType
-			count: 1
+			count: 2
 			path: src/Support/CollectsResolver.php
 
 		-

src/AttributesProviders/LaravelJobAttributesProvider.php

@@ -204,6 +204,7 @@ protected function resolveCommandProperties(object $command, int $maxChainDepth)
             'deleteWhenMissingModels',
             'messageGroup',
             'deduplicator',
+            'tries',
         ];
 
         $properties = $jobProperties

src/AttributesProviders/LaravelRequestAttributesProvider.php

@@ -2,18 +2,30 @@
 
 namespace Spatie\LaravelFlare\AttributesProviders;
 
+use Closure;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Request as LaravelRequest;
+use Illuminate\Routing\RedirectController;
 use Illuminate\Routing\Route;
+use Illuminate\Routing\ViewController;
 use Livewire\LivewireManager;
+use ReflectionFunction;
 use Spatie\FlareClient\AttributesProviders\RequestAttributesProvider as BaseRequestAttributesProvider;
+use Spatie\LaravelFlare\Enums\LaravelRouteActionType;
 use Symfony\Component\HttpFoundation\Request;
 use Throwable;
 
 class LaravelRequestAttributesProvider extends BaseRequestAttributesProvider
 {
-    public function toArray(Request $request, bool $includeContents = true, bool $includeLivewireComponents = false): array
-    {
+    /**
+     * @param array<string> $ignoreLivewireComponents
+     */
+    public function toArray(
+        Request $request,
+        bool $includeContents = true,
+        bool $includeLivewireComponents = false,
+        array $ignoreLivewireComponents = []
+    ): array {
         if (! $request instanceof LaravelRequest) {
             return parent::toArray($request, $includeContents);
         }
@@ -34,7 +46,7 @@ public function toArray(Request $request, bool $includeContents = true, bool $in
 
             return array_merge(
                 $attributes,
-                $provider->toArray($request, $livewireManager)
+                $provider->toArray($request, $livewireManager, $ignoreLivewireComponents),
             );
         } catch (Throwable) {
             return $attributes;
@@ -72,10 +84,8 @@ protected function getRoute(LaravelRequest $request): array
             'http.route' => $route->uri(),
             'laravel.route.name' => $route->getName(),
             'laravel.route.parameters' => $this->getRouteParameters($route),
-            'laravel.route.action' => $route->getActionName(),
             'laravel.route.middleware' => array_values($route->gatherMiddleware()),
-
-            'flare.entry_point.class' => $route->getActionName(),
+            ...$this->getActionAttributes($route),
         ];
     }
 
@@ -99,4 +109,50 @@ protected function isRunningLiveWire(LaravelRequest $request): bool
     {
         return $request->hasHeader('x-livewire') && $request->hasHeader('referer');
     }
+
+    protected function getActionAttributes(Route $route): array
+    {
+        $actionName = $route->getActionName();
+        $type = LaravelRouteActionType::Controller;
+
+        if ($actionName === '\\'.ViewController::class
+            && ($view = $route->parameter('view'))
+            && is_string($view)
+        ) {
+            $actionName = "view: {$view}";
+            $type = LaravelRouteActionType::View;
+        }
+
+        if ($actionName === '\\'.RedirectController::class
+            && ($destination = $route->parameter('destination'))
+            && is_string($destination)
+        ) {
+            $actionName = "redirect: {$destination}";
+            $type = LaravelRouteActionType::Redirect;
+        }
+
+        if ($actionName === 'Closure' && $route->getAction('uses') instanceof Closure) {
+            try {
+                $closure = $route->getAction('uses');
+
+                $reflection = new ReflectionFunction($closure);
+
+                $filename = str_replace(
+                    rtrim(base_path(), '/').'/',
+                    '',
+                    $reflection->getFileName() ?: 'unknown file',
+                );
+
+                $actionName = "closure: {$filename}";
+                $type = LaravelRouteActionType::Closure;
+            } catch (Throwable) {
+            }
+        }
+
+        return [
+            'laravel.route.action' => $actionName,
+            'laravel.route.action_type' => $type,
+            'flare.entry_point.class' => $actionName,
+        ];
+    }
 }

src/AttributesProviders/LivewireAttributesProvider.php

@@ -10,9 +10,13 @@
 
 class LivewireAttributesProvider
 {
+    /**
+     * @param array<string> $ignore
+     */
     public function toArray(
         Request $request,
         LivewireManager $livewire,
+        array $ignore = [],
     ): array {
         return [
             'http.request.method' => $livewire->originalMethod(),
@@ -21,11 +25,14 @@ public function toArray(
             'url.path' => parse_url($livewire->originalUrl(), PHP_URL_PATH),
             'url.query' => parse_url($livewire->originalUrl(), PHP_URL_QUERY),
             'flare.entry_point.value' => $livewire->originalUrl(),
-            'livewire.components' => $this->getLivewire($request, $livewire),
+            'livewire.components' => $this->getLivewire($request, $livewire, $ignore),
         ];
     }
 
-    protected function getLivewire(Request $request, LivewireManager $livewireManager): array
+    /**
+     * @param array<string> $ignore
+     */
+    protected function getLivewire(Request $request, LivewireManager $livewireManager, array $ignore): array
     {
         if ($request->has('components')) {
             $data = [];
@@ -35,6 +42,10 @@ protected function getLivewire(Request $request, LivewireManager $livewireManage
 
                 $class = app(ComponentRegistry::class)->getClass($snapshot['memo']['name']);
 
+                if (in_array($class, $ignore)) {
+                    continue;
+                }
+
                 $data[] = [
                     'component_class' => $class ?? null,
                     'data' => $snapshot['data'],

src/Enums/LaravelRouteActionType.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Spatie\LaravelFlare\Enums;
+
+enum LaravelRouteActionType: string
+{
+    case Controller = 'controller';
+    case Closure = 'closure';
+    case View = 'view';
+    case Redirect = 'redirect';
+    case Unknown = 'unknown';
+}

src/Enums/LivewireComponentPhase.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Spatie\LaravelFlare\Enums;
+
+enum LivewireComponentPhase: string
+{
+    case Mounting = 'mounting';
+    case Hydrating = 'hydrating';
+    case Calling = 'calling';
+    case Rendering = 'rendering';
+    case Dehydrating = 'dehydrating';
+
+    public static function fromLivewireProfileEvent(string $name): ?self
+    {
+        if (str_starts_with($name, 'call')) {
+            $name = 'call';
+        }
+
+        return match ($name) {
+            'mount' => self::Mounting,
+            'hydrate' => self::Hydrating,
+            'call' => self::Calling,
+            'render' => self::Rendering,
+            'dehydrate' => self::Dehydrating,
+            default => null,
+        };
+    }
+}

src/Enums/SpanType.php

@@ -9,4 +9,12 @@ enum SpanType: string implements FlareSpanType
     case Response = 'laravel_response';
     case Queueing = 'laravel_queueing';
     case Job = 'laravel_job';
+
+    case LivewireComponent = 'laravel_livewire_component';
+    case LivewireComponentMounting = 'laravel_livewire_component_mounting';
+    case LivewireComponentPreMounting = 'laravel_livewire_component_premounting';
+    case LivewireComponentHydrating = 'laravel_livewire_component_hydrating';
+    case LivewireComponentCall = 'laravel_livewire_component_call';
+    case LivewireComponentRendering = 'laravel_livewire_component_rendering';
+    case LivewireComponentDehydrating = 'laravel_livewire_component_dehydrating';
 }