[1.x] Add Configurable Trim Duration for Pulse Data Storage (#424)

* feat: add command to prune data with suggested before hours

* chore: remove prune structure

* feat: add environment to keep data in database storage

* chore: remove unused DateTimeInterface imports from Storage contracts

* Update DatabaseStorage.php

---------

Co-authored-by: Taylor Otwell <[email protected]>

config/pulse.php

@@ -83,7 +83,7 @@
 
         'trim' => [
             'lottery' => [1, 1_000],
-            'keep' => '7 days',
+            'keep' => env('PULSE_INGEST_KEEP', '7 days'),
         ],
 
         'redis' => [

src/Storage/DatabaseStorage.php

@@ -125,14 +125,16 @@ public function trim(): void
     {
         $now = CarbonImmutable::now();
 
+        $keep = $this->config->get('pulse.ingest.trim.keep');
+
         $this->connection()
             ->table('pulse_values')
-            ->where('timestamp', '<=', $now->subWeek()->getTimestamp())
+            ->where('timestamp', '<=', $now->sub($keep)->getTimestamp())
             ->delete();
 
         $this->connection()
             ->table('pulse_entries')
-            ->where('timestamp', '<=', $now->subWeek()->getTimestamp())
+            ->where('timestamp', '<=', $now->sub($keep)->getTimestamp())
             ->delete();
 
         $this->connection()

tests/Feature/Ingests/DatabaseTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Support\Facades\App;
+use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Date;
 use Illuminate\Support\Facades\DB;
 use Laravel\Pulse\Facades\Pulse;
@@ -121,3 +122,21 @@
     App::make(DatabaseStorage::class)->trim();
     expect(DB::table('pulse_aggregates')->where('period', 10080)->count())->toBe(1);
 });
+
+it('can configure days of data to keep when trimming', function () {
+    Config::set('pulse.ingest.trim.keep', '14 days');
+
+    Date::setTestNow('2000-01-01 00:00:04');
+    Pulse::record('foo', 'xxxx', 1);
+    Date::setTestNow('2000-01-01 00:00:05');
+    Pulse::record('bar', 'xxxx', 1);
+    Date::setTestNow('2000-01-01 00:00:06');
+    Pulse::record('baz', 'xxxx', 1);
+    Pulse::ingest();
+
+    Pulse::stopRecording();
+    Date::setTestNow('2000-01-15 00:00:05');
+    App::make(DatabaseStorage::class)->trim();
+
+    expect(DB::table('pulse_entries')->pluck('type')->all())->toBe(['baz']);
+});

tests/Feature/PulseTest.php

@@ -48,6 +48,19 @@
     expect($storage->stored)->toHaveCount(1);
 });
 
+it('can configure days of data to keep when trimming', function () {
+    Config::set('pulse.ingest.trim.keep', '30 days');
+    App::instance(Storage::class, $storage = new StorageFake);
+
+    Pulse::record('foo', 'delete', 0, now()->subMonth());
+    Pulse::record('foo', 'keep', 0, now()->subWeek());
+    Pulse::record('foo', 'keep', 0);
+
+    Pulse::ingest();
+
+    expect($storage->stored)->toHaveCount(2);
+});
+
 it('can lazily capture entries', function () {
     App::instance(Storage::class, $storage = new StorageFake);
 

tests/StorageFake.php

@@ -31,7 +31,9 @@ public function store(Collection $items): void
      */
     public function trim(): void
     {
-        $this->stored = $this->stored->reject(fn ($record) => $record->timestamp <= now()->subWeek()->timestamp);
+        $keep = config('pulse.ingest.trim.keep');
+
+        $this->stored = $this->stored->reject(fn ($record) => $record->timestamp <= now()->sub($keep)->timestamp);
     }
 
     /**