Add events for notification sent/failed

Author: cretueusebiu

src/Events/NotificationFailed.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace NotificationChannels\WebPush\Events;
+
+use Illuminate\Queue\SerializesModels;
+
+class NotificationFailed
+{
+    use SerializesModels;
+
+    /**
+     * @var \Minishlink\WebPush\MessageSentReport
+     */
+    public $report;
+
+    /**
+     * @var \NotificationChannels\WebPush\PushSubscription
+     */
+    public $subscription;
+
+    /**
+     * @var \NotificationChannels\WebPush\WebPushMessage
+     */
+    public $message;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param \Minishlink\WebPush\MessageSentReport $report
+     * @param \NotificationChannels\WebPush\PushSubscription $subscription
+     * @param \NotificationChannels\WebPush\WebPushMessage $message
+     * @return void
+     */
+    public function __construct($report, $subscription, $message)
+    {
+        $this->report = $report;
+        $this->subscription = $subscription;
+        $this->message = $message;
+    }
+}

src/Events/NotificationSent.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace NotificationChannels\WebPush\Events;
+
+use Illuminate\Queue\SerializesModels;
+
+class NotificationSent
+{
+    use SerializesModels;
+
+    /**
+     * @var \Minishlink\WebPush\MessageSentReport
+     */
+    public $report;
+
+    /**
+     * @var \NotificationChannels\WebPush\PushSubscription
+     */
+    public $subscription;
+
+    /**
+     * @var \NotificationChannels\WebPush\WebPushMessage
+     */
+    public $message;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param \Minishlink\WebPush\MessageSentReport $report
+     * @param \NotificationChannels\WebPush\PushSubscription $subscription
+     * @param \NotificationChannels\WebPush\WebPushMessage $message
+     * @return void
+     */
+    public function __construct($report, $subscription, $message)
+    {
+        $this->report = $report;
+        $this->subscription = $subscription;
+        $this->message = $message;
+    }
+}

src/ReportHandler.php

@@ -2,10 +2,28 @@
 
 namespace NotificationChannels\WebPush;
 
-use Illuminate\Support\Facades\Log;
+use Illuminate\Contracts\Events\Dispatcher;
+use NotificationChannels\WebPush\Events\NotificationFailed;
+use NotificationChannels\WebPush\Events\NotificationSent;
 
 class ReportHandler implements ReportHandlerInterface
 {
+    /**
+     * @var \Illuminate\Contracts\Events\Dispatcher
+     */
+    protected $events;
+
+    /**
+     * Create a new report handler.
+     *
+     * @param  \Illuminate\Contracts\Events\Dispatcher $events
+     * @return void
+     */
+    public function __construct(Dispatcher $events)
+    {
+        $this->events = $events;
+    }
+
     /**
      * Handle a message sent report.
      *
@@ -17,14 +35,14 @@ class ReportHandler implements ReportHandlerInterface
     public function handleReport($report, $subscription, $message)
     {
         if ($report->isSuccess()) {
+            $this->events->dispatch(new NotificationSent($report, $subscription, $message));
             return;
         }
 
         if ($report->isSubscriptionExpired()) {
             $subscription->delete();
-            return;
         }
 
-        Log::warning("Notification failed to sent for subscription {$subscription->endpoint}: {$report->getReason()}");
+        $this->events->dispatch(new NotificationFailed($report, $subscription, $message));
     }
 }

tests/ChannelTest.php

@@ -4,35 +4,29 @@
 
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
+use Illuminate\Support\Facades\Event;
 use Minishlink\WebPush\MessageSentReport;
 use Minishlink\WebPush\Subscription;
 use Minishlink\WebPush\WebPush;
 use Mockery;
+use NotificationChannels\WebPush\Events\NotificationFailed;
+use NotificationChannels\WebPush\Events\NotificationSent;
 use NotificationChannels\WebPush\ReportHandler;
 use NotificationChannels\WebPush\WebPushChannel;
 
 class ChannelTest extends TestCase
 {
-    /** @var \Mockery\MockInterface */
-    protected $webPush;
-
-    /** @var \NotificationChannels\WebPush\WebPushChannel */
-    protected $channel;
-
-    public function setUp(): void
-    {
-        parent::setUp();
-
-        $this->webPush = Mockery::mock(WebPush::class);
-        $this->channel = new WebPushChannel($this->webPush, new ReportHandler);
-    }
-
     /** @test */
     public function notification_can_be_sent()
     {
+        Event::fake();
+
+        /** @var mixed $webpush */
+        $webpush = Mockery::mock(WebPush::class);
+        $channel = new WebPushChannel($webpush, $this->app->make(ReportHandler::class));
         $message = ($notification = new TestNotification)->toWebPush(null, null);
 
-        $this->webPush->shouldReceive('queueNotification')
+        $webpush->shouldReceive('queueNotification')
             ->once()
             ->withArgs(function (Subscription $subscription, string $payload, array $options = [], array $auth = []) use ($message) {
                 $this->assertInstanceOf(Subscription::class, $subscription);
@@ -47,24 +41,32 @@ public function notification_can_be_sent()
             })
             ->andReturn(true);
 
-        $this->webPush->shouldReceive('flush')
+        $webpush->shouldReceive('flush')
             ->once()
             ->andReturn((function () {
                 yield new MessageSentReport(new Request('POST', 'endpoint'), null, true);
             })());
 
         $this->testUser->updatePushSubscription('endpoint', 'key', 'token', 'aesgcm');
 
-        $this->channel->send($this->testUser, $notification);
+        $channel->send($this->testUser, $notification);
+
+        Event::assertDispatched(NotificationSent::class);
     }
 
     /** @test */
     public function subscriptions_with_invalid_endpoint_are_deleted()
     {
-        $this->webPush->shouldReceive('queueNotification')
+        Event::fake();
+
+        /** @var mixed $webpush */
+        $webpush = Mockery::mock(WebPush::class);
+        $channel = new WebPushChannel($webpush, $this->app->make(ReportHandler::class));
+
+        $webpush->shouldReceive('queueNotification')
             ->times(3);
 
-        $this->webPush->shouldReceive('flush')
+        $webpush->shouldReceive('flush')
             ->once()
             ->andReturn((function () {
                 yield new MessageSentReport(new Request('POST', 'valid_endpoint'), new Response(200), true);
@@ -76,10 +78,14 @@ public function subscriptions_with_invalid_endpoint_are_deleted()
         $this->testUser->updatePushSubscription('invalid_endpoint1');
         $this->testUser->updatePushSubscription('invalid_endpoint2');
 
-        $this->channel->send($this->testUser, new TestNotification);
+        $channel->send($this->testUser, new TestNotification);
 
         $this->assertTrue($this->testUser->pushSubscriptions()->where('endpoint', 'valid_endpoint')->exists());
         $this->assertFalse($this->testUser->pushSubscriptions()->where('endpoint', 'invalid_endpoint1')->exists());
         $this->assertFalse($this->testUser->pushSubscriptions()->where('endpoint', 'invalid_endpoint2')->exists());
+
+        Event::assertDispatched(NotificationSent::class);
+        Event::assertDispatched(NotificationFailed::class);
+        Event::assertDispatched(NotificationFailed::class);
     }
 }