feat: mark obsolete UpdateAsync(TId id, TEntity entity) method, add new one without id parameter

Author: maurei

src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs

@@ -238,14 +238,16 @@ public void DetachRelationshipPointers(TEntity entity)
             }
         }
 
-        /// <inheritdoc />
+        [Obsolete("Use overload UpdateAsync(TEntity updatedEntity): providing parameter ID does no longer add anything relevant")]
         public virtual async Task<TEntity> UpdateAsync(TId id, TEntity updatedEntity)
         {
-            /// WHY is parameter "entity" even passed along to this method??
-            /// It does nothing!
-
-            var oldEntity = await GetAsync(id);
+            return await UpdateAsync(updatedEntity);
+        }
 
+        /// <inheritdoc />
+        public virtual async Task<TEntity> UpdateAsync(TEntity updatedEntity)
+        {
+            var oldEntity = await GetAsync(updatedEntity.Id);
             if (oldEntity == null)
                 return null;
 
@@ -259,6 +261,7 @@ public virtual async Task<TEntity> UpdateAsync(TId id, TEntity updatedEntity)
                 LoadInverseRelationships(trackedRelationshipValue, relationshipAttr);
                 AssignRelationshipValue(oldEntity, trackedRelationshipValue, relationshipAttr);
             }
+
             await _context.SaveChangesAsync();
             return oldEntity;
         }

src/JsonApiDotNetCore/Data/IEntityWriteRepository.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using JsonApiDotNetCore.Models;
@@ -14,6 +15,9 @@ public interface IEntityWriteRepository<TEntity, in TId>
     {
         Task<TEntity> CreateAsync(TEntity entity);
 
+        Task<TEntity> UpdateAsync(TEntity entity);
+
+        [Obsolete("Use overload UpdateAsync(TEntity updatedEntity): providing parameter ID does no longer add anything relevant")]
         Task<TEntity> UpdateAsync(TId id, TEntity entity);
 
         Task UpdateRelationshipsAsync(object parent, RelationshipAttribute relationship, IEnumerable<string> relationshipIds);

src/JsonApiDotNetCore/Services/EntityResourceService.cs

@@ -154,9 +154,7 @@ public virtual async Task<TResource> UpdateAsync(TId id, TResource resource)
         {
             var entity = MapIn(resource);
 
-
-
-            entity = await _entities.UpdateAsync(id, entity);
+            entity = await _entities.UpdateAsync(entity);
 
             return MapOut(entity);
         }

test/UnitTests/Data/DefaultEntityRepository_Tests.cs

@@ -60,14 +60,14 @@ public async Task UpdateAsync_Updates_Attributes_In_AttributesToUpdate()
             {
                 {
                     descAttr,
-                    todoItemUpdates.Description
+                    null //todoItemUpdates.Description
                 }
             };
 
             var repository = GetRepository();
 
             // act
-            var updatedItem = await repository.UpdateAsync(_todoItem.Id, todoItemUpdates);
+            var updatedItem = await repository.UpdateAsync(todoItemUpdates);
 
             // assert
             Assert.NotNull(updatedItem);