improve performance by not saving dirty models in generate computed a…

…ttributes command
korridor · Jun 10, 2022 · f549d92 · f549d92
1 parent 71d3b03
commit f549d92
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 1 deletion.
diff --git a/src/Console/GenerateComputedAttributes.php b/src/Console/GenerateComputedAttributes.php
@@ -89,7 +89,9 @@ public function handle(): int
                             foreach ($attributes as $attribute) {
                                 $modelResult->setComputedAttributeValue($attribute);
                             }
-                            $modelResult->save();
+                            if ($modelResult->isDirty()) {
+                                $modelResult->save();
+                            }
                         }
                     });
             }

diff --git a/tests/Feature/GenerateComputedAttributesCommandTest.php b/tests/Feature/GenerateComputedAttributesCommandTest.php
@@ -4,7 +4,10 @@
 
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Event;
 use Korridor\LaravelComputedAttributes\Tests\TestCase;
+use Korridor\LaravelComputedAttributes\Tests\TestEnvironment\Events\PostSaved;
+use Korridor\LaravelComputedAttributes\Tests\TestEnvironment\Events\PostSaving;
 use Korridor\LaravelComputedAttributes\Tests\TestEnvironment\Models\Post;
 use Korridor\LaravelComputedAttributes\Tests\TestEnvironment\Models\Vote;
 
@@ -33,6 +36,7 @@ public function testCommandComputesAttributesForAllModelsWithTraitAndAllThereAtt
             'complex_calculation' => null,
             'sum_of_votes' => 0,
         ]);
+        Event::fake();
 
         // Act
         $this->artisan('computed-attributes:generate', [
@@ -50,6 +54,8 @@ public function testCommandComputesAttributesForAllModelsWithTraitAndAllThereAtt
             'complex_calculation' => 3,
             'sum_of_votes' => 4,
         ]);
+        Event::assertDispatched(PostSaved::class);
+        Event::assertDispatched(PostSaving::class);
     }
 
     public function testCommandCanOnlyCalculateOneAttributeOfOneModelIfSpecifiedInArgument(): void
@@ -121,4 +127,44 @@ public function testZeroAsChunkSizeReturnsErrorMessage(): void
             ->assertExitCode(1)
             ->execute();
     }
+
+    public function testGenerateAttributesCommandWillNotDispatchEventsIfNotDirty(): void
+    {
+        // Arrange
+        $post = new Post();
+        $post->title = 'titleTest';
+        $post->content = 'Text';
+        $post->complex_calculation = 3;
+        $post->save();
+        Config::set('computed-attributes.model_path', 'Models');
+        Config::set(
+            'computed-attributes.model_namespace',
+            'Korridor\\LaravelComputedAttributes\\Tests\\TestEnvironment\\Models'
+        );
+        $this->assertDatabaseHas('posts', [
+            'id' => $post->id,
+            'complex_calculation' => 3,
+            'sum_of_votes' => 0,
+        ]);
+        Event::fake();
+
+        // Act
+        $this->artisan('computed-attributes:generate', [
+            'modelsAttributes' => 'Post:complex_calculation',
+        ])
+            ->expectsOutput('Start calculating for following attributes of model '.
+                '"Korridor\LaravelComputedAttributes\Tests\TestEnvironment\Models\Post":')
+            ->expectsOutput('[complex_calculation]')
+            ->assertExitCode(0)
+            ->execute();
+
+        // Assert
+        $this->assertDatabaseHas('posts', [
+            'id' => $post->id,
+            'complex_calculation' => 3,
+            'sum_of_votes' => 0,
+        ]);
+        Event::assertNotDispatched(PostSaved::class);
+        Event::assertNotDispatched(PostSaving::class);
+    }
 }
diff --git a/tests/TestEnvironment/Events/PostSaved.php b/tests/TestEnvironment/Events/PostSaved.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Korridor\LaravelComputedAttributes\Tests\TestEnvironment\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class PostSaved
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+}
diff --git a/tests/TestEnvironment/Events/PostSaving.php b/tests/TestEnvironment/Events/PostSaving.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Korridor\LaravelComputedAttributes\Tests\TestEnvironment\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class PostSaving
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+}
diff --git a/tests/TestEnvironment/Models/Post.php b/tests/TestEnvironment/Models/Post.php
@@ -6,6 +6,8 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Korridor\LaravelComputedAttributes\ComputedAttributes;
+use Korridor\LaravelComputedAttributes\Tests\TestEnvironment\Events\PostSaved;
+use Korridor\LaravelComputedAttributes\Tests\TestEnvironment\Events\PostSaving;
 
 class Post extends Model
 {
@@ -32,6 +34,14 @@ class Post extends Model
         'sum_of_votes' => 'int',
     ];
 
+    /**
+     * @var array
+     */
+    protected $dispatchesEvents = [
+        'saved' => PostSaved::class,
+        'saving' => PostSaving::class,
+    ];
+
     /*
      * Computed attributes.
      */