Fix AuditCustom event not respecting audit.enabled and audit.console config

Author: rrodrigofranco

src/Contracts/Auditable.php

@@ -35,6 +35,11 @@ public function getAuditEvent();
      */
     public function getAuditEvents(): array;
 
+    /**
+     * Determine whether auditing is enabled.
+     */
+    public static function isAuditingEnabled(): bool;
+
     /**
      * Is the model ready for auditing?
      */

src/Listeners/RecordCustomAudit.php

@@ -9,6 +9,10 @@ class RecordCustomAudit
 {
     public function handle(AuditCustom $event): void
     {
+        if (! $event->model::isAuditingEnabled()) {
+            return;
+        }
+
         Auditor::execute($event->model);
     }
 }

tests/Functional/AuditingTest.php

@@ -946,6 +946,41 @@ public function test_can_audit_any_custom_event(): void
         ]);
     }
 
+    public function test_custom_event_does_not_audit_when_auditing_is_disabled(): void
+    {
+        config(['audit.enabled' => false]);
+
+        $article = Article::factory()->create();
+        $article->auditEvent = 'whateverYouWant';
+        $article->isCustomEvent = true;
+        $article->auditCustomOld = ['customExample' => 'Anakin Skywalker'];
+        $article->auditCustomNew = ['customExample' => 'Darth Vader'];
+
+        $auditCountBefore = Audit::where('auditable_type', Article::class)->count();
+
+        Event::dispatch(new AuditCustom($article));
+
+        $this->assertSame($auditCountBefore, Audit::where('auditable_type', Article::class)->count());
+    }
+
+    public function test_custom_event_does_not_audit_when_running_in_console_without_console_flag(): void
+    {
+        App::shouldReceive('runningInConsole')->andReturn(true);
+        config(['audit.enabled' => true, 'audit.console' => false]);
+
+        $article = Article::factory()->create();
+        $article->auditEvent = 'whateverYouWant';
+        $article->isCustomEvent = true;
+        $article->auditCustomOld = ['customExample' => 'Anakin Skywalker'];
+        $article->auditCustomNew = ['customExample' => 'Darth Vader'];
+
+        $auditCountBefore = Audit::where('auditable_type', Article::class)->count();
+
+        Event::dispatch(new AuditCustom($article));
+
+        $this->assertSame($auditCountBefore, Audit::where('auditable_type', Article::class)->count());
+    }
+
     public function test_can_audit_custom_audit_model_implementation(): void
     {
         $audit = null;