feat: ✨ add support for filtering in primary resource with included relationships

Author: erlendellefsen

JsonApiToolkit.Tests/Extensions/IncludeFilterParserTests.cs

@@ -64,7 +64,7 @@ public void SeparateIncludeFilters_WithOnlyMainFilters_ReturnsMainFilters()
     [Fact]
     public void SeparateIncludeFilters_WithSimpleIncludeFilter_SeparatesCorrectly()
     {
-        // Arrange
+        // Arrange - Include filters must have IsIncludeFilter=true (set by parser for bracket syntax)
         var filters = new FilterGroup
         {
             Filters = new List<FilterParameter>
@@ -80,6 +80,7 @@ public void SeparateIncludeFilters_WithSimpleIncludeFilter_SeparatesCorrectly()
                     Field = "comments.status",
                     Operator = FilterOperator.Eq,
                     Value = "approved",
+                    IsIncludeFilter = true, // Bracket syntax: filter[comments][status][eq]=approved
                 },
             },
         };
@@ -103,10 +104,51 @@ public void SeparateIncludeFilters_WithSimpleIncludeFilter_SeparatesCorrectly()
         Assert.Equal("approved", includeFilters[0].FilterGroup.Filters[0].Value);
     }
 
+    [Fact]
+    public void SeparateIncludeFilters_WithDotNotation_TreatedAsPrimaryFilter()
+    {
+        // Arrange - Dot notation filters are primary filters (filter main resource through relationship)
+        var filters = new FilterGroup
+        {
+            Filters = new List<FilterParameter>
+            {
+                new()
+                {
+                    Field = "title",
+                    Operator = FilterOperator.Eq,
+                    Value = "Test",
+                },
+                new()
+                {
+                    Field = "comments.status", // Dot notation without IsIncludeFilter = primary filter
+                    Operator = FilterOperator.Eq,
+                    Value = "approved",
+                    IsIncludeFilter = false,
+                },
+            },
+        };
+        var includePaths = new List<string> { "comments" };
+
+        // Act
+        var (mainFilters, includeFilters) = IncludeFilterParser.SeparateIncludeFilters(
+            filters,
+            includePaths
+        );
+
+        // Assert - Both filters should be main filters (dot notation = primary filter)
+        Assert.NotNull(mainFilters);
+        Assert.Equal(2, mainFilters.Filters.Count);
+        Assert.Contains(mainFilters.Filters, f => f.Field == "title");
+        Assert.Contains(mainFilters.Filters, f => f.Field == "comments.status");
+
+        // No include filters - dot notation is now primary filter
+        Assert.Empty(includeFilters);
+    }
+
     [Fact]
     public void SeparateIncludeFilters_WithKebabCaseInclude_HandlesCorrectly()
     {
-        // Arrange
+        // Arrange - Include filters must have IsIncludeFilter=true
         var filters = new FilterGroup
         {
             Filters = new List<FilterParameter>
@@ -116,6 +158,7 @@ public void SeparateIncludeFilters_WithKebabCaseInclude_HandlesCorrectly()
                     Field = "cveComments.companyCode",
                     Operator = FilterOperator.Eq,
                     Value = "AA",
+                    IsIncludeFilter = true, // Bracket syntax: filter[cveComments][companyCode][eq]=AA
                 },
             },
         };
@@ -137,7 +180,7 @@ public void SeparateIncludeFilters_WithKebabCaseInclude_HandlesCorrectly()
     [Fact]
     public void SeparateIncludeFilters_WithNestedIncludeFilter_SeparatesCorrectly()
     {
-        // Arrange
+        // Arrange - Include filters must have IsIncludeFilter=true
         var filters = new FilterGroup
         {
             Filters = new List<FilterParameter>
@@ -147,6 +190,7 @@ public void SeparateIncludeFilters_WithNestedIncludeFilter_SeparatesCorrectly()
                     Field = "comments.author.department",
                     Operator = FilterOperator.Eq,
                     Value = "Security",
+                    IsIncludeFilter = true, // Bracket syntax for nested: filter[comments.author][department][eq]=Security
                 },
             },
         };
@@ -168,7 +212,7 @@ public void SeparateIncludeFilters_WithNestedIncludeFilter_SeparatesCorrectly()
     [Fact]
     public void SeparateIncludeFilters_WithComplexOrFilter_HandlesCorrectly()
     {
-        // Arrange
+        // Arrange - Include filters must have IsIncludeFilter=true
         var filters = new FilterGroup
         {
             LogicalOperator = LogicalOperator.Or,
@@ -179,12 +223,14 @@ public void SeparateIncludeFilters_WithComplexOrFilter_HandlesCorrectly()
                     Field = "comments.companyCode",
                     Operator = FilterOperator.Eq,
                     Value = "AA",
+                    IsIncludeFilter = true,
                 },
                 new()
                 {
                     Field = "comments.companyCode",
                     Operator = FilterOperator.IsNull,
                     Value = "true",
+                    IsIncludeFilter = true,
                 },
             },
         };
@@ -201,13 +247,16 @@ public void SeparateIncludeFilters_WithComplexOrFilter_HandlesCorrectly()
         Assert.Equal("comments", includeFilters[0].RelationshipPath);
         Assert.Equal(LogicalOperator.Or, includeFilters[0].FilterGroup.LogicalOperator);
         Assert.Equal(2, includeFilters[0].FilterGroup.Filters.Count);
-        Assert.All(includeFilters[0].FilterGroup.Filters, f => Assert.Equal("companyCode", f.Field));
+        Assert.All(
+            includeFilters[0].FilterGroup.Filters,
+            f => Assert.Equal("companyCode", f.Field)
+        );
     }
 
     [Fact]
     public void SeparateIncludeFilters_WithFilterOnNonIncludedRelationship_ReturnsAsMainFilter()
     {
-        // Arrange
+        // Arrange - Even with IsIncludeFilter=true, if relationship is not included, it becomes main filter
         var filters = new FilterGroup
         {
             Filters = new List<FilterParameter>
@@ -217,6 +266,7 @@ public void SeparateIncludeFilters_WithFilterOnNonIncludedRelationship_ReturnsAs
                     Field = "comments.status",
                     Operator = FilterOperator.Eq,
                     Value = "approved",
+                    IsIncludeFilter = true, // Marked as include filter but relationship not in includes
                 },
             },
         };
@@ -229,7 +279,7 @@ public void SeparateIncludeFilters_WithFilterOnNonIncludedRelationship_ReturnsAs
         );
 
         // Assert
-        // When the relationship is not included, the filter should be treated as a main filter with dot notation
+        // When the relationship is not included, the filter should be treated as a main filter
         Assert.NotNull(mainFilters);
         Assert.Single(mainFilters.Filters);
         Assert.Equal("comments.status", mainFilters.Filters[0].Field);
@@ -272,7 +322,7 @@ public void SeparateIncludeFilters_WithTooManyOrConditions_ThrowsException()
     [Fact]
     public void SeparateIncludeFilters_WithTooDeepNesting_ThrowsException()
     {
-        // Arrange
+        // Arrange - Include filters must have IsIncludeFilter=true for depth checking
         var filters = new FilterGroup
         {
             Filters = new List<FilterParameter>
@@ -282,7 +332,8 @@ public void SeparateIncludeFilters_WithTooDeepNesting_ThrowsException()
                     Field = "a.b.c.d.e",
                     Operator = FilterOperator.Eq,
                     Value = "test",
-                }, // 5 levels deep
+                    IsIncludeFilter = true, // 5 levels deep
+                },
             },
         };
         var includePaths = new List<string> { "a.b.c.d" };
@@ -298,7 +349,7 @@ public void SeparateIncludeFilters_WithTooDeepNesting_ThrowsException()
     [Fact]
     public void SeparateIncludeFilters_WithMixedMainAndIncludeFilters_SeparatesCorrectly()
     {
-        // Arrange
+        // Arrange - Include filters must have IsIncludeFilter=true
         var filters = new FilterGroup
         {
             Filters = new List<FilterParameter>
@@ -314,6 +365,7 @@ public void SeparateIncludeFilters_WithMixedMainAndIncludeFilters_SeparatesCorre
                     Field = "comments.approved",
                     Operator = FilterOperator.Eq,
                     Value = "true",
+                    IsIncludeFilter = true, // Bracket syntax: filter[comments][approved][eq]=true
                 },
                 new()
                 {
@@ -346,7 +398,7 @@ public void SeparateIncludeFilters_WithMixedMainAndIncludeFilters_SeparatesCorre
     [Fact]
     public void SeparateIncludeFilters_WithNestedGroups_HandlesCorrectly()
     {
-        // Arrange
+        // Arrange - Include filters must have IsIncludeFilter=true
         var filters = new FilterGroup
         {
             LogicalOperator = LogicalOperator.And,
@@ -371,12 +423,14 @@ public void SeparateIncludeFilters_WithNestedGroups_HandlesCorrectly()
                             Field = "comments.status",
                             Operator = FilterOperator.Eq,
                             Value = "approved",
+                            IsIncludeFilter = true,
                         },
                         new()
                         {
                             Field = "comments.status",
                             Operator = FilterOperator.Eq,
                             Value = "pending",
+                            IsIncludeFilter = true,
                         },
                     },
                 },
@@ -406,7 +460,7 @@ public void SeparateIncludeFilters_WithNestedGroups_HandlesCorrectly()
     [Fact]
     public void SeparateIncludeFilters_WithDeepNestedIncludeFilterUsingLeafName_SeparatesCorrectly()
     {
-        // Arrange - This tests the scenario: include=cve,cve.cvecomments&filter[cvecomments.companyCode][eq]=AA
+        // Arrange - This tests the scenario: include=cve,cve.cvecomments&filter[cvecomments][companyCode][eq]=AA
         var filters = new FilterGroup
         {
             Filters = new List<FilterParameter>
@@ -416,6 +470,7 @@ public void SeparateIncludeFilters_WithDeepNestedIncludeFilterUsingLeafName_Sepa
                     Field = "cvecomments.companyCode",
                     Operator = FilterOperator.Eq,
                     Value = "AA",
+                    IsIncludeFilter = true, // Bracket syntax: filter[cvecomments][companyCode][eq]=AA
                 },
             },
         };
@@ -449,6 +504,7 @@ public void SeparateIncludeFilters_WithDeepNestedIncludeFilterUsingKebabCase_Sep
                     Field = "cveComments.companyCode",
                     Operator = FilterOperator.Eq,
                     Value = "AA",
+                    IsIncludeFilter = true, // Bracket syntax: filter[cveComments][companyCode][eq]=AA
                 },
             },
         };
@@ -482,12 +538,14 @@ public void SeparateIncludeFilters_WithMultipleDeepNestedFilters_SeparatesCorrec
                     Field = "author.name",
                     Operator = FilterOperator.Eq,
                     Value = "John",
+                    IsIncludeFilter = true, // Bracket syntax
                 },
                 new()
                 {
                     Field = "comments.status",
                     Operator = FilterOperator.Eq,
                     Value = "approved",
+                    IsIncludeFilter = true, // Bracket syntax
                 },
             },
         };