Fix SystemProperties serialization to ignore null values (#380)

* Fix SystemProperties serialization to ignore null values

* Remove extra test methods

* chore: bump version to 8.4.2

---------

Co-authored-by: ethan-ozelius-contentful <ethan.ozelius@contentful.com>

Author: rubydog

CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version [8.4.2]
+- Remove extra test methods
+- Fix SystemProperties serialization to ignore null values
+
 ## Version [8.4.1]
 
 - Add version header to UpdateRole method to fix ContentfulException

Contentful.AspNetCore/Contentful.AspNetCore.csproj

@@ -3,7 +3,7 @@
     <Description>Official .NET SDK for the Contentful Content Delivery and Management API for ASP.NET core.</Description>
     <PackageId>contentful.aspnetcore</PackageId>
     <NeutralLanguage>en-US</NeutralLanguage>
-    <VersionPrefix>8.4.1</VersionPrefix>
+    <VersionPrefix>8.4.2</VersionPrefix>
     <TargetFramework>netstandard2.0</TargetFramework>
     <Authors>Contentful</Authors>
     <Copyright>Contentful GmbH.</Copyright>
@@ -13,10 +13,10 @@
     <PackageProjectUrl>https://github.com/contentful/contentful.net</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <RepositoryType>git</RepositoryType>
-    <Version>8.4.1</Version>
-    <AssemblyVersion>8.4.1.0</AssemblyVersion>
+    <Version>8.4.2</Version>
+    <AssemblyVersion>8.4.2.0</AssemblyVersion>
     <RepositoryUrl>https://github.com/contentful/contentful.net</RepositoryUrl>
-    <FileVersion>8.4.1.0</FileVersion>
+    <FileVersion>8.4.2.0</FileVersion>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
     <DocumentationFile>bin\Release\netstandard1.5\Contentful.AspNetCore.xml</DocumentationFile>
@@ -25,7 +25,7 @@
     <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="contentful.csharp" Version="8.4.1" />
+    <PackageReference Include="contentful.csharp" Version="8.4.2" />
     <PackageReference Include="Microsoft.AspNetCore.Http" Version="2.2.2" />
     <PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.AspNetCore.Mvc.Razor" Version="2.2.0" />

Contentful.Core.Tests/Extensions/JsonConversionExtensionsTests.cs

@@ -1,4 +1,5 @@
 using Contentful.Core.Extensions;
+using Contentful.Core.Models;
 using Newtonsoft.Json.Linq;
 using System;
 using System.Collections.Generic;
@@ -134,6 +135,34 @@ public void JsonConversionExtensionsConvertsEmargoedAssetBodyCorrectly()
 
         }
 
+        [Fact]
+        public void SystemPropertiesSerializationIgnoresNullValues()
+        {
+            // Arrange
+            var systemProperties = new SystemProperties
+            {
+                Id = "test-asset-id",
+                Type = "Link",
+                LinkType = "Asset"
+                // All other properties are null and should be ignored
+            };
+
+            // Act
+            var convertedString = systemProperties.ConvertObjectToJsonString();
+
+            // Assert
+            Assert.Contains("\"id\":\"test-asset-id\"", convertedString);
+            Assert.Contains("\"type\":\"Link\"", convertedString);
+            Assert.Contains("\"linkType\":\"Asset\"", convertedString);
+            // Should not contain any null values
+            Assert.DoesNotContain("\"archivedAt\":null", convertedString);
+            Assert.DoesNotContain("\"createdAt\":null", convertedString);
+            Assert.DoesNotContain("\"updatedAt\":null", convertedString);
+            Assert.DoesNotContain("\"revision\":null", convertedString);
+        }
+
+
+
         [Theory]
         [InlineData(null, null)]
         [InlineData(13, 13)]

Contentful.Core/Contentful.Core.csproj

@@ -4,7 +4,7 @@
     <PackageId>contentful.csharp</PackageId>
     <AssemblyTitle>contentful.net</AssemblyTitle>
     <NeutralLanguage>en-US</NeutralLanguage>
-    <VersionPrefix>8.4.1</VersionPrefix>
+    <VersionPrefix>8.4.2</VersionPrefix>
     <TargetFramework>netstandard2.0</TargetFramework>
     <Authors>Contentful</Authors>
     <Copyright>Contentful GmbH.</Copyright>

Contentful.Core/Models/BaseSystemProperties.cs

@@ -1,8 +1,9 @@
-using System;
-using Contentful.Core.Models.Management;
-
-namespace Contentful.Core.Models;
-
+using System;
+using Contentful.Core.Models.Management;
+using Newtonsoft.Json;
+
+namespace Contentful.Core.Models;
+
 public class BaseSystemProperties
 {
     /// <summary>
@@ -13,6 +14,7 @@ public class BaseSystemProperties
     /// <summary>
     /// The type of link. Will be null for non link types.
     /// </summary>
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
     public string LinkType { get; set; }
 
     /// <summary>
@@ -23,35 +25,42 @@ public class BaseSystemProperties
     /// <summary>
     /// The link to the environment of the resource.
     /// </summary>
-    public ContentfulEnvironment Environment { get; set; }
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
+    public ContentfulEnvironment Environment { get; set; }
 
     /// <summary>
     /// The link to the space of the resource.
     /// </summary>
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
     public Space Space { get; set; }
 
     /// <summary>
     /// The date and time the resource was created. Will be null when not applicable, e.g. for arrays.
     /// </summary>
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
     public DateTime? CreatedAt { get; set; }
 
     /// <summary>
     /// The link to the user that created this content. Will only be present for management API call.
     /// </summary>
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
     public User CreatedBy { get; set; }
 
     /// <summary>
     /// The date and time the resource was last updated. Will be null when not applicable or when the resource has never been updated.
     /// </summary>
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
     public DateTime? UpdatedAt { get; set; }
 
     /// <summary>
     /// The link to the user that last updated this content. Will only be present for management API call.
     /// </summary>
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
     public User UpdatedBy { get; set; }
 
     /// <summary>
     /// The current version of the resource. Will only be present for management API calls. 
     /// </summary>
+    [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
     public int? Version { get; set; }
 }

Contentful.Core/Models/SystemProperties.cs

@@ -1,4 +1,5 @@
 using Contentful.Core.Models.Management;
+using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -14,81 +15,97 @@ public class SystemProperties : BaseSystemProperties
         /// <summary>
         /// The published version of the resource. Will be null for non-versioned types.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public int? Revision { get; set; }
 
         /// <summary>
         /// The date and time the resource was deleted. This field will only be present for <seealso cref="SyncResult"/> deleted items.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public DateTime? DeletedAt { get; set; }
 
         /// <summary>
         /// The locale of the resource. Will only have a value for <seealso cref="Asset"/> and <seealso cref="Entry{T}"/> resource types.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public string Locale { get; set; }
 
         /// <summary>
         /// The <seealso cref="ContentType"/> of the resource. Only applicable for <seealso cref="Entry{T}"/> resource types.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public ContentType ContentType { get; set; }
 
         /// <summary>
         /// The number of times the resource has been published.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public int? PublishedCounter { get; set; }
 
         /// <summary>
         /// The published version of the resource. Will only be present for management API calls.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public int? PublishedVersion { get; set; }
 
         /// <summary>
         /// The user that published the resource. Will only be present for management API calls.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public User PublishedBy { get; set; }
 
         /// <summary>
         /// When the resource was last published. Will only be present for management API calls.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public DateTime? PublishedAt { get; set; }
 
         /// <summary>
         /// The number of times the resource has been published. Will only be present for management API calls.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public int? PublishCounter { get; set; }
 
         /// <summary>
         /// When the resource was first published. Will only be present for management API calls.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public DateTime? FirstPublishedAt { get; set; }
 
         /// <summary>
         /// The date and time the resource was archived. Will only be present for management API calls.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public DateTime? ArchivedAt { get; set; }
 
         /// <summary>
         /// The version that is currently archived. Will only be present for management API calls.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public int? ArchivedVersion { get; set; }
 
         /// <summary>
         /// The link to the user that last archived this content. Will only be present for management API call.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public User ArchivedBy { get; set; }
 
         /// <summary>
         /// The organization the resource links to. Will only be present for certain management API calls.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public Organization Organization { get; set; }
 
         /// <summary>
         /// The usage period the resource links to. Will only be present for certain management API calls.
         /// </summary>
-        public UsagePeriod UsagePeriod { get; set; }
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
+        public UsagePeriod UsagePeriod { get; set; }
 
         /// <summary>
         /// The link to the status that the current object had. Used only for resources that have a status.
         /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public Status Status { get; set; }
     }
 }