feat: add command to prune data with suggested before hours

src/Commands/PruneCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Laravel\Pulse\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Console\ConfirmableTrait;
+use Laravel\Pulse\Pulse;
+
+/**
+ * @internal
+ */
+class PruneCommand extends Command
+{
+    use ConfirmableTrait;
+
+    /**
+     * The command's signature.
+     *
+     * @var string
+     */
+    protected $signature = 'pulse:prune {--hours=24 : The number of hours to retain Pulse data}';
+
+    /**
+     * The command's description.
+     *
+     * @var string
+     */
+    protected $description = 'Prune stale entries from the Prune database';
+
+    /**
+     * Handle the command.
+     */
+    public function handle(Pulse $pulse): int
+    {
+        if (! $this->confirmToProceed()) {
+            return Command::FAILURE;
+        }
+
+        $pulse->prune(
+            now()->subHours(
+                (int) $this->option('hours')
+            )
+        );
+
+        return Command::SUCCESS;
+    }
+}

src/Contracts/Storage.php

@@ -3,6 +3,7 @@
 namespace Laravel\Pulse\Contracts;
 
 use Carbon\CarbonInterval;
+use DateTimeInterface;
 use Illuminate\Support\Collection;
 
 interface Storage
@@ -19,6 +20,14 @@ public function store(Collection $items): void;
      */
     public function trim(): void;
 
+     /**
+     * Prune the storage.
+     *
+     * @param  \DateTimeInterface  $before
+     * @return void
+     */
+    public function prune(DateTimeInterface $before): void;
+
     /**
      * Purge the storage.
      *

src/PulseServiceProvider.php

@@ -234,6 +234,7 @@ protected function registerCommands(): void
                 Commands\CheckCommand::class,
                 Commands\RestartCommand::class,
                 Commands\ClearCommand::class,
+                Commands\PruneCommand::class,
             ]);
 
             AboutCommand::add('Pulse', fn () => [

src/Storage/DatabaseStorage.php

@@ -5,6 +5,7 @@
 use Carbon\CarbonImmutable;
 use Carbon\CarbonInterval;
 use Closure;
+use DateTimeInterface;
 use Illuminate\Contracts\Config\Repository;
 use Illuminate\Database\Connection;
 use Illuminate\Database\DatabaseManager;
@@ -146,6 +147,37 @@ public function trim(): void
                 ->delete());
     }
 
+    /**
+     * Prune the storage.
+     *
+     * @param  \DateTimeInterface  $before
+     * @return void
+     */
+    public function prune(DateTimeInterface $before): void
+    {
+        $before = CarbonImmutable::parse($before);
+
+        $this->connection()
+            ->table('pulse_values')
+            ->where('timestamp', '<', $before->getTimestamp())
+            ->delete();
+
+        $this->connection()
+            ->table('pulse_entries')
+            ->where('timestamp', '<', $before->getTimestamp())
+            ->delete();
+
+        $this->connection()
+            ->table('pulse_aggregates')
+            ->distinct()
+            ->pluck('period')
+            ->each(fn (int $period) => $this->connection()
+                ->table('pulse_aggregates')
+                ->where('period', $period)
+                ->where('bucket', '<', $before->subMinutes($period)->getTimestamp())
+                ->delete());
+    }
+
     /**
      * Purge the storage.
      *

tests/Feature/Commands/PruneCommandTest.php

@@ -0,0 +1,49 @@
+<?php
+
+use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Date;
+use Illuminate\Support\Facades\DB;
+use Laravel\Pulse\Facades\Pulse;
+
+it('prune Pulse data', function () {
+    # Arrange
+    Date::setTestNow('2000-01-01 00:00:04');
+    Pulse::set('type', 'foo', 'value');
+    Date::setTestNow('2000-01-01 00:00:05');
+    Pulse::set('type', 'bar', 'value');
+    Date::setTestNow('2000-01-01 00:00:06');
+    Pulse::set('type', 'baz', 'value');
+    Pulse::ingest();
+
+    Pulse::stopRecording();
+    Date::setTestNow('2000-01-08 00:00:05');
+
+    # Act
+    Artisan::call('pulse:prune');
+
+    # Assert
+    expect(DB::table('pulse_values')->count())->toBe(0);
+    expect(DB::table('pulse_entries')->count())->toBe(0);
+    expect(DB::table('pulse_aggregates')->count())->toBe(0);
+});
+
+it('prune entries from the suggested before hours', function () {
+    // Entries will be pruned
+    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);
+
+    // Entries will be kept
+    Date::setTestNow("2000-01-07 00:00:00");
+    Pulse::record('baz', 'xxxx', 1);
+    Pulse::ingest();
+
+    Pulse::stopRecording();
+    Date::setTestNow('2000-01-09 00:00:00');
+
+    # Act
+    Artisan::call("pulse:prune --hours=168");
+
+    expect(DB::table('pulse_entries')->pluck('type')->all())->toBe(['baz']);
+});

tests/StorageFake.php

@@ -3,6 +3,7 @@
 namespace Tests;
 
 use Carbon\CarbonInterval;
+use DateTimeInterface;
 use Illuminate\Support\Collection;
 use Laravel\Pulse\Contracts\Storage;
 
@@ -34,6 +35,17 @@ public function trim(): void
         $this->stored = $this->stored->reject(fn ($record) => $record->timestamp <= now()->subWeek()->timestamp);
     }
 
+    /**
+     * Prune the storage.
+     *
+     * @param  \DateTimeInterface  $before
+     * @return void
+     */
+    public function prune(DateTimeInterface $before): void
+    {
+        $this->stored = $this->stored->reject(fn ($record) => $record->timestamp <= $before->getTimestamp());
+    }
+
     /**
      * Purge the storage.
      *