Merge pull request #1388 from SimonCropp/cleanup-exception-handling

cleanup exception handling
microsoft · Oct 5, 2023 · eb97519 · eb97519
2 parents 22c7a3d + bb0f507
commit eb97519
Show file tree

Hide file tree

Showing 54 changed files with 125 additions and 431 deletions.
diff --git a/src/Microsoft.OpenApi/Attributes/DisplayAttribute.cs b/src/Microsoft.OpenApi/Attributes/DisplayAttribute.cs
@@ -17,12 +17,7 @@ public class DisplayAttribute : Attribute
         /// <param name="name">The display name.</param>
         public DisplayAttribute(string name)
         {
-            if (string.IsNullOrWhiteSpace(name))
-            {
-                throw Error.ArgumentNullOrWhiteSpace(nameof(name));
-            }
-
-            Name = name;
+            Name = Utils.CheckArgumentNullOrEmpty(name);
         }
 
         /// <summary>

diff --git a/src/Microsoft.OpenApi/CallerArgumentExpressionAttribute.cs b/src/Microsoft.OpenApi/CallerArgumentExpressionAttribute.cs
@@ -0,0 +1,18 @@
+#if !NETCOREAPP3_1_OR_GREATER
+using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
+
+namespace System.Runtime.CompilerServices;
+
+[ExcludeFromCodeCoverage]
+[DebuggerNonUserCode]
+[AttributeUsage(AttributeTargets.Parameter)]
+sealed class CallerArgumentExpressionAttribute :
+    Attribute
+{
+    public CallerArgumentExpressionAttribute(string parameterName) =>
+        ParameterName = parameterName;
+
+    public string ParameterName { get; }
+}
+#endif
diff --git a/src/Microsoft.OpenApi/Error.cs b/src/Microsoft.OpenApi/Error.cs
diff --git a/src/Microsoft.OpenApi/Expressions/BodyExpression.cs b/src/Microsoft.OpenApi/Expressions/BodyExpression.cs
@@ -33,10 +33,7 @@ public BodyExpression()
         public BodyExpression(JsonPointer pointer)
             : base(pointer?.ToString())
         {
-            if (pointer == null)
-            {
-                throw Error.ArgumentNull(nameof(pointer));
-            }
+            Utils.CheckArgumentNull(pointer);
         }
 
         /// <summary>

diff --git a/src/Microsoft.OpenApi/Expressions/HeaderExpression.cs b/src/Microsoft.OpenApi/Expressions/HeaderExpression.cs
@@ -20,10 +20,7 @@ public class HeaderExpression : SourceExpression
         public HeaderExpression(string token)
             : base(token)
         {
-            if (string.IsNullOrWhiteSpace(token))
-            {
-                throw Error.ArgumentNullOrWhiteSpace(nameof(token));
-            }
+            Utils.CheckArgumentNullOrEmpty(token);
         }
 
         /// <summary>

diff --git a/src/Microsoft.OpenApi/Expressions/PathExpression.cs b/src/Microsoft.OpenApi/Expressions/PathExpression.cs
@@ -20,10 +20,7 @@ public sealed class PathExpression : SourceExpression
         public PathExpression(string name)
             : base(name)
         {
-            if (string.IsNullOrWhiteSpace(name))
-            {
-                throw Error.ArgumentNullOrWhiteSpace(nameof(name));
-            }
+            Utils.CheckArgumentNullOrEmpty(name);
         }
 
         /// <summary>

diff --git a/src/Microsoft.OpenApi/Expressions/QueryExpression.cs b/src/Microsoft.OpenApi/Expressions/QueryExpression.cs
@@ -20,10 +20,7 @@ public sealed class QueryExpression : SourceExpression
         public QueryExpression(string name)
             : base(name)
         {
-            if (string.IsNullOrWhiteSpace(name))
-            {
-                throw Error.ArgumentNullOrWhiteSpace(nameof(name));
-            }
+            Utils.CheckArgumentNullOrEmpty(name);
         }
 
         /// <summary>

diff --git a/src/Microsoft.OpenApi/Expressions/RequestExpression.cs b/src/Microsoft.OpenApi/Expressions/RequestExpression.cs
@@ -19,7 +19,7 @@ public sealed class RequestExpression : RuntimeExpression
         /// <param name="source">The source of the request.</param>
         public RequestExpression(SourceExpression source)
         {
-            Source = source ?? throw Error.ArgumentNull(nameof(source));
+            Source = Utils.CheckArgumentNull(source);
         }
 
         /// <summary>

diff --git a/src/Microsoft.OpenApi/Expressions/ResponseExpression.cs b/src/Microsoft.OpenApi/Expressions/ResponseExpression.cs
@@ -19,7 +19,7 @@ public sealed class ResponseExpression : RuntimeExpression
         /// <param name="source">The source of the response.</param>
         public ResponseExpression(SourceExpression source)
         {
-            Source = source ?? throw Error.ArgumentNull(nameof(source));
+            Source = Utils.CheckArgumentNull(source);
         }
 
         /// <summary>

diff --git a/src/Microsoft.OpenApi/Expressions/RuntimeExpression.cs b/src/Microsoft.OpenApi/Expressions/RuntimeExpression.cs
@@ -29,10 +29,7 @@ public abstract class RuntimeExpression : IEquatable<RuntimeExpression>
         /// <returns>The built runtime expression object.</returns>
         public static RuntimeExpression Build(string expression)
         {
-            if (string.IsNullOrWhiteSpace(expression))
-            {
-                throw Error.ArgumentNullOrWhiteSpace(nameof(expression));
-            }
+            Utils.CheckArgumentNullOrEmpty(expression);
 
             if (!expression.StartsWith(Prefix))
             {

diff --git a/src/Microsoft.OpenApi/Extensions/OpenApiExtensibleExtensions.cs b/src/Microsoft.OpenApi/Extensions/OpenApiExtensibleExtensions.cs
@@ -23,22 +23,15 @@ public static class OpenApiExtensibleExtensions
         public static void AddExtension<T>(this T element, string name, IOpenApiExtension any)
             where T : IOpenApiExtensible
         {
-            if (element == null)
-            {
-                throw Error.ArgumentNull(nameof(element));
-            }
-
-            if (string.IsNullOrWhiteSpace(name))
-            {
-                throw Error.ArgumentNullOrWhiteSpace(nameof(name));
-            }
+            Utils.CheckArgumentNull(element);
+            Utils.CheckArgumentNullOrEmpty(name);
 
             if (!name.StartsWith(OpenApiConstants.ExtensionFieldNamePrefix))
             {
                 throw new OpenApiException(string.Format(SRResource.ExtensionFieldNameMustBeginWithXDash, name));
             }
 
-            element.Extensions[name] = any ?? throw Error.ArgumentNull(nameof(any));
+            element.Extensions[name] = Utils.CheckArgumentNull(any);
         }
     }
 }
diff --git a/src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs b/src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs
@@ -78,10 +78,7 @@ public static void Serialize<T>(
             OpenApiWriterSettings settings)
             where T : IOpenApiSerializable
         {
-            if (stream == null)
-            {
-                throw Error.ArgumentNull(nameof(stream));
-            }
+            Utils.CheckArgumentNull(stream);
 
             var streamWriter = new FormattingStreamWriter(stream, CultureInfo.InvariantCulture);
 
@@ -105,15 +102,8 @@ public static void Serialize<T>(
         public static void Serialize<T>(this T element, IOpenApiWriter writer, OpenApiSpecVersion specVersion)
             where T : IOpenApiSerializable
         {
-            if (element == null)
-            {
-                throw Error.ArgumentNull(nameof(element));
-            }
-
-            if (writer == null)
-            {
-                throw Error.ArgumentNull(nameof(writer));
-            }
+            Utils.CheckArgumentNull(element);
+            Utils.CheckArgumentNull(writer);
 
             switch (specVersion)
             {
@@ -173,10 +163,7 @@ public static string Serialize<T>(
             OpenApiFormat format)
             where T : IOpenApiSerializable
         {
-            if (element == null)
-            {
-                throw Error.ArgumentNull(nameof(element));
-            }
+            Utils.CheckArgumentNull(element);
 
             using var stream = new MemoryStream();
             element.Serialize(stream, specVersion, format);

diff --git a/src/Microsoft.OpenApi/Models/OpenApiCallback.cs b/src/Microsoft.OpenApi/Models/OpenApiCallback.cs
@@ -57,15 +57,8 @@ public OpenApiCallback(OpenApiCallback callback)
         /// <param name="pathItem">The path item.</param>
         public void AddPathItem(RuntimeExpression expression, OpenApiPathItem pathItem)
         {
-            if (expression == null)
-            {
-                throw Error.ArgumentNull(nameof(expression));
-            }
-
-            if (pathItem == null)
-            {
-                throw Error.ArgumentNull(nameof(pathItem));
-            }
+            Utils.CheckArgumentNull(expression);
+            Utils.CheckArgumentNull(pathItem);
 
             if (PathItems == null)
             {
@@ -80,10 +73,7 @@ public void AddPathItem(RuntimeExpression expression, OpenApiPathItem pathItem)
         /// </summary>
         public void SerializeAsV3(IOpenApiWriter writer)
         {
-            if (writer == null)
-            {
-                throw Error.ArgumentNull(nameof(writer));
-            }
+            Utils.CheckArgumentNull(writer);
 
             var target = this;
 

diff --git a/src/Microsoft.OpenApi/Models/OpenApiComponents.cs b/src/Microsoft.OpenApi/Models/OpenApiComponents.cs
@@ -93,10 +93,7 @@ public OpenApiComponents(OpenApiComponents components)
         /// </summary>
         public void SerializeAsV3(IOpenApiWriter writer)
         {
-            if (writer == null)
-            {
-                throw Error.ArgumentNull(nameof(writer));
-            }
+            Utils.CheckArgumentNull(writer);
 
             // If references have been inlined we don't need the to render the components section
             // however if they have cycles, then we will need a component rendered

diff --git a/src/Microsoft.OpenApi/Models/OpenApiContact.cs b/src/Microsoft.OpenApi/Models/OpenApiContact.cs
@@ -68,10 +68,7 @@ public void SerializeAsV2(IOpenApiWriter writer)
 
         private void WriteInternal(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
         {
-            if (writer == null)
-            {
-                throw Error.ArgumentNull(nameof(writer));
-            }
+            Utils.CheckArgumentNull(writer);
 
             writer.WriteStartObject();
 

diff --git a/src/Microsoft.OpenApi/Models/OpenApiDiscriminator.cs b/src/Microsoft.OpenApi/Models/OpenApiDiscriminator.cs
@@ -41,10 +41,7 @@ public OpenApiDiscriminator(OpenApiDiscriminator discriminator)
         /// </summary>
         public void SerializeAsV3(IOpenApiWriter writer)
         {
-            if (writer == null)
-            {
-                throw Error.ArgumentNull(nameof(writer));
-            }
+            Utils.CheckArgumentNull(writer);
 
             writer.WriteStartObject();
 

diff --git a/src/Microsoft.OpenApi/Models/OpenApiDocument.cs b/src/Microsoft.OpenApi/Models/OpenApiDocument.cs
@@ -96,10 +96,7 @@ public OpenApiDocument(OpenApiDocument document)
         /// </summary>
         public void SerializeAsV3(IOpenApiWriter writer)
         {
-            if (writer == null)
-            {
-                throw Error.ArgumentNull(nameof(writer));
-            }
+            Utils.CheckArgumentNull(writer);
 
             writer.WriteStartObject();
 
@@ -141,10 +138,7 @@ public void SerializeAsV3(IOpenApiWriter writer)
         /// </summary>
         public void SerializeAsV2(IOpenApiWriter writer)
         {
-            if (writer == null)
-            {
-                throw Error.ArgumentNull(nameof(writer));
-            }
+            Utils.CheckArgumentNull(writer);
 
             writer.WriteStartObject();
 

diff --git a/src/Microsoft.OpenApi/Models/OpenApiEncoding.cs b/src/Microsoft.OpenApi/Models/OpenApiEncoding.cs
@@ -75,10 +75,7 @@ public OpenApiEncoding(OpenApiEncoding encoding)
         /// </summary>
         public void SerializeAsV3(IOpenApiWriter writer)
         {
-            if (writer == null)
-            {
-                throw Error.ArgumentNull("writer");
-            }
+            Utils.CheckArgumentNull(writer);
 
             writer.WriteStartObject();
 

diff --git a/src/Microsoft.OpenApi/Models/OpenApiExample.cs b/src/Microsoft.OpenApi/Models/OpenApiExample.cs
@@ -78,10 +78,7 @@ public OpenApiExample(OpenApiExample example)
         /// </summary>
         public void SerializeAsV3(IOpenApiWriter writer)
         {
-            if (writer == null)
-            {
-                throw Error.ArgumentNull(nameof(writer));
-            }
+            Utils.CheckArgumentNull(writer);
 
             var target = this;