Merge pull request #458 from milosloub/feat/#406

Feat(#406): Allow filter[id] and filter[related.id]

Author: milosloub

src/JsonApiDotNetCore/Builders/ContextGraphBuilder.cs

@@ -139,6 +139,18 @@ protected virtual List<AttrAttribute> GetAttributes(Type entityType)
 
             foreach (var prop in properties)
             {
+                if (prop.Name == nameof(Identifiable.Id))
+                {
+                    var idAttr = new AttrAttribute()
+                    {
+                        PublicAttributeName = JsonApiOptions.ResourceNameFormatter.FormatPropertyName(prop),
+                        PropertyInfo = prop,
+                        InternalAttributeName = prop.Name
+                    };
+                    attributes.Add(idAttr);
+                    continue;
+                }
+
                 var attribute = (AttrAttribute)prop.GetCustomAttribute(typeof(AttrAttribute));
                 if (attribute == null)
                     continue;

src/JsonApiDotNetCore/Builders/DocumentBuilder.cs

@@ -141,6 +141,7 @@ public ResourceObject GetData(ContextEntity contextEntity, IIdentifiable entity,
         private bool ShouldIncludeAttribute(AttrAttribute attr, object attributeValue)
         {
             return OmitNullValuedAttribute(attr, attributeValue) == false
+                    && attr.InternalAttributeName != nameof(Identifiable.Id)
                    && ((_jsonApiContext.QuerySet == null
                        || _jsonApiContext.QuerySet.Fields.Count == 0)
                        || _jsonApiContext.QuerySet.Fields.Contains(attr.InternalAttributeName));
@@ -280,10 +281,13 @@ private ResourceObject GetIncludedEntity(IIdentifiable entity)
 
             data.Attributes = new Dictionary<string, object>();
 
-            contextEntity.Attributes.ForEach(attr =>
+            foreach(var attr in contextEntity.Attributes)
             {
+                if (attr.InternalAttributeName == nameof(Identifiable.Id))
+                    continue;
+
                 data.Attributes.Add(attr.PublicAttributeName, attr.GetValue(entity));
-            });
+            }
 
             return data;
         }

test/JsonApiDotNetCoreExampleTests/Acceptance/TodoItemsControllerTests.cs

@@ -69,6 +69,54 @@ public async Task Can_Get_TodoItems()
             Assert.True(deserializedBody.Count <= expectedEntitiesPerPage);
         }
 
+        [Fact]
+        public async Task Can_Filter_By_Resource_Id()
+        {
+            // Arrange
+            var todoItem = _todoItemFaker.Generate();
+            _context.TodoItems.Add(todoItem);
+            _context.SaveChanges();
+
+            var httpMethod = new HttpMethod("GET");
+            var route = $"/api/v1/todo-items?filter[id]={todoItem.Id}";
+            var request = new HttpRequestMessage(httpMethod, route);
+
+            // Act
+            var response = await _fixture.Client.SendAsync(request);
+            var body = await response.Content.ReadAsStringAsync();
+            var deserializedBody = _fixture.GetService<IJsonApiDeSerializer>().DeserializeList<TodoItem>(body);
+
+            // Assert
+            Assert.Equal(HttpStatusCode.OK, response.StatusCode);
+            Assert.NotEmpty(deserializedBody);
+            Assert.Contains(deserializedBody, (i) => i.Id == todoItem.Id);
+        }
+
+        [Fact]
+        public async Task Can_Filter_By_Relationship_Id()
+        {
+            // Arrange
+            var person = new Person();           
+            var todoItem = _todoItemFaker.Generate();
+            todoItem.Owner = person;
+            _context.TodoItems.Add(todoItem);
+            _context.SaveChanges();
+
+            var httpMethod = new HttpMethod("GET");
+            var route = $"/api/v1/todo-items?filter[owner.id]={person.Id}";
+            var request = new HttpRequestMessage(httpMethod, route);
+
+            // Act
+            var response = await _fixture.Client.SendAsync(request);
+            var body = await response.Content.ReadAsStringAsync();
+            var deserializedBody = _fixture.GetService<IJsonApiDeSerializer>().DeserializeList<TodoItem>(body);
+
+            // Assert
+            Assert.Equal(HttpStatusCode.OK, response.StatusCode);
+            Assert.NotEmpty(deserializedBody);
+            Assert.Contains(deserializedBody, (i) => i.OwnerId == person.Id);
+        }
+
         [Fact]
         public async Task Can_Filter_TodoItems()
         {

test/UnitTests/Builders/ContextGraphBuilder_Tests.cs

@@ -94,7 +94,7 @@ public void Attrs_Without_Names_Specified_Will_Use_Default_Formatter()
 
             // assert
             var resource = graph.GetContextEntity(typeof(TestResource));
-            Assert.Equal("compound-attribute", resource.Attributes.Single().PublicAttributeName);
+            Assert.Contains(resource.Attributes, (i) => i.PublicAttributeName == "compound-attribute");
         }
 
         [Fact]
@@ -110,7 +110,7 @@ public void Attrs_Without_Names_Specified_Will_Use_Configured_Formatter()
 
             // assert
             var resource = graph.GetContextEntity(typeof(TestResource));
-            Assert.Equal("compoundAttribute", resource.Attributes.Single().PublicAttributeName);
+            Assert.Contains(resource.Attributes, (i) => i.PublicAttributeName == "compoundAttribute");
         }
 
         [Fact]