🎉 [1.4.0] Version Update

- Support multiple mode for Edit Event Log - Add retrieved event log support - Fine tune some code.
yungts97 · Oct 2, 2022 · f0518ed · f0518ed
1 parent cce4a92
commit f0518ed
Show file tree

Hide file tree

Showing 13 changed files with 207 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -95,7 +95,18 @@ Log::all();
 
 However, you can get activity logs from a model by using this.
 ```php
-$post->logs();
+$post->logs; // get all model's logs
+$post->log; // get the latest model's log
+$post->logs()->where('log_type', 'edit')->get(); // get filtered logs
+```
+
+You allowed to specify the mode for the `edit` event log. There are two modes available now `simple`/`full`. The default mode is `full`.
+```php
+# config/user-activity-log.php
+
+# only can choose either one of them
+'mode' => 'full',   # the 'full' mode record everything
+'mode' => 'simple', # the 'simple' mode only record the modified columns
 ```
 
 ## ⚙️ Configuration
@@ -122,10 +133,17 @@ return [
         'create' => true,
         'edit'   => true,
         'delete' => true,
+        'retrieve' => false,
         'login'  => true,
         'logout' => true
     ],
 
+    # the mode is only for 'edit' event log
+    # the 'simple' mode only record the modified columns
+    # the 'full' mode record everything
+    # supported mode => 'simple' / 'full'
+    'mode' => 'full',
+
     # timezone for log date time (Change to your region time zone)
     # UTC is always the time zone being recorded.
     # define your timezone to have the accurate logs time and filtered record (Especially filtered by date time)

diff --git a/config/user-activity-log.php b/config/user-activity-log.php
@@ -20,12 +20,19 @@
         'create' => true,
         'edit'   => true,
         'delete' => true,
+        'retrieve' => false,
         'login'  => true,
         'logout' => true
     ],
 
+    # the mode is only for 'edit' event log
+    # the 'simple' mode only record the modified columns
+    # the 'full' mode record everything
+    # supported mode => 'simple' / 'full'
+    'mode' => 'full',
+
     # timezone for log date time (Change to your region time zone)
     # UTC is always the time zone being recorded.
     # define your timezone to have the accurate logs time and filtered record (Especially filtered by date time)
     'timezone' => 'UTC'
-];
+];
diff --git a/src/Events/RetrievedModel.php b/src/Events/RetrievedModel.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Yungts97\LaravelUserActivityLog\Events;
+
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Database\Eloquent\Model;
+
+class RetrievedModel
+{
+    use SerializesModels;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(public Model $model)
+    {
+    }
+}
diff --git a/src/Listeners/CreatedListener.php b/src/Listeners/CreatedListener.php
@@ -2,15 +2,10 @@
 
 namespace Yungts97\LaravelUserActivityLog\Listeners;
 
-use Yungts97\LaravelUserActivityLog\Traits\ListenerTraits\HasTableName;
-use Yungts97\LaravelUserActivityLog\Traits\ListenerTraits\HasData;
-
-class CreatedListener extends Listener
+class CreatedListener extends ModelListener
 {
-    use HasTableName, HasData;
-
     public function __construct()
     {
         parent::__construct("create");
     }
-}
+}
diff --git a/src/Listeners/DeletedListener.php b/src/Listeners/DeletedListener.php
@@ -2,15 +2,10 @@
 
 namespace Yungts97\LaravelUserActivityLog\Listeners;
 
-use Yungts97\LaravelUserActivityLog\Traits\ListenerTraits\HasTableName;
-use Yungts97\LaravelUserActivityLog\Traits\ListenerTraits\HasData;
-
-class DeletedListener extends Listener
+class DeletedListener extends ModelListener
 {
-    use HasTableName, HasData;
-
     public function __construct()
     {
         parent::__construct("delete");
     }
-}
+}
diff --git a/src/Listeners/Listener.php b/src/Listeners/Listener.php
@@ -3,6 +3,7 @@
 namespace Yungts97\LaravelUserActivityLog\Listeners;
 
 use Yungts97\LaravelUserActivityLog\Models\Log;
+use Illuminate\Contracts\Auth\Authenticatable;
 
 class Listener
 {
@@ -29,6 +30,7 @@ protected function logging()
             'ip'         => request()->ip(),
             'user_agent' => request()->userAgent()
         ];
+
         // insert log record
         Log::create([
             'user_id'       => auth()?->user()?->id,
@@ -42,6 +44,9 @@ protected function logging()
 
     protected function isLoggable()
     {
+        // always skip retrieve event for authenticatable model. Exp. App\Models\User
+        if ($this->isRetrieveAuthenticatableModel()) return false;
+
         return config("user-activity-log.events.{$this->event_name}", false);
     }
 
@@ -54,4 +59,11 @@ protected function getData()
     {
         return null;
     }
-}
+
+    private function isRetrieveAuthenticatableModel()
+    {
+        return
+            $this->event_name === 'retrieve' &&
+            $this->event?->model instanceof Authenticatable;
+    }
+}
diff --git a/src/Listeners/ModelListener.php b/src/Listeners/ModelListener.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Yungts97\LaravelUserActivityLog\Listeners;
+
+use Yungts97\LaravelUserActivityLog\Traits\ListenerTraits\HasData;
+use Yungts97\LaravelUserActivityLog\Traits\ListenerTraits\HasTableName;
+
+class ModelListener extends Listener
+{
+    use HasTableName, HasData;
+
+    public function __construct(string $event_name = "")
+    {
+        parent::__construct($event_name);
+    }
+}
diff --git a/src/Listeners/RetrievedListener.php b/src/Listeners/RetrievedListener.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Yungts97\LaravelUserActivityLog\Listeners;
+
+class RetrievedListener extends ModelListener
+{
+    public function __construct()
+    {
+        parent::__construct("retrieve");
+    }
+}
diff --git a/src/Listeners/UpdatedListener.php b/src/Listeners/UpdatedListener.php
@@ -2,15 +2,10 @@
 
 namespace Yungts97\LaravelUserActivityLog\Listeners;
 
-use Yungts97\LaravelUserActivityLog\Traits\ListenerTraits\HasTableName;
-use Yungts97\LaravelUserActivityLog\Traits\ListenerTraits\HasData;
-
-class UpdatedListener extends Listener
+class UpdatedListener extends ModelListener
 {
-    use HasTableName, HasData;
-
     public function __construct()
     {
         parent::__construct("edit");
     }
-}
+}
diff --git a/src/Traits/ListenerTraits/HasData.php b/src/Traits/ListenerTraits/HasData.php
@@ -8,8 +8,12 @@ trait HasData
 {
     protected function getData()
     {
-        return $this->event_name === 'create' ?
-            Arr::except($this->event->model->toArray(), $this->event->model->log_hidden ?? []) :
+        if ($this->event_name === 'create')
+            return Arr::except($this->event->model->toArray(), $this->event->model->log_hidden ?? []);
+
+        $mode = config("user-activity-log.mode", 'simple');
+        return $this->event_name === 'edit' && $mode === 'simple' ?
+            Arr::except([...$this->event->model->getChanges(), 'id' => $this->event->model->id], $this->event->model->log_hidden ?? []) :
             Arr::except($this->event->model->getRawOriginal(), $this->event->model->log_hidden ?? []);
     }
-}
+}
diff --git a/src/Traits/Loggable.php b/src/Traits/Loggable.php
@@ -6,6 +6,7 @@
 use Yungts97\LaravelUserActivityLog\Events\CreatedModel;
 use Yungts97\LaravelUserActivityLog\Events\DeletedModel;
 use Yungts97\LaravelUserActivityLog\Events\UpdatedModel;
+use Yungts97\LaravelUserActivityLog\Events\RetrievedModel;
 
 trait Loggable
 {
@@ -15,14 +16,17 @@ public function initializeLoggable()
             'created' => CreatedModel::class,
             'updated' => UpdatedModel::class,
             'deleted' => DeletedModel::class,
+            'retrieved' => RetrievedModel::class,
         ];
     }
 
+    public function log()
+    {
+        return $this->hasOne(Log::class, 'data->id', 'id')->where('table_name', $this->getTable());
+    }
+
     public function logs()
     {
-        return Log::where([
-            ['table_name', $this->getTable()],
-            ['data->id', $this->id]
-        ])->get();
+        return $this->hasMany(Log::class, 'data->id', 'id')->where('table_name', $this->getTable());
     }
-}
+}
diff --git a/src/UserActivityLogEventServiceProvider.php b/src/UserActivityLogEventServiceProvider.php
@@ -5,13 +5,15 @@
 use Illuminate\Auth\Events\Login;
 use Illuminate\Auth\Events\Logout;
 use Yungts97\LaravelUserActivityLog\Events\CreatedModel;
-use Yungts97\LaravelUserActivityLog\Events\UpdatedModel;
 use Yungts97\LaravelUserActivityLog\Events\DeletedModel;
-use Yungts97\LaravelUserActivityLog\Listeners\LogoutListener;
+use Yungts97\LaravelUserActivityLog\Events\UpdatedModel;
+use Yungts97\LaravelUserActivityLog\Events\RetrievedModel;
 use Yungts97\LaravelUserActivityLog\Listeners\LoginListener;
+use Yungts97\LaravelUserActivityLog\Listeners\LogoutListener;
 use Yungts97\LaravelUserActivityLog\Listeners\CreatedListener;
-use Yungts97\LaravelUserActivityLog\Listeners\UpdatedListener;
 use Yungts97\LaravelUserActivityLog\Listeners\DeletedListener;
+use Yungts97\LaravelUserActivityLog\Listeners\UpdatedListener;
+use Yungts97\LaravelUserActivityLog\Listeners\RetrievedListener;
 use Illuminate\Foundation\Support\Providers\EventServiceProvider;
 
 
@@ -32,11 +34,14 @@ class UserActivityLogEventServiceProvider extends EventServiceProvider
         ],
         DeletedModel::class => [
             DeletedListener::class
+        ],
+        RetrievedModel::class => [
+            RetrievedListener::class
         ]
     ];
 
     public function boot()
     {
         parent::boot();
     }
-}
+}
diff --git a/tests/Feature/UserActivityLogTest.php b/tests/Feature/UserActivityLogTest.php
@@ -75,6 +75,30 @@ function it_can_log_on_delete_event()
         ]);
     }
 
+    /** @test */
+    function it_can_log_on_retrieve_event()
+    {
+        config(['user-activity-log.events.retrieve' => true]);
+
+        //user login
+        $user = User::first();
+        Auth::login($user);
+
+        //create a post
+        $newPost = new Post(['name' => 'Post 1']);
+        $user->posts()->save($newPost);
+
+        //retrieve a post
+        $post = Post::first();
+
+        //checking database have the activity log record
+        $this->assertDatabaseHas('logs', [
+            'log_type' => 'retrieve',
+            'user_id' => $user->id,
+            'table_name' => 'posts'
+        ]);
+    }
+
     /** @test */
     function it_can_skip_logging()
     {
@@ -133,9 +157,70 @@ function it_can_get_logs_from_the_model()
             'table_name' => 'posts'
         ]);
 
-        $logs = $newPost->logs();
+        $logs = $newPost->logs;
         $this->assertCount(1, $logs);
-
-        $this->assertEquals($newPost->toArray(), $logs[0]->data);
+
+        $newPost->unsetRelation('logs');
+        $this->assertEquals($newPost->toArray(), $logs->first()->data);
+    }
+
+    /** @test */
+    function it_can_log_on_edit_event_with_simple_mode()
+    {
+        config(['user-activity-log.mode' => 'simple']);
+
+        //user login
+        $user = User::first();
+        Auth::login($user);
+
+        //create a post
+        $newPost = new Post(['name' => 'Post 1']);
+        $user->posts()->save($newPost);
+
+        //edit the post
+        $newPost->name = "Post 1 edited";
+        $newPost->save();
+
+        //checking database have the activity log record
+        $this->assertDatabaseHas('logs', [
+            'log_type' => 'edit',
+            'user_id' => $user->id,
+            'table_name' => 'posts'
+        ]);
+
+        //since the latest log is edit type, so just simply use latest log to test
+        $actualLogData = $newPost->log->data;
+        $expectedLogData = [...$newPost->getChanges(), 'id' => $newPost->id];
+        $this->assertTrue($expectedLogData == $actualLogData);
+    }
+
+    /** @test */
+    function it_can_log_on_edit_event_with_full_mode()
+    {
+        config(['user-activity-log.mode' => 'full']);
+
+        //user login
+        $user = User::first();
+        Auth::login($user);
+
+        //create a post
+        $newPost = new Post(['name' => 'Post 1']);
+        $user->posts()->save($newPost);
+        $expectedLogData = $newPost->getRawOriginal();
+
+        //edit the post
+        $newPost->name = "Post 1 edited";
+        $newPost->save();
+
+        //checking database have the activity log record
+        $this->assertDatabaseHas('logs', [
+            'log_type' => 'edit',
+            'user_id' => $user->id,
+            'table_name' => 'posts'
+        ]);
+
+        //since the latest log is edit type, so just simply use latest log to test
+        $actualLogData = $newPost->log->data;
+        $this->assertTrue($expectedLogData == $actualLogData);
     }
-}
+}