fix: refresh updated entity using the base methods to avoid user-defined constraints

Author: alexzarbn

src/Concerns/HandlesRelationStandardBatchOperations.php

@@ -219,11 +219,8 @@ protected function batchUpdateWithTransaction(Request $request, $parentKey)
                 Arr::get($resource, 'pivot', [])
             );
 
-            $entityQuery = $this->buildUpdateFetchQuery(
-                $request, $parentEntity, $requestedRelations
-            );
-            $entity = $this->runUpdateFetchQuery(
-                $request, $entityQuery, $parentEntity, $entity->{$this->keyName()}
+            $entity = $this->refreshUpdatedEntity(
+                $request, $parentEntity,$requestedRelations, $entity->{$this->keyName()}
             );
 
             $entity = $this->cleanupEntity($entity);

src/Concerns/HandlesRelationStandardOperations.php

@@ -162,7 +162,7 @@ protected function buildIndexFetchQuery(Request $request, Model $parentEntity, a
     }
 
     /**
-     * Builds Eloquent query for fetching relation entity.
+     * Wrapper function to build Eloquent query for fetching relation entity.
      *
      * @param Request $request
      * @param Model $parentEntity
@@ -174,7 +174,29 @@ protected function buildRelationFetchQuery(
         Model $parentEntity,
         array $requestedRelations
     ): Relation {
-        return $this->relationQueryBuilder->buildQuery($this->newRelationQuery($parentEntity), $request);
+        return $this->buildRelationFetchQueryBase(
+            $request,
+            $parentEntity,
+            $requestedRelations
+        );
+    }
+
+    /**
+     * Builds Eloquent query for fetching relation entity.
+     *
+     * @param Request $request
+     * @param Model $parentEntity
+     * @param array $requestedRelations
+     * @return Relation
+     */
+    protected function buildRelationFetchQueryBase(
+        Request $request,
+        Model $parentEntity,
+        array $requestedRelations
+    ): Relation {
+        return $this->relationQueryBuilder->buildQuery(
+            $this->newRelationQuery($parentEntity), $request
+        );
     }
 
     /**
@@ -292,7 +314,10 @@ protected function storeWithTransaction(Request $request, $parentKey)
         $query = $this->buildStoreFetchQuery($request, $parentEntity, $requestedRelations);
 
         $entity = $this->runStoreFetchQuery(
-            $request, $query, $parentEntity, $entity->{$this->keyName()}
+            $request,
+            $query,
+            $parentEntity,
+            $entity->{$this->keyName()}
         );
         $entity->wasRecentlyCreated = true;
 
@@ -554,7 +579,7 @@ protected function runShowFetchQuery(Request $request, Relation $query, Model $p
     }
 
     /**
-     * Runs the given query for fetching relation entity.
+     * Wrapper function to run the given query for fetching relation entity.
      *
      * @param Request $request
      * @param Relation $query
@@ -564,6 +589,29 @@ protected function runShowFetchQuery(Request $request, Relation $query, Model $p
      */
     protected function runRelationFetchQuery(Request $request, Relation $query, Model $parentEntity, $relatedKey): Model
     {
+        return $this->runRelationFetchQueryBase(
+            $request,
+            $query,
+            $parentEntity,
+            $relatedKey
+        );
+    }
+
+    /**
+     * Runs the given query for fetching relation entity.
+     *
+     * @param Request $request
+     * @param Relation $query
+     * @param Model $parentEntity
+     * @param string|int $relatedKey
+     * @return Model
+     */
+    protected function runRelationFetchQueryBase(
+        Request $request,
+        Relation $query,
+        Model $parentEntity,
+        $relatedKey
+    ): Model {
         if ($this->isOneToOneRelation($parentEntity)) {
             return $query->firstOrFail();
         }
@@ -671,7 +719,9 @@ protected function updateWithTransaction(Request $request, $parentKey, $relatedK
             $request->get('pivot', [])
         );
 
-        $entity = $this->runUpdateFetchQuery($request, $query, $parentEntity, $relatedKey);
+        $entity = $this->refreshUpdatedEntity(
+            $request, $parentEntity, $requestedRelations,  $relatedKey
+        );
         $entity = $this->cleanupEntity($entity);
 
         if (count($this->getPivotJson())) {
@@ -745,6 +795,35 @@ protected function runUpdateFetchQuery(Request $request, Relation $query, Model
         return $this->runRelationFetchQuery($request, $query, $parentEntity, $relatedKey);
     }
 
+    /**
+     * Fetches the relation model that has just been updated using the given key.
+     *
+     * @param Request $request
+     * @param Model $parentEntity
+     * @param array $requestedRelations
+     * @param string|int $relatedKey
+     * @return Model
+     */
+    protected function refreshUpdatedEntity(
+        Request $request,
+        Model $parentEntity,
+        array $requestedRelations,
+        $relatedKey
+    ): Model {
+        $query = $this->buildRelationFetchQueryBase(
+            $request,
+            $parentEntity,
+            $requestedRelations
+        );
+
+        return $this->runRelationFetchQueryBase(
+            $request,
+            $query,
+            $parentEntity,
+            $relatedKey
+        );
+    }
+
     /**
      * The hook is executed before updating a relation resource.
      *

src/Concerns/HandlesStandardBatchOperations.php

@@ -163,8 +163,9 @@ protected function batchUpdateWithTransaction(Request $request)
 
             $this->beforeUpdateFresh($request, $entity);
 
-            $entityQuery = $this->buildUpdateFetchQuery($request, $requestedRelations);
-            $entity = $this->runUpdateFetchQuery($request, $entityQuery, $entity->{$this->keyName()});
+            $entity = $this->refreshUpdatedEntity(
+                $request, $requestedRelations, $entity->{$this->keyName()}
+            );
 
             $this->afterSave($request, $entity);
             $this->afterUpdate($request, $entity);

src/Concerns/HandlesStandardOperations.php

@@ -73,13 +73,25 @@ protected function buildIndexFetchQuery(Request $request, array $requestedRelati
     }
 
     /**
-     * Builds Eloquent query for fetching entity(-ies).
+     * Wrapper function to build Eloquent query for fetching entity(-ies).
      *
      * @param Request $request
      * @param array $requestedRelations
      * @return Builder
      */
     protected function buildFetchQuery(Request $request, array $requestedRelations): Builder
+    {
+        return $this->buildFetchQueryBase($request, $requestedRelations);
+    }
+
+    /**
+     * Builds Eloquent query for fetching entity(-ies).
+     *
+     * @param Request $request
+     * @param array $requestedRelations
+     * @return Builder
+     */
+    protected function buildFetchQueryBase(Request $request, array $requestedRelations): Builder
     {
         return $this->queryBuilder->buildQuery($this->newModelQuery(), $request);
     }
@@ -386,14 +398,27 @@ protected function runShowFetchQuery(Request $request, Builder $query, $key): Mo
     }
 
     /**
-     * Runs the given query for fetching entity.
+     * Wrapper function to run the given query for fetching entity.
      *
      * @param Request $request
      * @param Builder $query
      * @param int|string $key
      * @return Model
      */
     protected function runFetchQuery(Request $request, Builder $query, $key): Model
+    {
+        return $this->runFetchQueryBase($request, $query, $key);
+    }
+
+    /**
+     * Runs the given query for fetching entity.
+     *
+     * @param Request $request
+     * @param Builder $query
+     * @param int|string $key
+     * @return Model
+     */
+    protected function runFetchQueryBase(Request $request, Builder $query, $key): Model
     {
         return $query->where($this->resolveQualifiedKeyName(), $key)->firstOrFail();
     }
@@ -470,7 +495,7 @@ protected function updateWithTransaction(Request $request, $key)
             return $beforeUpdateFreshResult;
         }
 
-        $entity = $this->runUpdateFetchQuery($request, $query, $key);
+        $entity = $this->refreshUpdatedEntity($request, $requestedRelations,$key);
 
         $afterSaveHookResult = $this->afterSave($request, $entity);
         if ($this->hookResponds($afterSaveHookResult)) {
@@ -512,6 +537,21 @@ protected function runUpdateFetchQuery(Request $request, Builder $query, $key):
         return $this->runFetchQuery($request, $query, $key);
     }
 
+    /**
+     * Fetches the model that has just been updated using the given key.
+     *
+     * @param Request $request
+     * @param array $requestedRelations
+     * @param int|string $key
+     * @return Model
+     */
+    protected function refreshUpdatedEntity(Request $request, array $requestedRelations, $key): Model
+    {
+        $query = $this->buildFetchQueryBase($request, $requestedRelations);
+
+        return $this->runFetchQueryBase($request, $query, $key);
+    }
+
     /**
      * The hook is executed before updating a resource.
      *