diff --git a/test/JsonApiDotNetCoreExampleTests/Acceptance/Spec/DeeplyNestedInclusionTests.cs b/test/JsonApiDotNetCoreExampleTests/Acceptance/Spec/DeeplyNestedInclusionTests.cs index 7af5c3b594..5e4754c7c5 100644 --- a/test/JsonApiDotNetCoreExampleTests/Acceptance/Spec/DeeplyNestedInclusionTests.cs +++ b/test/JsonApiDotNetCoreExampleTests/Acceptance/Spec/DeeplyNestedInclusionTests.cs @@ -1,10 +1,13 @@ +using System.Collections.Generic; using System.Net; using System.Net.Http; using System.Threading.Tasks; using Bogus; +using JsonApiDotNetCore.Models; using JsonApiDotNetCoreExample; using JsonApiDotNetCoreExample.Data; using JsonApiDotNetCoreExample.Models; +using JsonApiDotNetCoreExampleTests.Helpers.Extensions; using Microsoft.AspNetCore.Hosting; using Newtonsoft.Json; using Xunit; @@ -22,6 +25,14 @@ public DeeplyNestedInclusionTests(TestFixture fixture) _fixture = fixture; } + private void ResetContext(AppDbContext context) + { + context.TodoItems.RemoveRange(context.TodoItems); + context.TodoItemCollections.RemoveRange(context.TodoItemCollections); + context.People.RemoveRange(context.People); + context.PersonRoles.RemoveRange(context.PersonRoles); + } + [Fact] public async Task Can_Include_Nested_Relationships() { @@ -53,5 +64,253 @@ public async Task Can_Include_Nested_Relationships() Assert.NotNull(responseTodoItem.Collection); Assert.NotNull(responseTodoItem.Collection.Owner); } + + [Fact] + public async Task Can_Include_Nested_HasMany_Relationships() + { + // arrange + const string route = "/api/v1/todo-items?include=collection.todo-items"; + + var todoItem = new TodoItem { + Collection = new TodoItemCollection { + Owner = new Person(), + TodoItems = new List { + new TodoItem(), + new TodoItem() + } + } + }; + + + var context = _fixture.GetService(); + ResetContext(context); + + context.TodoItems.Add(todoItem); + await context.SaveChangesAsync(); + + // act + var response = await _fixture.Client.GetAsync(route); + + // assert + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + + var body = await response.Content.ReadAsStringAsync(); + var documents = JsonConvert.DeserializeObject(body); + var included = documents.Included; + + Assert.Equal(4, included.Count); + + Assert.Equal(3, included.CountOfType("todo-items")); + Assert.Equal(1, included.CountOfType("todo-collections")); + } + + [Fact] + public async Task Can_Include_Nested_HasMany_Relationships_BelongsTo() + { + // arrange + const string route = "/api/v1/todo-items?include=collection.todo-items.owner"; + + var todoItem = new TodoItem { + Collection = new TodoItemCollection { + Owner = new Person(), + TodoItems = new List { + new TodoItem { + Owner = new Person() + }, + new TodoItem() + } + } + }; + + var context = _fixture.GetService(); + ResetContext(context); + + context.TodoItems.Add(todoItem); + await context.SaveChangesAsync(); + + // act + var response = await _fixture.Client.GetAsync(route); + + // assert + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + + var body = await response.Content.ReadAsStringAsync(); + var documents = JsonConvert.DeserializeObject(body); + var included = documents.Included; + + Assert.Equal(5, included.Count); + + Assert.Equal(3, included.CountOfType("todo-items")); + Assert.Equal(1, included.CountOfType("people")); + Assert.Equal(1, included.CountOfType("todo-collections")); + } + + [Fact] + public async Task Can_Include_Nested_Relationships_With_Multiple_Paths() + { + // arrange + const string route = "/api/v1/todo-items?include=collection.owner.role,collection.todo-items.owner"; + + var todoItem = new TodoItem { + Collection = new TodoItemCollection { + Owner = new Person { + Role = new PersonRole() + }, + TodoItems = new List { + new TodoItem { + Owner = new Person() + }, + new TodoItem() + } + } + }; + + var context = _fixture.GetService(); + ResetContext(context); + + context.TodoItems.Add(todoItem); + await context.SaveChangesAsync(); + + // act + var response = await _fixture.Client.GetAsync(route); + + // assert + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + + var body = await response.Content.ReadAsStringAsync(); + var documents = JsonConvert.DeserializeObject(body); + var included = documents.Included; + + Assert.Equal(7, included.Count); + + Assert.Equal(3, included.CountOfType("todo-items")); + Assert.Equal(2, included.CountOfType("people")); + Assert.Equal(1, included.CountOfType("person-roles")); + Assert.Equal(1, included.CountOfType("todo-collections")); + } + + [Fact] + public async Task Included_Resources_Are_Correct() + { + // arrange + var role = new PersonRole(); + var assignee = new Person { Role = role }; + var collectionOwner = new Person(); + var someOtherOwner = new Person(); + var collection = new TodoItemCollection { Owner = collectionOwner }; + var todoItem1 = new TodoItem { Collection = collection, Assignee = assignee }; + var todoItem2 = new TodoItem { Collection = collection, Assignee = assignee }; + var todoItem3 = new TodoItem { Collection = collection, Owner = someOtherOwner }; + var todoItem4 = new TodoItem { Collection = collection, Owner = assignee }; + + var context = _fixture.GetService(); + ResetContext(context); + + context.TodoItems.Add(todoItem1); + context.TodoItems.Add(todoItem2); + context.TodoItems.Add(todoItem3); + context.TodoItems.Add(todoItem4); + context.PersonRoles.Add(role); + context.People.Add(assignee); + context.People.Add(collectionOwner); + context.People.Add(someOtherOwner); + context.TodoItemCollections.Add(collection); + + + await context.SaveChangesAsync(); + + string route = + "/api/v1/todo-items/" + todoItem1.Id + "?include=" + + "collection.owner," + + "assignee.role," + + "assignee.assigned-todo-items"; + + // act + var response = await _fixture.Client.GetAsync(route); + + // assert + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + + var body = await response.Content.ReadAsStringAsync(); + var documents = JsonConvert.DeserializeObject(body); + var included = documents.Included; + + // 1 collection, 1 owner, + // 1 assignee, 1 assignee role, + // 2 assigned todo items (including the primary resource) + Assert.Equal(6, included.Count); + + var collectionDocument = included.FindResource("todo-collections", collection.Id); + var ownerDocument = included.FindResource("people", collectionOwner.Id); + var assigneeDocument = included.FindResource("people", assignee.Id); + var roleDocument = included.FindResource("person-roles", role.Id); + var assignedTodo1 = included.FindResource("todo-items", todoItem1.Id); + var assignedTodo2 = included.FindResource("todo-items", todoItem2.Id); + + Assert.NotNull(assignedTodo1); + Assert.Equal(todoItem1.Id.ToString(), assignedTodo1.Id); + + Assert.NotNull(assignedTodo2); + Assert.Equal(todoItem2.Id.ToString(), assignedTodo2.Id); + + Assert.NotNull(collectionDocument); + Assert.Equal(collection.Id.ToString(), collectionDocument.Id); + + Assert.NotNull(ownerDocument); + Assert.Equal(collectionOwner.Id.ToString(), ownerDocument.Id); + + Assert.NotNull(assigneeDocument); + Assert.Equal(assignee.Id.ToString(), assigneeDocument.Id); + + Assert.NotNull(roleDocument); + Assert.Equal(role.Id.ToString(), roleDocument.Id); + } + + [Fact] + public async Task Can_Include_Doubly_HasMany_Relationships() + { + // arrange + var person = new Person { + TodoItemCollections = new List { + new TodoItemCollection { + TodoItems = new List { + new TodoItem(), + new TodoItem() + } + }, + new TodoItemCollection { + TodoItems = new List { + new TodoItem(), + new TodoItem(), + new TodoItem() + } + } + } + }; + + var context = _fixture.GetService(); + ResetContext(context); + + context.People.Add(person); + + await context.SaveChangesAsync(); + + string route = "/api/v1/people/" + person.Id + "?include=todo-collections.todo-items"; + + // act + var response = await _fixture.Client.GetAsync(route); + + // assert + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + + var body = await response.Content.ReadAsStringAsync(); + var documents = JsonConvert.DeserializeObject(body); + var included = documents.Included; + + Assert.Equal(7, included.Count); + + Assert.Equal(5, included.CountOfType("todo-items")); + Assert.Equal(2, included.CountOfType("todo-collections")); + } } } \ No newline at end of file diff --git a/test/JsonApiDotNetCoreExampleTests/Helpers/Extensions/DocumentExtensions.cs b/test/JsonApiDotNetCoreExampleTests/Helpers/Extensions/DocumentExtensions.cs new file mode 100644 index 0000000000..f467e17f5b --- /dev/null +++ b/test/JsonApiDotNetCoreExampleTests/Helpers/Extensions/DocumentExtensions.cs @@ -0,0 +1,30 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Reflection; +using JsonApiDotNetCore.Models; +using Microsoft.EntityFrameworkCore.Internal; +using Microsoft.EntityFrameworkCore.Query; +using Microsoft.EntityFrameworkCore.Query.Internal; +using Microsoft.EntityFrameworkCore.Storage; +using Database = Microsoft.EntityFrameworkCore.Storage.Database; + +namespace JsonApiDotNetCoreExampleTests.Helpers.Extensions +{ + public static class DocumentExtensions + { + public static DocumentData FindResource(this List included, string type, TId id) + { + var document = included.Where(documentData => ( + documentData.Type == type + && documentData.Id == id.ToString() + )).FirstOrDefault(); + + return document; + } + + public static int CountOfType(this List included, string type) { + return included.Where(documentData => documentData.Type == type).Count(); + } + } +} \ No newline at end of file diff --git a/test/UnitTests/Serialization/JsonApiDeSerializerTests.cs b/test/UnitTests/Serialization/JsonApiDeSerializerTests.cs index 18d4b0ee6b..bf003bcecf 100644 --- a/test/UnitTests/Serialization/JsonApiDeSerializerTests.cs +++ b/test/UnitTests/Serialization/JsonApiDeSerializerTests.cs @@ -532,17 +532,186 @@ public void Sets_Attribute_Values_On_Included_HasOne_Relationships() Assert.Equal(expectedName, result.Independent.Name); } + + [Fact] + public void Can_Deserialize_Nested_Included_HasMany_Relationships() + { + // arrange + var contextGraphBuilder = new ContextGraphBuilder(); + contextGraphBuilder.AddResource("independents"); + contextGraphBuilder.AddResource("dependents"); + contextGraphBuilder.AddResource("many-to-manys"); + + var deserializer = GetDeserializer(contextGraphBuilder); + + var contentString = + @"{ + ""data"": { + ""type"": ""independents"", + ""id"": ""1"", + ""attributes"": { }, + ""relationships"": { + ""many-to-manys"": { + ""data"": [{ + ""type"": ""many-to-manys"", + ""id"": ""2"" + }, { + ""type"": ""many-to-manys"", + ""id"": ""3"" + }] + } + } + }, + ""included"": [ + { + ""type"": ""many-to-manys"", + ""id"": ""2"", + ""attributes"": {}, + ""relationships"": { + ""dependent"": { + ""data"": { + ""type"": ""dependents"", + ""id"": ""4"" + } + }, + ""independent"": { + ""data"": { + ""type"": ""independents"", + ""id"": ""5"" + } + } + } + }, + { + ""type"": ""many-to-manys"", + ""id"": ""3"", + ""attributes"": {}, + ""relationships"": { + ""dependent"": { + ""data"": { + ""type"": ""dependents"", + ""id"": ""4"" + } + }, + ""independent"": { + ""data"": { + ""type"": ""independents"", + ""id"": ""6"" + } + } + } + }, + { + ""type"": ""dependents"", + ""id"": ""4"", + ""attributes"": {}, + ""relationships"": { + ""many-to-manys"": { + ""data"": [{ + ""type"": ""many-to-manys"", + ""id"": ""2"" + }, { + ""type"": ""many-to-manys"", + ""id"": ""3"" + }] + } + } + } + , + { + ""type"": ""independents"", + ""id"": ""5"", + ""attributes"": {}, + ""relationships"": { + ""many-to-manys"": { + ""data"": [{ + ""type"": ""many-to-manys"", + ""id"": ""2"" + }] + } + } + } + , + { + ""type"": ""independents"", + ""id"": ""6"", + ""attributes"": {}, + ""relationships"": { + ""many-to-manys"": { + ""data"": [{ + ""type"": ""many-to-manys"", + ""id"": ""3"" + }] + } + } + } + ] + }"; + + // act + var result = deserializer.Deserialize(contentString); + + // assert + Assert.NotNull(result); + Assert.Equal(1, result.Id); + Assert.NotNull(result.ManyToManys); + Assert.Equal(2, result.ManyToManys.Count); + + // TODO: not sure if this should be a thing that works? + // could this cause cycles in the graph? + // Assert.NotNull(result.ManyToManys[0].Dependent); + // Assert.NotNull(result.ManyToManys[0].Independent); + // Assert.NotNull(result.ManyToManys[1].Dependent); + // Assert.NotNull(result.ManyToManys[1].Independent); + + // Assert.Equal(result.ManyToManys[0].Dependent, result.ManyToManys[1].Dependent); + // Assert.NotEqual(result.ManyToManys[0].Independent, result.ManyToManys[1].Independent); + } + + private JsonApiDeSerializer GetDeserializer(ContextGraphBuilder contextGraphBuilder) + { + var contextGraph = contextGraphBuilder.Build(); + + var jsonApiContextMock = new Mock(); + jsonApiContextMock.SetupAllProperties(); + jsonApiContextMock.Setup(m => m.ContextGraph).Returns(contextGraph); + jsonApiContextMock.Setup(m => m.AttributesToUpdate).Returns(new Dictionary()); + jsonApiContextMock.Setup(m => m.RelationshipsToUpdate).Returns(new Dictionary()); + jsonApiContextMock.Setup(m => m.HasManyRelationshipPointers).Returns(new HasManyRelationshipPointers()); + jsonApiContextMock.Setup(m => m.HasOneRelationshipPointers).Returns(new HasOneRelationshipPointers()); + + var jsonApiOptions = new JsonApiOptions(); + jsonApiContextMock.Setup(m => m.Options).Returns(jsonApiOptions); + + var deserializer = new JsonApiDeSerializer(jsonApiContextMock.Object); + + return deserializer; + } + + private class ManyToManyNested : Identifiable + { + [Attr("name")] public string Name { get; set; } + [HasOne("dependent")] public OneToManyDependent Dependent { get; set; } + public int DependentId { get; set; } + [HasOne("independent")] public OneToManyIndependent Independent { get; set; } + public int InependentId { get; set; } + } + private class OneToManyDependent : Identifiable { [Attr("name")] public string Name { get; set; } [HasOne("independent")] public OneToManyIndependent Independent { get; set; } public int IndependentId { get; set; } + + [HasMany("many-to-manys")] public List ManyToManys { get; set; } } private class OneToManyIndependent : Identifiable { [Attr("name")] public string Name { get; set; } [HasMany("dependents")] public List Dependents { get; set; } + + [HasMany("many-to-manys")] public List ManyToManys { get; set; } } } }