Update service error codes (#3315)

drwill-ms · web-flow · commit abe2b4cf8869 · 2023-05-02T00:28:42.000Z
* Update service error codes

* Fix transientness of associated exceptions
diff --git a/e2e/test/iothub/DeviceClientE2eTests.cs b/e2e/test/iothub/DeviceClientE2eTests.cs
@@ -36,9 +36,7 @@ public async Task DeviceClient_CloseAsync_CanBeCalledTwice()
             finally
             {
                 await testDevice.RemoveDeviceAsync().ConfigureAwait(false);
-                testDevice.Dispose();
             }
-
         }
     }
 }
diff --git a/iothub/device/src/Common/Exceptions/IotHubException.cs b/iothub/device/src/Common/Exceptions/IotHubException.cs
@@ -129,15 +129,16 @@ protected IotHubException(SerializationInfo info, StreamingContext context)
             }
         }
 
-        internal IotHubException(bool isTransient) : base()
+        internal IotHubException(bool isTransient)
+            : base()
         {
             IsTransient = isTransient;
         }
 
         /// <summary>
         /// Indicates if the error is transient and should be retried.
         /// </summary>
-        public bool IsTransient { get; private set; }
+        public bool IsTransient { get; protected set; }
 
         /// <summary>
         /// The service returned tracking Id associated with this particular error.
diff --git a/iothub/device/src/Common/Exceptions/IotHubThrottledException.cs b/iothub/device/src/Common/Exceptions/IotHubThrottledException.cs
@@ -20,7 +20,8 @@ public sealed class IotHubThrottledException : IotHubException
         /// <summary>
         /// Initializes a new instance of the class.
         /// </summary>
-        public IotHubThrottledException() : base(isTransient: true)
+        public IotHubThrottledException()
+            : base(isTransient: true)
         {
         }
 
@@ -65,6 +66,7 @@ public IotHubThrottledException(string message, Exception innerException)
         private IotHubThrottledException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {
+            IsTransient = true;
         }
     }
 }
diff --git a/iothub/device/src/Common/Exceptions/QuotaExceededException.cs b/iothub/device/src/Common/Exceptions/QuotaExceededException.cs
@@ -19,7 +19,8 @@ public sealed class QuotaExceededException : IotHubException
         /// <summary>
         /// Initializes a new instance of the class.
         /// </summary>
-        public QuotaExceededException() : base(isTransient: true)
+        public QuotaExceededException()
+            : base(isTransient: true)
         {
         }
 
@@ -30,7 +31,7 @@ public QuotaExceededException() : base(isTransient: true)
         /// understood by humans. The caller of this constructor is required to ensure that this string has
         /// been localized for the current system culture.</param>
         public QuotaExceededException(string message)
-            : this(message, null)
+            : base(message, true)
         {
         }
 
diff --git a/iothub/device/src/Common/Exceptions/ServerBusyException.cs b/iothub/device/src/Common/Exceptions/ServerBusyException.cs
@@ -20,7 +20,8 @@ public sealed class ServerBusyException : IotHubException
         /// <summary>
         /// Initializes a new instance of the class.
         /// </summary>
-        public ServerBusyException() : base(isTransient: true)
+        public ServerBusyException()
+            : base(isTransient: true)
         {
         }
 
@@ -29,7 +30,7 @@ public ServerBusyException() : base(isTransient: true)
         /// </summary>
         /// <param name="message">The error message.</param>
         public ServerBusyException(string message)
-            : this(message, null)
+            : base(message, true)
         {
         }
 
@@ -43,6 +44,7 @@ public ServerBusyException(string message, Exception innerException)
         private ServerBusyException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {
+            IsTransient = true;
         }
     }
 }
diff --git a/iothub/service/src/Common/Exceptions/ErrorCode.cs b/iothub/service/src/Common/Exceptions/ErrorCode.cs
@@ -292,6 +292,12 @@ public enum ErrorCode
 
         // Throttling Exception
 
+        /// <summary>
+        /// IoT hub throttling limits have been exceeded for the requested operation.
+        /// For more information, <see href="https://aka.ms/iothubthrottling">IoT hub quotas and throttling</see>.
+        /// </summary>
+        GenericTooManyRequests = 429000,
+
         /// <summary>
         /// IoT hub throttling limits have been exceeded for the requested operation.
         /// For more information, <see href="https://aka.ms/iothubthrottling">IoT hub quotas and throttling</see>.
@@ -306,6 +312,24 @@ public enum ErrorCode
         /// </summary>
         ThrottleBacklogLimitExceeded = 429002,
 
+        /// <summary>
+        /// IoT hub throttling limits have been exceeded for the requested operation.
+        /// For more information, <see href="https://aka.ms/iothubthrottling">IoT hub quotas and throttling</see>.
+        /// </summary>
+        ThrottlingBacklogTimeout = 429003,
+
+        /// <summary>
+        /// IoT hub throttling limits have been exceeded for the requested operation.
+        /// For more information, <see href="https://aka.ms/iothubthrottling">IoT hub quotas and throttling</see>.
+        /// </summary>
+        ThrottlingMaxActiveJobCountExceeded = 429004,
+
+        /// <summary>
+        /// IoT hub throttling limits have been exceeded for the requested operation.
+        /// For more information, <see href="https://aka.ms/iothubthrottling">IoT hub quotas and throttling</see>.
+        /// </summary>
+        DeviceThrottlingLimitExceeded = 429005,
+
         /// <summary>
         /// IoT hub ran into a server side issue when attempting to throttle.
         /// <para>
diff --git a/iothub/service/src/Common/Exceptions/IotHubException.cs b/iothub/service/src/Common/Exceptions/IotHubException.cs
@@ -157,7 +157,7 @@ internal IotHubException()
         /// <summary>
         /// Indicates if the error is transient and should be retried.
         /// </summary>
-        public bool IsTransient { get; private set; }
+        public bool IsTransient { get; protected set; }
 
         /// <summary>
         /// The service returned tracking Id associated with this particular error.
diff --git a/iothub/service/src/Common/Exceptions/IotHubThrottledException.cs b/iothub/service/src/Common/Exceptions/IotHubThrottledException.cs
@@ -18,38 +18,29 @@ public sealed class IotHubThrottledException : IotHubException
     {
         /// <summary>
         /// Creates an instance of this class with the value of the
-        /// maximum allowed count of active requests and marks it as non-transient.
+        /// maximum allowed count of active requests and marks it as transient.
         /// </summary>
         /// <param name="maximumBatchCount">The maximum allowed count of active requests.</param>
         public IotHubThrottledException(int maximumBatchCount)
-            : this($"Device Container has exceeded maximum number of allowed active requests: {maximumBatchCount}.")
+            : base($"Device Container has exceeded maximum number of allowed active requests: {maximumBatchCount}.", true)
         {
         }
 
         /// <summary>
         /// Creates an instance of this class with a specified error message and
-        /// a reference to the inner exception that caused this exception, and marks it as non-transient.
+        /// a reference to the inner exception that caused this exception, and marks it as transient.
         /// </summary>
         /// <param name="message">The message that describes the error.</param>
         /// <param name="innerException">The exception that is the cause of the current exception.</param>
         public IotHubThrottledException(string message, Exception innerException)
-            : base(message, innerException)
-        {
-        }
-
-        internal IotHubThrottledException()
-            : base()
-        {
-        }
-
-        internal IotHubThrottledException(string message)
-            : base(message)
+            : base(message, innerException, true)
         {
         }
 
         private IotHubThrottledException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {
+            IsTransient = true;
         }
     }
 }
diff --git a/iothub/service/src/Common/Exceptions/JobQuotaExceededException.cs b/iothub/service/src/Common/Exceptions/JobQuotaExceededException.cs
@@ -15,30 +15,33 @@ public sealed class JobQuotaExceededException : IotHubException
         private const string DefaultErrorMessage = "Job quota has been exceeded.";
 
         /// <summary>
-        /// Creates an instance of this class with the default error message and marks it as non-transient.
+        /// Creates an instance of this class with the default error message and marks it as transient.
         /// </summary>
         public JobQuotaExceededException()
             : this(DefaultErrorMessage)
         {
         }
 
         /// <summary>
-        /// Creates an instance of this class with a specified error message and marks it as non-transient.
+        /// Creates an instance of this class with a specified error message and marks it as transient.
         /// </summary>
         /// <param name="message">The message that describes the error.</param>
         public JobQuotaExceededException(string message)
-            : base(message)
+            : base(message, true)
         {
         }
 
         internal JobQuotaExceededException(string message, Exception innerException)
             : base(message, innerException)
         {
+
+            IsTransient = true;
         }
 
         private JobQuotaExceededException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {
+            IsTransient = true;
         }
     }
 }
diff --git a/iothub/service/src/Common/Exceptions/QuotaExceededException.cs b/iothub/service/src/Common/Exceptions/QuotaExceededException.cs
@@ -22,7 +22,7 @@ public sealed class QuotaExceededException : IotHubException
         /// </summary>
         /// <param name="message">The message that describes the error.</param>
         public QuotaExceededException(string message)
-            : this(message, null)
+            : base(message, true)
         {
         }
 
@@ -48,14 +48,10 @@ public QuotaExceededException(string message, Exception innerException)
         {
         }
 
-        internal QuotaExceededException()
-            : base()
-        {
-        }
-
         private QuotaExceededException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {
+            IsTransient = true;
         }
     }
 }
diff --git a/iothub/service/src/Common/Exceptions/ServerBusyException.cs b/iothub/service/src/Common/Exceptions/ServerBusyException.cs
@@ -47,11 +47,6 @@ public ServerBusyException(string message, Exception innerException)
         {
         }
 
-        internal ServerBusyException()
-            : base()
-        {
-        }
-
         private ServerBusyException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {
diff --git a/iothub/service/src/Common/Exceptions/ThrottlingException.cs b/iothub/service/src/Common/Exceptions/ThrottlingException.cs
@@ -13,33 +13,34 @@ namespace Microsoft.Azure.Devices.Common.Exceptions
     public class ThrottlingException : IotHubException
     {
         /// <summary>
-        /// Creates an instance of <see cref="ThrottlingException"/> with a specified error message and marks it as non-transient.
+        /// Creates an instance of <see cref="ThrottlingException"/> with a specified error message and marks it as transient.
         /// </summary>
         /// <param name="message">The message that describes the error.</param>
         public ThrottlingException(string message)
-            : base(message)
+            : base(message, true)
         {
         }
 
         /// <summary>
         /// Creates an instance of <see cref="ThrottlingException"/> with a specified <see cref="ErrorCode"/>, error message
-        /// and marks it as non-transient.
+        /// and marks it as transient.
         /// </summary>
         /// <param name="code">The <see cref="ErrorCode"/> associated with the error.</param>
         /// <param name="message">The message that describes the error.</param>
         public ThrottlingException(ErrorCode code, string message)
             : base(code, message)
         {
+            IsTransient = true;
         }
 
         /// <summary>
         /// Creates an instance of <see cref="ThrottlingException"/> with a specified error message and
-        /// a reference to the inner exception that caused this exception, and marks it as non-transient.
+        /// a reference to the inner exception that caused this exception, and marks it as transient.
         /// </summary>
         /// <param name="message">The message that describes the error.</param>
         /// <param name="inner">The exception that is the cause of the current exception.</param>
         public ThrottlingException(string message, Exception inner)
-            : base(message, inner)
+            : base(message, inner, true)
         {
         }
 
@@ -52,11 +53,7 @@ public ThrottlingException(string message, Exception inner)
         protected ThrottlingException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {
-        }
-
-        internal ThrottlingException()
-            : base()
-        {
+            IsTransient = true;
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,7 @@ public async Task DeviceClient_CloseAsync_CanBeCalledTwice()`
`36`	`36`	`finally`
`37`	`37`	`{`
`38`	`38`	`await testDevice.RemoveDeviceAsync().ConfigureAwait(false);`
`39`		`- testDevice.Dispose();`
`40`	`39`	`}`
`41`		`-`
`42`	`40`	`}`
`43`	`41`	`}`
`44`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -129,15 +129,16 @@ protected IotHubException(SerializationInfo info, StreamingContext context)`
`129`	`129`	`}`
`130`	`130`	`}`
`131`	`131`
`132`		`- internal IotHubException(bool isTransient) : base()`
	`132`	`+ internal IotHubException(bool isTransient)`
	`133`	`+ : base()`
`133`	`134`	`{`
`134`	`135`	`IsTransient = isTransient;`
`135`	`136`	`}`
`136`	`137`
`137`	`138`	`/// <summary>`
`138`	`139`	`/// Indicates if the error is transient and should be retried.`
`139`	`140`	`/// </summary>`
`140`		`- public bool IsTransient { get; private set; }`
	`141`	`+ public bool IsTransient { get; protected set; }`
`141`	`142`
`142`	`143`	`/// <summary>`
`143`	`144`	`/// The service returned tracking Id associated with this particular error.`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,8 @@ public sealed class IotHubThrottledException : IotHubException`
`20`	`20`	`/// <summary>`
`21`	`21`	`/// Initializes a new instance of the class.`
`22`	`22`	`/// </summary>`
`23`		`- public IotHubThrottledException() : base(isTransient: true)`
	`23`	`+ public IotHubThrottledException()`
	`24`	`+ : base(isTransient: true)`
`24`	`25`	`{`
`25`	`26`	`}`
`26`	`27`
`@@ -65,6 +66,7 @@ public IotHubThrottledException(string message, Exception innerException)`
`65`	`66`	`private IotHubThrottledException(SerializationInfo info, StreamingContext context)`
`66`	`67`	`: base(info, context)`
`67`	`68`	`{`
	`69`	`+ IsTransient = true;`
`68`	`70`	`}`
`69`	`71`	`}`
`70`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,8 @@ public sealed class QuotaExceededException : IotHubException`
`19`	`19`	`/// <summary>`
`20`	`20`	`/// Initializes a new instance of the class.`
`21`	`21`	`/// </summary>`
`22`		`- public QuotaExceededException() : base(isTransient: true)`
	`22`	`+ public QuotaExceededException()`
	`23`	`+ : base(isTransient: true)`
`23`	`24`	`{`
`24`	`25`	`}`
`25`	`26`
`@@ -30,7 +31,7 @@ public QuotaExceededException() : base(isTransient: true)`
`30`	`31`	`/// understood by humans. The caller of this constructor is required to ensure that this string has`
`31`	`32`	`/// been localized for the current system culture.</param>`
`32`	`33`	`public QuotaExceededException(string message)`
`33`		`- : this(message, null)`
	`34`	`+ : base(message, true)`
`34`	`35`	`{`
`35`	`36`	`}`
`36`	`37`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,8 @@ public sealed class ServerBusyException : IotHubException`
`20`	`20`	`/// <summary>`
`21`	`21`	`/// Initializes a new instance of the class.`
`22`	`22`	`/// </summary>`
`23`		`- public ServerBusyException() : base(isTransient: true)`
	`23`	`+ public ServerBusyException()`
	`24`	`+ : base(isTransient: true)`
`24`	`25`	`{`
`25`	`26`	`}`
`26`	`27`
`@@ -29,7 +30,7 @@ public ServerBusyException() : base(isTransient: true)`
`29`	`30`	`/// </summary>`
`30`	`31`	`/// <param name="message">The error message.</param>`
`31`	`32`	`public ServerBusyException(string message)`
`32`		`- : this(message, null)`
	`33`	`+ : base(message, true)`
`33`	`34`	`{`
`34`	`35`	`}`
`35`	`36`
`@@ -43,6 +44,7 @@ public ServerBusyException(string message, Exception innerException)`
`43`	`44`	`private ServerBusyException(SerializationInfo info, StreamingContext context)`
`44`	`45`	`: base(info, context)`
`45`	`46`	`{`
	`47`	`+ IsTransient = true;`
`46`	`48`	`}`
`47`	`49`	`}`
`48`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,38 +18,29 @@ public sealed class IotHubThrottledException : IotHubException`
`18`	`18`	`{`
`19`	`19`	`/// <summary>`
`20`	`20`	`/// Creates an instance of this class with the value of the`
`21`		`- /// maximum allowed count of active requests and marks it as non-transient.`
	`21`	`+ /// maximum allowed count of active requests and marks it as transient.`
`22`	`22`	`/// </summary>`
`23`	`23`	`/// <param name="maximumBatchCount">The maximum allowed count of active requests.</param>`
`24`	`24`	`public IotHubThrottledException(int maximumBatchCount)`
`25`		`- : this($"Device Container has exceeded maximum number of allowed active requests: {maximumBatchCount}.")`
	`25`	`+ : base($"Device Container has exceeded maximum number of allowed active requests: {maximumBatchCount}.", true)`
`26`	`26`	`{`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`/// <summary>`
`30`	`30`	`/// Creates an instance of this class with a specified error message and`
`31`		`- /// a reference to the inner exception that caused this exception, and marks it as non-transient.`
	`31`	`+ /// a reference to the inner exception that caused this exception, and marks it as transient.`
`32`	`32`	`/// </summary>`
`33`	`33`	`/// <param name="message">The message that describes the error.</param>`
`34`	`34`	`/// <param name="innerException">The exception that is the cause of the current exception.</param>`
`35`	`35`	`public IotHubThrottledException(string message, Exception innerException)`
`36`		`- : base(message, innerException)`
`37`		`- {`
`38`		`- }`
`39`		`-`
`40`		`- internal IotHubThrottledException()`
`41`		`- : base()`
`42`		`- {`
`43`		`- }`
`44`		`-`
`45`		`- internal IotHubThrottledException(string message)`
`46`		`- : base(message)`
	`36`	`+ : base(message, innerException, true)`
`47`	`37`	`{`
`48`	`38`	`}`
`49`	`39`
`50`	`40`	`private IotHubThrottledException(SerializationInfo info, StreamingContext context)`
`51`	`41`	`: base(info, context)`
`52`	`42`	`{`
	`43`	`+ IsTransient = true;`
`53`	`44`	`}`
`54`	`45`	`}`
`55`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,30 +15,33 @@ public sealed class JobQuotaExceededException : IotHubException`
`15`	`15`	`private const string DefaultErrorMessage = "Job quota has been exceeded.";`
`16`	`16`
`17`	`17`	`/// <summary>`
`18`		`- /// Creates an instance of this class with the default error message and marks it as non-transient.`
	`18`	`+ /// Creates an instance of this class with the default error message and marks it as transient.`
`19`	`19`	`/// </summary>`
`20`	`20`	`public JobQuotaExceededException()`
`21`	`21`	`: this(DefaultErrorMessage)`
`22`	`22`	`{`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`/// <summary>`
`26`		`- /// Creates an instance of this class with a specified error message and marks it as non-transient.`
	`26`	`+ /// Creates an instance of this class with a specified error message and marks it as transient.`
`27`	`27`	`/// </summary>`
`28`	`28`	`/// <param name="message">The message that describes the error.</param>`
`29`	`29`	`public JobQuotaExceededException(string message)`
`30`		`- : base(message)`
	`30`	`+ : base(message, true)`
`31`	`31`	`{`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`internal JobQuotaExceededException(string message, Exception innerException)`
`35`	`35`	`: base(message, innerException)`
`36`	`36`	`{`
	`37`	`+`
	`38`	`+ IsTransient = true;`
`37`	`39`	`}`
`38`	`40`
`39`	`41`	`private JobQuotaExceededException(SerializationInfo info, StreamingContext context)`
`40`	`42`	`: base(info, context)`
`41`	`43`	`{`
	`44`	`+ IsTransient = true;`
`42`	`45`	`}`
`43`	`46`	`}`
`44`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public sealed class QuotaExceededException : IotHubException`
`22`	`22`	`/// </summary>`
`23`	`23`	`/// <param name="message">The message that describes the error.</param>`
`24`	`24`	`public QuotaExceededException(string message)`
`25`		`- : this(message, null)`
	`25`	`+ : base(message, true)`
`26`	`26`	`{`
`27`	`27`	`}`
`28`	`28`
`@@ -48,14 +48,10 @@ public QuotaExceededException(string message, Exception innerException)`
`48`	`48`	`{`
`49`	`49`	`}`
`50`	`50`
`51`		`- internal QuotaExceededException()`
`52`		`- : base()`
`53`		`- {`
`54`		`- }`
`55`		`-`
`56`	`51`	`private QuotaExceededException(SerializationInfo info, StreamingContext context)`
`57`	`52`	`: base(info, context)`
`58`	`53`	`{`
	`54`	`+ IsTransient = true;`
`59`	`55`	`}`
`60`	`56`	`}`
`61`	`57`	`}`