Fix not replacing session key before session is started

Author: stayallive

src/Sentry/Laravel/Features/CacheIntegration.php

@@ -4,7 +4,7 @@
 
 use Illuminate\Cache\Events;
 use Illuminate\Contracts\Events\Dispatcher;
-use Illuminate\Http\Request;
+use Illuminate\Contracts\Session\Session;
 use Illuminate\Redis\Events as RedisEvents;
 use Illuminate\Redis\RedisManager;
 use Illuminate\Support\Str;
@@ -262,23 +262,13 @@ private function maybeHandleCacheEventAsEndOfSpan(Events\CacheEvent $event): boo
     private function getSessionKey(): ?string
     {
         try {
-            /** @var Request $request */
-            $request = $this->container()->make('request');
+            /** @var Session $request */
+            $request = $this->container()->make('session.store');
 
-            if (!$request->hasSession()) {
-                return false;
-            }
-
-            $session = $request->session();
-
-            if (!$session->isStarted()) {
-                return false;
-            }
-
-            return $session->getId();
+            return $request->getId();
         } catch (\Exception $e) {
-            // If anything goes wrong, we assume it's not a session key
-            return false;
+            // We can assume the session store is not available here so there is no session key to retrieve
+            return null;
         }
     }
 

test/Sentry/Features/CacheIntegrationTest.php

@@ -58,7 +58,6 @@ public function testCacheBreadcrumbIsNotRecordedWhenDisabled(): void
     public function testCacheBreadcrumbReplacesSessionKeyWithPlaceholder(): void
     {
         // Start a session properly in the test environment
-        $this->ensureRequestIsBoundWithSession();
         $this->startSession();
         $sessionId = $this->app['session']->getId();
 
@@ -182,8 +181,6 @@ public function testCacheSpanReplacesSessionKeyWithPlaceholder(): void
     {
         $this->markSkippedIfTracingEventsNotAvailable();
 
-        // Start a session properly in the test environment
-        $this->ensureRequestIsBoundWithSession();
         $this->startSession();
         $sessionId = $this->app['session']->getId();
 
@@ -201,7 +198,6 @@ public function testCacheSpanReplacesMultipleSessionKeysWithPlaceholder(): void
         $this->markSkippedIfTracingEventsNotAvailable();
 
         // Start a session properly in the test environment
-        $this->ensureRequestIsBoundWithSession();
         $this->startSession();
         $sessionId = $this->app['session']->getId();
 
@@ -252,17 +248,4 @@ private function executeAndReturnMostRecentSpan(callable $callable): Span
 
         return array_pop($spans);
     }
-
-    private function ensureRequestIsBoundWithSession(): void
-    {
-        if ($this->app->bound('request')) {
-            $request = $this->app['request'];
-        } else {
-            $request = $this->app->make(\Illuminate\Http\Request::class);
-
-            $this->app->instance('request', $request);
-        }
-
-        $request->setLaravelSession($this->app['session']->driver());
-    }
 }