Support parameters

.gitignore

@@ -2,6 +2,7 @@
 .php_cs
 .php_cs.cache
 .phpunit.result.cache
+.phpunit.cache
 build
 composer.lock
 coverage

README.md

@@ -147,6 +147,7 @@ This package works as follows:
   - `team_id`: The team id associated with the request (if available)
   - `method`: The HTTP method (`GET/POST/...`)
   - `route`: The route name (if available) or the route URI (eg `/posts/{post}`)
+  - `parameters`: The route parameters passed (if enabled else `null`)
   - `status`: The HTTP status (eg `202`)
   - `ip`: The request ip
   - `date`: The date of the request as datetime (can be aggregated)

config/route-statistics.php

@@ -12,6 +12,16 @@
     */
     'enabled' => env('ROUTE_STATISTICS_ENABLED', true),
 
+    /*
+    |--------------------------------------------------------------------------
+    | Store parameters
+    |--------------------------------------------------------------------------
+    |
+    | If this setting is set to true the route parameters will also be logged.
+    |
+    */
+    'store_parameters' => env('ROUTE_STORE_PARAMETERS', false),
+
     /*
     |--------------------------------------------------------------------------
     | Aggregation

database/factories/RouteStatisticFactory.php

@@ -15,6 +15,7 @@ public function definition()
             'method' => $this->faker->randomElement(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']),
             'route' => $this->faker->domainWord().'.'.$this->faker->randomElement(['index', 'create', 'store', 'show', 'edit', 'update', 'destroy']),
             'status' => $this->faker->randomElement([200, 201, 202, 204, 300, 301, 302, 303, 304, 400, 401, 402, 403, 404, 405, 406, 422, 429, 500, 501, 502, 503, 504]),
+            'parameters' => $this->faker->json(),
             'ip' => $this->faker->ipv4(),
             'date' => $this->faker->dateTime(),
             'counter' => $this->faker->randomNumber(4),

database/migrations/add_parameters_to_route_statistics_table.php.stub

@@ -0,0 +1,22 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up()
+    {
+        Schema::table('route_statistics', function (Blueprint $table) {
+            $table->json('parameters')->after('route')->nullable();
+        });
+    }
+
+    public function down()
+    {
+        Schema::table('route_statistics', function (Blueprint $table) {
+            $table->dropColumn('parameters');
+        });
+    }
+};

src/Commands/LaravelRouteStatisticsCommand.php

@@ -29,11 +29,14 @@ class LaravelRouteStatisticsCommand extends Command
     public function handle()
     {
         $query = $this->getQuery();
+        $fields = $this->getFields();
 
         if ($this->option('group')) {
             $query->select($this->option('group'))
                 ->addSelect(DB::raw('MAX(date) as last_used'))
                 ->addSelect(DB::raw('SUM(counter) as counter'));
+        } else {
+            $query->select($fields);
         }
 
         $this->applyFilters($query);
@@ -43,7 +46,7 @@ public function handle()
         $results = $query->limit($this->option('limit'))->get();
 
         $this->table(
-            $this->getFields(),
+            $fields,
             $results->toArray()
         );
 
@@ -111,16 +114,17 @@ protected function getFields(): array
             return array_merge($this->option('group'), ['last_used', 'counter']);
         }
 
-        return [
+        return array_filter([
             'id',
             'user_id',
             'team_id',
             'method',
             'route',
             'status',
+            config('route-statistics.store_parameters') === true ? 'parameters' : null,
             'ip',
             'date',
             'counter',
-        ];
+        ]);
     }
 }

src/Commands/LaravelRouteTruncateCommand.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Bilfeldt\LaravelRouteStatistics\Commands;
+
+use Illuminate\Console\Command;
+use TypeError;
+
+class LaravelRouteTruncateCommand extends Command
+{
+    public $signature = 'route:truncate-stats';
+
+    public $description = 'Prune route usage statistics';
+
+    public function handle(): int
+    {
+        try {
+            call_user_func_array([config('route-statistics.model'), 'truncate'], []);
+        } catch (TypeError $ex) {
+            $this->components->error('Failed to truncate route usage statistics: '.$ex->getMessage());
+        }
+
+        $this->components->info('Route usage statistics truncated');
+
+        return Command::SUCCESS;
+    }
+}

src/Http/Middleware/RouteStatisticsMiddleware.php

@@ -12,7 +12,6 @@ class RouteStatisticsMiddleware
      * Handle an incoming request.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure  $next
      * @return mixed
      */
     public function handle($request, Closure $next)

src/LaravelRouteStatisticsServiceProvider.php

@@ -3,6 +3,7 @@
 namespace Bilfeldt\LaravelRouteStatistics;
 
 use Bilfeldt\LaravelRouteStatistics\Commands\LaravelRouteStatisticsCommand;
+use Bilfeldt\LaravelRouteStatistics\Commands\LaravelRouteTruncateCommand;
 use Bilfeldt\LaravelRouteStatistics\Commands\LaravelRouteUnusedCommand;
 use Bilfeldt\LaravelRouteStatistics\Http\Middleware\RouteStatisticsMiddleware;
 use Bilfeldt\RequestLogger\RequestLoggerFacade;
@@ -60,6 +61,7 @@ private function publishMigrations()
     {
         $this->publishes([
             __DIR__.'/../database/migrations/create_route_statistics_table.php.stub' => database_path('migrations/'.date('Y_m_d_His', time()).'_create_route_statistics_table.php'),
+            __DIR__.'/../database/migrations/add_parameters_to_route_statistics_table.php.stub' => database_path('migrations/'.date('Y_m_d_His', time()).'_add_parameters_to_route_statistics_table.php'),
             // you can add any number of migrations here
         ], 'migrations');
     }
@@ -69,6 +71,7 @@ private function bootCommands()
         if ($this->app->runningInConsole()) {
             $this->commands([
                 LaravelRouteStatisticsCommand::class,
+                LaravelRouteTruncateCommand::class,
                 LaravelRouteUnusedCommand::class,
             ]);
         }

src/Models/RouteStatistic.php

@@ -85,6 +85,7 @@ public function getLogAttributes(Request $request, $response, ?int $time = null,
             'team_id' => $this->getRequestTeam($request)?->getKey(),
             'method' => $request->getMethod(),
             'route' => $request->route()?->getName() ?? $request->route()?->uri(),
+            'parameters' => config('route-statistics.store_parameters') ? json_encode($request->route()->originalParameters()) : null,
             'status' => $response->getStatusCode(),
             'ip' => $request->ip(),
             'date' => $this->getDate(),

tests/TestCase.php

@@ -35,7 +35,17 @@ public function getEnvironmentSetUp($app)
             'prefix' => '',
         ]);
 
-        $migration = include __DIR__.'/../database/migrations/create_route_statistics_table.php.stub';
-        $migration->up();
+        $this->runMigrations([
+            'create_route_statistics_table',
+            'add_parameters_to_route_statistics_table',
+        ]);
+    }
+
+    private function runMigrations(array $fileNames): void
+    {
+        foreach ($fileNames as $fileName) {
+            $class = require __DIR__.'/../database/migrations/'.$fileName.'.php.stub';
+            $class->up();
+        }
     }
 }

tests/Unit/RouteStatisticModelTest.php

@@ -46,4 +46,52 @@ public function test_get_log_attributes(): void
     {
         $this->markTestIncomplete('Mock the request and response to ensture the correct attributes are returned');
     }
+
+    public function test_logs_parameters_if_config_enabled(): void
+    {
+        Config::set('route-statistics.store_parameters', true);
+
+        $route = 'home';
+        $params = [
+            'param1' => 'one',
+            'param2' => 'two',
+        ];
+        $request = \Illuminate\Http\Request::create($route.'/'.implode('/', $this->get_route_parameters($params)), 'GET');
+        $this->app['router']->get($route.'/'.implode('/', $this->get_route_keys($params)), fn () => 'Test route response');
+        $response = $this->app['router']->dispatch($request);
+
+        (new RouteStatistic)->log($request, $response, 1, 2);
+
+        $log = RouteStatistic::first();
+        $this->assertEquals(json_encode($params), $log->parameters);
+    }
+
+    public function test_logs_parameters_if_config_disabled(): void
+    {
+        Config::set('route-statistics.store_parameters', false);
+
+        $route = 'home';
+        $params = [
+            'param1' => 'one',
+            'param2' => 'two',
+        ];
+        $request = \Illuminate\Http\Request::create($route.'/'.implode('/', $this->get_route_parameters($params)), 'GET');
+        $this->app['router']->get($route.'/'.implode('/', $this->get_route_keys($params)), fn () => 'Test route response');
+        $response = $this->app['router']->dispatch($request);
+
+        (new RouteStatistic)->log($request, $response, 1, 2);
+
+        $log = RouteStatistic::first();
+        $this->assertNull($log->parameters);
+    }
+
+    private function get_route_parameters(array $parameters): array
+    {
+        return array_values($parameters);
+    }
+
+    private function get_route_keys(array $parameters): array
+    {
+        return array_map(fn ($parameter) => '{'.$parameter.'}', array_keys($parameters));
+    }
 }