Automatically truncating the user agent string to 255 characters #2

Author: fulopattila122

Changelog.md

@@ -1,5 +1,10 @@
 # Eloquent History Changelog
 
+## Unreleased
+##### 2024-XX-YY
+
+- Fixed MySQL/Postgres truncation errors when the user-agent string is longer than 255 characters by truncating the string to 255 chars before inserting to the DB
+
 ## 1.6.0
 ##### 2024-11-28
 

src/JobTracker.php

@@ -21,6 +21,7 @@
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Request;
+use Illuminate\Support\Str;
 use Konekt\History\Contracts\JobExecution;
 use Konekt\History\Contracts\JobExecutionLog;
 use Konekt\History\Contracts\JobStatus;
@@ -203,7 +204,7 @@ protected static function commonFields(TrackableJob $job): array
             'tracking_id' => $job->getJobTrackingId(),
             'user_id' => Auth::id(),
             'ip_address' => Request::ip(),
-            'user_agent' => Request::userAgent(),
+            'user_agent' => Str::limit(Request::userAgent(), 255, ''),
         ];
     }
 

tests/UserAgentTest.php

@@ -16,7 +16,10 @@
 
 use Illuminate\Http\Request;
 use Konekt\History\History;
+use Konekt\History\JobTracker;
+use Konekt\History\Models\JobExecution;
 use Konekt\History\Tests\Dummies\SampleTask;
+use Konekt\History\Tests\Dummies\SampleTrackableJob;
 
 class UserAgentTest extends TestCase
 {
@@ -25,16 +28,35 @@ class UserAgentTest extends TestCase
     /** @test */
     public function it_truncates_user_agent_strings_longer_than_255_characters_without_errors()
     {
-        $request = Request::create('/example-route', 'GET', [], [], [], [
-            'HTTP_USER_AGENT' => self::STUPID_UA_STRING,
-        ]);
-        app()->forgetInstance('request');
-        app()->singleton('request', fn () => $request);
+        $this->forgeRequestWithStupidUserAgent();
 
         $task = SampleTask::create(['title' => 'Task With a stupid Browser Agent String', 'status' => 'in-progress']);
         $entry = History::begin($task);
         $entry = $entry->fresh();
 
         $this->assertEquals(substr(self::STUPID_UA_STRING, 0, 255), $entry->user_agent);
     }
+
+    /** @test */
+    public function it_truncates_the_user_agent_strings_longer_than_255_characters_when_using_the_job_tracker()
+    {
+        $this->forgeRequestWithStupidUserAgent();
+
+        JobExecution::ofJobClass(SampleTrackableJob::class)->delete();
+
+        $job = new SampleTrackableJob(new SampleTask());
+        $job->generateJobTrackingId();
+        $entry = JobTracker::createFor($job);
+
+        $this->assertEquals(substr(self::STUPID_UA_STRING, 0, 255), $entry->user_agent);
+    }
+
+    private function forgeRequestWithStupidUserAgent(): void
+    {
+        $request = Request::create('/example-route', 'GET', [], [], [], [
+            'HTTP_USER_AGENT' => self::STUPID_UA_STRING,
+        ]);
+        app()->forgetInstance('request');
+        app()->singleton('request', fn () => $request);
+    }
 }