Improve how we signal that a route was matched

src/Sentry/Laravel/EventHandler.php

@@ -19,6 +19,7 @@
 use Laravel\Sanctum\Events as Sanctum;
 use RuntimeException;
 use Sentry\Breadcrumb;
+use Sentry\Laravel\Tracing\Middleware;
 use Sentry\Laravel\Util\WorksWithUris;
 use Sentry\SentrySdk;
 use Sentry\State\Scope;
@@ -216,6 +217,8 @@ protected function routeMatchedHandler(RoutingEvents\RouteMatched $match): void
             return;
         }
 
+        Middleware::signalRouteWasMatched();
+
         [$routeName] = Integration::extractNameAndSourceForRoute($match->route);
 
         Integration::addBreadcrumb(new Breadcrumb(

src/Sentry/Laravel/Features/FolioPackageIntegration.php

@@ -10,6 +10,7 @@
 use Laravel\Folio\Pipeline\MatchedView;
 use Sentry\Breadcrumb;
 use Sentry\Laravel\Integration;
+use Sentry\Laravel\Tracing\Middleware;
 use Sentry\SentrySdk;
 use Sentry\Tracing\TransactionSource;
 
@@ -29,6 +30,8 @@ public function onBoot(Dispatcher $events): void
 
     public function handleViewMatched(ViewMatched $matched): void
     {
+        Middleware::signalRouteWasMatched();
+
         $routeName = $this->extractRouteForMatchedView($matched->matchedView, $matched->mountPath);
 
         Integration::addBreadcrumb(new Breadcrumb(

src/Sentry/Laravel/Tracing/Middleware.php

@@ -15,6 +15,9 @@
 
 use function Sentry\continueTrace;
 
+/**
+ * @internal
+ */
 class Middleware
 {
     /**
@@ -59,6 +62,13 @@ class Middleware
      */
     private $registeredTerminatingCallback = false;
 
+    /**
+     * Whether a defined route was matched in the application.
+     *
+     * @var bool
+     */
+    private $didRouteMatch = false;
+
     /**
      * Construct the Sentry tracing middleware.
      *
@@ -80,8 +90,8 @@ public function __construct($app, bool $continueAfterResponse = true)
      */
     public function handle(Request $request, Closure $next)
     {
-        if (app()->bound(HubInterface::class)) {
-            $this->startTransaction($request, app(HubInterface::class));
+        if ($this->app->bound(HubInterface::class)) {
+            $this->startTransaction($request, $this->app->make(HubInterface::class));
         }
 
         return $next($request);
@@ -98,12 +108,12 @@ public function handle(Request $request, Closure $next)
     public function terminate(Request $request, $response): void
     {
         // If there is no transaction or the HubInterface is not bound in the container there is nothing for us to do
-        if ($this->transaction === null || !app()->bound(HubInterface::class)) {
+        if ($this->transaction === null || !$this->app->bound(HubInterface::class)) {
             return;
         }
 
         // We stop here if a route has not been matched unless we are configured to trace missing routes
-        if (config('sentry.tracing.missing_routes', false) === false && $request->route() === null) {
+        if (!$this->didRouteMatch && config('sentry.tracing.missing_routes', false) === false) {
             return;
         }
 
@@ -154,6 +164,9 @@ public function setBootedTimestamp(?float $timestamp = null): void
 
     private function startTransaction(Request $request, HubInterface $sentry): void
     {
+        // Reset our internal state in case we are handling multiple requests (e.g. in Octane)
+        $this->didRouteMatch = false;
+
         // Try $_SERVER['REQUEST_TIME_FLOAT'] then LARAVEL_START and fallback to microtime(true) if neither are defined
         $requestStartTime = $request->server(
             'REQUEST_TIME_FLOAT',
@@ -260,4 +273,18 @@ private function finishTransaction(): void
         $this->transaction->finish();
         $this->transaction = null;
     }
+
+    private function internalSignalRouteWasMatched(): void
+    {
+        $this->didRouteMatch = true;
+    }
+
+    public static function signalRouteWasMatched(): void
+    {
+        if (!app()->bound(self::class)) {
+            return;
+        }
+
+        app(self::class)->internalSignalRouteWasMatched();
+    }
 }

test/Sentry/ClientBuilderDecoratorTest.php

@@ -21,7 +21,7 @@ public function testClientHasEnvironmentSetFromDecorator(): void
     {
         $this->assertEquals(
             'from_service_container',
-            $this->getClientFromContainer()->getOptions()->getEnvironment()
+            $this->getSentryClientFromContainer()->getOptions()->getEnvironment()
         );
     }
 }

test/Sentry/EventHandler/ConsoleEventsTest.php

@@ -19,7 +19,7 @@ public function testCommandBreadcrumbIsRecordedWhenEnabled(): void
 
         $this->dispatchCommandStartEvent();
 
-        $lastBreadcrumb = $this->getLastBreadcrumb();
+        $lastBreadcrumb = $this->getLastSentryBreadcrumb();
 
         $this->assertEquals('Starting Artisan command: test:command', $lastBreadcrumb->getMessage());
         $this->assertEquals('--foo=bar', $lastBreadcrumb->getMetadata()['input']);
@@ -35,7 +35,7 @@ public function testCommandBreadcrumIsNotRecordedWhenDisabled(): void
 
         $this->dispatchCommandStartEvent();
 
-        $this->assertEmpty($this->getCurrentBreadcrumbs());
+        $this->assertEmpty($this->getCurrentSentryBreadcrumbs());
     }
 
     private function dispatchCommandStartEvent(): void

test/Sentry/EventHandler/DatabaseEventsTest.php

@@ -24,7 +24,7 @@ public function testSqlQueriesAreRecordedWhenEnabled(): void
             $this->getMockedConnection()
         ));
 
-        $lastBreadcrumb = $this->getLastBreadcrumb();
+        $lastBreadcrumb = $this->getLastSentryBreadcrumb();
 
         $this->assertEquals($query, $lastBreadcrumb->getMessage());
     }
@@ -44,7 +44,7 @@ public function testSqlBindingsAreRecordedWhenEnabled(): void
             $this->getMockedConnection()
         ));
 
-        $lastBreadcrumb = $this->getLastBreadcrumb();
+        $lastBreadcrumb = $this->getLastSentryBreadcrumb();
 
         $this->assertEquals($query, $lastBreadcrumb->getMessage());
         $this->assertEquals($bindings, $lastBreadcrumb->getMetadata()['bindings']);
@@ -65,7 +65,7 @@ public function testSqlQueriesAreRecordedWhenDisabled(): void
             $this->getMockedConnection()
         ));
 
-        $this->assertEmpty($this->getCurrentBreadcrumbs());
+        $this->assertEmpty($this->getCurrentSentryBreadcrumbs());
     }
 
     public function testSqlBindingsAreRecordedWhenDisabled(): void
@@ -83,7 +83,7 @@ public function testSqlBindingsAreRecordedWhenDisabled(): void
             $this->getMockedConnection()
         ));
 
-        $lastBreadcrumb = $this->getLastBreadcrumb();
+        $lastBreadcrumb = $this->getLastSentryBreadcrumb();
 
         $this->assertEquals($query, $lastBreadcrumb->getMessage());
         $this->assertFalse(isset($lastBreadcrumb->getMetadata()['bindings']));

test/Sentry/EventHandler/LogEventsTest.php

@@ -21,7 +21,7 @@ public function testLaravelLogsAreRecordedWhenEnabled(): void
             $context = ['1']
         ));
 
-        $lastBreadcrumb = $this->getLastBreadcrumb();
+        $lastBreadcrumb = $this->getLastSentryBreadcrumb();
 
         $this->assertEquals($level, $lastBreadcrumb->getLevel());
         $this->assertEquals($message, $lastBreadcrumb->getMessage());
@@ -38,6 +38,6 @@ public function testLaravelLogsAreRecordedWhenDisabled(): void
 
         $this->dispatchLaravelEvent(new MessageLogged('debug', 'test message'));
 
-        $this->assertEmpty($this->getCurrentBreadcrumbs());
+        $this->assertEmpty($this->getCurrentSentryBreadcrumbs());
     }
 }

test/Sentry/EventHandler/QueueEventsTest.php

@@ -15,18 +15,18 @@ public function testQueueJobPushesAndPopsScopeWithBreadcrumbs(): void
     {
         dispatch(new QueueEventsTestJobWithBreadcrumb);
 
-        $this->assertCount(0, $this->getCurrentBreadcrumbs());
+        $this->assertCount(0, $this->getCurrentSentryBreadcrumbs());
     }
 
     public function testQueueJobThatReportsPushesAndPopsScopeWithBreadcrumbs(): void
     {
         dispatch(new QueueEventsTestJobThatReportsAnExceptionWithBreadcrumb);
 
-        $this->assertCount(0, $this->getCurrentBreadcrumbs());
+        $this->assertCount(0, $this->getCurrentSentryBreadcrumbs());
 
-        $this->assertNotNull($this->getLastEvent());
+        $this->assertNotNull($this->getLastSentryEvent());
 
-        $event = $this->getLastEvent();
+        $event = $this->getLastSentryEvent();
 
         $this->assertCount(2, $event->getBreadcrumbs());
     }
@@ -41,12 +41,12 @@ public function testQueueJobThatThrowsLeavesPushedScopeWithBreadcrumbs(): void
 
         // We still expect to find the breadcrumbs from the job here so they are attached to reported exceptions
 
-        $this->assertCount(2, $this->getCurrentBreadcrumbs());
+        $this->assertCount(2, $this->getCurrentSentryBreadcrumbs());
 
-        $firstBreadcrumb = $this->getCurrentBreadcrumbs()[0];
+        $firstBreadcrumb = $this->getCurrentSentryBreadcrumbs()[0];
         $this->assertEquals('queue.job', $firstBreadcrumb->getCategory());
 
-        $secondBreadcrumb = $this->getCurrentBreadcrumbs()[1];
+        $secondBreadcrumb = $this->getCurrentSentryBreadcrumbs()[1];
         $this->assertEquals('test', $secondBreadcrumb->getCategory());
     }
 
@@ -66,12 +66,12 @@ public function testQueueJobsThatThrowPopsAndPushesScopeWithBreadcrumbsBeforeNew
 
         // We only expect to find the breadcrumbs from the second job here
 
-        $this->assertCount(2, $this->getCurrentBreadcrumbs());
+        $this->assertCount(2, $this->getCurrentSentryBreadcrumbs());
 
-        $firstBreadcrumb = $this->getCurrentBreadcrumbs()[0];
+        $firstBreadcrumb = $this->getCurrentSentryBreadcrumbs()[0];
         $this->assertEquals('queue.job', $firstBreadcrumb->getCategory());
 
-        $secondBreadcrumb = $this->getCurrentBreadcrumbs()[1];
+        $secondBreadcrumb = $this->getCurrentSentryBreadcrumbs()[1];
         $this->assertEquals('test #2', $secondBreadcrumb->getMessage());
     }
 
@@ -83,7 +83,7 @@ public function testQueueJobsWithBreadcrumbSetInBetweenKeepsNonJobBreadcrumbsOnC
 
         dispatch(new QueueEventsTestJobWithBreadcrumb);
 
-        $this->assertCount(1, $this->getCurrentBreadcrumbs());
+        $this->assertCount(1, $this->getCurrentSentryBreadcrumbs());
     }
 }
 

test/Sentry/Features/CacheIntegrationTest.php

@@ -11,29 +11,29 @@ public function testCacheBreadcrumbForWriteAndHitIsRecorded(): void
     {
         Cache::put($key = 'foo', 'bar');
 
-        $this->assertEquals("Written: {$key}", $this->getLastBreadcrumb()->getMessage());
+        $this->assertEquals("Written: {$key}", $this->getLastSentryBreadcrumb()->getMessage());
 
         Cache::get('foo');
 
-        $this->assertEquals("Read: {$key}", $this->getLastBreadcrumb()->getMessage());
+        $this->assertEquals("Read: {$key}", $this->getLastSentryBreadcrumb()->getMessage());
     }
 
     public function testCacheBreadcrumbForWriteAndForgetIsRecorded(): void
     {
         Cache::put($key = 'foo', 'bar');
 
-        $this->assertEquals("Written: {$key}", $this->getLastBreadcrumb()->getMessage());
+        $this->assertEquals("Written: {$key}", $this->getLastSentryBreadcrumb()->getMessage());
 
         Cache::forget($key);
 
-        $this->assertEquals("Forgotten: {$key}", $this->getLastBreadcrumb()->getMessage());
+        $this->assertEquals("Forgotten: {$key}", $this->getLastSentryBreadcrumb()->getMessage());
     }
 
     public function testCacheBreadcrumbForMissIsRecorded(): void
     {
         Cache::get($key = 'foo');
 
-        $this->assertEquals("Missed: {$key}", $this->getLastBreadcrumb()->getMessage());
+        $this->assertEquals("Missed: {$key}", $this->getLastSentryBreadcrumb()->getMessage());
     }
 
     public function testCacheBreadcrumbIsNotRecordedWhenDisabled(): void
@@ -46,6 +46,6 @@ public function testCacheBreadcrumbIsNotRecordedWhenDisabled(): void
 
         Cache::get('foo');
 
-        $this->assertEmpty($this->getCurrentBreadcrumbs());
+        $this->assertEmpty($this->getCurrentSentryBreadcrumbs());
     }
 }

test/Sentry/Features/ConsoleIntegrationTest.php

@@ -13,16 +13,18 @@ class ConsoleIntegrationTest extends TestCase
     public function testScheduleMacro(): void
     {
         /** @var Event $scheduledEvent */
-        $scheduledEvent = $this->getScheduler()->call(function () {})->sentryMonitor('test-monitor');
+        $scheduledEvent = $this->getScheduler()
+            ->call(function () {})
+            ->sentryMonitor('test-monitor');
 
         $scheduledEvent->run($this->app);
 
         // We expect a total of 2 events to be sent to Sentry:
         // 1. The start check-in event
         // 2. The finish check-in event
-        $this->assertEquals(2, $this->getEventsCount());
+        $this->assertSentryCheckInCount(2);
 
-        $finishCheckInEvent = $this->getLastEvent();
+        $finishCheckInEvent = $this->getLastSentryEvent();
 
         $this->assertNotNull($finishCheckInEvent->getCheckIn());
         $this->assertEquals('test-monitor', $finishCheckInEvent->getCheckIn()->getMonitorSlug());
@@ -48,9 +50,9 @@ public function testScheduleMacroWithTimeZone(): void
         // We expect a total of 2 events to be sent to Sentry:
         // 1. The start check-in event
         // 2. The finish check-in event
-        $this->assertEquals(2, $this->getEventsCount());
+        $this->assertSentryCheckInCount(2);
 
-        $finishCheckInEvent = $this->getLastEvent();
+        $finishCheckInEvent = $this->getLastSentryEvent();
 
         $this->assertNotNull($finishCheckInEvent->getCheckIn());
         $this->assertEquals($expectedTimezone, $finishCheckInEvent->getCheckIn()->getMonitorConfig()->getTimezone());
@@ -66,9 +68,9 @@ public function testScheduleMacroAutomaticSlug(): void
         // We expect a total of 2 events to be sent to Sentry:
         // 1. The start check-in event
         // 2. The finish check-in event
-        $this->assertEquals(2, $this->getEventsCount());
+        $this->assertSentryCheckInCount(2);
 
-        $finishCheckInEvent = $this->getLastEvent();
+        $finishCheckInEvent = $this->getLastSentryEvent();
 
         $this->assertNotNull($finishCheckInEvent->getCheckIn());
         $this->assertEquals('scheduled_artisan-inspire', $finishCheckInEvent->getCheckIn()->getMonitorSlug());
@@ -89,7 +91,7 @@ public function testScheduleMacroWithoutDsnSet(): void
 
         $scheduledEvent->run($this->app);
 
-        $this->assertEquals(0, $this->getEventsCount());
+        $this->assertSentryCheckInCount(0);
     }
 
     public function testScheduleMacroIsRegistered(): void