Make dynamic resolvers

+ Deprecate specific resolver contracts + move user resolver to user config + rename resolver array to resolvers in config
onlime · Feb 4, 2022 · c6b06dd · c6b06dd
1 parent 06ca0fd
commit c6b06dd
Show file tree

Hide file tree

Showing 9 changed files with 42 additions and 69 deletions.
diff --git a/config/audit.php b/config/audit.php
@@ -24,12 +24,13 @@
     |
     */
 
-    'user' => [
+    'user'      => [
         'morph_prefix' => 'user',
         'guards'       => [
             'web',
             'api',
         ],
+        'resolver' => OwenIt\Auditing\Resolvers\UserResolver::class
     ],
 
     /*
@@ -40,8 +41,7 @@
     | Define the User, IP Address, User Agent and URL resolver implementations.
     |
     */
-    'resolver' => [
-        'user'       => OwenIt\Auditing\Resolvers\UserResolver::class,
+    'resolvers' => [
         'ip_address' => OwenIt\Auditing\Resolvers\IpAddressResolver::class,
         'user_agent' => OwenIt\Auditing\Resolvers\UserAgentResolver::class,
         'url'        => OwenIt\Auditing\Resolvers\UrlResolver::class,

diff --git a/src/Auditable.php b/src/Auditable.php
@@ -2,16 +2,14 @@
 
 namespace OwenIt\Auditing;
 
+use Dotenv\Loader\Resolver;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Config;
 use OwenIt\Auditing\Contracts\AttributeEncoder;
 use OwenIt\Auditing\Contracts\AttributeRedactor;
-use OwenIt\Auditing\Contracts\IpAddressResolver;
-use OwenIt\Auditing\Contracts\UrlResolver;
-use OwenIt\Auditing\Contracts\UserAgentResolver;
 use OwenIt\Auditing\Contracts\UserResolver;
 use OwenIt\Auditing\Exceptions\AuditableTransitionException;
 use OwenIt\Auditing\Exceptions\AuditingException;
@@ -278,19 +276,16 @@ public function toAudit(): array
 
         $user = $this->resolveUser();
 
-        return $this->transformAudit([
+        return $this->transformAudit(array_merge([
             '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,
-        ]);
+        ], $this->runResolvers()));
     }
 
     /**
@@ -319,58 +314,18 @@ protected function resolveUser()
         throw new AuditingException('Invalid UserResolver implementation');
     }
 
-    /**
-     * Resolve the URL.
-     *
-     * @return string
-     * @throws AuditingException
-     *
-     */
-    protected function resolveUrl(): string
-    {
-        $urlResolver = Config::get('audit.resolver.url');
-
-        if (is_subclass_of($urlResolver, UrlResolver::class)) {
-            return call_user_func([$urlResolver, 'resolve']);
-        }
 
-        throw new AuditingException('Invalid UrlResolver implementation');
-    }
-
-    /**
-     * Resolve the IP Address.
-     *
-     * @return string
-     * @throws AuditingException
-     *
-     */
-    protected function resolveIpAddress(): string
+    protected function runResolvers(): array
     {
-        $ipAddressResolver = Config::get('audit.resolver.ip_address');
-
-        if (is_subclass_of($ipAddressResolver, IpAddressResolver::class)) {
-            return call_user_func([$ipAddressResolver, 'resolve']);
-        }
-
-        throw new AuditingException('Invalid IpAddressResolver implementation');
-    }
-
-    /**
-     * Resolve the User Agent.
-     *
-     * @return string|null
-     * @throws AuditingException
-     *
-     */
-    protected function resolveUserAgent()
-    {
-        $userAgentResolver = Config::get('audit.resolver.user_agent');
+        $resolved = [];
+        foreach (Config::get('audit.resolvers', []) as $name => $implementation) {
+            if (is_subclass_of($implementation, Resolver::class)) {
+                $resolved[$name] = call_user_func([$implementation, 'resolve']);
+            }
 
-        if (is_subclass_of($userAgentResolver, UserAgentResolver::class)) {
-            return call_user_func([$userAgentResolver, 'resolve']);
+            throw new AuditingException('Invalid Resolver implementation for: ' . $name);
         }
-
-        throw new AuditingException('Invalid UserAgentResolver implementation');
+        return $resolved;
     }
 
     /**

diff --git a/src/Contracts/IpAddressResolver.php b/src/Contracts/IpAddressResolver.php
@@ -2,6 +2,10 @@
 
 namespace OwenIt\Auditing\Contracts;
 
+/**
+ * @deprecated
+ * @see Resolver
+ */
 interface IpAddressResolver
 {
     /**

diff --git a/src/Contracts/Resolver.php b/src/Contracts/Resolver.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace OwenIt\Auditing\Contracts;
+
+interface Resolver
+{
+    public static function resolve();
+}
diff --git a/src/Contracts/UrlResolver.php b/src/Contracts/UrlResolver.php
@@ -2,6 +2,10 @@
 
 namespace OwenIt\Auditing\Contracts;
 
+/**
+ * @deprecated
+ * @see Resolver
+ */
 interface UrlResolver
 {
     /**

diff --git a/src/Contracts/UserAgentResolver.php b/src/Contracts/UserAgentResolver.php
@@ -2,6 +2,10 @@
 
 namespace OwenIt\Auditing\Contracts;
 
+/**
+ * @deprecated
+ * @see Resolver
+ */
 interface UserAgentResolver
 {
     /**

diff --git a/src/Resolvers/IpAddressResolver.php b/src/Resolvers/IpAddressResolver.php
@@ -3,12 +3,11 @@
 namespace OwenIt\Auditing\Resolvers;
 
 use Illuminate\Support\Facades\Request;
+use OwenIt\Auditing\Contracts\Resolver;
 
-class IpAddressResolver implements \OwenIt\Auditing\Contracts\IpAddressResolver
+
+class IpAddressResolver implements Resolver
 {
-    /**
-     * {@inheritdoc}
-     */
     public static function resolve(): string
     {
         return Request::ip();

diff --git a/src/Resolvers/UrlResolver.php b/src/Resolvers/UrlResolver.php
@@ -4,11 +4,12 @@
 
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Request;
+use OwenIt\Auditing\Contracts\Resolver;
 
-class UrlResolver implements \OwenIt\Auditing\Contracts\UrlResolver
+class UrlResolver implements Resolver
 {
     /**
-     * {@inheritdoc}
+     * @return string
      */
     public static function resolve(): string
     {

diff --git a/src/Resolvers/UserAgentResolver.php b/src/Resolvers/UserAgentResolver.php
@@ -3,12 +3,10 @@
 namespace OwenIt\Auditing\Resolvers;
 
 use Illuminate\Support\Facades\Request;
+use OwenIt\Auditing\Contracts\Resolver;
 
-class UserAgentResolver implements \OwenIt\Auditing\Contracts\UserAgentResolver
+class UserAgentResolver implements Resolver
 {
-    /**
-     * {@inheritdoc}
-     */
     public static function resolve()
     {
         return Request::header('User-Agent');