Merge branch 'master' into merge-v5.1-into-openapi

Author: maurei

.config/dotnet-tools.json

@@ -3,13 +3,13 @@
   "isRoot": true,
   "tools": {
     "jetbrains.resharper.globaltools": {
-      "version": "2022.2.3",
+      "version": "2022.2.4",
       "commands": [
         "jb"
       ]
     },
     "regitlint": {
-      "version": "6.1.1",
+      "version": "6.2.1",
       "commands": [
         "regitlint"
       ]
@@ -21,7 +21,7 @@
       ]
     },
     "dotnet-reportgenerator-globaltool": {
-      "version": "5.1.3",
+      "version": "5.1.11",
       "commands": [
         "reportgenerator"
       ]

Build.ps1

@@ -51,7 +51,7 @@ function RunCleanupCode {
 
         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
+            dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --max-runs=5 --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

@@ -20,7 +20,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="JetBrains.Annotations" Version="2022.1.0" PrivateAssets="All" />
+    <PackageReference Include="JetBrains.Annotations" Version="2022.3.1" PrivateAssets="All" />
     <PackageReference Include="CSharpGuidelinesAnalyzer" Version="3.8.2" PrivateAssets="All" />
     <AdditionalFiles Include="$(MSBuildThisFileDirectory)CSharpGuidelinesAnalyzer.config" Visible="False" />
   </ItemGroup>
@@ -37,8 +37,8 @@
 
   <!-- Test Project Dependencies -->
   <PropertyGroup>
-    <CoverletVersion>3.1.2</CoverletVersion>
+    <CoverletVersion>3.2.0</CoverletVersion>
     <MoqVersion>4.18.2</MoqVersion>
-    <TestSdkVersion>17.3.1</TestSdkVersion>
+    <TestSdkVersion>17.4.0</TestSdkVersion>
   </PropertyGroup>
 </Project>

appveyor.yml

@@ -4,7 +4,7 @@ image:
 
 version: '{build}'
 
-stack: postgresql 13.4
+stack: postgresql 15
 
 environment:
   PGUSER: postgres
@@ -35,7 +35,10 @@ for:
     only:
     - image: Visual Studio 2022
   services:
-  - postgresql13
+  - postgresql15
+  install:
+  # Temporary workaround for https://help.appveyor.com/discussions/questions/60488-postgresql-version
+  - net start postgresql-x64-15
   # REF: https://github.com/docascode/docfx-seed/blob/master/appveyor.yml
   before_build:
     - pwsh: |
@@ -102,7 +105,7 @@ build_script:
 
     Write-Output "PostgreSQL version:"
     if ($IsWindows) {
-        . "${env:ProgramFiles}\PostgreSQL\13\bin\psql" --version
+        . "${env:ProgramFiles}\PostgreSQL\15\bin\psql" --version
     }
     else {
         psql --version

cleanupcode.ps1

@@ -28,17 +28,17 @@ if ($revision) {
 
     if ($baseCommitHash -eq $headCommitHash) {
         Write-Output "Running code cleanup on staged/unstaged files."
-        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --verbosity=WARN -f staged,modified
+        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --max-runs=5 --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --verbosity=WARN -f staged,modified
         VerifySuccessExitCode
     }
     else {
         Write-Output "Running code cleanup on commit range $baseCommitHash..$headCommitHash, including staged/unstaged files."
-        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --verbosity=WARN -f staged,modified,commits -a $headCommitHash -b $baseCommitHash
+        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --max-runs=5 --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --verbosity=WARN -f staged,modified,commits -a $headCommitHash -b $baseCommitHash
         VerifySuccessExitCode
     }
 }
 else {
     Write-Output "Running code cleanup on all files."
-    dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --verbosity=WARN
+    dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --max-runs=5 --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --verbosity=WARN
     VerifySuccessExitCode
 }

run-docker-postgres.ps1

@@ -9,4 +9,4 @@ docker run --rm --name jsonapi-dotnet-core-testing       `
  -e POSTGRES_USER=postgres                               `
  -e POSTGRES_PASSWORD=postgres                           `
  -p 5432:5432                                            `
- postgres:13.4
+ postgres:15

src/Examples/DatabasePerTenantExample/Data/AppDbContext.cs

@@ -36,7 +36,7 @@ protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     private string GetConnectionString()
     {
         string? tenantName = GetTenantName();
-        string connectionString = _configuration[$"Data:{tenantName ?? "Default"}Connection"];
+        string? connectionString = _configuration[$"Data:{tenantName ?? "Default"}Connection"];
 
         if (connectionString == null)
         {

src/Examples/NoEntityFrameworkExample/Services/WorkItemService.cs

@@ -11,12 +11,12 @@ namespace NoEntityFrameworkExample.Services;
 [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
 public sealed class WorkItemService : IResourceService<WorkItem, int>
 {
-    private readonly string _connectionString;
+    private readonly string? _connectionString;
 
     public WorkItemService(IConfiguration configuration)
     {
         string postgresPassword = Environment.GetEnvironmentVariable("PGPASSWORD") ?? "postgres";
-        _connectionString = configuration["Data:DefaultConnection"].Replace("###", postgresPassword);
+        _connectionString = configuration["Data:DefaultConnection"]?.Replace("###", postgresPassword);
     }
 
     public async Task<IReadOnlyCollection<WorkItem>> GetAsync(CancellationToken cancellationToken)

src/JsonApiDotNetCore/QueryStrings/Internal/FilterQueryStringParameterReader.cs

@@ -77,18 +77,21 @@ public virtual void Read(string parameterName, StringValues parameterValue)
         }
     }
 
-    private IEnumerable<string> ExtractParameterValue(string parameterValue)
+    private IEnumerable<string> ExtractParameterValue(string? parameterValue)
     {
-        if (_options.EnableLegacyFilterNotation)
+        if (parameterValue != null)
         {
-            foreach (string condition in LegacyConverter.ExtractConditions(parameterValue))
+            if (_options.EnableLegacyFilterNotation)
             {
-                yield return condition;
+                foreach (string condition in LegacyConverter.ExtractConditions(parameterValue))
+                {
+                    yield return condition;
+                }
+            }
+            else
+            {
+                yield return parameterValue;
             }
-        }
-        else
-        {
-            yield return parameterValue;
         }
     }
 

src/JsonApiDotNetCore/QueryStrings/Internal/IncludeQueryStringParameterReader.cs

@@ -48,7 +48,7 @@ public virtual void Read(string parameterName, StringValues parameterValue)
     {
         try
         {
-            _includeExpression = GetInclude(parameterValue);
+            _includeExpression = GetInclude(parameterValue.ToString());
         }
         catch (QueryParseException exception)
         {

src/JsonApiDotNetCore/QueryStrings/Internal/PaginationQueryStringParameterReader.cs

@@ -53,7 +53,7 @@ public virtual void Read(string parameterName, StringValues parameterValue)
     {
         try
         {
-            PaginationQueryStringValueExpression constraint = GetPageConstraint(parameterValue);
+            PaginationQueryStringValueExpression constraint = GetPageConstraint(parameterValue.ToString());
 
             if (constraint.Elements.Any(element => element.Scope == null))
             {

src/JsonApiDotNetCore/QueryStrings/Internal/SortQueryStringParameterReader.cs

@@ -62,7 +62,7 @@ public virtual void Read(string parameterName, StringValues parameterValue)
         try
         {
             ResourceFieldChainExpression? scope = GetScope(parameterName);
-            SortExpression sort = GetSort(parameterValue, scope);
+            SortExpression sort = GetSort(parameterValue.ToString(), scope);
 
             var expressionInScope = new ExpressionInScope(scope, sort);
             _constraints.Add(expressionInScope);

src/JsonApiDotNetCore/QueryStrings/Internal/SparseFieldSetQueryStringParameterReader.cs

@@ -69,7 +69,7 @@ public virtual void Read(string parameterName, StringValues parameterValue)
         try
         {
             ResourceType targetResourceType = GetSparseFieldType(parameterName);
-            SparseFieldSetExpression sparseFieldSet = GetSparseFieldSet(parameterValue, targetResourceType);
+            SparseFieldSetExpression sparseFieldSet = GetSparseFieldSet(parameterValue.ToString(), targetResourceType);
 
             _sparseFieldTableBuilder[targetResourceType] = sparseFieldSet;
         }

src/JsonApiDotNetCore/Serialization/Response/LinkBuilder.cs

@@ -140,13 +140,13 @@ private void SetPaginationInTopLevelLinks(ResourceType resourceType, TopLevelLin
 
     private string? CalculatePageSizeValue(PageSize? topPageSize, ResourceType resourceType)
     {
-        string pageSizeParameterValue = HttpContext.Request.Query[PageSizeParameterName];
+        string? pageSizeParameterValue = HttpContext.Request.Query[PageSizeParameterName];
 
         PageSize? newTopPageSize = Equals(topPageSize, _options.DefaultPageSize) ? null : topPageSize;
         return ChangeTopPageSize(pageSizeParameterValue, newTopPageSize, resourceType);
     }
 
-    private string? ChangeTopPageSize(string pageSizeParameterValue, PageSize? topPageSize, ResourceType resourceType)
+    private string? ChangeTopPageSize(string? pageSizeParameterValue, PageSize? topPageSize, ResourceType resourceType)
     {
         IImmutableList<PaginationElementQueryStringValueExpression> elements = ParsePageSizeExpression(pageSizeParameterValue, resourceType);
         int elementInTopScopeIndex = elements.FindIndex(expression => expression.Scope == null);

test/AnnotationTests/AnnotationTests.csproj

@@ -4,12 +4,6 @@
     <LangVersion>latest</LangVersion>
   </PropertyGroup>
 
-  <ItemGroup>
-    <None Update="xunit.runner.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
-  </ItemGroup>
-
   <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard1.0' ">
     <Using Remove="System.Net.Http" />
   </ItemGroup>

test/DiscoveryTests/DiscoveryTests.csproj

@@ -3,12 +3,6 @@
     <TargetFramework>$(TargetFrameworkName)</TargetFramework>
   </PropertyGroup>
 
-  <ItemGroup>
-    <None Update="xunit.runner.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
-  </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\..\src\Examples\JsonApiDotNetCoreExample\JsonApiDotNetCoreExample.csproj" />
     <ProjectReference Include="..\TestBuildingBlocks\TestBuildingBlocks.csproj" />

test/DiscoveryTests/xunit.runner.json

@@ -31,5 +31,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<MusicTrack>()
             .HasMany(musicTrack => musicTrack.OccursIn)
             .WithMany(playlist => playlist.Tracks);
+
+        base.OnModelCreating(builder);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/OperationsDbContext.cs

@@ -32,7 +32,7 @@ private IQueryable<MusicTrack> FilterOnRecentlyReleased(IQueryable<MusicTrack> s
     {
         IQueryable<MusicTrack> tracks = source;
 
-        if (bool.Parse(parameterValue))
+        if (bool.Parse(parameterValue.ToString()))
         {
             tracks = tracks.Where(musicTrack => musicTrack.ReleasedAt < _systemClock.UtcNow && musicTrack.ReleasedAt > _systemClock.UtcNow.AddMonths(-3));
         }

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/QueryStrings/MusicTrackReleaseDefinition.cs

@@ -9,7 +9,8 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.AtomicOperations.Transactions;
 
-public sealed class AtomicTransactionConsistencyTests : IClassFixture<IntegrationTestContext<TestableStartup<OperationsDbContext>, OperationsDbContext>>
+public sealed class AtomicTransactionConsistencyTests
+    : IClassFixture<IntegrationTestContext<TestableStartup<OperationsDbContext>, OperationsDbContext>>, IAsyncLifetime
 {
     private readonly IntegrationTestContext<TestableStartup<OperationsDbContext>, OperationsDbContext> _testContext;
     private readonly OperationsFakers _fakers = new();
@@ -27,7 +28,7 @@ public AtomicTransactionConsistencyTests(IntegrationTestContext<TestableStartup<
             services.AddResourceRepository<LyricRepository>();
 
             string postgresPassword = Environment.GetEnvironmentVariable("PGPASSWORD") ?? "postgres";
-            string dbConnectionString = $"Host=localhost;Port=5432;Database=JsonApiTest-{Guid.NewGuid():N};User ID=postgres;Password={postgresPassword}";
+            string dbConnectionString = $"Host=localhost;Port=5432;Database=JsonApiTest-Extra-{Guid.NewGuid():N};User ID=postgres;Password={postgresPassword}";
 
             services.AddDbContext<ExtraDbContext>(options => options.UseNpgsql(dbConnectionString));
         });
@@ -158,4 +159,22 @@ public async Task Cannot_use_distributed_transaction()
         error.Source.ShouldNotBeNull();
         error.Source.Pointer.Should().Be("/atomic:operations[0]");
     }
+
+    public Task InitializeAsync()
+    {
+        return Task.CompletedTask;
+    }
+
+    Task IAsyncLifetime.DisposeAsync()
+    {
+        return DeleteExtraDatabaseAsync();
+    }
+
+    private async Task DeleteExtraDatabaseAsync()
+    {
+        await using AsyncServiceScope scope = _testContext.Factory.Services.CreateAsyncScope();
+        var dbContext = scope.ServiceProvider.GetRequiredService<ExtraDbContext>();
+
+        await dbContext.Database.EnsureDeletedAsync();
+    }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/Transactions/AtomicTransactionConsistencyTests.cs

@@ -39,5 +39,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<Car>()
             .HasMany(car => car.PreviousDealerships)
             .WithMany(dealership => dealership.SoldCars);
+
+        base.OnModelCreating(builder);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/CompositeKeys/CompositeDbContext.cs

@@ -34,5 +34,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             .HasOne(building => building.SecondaryDoor)
             .WithOne()
             .HasForeignKey<Building>("SecondaryDoorId");
+
+        base.OnModelCreating(builder);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/EagerLoading/EagerLoadingDbContext.cs

@@ -37,5 +37,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<SystemDirectory>()
             .HasOne(systemDirectory => systemDirectory.AlsoSelf)
             .WithOne();
+
+        base.OnModelCreating(builder);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/InputValidation/ModelState/ModelStateDbContext.cs

@@ -24,5 +24,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             .HasOne(photo => photo.Location)
             .WithOne(location => location.Photo)
             .HasForeignKey<Photo>("LocationId");
+
+        base.OnModelCreating(builder);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/Links/LinksDbContext.cs

@@ -31,5 +31,7 @@ protected override void OnModelCreating(ModelBuilder builder)
 
         builder.Entity<WebProduct>()
             .HasQueryFilter(webProduct => webProduct.Shop.TenantId == _tenantProvider.TenantId);
+
+        base.OnModelCreating(builder);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/MultiTenancy/MultiTenancyDbContext.cs

@@ -21,5 +21,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<FilterableResource>()
             .Property(resource => resource.SomeDateTimeInLocalZone)
             .HasColumnType("timestamp without time zone");
+
+        base.OnModelCreating(builder);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/Filtering/FilterDbContext.cs

@@ -37,5 +37,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             .HasOne(man => man.Wife)
             .WithOne(woman => woman.Husband)
             .HasForeignKey<Man>();
+
+        base.OnModelCreating(builder);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/QueryStringDbContext.cs

@@ -49,5 +49,7 @@ protected override void OnModelCreating(ModelBuilder builder)
                 left => left
                     .HasOne(joinEntity => joinEntity.ToItem)
                     .WithMany());
+
+        base.OnModelCreating(builder);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/ReadWriteDbContext.cs

@@ -33,5 +33,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             .HasOne(order => order.Shipment)
             .WithOne(shipment => shipment.Order)
             .HasForeignKey<Shipment>("OrderId");
+
+        base.OnModelCreating(builder);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/RequiredRelationships/DefaultBehaviorDbContext.cs

@@ -51,7 +51,7 @@ public override QueryStringParameterHandlers<Moon> OnRegisterQueryableHandlersFo
 
     private static IQueryable<Moon> FilterByRadius(IQueryable<Moon> source, StringValues parameterValue)
     {
-        bool isFilterOnLargerThan = bool.Parse(parameterValue);
+        bool isFilterOnLargerThan = bool.Parse(parameterValue.ToString());
         return isFilterOnLargerThan ? source.Where(moon => moon.SolarRadius > 1m) : source.Where(moon => moon.SolarRadius <= 1m);
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/ResourceDefinitions/Reading/MoonDefinition.cs

@@ -22,5 +22,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<Scholarship>()
             .HasMany(scholarship => scholarship.Participants)
             .WithOne(student => student.Scholarship!);
+
+        base.OnModelCreating(builder);
     }
 }