OverdueNotificationTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use App\Enums\TaskStatus;
use App\Jobs\NotifyTaskOverdue;
use App\Models\Project;
use App\Models\Task;
use App\Models\User;
use App\Notifications\TaskOverdueNotification;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\Bus;
use Illuminate\Support\Facades\Notification;
use PHPUnit\Framework\Attributes\Test;
use Tests\TestCase;

class OverdueNotificationTest extends TestCase
{
    use RefreshDatabase;

    private User $user;

    private Project $project;

    protected function setUp(): void
    {
        parent::setUp();

        $this->user = User::factory()->create();
        $this->project = Project::factory()->for($this->user)->create();
    }

    #[Test]
    public function the_command_queues_a_job_for_every_overdue_task(): void
    {
        Bus::fake();

        $overdue = Task::factory(3)->overdue()->for($this->project)->create();
        Task::factory(2)->for($this->project)->create(['due_date' => now()->addWeek()]);
        Task::factory()->done()->for($this->project)->create(['due_date' => now()->subWeek()]);

        $this->artisan('tasks:notify-overdue')
            ->expectsOutputToContain('Queued 3 overdue notification(s).')
            ->assertSuccessful();

        Bus::assertDispatchedTimes(NotifyTaskOverdue::class, 3);
        Bus::assertDispatched(
            NotifyTaskOverdue::class,
            fn (NotifyTaskOverdue $job) => $overdue->contains($job->task->id),
        );
    }

    #[Test]
    public function the_command_skips_tasks_that_were_already_notified(): void
    {
        Bus::fake();

        Task::factory()->overdue()->for($this->project)->create(['overdue_notified_at' => now()]);

        $this->artisan('tasks:notify-overdue')->assertSuccessful();

        Bus::assertNothingDispatched();
    }

    #[Test]
    public function the_job_notifies_the_owner_and_stamps_the_task(): void
    {
        Notification::fake();

        $task = Task::factory()->overdue()->for($this->project)->create();

        (new NotifyTaskOverdue($task))->handle();

        Notification::assertSentTo(
            $this->user,
            TaskOverdueNotification::class,
            fn (TaskOverdueNotification $notification) => $notification->task->is($task),
        );

        $this->assertNotNull($task->fresh()->overdue_notified_at);
    }

    #[Test]
    public function the_job_does_nothing_when_the_task_was_finished_meanwhile(): void
    {
        Notification::fake();

        $task = Task::factory()->overdue()->for($this->project)->create();
        $task->update(['status' => TaskStatus::Done]);

        (new NotifyTaskOverdue($task))->handle();

        Notification::assertNothingSent();
        $this->assertNull($task->fresh()->overdue_notified_at);
    }

    #[Test]
    public function the_job_does_nothing_when_the_task_was_deleted_meanwhile(): void
    {
        Notification::fake();

        $task = Task::factory()->overdue()->for($this->project)->create();
        $task->delete();

        (new NotifyTaskOverdue($task))->handle();

        Notification::assertNothingSent();
    }

    #[Test]
    public function rescheduling_a_task_allows_a_new_notification(): void
    {
        $task = Task::factory()->overdue()->for($this->project)->create([
            'overdue_notified_at' => now(),
        ]);

        $this->actingAs($this->user, 'sanctum')
            ->patchJson(route('api.v1.tasks.update', $task), [
                'due_date' => now()->addWeek()->toDateTimeString(),
            ])
            ->assertOk();

        $this->assertNull($task->fresh()->overdue_notified_at);
    }

    #[Test]
    public function editing_another_field_keeps_the_notification_stamp(): void
    {
        $task = Task::factory()->overdue()->for($this->project)->create([
            'overdue_notified_at' => now(),
        ]);

        $this->actingAs($this->user, 'sanctum')
            ->patchJson(route('api.v1.tasks.update', $task), ['title' => 'Renamed'])
            ->assertOk();

        $this->assertNotNull($task->fresh()->overdue_notified_at);
    }
}