Package updates

.config/dotnet-tools.json

@@ -3,13 +3,13 @@
   "isRoot": true,
   "tools": {
     "jetbrains.resharper.globaltools": {
-      "version": "2021.3.0",
+      "version": "2021.3.4",
       "commands": [
         "jb"
       ]
     },
     "regitlint": {
-      "version": "6.0.6",
+      "version": "6.0.8",
       "commands": [
         "regitlint"
       ]
@@ -21,7 +21,7 @@
       ]
     },
     "dotnet-reportgenerator-globaltool": {
-      "version": "5.0.0",
+      "version": "5.1.3",
       "commands": [
         "reportgenerator"
       ]

CodingGuidelines.ruleset

@@ -14,14 +14,15 @@
     <Rule Id="AV1555" Action="Warning" />
     <Rule Id="AV1564" Action="Info" />
     <Rule Id="AV1568" Action="Warning" />
+    <Rule Id="AV1580" Action="None" />
     <Rule Id="AV1706" Action="Warning" />
     <Rule Id="AV1710" Action="Info" />
     <Rule Id="AV1711" Action="Info" />
     <Rule Id="AV1738" Action="Warning" />
     <Rule Id="AV1739" Action="Warning" />
     <Rule Id="AV1745" Action="Warning" />
     <Rule Id="AV1755" Action="Warning" />
-    <Rule Id="AV2210" Action="None" />
+    <Rule Id="AV2210" Action="Warning" />
     <Rule Id="AV2220" Action="Warning" />
     <Rule Id="AV2230" Action="Info" />
     <Rule Id="AV2305" Action="None" />

Directory.Build.props

@@ -4,7 +4,7 @@
     <AspNetVersion>6.0.*</AspNetVersion>
     <EFCoreVersion>6.0.*</EFCoreVersion>
     <EFCorePostgresVersion>6.0.*</EFCorePostgresVersion>
-    <MicrosoftCodeAnalysisVersion>4.0.*</MicrosoftCodeAnalysisVersion>
+    <MicrosoftCodeAnalysisVersion>4.1.*</MicrosoftCodeAnalysisVersion>
     <HumanizerVersion>2.*</HumanizerVersion>
     <JsonApiDotNetCoreVersionPrefix>5.0.0</JsonApiDotNetCoreVersionPrefix>
     <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)CodingGuidelines.ruleset</CodeAnalysisRuleSet>
@@ -17,7 +17,7 @@
 
   <ItemGroup>
     <PackageReference Include="JetBrains.Annotations" Version="2021.3.0" PrivateAssets="All" />
-    <PackageReference Include="CSharpGuidelinesAnalyzer" Version="3.7.1" PrivateAssets="All" />
+    <PackageReference Include="CSharpGuidelinesAnalyzer" Version="3.8.0" PrivateAssets="All" />
     <AdditionalFiles Include="$(MSBuildThisFileDirectory)CSharpGuidelinesAnalyzer.config" Visible="False" />
   </ItemGroup>
 
@@ -27,10 +27,14 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)'=='Debug'">
+    <NoWarn>$(NoWarn);AV2210</NoWarn>
+  </PropertyGroup>
+
   <!-- Test Project Dependencies -->
   <PropertyGroup>
     <CoverletVersion>3.1.2</CoverletVersion>
-    <MoqVersion>4.16.1</MoqVersion>
+    <MoqVersion>4.17.2</MoqVersion>
     <TestSdkVersion>17.1.0</TestSdkVersion>
   </PropertyGroup>
 </Project>

benchmarks/Serialization/SerializationBenchmarkBase.cs

@@ -245,7 +245,7 @@ public RelationshipLinks GetRelationshipLinks(RelationshipAttribute relationship
 
     private sealed class FakeMetaBuilder : IMetaBuilder
     {
-        public void Add(IReadOnlyDictionary<string, object?> values)
+        public void Add(IDictionary<string, object?> values)
         {
         }
 

src/JsonApiDotNetCore.Annotations/ArgumentGuard.cs

@@ -18,13 +18,24 @@ public static void NotNull<T>([NoEnumeration] [SysNotNull] T? value, [InvokerPar
     }
 
     [AssertionMethod]
-    public static void NotNullNorEmpty<T>([SysNotNull] IEnumerable<T>? value, [InvokerParameterName] string name, string? collectionName = null)
+    public static void NotNullNorEmpty<T>([SysNotNull] IEnumerable<T>? value, [InvokerParameterName] string name)
     {
         NotNull(value, name);
 
         if (!value.Any())
         {
-            throw new ArgumentException($"Must have one or more {collectionName ?? name}.", name);
+            throw new ArgumentException($"Must have one or more {name}.", name);
+        }
+    }
+
+    [AssertionMethod]
+    public static void NotNullNorEmpty<T>([SysNotNull] IEnumerable<T>? value, [InvokerParameterName] string name, string collectionName)
+    {
+        NotNull(value, name);
+
+        if (!value.Any())
+        {
+            throw new ArgumentException($"Must have one or more {collectionName}.", name);
         }
     }
 

src/JsonApiDotNetCore.Annotations/CollectionConverter.cs

@@ -66,9 +66,19 @@ private Type ToConcreteCollectionType(Type collectionType)
     /// <summary>
     /// Returns a collection that contains zero, one or multiple resources, depending on the specified value.
     /// </summary>
-    public ICollection<IIdentifiable> ExtractResources(object? value)
+    public IReadOnlyCollection<IIdentifiable> ExtractResources(object? value)
     {
-        if (value is ICollection<IIdentifiable> resourceCollection)
+        if (value is List<IIdentifiable> resourceList)
+        {
+            return resourceList;
+        }
+
+        if (value is HashSet<IIdentifiable> resourceSet)
+        {
+            return resourceSet;
+        }
+
+        if (value is IReadOnlyCollection<IIdentifiable> resourceCollection)
         {
             return resourceCollection;
         }

src/JsonApiDotNetCore.Annotations/Configuration/ResourceType.cs

@@ -89,8 +89,14 @@ public sealed class ResourceType
     /// </remarks>
     public LinkTypes RelationshipLinks { get; }
 
-    public ResourceType(string publicName, Type clrType, Type identityClrType, IReadOnlyCollection<AttrAttribute>? attributes = null,
-        IReadOnlyCollection<RelationshipAttribute>? relationships = null, IReadOnlyCollection<EagerLoadAttribute>? eagerLoads = null,
+    public ResourceType(string publicName, Type clrType, Type identityClrType, LinkTypes topLevelLinks = LinkTypes.NotConfigured,
+        LinkTypes resourceLinks = LinkTypes.NotConfigured, LinkTypes relationshipLinks = LinkTypes.NotConfigured)
+        : this(publicName, clrType, identityClrType, null, null, null, topLevelLinks, resourceLinks, relationshipLinks)
+    {
+    }
+
+    public ResourceType(string publicName, Type clrType, Type identityClrType, IReadOnlyCollection<AttrAttribute>? attributes,
+        IReadOnlyCollection<RelationshipAttribute>? relationships, IReadOnlyCollection<EagerLoadAttribute>? eagerLoads,
         LinkTypes topLevelLinks = LinkTypes.NotConfigured, LinkTypes resourceLinks = LinkTypes.NotConfigured,
         LinkTypes relationshipLinks = LinkTypes.NotConfigured)
     {

src/JsonApiDotNetCore.Annotations/ObjectExtensions.cs

@@ -1,4 +1,4 @@
-#pragma warning disable AV1130 // Return type in method signature should be a collection interface instead of a concrete type
+#pragma warning disable AV1130 // Return type in method signature should be an interface to an unchangeable collection
 
 namespace JsonApiDotNetCore;
 

src/JsonApiDotNetCore/ArrayFactory.cs

@@ -1,5 +1,5 @@
 #pragma warning disable AV1008 // Class should not be static
-#pragma warning disable AV1130 // Return type in method signature should be a collection interface instead of a concrete type
+#pragma warning disable AV1130 // Return type in method signature should be an interface to an unchangeable collection
 
 namespace JsonApiDotNetCore;
 

src/JsonApiDotNetCore/AtomicOperations/Processors/SetRelationshipProcessor.cs

@@ -40,7 +40,7 @@ public SetRelationshipProcessor(ISetRelationshipService<TResource, TId> service)
 
         if (relationship is HasManyAttribute)
         {
-            ICollection<IIdentifiable> rightResources = _collectionConverter.ExtractResources(rightValue);
+            IReadOnlyCollection<IIdentifiable> rightResources = _collectionConverter.ExtractResources(rightValue);
             return rightResources.ToHashSet(IdentifiableComparer.Instance);
         }
 

src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs

@@ -175,8 +175,10 @@ private static bool IsImplicitManyToManyJoinEntity(IEntityType entityType)
     /// The name under which the resource is publicly exposed by the API. If nothing is specified, the naming convention is applied on the pluralized CLR
     /// type name.
     /// </param>
+#pragma warning disable AV1553 // Do not use optional parameters with default value null for strings, collections or tasks
     public ResourceGraphBuilder Add<TResource, TId>(string? publicName = null)
         where TResource : class, IIdentifiable<TId>
+#pragma warning restore AV1553 // Do not use optional parameters with default value null for strings, collections or tasks
     {
         return Add(typeof(TResource), typeof(TId), publicName);
     }
@@ -194,7 +196,9 @@ public ResourceGraphBuilder Add<TResource, TId>(string? publicName = null)
     /// The name under which the resource is publicly exposed by the API. If nothing is specified, the naming convention is applied on the pluralized CLR
     /// type name.
     /// </param>
+#pragma warning disable AV1553 // Do not use optional parameters with default value null for strings, collections or tasks
     public ResourceGraphBuilder Add(Type resourceClrType, Type? idClrType = null, string? publicName = null)
+#pragma warning restore AV1553 // Do not use optional parameters with default value null for strings, collections or tasks
     {
         ArgumentGuard.NotNull(resourceClrType, nameof(resourceClrType));
 

src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs

@@ -6,6 +6,8 @@
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.DependencyInjection;
 
+#pragma warning disable AV1130 // Return type in method signature should be an interface to an unchangeable collection
+
 namespace JsonApiDotNetCore.Configuration;
 
 [PublicAPI]
@@ -16,9 +18,11 @@ public static class ServiceCollectionExtensions
     /// <summary>
     /// Configures JsonApiDotNetCore by registering resources manually.
     /// </summary>
+#pragma warning disable AV1553 // Do not use optional parameters with default value null for strings, collections or tasks
     public static IServiceCollection AddJsonApi(this IServiceCollection services, Action<JsonApiOptions>? options = null,
         Action<ServiceDiscoveryFacade>? discovery = null, Action<ResourceGraphBuilder>? resources = null, IMvcCoreBuilder? mvcBuilder = null,
         ICollection<Type>? dbContextTypes = null)
+#pragma warning restore AV1553 // Do not use optional parameters with default value null for strings, collections or tasks
     {
         ArgumentGuard.NotNull(services, nameof(services));
 

src/JsonApiDotNetCore/Diagnostics/CascadingCodeTimer.cs

@@ -32,7 +32,13 @@ static CascadingCodeTimer()
     }
 
     /// <inheritdoc />
-    public IDisposable Measure(string name, bool excludeInRelativeCost = false)
+    public IDisposable Measure(string name)
+    {
+        return Measure(name, false);
+    }
+
+    /// <inheritdoc />
+    public IDisposable Measure(string name, bool excludeInRelativeCost)
     {
         MeasureScope childScope = CreateChildScope(name, excludeInRelativeCost);
         _activeScopeStack.Push(childScope);

src/JsonApiDotNetCore/Diagnostics/DisabledCodeTimer.cs

@@ -11,7 +11,12 @@ private DisabledCodeTimer()
     {
     }
 
-    public IDisposable Measure(string name, bool excludeInRelativeCost = false)
+    public IDisposable Measure(string name)
+    {
+        return this;
+    }
+
+    public IDisposable Measure(string name, bool excludeInRelativeCost)
     {
         return this;
     }

src/JsonApiDotNetCore/Diagnostics/ICodeTimer.cs

@@ -5,6 +5,15 @@ namespace JsonApiDotNetCore.Diagnostics;
 /// </summary>
 public interface ICodeTimer : IDisposable
 {
+    /// <summary>
+    /// Starts recording the duration of a code block, while including this measurement in calculated percentages. Wrap this call in a <c>using</c>
+    /// statement, so the recording stops when the return value goes out of scope.
+    /// </summary>
+    /// <param name="name">
+    /// Description of what is being recorded.
+    /// </param>
+    IDisposable Measure(string name);
+
     /// <summary>
     /// Starts recording the duration of a code block. Wrap this call in a <c>using</c> statement, so the recording stops when the return value goes out of
     /// scope.
@@ -13,9 +22,9 @@ public interface ICodeTimer : IDisposable
     /// Description of what is being recorded.
     /// </param>
     /// <param name="excludeInRelativeCost">
-    /// When set, indicates to exclude this measurement in calculated percentages. <c>false</c> by default.
+    /// When set, indicates to exclude this measurement in calculated percentages.
     /// </param>
-    IDisposable Measure(string name, bool excludeInRelativeCost = false);
+    IDisposable Measure(string name, bool excludeInRelativeCost);
 
     /// <summary>
     /// Returns intermediate or final results.

src/JsonApiDotNetCore/Queries/Expressions/QueryableHandlerExpression.cs

@@ -21,8 +21,10 @@ public QueryableHandlerExpression(object queryableHandler, StringValues paramete
         _parameterValue = parameterValue;
     }
 
+#pragma warning disable AV1130 // Return type in method signature should be an interface to an unchangeable collection
     public IQueryable<TResource> Apply<TResource>(IQueryable<TResource> query)
         where TResource : class, IIdentifiable
+#pragma warning restore AV1130 // Return type in method signature should be an interface to an unchangeable collection
     {
         var handler = (Func<IQueryable<TResource>, StringValues, IQueryable<TResource>>)_queryableHandler;
         return handler(query, _parameterValue);

src/JsonApiDotNetCore/Queries/FieldSelection.cs

@@ -14,14 +14,14 @@ public sealed class FieldSelection : Dictionary<ResourceType, FieldSelectors>
 {
     public bool IsEmpty => Values.All(selectors => selectors.IsEmpty);
 
-    public ISet<ResourceType> GetResourceTypes()
+    public IReadOnlySet<ResourceType> GetResourceTypes()
     {
         return Keys.ToHashSet();
     }
 
-#pragma warning disable AV1130 // Return type in method signature should be a collection interface instead of a concrete type
+#pragma warning disable AV1130 // Return type in method signature should be an interface to an unchangeable collection
     public FieldSelectors GetOrCreateSelectors(ResourceType resourceType)
-#pragma warning restore AV1130 // Return type in method signature should be a collection interface instead of a concrete type
+#pragma warning restore AV1130 // Return type in method signature should be an interface to an unchangeable collection
     {
         ArgumentGuard.NotNull(resourceType, nameof(resourceType));
 

src/JsonApiDotNetCore/Queries/Internal/Parsing/Token.cs

@@ -8,9 +8,14 @@ public sealed class Token
     public TokenKind Kind { get; }
     public string? Value { get; }
 
-    public Token(TokenKind kind, string? value = null)
+    public Token(TokenKind kind)
     {
         Kind = kind;
+    }
+
+    public Token(TokenKind kind, string value)
+        : this(kind)
+    {
         Value = value;
     }
 

src/JsonApiDotNetCore/Queries/Internal/QueryLayerComposer.cs

@@ -305,9 +305,7 @@ public QueryLayer ComposeSecondaryLayerForRelationship(ResourceType secondaryRes
         return secondaryLayer;
     }
 
-#pragma warning disable AV1130 // Return type in method signature should be a collection interface instead of a concrete type
     private FieldSelection GetSelectionForRelationship(ResourceType secondaryResourceType)
-#pragma warning restore AV1130 // Return type in method signature should be a collection interface instead of a concrete type
     {
         var selection = new FieldSelection();
         FieldSelectors selectors = selection.GetOrCreateSelectors(secondaryResourceType);
@@ -404,7 +402,7 @@ public QueryLayer ComposeForUpdate<TId>(TId id, ResourceType primaryResourceType
         foreach (RelationshipAttribute relationship in _targetedFields.Relationships)
         {
             object? rightValue = relationship.GetValue(primaryResource);
-            ICollection<IIdentifiable> rightResourceIds = _collectionConverter.ExtractResources(rightValue);
+            HashSet<IIdentifiable> rightResourceIds = _collectionConverter.ExtractResources(rightValue).ToHashSet(IdentifiableComparer.Instance);
 
             if (rightResourceIds.Any())
             {
@@ -527,9 +525,9 @@ protected virtual PaginationExpression GetPagination(IReadOnlyCollection<QueryEx
         return pagination;
     }
 
-#pragma warning disable AV1130 // Return type in method signature should be a collection interface instead of a concrete type
+#pragma warning disable AV1130 // Return type in method signature should be an interface to an unchangeable collection
     protected virtual FieldSelection? GetSelectionForSparseAttributeSet(ResourceType resourceType)
-#pragma warning restore AV1130 // Return type in method signature should be a collection interface instead of a concrete type
+#pragma warning restore AV1130 // Return type in method signature should be an interface to an unchangeable collection
     {
         ArgumentGuard.NotNull(resourceType, nameof(resourceType));
 

src/JsonApiDotNetCore/Queries/Internal/QueryableBuilding/SelectClauseBuilder.cs

@@ -76,7 +76,7 @@ private Expression CreateLambdaBodyInitializer(FieldSelection selection, Resourc
     private Expression CreateLambdaBodyInitializerForTypeHierarchy(FieldSelection selection, ResourceType baseResourceType,
         IEnumerable<IEntityType> concreteEntityTypes, LambdaScope lambdaScope)
     {
-        ISet<ResourceType> resourceTypes = selection.GetResourceTypes();
+        IReadOnlySet<ResourceType> resourceTypes = selection.GetResourceTypes();
         Expression rootCondition = lambdaScope.Accessor;
 
         foreach (IEntityType entityType in concreteEntityTypes)