From ec53497ac7514e3fb089cbd98232af48bf85a8bc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mert=20A=C5=9Fan?= <mertemreasan@gmail.com>
Date: Thu, 1 Aug 2024 10:52:00 +0300
Subject: [PATCH] Add Event Dispatching for Notifications (#12)

* remove phpunit & add pestphp

* Drop support for Laravel 8

* update composer scripts & code quality tools

* refactoring

* migrate to pestphp

* Achieved 100% code coverage

* Temporarily revert changes that should be done in another PR

* remove namespace

* add Pest v1 support for Laravel 9

* formatting

* Remove parallel flag for Pest v1

https://github.com/mertasan/onesignal/actions/runs/10187251895/job/28180865729#step:6:33

The Parallel plugin has been moved to the main repo in Pest v2.

* Add missing directories to phpunit.xml

* add Events

* Apply events

* Add tests for Events
---
 phpunit.xml                                   | 34 +++----
 .../OneSignalNotificationErrorsOccurred.php   | 25 +++++
 src/Events/OneSignalNotificationNotSent.php   | 24 +++++
 src/Events/OneSignalNotificationSending.php   | 24 +++++
 src/Events/OneSignalNotificationSent.php      | 25 +++++
 src/OneSignalChannel.php                      | 18 +++-
 tests/Feature/ChannelEventsTest.php           | 97 +++++++++++++++++++
 7 files changed, 223 insertions(+), 24 deletions(-)
 create mode 100644 src/Events/OneSignalNotificationErrorsOccurred.php
 create mode 100644 src/Events/OneSignalNotificationNotSent.php
 create mode 100644 src/Events/OneSignalNotificationSending.php
 create mode 100644 src/Events/OneSignalNotificationSent.php
 create mode 100644 tests/Feature/ChannelEventsTest.php

diff --git a/phpunit.xml b/phpunit.xml
index 0610882..66cfe7c 100644
--- a/phpunit.xml
+++ b/phpunit.xml
@@ -1,23 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        bootstrap="vendor/autoload.php"
-        backupGlobals="false"
-        colors="true"
-        processIsolation="false"
-        stopOnError="true"
-        stopOnFailure="true"
-        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
->
-    <coverage>
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
-    </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" processIsolation="false" stopOnError="true" stopOnFailure="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd">
+  <testsuites>
+    <testsuite name="Unit Tests">
+      <directory>tests/Unit</directory>
+    </testsuite>
+    <testsuite name="Feature Tests">
+      <directory>tests/Feature</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </source>
 
-    <testsuites>
-        <testsuite name="Laravel Onesignal Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
 </phpunit>
diff --git a/src/Events/OneSignalNotificationErrorsOccurred.php b/src/Events/OneSignalNotificationErrorsOccurred.php
new file mode 100644
index 0000000..d83b276
--- /dev/null
+++ b/src/Events/OneSignalNotificationErrorsOccurred.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Macellan\OneSignal\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Notifications\Notification;
+use Illuminate\Queue\SerializesModels;
+
+class OneSignalNotificationErrorsOccurred
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    public function __construct(
+        public mixed $notifiable,
+        public Notification $notification,
+        public array $errors,
+    ) {
+        // .
+    }
+}
diff --git a/src/Events/OneSignalNotificationNotSent.php b/src/Events/OneSignalNotificationNotSent.php
new file mode 100644
index 0000000..518c538
--- /dev/null
+++ b/src/Events/OneSignalNotificationNotSent.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Macellan\OneSignal\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Notifications\Notification;
+use Illuminate\Queue\SerializesModels;
+
+class OneSignalNotificationNotSent
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    public function __construct(
+        public mixed $notifiable,
+        public Notification $notification,
+    ) {
+        // .
+    }
+}
diff --git a/src/Events/OneSignalNotificationSending.php b/src/Events/OneSignalNotificationSending.php
new file mode 100644
index 0000000..cf471ec
--- /dev/null
+++ b/src/Events/OneSignalNotificationSending.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Macellan\OneSignal\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Notifications\Notification;
+use Illuminate\Queue\SerializesModels;
+
+class OneSignalNotificationSending
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    public function __construct(
+        public mixed $notifiable,
+        public Notification $notification,
+    ) {
+        // .
+    }
+}
diff --git a/src/Events/OneSignalNotificationSent.php b/src/Events/OneSignalNotificationSent.php
new file mode 100644
index 0000000..18aa196
--- /dev/null
+++ b/src/Events/OneSignalNotificationSent.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Macellan\OneSignal\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Notifications\Notification;
+use Illuminate\Queue\SerializesModels;
+
+class OneSignalNotificationSent
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    public function __construct(
+        public mixed $notifiable,
+        public Notification $notification,
+        public array $response,
+    ) {
+        // .
+    }
+}
diff --git a/src/OneSignalChannel.php b/src/OneSignalChannel.php
index e47c5cf..ff362d9 100644
--- a/src/OneSignalChannel.php
+++ b/src/OneSignalChannel.php
@@ -6,6 +6,10 @@
 
 use Illuminate\Notifications\Notification;
 use Illuminate\Support\Facades\Http;
+use Macellan\OneSignal\Events\OneSignalNotificationErrorsOccurred;
+use Macellan\OneSignal\Events\OneSignalNotificationNotSent;
+use Macellan\OneSignal\Events\OneSignalNotificationSending;
+use Macellan\OneSignal\Events\OneSignalNotificationSent;
 use Macellan\OneSignal\Exceptions\CouldNotSendNotification;
 
 class OneSignalChannel
@@ -27,7 +31,7 @@ public function __construct(string $appId)
      *
      * @throws CouldNotSendNotification|\Illuminate\Http\Client\RequestException|\Illuminate\Http\Client\ConnectionException
      */
-    public function send(mixed $notifiable, Notification $notification): ?object
+    public function send(mixed $notifiable, Notification $notification): void
     {
         /**
          * @noinspection PhpPossiblePolymorphicInvocationInspection
@@ -40,9 +44,13 @@ public function send(mixed $notifiable, Notification $notification): ?object
         }
 
         if (! $userIds = $notifiable->routeNotificationFor('OneSignal', $notification)) {
-            return null;
+            OneSignalNotificationNotSent::dispatch($notifiable, $notification);
+
+            return;
         }
 
+        OneSignalNotificationSending::dispatch($notifiable, $notification);
+
         $result = Http::timeout($this->timeout)
             ->asJson()->acceptJson()
             ->post(self::ENDPOINT, [
@@ -58,6 +66,8 @@ public function send(mixed $notifiable, Notification $notification): ?object
 
             ]);
 
+        OneSignalNotificationSent::dispatch($notifiable, $notification, $result->json());
+
         if ($requestException = $result->toException()) {
             throw $requestException;
         }
@@ -65,9 +75,9 @@ public function send(mixed $notifiable, Notification $notification): ?object
         $errors = $result->json('errors');
 
         if (! empty($errors)) {
+            OneSignalNotificationErrorsOccurred::dispatch($notifiable, $notification, $errors);
+
             throw CouldNotSendNotification::withErrors($result->body());
         }
-
-        return $result;
     }
 }
diff --git a/tests/Feature/ChannelEventsTest.php b/tests/Feature/ChannelEventsTest.php
new file mode 100644
index 0000000..9c309c7
--- /dev/null
+++ b/tests/Feature/ChannelEventsTest.php
@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Http\Client\Request;
+use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\Http;
+use Macellan\OneSignal\Events\OneSignalNotificationErrorsOccurred;
+use Macellan\OneSignal\Events\OneSignalNotificationNotSent;
+use Macellan\OneSignal\Events\OneSignalNotificationSending;
+use Macellan\OneSignal\Events\OneSignalNotificationSent;
+use Macellan\OneSignal\Exceptions\CouldNotSendNotification;
+use Macellan\OneSignal\OneSignalChannel;
+use Macellan\OneSignal\Tests\Fixtures\Notifiable;
+use Macellan\OneSignal\Tests\Fixtures\Notifications\TestNotification;
+use Macellan\OneSignal\Tests\Fixtures\Notifications\TestNotificationByText;
+use Macellan\OneSignal\Tests\Fixtures\WrongNotifiable;
+
+test('notification not sent', function () {
+    Event::fake();
+
+    Http::fake([
+        'api/v1/notifications' => Http::response(),
+    ]);
+
+    (new WrongNotifiable)->notify(new TestNotificationByText);
+
+    Http::assertNothingSent();
+
+    Event::assertDispatched(OneSignalNotificationNotSent::class);
+});
+
+test('notification sent', function () {
+    Event::fake();
+
+    Http::fake([
+        'api/v1/notifications' => Http::response([
+            'id' => '931082f5-e442-42b1-a951-19e7e45dee39',
+            'recipients' => 1,
+            'external_id' => null,
+        ]),
+    ]);
+
+    (new Notifiable)->notify(new TestNotification);
+
+    Http::assertSent(function (Request $request) {
+        return $request->url() === OneSignalChannel::ENDPOINT &&
+            $request['app_id'] === $this->appId &&
+            $request['include_player_ids'] === ['player_id'] &&
+            $request['headings'] === ['en' => 'Subject'] &&
+            $request['contents'] === ['en' => 'Body'] &&
+            $request['data'] === null;
+    });
+
+    Event::assertNotDispatched(OneSignalNotificationNotSent::class);
+
+    Event::assertDispatched(OneSignalNotificationSending::class, static function ($event) {
+        return $event->notification instanceof TestNotification;
+    });
+
+    Event::assertDispatched(OneSignalNotificationSent::class, static function ($event) {
+        return $event->response['id'] === '931082f5-e442-42b1-a951-19e7e45dee39';
+    });
+
+    Event::assertNotDispatched(OneSignalNotificationErrorsOccurred::class);
+});
+
+test('notification errors occurred', function () {
+    Event::fake();
+
+    Http::fake([
+        'api/v1/notifications' => Http::response([
+            'id' => '',
+            'recipients' => 0,
+            'errors' => [
+                'All included players are not subscribed',
+            ],
+        ]),
+    ]);
+
+    try {
+        (new Notifiable)->notify(new TestNotification);
+    } catch (CouldNotSendNotification $e) {
+        expect($e->getMessage())
+            ->toContain('{"id":"","recipients":0,"errors":["All included players are not subscribed"]}');
+    }
+
+    Event::assertNotDispatched(OneSignalNotificationNotSent::class);
+
+    Event::assertDispatched(OneSignalNotificationSending::class, static function ($event) {
+        return $event->notification instanceof TestNotification;
+    });
+
+    Event::assertDispatched(OneSignalNotificationSent::class);
+
+    Event::assertDispatched(OneSignalNotificationErrorsOccurred::class);
+});