feat: added registration + tests. Fine-tuned Auth tests

Author: Lexx

.env.testing

@@ -1,5 +1,5 @@
 APP_NAME=Laravelte
-APP_ENV=local
+APP_ENV=production
 APP_KEY=base64:GKVp3UUkWnXCqvI2DOMLw84D0/ysWhcYaGYioAkAYNU=
 APP_DEBUG=true
 APP_URL=http://laravelte.test
@@ -10,6 +10,7 @@ LOG_CHANNEL=stack
 LOG_DEPRECATIONS_CHANNEL=null
 LOG_LEVEL=debug
 DEBUGBAR_ENABLED=false
+DD_ON_ERROR=false
 
 DB_CONNECTION=sqlite
 DB_HOST=127.0.0.1
@@ -20,7 +21,7 @@ DB_PASSWORD=
 
 BROADCAST_DRIVER=log
 CACHE_DRIVER=redis
-CACHE_PREFIX="laravelte_"
+CACHE_PREFIX="laravelte_testing_"
 FILESYSTEM_DISK=local
 QUEUE_CONNECTION=sync
 SESSION_DRIVER=redis

README.md

@@ -29,6 +29,7 @@ It features:
 - [Laravel Actions](https://laravelactions.com/): Instead of creating controllers, jobs, listeners and so on, it allows you to create a PHP class that handles a specific task and run that class as anything you want.
 - [Redis support](https://laravel.com/docs/queues) and Laravel Queues.
 - [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+- [i18N (Localization) - Multiple languages support](https://laravel.com/docs/10.x/localization#main-content).
 
 Laravel is accessible, powerful, and provides tools required for large, robust applications.
 
@@ -58,6 +59,13 @@ php artisan test --group=api
 
 # Setup tests
 php artisan test --group=setup
+
+# test in parallel
+php artisan test --parallel
+php artisan test --parallel --processes=4
+
+# list of your ten slowest tests
+php artisan test --profile
 ```
 
 ## Contributing

app/Actions/Auth/Register.php

@@ -3,9 +3,11 @@
 namespace App\Actions\Auth;
 
 use App\Events\CRUDErrorOccurred;
+use App\Events\UserWasRegistered;
 use App\Http\Requests\RegisterRequest;
 use App\Http\Resources\UserResource;
 use App\Models\User;
+use App\Repositories\UserRepository;
 use App\Traits\CustomControllerResponsesTrait;
 use App\Traits\ThemesTrait;
 use Exception;
@@ -21,7 +23,14 @@ class Register
     use ThemesTrait;
     use CustomControllerResponsesTrait;
 
-    public function asController(RegisterRequest $request)
+    /**
+     * Provide functions for formatting & detecting phone numbers
+     *
+     * @var UsersRepository
+     */
+    protected $usersRepo;
+
+    public function asController(RegisterRequest $request, UserRepository $usersRepo)
     {
         if (!setting('allow_user_registrations')) {
             return $this->respError(trans('auth.registration_closed'));
@@ -40,44 +49,7 @@ public function asController(RegisterRequest $request)
             'last_name',
         ]);
 
-        $data = collect($data)->filter(function ($value) {
-            return !empty($value);
-        })->toArray();
-
-        try {
-            DB::beginTransaction();
-
-            $role = User::ROLE_DEFAULT;
-            $theRole = 'ROLE_' . strtoupper($role);
-            $data['role'] = constant("App\Models\User::$theRole");
-
-            isset($data['date_of_birth']) ? $data['date_of_birth'] = Carbon::parse(request('date_of_birth')) : '';
-            $data['password'] = bcrypt($data['password']);
-
-            // set an appropriate (user)name if not provided
-            if (!isset($data['name']) || empty($data['name'])) {
-                if (isset($data['first_name'])) {
-                    $data['name'] = Str::slug($data['first_name'] . '-' . Str::random(5));
-                } else if (isset($data['email'])) {
-                    $data['name'] = Str::slug(explode('@', $data['email'])[0] . '-' . Str::random(5));
-                } else {
-                    $data['name'] = Str::slug(Str::random(10));
-                }
-            }
-
-            $user = User::create($data);
-        } catch (Exception $e) {
-            DB::rollBack();
-
-            debugOn() ? dde($e->getMessage()) : '';
-
-            event(new CRUDErrorOccurred($e->getMessage()));
-
-            return false;
-        }
-
-        // TODO: event
-        // event(new UserWasCreated($user->fresh(), doe()));
+        $user = $usersRepo->create($data, User::ROLE_DEFAULT);
 
         if ($user) {
             if ($request->wantsJson())

app/Events/UserWasCreated.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\User;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
+use Illuminate\Broadcasting\PrivateChannel;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class UserWasCreated
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    public $user;
+    public $ipAddress;
+
+    /**
+     * User|null admin. If missing, the user was created by the system/registration)
+     */
+    public $admin;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(User $user, $ipAddress, $admin = null)
+    {
+        $this->user = $user;
+        $this->ipAddress = $ipAddress;
+        $this->admin = $admin;
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return new PrivateChannel('channel-name');
+    }
+}

app/Http/Requests/RegisterRequest.php

@@ -25,7 +25,7 @@ public function rules()
     {
         return [
             'name' => 'nullable|string|max:255|unique:users,name',
-            'email' => 'nullable|email|string|min:1|max:255|unique:users,email',
+            'email' => 'required|email|string|min:1|max:255|unique:users,email',
             'phone' => 'nullable|string|max:255|min:10|unique:users,phone|starts_with:+',
             'password' => 'required|string|confirmed|max:255',
             'first_name' => 'required|string|max:255',
@@ -35,25 +35,4 @@ public function rules()
         ];
     }
 
-    /**
-     * extra validation
-     *
-     * @param $validator
-     */
-    public function withValidator($validator)
-    {
-        // validate at least user has provided email, or username
-        $validator->after(function ($validator)
-        {
-            $email = $validator->attributes()['email'] ?? null;
-            $username = $validator->attributes()['name'] ?? null;
-
-            if(! $email && ! $username)
-            {
-                $message = trans('auth.email_name_required');
-                $validator->errors()->add('email', $message);
-                $validator->errors()->add('name', $message);
-            }
-        });
-    }
 }

app/Library/events.php

@@ -2,7 +2,9 @@
 
 use App\Events\CRUDErrorOccurred;
 use App\Events\UserLoggedIn;
+use App\Events\UserWasCreated;
 use App\Listeners\CRUDErrorHasOccurred;
+use App\Listeners\UserHasBeenCreated;
 use App\Listeners\UserHasLoggedIn;
 
 $events = [
@@ -12,5 +14,11 @@
 
     UserLoggedIn::class => [
         UserHasLoggedIn::class,
+    ],
+
+    UserWasCreated::class => [
+        UserHasBeenCreated::class,
     ]
+
+
 ];

app/Library/helpers.php

@@ -1,6 +1,7 @@
 <?php
 
 use App\Models\Configuration;
+use App\Models\User;
 use App\Repositories\RedisRepository;
 use App\Repositories\SystemInfoRepository;
 use Illuminate\Http\Resources\Json\JsonResource;
@@ -35,6 +36,18 @@ function debugOn() : bool
     }
 }
 
+if (! function_exists('ddOnError'))
+{
+    /**
+     * dd on error
+     */
+    function ddOnError(Exception $e) : void
+    {
+        if(debugOn() && env('DD_ON_ERROR', true))
+            dde($e->getMessage());
+    }
+}
+
 
 if(! function_exists('doe'))
 {
@@ -317,3 +330,14 @@ function is_serialized($data)
     }
 }
 
+if (! function_exists('adminUsers'))
+{
+    /**
+     * Get the admin users in the system
+     * Userfule when one requires to alert admins of an activity
+     */
+    function adminUsers()
+    {
+        return User::admins()->get();
+    }
+}

app/Listeners/UserHasBeenCreated.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace App\Listeners;
+
+use App\Notifications\NotifyAdmin;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Queue\InteractsWithQueue;
+
+class UserHasBeenCreated implements ShouldQueue
+{
+    public $tries = 3;
+    public $timeout = 120;
+
+    /**
+     * Create the event listener.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Handle the event.
+     *
+     * @param  object  $event
+     * @return void
+     */
+    public function handle($event)
+    {
+        $user = $event->user;
+        $ipAddress = $event->ipAddress;
+        $admin = $event->admin;
+
+        // notify admins
+        foreach(adminUsers() as $admin)
+        {
+            $message = $admin
+                ? $admin->aka . " added a new user in the system."
+                : "Email: " . $user->email;
+
+            $admin->notify(new NotifyAdmin($user->aka . "'s account has just been created!", $message, '#', $ipAddress));
+        }
+
+    }
+}

app/Notifications/NotifyAdmin.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace App\Notifications;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+
+class NotifyAdmin extends Notification
+{
+    use Queueable;
+
+    public $tries = 3;
+    public $timeout = 120;
+
+    public $title, $message, $ipAddress, $link;
+
+    /**
+     * Create a new notification instance.
+     */
+    public function __construct(
+        string $title,
+        string $message,
+        $link = '#',
+        $ipAddress = null
+    )
+    {
+        $this->title = $title;
+        $this->message = $message;
+        $this->link = $link;
+        $this->ipAddress = $ipAddress;
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @return array<int, string>
+     */
+    public function via(object $notifiable): array
+    {
+        // return $notifiable->prefers_sms ? ['nexmo'] : ['mail', 'database'];
+        return ['database'];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     */
+    public function toMail(object $notifiable): MailMessage
+    {
+        return (new MailMessage)
+                    ->line('The introduction to the notification.')
+                    ->action('Notification Action', url('/'))
+                    ->line('Thank you for using our application!');
+    }
+
+    /**
+     * Get the array representation of the notification.
+     *
+     * @return array<string, mixed>
+     */
+    public function toArray(object $notifiable): array
+    {
+        return [
+            'title' => $this->title,
+            'message' => $this->message,
+            'link' => $this->link,
+            'ip_address' => $this->ipAddress,
+        ];
+    }
+}