fix: 🚑️ [JsonIgnore] not being respected

Author: erlendellefsen

JsonApiToolkit.Tests/Mapping/EntityMapperTests.cs

@@ -1,3 +1,4 @@
+using System.Text.Json.Serialization;
 using JsonApiToolkit.Mapping;
 using JsonApiToolkit.Tests.Models;
 
@@ -63,4 +64,46 @@ public void GetIdProperty_IdentifiesPrimaryId()
         Assert.NotNull(idProperty);
         Assert.Equal("Id", idProperty.Name);
     }
+
+    [Fact]
+    public void GetAttributeProperties_ExcludesJsonIgnoreProperties()
+    {
+        var attributeProperties = EntityMapper.GetAttributeProperties(typeof(EntityWithJsonIgnore));
+        var propertyNames = attributeProperties.Select(p => p.Name).ToList();
+
+        Assert.Contains("VisibleProperty", propertyNames);
+        Assert.DoesNotContain("HiddenProperty", propertyNames);
+    }
+
+    [Fact]
+    public void GetRelationshipProperties_ExcludesJsonIgnoreProperties()
+    {
+        var relationshipProperties = EntityMapper.GetRelationshipProperties(
+            typeof(EntityWithJsonIgnore)
+        );
+        var propertyNames = relationshipProperties.Select(p => p.Name).ToList();
+
+        Assert.Contains("VisibleRelation", propertyNames);
+        Assert.DoesNotContain("HiddenRelation", propertyNames);
+    }
+
+    private class EntityWithJsonIgnore
+    {
+        public int Id { get; set; }
+        public string VisibleProperty { get; set; } = string.Empty;
+
+        [JsonIgnore]
+        public string HiddenProperty { get; set; } = string.Empty;
+
+        public RelatedEntityForIgnoreTest? VisibleRelation { get; set; }
+
+        [JsonIgnore]
+        public RelatedEntityForIgnoreTest? HiddenRelation { get; set; }
+    }
+
+    private class RelatedEntityForIgnoreTest
+    {
+        public int Id { get; set; }
+        public string Name { get; set; } = string.Empty;
+    }
 }

JsonApiToolkit.Tests/Mapping/JsonApiMapperTests.cs

@@ -1,3 +1,4 @@
+using System.Text.Json.Serialization;
 using JsonApiToolkit.Mapping;
 using JsonApiToolkit.Models.Documents;
 using JsonApiToolkit.Models.Metadata;
@@ -177,4 +178,36 @@ public void ToCollectionDocument_WithPagination_IncludesCorrectLinks()
         Assert.NotNull(document.Meta);
         Assert.True(document.Meta.ContainsKey("pagination"));
     }
+
+    [Fact]
+    public void ToResourceObject_ExcludesJsonIgnoreProperties()
+    {
+        var entity = new EntityWithIgnoredProperties
+        {
+            Id = 1,
+            VisibleName = "Visible",
+            SecretPassword = "should-not-appear",
+            InternalData = "should-not-appear-either",
+        };
+
+        var resourceObject = JsonApiMapper.ToResourceObject(entity, "entities");
+
+        Assert.NotNull(resourceObject.Attributes);
+        Assert.True(resourceObject.Attributes.ContainsKey("visibleName"));
+        Assert.Equal("Visible", resourceObject.Attributes["visibleName"]);
+        Assert.False(resourceObject.Attributes.ContainsKey("secretPassword"));
+        Assert.False(resourceObject.Attributes.ContainsKey("internalData"));
+    }
+
+    private class EntityWithIgnoredProperties
+    {
+        public int Id { get; set; }
+        public string VisibleName { get; set; } = string.Empty;
+
+        [JsonIgnore]
+        public string SecretPassword { get; set; } = string.Empty;
+
+        [JsonIgnore]
+        public string InternalData { get; set; } = string.Empty;
+    }
 }

JsonApiToolkit/Mapping/EntityMapper.cs

@@ -1,6 +1,7 @@
 using System.Collections;
 using System.Collections.Concurrent;
 using System.Reflection;
+using System.Text.Json.Serialization;
 using JsonApiToolkit.Extensions;
 
 namespace JsonApiToolkit.Mapping;
@@ -58,6 +59,7 @@ public static List<PropertyInfo> GetAttributeProperties(Type type)
                         && !relationshipNames.Contains(p.Name) // Exclude properties identified as relationships
                         && p.CanRead
                         && p.GetMethod?.IsPublic == true
+                        && !HasJsonIgnoreAttribute(p) // Exclude properties marked with [JsonIgnore]
                     )
                     .ToList();
             }
@@ -79,6 +81,7 @@ public static List<PropertyInfo> GetRelationshipProperties(Type type)
                     .Where(p =>
                         p.CanRead
                         && p.GetMethod?.IsPublic == true
+                        && !HasJsonIgnoreAttribute(p) // Exclude properties marked with [JsonIgnore]
                         && (
                             (
                                 typeof(IEnumerable).IsAssignableFrom(p.PropertyType)
@@ -125,6 +128,14 @@ private static bool HasIdProperty(Type? type)
         return GetIdProperty(type) != null;
     }
 
+    /// <summary>
+    /// Checks if a property has the JsonIgnore attribute.
+    /// </summary>
+    private static bool HasJsonIgnoreAttribute(PropertyInfo property)
+    {
+        return property.GetCustomAttribute<JsonIgnoreAttribute>() != null;
+    }
+
     /// <summary>
     /// Gets the element type of a collection.
     /// </summary>