add entity check to hasmany

Author: roblankey

src/Examples/JsonApiDotNetCoreExample/Models/Resources/CourseResource.cs

@@ -18,7 +18,7 @@ public class CourseResource : Identifiable
         [Attr("description")]
         public string Description { get; set; }
 
-        [HasOne("department", withEntity: "Department")]
+        [HasOne("department", mappedBy: "Department")]
         public DepartmentResource Department { get; set; }
         public int? DepartmentId { get; set; }
 

src/Examples/JsonApiDotNetCoreExample/Models/Resources/DepartmentResource.cs

@@ -8,7 +8,7 @@ public class DepartmentResource : Identifiable
         [Attr("name")]
         public string Name { get; set; }
 
-        [HasMany("courses")]
+        [HasMany("courses", mappedBy: "Courses")]
         public List<CourseResource> Courses { get; set; }
     }
 }

src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs

@@ -178,11 +178,23 @@ public void DetachRelationshipPointers(TEntity entity)
 
             foreach (var hasManyRelationship in _jsonApiContext.HasManyRelationshipPointers.Get())
             {
-                foreach (var pointer in hasManyRelationship.Value)
+                var hasMany = (HasOneAttribute) hasManyRelationship.Key;
+                if (hasMany.EntityPropertyName != null)
                 {
-                    _context.Entry(pointer).State = EntityState.Detached;
+                    var relatedList = (IList)entity.GetType().GetProperty(hasMany.EntityPropertyName)?.GetValue(entity);
+                    foreach (var related in relatedList)
+                    {
+                        _context.Entry(related).State = EntityState.Detached;
+                    }
                 }
-
+                else
+                {
+                    foreach (var pointer in hasManyRelationship.Value)
+                    {
+                        _context.Entry(pointer).State = EntityState.Detached;
+                    }
+                }
+                
                 // HACK: detaching has many relationships doesn't appear to be sufficient
                 // the navigation property actually needs to be nulled out, otherwise
                 // EF adds duplicate instances to the collection
@@ -202,14 +214,27 @@ private void AttachHasManyPointers(TEntity entity)
                 if (relationship.Key is HasManyThroughAttribute hasManyThrough)
                     AttachHasManyThrough(entity, hasManyThrough, relationship.Value);
                 else
-                    AttachHasMany(relationship.Key as HasManyAttribute, relationship.Value);
+                    AttachHasMany(entity, relationship.Key as HasManyAttribute, relationship.Value);
             }
         }
 
-        private void AttachHasMany(HasManyAttribute relationship, IList pointers)
+        private void AttachHasMany(TEntity entity, HasManyAttribute relationship, IList pointers)
         {
-            foreach (var pointer in pointers)
-                _context.Entry(pointer).State = EntityState.Unchanged;
+            if (relationship.EntityPropertyName != null)
+            {
+                var relatedList = (IList)entity.GetType().GetProperty(relationship.EntityPropertyName)?.GetValue(entity);
+                foreach (var related in relatedList)
+                {
+                    _context.Entry(related).State = EntityState.Unchanged;
+                }
+            }
+            else
+            {
+                foreach (var pointer in pointers)
+                {
+                    _context.Entry(pointer).State = EntityState.Unchanged;
+                }
+            }  
         }
 
         private void AttachHasManyThrough(TEntity entity, HasManyThroughAttribute hasManyThrough, IList pointers)

src/JsonApiDotNetCore/Models/HasManyAttribute.cs

@@ -11,6 +11,7 @@ public class HasManyAttribute : RelationshipAttribute
         /// <param name="publicName">The relationship name as exposed by the API</param>
         /// <param name="documentLinks">Which links are available. Defaults to <see cref="Link.All"/></param>
         /// <param name="canInclude">Whether or not this relationship can be included using the <c>?include=public-name</c> query string</param>
+        /// <param name="mappedBy">The name of the entity mapped property, defaults to null</param>
         /// 
         /// <example>
         /// 
@@ -23,8 +24,8 @@ public class HasManyAttribute : RelationshipAttribute
         /// </code>
         /// 
         /// </example>
-        public HasManyAttribute(string publicName = null, Link documentLinks = Link.All, bool canInclude = true)
-        : base(publicName, documentLinks, canInclude)
+        public HasManyAttribute(string publicName = null, Link documentLinks = Link.All, bool canInclude = true, string mappedBy = null)
+        : base(publicName, documentLinks, canInclude, mappedBy)
         { }
 
         /// <summary>

src/JsonApiDotNetCore/Models/HasManyThroughAttribute.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Reflection;
+using System.Security;
 
 namespace JsonApiDotNetCore.Models
 {
@@ -30,14 +31,15 @@ public class HasManyThroughAttribute : HasManyAttribute
         /// <param name="internalThroughName">The name of the navigation property that will be used to get the HasMany relationship</param>
         /// <param name="documentLinks">Which links are available. Defaults to <see cref="Link.All"/></param>
         /// <param name="canInclude">Whether or not this relationship can be included using the <c>?include=public-name</c> query string</param>
+        /// <param name="mappedBy">The name of the entity mapped property, defaults to null</param>
         /// 
         /// <example>
         /// <code>
         /// [HasManyThrough(nameof(ArticleTags), documentLinks: Link.All, canInclude: true)]
         /// </code>
         /// </example>
-        public HasManyThroughAttribute(string internalThroughName, Link documentLinks = Link.All, bool canInclude = true)
-        : base(null, documentLinks, canInclude)
+        public HasManyThroughAttribute(string internalThroughName, Link documentLinks = Link.All, bool canInclude = true, string mappedBy = null)
+        : base(null, documentLinks, canInclude, mappedBy)
         {
             InternalThroughName = internalThroughName;
         }
@@ -50,14 +52,15 @@ public HasManyThroughAttribute(string internalThroughName, Link documentLinks =
         /// <param name="internalThroughName">The name of the navigation property that will be used to get the HasMany relationship</param>
         /// <param name="documentLinks">Which links are available. Defaults to <see cref="Link.All"/></param>
         /// <param name="canInclude">Whether or not this relationship can be included using the <c>?include=public-name</c> query string</param>
+        /// <param name="mappedBy">The name of the entity mapped property, defaults to null</param>
         /// 
         /// <example>
         /// <code>
         /// [HasManyThrough("tags", nameof(ArticleTags), documentLinks: Link.All, canInclude: true)]
         /// </code>
         /// </example>
-        public HasManyThroughAttribute(string publicName, string internalThroughName, Link documentLinks = Link.All, bool canInclude = true)
-        : base(publicName, documentLinks, canInclude)
+        public HasManyThroughAttribute(string publicName, string internalThroughName, Link documentLinks = Link.All, bool canInclude = true, string mappedBy = null)
+        : base(publicName, documentLinks, canInclude, mappedBy)
         {
             InternalThroughName = internalThroughName;
         }
@@ -161,4 +164,4 @@ public HasManyThroughAttribute(string publicName, string internalThroughName, Li
         /// </example>
         public override string RelationshipPath => $"{InternalThroughName}.{RightProperty.Name}";
     }
-}
+}

src/JsonApiDotNetCore/Models/HasOneAttribute.cs

@@ -13,7 +13,7 @@ public class HasOneAttribute : RelationshipAttribute
         /// <param name="documentLinks">Which links are available. Defaults to <see cref="Link.All"/></param>
         /// <param name="canInclude">Whether or not this relationship can be included using the <c>?include=public-name</c> query string</param>
         /// <param name="withForeignKey">The foreign key property name. Defaults to <c>"{RelationshipName}Id"</c></param>
-        /// <param name="withEntity">If the entity model of this relationship refers to a different type, specify that here</param>
+        /// <param name="mappedBy">The name of the entity mapped property, defaults to null</param>
         /// 
         /// <example>
         /// Using an alternative foreign key:
@@ -28,15 +28,13 @@ public class HasOneAttribute : RelationshipAttribute
         /// </code>
         /// 
         /// </example>
-        public HasOneAttribute(string publicName = null, Link documentLinks = Link.All, bool canInclude = true, string withForeignKey = null, string withEntity = null)
-        : base(publicName, documentLinks, canInclude)
+        public HasOneAttribute(string publicName = null, Link documentLinks = Link.All, bool canInclude = true, string withForeignKey = null, string mappedBy = null)
+        : base(publicName, documentLinks, canInclude, mappedBy)
         {
             _explicitIdentifiablePropertyName = withForeignKey;
-            EntityPropertyName = withEntity;
         }
 
         private readonly string _explicitIdentifiablePropertyName;
-        private readonly string _relatedEntityPropertyName;
 
         /// <summary>
         /// The independent resource identifier.
@@ -45,11 +43,6 @@ public HasOneAttribute(string publicName = null, Link documentLinks = Link.All,
             ? JsonApiOptions.RelatedIdMapper.GetRelatedIdPropertyName(InternalRelationshipName)
             : _explicitIdentifiablePropertyName;
 
-        /// <summary>
-        /// For use in entity / resource separation when the related property is also separated
-        /// </summary>
-        public string EntityPropertyName { get; }
-
         /// <summary>
         /// Sets the value of the property identified by this attribute
         /// </summary>

src/JsonApiDotNetCore/Models/RelationshipAttribute.cs

@@ -6,15 +6,16 @@ namespace JsonApiDotNetCore.Models
 {
     public abstract class RelationshipAttribute : Attribute
     {
-        protected RelationshipAttribute(string publicName, Link documentLinks, bool canInclude)
+        protected RelationshipAttribute(string publicName, Link documentLinks, bool canInclude, string mappedBy)
         {
             PublicRelationshipName = publicName;
             DocumentLinks = documentLinks;
             CanInclude = canInclude;
+            EntityPropertyName = mappedBy;
         }
 
         public string PublicRelationshipName { get; internal set; }
-        public string InternalRelationshipName { get; internal set; }
+        public string InternalRelationshipName { get; internal set; } 
 
         /// <summary>
         /// The related entity type. This does not necessarily match the navigation property type.
@@ -31,6 +32,7 @@ protected RelationshipAttribute(string publicName, Link documentLinks, bool canI
         public bool IsHasOne => GetType() == typeof(HasOneAttribute);
         public Link DocumentLinks { get; } = Link.All;
         public bool CanInclude { get; }
+        public string EntityPropertyName { get; }
 
         public bool TryGetHasOne(out HasOneAttribute result)
         {

test/ResourceEntitySeparationExampleTests/Acceptance/AddTests.cs

@@ -1,7 +1,9 @@
 using JsonApiDotNetCoreExample.Models.Resources;
 using System.Collections.Generic;
+using System.Linq;
 using System.Net;
 using System.Threading.Tasks;
+using Microsoft.AspNetCore.Authorization.Infrastructure;
 using Xunit;
 
 namespace ResourceEntitySeparationExampleTests.Acceptance
@@ -121,6 +123,62 @@ public async Task Can_Create_Department()
             Assert.NotNull(data);
             Assert.Equal(dept.Name, data.Name);
         }
+        
+        [Fact]
+        public async Task Can_Create_Department_With_Courses()
+        {
+            // arrange
+            var route = $"/api/v1/departments/";
+            var dept = _fixture.DepartmentFaker.Generate();
+            
+            var one = _fixture.CourseFaker.Generate();
+            var two = _fixture.CourseFaker.Generate();
+            _fixture.Context.Courses.Add(one);
+            _fixture.Context.Courses.Add(two);
+            _fixture.Context.SaveChanges();
+            
+            var content = new
+            {
+                data = new
+                {
+                    type = "departments",
+                    attributes = new Dictionary<string, string>
+                    {
+                        { "name", dept.Name }
+                    },
+                    relationships = new
+                    {
+                        courses = new
+                        {
+                            data = new[]
+                            {
+                                new
+                                {
+                                    type = "courses",
+                                    id = one.Id
+                                },
+                                new
+                                {
+                                    type = "courses",
+                                    id = two.Id
+                                }
+                            }  
+                        } 
+                    }
+                }
+            };
+
+            // act 
+            var (response, data) = await _fixture.PostAsync<DepartmentResource>(route, content);
+
+            // assert
+            Assert.Equal(HttpStatusCode.Created, response.StatusCode);
+            Assert.NotNull(data);
+            Assert.Equal(dept.Name, data.Name);
+            Assert.NotEmpty(data.Courses);
+            Assert.NotNull(data.Courses.SingleOrDefault(c => c.Id == one.Id));
+            Assert.NotNull(data.Courses.SingleOrDefault(c => c.Id == two.Id));
+        }
 
         [Fact]
         public async Task Can_Create_Student()