CR

Author: stayallive

src/Sentry/Laravel/Tracing/Integrations/IntegrationInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Sentry\Laravel\Tracing\Integrations;
+
+interface IntegrationInterface
+{
+    public static function supported(): bool;
+}

src/Sentry/Laravel/Tracing/Integrations/LighthouseIntegration.php

@@ -2,8 +2,9 @@
 
 namespace Sentry\Laravel\Tracing\Integrations;
 
+use GraphQL\Language\AST\DocumentNode;
 use GraphQL\Language\AST\OperationDefinitionNode;
-use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Contracts\Events\Dispatcher as EventDispatcher;
 use Nuwave\Lighthouse\Events\EndExecution;
 use Nuwave\Lighthouse\Events\EndRequest;
 use Nuwave\Lighthouse\Events\StartExecution;
@@ -12,9 +13,9 @@
 use Sentry\SentrySdk;
 use Sentry\Tracing\SpanContext;
 
-class LighthouseIntegration
+class LighthouseIntegration implements IntegrationInterface
 {
-    /** @var array<int, <string|null, \GraphQL\Language\AST\OperationDefinitionNode>> $operations */
+    /** @var array<int, array{?string, \GraphQL\Language\AST\OperationDefinitionNode}> $operations */
     private $operations;
 
     /** @var \Sentry\Tracing\Span|null $previousSpan */
@@ -26,16 +27,12 @@ class LighthouseIntegration
     /** @var \Sentry\Tracing\Span|null $operationSpan */
     private $operationSpan;
 
-    public function __construct(Dispatcher $evenDispatcher)
+    public function __construct(EventDispatcher $eventDispatcher)
     {
-        if (!class_exists(StartRequest::class)) {
-            return;
-        }
-
-        $evenDispatcher->listen(StartRequest::class, [$this, 'handleStartRequest']);
-        $evenDispatcher->listen(StartExecution::class, [$this, 'handleStartExecution']);
-        $evenDispatcher->listen(EndExecution::class, [$this, 'handleEndExecution']);
-        $evenDispatcher->listen(EndRequest::class, [$this, 'handleEndRequest']);
+        $eventDispatcher->listen(StartRequest::class, [$this, 'handleStartRequest']);
+        $eventDispatcher->listen(StartExecution::class, [$this, 'handleStartExecution']);
+        $eventDispatcher->listen(EndExecution::class, [$this, 'handleEndExecution']);
+        $eventDispatcher->listen(EndRequest::class, [$this, 'handleEndRequest']);
     }
 
     public function handleStartRequest(StartRequest $startRequest): void
@@ -46,12 +43,12 @@ public function handleStartRequest(StartRequest $startRequest): void
             return;
         }
 
-        $this->operations = [];
-
         $context = new SpanContext;
         $context->setOp('graphql.request');
 
-        $this->requestSpan = $this->previousSpan->startChild($context);
+        $this->operations    = [];
+        $this->requestSpan   = $this->previousSpan->startChild($context);
+        $this->operationSpan = null;
 
         SentrySdk::getCurrentHub()->setSpan($this->requestSpan);
     }
@@ -62,14 +59,18 @@ public function handleStartExecution(StartExecution $startExecution): void
             return;
         }
 
+        if (!$startExecution->query instanceof DocumentNode) {
+            return;
+        }
+
         /** @var \GraphQL\Language\AST\OperationDefinitionNode|null $operationDefinition */
         $operationDefinition = $startExecution->query->definitions[0] ?? null;
 
-        if ($operationDefinition === null) {
+        if (!$operationDefinition instanceof OperationDefinitionNode) {
             return;
         }
 
-        $this->operations[] = [$startExecution->operationName, $operationDefinition];
+        $this->operations[] = [$startExecution->operationName ?? null, $operationDefinition];
 
         $context = new SpanContext;
         $context->setOp(
@@ -147,6 +148,9 @@ private function updateTransaction(): void
         SentrySdk::getCurrentHub()->getTransaction()->setName($transactionName);
     }
 
+    /**
+     * @return array<int, string>
+     */
     private function extractOperationNames(OperationDefinitionNode $operation): array
     {
         if ($operation->name !== null) {
@@ -157,9 +161,9 @@ private function extractOperationNames(OperationDefinitionNode $operation): arra
 
         /** @var \GraphQL\Language\AST\FieldNode $selection */
         foreach ($operation->selectionSet->selections as $selection) {
-            $selectionSet[] = $selection->alias === null
-                ? $selection->name->value
-                : $selection->alias->value;
+            // Not respecting aliases because they are only relevant for clients
+            // and the tracing we extract here is targeted at server developers.
+            $selectionSet[] = $selection->name->value;
         }
 
         sort($selectionSet, SORT_STRING);
@@ -169,6 +173,10 @@ private function extractOperationNames(OperationDefinitionNode $operation): arra
 
     public static function supported(): bool
     {
-        return class_exists(StartRequest::class);
+        if (!class_exists(StartRequest::class) || !class_exists(StartExecution::class)) {
+            return false;
+        }
+
+        return property_exists(StartExecution::class, 'query');
     }
 }

src/Sentry/Laravel/Tracing/ServiceProvider.php

@@ -11,6 +11,7 @@
 use Illuminate\View\Factory as ViewFactory;
 use InvalidArgumentException;
 use Laravel\Lumen\Application as Lumen;
+use RuntimeException;
 use Sentry\Laravel\BaseServiceProvider;
 use Sentry\Serializer\RepresentationSerializer;
 use Throwable;
@@ -132,7 +133,18 @@ private function bootIntegrations(): void
             $this->getUserConfig()['tracing_integrations'] ?? []
         );
 
+        /** @var \Sentry\Laravel\Tracing\Integrations\IntegrationInterface $tracingIntegration */
         foreach ($integrations as $tracingIntegration) {
+            if (!is_subclass_of($tracingIntegration, Integrations\IntegrationInterface::class)) {
+                throw new RuntimeException(
+                    sprintf('Sentry tracing integrations should an instance of `%s`.', Integrations\IntegrationInterface::class)
+                );
+            }
+
+            if (!$tracingIntegration::supported()) {
+                continue;
+            }
+
             try {
                 $this->app->make($tracingIntegration);
             } catch (Throwable $e) {