Add Guzzle Timeout To Prerender Middleware (#39)

Also adds new `prerender.timeout` config option. Defaults to no timeout

Co-authored-by: Keller Martin <[email protected]>

Author: kellerjmrtn

README.md

@@ -276,6 +276,21 @@ return [
         'Qwantify'
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Timeout
+    |--------------------------------------------------------------------------
+    |
+    | Specifies the Guzzle request timeout in seconds. If the request for a
+    | prerendered page takes longer than this, the request will be terminated
+    | and the page will be loaded without prerender. A value of 0 means no
+    | timeout.
+    |
+    | See: https://docs.guzzlephp.org/en/stable/request-options.html#timeout
+    |
+    */
+    'timeout' => env('PRERENDER_TIMEOUT', 0),
+
 ];
 ```
 

config/prerender.php

@@ -181,4 +181,19 @@
         'Qwantify',
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Timeout
+    |--------------------------------------------------------------------------
+    |
+    | Specifies the Guzzle request timeout in seconds. If the request for a
+    | prerendered page takes longer than this, the request will be terminated
+    | and the page will be loaded without prerender. A value of 0 means no
+    | timeout.
+    |
+    | See: https://docs.guzzlephp.org/en/stable/request-options.html#timeout
+    |
+    */
+    'timeout' => env('PRERENDER_TIMEOUT', 0),
+
 ];

src/PrerenderMiddleware.php

@@ -4,6 +4,7 @@
 
 use Closure;
 use GuzzleHttp\Client as Guzzle;
+use GuzzleHttp\Exception\ConnectException;
 use GuzzleHttp\Exception\RequestException;
 use Illuminate\Http\Request;
 use Illuminate\Support\Arr;
@@ -71,15 +72,15 @@ public function __construct(Guzzle $client)
     {
         $this->returnSoftHttpCodes = config('prerender.prerender_soft_http_codes');
 
-        if ($this->returnSoftHttpCodes) {
-            $this->client = $client;
-        } else {
-            // Workaround to avoid following redirects
-            $config = $client->getConfig();
-            $config['allow_redirects'] = false;
-            $this->client = new Guzzle($config);
+        $guzzleConfig = $client->getConfig();
+        $guzzleConfig['timeout'] = config('prerender.timeout');
+
+        if (!$this->returnSoftHttpCodes) {
+            $guzzleConfig['allow_redirects'] = false;
         }
 
+        $this->client = new Guzzle($guzzleConfig);
+
         $config = config('prerender');
 
         $this->prerenderUri = $config['prerender_url'];
@@ -102,7 +103,7 @@ public function handle(Request $request, Closure $next)
             if ($prerenderedResponse) {
                 $statusCode = $prerenderedResponse->getStatusCode();
 
-                if (! $this->returnSoftHttpCodes && $statusCode >= 300 && $statusCode < 400) {
+                if (!$this->returnSoftHttpCodes && $statusCode >= 300 && $statusCode < 400) {
                     $headers = $prerenderedResponse->getHeaders();
 
                     return Redirect::to(array_change_key_case($headers, CASE_LOWER)['location'][0], $statusCode);
@@ -128,11 +129,11 @@ private function shouldShowPrerenderedPage(Request $request): bool
 
         $isRequestingPrerenderedPage = false;
 
-        if (! $userAgent) {
+        if (!$userAgent) {
             return false;
         }
 
-        if (! $request->isMethod('GET')) {
+        if (!$request->isMethod('GET')) {
             return false;
         }
 
@@ -152,13 +153,13 @@ private function shouldShowPrerenderedPage(Request $request): bool
             $isRequestingPrerenderedPage = true;
         }
 
-        if (! $isRequestingPrerenderedPage) {
+        if (!$isRequestingPrerenderedPage) {
             return false;
         }
 
         // only check whitelist if it is not empty
         if ($this->whitelist) {
-            if (! $this->isListed($requestUri, $this->whitelist)) {
+            if (!$this->isListed($requestUri, $this->whitelist)) {
                 return false;
             }
         }
@@ -207,19 +208,21 @@ private function getPrerenderedPageResponse(Request $request): ?ResponseInterfac
 
             return $this->client->get($this->prerenderUri.'/'.urlencode($protocol.'://'.$host.'/'.$path), compact('headers'));
         } catch (RequestException $exception) {
-            if (! $this->returnSoftHttpCodes && ! empty($exception->getResponse()) && $exception->getResponse()->getStatusCode() === 404) {
+            if (!$this->returnSoftHttpCodes && !empty($exception->getResponse()) && $exception->getResponse()->getStatusCode() === 404) {
                 abort(404);
             }
+        } catch (ConnectException $exception) {
+            //
+        }
 
-            // In case of an exception, we only throw the exception if we are in debug mode. Otherwise,
-            // we return null and the handle() method will just pass the request to the next middleware
-            // and we do not show a prerendered page.
-            if (config('app.debug')) {
-                throw $exception;
-            }
-
-            return null;
+        // In case of an exception, we only throw the exception if we are in debug mode. Otherwise,
+        // we return null and the handle() method will just pass the request to the next middleware
+        // and we do not show a prerendered page.
+        if (config('app.debug')) {
+            throw $exception;
         }
+
+        return null;
     }
 
     /**

tests/PrerenderMiddlewareTest.php

@@ -2,6 +2,8 @@
 
 namespace CodebarAg\LaravelPrerender\Tests;
 
+use GuzzleHttp\Client;
+
 class PrerenderMiddlewareTest extends TestCase
 {
     /** @test */
@@ -78,6 +80,20 @@ public function it_should_not_prerender_page_when_missing_user_agent()
             ->assertSee('GET - Success');
     }
 
+    /** @test */
+    public function it_should_not_prerender_page_if_request_times_out()
+    {
+        $this->app->bind(Client::class, function () {
+            return $this->createMockTimeoutClient();
+        });
+
+        $this->allowSymfonyUserAgent();
+
+        $this->get('/test-middleware')
+            ->assertHeaderMissing('prerender.io-mock')
+            ->assertSee('GET - Success');
+    }
+
     private function allowSymfonyUserAgent()
     {
         config()->set('prerender.crawler_user_agents', ['symfony']);

tests/TestCase.php

@@ -5,8 +5,10 @@
 use CodebarAg\LaravelPrerender\LaravelPrerenderServiceProvider;
 use CodebarAg\LaravelPrerender\PrerenderMiddleware;
 use GuzzleHttp\Client;
+use GuzzleHttp\Exception\ConnectException;
 use GuzzleHttp\Handler\MockHandler;
 use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
 use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Http\Kernel;
@@ -49,6 +51,17 @@ protected function getEnvironmentSetUp($app): void
         });
     }
 
+    protected function createMockTimeoutClient(): Client
+    {
+        $mock = new MockHandler([
+            new ConnectException('Could not connect', new Request('GET', 'test')),
+        ]);
+
+        $stack = HandlerStack::create($mock);
+
+        return new Client(['handler' => $stack]);
+    }
+
     protected function setupRoutes(): void
     {
         Route::get('test-middleware', function () {