Fix redirect session (#1657)

* Fix redirect session

* Check if enabled

* Test session redirect

* Test database

* Remove flag

* TWeak wait

Author: barryvdh

phpunit.xml.dist

@@ -28,6 +28,7 @@
     <php>
         <env name="DEBUGBAR_ENABLED" value="true"/>
         <env name="DB_CONNECTION" value="testing"/>
+        <env name="DB_CONNECTION" value="testing"/>
         <ini name="xdebug.file_link_format" value="vscode://file/%f:%l"/>
     </php>
 </phpunit>

src/LaravelDebugbar.php

@@ -100,8 +100,8 @@ class LaravelDebugbar extends DebugBar
 
     protected ?string $editorTemplateLink = null;
     protected array $remoteServerReplacements = [];
-
-
+    protected bool $responseIsModified = false;
+    protected array $stackedData = [];
     /**
      * @param Application $app
      */
@@ -711,10 +711,13 @@ public function modifyResponse(Request $request, Response $response)
     {
         /** @var Application $app */
         $app = $this->app;
-        if (!$this->isEnabled() || $this->isDebugbarRequest()) {
+        if (!$this->isEnabled() || $this->isDebugbarRequest() || $this->responseIsModified) {
             return $response;
         }
 
+        // Prevent duplicate modification
+        $this->responseIsModified = true;
+
         // Show the Http Response Exception in the Debugbar, when available
         if (isset($response->exception)) {
             $this->addThrowable($response->exception);
@@ -984,6 +987,29 @@ public function injectDebugbar(Response $response)
         }
     }
 
+    /**
+     * Checks if there is stacked data in the session
+     *
+     * @return boolean
+     */
+    public function hasStackedData()
+    {
+        return count($this->getStackedData(false)) > 0;
+    }
+
+    /**
+     * Returns the data stacked in the session
+     *
+     * @param boolean $delete Whether to delete the data in the session
+     * @return array
+     */
+    public function getStackedData($delete = true): array
+    {
+        $this->stackedData = array_merge($this->stackedData, parent::getStackedData($delete));
+
+        return $this->stackedData;
+    }
+
     /**
      * Disable the Debugbar
      */

src/ServiceProvider.php

@@ -2,17 +2,16 @@
 
 namespace Barryvdh\Debugbar;
 
-use Barryvdh\Debugbar\Middleware\DebugbarEnabled;
 use Barryvdh\Debugbar\Middleware\InjectDebugbar;
 use DebugBar\DataFormatter\DataFormatter;
 use DebugBar\DataFormatter\DataFormatterInterface;
 use Illuminate\Container\Container;
 use Illuminate\Contracts\View\Factory;
 use Illuminate\Contracts\Http\Kernel;
+use Illuminate\Routing\Events\ResponsePrepared;
 use Illuminate\Routing\Router;
 use Illuminate\Session\SessionManager;
 use Illuminate\Support\Collection;
-use Barryvdh\Debugbar\Facade as DebugBar;
 
 class ServiceProvider extends \Illuminate\Support\ServiceProvider
 {
@@ -106,6 +105,7 @@ public function boot()
 
         $this->loadRoutesFrom(__DIR__ . '/debugbar-routes.php');
 
+        $this->registerResponseListener();
         $this->registerMiddleware(InjectDebugbar::class);
 
         $this->commands(['command.debugbar.clear']);
@@ -151,4 +151,32 @@ protected function registerMiddleware($middleware)
         $kernel = $this->app[Kernel::class];
         $kernel->pushMiddleware($middleware);
     }
+
+    /**
+     * Register the Response Listener
+     *
+     * @param  string $middleware
+     */
+    protected function registerResponseListener()
+    {
+        if (!isset($this->app['events']) || !class_exists(ResponsePrepared::class)) {
+            return;
+        }
+
+        /**
+         * For redirects, prepare the response early to store in the session.
+         * For regular requests, get the stacked data early
+         */
+        $this->app['events']->listen(ResponsePrepared::class, function (ResponsePrepared $event) {
+            /** @var LaravelDebugbar $debugbar */
+            $debugbar = $this->app->make(LaravelDebugbar::class);
+            if ($debugbar->isEnabled()) {
+                if ($event->response->isRedirection()) {
+                    $debugbar->modifyResponse($event->request, $event->response);
+                } else {
+                    $debugbar->getStackedData();
+                }
+            }
+        });
+    }
 }

tests/DebugbarBrowserTest.php

@@ -3,9 +3,11 @@
 namespace Barryvdh\Debugbar\Tests;
 
 use Illuminate\Routing\Router;
+use Laravel\Dusk\Browser;
 
 class DebugbarBrowserTest extends BrowserTestCase
 {
+
     /**
      * Define environment setup.
      *
@@ -15,6 +17,8 @@ class DebugbarBrowserTest extends BrowserTestCase
      */
     protected function getEnvironmentSetUp($app)
     {
+        parent::getEnvironmentSetUp($app);
+
         $app['env'] = 'local';
 
 //        $app['config']->set('app.debug', true);
@@ -25,6 +29,9 @@ protected function getEnvironmentSetUp($app)
         $this->addWebRoutes($router);
         $this->addApiRoutes($router);
 
+        $kernel = app('Illuminate\Contracts\Http\Kernel');
+        $kernel->pushMiddleware('Illuminate\Session\Middleware\StartSession');
+
         \Orchestra\Testbench\Dusk\Options::withoutUI();
     }
 
@@ -33,6 +40,12 @@ protected function getEnvironmentSetUp($app)
      */
     protected function addWebRoutes(Router $router)
     {
+        $router->get('web/redirect', [
+            'uses' => function () {
+                return redirect($this->applicationBaseUrl() . '/web/plain');
+            }
+        ]);
+
         $router->get('web/plain', [
             'uses' => function () {
                 return 'PONG';
@@ -58,6 +71,19 @@ protected function addApiRoutes(Router $router)
         ]);
     }
 
+    public function testItStacksOnRedirect()
+    {
+        $this->browse(function (Browser $browser) {
+            $browser->visit('web/redirect')
+                ->assertSee('PONG')
+                ->waitFor('.phpdebugbar')
+                ->assertSee('GET web/plain')
+                ->click('.phpdebugbar-tab-history')
+                ->waitForTextIn('.phpdebugbar-widgets-dataset-history', 'web/redirect (stacked)')
+                ->assertSee('web/redirect');
+        });
+    }
+
     public function testItInjectsOnPlainText()
     {
         $this->browse(function ($browser) {