Use ArgumentException.ThrowIfNullOrEmpty and ThrowIfNullOrWhitespace (#…

…52897)
dotnet · Jan 20, 2024 · 6372a53 · 6372a53
1 parent 15a4a77
commit 6372a53
Show file tree

Hide file tree

Showing 93 changed files with 450 additions and 872 deletions.
diff --git a/src/Caching/SqlServer/src/Microsoft.Extensions.Caching.SqlServer.csproj b/src/Caching/SqlServer/src/Microsoft.Extensions.Caching.SqlServer.csproj
@@ -24,6 +24,7 @@
 
   <ItemGroup>
     <Compile Include="$(SharedSourceRoot)ThrowHelpers\ArgumentNullThrowHelper.cs" LinkBase="Shared" />
+    <Compile Include="$(SharedSourceRoot)ThrowHelpers\ArgumentThrowHelper.cs" LinkBase="Shared" />
     <Compile Include="$(SharedSourceRoot)CallerArgument\CallerArgumentExpressionAttribute.cs" LinkBase="Shared" />
   </ItemGroup>
 

diff --git a/src/Caching/SqlServer/src/SqlServerCache.cs b/src/Caching/SqlServer/src/SqlServerCache.cs
@@ -35,21 +35,10 @@ public SqlServerCache(IOptions<SqlServerCacheOptions> options)
     {
         var cacheOptions = options.Value;
 
-        if (string.IsNullOrEmpty(cacheOptions.ConnectionString))
-        {
-            throw new ArgumentException(
-                $"{nameof(SqlServerCacheOptions.ConnectionString)} cannot be empty or null.");
-        }
-        if (string.IsNullOrEmpty(cacheOptions.SchemaName))
-        {
-            throw new ArgumentException(
-                $"{nameof(SqlServerCacheOptions.SchemaName)} cannot be empty or null.");
-        }
-        if (string.IsNullOrEmpty(cacheOptions.TableName))
-        {
-            throw new ArgumentException(
-                $"{nameof(SqlServerCacheOptions.TableName)} cannot be empty or null.");
-        }
+        ArgumentThrowHelper.ThrowIfNullOrEmpty(cacheOptions.ConnectionString);
+        ArgumentThrowHelper.ThrowIfNullOrEmpty(cacheOptions.SchemaName);
+        ArgumentThrowHelper.ThrowIfNullOrEmpty(cacheOptions.TableName);
+
         if (cacheOptions.ExpiredItemsDeletionInterval.HasValue &&
             cacheOptions.ExpiredItemsDeletionInterval.Value < MinimumExpiredItemsDeletionInterval)
         {

diff --git a/src/Components/Components/src/Routing/Resources.resx b/src/Components/Components/src/Routing/Resources.resx
@@ -159,9 +159,6 @@
   <data name="ArgumentMustBeGreaterThanOrEqualTo" xml:space="preserve">
     <value>Value must be greater than or equal to {0}.</value>
   </data>
-  <data name="Argument_NullOrEmpty" xml:space="preserve">
-    <value>Value cannot be null or empty.</value>
-  </data>
   <data name="TemplateRoute_CannotHaveCatchAllInMultiSegment" xml:space="preserve">
     <value>A path segment that contains more than one section, such as a literal section or a parameter, cannot contain a catch-all parameter.</value>
   </data>

diff --git a/src/Components/Server/src/ProtectedBrowserStorage/ProtectedBrowserStorage.cs b/src/Components/Server/src/ProtectedBrowserStorage/ProtectedBrowserStorage.cs
@@ -33,10 +33,7 @@ private protected ProtectedBrowserStorage(string storeName, IJSRuntime jsRuntime
             throw new PlatformNotSupportedException($"{GetType()} cannot be used when running in a browser.");
         }
 
-        if (string.IsNullOrEmpty(storeName))
-        {
-            throw new ArgumentException("The value cannot be null or empty", nameof(storeName));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(storeName);
 
         _storeName = storeName;
         _jsRuntime = jsRuntime ?? throw new ArgumentNullException(nameof(jsRuntime));
@@ -71,15 +68,8 @@ public ValueTask SetAsync(string key, object value)
     /// <returns>A <see cref="ValueTask"/> representing the completion of the operation.</returns>
     public ValueTask SetAsync(string purpose, string key, object value)
     {
-        if (string.IsNullOrEmpty(purpose))
-        {
-            throw new ArgumentException("Cannot be null or empty", nameof(purpose));
-        }
-
-        if (string.IsNullOrEmpty(key))
-        {
-            throw new ArgumentException("Cannot be null or empty", nameof(key));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(purpose);
+        ArgumentException.ThrowIfNullOrEmpty(key);
 
         return SetProtectedJsonAsync(key, Protect(purpose, value));
     }

diff --git a/src/Components/Web/src/JSComponents/JSComponentConfigurationStore.cs b/src/Components/Web/src/JSComponents/JSComponentConfigurationStore.cs
@@ -56,10 +56,7 @@ internal void Add([DynamicallyAccessedMembers(LinkerFlags.Component)] Type compo
     {
         Add(componentType, identifier);
 
-        if (string.IsNullOrEmpty(javaScriptInitializer))
-        {
-            throw new ArgumentException($"'{nameof(javaScriptInitializer)}' cannot be null or empty.", nameof(javaScriptInitializer));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(javaScriptInitializer);
 
         // Since it has a JS initializer, prepare the metadata we'll supply to JS code
         if (!JSComponentIdentifiersByInitializer.TryGetValue(javaScriptInitializer, out var identifiersForInitializer))

diff --git a/src/FileProviders/Embedded/src/Manifest/ManifestDirectory.cs b/src/FileProviders/Embedded/src/Manifest/ManifestDirectory.cs
@@ -47,11 +47,7 @@ public override ManifestEntry Traverse(StringSegment segment)
 
     public static ManifestDirectory CreateDirectory(string name, ManifestEntry[] children)
     {
-        if (string.IsNullOrWhiteSpace(name))
-        {
-            throw new ArgumentException($"'{nameof(name)}' must not be null, empty or whitespace.", nameof(name));
-        }
-
+        ArgumentThrowHelper.ThrowIfNullOrWhiteSpace(name);
         ArgumentNullThrowHelper.ThrowIfNull(children);
 
         var result = new ManifestDirectory(name, children);

diff --git a/src/FileProviders/Embedded/src/Manifest/ManifestFile.cs b/src/FileProviders/Embedded/src/Manifest/ManifestFile.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
+using Microsoft.AspNetCore.Shared;
 using Microsoft.Extensions.Primitives;
 
 namespace Microsoft.Extensions.FileProviders.Embedded.Manifest;
@@ -11,15 +12,8 @@ internal sealed class ManifestFile : ManifestEntry
     public ManifestFile(string name, string resourcePath)
         : base(name)
     {
-        if (string.IsNullOrWhiteSpace(name))
-        {
-            throw new ArgumentException($"'{nameof(name)}' must not be null, empty or whitespace.", nameof(name));
-        }
-
-        if (string.IsNullOrWhiteSpace(resourcePath))
-        {
-            throw new ArgumentException($"'{nameof(resourcePath)}' must not be null, empty or whitespace.", nameof(resourcePath));
-        }
+        ArgumentThrowHelper.ThrowIfNullOrWhiteSpace(name);
+        ArgumentThrowHelper.ThrowIfNullOrWhiteSpace(resourcePath);
 
         ResourcePath = resourcePath;
     }

diff --git a/src/FileProviders/Embedded/src/Microsoft.Extensions.FileProviders.Embedded.csproj b/src/FileProviders/Embedded/src/Microsoft.Extensions.FileProviders.Embedded.csproj
@@ -41,6 +41,7 @@
 
   <ItemGroup>
     <Compile Include="$(SharedSourceRoot)ThrowHelpers\ArgumentNullThrowHelper.cs" LinkBase="Shared" />
+    <Compile Include="$(SharedSourceRoot)ThrowHelpers\ArgumentThrowHelper.cs" LinkBase="Shared" />
     <Compile Include="$(SharedSourceRoot)CallerArgument\CallerArgumentExpressionAttribute.cs" LinkBase="Shared" />
     <Compile Include="$(SharedSourceRoot)TrimmingAttributes.cs" LinkBase="Shared"
              Condition="'$(TargetFramework)' != '$(DefaultNetCoreTargetFramework)'" />

diff --git a/src/Hosting/Hosting/src/Internal/HostingEnvironmentExtensions.cs b/src/Hosting/Hosting/src/Internal/HostingEnvironmentExtensions.cs
@@ -13,10 +13,7 @@ internal static void Initialize(this IHostingEnvironment hostingEnvironment, str
 #pragma warning restore CS0618 // Type or member is obsolete
     {
         ArgumentNullException.ThrowIfNull(options);
-        if (string.IsNullOrEmpty(contentRootPath))
-        {
-            throw new ArgumentException("A valid non-empty content root must be provided.", nameof(contentRootPath));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(contentRootPath);
         if (!Directory.Exists(contentRootPath))
         {
             throw new ArgumentException($"The content root '{contentRootPath}' does not exist.", nameof(contentRootPath));
@@ -67,10 +64,7 @@ internal static void Initialize(
         IHostEnvironment? baseEnvironment = null)
     {
         ArgumentNullException.ThrowIfNull(options);
-        if (string.IsNullOrEmpty(contentRootPath))
-        {
-            throw new ArgumentException("A valid non-empty content root must be provided.", nameof(contentRootPath));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(contentRootPath);
         if (!Directory.Exists(contentRootPath))
         {
             throw new ArgumentException($"The content root '{contentRootPath}' does not exist.", nameof(contentRootPath));

diff --git a/src/Hosting/Server.IntegrationTesting/src/Common/DeploymentParameters.cs b/src/Hosting/Server.IntegrationTesting/src/Common/DeploymentParameters.cs
@@ -52,10 +52,7 @@ public DeploymentParameters(
         RuntimeFlavor runtimeFlavor,
         RuntimeArchitecture runtimeArchitecture)
     {
-        if (string.IsNullOrEmpty(applicationPath))
-        {
-            throw new ArgumentException("Value cannot be null.", nameof(applicationPath));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(applicationPath);
 
         if (!Directory.Exists(applicationPath))
         {

diff --git a/src/Hosting/Server.IntegrationTesting/src/Deployers/ApplicationDeployer.cs b/src/Hosting/Server.IntegrationTesting/src/Deployers/ApplicationDeployer.cs
@@ -41,10 +41,7 @@ private void ValidateParameters()
 
         if (DeploymentParameters.ApplicationPublisher == null)
         {
-            if (string.IsNullOrEmpty(DeploymentParameters.ApplicationPath))
-            {
-                throw new ArgumentException("ApplicationPath cannot be null.");
-            }
+            ArgumentException.ThrowIfNullOrEmpty(DeploymentParameters.ApplicationPath);
 
             if (!Directory.Exists(DeploymentParameters.ApplicationPath))
             {

diff --git a/src/Http/Http.Results/src/TypedResults.cs b/src/Http/Http.Results/src/TypedResults.cs
@@ -511,10 +511,7 @@ public static PhysicalFileHttpResult PhysicalFile(
         EntityTagHeaderValue? entityTag = null,
         bool enableRangeProcessing = false)
     {
-        if (string.IsNullOrEmpty(path))
-        {
-            throw new ArgumentException("Argument cannot be null or empty", nameof(path));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(path);
 
         return new(path, contentType)
         {
@@ -547,10 +544,7 @@ public static VirtualFileHttpResult VirtualFile(
         EntityTagHeaderValue? entityTag = null,
         bool enableRangeProcessing = false)
     {
-        if (string.IsNullOrEmpty(path))
-        {
-            throw new ArgumentException("Argument cannot be null or empty", nameof(path));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(path);
 
         return new(path, contentType)
         {
@@ -576,10 +570,7 @@ public static VirtualFileHttpResult VirtualFile(
     /// <returns>The created <see cref="RedirectHttpResult"/> for the response.</returns>
     public static RedirectHttpResult Redirect([StringSyntax(StringSyntaxAttribute.Uri)] string url, bool permanent = false, bool preserveMethod = false)
     {
-        if (string.IsNullOrEmpty(url))
-        {
-            throw new ArgumentException("Argument cannot be null or empty", nameof(url));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(url);
 
         return new(url, permanent, preserveMethod);
     }
@@ -599,10 +590,7 @@ public static RedirectHttpResult Redirect([StringSyntax(StringSyntaxAttribute.Ur
     /// <returns>The created <see cref="RedirectHttpResult"/> for the response.</returns>
     public static RedirectHttpResult LocalRedirect([StringSyntax(StringSyntaxAttribute.Uri, UriKind.Relative)] string localUrl, bool permanent = false, bool preserveMethod = false)
     {
-        if (string.IsNullOrEmpty(localUrl))
-        {
-            throw new ArgumentException("Argument cannot be null or empty", nameof(localUrl));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(localUrl);
 
         return new(localUrl, acceptLocalUrlOnly: true, permanent, preserveMethod);
     }
@@ -837,7 +825,7 @@ public static ValidationProblem ValidationProblem(
 
     /// <summary>
     /// Produces a <see cref="StatusCodes.Status201Created"/> response.
-    /// </summary>   
+    /// </summary>
     /// <returns>The created <see cref="HttpResults.Created"/> for the response.</returns>
     public static Created Created()
     {

diff --git a/src/Http/Http.Results/test/ResultsTests.cs b/src/Http/Http.Results/test/ResultsTests.cs
@@ -666,7 +666,7 @@ public void Created_WithNullStringUriAndValue_SetsLocationNull()
         //Arrange
         object value = new { };
 
-        // Act        
+        // Act
         var result = Results.Created(default(string), value) as Created<object>;
 
         //Assert
@@ -680,7 +680,7 @@ public void Created_WithEmptyStringUriAndValue_SetsLocationEmpty()
         //Arrange
         object value = new { };
 
-        // Act        
+        // Act
         var result = Results.Created(string.Empty, value) as Created<object>;
 
         //Assert
@@ -694,7 +694,7 @@ public void Created_WithNullUriAndValue_SetsLocationNull()
         //Arrange
         object value = new { };
 
-        // Act       
+        // Act
         var result = Results.Created(default(Uri), value) as Created<object>;
 
         //Assert
@@ -895,7 +895,7 @@ public void Json_WithAllArgs_ResultHasCorrectValues()
         var options = new JsonSerializerOptions();
         var contentType = "application/custom+json";
         var statusCode = StatusCodes.Status208AlreadyReported;
-            
+
         // Act
         var result = Results.Json(data, options, contentType, statusCode) as JsonHttpResult<object>;
 
@@ -1035,7 +1035,7 @@ public void JsonOfT_WithNullTypeInfo_ThrowsArgException()
     [Fact]
     public void LocalRedirect_WithNullStringUrl_ThrowsArgException()
     {
-        Assert.Throws<ArgumentException>("localUrl", () => Results.LocalRedirect(default(string)));
+        Assert.Throws<ArgumentNullException>("localUrl", () => Results.LocalRedirect(default(string)));
     }
 
     [Fact]
@@ -1339,7 +1339,7 @@ public void ValidationProblem_WithValidationProblemArg_ResultHasCorrectValues()
     [Fact]
     public void Redirect_WithNullStringUrl_ThrowsArgException()
     {
-        Assert.Throws<ArgumentException>("url", () => Results.Redirect(default(string)));
+        Assert.Throws<ArgumentNullException>("url", () => Results.Redirect(default(string)));
     }
 
     [Fact]

diff --git a/src/Http/Http.Results/test/TypedResultsTests.cs b/src/Http/Http.Results/test/TypedResultsTests.cs
@@ -349,7 +349,7 @@ public void Stream_WithNullCallback_ThrowsArgNullException()
     [Fact]
     public void PhysicalFile_WithNullPath_ThrowsArgException()
     {
-        Assert.Throws<ArgumentException>("path", () => TypedResults.PhysicalFile(default(string)));
+        Assert.Throws<ArgumentNullException>("path", () => TypedResults.PhysicalFile(default(string)));
     }
 
     [Fact]
@@ -361,7 +361,7 @@ public void PhysicalFile_WithEmptyPath_ThrowsArgException()
     [Fact]
     public void VirtualFile_WithNullPath_ThrowsArgException()
     {
-        Assert.Throws<ArgumentException>("path", () => TypedResults.VirtualFile(default(string)));
+        Assert.Throws<ArgumentNullException>("path", () => TypedResults.VirtualFile(default(string)));
     }
 
     [Fact]
@@ -916,7 +916,7 @@ public void Json_WithNullTypeInfo_ThrowsArgException()
     [Fact]
     public void LocalRedirect_WithNullStringUrl_ThrowsArgException()
     {
-        Assert.Throws<ArgumentException>("localUrl", () => TypedResults.LocalRedirect(default(string)));
+        Assert.Throws<ArgumentNullException>("localUrl", () => TypedResults.LocalRedirect(default(string)));
     }
 
     [Fact]
@@ -1187,7 +1187,7 @@ public void ValidationProblem_WithValidationProblemArg_ResultHasCorrectValues()
     [Fact]
     public void Redirect_WithNullStringUrl_ThrowsArgException()
     {
-        Assert.Throws<ArgumentException>("url", () => TypedResults.Redirect(default(string)));
+        Assert.Throws<ArgumentNullException>("url", () => TypedResults.Redirect(default(string)));
     }
 
     [Fact]

diff --git a/src/Http/Routing/src/DefaultLinkGenerator.cs b/src/Http/Routing/src/DefaultLinkGenerator.cs
@@ -155,10 +155,7 @@ public DefaultLinkGenerator(
         FragmentString fragment = default,
         LinkOptions? options = null)
     {
-        if (string.IsNullOrEmpty(scheme))
-        {
-            throw new ArgumentException("A scheme must be provided.", nameof(scheme));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(scheme);
 
         if (!host.HasValue)
         {

diff --git a/src/Http/Routing/src/LinkGeneratorEndpointNameAddressExtensions.cs b/src/Http/Routing/src/LinkGeneratorEndpointNameAddressExtensions.cs
@@ -305,11 +305,7 @@ public static class LinkGeneratorEndpointNameAddressExtensions
     {
         ArgumentNullException.ThrowIfNull(generator);
         ArgumentNullException.ThrowIfNull(endpointName);
-
-        if (string.IsNullOrEmpty(scheme))
-        {
-            throw new ArgumentException("A scheme must be provided.", nameof(scheme));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(scheme);
 
         if (!host.HasValue)
         {
@@ -358,11 +354,7 @@ public static class LinkGeneratorEndpointNameAddressExtensions
     {
         ArgumentNullException.ThrowIfNull(generator);
         ArgumentNullException.ThrowIfNull(endpointName);
-
-        if (string.IsNullOrEmpty(scheme))
-        {
-            throw new ArgumentException("A scheme must be provided.", nameof(scheme));
-        }
+        ArgumentException.ThrowIfNullOrEmpty(scheme);
 
         if (!host.HasValue)
         {