chore: add interface for all error response types (#434)

In the current formulation, downstream code cannot consume a generic Error type, because current error types inherit from a parent abstract class. This PR introduces an error interface, IError, which specifies that an error response has the following properties: InnerException ErrorCode Message which is common to all error classes. With this in place we inherit the documentation from the interface, simplifying the doc strings in the response classes. Eventually we should the same for Success, Hit, and Miss.
momentohq · May 2, 2023 · c698107 · c698107
1 parent 6b87c89
commit c698107
Show file tree

Hide file tree

Showing 38 changed files with 171 additions and 161 deletions.
diff --git a/src/Momento.Sdk/Responses/CacheDeleteResponse.cs b/src/Momento.Sdk/Responses/CacheDeleteResponse.cs
@@ -33,7 +33,7 @@ public abstract class CacheDeleteResponse
     public class Success : CacheDeleteResponse { }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheDeleteResponse
+    public class Error : CacheDeleteResponse, IError
     {
         private readonly SdkException _error;
 
@@ -43,19 +43,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheDictionaryFetchResponse.cs b/src/Momento.Sdk/Responses/CacheDictionaryFetchResponse.cs
@@ -111,7 +111,7 @@ public class Miss : CacheDictionaryFetchResponse
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheDictionaryFetchResponse
+    public class Error : CacheDictionaryFetchResponse, IError
     {
         private readonly SdkException _error;
 
@@ -121,19 +121,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheDictionaryGetFieldResponse.cs b/src/Momento.Sdk/Responses/CacheDictionaryGetFieldResponse.cs
@@ -123,7 +123,7 @@ public Miss(ByteString field) : base(field)
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheDictionaryGetFieldResponse
+    public class Error : CacheDictionaryGetFieldResponse, IError
     {
         private readonly SdkException _error;
 
@@ -139,19 +139,19 @@ public Error(ByteString field, SdkException error) : base(field)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheDictionaryGetFieldsResponse.cs b/src/Momento.Sdk/Responses/CacheDictionaryGetFieldsResponse.cs
@@ -146,7 +146,7 @@ public class Miss : CacheDictionaryGetFieldsResponse
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheDictionaryGetFieldsResponse
+    public class Error : CacheDictionaryGetFieldsResponse, IError
     {
         private readonly SdkException _error;
 
@@ -156,19 +156,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheDictionaryIncrementResponse.cs b/src/Momento.Sdk/Responses/CacheDictionaryIncrementResponse.cs
@@ -52,7 +52,7 @@ public override string ToString()
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheDictionaryIncrementResponse
+    public class Error : CacheDictionaryIncrementResponse, IError
     {
         private readonly SdkException _error;
 
@@ -62,19 +62,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheDictionaryRemoveFieldResponse.cs b/src/Momento.Sdk/Responses/CacheDictionaryRemoveFieldResponse.cs
@@ -35,7 +35,7 @@ public class Success : CacheDictionaryRemoveFieldResponse
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheDictionaryRemoveFieldResponse
+    public class Error : CacheDictionaryRemoveFieldResponse, IError
     {
         private readonly SdkException _error;
 
@@ -45,19 +45,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheDictionaryRemoveFieldsResponse.cs b/src/Momento.Sdk/Responses/CacheDictionaryRemoveFieldsResponse.cs
@@ -35,7 +35,7 @@ public class Success : CacheDictionaryRemoveFieldsResponse
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheDictionaryRemoveFieldsResponse
+    public class Error : CacheDictionaryRemoveFieldsResponse, IError
     {
         private readonly SdkException _error;
 
@@ -45,19 +45,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheDictionarySetFieldResponse.cs b/src/Momento.Sdk/Responses/CacheDictionarySetFieldResponse.cs
@@ -35,7 +35,7 @@ public class Success : CacheDictionarySetFieldResponse
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheDictionarySetFieldResponse
+    public class Error : CacheDictionarySetFieldResponse, IError
     {
         private readonly SdkException _error;
 
@@ -45,19 +45,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheDictionarySetFieldsResponse.cs b/src/Momento.Sdk/Responses/CacheDictionarySetFieldsResponse.cs
@@ -35,7 +35,7 @@ public class Success : CacheDictionarySetFieldsResponse
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheDictionarySetFieldsResponse
+    public class Error : CacheDictionarySetFieldsResponse, IError
     {
         private readonly SdkException _error;
 
@@ -45,19 +45,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheGetBatchResponse.cs b/src/Momento.Sdk/Responses/CacheGetBatchResponse.cs
@@ -58,7 +58,7 @@ public IEnumerable<byte[]?> ValueByteArrays
         }
     }
 
-    public class Error : CacheGetBatchResponse
+    public class Error : CacheGetBatchResponse, IError
     {
         private readonly SdkException _error;
         public Error(SdkException error)

diff --git a/src/Momento.Sdk/Responses/CacheGetResponse.cs b/src/Momento.Sdk/Responses/CacheGetResponse.cs
@@ -85,7 +85,7 @@ public class Miss : CacheGetResponse
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheGetResponse
+    public class Error : CacheGetResponse, IError
     {
         private readonly SdkException _error;
 
@@ -95,19 +95,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheIncrementResponse.cs b/src/Momento.Sdk/Responses/CacheIncrementResponse.cs
@@ -52,7 +52,7 @@ public override string ToString()
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheIncrementResponse
+    public class Error : CacheIncrementResponse, IError
     {
         private readonly SdkException _error;
 
@@ -62,19 +62,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";

diff --git a/src/Momento.Sdk/Responses/CacheKeyExistsResponse.cs b/src/Momento.Sdk/Responses/CacheKeyExistsResponse.cs
@@ -53,7 +53,7 @@ public override string ToString()
     }
 
     /// <include file="../docs.xml" path='docs/class[@name="Error"]/description/*' />
-    public class Error : CacheKeyExistsResponse
+    public class Error : CacheKeyExistsResponse, IError
     {
         private readonly SdkException _error;
 
@@ -63,19 +63,19 @@ public Error(SdkException error)
             _error = error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' />
+        /// <inheritdoc />
         public SdkException InnerException
         {
             get => _error;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="ErrorCode"]/*' />
+        /// <inheritdoc />
         public MomentoErrorCode ErrorCode
         {
             get => _error.ErrorCode;
         }
 
-        /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="Message"]/*' />
+        /// <inheritdoc />
         public string Message
         {
             get => $"{_error.MessageWrapper}: {_error.Message}";