Avoid duplicate data on detach, attach, sync (#873)

owen-it · Oct 10, 2023 · cca0fbe · cca0fbe
1 parent 7adc295
commit cca0fbe
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 7 deletions.
diff --git a/src/Auditable.php b/src/Auditable.php
@@ -736,8 +736,8 @@ public function auditSyncWithoutDetaching(string $relationName, $ids, $columns =
      */
     private function dispatchRelationAuditEvent($relationName, $event, $old, $new)
     {
-        $this->auditCustomOld[$relationName] = $old->toArray();
-        $this->auditCustomNew[$relationName] = $new->toArray();
+        $this->auditCustomOld[$relationName] = $old->diff($new)->toArray();
+        $this->auditCustomNew[$relationName] = $new->diff($old)->toArray();
 
         if (
             empty($this->auditCustomOld[$relationName]) &&

diff --git a/tests/Functional/AuditingTest.php b/tests/Functional/AuditingTest.php
@@ -23,7 +23,6 @@ class AuditingTest extends AuditingTestCase
 {
     use WithFaker;
 
-
     /**
      * @test
      */
@@ -586,18 +585,20 @@ public function itWillAuditModelsWhenValuesAreEmpty()
      * @test
      * @return void
      */
-    public function itWillAuditCustomEventData()
+    public function itWillAuditAttach()
     {
         $firstCategory = factory(Category::class)->create();
         $secondCategory = factory(Category::class)->create();
         $article = factory(Article::class)->create();
 
         $article->auditAttach('categories', $firstCategory);
         $article->auditAttach('categories', $secondCategory);
-        $lastAttachedArticle = \end($article->audits->last()->getModified()['categories']['new']);
-        
+        $lastArticleAudit = $article->audits->last()->getModified()['categories'];
+
         $this->assertSame($firstCategory->name, $article->categories->first()->name);
-        $this->assertSame($secondCategory->name, $lastAttachedArticle['name']);
+        $this->assertSame(0, count($lastArticleAudit['old']));
+        $this->assertSame(1, count($lastArticleAudit['new']));
+        $this->assertSame($secondCategory->name, $lastArticleAudit['new'][0]['name']);
     }
 
     /**
@@ -733,6 +734,61 @@ public function itWillNotAuditSyncWhenSkippingEmptyValuesAndNoChangesMade()
         $this->assertSame($no_of_audits_before, $no_of_audits_after);
     }
 
+    /**
+     * @test
+     * @return void
+     */
+    public function itWillNotAuditAttachWhenSkippingEmptyValuesAndNoChangesMade()
+    {
+        $this->app['config']->set('audit.empty_values', false);
+
+        $firstCategory = factory(Category::class)->create();
+        $article = factory(Article::class)->create();
+
+        $article->categories()->attach($firstCategory);
+
+        $no_of_audits_before = Audit::where('auditable_type', Article::class)->count();
+        $categoryBefore = $article->categories()->first()->getKey();
+
+        $article->auditAttach('categories', [$firstCategory->getKey()]);
+
+        $no_of_audits_after = Audit::where('auditable_type', Article::class)->count();
+        $categoryAfter = $article->categories()->first()->getKey();
+
+        $this->assertSame($firstCategory->getKey(), $categoryBefore);
+        $this->assertSame($firstCategory->getKey(), $categoryAfter);
+        $this->assertSame($categoryBefore, $categoryAfter);
+        $this->assertSame($no_of_audits_before, $no_of_audits_after);
+    }
+
+    /**
+     * @test
+     * @return void
+     */
+    public function itWillNotAuditDetachWhenSkippingEmptyValuesAndNoChangesMade()
+    {
+        $this->app['config']->set('audit.empty_values', false);
+
+        $firstCategory = factory(Category::class)->create();
+        $secondCategory = factory(Category::class)->create();
+        $article = factory(Article::class)->create();
+
+        $article->categories()->attach($firstCategory);
+
+        $no_of_audits_before = Audit::where('auditable_type', Article::class)->count();
+        $categoryBefore = $article->categories()->first()->getKey();
+
+        $article->auditDetach('categories', [$secondCategory->getKey()]);
+
+        $no_of_audits_after = Audit::where('auditable_type', Article::class)->count();
+        $categoryAfter = $article->categories()->first()->getKey();
+
+        $this->assertSame($firstCategory->getKey(), $categoryBefore);
+        $this->assertSame($firstCategory->getKey(), $categoryAfter);
+        $this->assertSame($categoryBefore, $categoryAfter);
+        $this->assertSame($no_of_audits_before, $no_of_audits_after);
+    }
+
     /**
      * @test
      * @return void