Fix Serialization always results in a Success object. (#166)

Co-authored-by: Steve Smith <[email protected]>
ardalis · Feb 28, 2024 · 9bfa4f8 · 9bfa4f8
1 parent 9b845a2
commit 9bfa4f8
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 4 deletions.
diff --git a/src/Ardalis.Result/PagedInfo.cs b/src/Ardalis.Result/PagedInfo.cs
@@ -1,4 +1,6 @@
-namespace Ardalis.Result
+using System.Text.Json.Serialization;
+
+namespace Ardalis.Result
 {
     public class PagedInfo
     {
@@ -11,9 +13,13 @@ public PagedInfo(long pageNumber, long pageSize, long totalPages, long totalReco
             TotalRecords = totalRecords;
         }
 
+        [JsonInclude] 
         public long PageNumber { get; private set; }
+        [JsonInclude] 
         public long PageSize { get; private set; }
+        [JsonInclude] 
         public long TotalPages { get; private set; }
+        [JsonInclude] 
         public long TotalRecords { get; private set; }
 
         public PagedInfo SetPageNumber(long pageNumber)

diff --git a/src/Ardalis.Result/PagedResult.cs b/src/Ardalis.Result/PagedResult.cs
@@ -1,4 +1,6 @@
-namespace Ardalis.Result
+using System.Text.Json.Serialization;
+
+namespace Ardalis.Result
 {
     public class PagedResult<T> : Result<T>
     {
@@ -7,6 +9,7 @@ public PagedResult(PagedInfo pagedInfo, T value) : base(value)
             PagedInfo = pagedInfo;
         }
 
-        public PagedInfo PagedInfo { get; }
+        [JsonInclude] 
+        public PagedInfo PagedInfo { get; init; }
     }
 }
diff --git a/src/Ardalis.Result/Result.cs b/src/Ardalis.Result/Result.cs
@@ -35,15 +35,21 @@ protected Result(ResultStatus status)
             ValidationErrors = result.ValidationErrors,
         };
 
-        public T Value { get; }
+        [JsonInclude] 
+        public T Value { get; init; }
 
         [JsonIgnore]
         public Type ValueType => typeof(T);
+        [JsonInclude] 
         public ResultStatus Status { get; protected set; } = ResultStatus.Ok;
         public bool IsSuccess => Status == ResultStatus.Ok;
+        [JsonInclude] 
         public string SuccessMessage { get; protected set; } = string.Empty;
+        [JsonInclude] 
         public string CorrelationId { get; protected set; } = string.Empty;
+        [JsonInclude] 
         public IEnumerable<string> Errors { get; protected set; } = new List<string>();
+        [JsonInclude] 
         public List<ValidationError> ValidationErrors { get; protected set; } = new List<ValidationError>();
 
         /// <summary>

diff --git a/tests/Ardalis.Result.UnitTests/SystemTextJsonSerializer.cs b/tests/Ardalis.Result.UnitTests/SystemTextJsonSerializer.cs
@@ -48,6 +48,19 @@ public void ShouldDeserializeResultOfReferenceType()
 
             Assert.Equivalent(expected, result);
         }
+
+
+        [Fact]
+        public void ShouldDeserializeCorrectResultType()
+        {
+            var obj = Result.NotFound("NotFound");
+
+            var a = JsonSerializer.Serialize(obj);
+            var b = JsonSerializer.Deserialize<Result>(a);
+            var c = JsonSerializer.Serialize(b);
+
+            Assert.Equivalent(a, c);
+        }
 
         private class Foo
         {