Fix errors while parsing the PSR-7 request with moved uploaded files (#487)

Author: stayallive

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Fix problem with parsing uploaded files from request after they have been moved (#487)
+
 ## 2.5.1
 
 - Fix problem with queue tracing when triggered from unit tests or when missing a queue name in the event

src/Sentry/Laravel/Http/LaravelRequestFetcher.php

@@ -10,6 +10,11 @@
 
 class LaravelRequestFetcher implements RequestFetcherInterface
 {
+    /**
+     * They key in the container where a PSR-7 instance of the current request could be stored.
+     */
+    public const CONTAINER_PSR7_INSTANCE_KEY = 'sentry-laravel.psr7.request';
+
     /**
      * The Laravel container.
      *
@@ -28,6 +33,10 @@ public function fetchRequest(): ?ServerRequestInterface
             return null;
         }
 
+        if ($this->container->bound(self::CONTAINER_PSR7_INSTANCE_KEY)) {
+            return $this->container->make(self::CONTAINER_PSR7_INSTANCE_KEY);
+        }
+
         try {
             return $this->container->make(ServerRequestInterface::class);
         } catch (BindingResolutionException $e) {

src/Sentry/Laravel/Http/SetRequestIpMiddleware.php

@@ -3,12 +3,30 @@
 namespace Sentry\Laravel\Http;
 
 use Closure;
+use Illuminate\Contracts\Container\Container;
 use Illuminate\Http\Request;
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
 
+/**
+ * This middleware enriches the Sentry scope with the IP address of the request.
+ * We do this ourself instead of letting the PHP SDK handle this because we want
+ * the IP from the Laravel request because it takes into account trusted proxies.
+ */
 class SetRequestIpMiddleware
 {
+    /**
+     * The Laravel container.
+     *
+     * @var \Illuminate\Contracts\Container\Container
+     */
+    private $container;
+
+    public function __construct(Container $container)
+    {
+        $this->container = $container;
+    }
+
     /**
      * Handle an incoming request.
      *
@@ -19,9 +37,9 @@ class SetRequestIpMiddleware
      */
     public function handle(Request $request, Closure $next)
     {
-        if (app()->bound(HubInterface::class)) {
+        if ($this->container->bound(HubInterface::class)) {
             /** @var \Sentry\State\HubInterface $sentry */
-            $sentry = app(HubInterface::class);
+            $sentry = $this->container->make(HubInterface::class);
 
             $client = $sentry->getClient();
 

src/Sentry/Laravel/Http/SetRequestMiddleware.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Sentry\Laravel\Http;
+
+use Closure;
+use Illuminate\Contracts\Container\BindingResolutionException;
+use Illuminate\Contracts\Container\Container;
+use Illuminate\Http\Request;
+use Psr\Http\Message\ServerRequestInterface;
+use Sentry\State\HubInterface;
+
+/**
+ * This middleware caches a PSR-7 version of the request as early as possible.
+ * This is done to prevent running into (mostly uploaded file) parsing failures.
+ */
+class SetRequestMiddleware
+{
+    /**
+     * The Laravel container.
+     *
+     * @var \Illuminate\Contracts\Container\Container
+     */
+    private $container;
+
+    public function __construct(Container $container)
+    {
+        $this->container = $container;
+    }
+
+    /**
+     * Handle an incoming request.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param \Closure                 $next
+     *
+     * @return mixed
+     */
+    public function handle(Request $request, Closure $next)
+    {
+        if ($this->container->bound(HubInterface::class)) {
+            try {
+                $this->container->instance(
+                    LaravelRequestFetcher::CONTAINER_PSR7_INSTANCE_KEY,
+                    $this->container->make(ServerRequestInterface::class)
+                );
+            } catch (BindingResolutionException $e) {
+                // Ignore problems getting the PSR-7 server request instance here
+                // In the Laravel request fetcher we have other fallbacks for that
+            }
+        }
+
+        return $next($request);
+    }
+}

src/Sentry/Laravel/ServiceProvider.php

@@ -12,6 +12,7 @@
 use Sentry\Integration as SdkIntegration;
 use Sentry\Laravel\Http\LaravelRequestFetcher;
 use Sentry\Laravel\Http\SetRequestIpMiddleware;
+use Sentry\Laravel\Http\SetRequestMiddleware;
 use Sentry\SentrySdk;
 use Sentry\State\Hub;
 use Sentry\State\HubInterface;
@@ -44,12 +45,14 @@ public function boot(): void
             $this->bindEvents();
 
             if ($this->app instanceof Lumen) {
+                $this->app->middleware(SetRequestMiddleware::class);
                 $this->app->middleware(SetRequestIpMiddleware::class);
             } elseif ($this->app->bound(HttpKernelInterface::class)) {
                 /** @var \Illuminate\Foundation\Http\Kernel $httpKernel */
                 $httpKernel = $this->app->make(HttpKernelInterface::class);
 
                 if ($httpKernel instanceof HttpKernel) {
+                    $httpKernel->pushMiddleware(SetRequestMiddleware::class);
                     $httpKernel->pushMiddleware(SetRequestIpMiddleware::class);
                 }
             }