Merge branch 'merge-master-v503-into-openapi' into openapi-required-and-nullable-properties

Author: bkoelman

.config/dotnet-tools.json

@@ -9,7 +9,7 @@
       ]
     },
     "regitlint": {
-      "version": "6.0.8",
+      "version": "6.1.1",
       "commands": [
         "regitlint"
       ]

.github/CONTRIBUTING.md

@@ -58,8 +58,8 @@ Please follow these steps to have your contribution considered by the maintainer
 
 We use [CSharpGuidelines](https://csharpcodingguidelines.com/) as our coding standard (with a few minor exceptions). Coding style is validated during PR build, where we inject an extra settings layer that promotes various suggestions to warning level. This ensures a high-quality codebase without interfering too much when editing code.
 You can run the following [PowerShell scripts](https://github.com/PowerShell/PowerShell/releases) locally:
-- `pwsh inspectcode.ps1`: Scans the code for style violations and opens the result in your web browser.
-- `pwsh cleanupcode.ps1`: Reformats the entire codebase to match with our configured style.
+- `pwsh ./inspectcode.ps1`: Scans the code for style violations and opens the result in your web browser.
+- `pwsh ./cleanupcode.ps1 [branch-name-or-commit-hash]`: Reformats the codebase to match with our configured style, optionally only changed files since the specified branch (usually master).
 
 Code inspection violations can be addressed in several ways, depending on the situation:
 - Types that are reported to be never instantiated (because the IoC container creates them dynamically) should be decorated with `[UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]`.

Build.ps1

@@ -40,16 +40,21 @@ function RunCleanupCode {
     # When running in cibuild for a pull request, this reformats only the files changed in the PR and fails if the reformat produces changes.
 
     if ($env:APPVEYOR_PULL_REQUEST_HEAD_COMMIT) {
-        Write-Output "Running code cleanup on changed files in pull request"
-
         # In the past, we used $env:APPVEYOR_PULL_REQUEST_HEAD_COMMIT for the merge commit hash. That is the pinned hash at the time the build is enqueued.
         # When a force-push happens after that, while the build hasn't yet started, this hash becomes invalid during the build, resulting in a lookup error.
-        # To prevent failing the build for unobvious reasons we use HEAD, which is always the latest version.
-        $mergeCommitHash = git rev-parse "HEAD"
-        $targetCommitHash = git rev-parse "$env:APPVEYOR_REPO_BRANCH"
+        # To prevent failing the build for unobvious reasons we use HEAD, which is always a detached head (the PR merge result).
+
+        $headCommitHash = git rev-parse HEAD
+        CheckLastExitCode
 
-        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --disable-jb-path-hack --jb --profile='\"JADNC Full Cleanup\"' --jb --properties:Configuration=Release --jb --verbosity=WARN -f commits -a $mergeCommitHash -b $targetCommitHash --fail-on-diff --print-diff
+        $baseCommitHash = git rev-parse "$env:APPVEYOR_REPO_BRANCH"
         CheckLastExitCode
+
+        if ($baseCommitHash -ne $headCommitHash) {
+            Write-Output "Running code cleanup on commit range $baseCommitHash..$headCommitHash in pull request."
+            dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --verbosity=WARN -f commits -a $headCommitHash -b $baseCommitHash --fail-on-diff --print-diff
+            CheckLastExitCode
+        }
     }
 }
 

Directory.Build.props

@@ -4,10 +4,13 @@
     <AspNetVersion>6.0.*</AspNetVersion>
     <EFCoreVersion>6.0.*</EFCoreVersion>
     <EFCorePostgresVersion>6.0.*</EFCorePostgresVersion>
-    <MicrosoftCodeAnalysisVersion>4.2.*</MicrosoftCodeAnalysisVersion>
+    <MicrosoftCodeAnalysisVersion>4.3.*</MicrosoftCodeAnalysisVersion>
     <HumanizerVersion>2.14.1</HumanizerVersion>
-    <SwashbuckleVersion>6.2.*</SwashbuckleVersion>
-    <JsonApiDotNetCoreVersionPrefix>5.0.3</JsonApiDotNetCoreVersionPrefix>
+    <SwashbuckleVersion>6.4.*</SwashbuckleVersion>
+    <NSwagApiClientVersion>13.16.*</NSwagApiClientVersion>
+    <MicrosoftApiClientVersion>6.0.*</MicrosoftApiClientVersion>
+    <NewtonsoftJsonVersion>13.0.*</NewtonsoftJsonVersion>
+    <JsonApiDotNetCoreVersionPrefix>5.0.4</JsonApiDotNetCoreVersionPrefix>
     <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)CodingGuidelines.ruleset</CodeAnalysisRuleSet>
     <WarningLevel>9999</WarningLevel>
     <Nullable>enable</Nullable>
@@ -18,7 +21,7 @@
 
   <ItemGroup>
     <PackageReference Include="JetBrains.Annotations" Version="2022.1.0" PrivateAssets="All" />
-    <PackageReference Include="CSharpGuidelinesAnalyzer" Version="3.8.1" PrivateAssets="All" />
+    <PackageReference Include="CSharpGuidelinesAnalyzer" Version="3.8.2" PrivateAssets="All" />
     <AdditionalFiles Include="$(MSBuildThisFileDirectory)CSharpGuidelinesAnalyzer.config" Visible="False" />
   </ItemGroup>
 
@@ -35,7 +38,7 @@
   <!-- Test Project Dependencies -->
   <PropertyGroup>
     <CoverletVersion>3.1.2</CoverletVersion>
-    <MoqVersion>4.18.1</MoqVersion>
-    <TestSdkVersion>17.2.0</TestSdkVersion>
+    <MoqVersion>4.18.2</MoqVersion>
+    <TestSdkVersion>17.3.1</TestSdkVersion>
   </PropertyGroup>
 </Project>

JsonApiDotNetCore.sln.DotSettings

@@ -57,6 +57,7 @@ JsonApiDotNetCore.ArgumentGuard.NotNull($EXPR$, $NAME$);</s:String>
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=EnforceUsingStatementBraces/@EntryIndexedValue">WARNING</s:String>
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=EnforceWhileStatementBraces/@EntryIndexedValue">WARNING</s:String>
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=EventNeverSubscribedTo_002ELocal/@EntryIndexedValue">WARNING</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=LambdaExpressionMustBeStatic/@EntryIndexedValue">WARNING</s:String>
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=LocalizableElement/@EntryIndexedValue">DO_NOT_SHOW</s:String>
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=LoopCanBePartlyConvertedToQuery/@EntryIndexedValue">HINT</s:String>
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=MemberCanBeInternal/@EntryIndexedValue">SUGGESTION</s:String>

benchmarks/Benchmarks.csproj

@@ -2,14 +2,17 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>$(TargetFrameworkName)</TargetFramework>
+    <ServerGarbageCollection>true</ServerGarbageCollection>
   </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\src\JsonApiDotNetCore\JsonApiDotNetCore.csproj" />
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="BenchmarkDotNet" Version="0.13.1" />
-    <PackageReference Include="Moq" Version="$(MoqVersion)" />
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.2" />
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="$(MicrosoftCodeAnalysisVersion)" PrivateAssets="all">
+      <!-- This reference solely exists to prevent build warnings for conflicting versions of Microsoft.CodeAnalysis. -->
+    </PackageReference>
   </ItemGroup>
 </Project>

benchmarks/Deserialization/OperationsDeserializationBenchmarks.cs

@@ -7,6 +7,7 @@
 namespace Benchmarks.Deserialization;
 
 [MarkdownExporter]
+[MemoryDiagnoser]
 // ReSharper disable once ClassCanBeSealed.Global
 public class OperationsDeserializationBenchmarks : DeserializationBenchmarkBase
 {

benchmarks/Deserialization/ResourceDeserializationBenchmarks.cs

@@ -7,6 +7,7 @@
 namespace Benchmarks.Deserialization;
 
 [MarkdownExporter]
+[MemoryDiagnoser]
 // ReSharper disable once ClassCanBeSealed.Global
 public class ResourceDeserializationBenchmarks : DeserializationBenchmarkBase
 {

benchmarks/QueryString/QueryStringParserBenchmarks.cs

@@ -1,13 +1,12 @@
 using System.ComponentModel.Design;
 using BenchmarkDotNet.Attributes;
+using Benchmarks.Tools;
 using JsonApiDotNetCore;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.QueryStrings;
 using JsonApiDotNetCore.QueryStrings.Internal;
 using JsonApiDotNetCore.Resources;
-using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.WebUtilities;
 using Microsoft.Extensions.Logging.Abstractions;
 
 namespace Benchmarks.QueryString;
@@ -71,31 +70,9 @@ public void DescendingSort()
     [Benchmark]
     public void ComplexQuery()
     {
-        Run(100, () =>
-        {
-            const string queryString =
-                "?filter[alt-attr-name]=abc,eq:abc&sort=-alt-attr-name&include=child&page[size]=1&fields[alt-resource-name]=alt-attr-name";
-
-            _queryStringAccessor.SetQueryString(queryString);
-            _queryStringReader.ReadAll(null);
-        });
-    }
-
-    private void Run(int iterations, Action action)
-    {
-        for (int index = 0; index < iterations; index++)
-        {
-            action();
-        }
-    }
-
-    private sealed class FakeRequestQueryStringAccessor : IRequestQueryStringAccessor
-    {
-        public IQueryCollection Query { get; private set; } = new QueryCollection();
+        const string queryString = "?filter[alt-attr-name]=abc,eq:abc&sort=-alt-attr-name&include=child&page[size]=1&fields[alt-resource-name]=alt-attr-name";
 
-        public void SetQueryString(string queryString)
-        {
-            Query = new QueryCollection(QueryHelpers.ParseQuery(queryString));
-        }
+        _queryStringAccessor.SetQueryString(queryString);
+        _queryStringReader.ReadAll(null);
     }
 }

benchmarks/Serialization/OperationsSerializationBenchmarks.cs

@@ -9,6 +9,7 @@
 namespace Benchmarks.Serialization;
 
 [MarkdownExporter]
+[MemoryDiagnoser]
 // ReSharper disable once ClassCanBeSealed.Global
 public class OperationsSerializationBenchmarks : SerializationBenchmarkBase
 {

benchmarks/Serialization/ResourceSerializationBenchmarks.cs

@@ -12,6 +12,7 @@
 namespace Benchmarks.Serialization;
 
 [MarkdownExporter]
+[MemoryDiagnoser]
 // ReSharper disable once ClassCanBeSealed.Global
 public class ResourceSerializationBenchmarks : SerializationBenchmarkBase
 {

benchmarks/Serialization/SerializationBenchmarkBase.cs

@@ -1,18 +1,14 @@
-using System.Collections.Immutable;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using Benchmarks.Tools;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Queries;
-using JsonApiDotNetCore.Queries.Expressions;
 using JsonApiDotNetCore.Queries.Internal;
-using JsonApiDotNetCore.QueryStrings;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
-using JsonApiDotNetCore.Serialization.Objects;
 using JsonApiDotNetCore.Serialization.Response;
-using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Logging.Abstractions;
 
 namespace Benchmarks.Serialization;
@@ -45,9 +41,9 @@ protected SerializationBenchmarkBase()
         // ReSharper restore VirtualMemberCallInConstructor
 
         var linkBuilder = new FakeLinkBuilder();
-        var metaBuilder = new FakeMetaBuilder();
+        var metaBuilder = new NoMetaBuilder();
         IQueryConstraintProvider[] constraintProviders = Array.Empty<IQueryConstraintProvider>();
-        var resourceDefinitionAccessor = new FakeResourceDefinitionAccessor();
+        var resourceDefinitionAccessor = new NeverResourceDefinitionAccessor();
         var sparseFieldSetCache = new SparseFieldSetCache(constraintProviders, resourceDefinitionAccessor);
         var requestQueryStringAccessor = new FakeRequestQueryStringAccessor();
 
@@ -122,141 +118,4 @@ public sealed class OutgoingResource : Identifiable<int>
         [HasMany]
         public ISet<OutgoingResource> Multi5 { get; set; } = null!;
     }
-
-    private sealed class FakeResourceDefinitionAccessor : IResourceDefinitionAccessor
-    {
-        public IImmutableSet<IncludeElementExpression> OnApplyIncludes(ResourceType resourceType, IImmutableSet<IncludeElementExpression> existingIncludes)
-        {
-            return existingIncludes;
-        }
-
-        public FilterExpression? OnApplyFilter(ResourceType resourceType, FilterExpression? existingFilter)
-        {
-            return existingFilter;
-        }
-
-        public SortExpression? OnApplySort(ResourceType resourceType, SortExpression? existingSort)
-        {
-            return existingSort;
-        }
-
-        public PaginationExpression? OnApplyPagination(ResourceType resourceType, PaginationExpression? existingPagination)
-        {
-            return existingPagination;
-        }
-
-        public SparseFieldSetExpression? OnApplySparseFieldSet(ResourceType resourceType, SparseFieldSetExpression? existingSparseFieldSet)
-        {
-            return existingSparseFieldSet;
-        }
-
-        public object? GetQueryableHandlerForQueryStringParameter(Type resourceClrType, string parameterName)
-        {
-            return null;
-        }
-
-        public IDictionary<string, object?>? GetMeta(ResourceType resourceType, IIdentifiable resourceInstance)
-        {
-            return null;
-        }
-
-        public Task OnPrepareWriteAsync<TResource>(TResource resource, WriteOperationKind writeOperation, CancellationToken cancellationToken)
-            where TResource : class, IIdentifiable
-        {
-            return Task.CompletedTask;
-        }
-
-        public Task<IIdentifiable?> OnSetToOneRelationshipAsync<TResource>(TResource leftResource, HasOneAttribute hasOneRelationship,
-            IIdentifiable? rightResourceId, WriteOperationKind writeOperation, CancellationToken cancellationToken)
-            where TResource : class, IIdentifiable
-        {
-            return Task.FromResult(rightResourceId);
-        }
-
-        public Task OnSetToManyRelationshipAsync<TResource>(TResource leftResource, HasManyAttribute hasManyRelationship, ISet<IIdentifiable> rightResourceIds,
-            WriteOperationKind writeOperation, CancellationToken cancellationToken)
-            where TResource : class, IIdentifiable
-        {
-            return Task.CompletedTask;
-        }
-
-        public Task OnAddToRelationshipAsync<TResource>(TResource leftResource, HasManyAttribute hasManyRelationship, ISet<IIdentifiable> rightResourceIds,
-            CancellationToken cancellationToken)
-            where TResource : class, IIdentifiable
-        {
-            return Task.CompletedTask;
-        }
-
-        public Task OnRemoveFromRelationshipAsync<TResource>(TResource leftResource, HasManyAttribute hasManyRelationship, ISet<IIdentifiable> rightResourceIds,
-            CancellationToken cancellationToken)
-            where TResource : class, IIdentifiable
-        {
-            return Task.CompletedTask;
-        }
-
-        public Task OnWritingAsync<TResource>(TResource resource, WriteOperationKind writeOperation, CancellationToken cancellationToken)
-            where TResource : class, IIdentifiable
-        {
-            return Task.CompletedTask;
-        }
-
-        public Task OnWriteSucceededAsync<TResource>(TResource resource, WriteOperationKind writeOperation, CancellationToken cancellationToken)
-            where TResource : class, IIdentifiable
-        {
-            return Task.CompletedTask;
-        }
-
-        public void OnDeserialize(IIdentifiable resource)
-        {
-        }
-
-        public void OnSerialize(IIdentifiable resource)
-        {
-        }
-    }
-
-    private sealed class FakeLinkBuilder : ILinkBuilder
-    {
-        public TopLevelLinks GetTopLevelLinks()
-        {
-            return new TopLevelLinks
-            {
-                Self = "TopLevel:Self"
-            };
-        }
-
-        public ResourceLinks GetResourceLinks(ResourceType resourceType, IIdentifiable resource)
-        {
-            return new ResourceLinks
-            {
-                Self = "Resource:Self"
-            };
-        }
-
-        public RelationshipLinks GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource)
-        {
-            return new RelationshipLinks
-            {
-                Self = "Relationship:Self",
-                Related = "Relationship:Related"
-            };
-        }
-    }
-
-    private sealed class FakeMetaBuilder : IMetaBuilder
-    {
-        public void Add(IDictionary<string, object?> values)
-        {
-        }
-
-        public IDictionary<string, object?>? Build()
-        {
-            return null;
-        }
-    }
-
-    private sealed class FakeRequestQueryStringAccessor : IRequestQueryStringAccessor
-    {
-        public IQueryCollection Query { get; } = new QueryCollection(0);
-    }
 }