add and use constants, more docs tidy up.

Signed-off-by: jev jacob@jev.org.uk
dapr · Dec 26, 2024 · 8ebac53 · 8ebac53
1 parent 46a5dc3
commit 8ebac53
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 25 deletions.
diff --git a/src/Dapr.Common/Exceptions/DaprExceptionExtensions.cs b/src/Dapr.Common/Exceptions/DaprExceptionExtensions.cs
@@ -21,8 +21,6 @@ namespace Dapr.Common.Exceptions
     /// </summary>
     public static class DaprExceptionExtensions
     {
-        private static string GrpcDetails = "grpc-status-details-bin";
-
         /// <summary>
         /// Attempt to retrieve <see cref="DaprExtendedErrorInfo"/> from <see cref="DaprException"/>.
         /// </summary>
@@ -37,7 +35,7 @@ public static bool TryGetExtendedErrorInfo(this DaprException exception, [NotNul
                 return false;
             }
 
-            var metadata = rpcException.Trailers.Get(GrpcDetails);
+            var metadata = rpcException.Trailers.Get(DaprExtendedErrorConstants.GrpcDetails);
 
             if (metadata is null)
             {

diff --git a/src/Dapr.Common/Exceptions/DaprExtendedErrorConstants.cs b/src/Dapr.Common/Exceptions/DaprExtendedErrorConstants.cs
@@ -0,0 +1,9 @@
+namespace Dapr.Common.Exceptions
+{
+    internal class DaprExtendedErrorConstants
+    {
+        public const string DaprErrorDetailTypeUrl = "type.googleapis.com/";
+
+        public const string GrpcDetails = "grpc-status-details-bin";
+    }
+}
diff --git a/src/Dapr.Common/Exceptions/DaprExtendedErrorDetail.cs b/src/Dapr.Common/Exceptions/DaprExtendedErrorDetail.cs
@@ -22,7 +22,7 @@ public abstract record DaprExtendedErrorDetail(DaprExtendedErrorType ErrorType);
     /// Detail when the type url is unrecognized.
     /// </summary>
     /// <param name="TypeUrl">The unrecognized type url.</param>
-    public sealed record DaprUnrecognizedDetail(string TypeUrl) : DaprExtendedErrorDetail(DaprExtendedErrorType.Unrecognized);
+    public sealed record DaprUnknownDetail(string TypeUrl) : DaprExtendedErrorDetail(DaprExtendedErrorType.Unknown);
 
     /// <summary>
     /// Detail proving debugging information.
@@ -76,7 +76,7 @@ public sealed record DaprRetryInfoDetail() : DaprExtendedErrorDetail(DaprExtende
     public sealed record DaprQuotaFailureViolation(string Subject, string Description);
 
     /// <summary>
-    /// Detail relating to a quota failure e.g reaching an API limit.
+    /// Detail relating to a quota failure e.g reaching API limit.
     /// </summary>
     public sealed record DaprQuotaFailureDetail() : DaprExtendedErrorDetail(DaprExtendedErrorType.QuotaFailure)
     {

diff --git a/src/Dapr.Common/Exceptions/DaprExtendedErrorType.cs b/src/Dapr.Common/Exceptions/DaprExtendedErrorType.cs
@@ -17,15 +17,15 @@ namespace Dapr.Common.Exceptions
     /// Extended error detail types.
     /// This is based on the Richer Error Model (see <see href="https://google.aip.dev/193#error_model"/> and
     /// <see href="https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto"/>)
-    /// and is implemented by the Dapr runtime (see <see href="https://github.com/dapr/dapr/blob/master/pkg/api/errors/README.md)."/>).
+    /// and is implemented by the Dapr runtime (see <see href="https://github.com/dapr/dapr/blob/master/pkg/api/errors/README.md"/>).
     /// </summary>
     public enum DaprExtendedErrorType
     {
         /// <summary>
-        /// Unrecognized extended error type.
-        /// Implemented by <see cref="DaprUnrecognizedDetail"/>.
+        /// Unknown extended error type.
+        /// Implemented by <see cref="DaprUnknownDetail"/>.
         /// </summary>
-        Unrecognized,
+        Unknown,
 
         /// <summary>
         /// Retry info detail type.

diff --git a/src/Dapr.Common/Exceptions/ExtendedErrorDetailFactory.cs b/src/Dapr.Common/Exceptions/ExtendedErrorDetailFactory.cs
@@ -9,7 +9,7 @@ namespace Dapr.Common.Exceptions
     /// </summary>
     internal static class ExtendedErrorDetailFactory
     {
-        private const string DaprErrorTypeUrl = "type.googleapis.com/";
+        private const string DaprErrorTypeUrl = DaprExtendedErrorConstants.DaprErrorDetailTypeUrl;
 
         private static Dictionary<string, Func<ByteString, DaprExtendedErrorDetail>> extendedErrorTypeMapping =
             new()
@@ -35,7 +35,7 @@ internal static DaprExtendedErrorDetail CreateErrorDetail(Any metadata)
         {
             if (!extendedErrorTypeMapping.TryGetValue(metadata.TypeUrl, out var create))
             {
-                return new DaprUnrecognizedDetail(metadata.TypeUrl);
+                return new DaprUnknownDetail(metadata.TypeUrl);
             }
 
             return create.Invoke(metadata.Value);

diff --git a/test/Dapr.Common.Test/DaprExtendedErrorInfoTest.cs b/test/Dapr.Common.Test/DaprExtendedErrorInfoTest.cs
@@ -13,8 +13,6 @@ public class DaprExtendedErrorInfoTest
         private static int statusCode = 1;
         private static string statusMessage = "Status Message";
 
-        private static string GrpcDetails = "grpc-status-details-bin";
-
         [Fact]
         public void DaprExendedErrorInfo_ThrowsRpcDaprException_ExtendedErrorInfoReturnsTrueAndNotNull()
         {
@@ -32,7 +30,7 @@ public void DaprExendedErrorInfo_ThrowsRpcDaprException_ExtendedErrorInfoReturns
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(StatusCode.Aborted, "BadRequest"), trailers: trailers);
@@ -119,7 +117,7 @@ public void DaprExtendedErrorInfo_ThrowsBadRequestRpcException_ShouldGetSingleDa
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(StatusCode.Aborted, "BadRequest"), trailers: trailers);
@@ -171,7 +169,7 @@ public void DaprExtendedErrorInfo_ThrowsLocalizedMessageRpcException_ShouldGetSi
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(StatusCode.Aborted, "BadRequest"), trailers: trailers);
@@ -220,7 +218,7 @@ public void DaprExtendedErrorInfo_ThrowRetryInfoRpcException_ShouldGetSingleDapr
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(StatusCode.FailedPrecondition, "RetryInfo"), trailers: trailers);
@@ -267,7 +265,7 @@ public void DaprExtendedErrorInfo_ThrowsDebugInfoRpcException_ShouldGetSingleDap
 
             Grpc.Core.Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(Grpc.Core.StatusCode.FailedPrecondition, "DebugInfo"), trailers: trailers);
@@ -323,7 +321,7 @@ public void DaprExtendedErrorInfo_ThrowsPreconditionFailureRpcException_ShouldGe
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(Grpc.Core.StatusCode.FailedPrecondition, "PrecondtionFailure"), trailers: trailers);
@@ -379,7 +377,7 @@ public void DaprExtendedErrorInfo_ThrowsHelpRpcException_ShouldGetSingleDaprHelp
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(StatusCode.Aborted, "Help"), trailers: trailers);
@@ -438,7 +436,7 @@ public void DaprExtendedErrorInfo_ThrowsResourceInfoRpcException_ShouldGetSingle
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(StatusCode.Aborted, "ResourceInfo"), trailers: trailers);
@@ -494,7 +492,7 @@ public void DaprExtendedErrorInfo_ThrowsQuotaFailureRpcException_ShouldGetSingle
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(StatusCode.Aborted, "QuotaFailure"), trailers: trailers);
@@ -556,7 +554,7 @@ public void DaprExtendedErrorInfo_ThrowsErrorInfoRpcException_ShouldGetSingleDap
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(StatusCode.Aborted, "ErrorInfo"), trailers: trailers);
@@ -612,7 +610,7 @@ public void DaprExtendedErrorInfo_ThrowsRequestInfoRpcException_ShouldGetSingleD
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(StatusCode.Aborted, "RequestInfo"), trailers: trailers);
@@ -665,7 +663,7 @@ public void DaprExtendedErrorInfo_ThrowsRequestInfoRpcException_ShouldGetMultipl
 
             Metadata trailers = new()
             {
-                { GrpcDetails, metadataEntry.ToByteArray() }
+                { DaprExtendedErrorConstants.GrpcDetails, metadataEntry.ToByteArray() }
             };
 
             var rpcEx = new RpcException(status: new Grpc.Core.Status(StatusCode.Aborted, "RequestInfo"), trailers: trailers);