Merge branch 'release/2.2.1'

Author: lindyhopchris

CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [2.2.1] - 2023-01-23
+
+### Fixed
+
+- [laravel#223](https://github.com/laravel-json-api/laravel/issues/223) Ensure a model always has fresh data from the
+  database after a write operation, to prevent stale data on cached relationships.
+
 ## [2.2.0] - 2022-12-22
 
 ### Added

src/Hydrators/ModelHydrator.php

@@ -91,6 +91,28 @@ public function store(array $validatedData): object
     {
         $model = $this->hydrate($validatedData);
 
+        /**
+         * Always refresh the model from the database.
+         *
+         * Due to the way Eloquent models cache relationships, it is
+         * possible that a relationship on the model holds stale data.
+         * E.g. if the relationship has been accessed on the model before
+         * hydration was executed above, there is a possibility that some
+         * data might be stale.
+         *
+         * We therefore always need to ensure we have the latest data from
+         * the database, and a refresh is the only way to achieve that at
+         * this point.
+         *
+         * This effectively means we are following more of a CQRS pattern.
+         * I.e. we've done the "write" (command), now we're doing a query
+         * so we need fresh data for that to achieve responsibility separation.
+         * We'll move to a CQRS pattern in a future version of the package.
+         *
+         * @see https://github.com/laravel-json-api/laravel/issues/223
+         */
+        $model->refresh();
+
         /**
          * Always do eager loading, as we may have default eager
          * load paths.