#41 - wip

app/Architecture/Providers/EventServiceProvider.php

@@ -9,20 +9,24 @@ use Toby\Domain\Events\VacationRequestAcceptedByAdministrative;
 use Toby\Domain\Events\VacationRequestAcceptedByTechnical;
 use Toby\Domain\Events\VacationRequestApproved;
 use Toby\Domain\Events\VacationRequestCreated;
+use Toby\Domain\Events\VacationRequestRejected;
 use Toby\Domain\Events\VacationRequestStateChanged;
 use Toby\Domain\Listeners\CreateVacationRequestActivity;
 use Toby\Domain\Listeners\HandleAcceptedByAdministrativeVacationRequest;
 use Toby\Domain\Listeners\HandleAcceptedByTechnicalVacationRequest;
 use Toby\Domain\Listeners\HandleApprovedVacationRequest;
 use Toby\Domain\Listeners\HandleCreatedVacationRequest;
+use Toby\Domain\Listeners\SendCreatedVacationRequestNotification;
+use Toby\Domain\Listeners\SendRejectedVacationRequestNotification;
 
 class EventServiceProvider extends ServiceProvider
 {
     protected $listen = [
         VacationRequestStateChanged::class => [CreateVacationRequestActivity::class],
-        VacationRequestCreated::class => [HandleCreatedVacationRequest::class],
+        VacationRequestCreated::class => [HandleCreatedVacationRequest::class, SendCreatedVacationRequestNotification::class],
         VacationRequestAcceptedByTechnical::class => [HandleAcceptedByTechnicalVacationRequest::class],
         VacationRequestAcceptedByAdministrative::class => [HandleAcceptedByAdministrativeVacationRequest::class],
         VacationRequestApproved::class => [HandleApprovedVacationRequest::class],
+        VacationRequestRejected::class => [SendRejectedVacationRequestNotification::class],
     ];
 }

app/Domain/Events/VacationRequestRejected.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Domain\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use Toby\Eloquent\Models\VacationRequest;
+
+class VacationRequestRejected
+{
+    use Dispatchable;
+    use SerializesModels;
+
+    public function __construct(
+        public VacationRequest $vacationRequest,
+    ) {
+    }
+}

app/Domain/Listeners/SendCreatedVacationRequestNotification.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Domain\Listeners;
+
+use Toby\Domain\Events\VacationRequestCreated;
+use Toby\Domain\Notifications\VacationRequestCreatedNotification;
+
+class SendCreatedVacationRequestNotification
+{
+    public function __construct(
+    ) {
+    }
+
+    public function handle(VacationRequestCreated $event): void
+    {
+        $event->vacationRequest->user->notify(new VacationRequestCreatedNotification($event->vacationRequest));
+    }
+}

app/Domain/Listeners/SendRejectedVacationRequestNotification.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Domain\Listeners;
+
+use Illuminate\Support\Collection;
+use Toby\Domain\Enums\Role;
+use Toby\Domain\Events\VacationRequestCreated;
+use Toby\Domain\Events\VacationRequestRejected;
+use Toby\Domain\Notifications\VacationRequestRejectedNotification;
+use Toby\Eloquent\Models\User;
+
+class SendRejectedVacationRequestNotification
+{
+    public function __construct(
+    ) {
+    }
+
+    public function handle(VacationRequestRejected $event): void
+    {
+        foreach ($this->getUsersForNotifications() as $user) {
+            $user->notify(new VacationRequestRejectedNotification($event->vacationRequest, $user));
+        }
+
+        $event->vacationRequest->user->notify(new VacationRequestRejectedNotification($event->vacationRequest, $event->vacationRequest->user));
+    }
+
+    protected function getUsersForNotifications(): Collection
+    {
+        return User::query()
+            ->whereIn("role", [Role::TechnicalApprover, Role::AdministrativeApprover])
+            ->get();
+    }
+}

app/Domain/Notifications/VacationRequestCreatedNotification.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Toby\Domain\Notifications;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+use InvalidArgumentException;
+use Toby\Eloquent\Models\VacationRequest;
+
+class VacationRequestCreatedNotification extends Notification
+{
+    use Queueable;
+
+    public function __construct(
+        protected VacationRequest $vacationRequest,
+    ) {
+    }
+
+    public function via(): array
+    {
+        return ["mail"];
+    }
+
+    /**
+     * @throws InvalidArgumentException
+     */
+    public function toMail(): MailMessage
+    {
+        $url = route(
+            "vacation.requests.show",
+            [
+                "vacationRequest" => $this->vacationRequest,
+            ],
+        );
+
+        return $this->buildMailMessage($url);
+    }
+
+    protected function buildMailMessage(string $url): MailMessage
+    {
+        $title = $this->vacationRequest->name;
+
+        $user = $this->vacationRequest->user;
+
+        return (new MailMessage())
+            ->greeting(__("Hi :user!", [
+                "user" => $user->fullName,
+            ]))
+            ->subject(__("Vacation request :title", [
+                "title" => $title,
+            ]))
+            ->line(__("Vacation request has been created.", [
+            ]))
+            ->action(__("Show vacation request"), $url);
+    }
+}

app/Domain/Notifications/VacationRequestRejectedNotification.php

@@ -11,17 +11,14 @@ use InvalidArgumentException;
 use Toby\Eloquent\Models\User;
 use Toby\Eloquent\Models\VacationRequest;
 
-class VacationRequestNotification extends Notification
+class VacationRequestRejectedNotification extends Notification
 {
     use Queueable;
 
-    protected User $user;
-    protected VacationRequest $vacationRequest;
-
-    public function __construct(User $user, VacationRequest $vacationRequest)
-    {
-        $this->user = $user;
-        $this->vacationRequest = $vacationRequest;
+    public function __construct(
+        protected VacationRequest $vacationRequest,
+        protected User $user,
+    ) {
     }
 
     public function via(): array
@@ -47,20 +44,15 @@ class VacationRequestNotification extends Notification
     protected function buildMailMessage(string $url): MailMessage
     {
         $title = $this->vacationRequest->name;
-        $state = $this->vacationRequest->state->label();
-
-        $user = $this->user->getFullNameAttribute();
 
         return (new MailMessage())
             ->greeting(__("Hi :user!", [
-                "user" => $user,
+                "user" => $this->user->fullName,
             ]))
             ->subject(__("Vacation request :title", [
                 "title" => $title,
             ]))
-            ->line(__("The vacation request :title has changed state to :state.", [
-                "title" => $title,
-                "state" => $state,
+            ->line(__("Vacation request has been rejected.", [
             ]))
             ->action(__("Show vacation request"), $url);
     }

app/Domain/VacationRequestNotificationSender.php

@@ -1,31 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Toby\Domain;
-
-use Illuminate\Support\Collection;
-use Toby\Domain\Enums\Role;
-use Toby\Domain\Notifications\VacationRequestNotification;
-use Toby\Eloquent\Models\User;
-use Toby\Eloquent\Models\VacationRequest;
-
-class VacationRequestNotificationSender
-{
-    public function sendVacationRequestNotification(VacationRequest $vacationRequest): void
-    {
-        foreach ($this->getUsersForNotifications() as $user) {
-            $user->notify(new VacationRequestNotification($user, $vacationRequest));
-        }
-
-        $vacationRequest->user->notify(new VacationRequestNotification($vacationRequest->user, $vacationRequest));
-    }
-
-    protected function getUsersForNotifications(): Collection
-    {
-        return User::query()
-            ->where("role", Role::TECHNICAL_APPROVER)
-            ->orWhere("role", Role::ADMINISTRATIVE_APPROVER)
-            ->get();
-    }
-}

app/Domain/VacationRequestStateManager.php

@@ -11,6 +11,7 @@ use Toby\Domain\Events\VacationRequestAcceptedByAdministrative;
 use Toby\Domain\Events\VacationRequestAcceptedByTechnical;
 use Toby\Domain\Events\VacationRequestApproved;
 use Toby\Domain\Events\VacationRequestCreated;
+use Toby\Domain\Events\VacationRequestRejected;
 use Toby\Eloquent\Models\VacationRequest;
 
 class VacationRequestStateManager
@@ -38,6 +39,7 @@ class VacationRequestStateManager
     public function reject(VacationRequest $vacationRequest): void
     {
         $this->changeState($vacationRequest, VacationRequestState::Rejected);
+        $this->dispatcher->dispatch(new VacationRequestRejected($vacationRequest));
     }
 
     public function cancel(VacationRequest $vacationRequest): void

app/Eloquent/Observers/VacationRequestObserver.php

@@ -5,10 +5,9 @@ declare(strict_types=1);
 namespace Toby\Eloquent\Observers;
 
 use Illuminate\Contracts\Auth\Factory as Auth;
-use Illuminate\Events\Dispatcher;
+use Illuminate\Contracts\Events\Dispatcher;
 use Toby\Domain\Enums\VacationRequestState;
 use Toby\Domain\Events\VacationRequestStateChanged;
-use Toby\Domain\VacationRequestNotificationSender;
 use Toby\Eloquent\Models\User;
 use Toby\Eloquent\Models\VacationRequest;
 
@@ -17,7 +16,6 @@ class VacationRequestObserver
     public function __construct(
         protected Auth $auth,
         protected Dispatcher $dispatcher,
-        protected VacationRequestNotificationSender $vacationRequestNotificationSender,
     ) {
     }
 
@@ -41,13 +39,6 @@ class VacationRequestObserver
         }
     }
 
-    public function updated(VacationRequest $vacationRequest): void
-    {
-        if ($vacationRequest->state !== VacationRequestState::CREATED) {
-            $this->vacationRequestNotificationSender->sendVacationRequestNotification($vacationRequest);
-        }
-    }
-
     protected function fireStateChangedEvent(
         VacationRequest $vacationRequest,
         ?VacationRequestState $from,

package-lock.json

@@ -1,5 +1,5 @@
 {
-    "name": "toby",
+    "name": "application",
     "lockfileVersion": 2,
     "requires": true,
     "packages": {

tests/Feature/VacationRequestTest.php

@@ -6,17 +6,19 @@ namespace Tests\Feature;
 
 use Illuminate\Foundation\Testing\DatabaseMigrations;
 use Illuminate\Support\Carbon;
-use Illuminate\Support\Facades\Bus;
+use Illuminate\Support\Facades\Event;
 use Inertia\Testing\AssertableInertia as Assert;
 use Tests\FeatureTestCase;
 use Toby\Domain\Enums\VacationRequestState;
 use Toby\Domain\Enums\VacationType;
+use Toby\Domain\Events\VacationRequestAcceptedByAdministrative;
+use Toby\Domain\Events\VacationRequestAcceptedByTechnical;
+use Toby\Domain\Events\VacationRequestRejected;
 use Toby\Domain\PolishHolidaysRetriever;
 use Toby\Eloquent\Models\User;
 use Toby\Eloquent\Models\VacationLimit;
 use Toby\Eloquent\Models\VacationRequest;
 use Toby\Eloquent\Models\YearPeriod;
-use Toby\Infrastructure\Jobs\SendVacationRequestDaysToGoogleCalendar;
 
 class VacationRequestTest extends FeatureTestCase
 {
@@ -28,8 +30,6 @@ class VacationRequestTest extends FeatureTestCase
     {
         parent::setUp();
 
-        Bus::fake();
-
         $this->polishHolidaysRetriever = $this->app->make(PolishHolidaysRetriever::class);
     }
 
@@ -90,6 +90,8 @@ class VacationRequestTest extends FeatureTestCase
 
     public function testTechnicalApproverCanApproveVacationRequest(): void
     {
+        Event::fake();
+
         $user = User::factory()->createQuietly();
         $technicalApprover = User::factory()->createQuietly();
         $currentYearPeriod = YearPeriod::current();
@@ -106,13 +108,13 @@ class VacationRequestTest extends FeatureTestCase
             ->post("/vacation-requests/{$vacationRequest->id}/accept-as-technical")
             ->assertSessionHasNoErrors();
 
-        $this->assertDatabaseHas("vacation_requests", [
-            "state" => VacationRequestState::WaitingForAdministrative,
-        ]);
+        Event::assertDispatched(VacationRequestAcceptedByTechnical::class);
     }
 
     public function testAdministrativeApproverCanApproveVacationRequest(): void
     {
+        Event::fake(VacationRequestAcceptedByAdministrative::class);
+
         $user = User::factory()->createQuietly();
         $administrativeApprover = User::factory()->createQuietly();
 
@@ -129,20 +131,18 @@ class VacationRequestTest extends FeatureTestCase
             ->post("/vacation-requests/{$vacationRequest->id}/accept-as-administrative")
             ->assertSessionHasNoErrors();
 
-        $this->assertDatabaseHas("vacation_requests", [
-            "state" => VacationRequestState::Approved,
-        ]);
-
-        Bus::assertDispatched(SendVacationRequestDaysToGoogleCalendar::class);
+        Event::assertDispatched(VacationRequestAcceptedByAdministrative::class);
     }
 
     public function testTechnicalApproverCanRejectVacationRequest(): void
     {
+        Event::fake();
+
         $user = User::factory()->createQuietly();
         $technicalApprover = User::factory()->createQuietly();
         $currentYearPeriod = YearPeriod::current();
 
-        $vacationLimit = VacationLimit::factory([
+        VacationLimit::factory([
             "days" => 20,
         ])
             ->for($user)
@@ -161,9 +161,7 @@ class VacationRequestTest extends FeatureTestCase
             ->post("/vacation-requests/{$vacationRequest->id}/reject")
             ->assertSessionHasNoErrors();
 
-        $this->assertDatabaseHas("vacation_requests", [
-            "state" => VacationRequestState::Rejected,
-        ]);
+        Event::assertDispatched(VacationRequestRejected::class);
     }
 
     public function testUserCannotCreateVacationRequestIfHeExceedsHisVacationLimit(): void

tests/Unit/VacationRequestNotificationTest.php

@@ -5,8 +5,8 @@ declare(strict_types=1);
 namespace Tests\Unit;
 
 use Illuminate\Foundation\Testing\DatabaseMigrations;
-use Illuminate\Support\Facades\Notification;
 use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\Notification;
 use Tests\TestCase;
 use Tests\Traits\InteractsWithYearPeriods;
 use Toby\Domain\Enums\Role;
@@ -38,16 +38,22 @@ class VacationRequestNotificationTest extends TestCase
     {
         Notification::fake();
 
-        $user = User::factory(["role" => Role::EMPLOYEE])->createQuietly();
-        $technicalApprover = User::factory(["role" => Role::TECHNICAL_APPROVER])->createQuietly();
-        $administrativeApprover = User::factory(["role" => Role::ADMINISTRATIVE_APPROVER])->createQuietly();
+        $user = User::factory([
+            "role" => Role::Employee,
+        ])->createQuietly();
+        $technicalApprover = User::factory([
+            "role" => Role::TechnicalApprover,
+        ])->createQuietly();
+        $administrativeApprover = User::factory([
+            "role" => Role::AdministrativeApprover,
+        ])->createQuietly();
 
         $currentYearPeriod = YearPeriod::current();
 
         /** @var VacationRequest $vacationRequest */
         $vacationRequest = VacationRequest::factory([
-            "type" => VacationType::VACATION->value,
-            "state" => VacationRequestState::CREATED,
+            "type" => VacationType::Vacation->value,
+            "state" => VacationRequestState::Created,
             "from" => Carbon::create($currentYearPeriod->year, 2, 1)->toDateString(),
             "to" => Carbon::create($currentYearPeriod->year, 2, 4)->toDateString(),
             "comment" => "Comment for the vacation request.",
@@ -61,21 +67,29 @@ class VacationRequestNotificationTest extends TestCase
         Notification::assertSentTo([$user, $technicalApprover, $administrativeApprover], VacationRequestNotification::class);
     }
 
-    public function testAfterChangingVacationRequestStateNotificationIsNotSentToAnotherEmployee(): void {
+    public function testAfterChangingVacationRequestStateNotificationIsNotSentToAnotherEmployee(): void
+    {
         Notification::fake();
 
-        $user = User::factory(["role" => Role::EMPLOYEE])->createQuietly();
-        $anotherUser = User::factory(["role" => Role::EMPLOYEE])->createQuietly();
-        $technicalApprover = User::factory(["role" => Role::TECHNICAL_APPROVER])->createQuietly();
-        $administrativeApprover = User::factory(["role" => Role::ADMINISTRATIVE_APPROVER])->createQuietly();
-
+        $user = User::factory([
+            "role" => Role::Employee,
+        ])->createQuietly();
+        $anotherUser = User::factory([
+            "role" => Role::Employee,
+        ])->createQuietly();
+        $technicalApprover = User::factory([
+            "role" => Role::TechnicalApprover,
+        ])->createQuietly();
+        $administrativeApprover = User::factory([
+            "role" => Role::AdministrativeApprover,
+        ])->createQuietly();
 
         $currentYearPeriod = YearPeriod::current();
 
         /** @var VacationRequest $vacationRequest */
         $vacationRequest = VacationRequest::factory([
-            "type" => VacationType::VACATION->value,
-            "state" => VacationRequestState::CREATED,
+            "type" => VacationType::Vacation->value,
+            "state" => VacationRequestState::Created,
             "from" => Carbon::create($currentYearPeriod->year, 2, 1)->toDateString(),
             "to" => Carbon::create($currentYearPeriod->year, 2, 4)->toDateString(),
             "comment" => "Comment for the vacation request.",
@@ -90,5 +104,3 @@ class VacationRequestNotificationTest extends TestCase
         Notification::assertNotSentTo([$anotherUser], VacationRequestNotification::class);
     }
 }
-
-