Use own cookie logic to avoid regenaration issues with Laravel driver (#1662)

* Use own cookie logic to avoid regenaration issues with Laravel driver

* Add SessionDriver

* Deprecate old one

* Defer loading of httpdriver until needed, use old driver for Lumen

* Add cookie middleware to tests

* Tweak comments

Author: barryvdh

src/LaravelDebugbar.php

@@ -32,6 +32,8 @@
 use DebugBar\DataCollector\RequestDataCollector;
 use DebugBar\DataCollector\TimeDataCollector;
 use DebugBar\DebugBar;
+use DebugBar\HttpDriverInterface;
+use DebugBar\PhpHttpDriver;
 use DebugBar\Storage\PdoStorage;
 use DebugBar\Storage\RedisStorage;
 use Exception;
@@ -118,6 +120,26 @@ public function __construct($app = null)
         }
     }
 
+    /**
+     * Returns the HTTP driver
+     *
+     * If no http driver where defined, a PhpHttpDriver is automatically created
+     *
+     * @return HttpDriverInterface
+     */
+    public function getHttpDriver()
+    {
+        if ($this->httpDriver === null) {
+            if ($this->app->bound('cookie')) {
+                $this->httpDriver = $this->app->make(SessionHttpDriver::class);
+            } else {
+                $this->httpDriver = $this->app->make(SymfonyHttpDriver::class);
+            }
+        }
+
+        return $this->httpDriver;
+    }
+    
     /**
      * Enable the Debugbar and boot, if not already booted.
      */
@@ -736,13 +758,10 @@ public function modifyResponse(Request $request, Response $response)
         $sessionHiddens = $app['config']->get('debugbar.options.session.hiddens', []);
         if ($app->bound(SessionManager::class)) {
 
-            /** @var \Illuminate\Session\SessionManager $sessionManager */
-            $sessionManager = $app->make(SessionManager::class);
-            $httpDriver = new SymfonyHttpDriver($sessionManager, $response);
-            $this->setHttpDriver($httpDriver);
-
             if ($this->shouldCollect('session') && ! $this->hasCollector('session')) {
                 try {
+                    /** @var \Illuminate\Session\SessionManager $sessionManager */
+                    $sessionManager = $app->make(SessionManager::class);
                     $this->addCollector(new SessionCollector($sessionManager, $sessionHiddens));
                 } catch (Exception $e) {
                     $this->addCollectorException('Cannot add SessionCollector', $e);

src/ServiceProvider.php

@@ -10,6 +10,7 @@
 use Illuminate\Contracts\Http\Kernel;
 use Illuminate\Routing\Events\ResponsePrepared;
 use Illuminate\Routing\Router;
+use Illuminate\Session\CookieSessionHandler;
 use Illuminate\Session\SessionManager;
 use Illuminate\Support\Collection;
 
@@ -31,15 +32,19 @@ public function register()
         );
 
         $this->app->singleton(LaravelDebugbar::class, function ($app) {
-            $debugbar = new LaravelDebugbar($app);
+            return new LaravelDebugbar($app);
+        });
 
-            if ($app->bound(SessionManager::class)) {
-                $sessionManager = $app->make(SessionManager::class);
-                $httpDriver = new SymfonyHttpDriver($sessionManager);
-                $debugbar->setHttpDriver($httpDriver);
-            }
+        $this->app->singleton(SessionHttpDriver::class, function ($app) {
+            // Attach the Cookie Handler with Request
+            $cookieHandler = new CookieSessionHandler($app->make('cookie'), 0, true);
+            $cookieHandler->setRequest($app['request']);
+
+            return new SessionHttpDriver($cookieHandler);
+        });
 
-            return $debugbar;
+        $this->app->singleton(SymfonyHttpDriver::class, function ($app) {
+            return new SymfonyHttpDriver($app->make(SessionManager::class));
         });
 
         $this->app->alias(LaravelDebugbar::class, 'debugbar');
@@ -171,6 +176,12 @@ protected function registerResponseListener()
             /** @var LaravelDebugbar $debugbar */
             $debugbar = $this->app->make(LaravelDebugbar::class);
             if ($debugbar->isEnabled()) {
+                // Now that we have a Response, set it on the Driver
+                $httpDriver = $debugbar->getHttpDriver();
+                if ($httpDriver instanceof SessionHttpDriver || $httpDriver instanceof SymfonyHttpDriver) {
+                    $httpDriver->setResponse($event->response);
+                }
+
                 if ($event->response->isRedirection()) {
                     $debugbar->modifyResponse($event->request, $event->response);
                 } else {

src/SessionHttpDriver.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace Barryvdh\Debugbar;
+
+use DebugBar\HttpDriverInterface;
+use Illuminate\Session\Store;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\Session\Session;
+
+/**
+ * HTTP driver for Larave Request/Session using Cookies
+ */
+class SessionHttpDriver implements HttpDriverInterface
+{
+    /** @var \SessionHandlerInterface */
+    protected $session;
+
+    /** @var \Symfony\Component\HttpFoundation\Response */
+    protected $response;
+
+    protected $data = null;
+
+    protected $id = '_debugbar';
+
+    public function __construct($session, $response = null)
+    {
+        $this->session = $session;
+        $this->response = $response;
+    }
+
+    /**
+     * @param \Symfony\Component\HttpFoundation\Response $response
+     * @return void
+     */
+    public function setResponse($response)
+    {
+        $this->response = $response;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function setHeaders(array $headers)
+    {
+        if (!is_null($this->response)) {
+            $this->response->headers->add($headers);
+        }
+    }
+
+    protected function ensureStarted()
+    {
+        if ($this->data === null) {
+            $this->data = json_decode($this->session->read($this->id), true) ?: [];
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function isSessionStarted()
+    {
+        $this->ensureStarted();
+        return true;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function setSessionValue($name, $value)
+    {
+        $this->isSessionStarted();
+
+        $this->data[$name] = $value;
+        $this->session->write($this->id, json_encode($this->data));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function hasSessionValue($name)
+    {
+        $this->ensureStarted();
+
+        return array_key_exists($name, $this->data);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getSessionValue($name)
+    {
+        $this->ensureStarted();
+
+        return $this->data[$name] ?? null;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function deleteSessionValue($name)
+    {$this->isSessionStarted();
+
+        unset($this->data[$name]);
+
+        $this->session->write($this->id, json_encode($this->data));
+    }
+}

src/SymfonyHttpDriver.php

@@ -8,6 +8,8 @@
 
 /**
  * HTTP driver for Symfony Request/Session
+ *
+ * @deprecated
  */
 class SymfonyHttpDriver implements HttpDriverInterface
 {
@@ -23,6 +25,15 @@ public function __construct($session, $response = null)
         $this->response = $response;
     }
 
+    /**
+     * @param \Symfony\Component\HttpFoundation\Response $response
+     * @return void
+     */
+    public function setResponse($response)
+    {
+        $this->response = $response;
+    }
+
     /**
      * {@inheritDoc}
      */

tests/DebugbarBrowserTest.php

@@ -29,8 +29,9 @@ protected function getEnvironmentSetUp($app)
         $this->addWebRoutes($router);
         $this->addApiRoutes($router);
 
-        $kernel = app('Illuminate\Contracts\Http\Kernel');
-        $kernel->pushMiddleware('Illuminate\Session\Middleware\StartSession');
+        $kernel = app(\Illuminate\Contracts\Http\Kernel::class);
+        $kernel->pushMiddleware(\Illuminate\Session\Middleware\StartSession::class);
+        $kernel->pushMiddleware(\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class);
 
         \Orchestra\Testbench\Dusk\Options::withoutUI();
     }