Merge pull request #3 from binaryk/config

Adding configuration to enable middleware.

Author: mpociot

README.md

@@ -61,6 +61,13 @@ ServerTiming::setDuration('Running expensive task', function() {
 
 You can also use the Server-Timing middleware to only set textual information without providing a duration.
 
+## Publishing configuration file
+
+The configuration file could be published using:
+`php artisan vendor:publish --tag=server-timing-config`
+
+You can disable the middleware changing the `timing.enabled` configuration to false.
+
 ```php
 ServerTiming::addMetric('User: '.$user->id);
 ```

src/Middleware/ServerTimingMiddleware.php

@@ -24,6 +24,10 @@ public function __construct(ServerTiming $timing)
 
     public function handle(Request $request, Closure $next)
     {
+        if(false === config('timing.enabled', true)) {
+            return $next($request);
+        }
+
         $this->timing->setDuration('Bootstrap', $this->getElapsedTimeInMs());
 
         $this->timing->start('App');

src/ServerTimingServiceProvider.php

@@ -6,6 +6,16 @@
 
 class ServerTimingServiceProvider extends ServiceProvider
 {
+    /**
+     * Bootstrap the application services.
+     */
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->registerPublishing();
+        }
+    }
+
     /**
      * Register the application services.
      */
@@ -15,4 +25,11 @@ public function register()
             return new ServerTiming(new \Symfony\Component\Stopwatch\Stopwatch());
         });
     }
+
+    protected function registerPublishing()
+    {
+        $this->publishes([
+            __DIR__.'/config/config.php' => config_path('timing.php'),
+        ], 'server-timing-config');
+    }
 }

src/config/config.php

@@ -0,0 +1,15 @@
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Laravel Server Timing enabled
+    |--------------------------------------------------------------------------
+    |
+    | This configuration is used to enable the server timing measurement,
+    | if set to false, the middleware will be bypassed
+    |
+    */
+
+    'enabled' => true,
+];

tests/Middleware/ServerTimingMiddlewareTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace BeyondCode\ServerTiming\Tests\Middleware;
+
+use BeyondCode\ServerTiming\Middleware\ServerTimingMiddleware;
+use BeyondCode\ServerTiming\ServerTiming;
+use Illuminate\Http\Request;
+use Orchestra\Testbench\TestCase;
+use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Component\HttpFoundation\Response;
+
+class ServerTimingMiddlewareTest extends TestCase
+{
+    /** @test */
+    public function it_add_server_timing_header()
+    {
+        $request = new Request;
+
+        $timing = new ServerTiming(new Stopwatch());
+
+        $middleware = new ServerTimingMiddleware($timing);
+
+        $response = $middleware->handle($request, function ($req) {
+            return new Response();
+        });
+
+        $this->assertArrayHasKey('server-timing', $response->headers->all());
+
+    }
+
+    /** @test */
+    public function it_is_bypassed_if_configuration_false()
+    {
+        $this->app['config']->set('timing.enabled', false);
+
+        $request = new Request;
+
+        $timing = new ServerTiming(new Stopwatch());
+
+        $middleware = new ServerTimingMiddleware($timing);
+
+        $response = $middleware->handle($request, function ($req) {
+            return new Response();
+        });
+
+        $this->assertArrayNotHasKey('server-timing', $response->headers->all());
+    }
+}