Adding notifications to fleetbase

migrations/2023_10_18_080950_create_notifications_table.php

@@ -0,0 +1,35 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateNotificationsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('notifications', function (Blueprint $table) {
+            $table->uuid('id')->primary();
+            $table->string('type');
+            $table->uuidMorphs('notifiable');
+            $table->text('data');
+            $table->timestamp('read_at')->nullable();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('notifications');
+    }
+}

src/Models/Notification.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Fleetbase\Models;
+
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\Searchable;
+use Illuminate\Notifications\DatabaseNotification;
+
+class Notification extends DatabaseNotification
+{
+    use HasApiModelBehavior;
+    use Searchable;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['read_at', 'data'];
+
+    /**
+     * The searchable columns.
+     *
+     * @var array
+     */
+    protected $searchableColumns = ['data->message'];
+}

src/Models/User.php

@@ -477,6 +477,16 @@ public function routeNotificationForTwilio()
         return $this->phone;
     }
 
+    /**
+     * The channels the user receives notification broadcasts on.
+     *
+     * @return string
+     */
+    public function receivesBroadcastNotificationsOn()
+    {
+        return 'user.' . $this->uuid;
+    }
+
     /**
      * Accessor to get the types associated with the model instance.
      *

src/Notifications/UserCreated.php

@@ -5,16 +5,20 @@
 use Fleetbase\Models\Company;
 use Fleetbase\Models\User;
 use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
+// use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Messages\BroadcastMessage;
 use Illuminate\Notifications\Notification;
+use Illuminate\Support\Carbon;
 
-class UserCreated extends Notification implements ShouldQueue
+class UserCreated extends Notification
 {
     use Queueable;
 
     public ?User $user;
     public ?Company $company;
+    public ?string $sentAt;
+    public ?string $notificationId;
 
     /**
      * Create a new notification instance.
@@ -25,6 +29,8 @@ public function __construct(User $user, Company $company)
     {
         $this->user    = $user;
         $this->company = $company;
+        $this->sentAt  = Carbon::now()->toDateTimeString();
+        $this->notificationId = uniqid('notification_');
     }
 
     /**
@@ -34,7 +40,7 @@ public function __construct(User $user, Company $company)
      */
     public function via($notifiable)
     {
-        return ['mail'];
+        return ['mail', 'database', 'broadcast'];
     }
 
     /**
@@ -45,11 +51,46 @@ public function via($notifiable)
     public function toMail($notifiable)
     {
         return (new MailMessage())
-                    ->subject('🥳 New Fleetbase Signup!')
-                    ->line('View user details below.')
-                    ->line('Name: ' . $this->user->name)
-                    ->line('Email: ' . $this->user->email)
-                    ->line('Phone: ' . $this->user->phone)
-                    ->line('Company: ' . $this->company->name);
+            ->subject('🥳 New Fleetbase Signup!')
+            ->line('View user details below.')
+            ->line('Name: ' . $this->user->name)
+            ->line('Email: ' . $this->user->email)
+            ->line('Phone: ' . $this->user->phone)
+            ->line('Company: ' . $this->company->name);
+    }
+
+    /**
+     * Get the broadcastable representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return \Illuminate\Notifications\Messages\BroadcastMessage
+     */
+    public function toBroadcast($notifiable)
+    {
+        return new BroadcastMessage($this->toArray($notifiable));
+    }
+
+    /**
+     * Get the array representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function toArray($notifiable)
+    {
+        return [
+            'id'          => $this->notificationId,
+            'created_at'  => $this->sentAt,
+            'notifiable' => $notifiable->{$notifiable->getKeyName()},
+            'data'        => [
+                'subject' => '🥳 New Fleetbase Signup!',
+                'message' => 'New user ' . $this->user->name . ' added to organization ' . $this->company->name,
+                'id' => $this->user->uuid,
+                'email' => $this->user->email,
+                'phone' => $this->user->phone,
+                'companyId' => $this->company->uuid,
+                'company' => $this->company->name,
+            ],
+        ];
     }
 }

src/Observers/NotificationObserver.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Fleetbase\Observers;
+
+use Fleetbase\Models\Notification;
+
+class NotificationObserver
+{
+}

src/Observers/UserObserver.php

@@ -5,6 +5,7 @@
 use Fleetbase\Models\Company;
 use Fleetbase\Models\CompanyUser;
 use Fleetbase\Models\User;
+use Fleetbase\Notifications\UserCreated;
 
 class UserObserver
 {
@@ -16,7 +17,7 @@ class UserObserver
     public function created(User $user)
     {
         // load user company
-        $user->load(['company']);
+        $user->load(['company.owner']);
 
         // create company user record
         if ($user->company_uuid) {
@@ -25,6 +26,9 @@ public function created(User $user)
 
         // invite user to join company
         $user->sendInviteFromCompany();
+
+        // Notify the company owner a user has been created
+        $user->company->owner->notify(new UserCreated($user, $user->company));
     }
 
     /**

src/Providers/CoreServiceProvider.php

@@ -26,6 +26,7 @@ class CoreServiceProvider extends ServiceProvider
     public $observers = [
         \Fleetbase\Models\User::class              => \Fleetbase\Observers\UserObserver::class,
         \Fleetbase\Models\ApiCredential::class     => \Fleetbase\Observers\ApiCredentialObserver::class,
+        \Fleetbase\Models\Notification::class      => \Fleetbase\Observers\NotificationObserver::class,
         \Spatie\Activitylog\Models\Activity::class => \Fleetbase\Observers\ActivityObserver::class,
     ];