Add tests (#16)

Author: CasperLaiTW

.github/workflows/php-cs-fixer.yml

@@ -0,0 +1,29 @@
+name: Check & fix styling
+
+on: [ push ]
+
+jobs:
+  style:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Fix style
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --config=.php_cs --allow-risky=yes
+
+      - name: Extract branch name
+        shell: bash
+        run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+        id: extract_branch
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix styling
+          branch: ${{ steps.extract_branch.outputs.branch }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -6,3 +6,5 @@ composer.lock
 coverage
 docs
 vendor
+.php_cs.cache
+coverage

.php_cs

@@ -0,0 +1,33 @@
+<?php
+
+$finder = Symfony\Component\Finder\Finder::create()
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->name('*.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'ordered_imports' => ['sortAlgorithm' => 'alpha'],
+        'no_unused_imports' => true,
+        'not_operator_with_successor_space' => false,
+        'trailing_comma_in_multiline_array' => true,
+        'phpdoc_scalar' => true,
+        'unary_operator_spaces' => true,
+        'binary_operator_spaces' => true,
+        'blank_line_before_statement' => [
+            'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
+        ],
+        'phpdoc_single_line_var_spacing' => true,
+        'phpdoc_var_without_name' => true,
+        'method_argument_space' => [
+            'on_multiline' => 'ensure_fully_multiline',
+            'keep_multiple_spaces_after_comma' => true,
+        ]
+    ])
+    ->setFinder($finder);

composer.json

@@ -27,7 +27,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^8.4|^9.0",
-        "orchestra/testbench": "^4.0|^5.0|^6.0"
+        "orchestra/testbench": "^4.0|^5.0|^6.0",
+        "friendsofphp/php-cs-fixer": "^2.16"
     },
     "autoload": {
         "psr-4": {
@@ -43,7 +44,7 @@
         "psalm": "vendor/bin/psalm",
         "test": "vendor/bin/phpunit",
         "test-coverage": "vendor/bin/phpunit --coverage-html coverage",
-        "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes"
+        "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes --config=.php_cs"
     },
     "config": {
         "sort-packages": true

config/prerender.php

@@ -35,10 +35,10 @@
     |
     | By default Prerender returns soft HTTP codes. If you would like it to
     | return the real ones in case of Redirection (3xx) or status Not Found (404),
-    | set this parameter to false. 
+    | set this parameter to false.
     | Keep in mind that returning real HTTP codes requires appropriate meta tags
     | to be set. For more details, see github.com/prerender/prerender#httpheaders
-    | 
+    |
     */
 
     'prerender_soft_http_codes' => env('PRERENDER_SOFT_HTTP_STATUS_CODES', true),

phpunit.xml.dist

@@ -10,6 +10,11 @@
          stopOnFailure="false"
          verbose="true"
 >
+    <coverage>
+        <include>
+            <directory suffix=".php">src/</directory>
+        </include>
+    </coverage>
     <testsuites>
         <testsuite name="codebar Test Suite">
             <directory>tests</directory>

src/LaravelPrerenderServiceProvider.php

@@ -1,4 +1,6 @@
-<?php namespace CodebarAg\LaravelPrerender;
+<?php
+
+namespace CodebarAg\LaravelPrerender;
 
 use Illuminate\Support\ServiceProvider;
 
@@ -14,7 +16,7 @@ class LaravelPrerenderServiceProvider extends ServiceProvider
     public function boot()
     {
         $this->publishes([
-            __DIR__ . '/../config/prerender.php' => config_path('prerender.php')
+            __DIR__ . '/../config/prerender.php' => config_path('prerender.php'),
         ], 'config');
 
         if ($this->app['config']->get('prerender.enable')) {
@@ -33,5 +35,4 @@ public function register()
     {
         $this->mergeConfigFrom(__DIR__ . '/../config/prerender.php', 'prerender');
     }
-
-}
+}

src/PrerenderMiddleware.php

@@ -1,18 +1,16 @@
 <?php
 
-
 namespace CodebarAg\LaravelPrerender;
 
-
 use App;
 use Closure;
-use Illuminate\Support\Arr;
-use Illuminate\Support\Str;
-use Redirect;
+use GuzzleHttp\Client as Guzzle;
 use GuzzleHttp\Exception\RequestException;
 use Illuminate\Contracts\Foundation\Application;
-use GuzzleHttp\Client as Guzzle;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Str;
 use Psr\Http\Message\ResponseInterface;
+use Redirect;
 use Symfony\Bridge\PsrHttpMessage\Factory\HttpFoundationFactory;
 use Symfony\Component\HttpFoundation\Response;
 
@@ -122,6 +120,7 @@ public function handle($request, Closure $next)
 
                 if (!$this->returnSoftHttpCodes && $statusCode >= 300 && $statusCode < 400) {
                     $headers = $prerenderedResponse->getHeaders();
+
                     return Redirect::to(array_change_key_case($headers, CASE_LOWER)['location'][0], $statusCode);
                 }
 
@@ -135,23 +134,30 @@ public function handle($request, Closure $next)
     /**
      * Returns whether the request must be prerendered.
      *
-     * @param $request
+     * @param \Illuminate\Http\Request $request
      * @return bool
      */
     private function shouldShowPrerenderedPage($request)
     {
         $userAgent = strtolower($request->server->get('HTTP_USER_AGENT'));
         $bufferAgent = $request->server->get('X-BUFFERBOT');
+
         $requestUri = $request->getRequestUri();
         $referer = $request->headers->get('Referer');
 
         $isRequestingPrerenderedPage = false;
 
-        if (!$userAgent) return false;
-        if (!$request->isMethod('GET')) return false;
+        if (!$userAgent) {
+            return false;
+        }
+        if (!$request->isMethod('GET')) {
+            return false;
+        }
 
         // prerender if _escaped_fragment_ is in the query string
-        if ($request->query->has('_escaped_fragment_')) $isRequestingPrerenderedPage = true;
+        if ($request->query->has('_escaped_fragment_')) {
+            $isRequestingPrerenderedPage = true;
+        }
 
         // prerender if a crawler is detected
         foreach ($this->crawlerUserAgents as $crawlerUserAgent) {
@@ -160,9 +166,13 @@ private function shouldShowPrerenderedPage($request)
             }
         }
 
-        if ($bufferAgent) $isRequestingPrerenderedPage = true;
+        if ($bufferAgent) {
+            $isRequestingPrerenderedPage = true;
+        }
 
-        if (!$isRequestingPrerenderedPage) return false;
+        if (!$isRequestingPrerenderedPage) {
+            return false;
+        }
 
         // only check whitelist if it is not empty
         if ($this->whitelist) {
@@ -175,7 +185,9 @@ private function shouldShowPrerenderedPage($request)
         if ($this->blacklist) {
             $uris[] = $requestUri;
             // we also check for a blacklisted referer
-            if ($referer) $uris[] = $referer;
+            if ($referer) {
+                $uris[] = $referer;
+            }
             if ($this->isListed($uris, $this->blacklist)) {
                 return false;
             }
@@ -210,9 +222,10 @@ private function getPrerenderedPageResponse($request)
             if ($path === '/') {
                 $path = '';
             }
+
             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) {
                 App::abort(404);
             }
             // In case of an exception, we only throw the exception if we are in debug mode. Otherwise,
@@ -221,6 +234,7 @@ private function getPrerenderedPageResponse($request)
             if ($this->app['config']->get('app.debug')) {
                 throw $exception;
             }
+
             return null;
         }
     }
@@ -254,7 +268,7 @@ private function isListed($needles, $list)
                 }
             }
         }
+
         return false;
     }
-
-}
+}

tests/ExampleTest.php

@@ -0,0 +1,92 @@
+<?php
+
+namespace CodebarAg\LaravelPrerender\Tests;
+
+class PrerenderMiddlewareTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_should_prerender_page_on_get_request()
+    {
+        $this->allowSymfonyUserAgent();
+
+        $this->get('/test-middleware')
+            ->assertHeader('prerender.io-mock', true)
+            ->assertSuccessful();
+    }
+
+    /**
+     * @test
+     */
+    public function it_should_not_prerender_page_when_user_agent_does_not_in_list()
+    {
+        $this->get('/test-middleware')
+            ->assertSuccessful()
+            ->assertHeaderMissing('prerender.io-mock')
+            ->assertSee('GET - Success');
+    }
+
+    /**
+     * @test
+     */
+    public function it_should_prerender_page_with_escaped_fragment_in_query_string()
+    {
+        $this->get('/test-middleware?_escaped_fragment_')
+            ->assertHeader('prerender.io-mock', true)
+            ->assertSuccessful();
+    }
+
+    /**
+     * @test
+     */
+    public function it_should_prerender_page_with_url_in_whitelist()
+    {
+        config()->set('prerender.whitelist', ['/test-middleware*']);
+        $this->get('/test-middleware?_escaped_fragment_')
+            ->assertHeader('prerender.io-mock', true)
+            ->assertSuccessful();
+    }
+
+    /**
+     * @test
+     */
+    public function is_should_not_prerender_page_in_blacklist()
+    {
+        config()->set('prerender.blacklist', ['/test-middleware*']);
+        $this->get('/test-middleware?_escaped_fragment_')
+            ->assertSuccessful()
+            ->assertHeaderMissing('prerender.io-mock')
+            ->assertSee('GET - Success');
+    }
+
+    /**
+     * @test
+     */
+    public function it_should_not_prrender_page_on_non_get_request()
+    {
+        $this->allowSymfonyUserAgent();
+
+        $this->post('/test-middleware')
+            ->assertSuccessful()
+            ->assertSee('Success');
+    }
+
+    /**
+     * @test
+     */
+    public function it_should_not_prerender_page_when_missing_useg_agent()
+    {
+        $this->get('/test-middleware', ['User-Agent' => null])
+            ->assertHeaderMissing('prerender.io-mock')
+            ->assertSee('GET - Success');
+    }
+
+    /**
+     *
+     */
+    private function allowSymfonyUserAgent()
+    {
+        config()->set('prerender.crawler_user_agents', ['symfony']);
+    }
+}