feat(Audit): multiple user type support

Author: quetzyg

config/audit.php

@@ -30,14 +30,18 @@
     | User Keys, Model
     |--------------------------------------------------------------------------
     |
-    | Define the User primary key, foreign key and Eloquent model.
+    | Define the User Eloquent model, morph prefix and authentication guards
+    | to use in the User resolver.
     |
     */
 
     'user' => [
-        'primary_key' => 'id',
-        'foreign_key' => 'user_id',
-        'model'       => App\User::class,
+        'model'        => App\User::class,
+        'morph_prefix' => 'user',
+        'guards'       => [
+            'web',
+            'api',
+        ],
     ],
 
     /*

database/migrations/audits.stub

@@ -27,7 +27,7 @@ class CreateAuditsTable extends Migration
     {
         Schema::create('audits', function (Blueprint $table) {
             $table->increments('id');
-            $table->unsignedInteger('user_id')->nullable();
+            $table->nullableMorphs('user');
             $table->string('event');
             $table->morphs('auditable');
             $table->text('old_values')->nullable();

src/Audit.php

@@ -16,7 +16,6 @@
 
 use DateTimeInterface;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Support\Facades\Config;
 
@@ -70,20 +69,18 @@ public function auditable(): MorphTo
     /**
      * {@inheritdoc}
      */
-    public function user(): BelongsTo
+    public function user(): MorphTo
     {
-        return $this->belongsTo(
-            Config::get('audit.user.model'),
-            Config::get('audit.user.foreign_key', 'user_id'),
-            Config::get('audit.user.primary_key', 'id')
-        );
+        return $this->morphTo();
     }
 
     /**
      * {@inheritdoc}
      */
     public function resolveData(): array
     {
+        $morphPrefix = Config::get('audit.user.morph_prefix', 'user');
+
         // Metadata
         $this->data = [
             'audit_id'         => $this->id,
@@ -94,7 +91,8 @@ public function resolveData(): array
             'audit_tags'       => $this->tags,
             'audit_created_at' => $this->serializeDate($this->created_at),
             'audit_updated_at' => $this->serializeDate($this->updated_at),
-            'user_id'          => $this->getAttribute(Config::get('audit.user.foreign_key', 'user_id')),
+            'user_id'          => $this->getAttribute($morphPrefix.'_id'),
+            'user_type'        => $this->getAttribute($morphPrefix.'_type'),
         ];
 
         if ($this->user) {

src/Auditable.php

@@ -278,21 +278,24 @@ public function toAudit(): array
             }
         }
 
-        $userForeignKey = Config::get('audit.user.foreign_key', 'user_id');
+        $morphPrefix = Config::get('audit.user.morph_prefix', 'user');
 
         $tags = implode(',', $this->generateTags());
 
+        $user = $this->resolveUser();
+
         return $this->transformAudit([
-            'old_values'     => $old,
-            'new_values'     => $new,
-            'event'          => $this->auditEvent,
-            'auditable_id'   => $this->getKey(),
-            'auditable_type' => $this->getMorphClass(),
-            $userForeignKey  => $this->resolveUser(),
-            'url'            => $this->resolveUrl(),
-            'ip_address'     => $this->resolveIpAddress(),
-            'user_agent'     => $this->resolveUserAgent(),
-            'tags'           => empty($tags) ? null : $tags,
+            'old_values'         => $old,
+            'new_values'         => $new,
+            'event'              => $this->auditEvent,
+            'auditable_id'       => $this->getKey(),
+            'auditable_type'     => $this->getMorphClass(),
+            $morphPrefix.'_id'   => $user ? $user->getAuthIdentifier() : null,
+            $morphPrefix.'_type' => $user ? $user->getMorphClass() : null,
+            'url'                => $this->resolveUrl(),
+            'ip_address'         => $this->resolveIpAddress(),
+            'user_agent'         => $this->resolveUserAgent(),
+            'tags'               => empty($tags) ? null : $tags,
         ]);
     }
 

src/Contracts/Audit.php

@@ -14,7 +14,6 @@
 
 namespace OwenIt\Auditing\Contracts;
 
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 interface Audit
@@ -43,9 +42,9 @@ public function auditable(): MorphTo;
     /**
      * User responsible for the changes.
      *
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
      */
-    public function user(): BelongsTo;
+    public function user(): MorphTo;
 
     /**
      * Audit data resolver.

src/Resolvers/UserResolver.php

@@ -15,6 +15,7 @@
 namespace OwenIt\Auditing\Resolvers;
 
 use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Config;
 
 class UserResolver implements \OwenIt\Auditing\Contracts\UserResolver
 {
@@ -23,6 +24,17 @@ class UserResolver implements \OwenIt\Auditing\Contracts\UserResolver
      */
     public static function resolve()
     {
-        return Auth::check() ? Auth::user()->getAuthIdentifier() : null;
+        $guards = Config::get('audit.user.guards', [
+            'web',
+            'api',
+        ]);
+
+        foreach ($guards as $guard) {
+            if (Auth::guard($guard)->check()) {
+                return Auth::guard($guard)->user();
+            }
+        }
+
+        return null;
     }
 }