Review/update ArgumentGuard usages:

bkoelman · bkoelman · commit 2cd419060223 · 2024-09-21T15:57:43.000+02:00
- Logger category name can consist of whitespace
- Assembly/type/member name can NOT consist of whitespace
- JSON:API field name can NOT consist of whitespace
diff --git a/src/Examples/DapperExample/TranslationToSql/Builders/DeleteOneToOneStatementBuilder.cs b/src/Examples/DapperExample/TranslationToSql/Builders/DeleteOneToOneStatementBuilder.cs
@@ -11,7 +11,7 @@ internal sealed class DeleteOneToOneStatementBuilder(IDataModelService dataModel
     public DeleteNode Build(ResourceType resourceType, string whereColumnName, object? whereValue)
     {
         ArgumentGuard.NotNull(resourceType);
-        ArgumentGuard.NotNull(whereColumnName);
+        ArgumentGuard.NotNullNorEmpty(whereColumnName);
 
         ResetState();
 
diff --git a/src/Examples/DapperExample/TranslationToSql/Builders/UpdateClearOneToOneStatementBuilder.cs b/src/Examples/DapperExample/TranslationToSql/Builders/UpdateClearOneToOneStatementBuilder.cs
@@ -11,8 +11,8 @@ internal sealed class UpdateClearOneToOneStatementBuilder(IDataModelService data
     public UpdateNode Build(ResourceType resourceType, string setColumnName, string whereColumnName, object? whereValue)
     {
         ArgumentGuard.NotNull(resourceType);
-        ArgumentGuard.NotNull(setColumnName);
-        ArgumentGuard.NotNull(whereColumnName);
+        ArgumentGuard.NotNullNorEmpty(setColumnName);
+        ArgumentGuard.NotNullNorEmpty(whereColumnName);
 
         ResetState();
 
diff --git a/src/Examples/DapperExample/TranslationToSql/TreeNodes/ParameterNode.cs b/src/Examples/DapperExample/TranslationToSql/TreeNodes/ParameterNode.cs
@@ -16,7 +16,7 @@ internal sealed class ParameterNode : SqlValueNode
 
     public ParameterNode(string name, object? value)
     {
-        ArgumentGuard.NotNull(name);
+        ArgumentGuard.NotNullNorEmpty(name);
 
         if (!name.StartsWith('@') || name.Length < 2)
         {
diff --git a/src/JsonApiDotNetCore.Annotations/ArgumentGuard.cs b/src/JsonApiDotNetCore.Annotations/ArgumentGuard.cs
@@ -30,11 +30,30 @@ public static void NotNullNorEmpty<T>([SysNotNull] IEnumerable<T>? value, [Calle
     [AssertionMethod]
     public static void NotNullNorEmpty([SysNotNull] string? value, [CallerArgumentExpression(nameof(value))] string? parameterName = null)
     {
+#if !NET6_0
+        ArgumentException.ThrowIfNullOrEmpty(value, parameterName);
+#else
         ArgumentNullException.ThrowIfNull(value, parameterName);
 
         if (value.Length == 0)
         {
             throw new ArgumentException("String cannot be null or empty.", parameterName);
         }
+#endif
+    }
+
+    [AssertionMethod]
+    public static void NotNullNorWhitespace([SysNotNull] string? value, [CallerArgumentExpression(nameof(value))] string? parameterName = null)
+    {
+#if !NET6_0
+        ArgumentException.ThrowIfNullOrWhiteSpace(value, parameterName);
+#else
+        ArgumentNullException.ThrowIfNull(value, parameterName);
+
+        if (string.IsNullOrWhiteSpace(value))
+        {
+            throw new ArgumentException("String cannot be null, empty, or whitespace.", parameterName);
+        }
+#endif
     }
 }
diff --git a/src/JsonApiDotNetCore.Annotations/Configuration/ResourceType.cs b/src/JsonApiDotNetCore.Annotations/Configuration/ResourceType.cs
@@ -111,7 +111,7 @@ public ResourceType(string publicName, ClientIdGenerationMode? clientIdGeneratio
         IReadOnlyCollection<EagerLoadAttribute>? eagerLoads, LinkTypes topLevelLinks = LinkTypes.NotConfigured,
         LinkTypes resourceLinks = LinkTypes.NotConfigured, LinkTypes relationshipLinks = LinkTypes.NotConfigured)
     {
-        ArgumentGuard.NotNullNorEmpty(publicName);
+        ArgumentGuard.NotNullNorWhitespace(publicName);
         ArgumentGuard.NotNull(clrType);
         ArgumentGuard.NotNull(identityClrType);
 
diff --git a/src/JsonApiDotNetCore/Errors/MissingResourceInRelationship.cs b/src/JsonApiDotNetCore/Errors/MissingResourceInRelationship.cs
@@ -11,9 +11,9 @@ public sealed class MissingResourceInRelationship
 
     public MissingResourceInRelationship(string relationshipName, string resourceType, string resourceId)
     {
-        ArgumentGuard.NotNullNorEmpty(relationshipName);
-        ArgumentGuard.NotNullNorEmpty(resourceType);
-        ArgumentGuard.NotNullNorEmpty(resourceId);
+        ArgumentGuard.NotNull(relationshipName);
+        ArgumentGuard.NotNull(resourceType);
+        ArgumentGuard.NotNull(resourceId);
 
         RelationshipName = relationshipName;
         ResourceType = resourceType;
diff --git a/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs b/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs
@@ -179,7 +179,7 @@ protected virtual NotExpression ParseNot()
 
     protected virtual LogicalExpression ParseLogical(string operatorName)
     {
-        ArgumentGuard.NotNull(operatorName);
+        ArgumentGuard.NotNullNorEmpty(operatorName);
 
         EatText(operatorName);
         EatSingleCharacterToken(TokenKind.OpenParen);
@@ -210,7 +210,7 @@ protected virtual LogicalExpression ParseLogical(string operatorName)
 
     protected virtual ComparisonExpression ParseComparison(string operatorName)
     {
-        ArgumentGuard.NotNull(operatorName);
+        ArgumentGuard.NotNullNorEmpty(operatorName);
 
         var comparisonOperator = Enum.Parse<ComparisonOperator>(operatorName.Pascalize());
 
@@ -315,7 +315,7 @@ private QueryExpression ParseTypedComparisonRightTerm(Type leftType, ConstantVal
 
     protected virtual MatchTextExpression ParseTextMatch(string operatorName)
     {
-        ArgumentGuard.NotNull(operatorName);
+        ArgumentGuard.NotNullNorEmpty(operatorName);
 
         EatText(operatorName);
         EatSingleCharacterToken(TokenKind.OpenParen);
diff --git a/src/JsonApiDotNetCore/QueryStrings/IncludeQueryStringParameterReader.cs b/src/JsonApiDotNetCore/QueryStrings/IncludeQueryStringParameterReader.cs
@@ -39,6 +39,8 @@ public virtual bool IsEnabled(DisableQueryStringAttribute disableQueryStringAttr
     /// <inheritdoc />
     public virtual bool CanRead(string parameterName)
     {
+        ArgumentGuard.NotNullNorEmpty(parameterName);
+
         return parameterName == "include";
     }
 
diff --git a/src/JsonApiDotNetCore/QueryStrings/PaginationQueryStringParameterReader.cs b/src/JsonApiDotNetCore/QueryStrings/PaginationQueryStringParameterReader.cs
@@ -49,6 +49,8 @@ public virtual bool IsEnabled(DisableQueryStringAttribute disableQueryStringAttr
     /// <inheritdoc />
     public virtual bool CanRead(string parameterName)
     {
+        ArgumentGuard.NotNullNorEmpty(parameterName);
+
         return parameterName is PageSizeParameterName or PageNumberParameterName;
     }
 
diff --git a/src/JsonApiDotNetCore/QueryStrings/ResourceDefinitionQueryableParameterReader.cs b/src/JsonApiDotNetCore/QueryStrings/ResourceDefinitionQueryableParameterReader.cs
@@ -37,6 +37,8 @@ public virtual bool IsEnabled(DisableQueryStringAttribute disableQueryStringAttr
     /// <inheritdoc />
     public virtual bool CanRead(string parameterName)
     {
+        ArgumentGuard.NotNullNorEmpty(parameterName);
+
         if (_request.Kind == EndpointKind.AtomicOperations)
         {
             return false;
diff --git a/src/JsonApiDotNetCore/Serialization/Request/Adapters/RequestAdapterPosition.cs b/src/JsonApiDotNetCore/Serialization/Request/Adapters/RequestAdapterPosition.cs
@@ -21,7 +21,7 @@ public RequestAdapterPosition()
 
     public IDisposable PushElement(string name)
     {
-        ArgumentGuard.NotNullNorEmpty(name);
+        ArgumentGuard.NotNullNorWhitespace(name);
 
         _stack.Push($"/{name}");
         return _disposable;
diff --git a/src/JsonApiDotNetCore/Serialization/Request/JsonInvalidAttributeInfo.cs b/src/JsonApiDotNetCore/Serialization/Request/JsonInvalidAttributeInfo.cs
@@ -16,7 +16,7 @@ internal sealed class JsonInvalidAttributeInfo
 
     public JsonInvalidAttributeInfo(string attributeName, Type attributeType, string? jsonValue, JsonValueKind jsonType)
     {
-        ArgumentGuard.NotNullNorEmpty(attributeName);
+        ArgumentGuard.NotNull(attributeName);
         ArgumentGuard.NotNull(attributeType);
 
         AttributeName = attributeName;
diff --git a/test/TestBuildingBlocks/CapturingLoggerProvider.cs b/test/TestBuildingBlocks/CapturingLoggerProvider.cs
@@ -32,7 +32,7 @@ public CapturingLoggerProvider(Func<string, LogLevel, bool> filter)
 
     public ILogger CreateLogger(string categoryName)
     {
-        ArgumentGuard.NotNull(categoryName);
+        ArgumentGuard.NotNullNorEmpty(categoryName);
 
         return new CapturingLogger(this, categoryName, _filter);
     }
diff --git a/test/TestBuildingBlocks/XUnitLoggerProvider.cs b/test/TestBuildingBlocks/XUnitLoggerProvider.cs
@@ -24,7 +24,7 @@ public XUnitLoggerProvider(ITestOutputHelper testOutputHelper, string? categoryP
 
     public ILogger CreateLogger(string categoryName)
     {
-        ArgumentGuard.NotNull(categoryName);
+        ArgumentGuard.NotNullNorEmpty(categoryName);
 
         if (_categoryPrefixFilter == null || categoryName.StartsWith(_categoryPrefixFilter, StringComparison.Ordinal))
         {

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ internal sealed class DeleteOneToOneStatementBuilder(IDataModelService dataModel`
`11`	`11`	`public DeleteNode Build(ResourceType resourceType, string whereColumnName, object? whereValue)`
`12`	`12`	`{`
`13`	`13`	`ArgumentGuard.NotNull(resourceType);`
`14`		`- ArgumentGuard.NotNull(whereColumnName);`
	`14`	`+ ArgumentGuard.NotNullNorEmpty(whereColumnName);`
`15`	`15`
`16`	`16`	`ResetState();`
`17`	`17`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@ internal sealed class UpdateClearOneToOneStatementBuilder(IDataModelService data`
`11`	`11`	`public UpdateNode Build(ResourceType resourceType, string setColumnName, string whereColumnName, object? whereValue)`
`12`	`12`	`{`
`13`	`13`	`ArgumentGuard.NotNull(resourceType);`
`14`		`- ArgumentGuard.NotNull(setColumnName);`
`15`		`- ArgumentGuard.NotNull(whereColumnName);`
	`14`	`+ ArgumentGuard.NotNullNorEmpty(setColumnName);`
	`15`	`+ ArgumentGuard.NotNullNorEmpty(whereColumnName);`
`16`	`16`
`17`	`17`	`ResetState();`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ internal sealed class ParameterNode : SqlValueNode`
`16`	`16`
`17`	`17`	`public ParameterNode(string name, object? value)`
`18`	`18`	`{`
`19`		`- ArgumentGuard.NotNull(name);`
	`19`	`+ ArgumentGuard.NotNullNorEmpty(name);`
`20`	`20`
`21`	`21`	`if (!name.StartsWith('@') \|\| name.Length < 2)`
`22`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ public ResourceType(string publicName, ClientIdGenerationMode? clientIdGeneratio`
`111`	`111`	`IReadOnlyCollection<EagerLoadAttribute>? eagerLoads, LinkTypes topLevelLinks = LinkTypes.NotConfigured,`
`112`	`112`	`LinkTypes resourceLinks = LinkTypes.NotConfigured, LinkTypes relationshipLinks = LinkTypes.NotConfigured)`
`113`	`113`	`{`
`114`		`- ArgumentGuard.NotNullNorEmpty(publicName);`
	`114`	`+ ArgumentGuard.NotNullNorWhitespace(publicName);`
`115`	`115`	`ArgumentGuard.NotNull(clrType);`
`116`	`116`	`ArgumentGuard.NotNull(identityClrType);`
`117`	`117`
Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ protected virtual NotExpression ParseNot()`
`179`	`179`
`180`	`180`	`protected virtual LogicalExpression ParseLogical(string operatorName)`
`181`	`181`	`{`
`182`		`- ArgumentGuard.NotNull(operatorName);`
	`182`	`+ ArgumentGuard.NotNullNorEmpty(operatorName);`
`183`	`183`
`184`	`184`	`EatText(operatorName);`
`185`	`185`	`EatSingleCharacterToken(TokenKind.OpenParen);`
`@@ -210,7 +210,7 @@ protected virtual LogicalExpression ParseLogical(string operatorName)`
`210`	`210`
`211`	`211`	`protected virtual ComparisonExpression ParseComparison(string operatorName)`
`212`	`212`	`{`
`213`		`- ArgumentGuard.NotNull(operatorName);`
	`213`	`+ ArgumentGuard.NotNullNorEmpty(operatorName);`
`214`	`214`
`215`	`215`	`var comparisonOperator = Enum.Parse<ComparisonOperator>(operatorName.Pascalize());`
`216`	`216`
`@@ -315,7 +315,7 @@ private QueryExpression ParseTypedComparisonRightTerm(Type leftType, ConstantVal`
`315`	`315`
`316`	`316`	`protected virtual MatchTextExpression ParseTextMatch(string operatorName)`
`317`	`317`	`{`
`318`		`- ArgumentGuard.NotNull(operatorName);`
	`318`	`+ ArgumentGuard.NotNullNorEmpty(operatorName);`
`319`	`319`
`320`	`320`	`EatText(operatorName);`
`321`	`321`	`EatSingleCharacterToken(TokenKind.OpenParen);`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,8 @@ public virtual bool IsEnabled(DisableQueryStringAttribute disableQueryStringAttr`
`39`	`39`	`/// <inheritdoc />`
`40`	`40`	`public virtual bool CanRead(string parameterName)`
`41`	`41`	`{`
	`42`	`+ ArgumentGuard.NotNullNorEmpty(parameterName);`
	`43`	`+`
`42`	`44`	`return parameterName == "include";`
`43`	`45`	`}`
`44`	`46`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,8 @@ public virtual bool IsEnabled(DisableQueryStringAttribute disableQueryStringAttr`
`49`	`49`	`/// <inheritdoc />`
`50`	`50`	`public virtual bool CanRead(string parameterName)`
`51`	`51`	`{`
	`52`	`+ ArgumentGuard.NotNullNorEmpty(parameterName);`
	`53`	`+`
`52`	`54`	`return parameterName is PageSizeParameterName or PageNumberParameterName;`
`53`	`55`	`}`
`54`	`56`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,8 @@ public virtual bool IsEnabled(DisableQueryStringAttribute disableQueryStringAttr`
`37`	`37`	`/// <inheritdoc />`
`38`	`38`	`public virtual bool CanRead(string parameterName)`
`39`	`39`	`{`
	`40`	`+ ArgumentGuard.NotNullNorEmpty(parameterName);`
	`41`	`+`
`40`	`42`	`if (_request.Kind == EndpointKind.AtomicOperations)`
`41`	`43`	`{`
`42`	`44`	`return false;`