use custom model in send command (#103)

thomasjohnkane · Apr 16, 2024 · 7a5a7d2 · 7a5a7d2
1 parent de570f0
commit 7a5a7d2
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 8 deletions.
diff --git a/src/Console/Commands/SendScheduledNotifications.php b/src/Console/Commands/SendScheduledNotifications.php
@@ -2,9 +2,9 @@
 
 namespace Thomasjohnkane\Snooze\Console\Commands;
 
-use Carbon\Carbon;
 use Illuminate\Console\Command;
-use Thomasjohnkane\Snooze\Models\ScheduledNotification;
+use Thomasjohnkane\Snooze\Models\ScheduledNotification as ScheduledNotificationModel;
+use Thomasjohnkane\Snooze\ScheduledNotification;
 
 class SendScheduledNotifications extends Command
 {
@@ -31,11 +31,7 @@ public function handle(): void
     {
         $tolerance = config('snooze.sendTolerance');
 
-        $notifications = ScheduledNotification::whereNull('sent_at')
-                                ->whereNull('cancelled_at')
-                                ->where('send_at', '<=', Carbon::now())
-                                ->where('send_at', '>=', Carbon::now()->subSeconds($tolerance ?? 60))
-                                ->get();
+        $notifications = ScheduledNotification::getPendingNotifications($tolerance);
 
         if (! $notifications->count()) {
             $this->info('No Scheduled Notifications need to be sent.');
@@ -51,7 +47,7 @@ public function handle(): void
 
         $this->info(sprintf('Sending %d scheduled notifications...', $notifications->count()));
 
-        $notifications->each(function (ScheduledNotification $notification) use ($bar) {
+        $notifications->each(function (ScheduledNotificationModel $notification) use ($bar) {
             $bar->advance();
 
             try {

diff --git a/src/ScheduledNotification.php b/src/ScheduledNotification.php
@@ -66,6 +66,18 @@ public static function create(
         ]));
     }
 
+    public static function getPendingNotifications(int $tolerance = null): \Illuminate\Database\Eloquent\Collection
+    {
+        $modelClass = self::getScheduledNotificationModelClass();
+
+        return $modelClass::query()
+            ->whereNull('sent_at')
+            ->whereNull('cancelled_at')
+            ->where('send_at', '<=', Carbon::now())
+            ->where('send_at', '>=', Carbon::now()->subSeconds($tolerance ?? 60))
+            ->get();
+    }
+
     public static function find(int $scheduledNotificationId): ?self
     {
         $modelClass = self::getScheduledNotificationModelClass();

diff --git a/tests/Models/CustomScheduledNotification.php b/tests/Models/CustomScheduledNotification.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Thomasjohnkane\Snooze\Tests\Models;
+
+use Exception;
+use Thomasjohnkane\Snooze\Models\ScheduledNotification;
+
+class CustomScheduledNotification extends ScheduledNotification
+{
+    public function send(): void
+    {
+        throw new Exception('Custom send method');
+    }
+}
diff --git a/tests/SendCommandTest.php b/tests/SendCommandTest.php
@@ -3,10 +3,12 @@
 namespace Thomasjohnkane\Snooze\Tests;
 
 use Carbon\Carbon;
+use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Notification;
 use Thomasjohnkane\Snooze\Models\ScheduledNotification as ScheduledNotificationModel;
 use Thomasjohnkane\Snooze\ScheduledNotification;
+use Thomasjohnkane\Snooze\Tests\Models\CustomScheduledNotification;
 use Thomasjohnkane\Snooze\Tests\Models\User;
 use Thomasjohnkane\Snooze\Tests\Notifications\TestNotification;
 use TiMacDonald\Log\LogEntry;
@@ -78,4 +80,21 @@ public function testItCatchesFailedScheduledNotifications()
             && $log->message === 'Cannot Send. Unserialize Failed. (unserialize(): Error at offset 0 of 10 bytes)'
         );
     }
+
+    public function testUsesCustomModelWhenSending()
+    {
+        Log::swap(new LogFake());
+        $target = User::find(1);
+
+        Config::set('snooze.model', CustomScheduledNotification::class);
+        $target->notifyAt(new TestNotification(User::find(2)), Carbon::now());
+
+        $this->artisan('snooze:send')
+            ->expectsOutput('Starting Sending Scheduled Notifications')
+            ->assertExitCode(0);
+
+        Log::assertLogged(fn (LogEntry $log) => $log->level === 'error'
+            && $log->message === 'Custom send method'
+        );
+    }
 }