Add Result.NoContent support (HTTP 204) (#178)

* feat: add NoContent (204) status code support * test: add unit tests for no content status --------- Co-authored-by: Steve Smith <steve@kentsmiths.com>
ardalis · May 13, 2024 · ddbac3f · ddbac3f
1 parent 8f8f2df
commit ddbac3f
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 3 deletions.
diff --git a/src/Ardalis.Result.AspNetCore/ResultStatusMap.cs b/src/Ardalis.Result.AspNetCore/ResultStatusMap.cs
@@ -41,7 +41,8 @@ public ResultStatusMap AddDefaultMap()
                         .With(CriticalEntity))
                 .For(ResultStatus.Unavailable, HttpStatusCode.ServiceUnavailable, resultStatusOptions =>
                     resultStatusOptions
-                        .With(UnavailableEntity));
+                        .With(UnavailableEntity))
+                .For(ResultStatus.NoContent, HttpStatusCode.NoContent);
         }
 
         /// <summary>

diff --git a/src/Ardalis.Result/Result.Void.cs b/src/Ardalis.Result/Result.Void.cs
@@ -193,5 +193,14 @@ public static Result ErrorWithCorrelationId(string correlationId, params string[
         {
             return new Result(ResultStatus.CriticalError) { Errors = errorMessages };
         }
+
+        /// <summary>
+        /// Represents a situation where the server has successfully fulfilled the request, but there is no content to send back in the response body.
+        /// </summary>
+        /// <returns>A Result object</returns>
+        public new static Result NoContent()
+        {
+            return new Result(ResultStatus.NoContent);
+        }
     }
 }
diff --git a/src/Ardalis.Result/Result.cs b/src/Ardalis.Result/Result.cs
@@ -43,7 +43,8 @@ protected Result(ResultStatus status)
         [JsonInclude] 
         public ResultStatus Status { get; protected set; } = ResultStatus.Ok;
 
-        public bool IsSuccess => Status is ResultStatus.Ok or ResultStatus.Created;
+        public bool IsSuccess => Status is ResultStatus.Ok or ResultStatus.NoContent or ResultStatus.Created;
+
         [JsonInclude] 
         public string SuccessMessage { get; protected set; } = string.Empty;
         [JsonInclude] 
@@ -156,7 +157,8 @@ public static Result<T> Invalid(ValidationError validationError)
         /// <returns>A Result<typeparamref name="T"/></returns>
         public static Result<T> Invalid(params ValidationError[] validationErrors)
         {
-            return new Result<T>(ResultStatus.Invalid) { ValidationErrors = new List<ValidationError>(validationErrors) };
+            return new Result<T>(ResultStatus.Invalid)
+                { ValidationErrors = new List<ValidationError>(validationErrors) };
         }
 
         /// <summary>
@@ -256,5 +258,15 @@ public static Result<T> Unavailable(params string[] errorMessages)
         {
             return new Result<T>(ResultStatus.Unavailable) { Errors = errorMessages};
         }
+
+        /// <summary>
+        /// Represents a situation where the server has successfully fulfilled the request, but there is no content to send back in the response body.
+        /// </summary>
+        /// <typeparam name="T">The type parameter representing the expected response data.</typeparam>
+        /// <returns>A Result object</returns>
+        public static Result<T> NoContent()
+        {
+            return new Result<T>(ResultStatus.NoContent);
+        }
     }
 }
diff --git a/src/Ardalis.Result/ResultExtensions.cs b/src/Ardalis.Result/ResultExtensions.cs
@@ -34,6 +34,7 @@ public static Result<TDestination> Map<TSource, TDestination>(this Result<TSourc
                                         : Result<TDestination>.Conflict();
                 case ResultStatus.CriticalError: return Result<TDestination>.CriticalError(result.Errors.ToArray());
                 case ResultStatus.Unavailable: return Result<TDestination>.Unavailable(result.Errors.ToArray());
+                case ResultStatus.NoContent: return Result<TDestination>.NoContent();
                 default:
                     throw new NotSupportedException($"Result {result.Status} conversion is not supported.");
             }

diff --git a/src/Ardalis.Result/ResultStatus.cs b/src/Ardalis.Result/ResultStatus.cs
@@ -9,6 +9,7 @@ public enum ResultStatus
         Unauthorized,
         Invalid,
         NotFound,
+        NoContent,
         Conflict,
         CriticalError,
         Unavailable

diff --git a/tests/Ardalis.Result.UnitTests/ResultConstructor.cs b/tests/Ardalis.Result.UnitTests/ResultConstructor.cs
@@ -284,4 +284,12 @@ public void InitializedIsSuccessFalseForCriticalErrorFactoryCall()
 
         Assert.False(result.IsSuccess);
     }
+
+    [Fact]
+    public void InitializesStatusToNoContentForNoContentFactoryCall()
+    {
+        var result = Result<object>.NoContent();
+
+        Assert.True(result.IsSuccess);
+    }
 }
diff --git a/tests/Ardalis.Result.UnitTests/ResultMap.cs b/tests/Ardalis.Result.UnitTests/ResultMap.cs
@@ -222,6 +222,19 @@ public void ShouldProduceCriticalErrorWithError()
             actual.Errors.Single().Should().Be(expectedMessage);
         }
 
+        [Fact]
+        public void ShouldProductNoContentWithoutAnyContent()
+        {
+            var result = Result<int>.NoContent();
+
+            var actual = result.Map(val => val.ToString());
+
+            actual.Status.Should().Be(ResultStatus.NoContent);
+            actual.Value.Should().BeNull();
+            actual.Errors.Should().BeEmpty();
+            actual.ValidationErrors.Should().BeEmpty();
+        }
+
         private record Foo(string Bar);
 
         private class FooDto