Add config to disable redirect hits tracking (#571)

Author: duncanmcclean

DOCUMENTATION.md

@@ -223,6 +223,20 @@ Alternatively, you may store redirects in the database by changing the driver:
 
 Then run `php please seo-pro:database-redirects` to publish the migration and import existing redirects.
 
+#### Hit Tracking
+
+Out of the box, SEO Pro tracks the number of hits and the timestamp of the last hit for each redirect. If you store redirects in flat files, this can lead to frequent file changes creating noise in version control.
+
+You may disable hit tracking in the config:
+
+```php
+// config/statamic/seo-pro.php
+
+'redirects' => [
+    'track_hits' => false,
+],
+```
+
 ### Multi-Site
 
 Redirects and errors are scoped to individual sites. Each redirect belongs to a single site, and the source URL is stored relative to the site root. For example, a redirect with the source `/about` on the French site will only match requests to `example.com/fr/about` (or `example.fr/about`, depending on your site configuration).

config/seo-pro.php

@@ -69,6 +69,7 @@
         'directory' => base_path('content/seo-pro/redirects'),
         'preserve_query_string' => true,
         'default_response_code' => 301,
+        'track_hits' => true,
         'automatic_redirects' => [
             'enabled' => env('SEO_PRO_AUTOMATIC_REDIRECTS', false),
             'collections' => ['*'],

src/Redirects/HandleRedirects.php

@@ -27,7 +27,9 @@ public function __invoke(Request $request)
             return;
         }
 
-        RecordRedirectHit::dispatch($redirect->id());
+        if (config('statamic.seo-pro.redirects.track_hits', true)) {
+            RecordRedirectHit::dispatch($redirect->id());
+        }
 
         return redirect(
             $this->resolveDestination($redirect, $path, $request),

src/Redirects/RedirectBlueprint.php

@@ -71,7 +71,7 @@ public function __invoke(): FieldsBlueprint
                                         'type' => 'integer',
                                         'display' => __('seo-pro::messages.hits'),
                                         'default' => 0,
-                                        'listable' => true,
+                                        'listable' => config('statamic.seo-pro.redirects.track_hits', true),
                                         'read_only' => true,
                                         'visibility' => 'hidden',
                                     ],
@@ -82,7 +82,7 @@ public function __invoke(): FieldsBlueprint
                                         'type' => 'date',
                                         'display' => __('seo-pro::messages.last_hit_at'),
                                         'time_enabled' => true,
-                                        'listable' => true,
+                                        'listable' => config('statamic.seo-pro.redirects.track_hits', true),
                                         'read_only' => true,
                                         'visibility' => 'hidden',
                                     ],

tests/Redirects/HandleRedirectsTest.php

@@ -181,6 +181,26 @@ public function it_does_not_dispatch_a_redirect_hit_job_when_no_redirect_matches
         Queue::assertNotPushed(RecordRedirectHit::class);
     }
 
+    #[Test]
+    public function it_does_not_dispatch_a_redirect_hit_job_when_tracking_is_disabled()
+    {
+        Queue::fake();
+
+        config(['statamic.seo-pro.redirects.track_hits' => false]);
+
+        Facades\Redirect::make()
+            ->id('abc')
+            ->source('/old-url')
+            ->destination('/new-url')
+            ->responseCode(301)
+            ->enabled(true)
+            ->save();
+
+        $this->get('/old-url')->assertRedirect('/new-url');
+
+        Queue::assertNotPushed(RecordRedirectHit::class);
+    }
+
     #[Test]
     public function it_dispatches_a_record_error_job_when_no_redirect_matches()
     {