POC for laravel/framework#31778 cover changes in created updated saved that got into $original but not in db

Author: Pantea Marius-ciclistu

illuminate/Database/Eloquent/Concerns/HasAttributes.php

@@ -70,6 +70,12 @@ trait HasAttributes
      */
     protected ?array $tmpDirtyIfAttributesAreSyncedFromCashedCasts = null;
 
+    /**
+     * Temporary original cache to prevent changes in created,updated,saved events from getting
+     * into $original without being saved into DB
+     */
+    protected ?array $tmpOriginalBeforeAfterEvents = null;
+
     /**
      * The attributes that should be cast.
      *
@@ -2002,7 +2008,7 @@ public function only($attributes)
      */
     public function syncOriginal()
     {
-        $this->original = $this->getAttributes(isset($this->tmpDirtyIfAttributesAreSyncedFromCashedCasts));
+        $this->original = $this->getAttributes();
 
         return $this;
     }

illuminate/Database/Eloquent/Model.php

@@ -1159,10 +1159,9 @@ public function save(array $options = [])
             try {
                 /** We will try to optimize the execution by caching $dirty array BUT,
                 multiple set calls will be needed (https://github.com/laravel/framework/discussions/31778)
-                WHEN $this->usesTimestamps() or WHEN there are listeners for the following events:
-                - updating event can do changes so, $this->getDirtyForUpdate() and $this->syncChanges() will call
-                    $this->getDirty(),
-                - updated/saved events can do changes so, $this->syncOriginal() will call $this->getAttributes() */
+                WHEN $this->usesTimestamps() or WHEN there are listeners for updating event because they can do changes
+                so, $this->getDirtyForUpdate() and $this->syncChanges() will call $this->getDirty() which will call
+                getAttributes() */
                 if (!$this->getEventDispatcher()->hasListeners('eloquent.updating: ' . $this::class)) {
                     $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = $dirty;
                     unset($dirty);
@@ -1177,6 +1176,7 @@ public function save(array $options = [])
                 return false;
             } finally {
                 $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = null;
+                $this->tmpOriginalBeforeAfterEvents = null;
             }
         }
 
@@ -1185,20 +1185,24 @@ public function save(array $options = [])
 
         /** Multiple set calls are needed (https://github.com/laravel/framework/discussions/31778) because:
         - $this->performInsert can do changes,
-        - creating event can do changes so, $this->getAttributesForInsert() will call $this->getAttributes(),
-        - created/saved events can do changes so, $this->syncOriginal() will call $this->getAttributes() */
+        - creating event can do changes so,
+        $this->getAttributesForInsert() and $this->syncOriginal() will call $this->getAttributes() */
 
-        $saved = $this->performInsert($query);
+        try {
+            $saved = $this->performInsert($query);
 
-        if (
-            '' === (string)$this->getConnectionName() &&
-            ($connection = $query->getConnection()) instanceof Connection
-        ) {
-            $this->setConnection($connection->getName());
-        }
+            if (
+                '' === (string)$this->getConnectionName() &&
+                ($connection = $query->getConnection()) instanceof Connection
+            ) {
+                $this->setConnection($connection->getName());
+            }
 
-        if ($saved) {
-            $this->finishSave($options + ['touch' => $isDirty]);
+            if ($saved) {
+                $this->finishSave($options + ['touch' => $isDirty]);
+            }
+        } finally {
+            $this->tmpOriginalBeforeAfterEvents = null;
         }
 
         return $saved;
@@ -1225,19 +1229,19 @@ public function saveOrFail(array $options = [])
      */
     protected function finishSave(array $options)
     {
-        if (
-            isset($this->tmpDirtyIfAttributesAreSyncedFromCashedCasts)
-            && $this->getEventDispatcher()->hasListeners('eloquent.saved: ' . $this::class)
-        ) {
-            $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = null;
-        }
-
         $this->fireModelEvent('saved', false);
 
         if ($options['touch'] ?? true) {
             $this->touchOwners();
         }
 
+        if (isset($this->tmpOriginalBeforeAfterEvents)) {
+            $this->original = $this->tmpOriginalBeforeAfterEvents;
+            $this->tmpOriginalBeforeAfterEvents = null;
+
+            return;
+        }
+
         $this->syncOriginal();
     }
 
@@ -1274,12 +1278,8 @@ protected function performUpdate(Builder $query)
 
             $this->syncChanges();
 
-            if (
-                isset($this->tmpDirtyIfAttributesAreSyncedFromCashedCasts)
-                && $this->getEventDispatcher()->hasListeners('eloquent.updated: ' . $this::class)
-            ) {
-                $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = null;
-            }
+            $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = null;
+            $this->tmpOriginalBeforeAfterEvents = $this->attributes;
 
             $this->fireModelEvent('updated', false);
         }
@@ -1374,6 +1374,8 @@ protected function performInsert(Builder $query)
             $query->insert($attributes);
         }
 
+        $this->tmpOriginalBeforeAfterEvents = $this->attributes;
+
         // We will go ahead and set the exists property to true, so that it is set when
         // the created event is fired, just in case the developer tries to update it
         // during the event. This will allow them to do so and run an update here.