Merge pull request #1527 from json-api-dotnet/merge-master-into-openapi

Merge master into openapi

Author: bkoelman

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "jetbrains.resharper.globaltools": {
-      "version": "2023.3.4",
+      "version": "2024.1.0",
       "commands": [
         "jb"
       ]
@@ -21,7 +21,7 @@
       ]
     },
     "docfx": {
-      "version": "2.74.0",
+      "version": "2.76.0",
       "commands": [
         "docfx"
       ]

.github/workflows/build.yml

@@ -206,7 +206,7 @@ jobs:
       run: |
         $inspectCodeOutputPath = Join-Path $env:RUNNER_TEMP 'jetbrains-inspectcode-results.xml'
         Write-Output "INSPECT_CODE_OUTPUT_PATH=$inspectCodeOutputPath" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
-        dotnet jb inspectcode JsonApiDotNetCore.sln --build --dotnetcoresdk=$(dotnet --version) --output="$inspectCodeOutputPath" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --properties:ContinuousIntegrationBuild=false --properties:RunAnalyzers=false --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
+        dotnet jb inspectcode JsonApiDotNetCore.sln --build --dotnetcoresdk=$(dotnet --version) --output="$inspectCodeOutputPath" --format="xml" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --properties:ContinuousIntegrationBuild=false --properties:RunAnalyzers=false --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
     - name: Verify outcome
       shell: pwsh
       run: |

JsonApiDotNetCore.sln.DotSettings

@@ -594,11 +594,14 @@ JsonApiDotNetCore.ArgumentGuard.NotNull($EXPR$);</s:String>
 	<s:Boolean x:Key="/Default/CodeStyle/Naming/CSharpNaming/ApplyAutoDetectedRules/@EntryValue">False</s:Boolean>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateInstanceFields/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="_" Suffix="" Style="aaBb" /&gt;</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateStaticFields/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="_" Suffix="" Style="aaBb" /&gt;</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/UserRules/=4a98fdf6_002D7d98_002D4f5a_002Dafeb_002Dea44ad98c70c/@EntryIndexedValue">&lt;Policy&gt;&lt;Descriptor Staticness="Instance" AccessRightKinds="Private" Description="Instance fields (private)"&gt;&lt;ElementKinds&gt;&lt;Kind Name="FIELD" /&gt;&lt;Kind Name="READONLY_FIELD" /&gt;&lt;/ElementKinds&gt;&lt;/Descriptor&gt;&lt;Policy Inspect="True" Prefix="_" Suffix="" Style="aaBb" /&gt;&lt;/Policy&gt;</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/UserRules/=f9fce829_002De6f4_002D4cb2_002D80f1_002D5497c44f51df/@EntryIndexedValue">&lt;Policy&gt;&lt;Descriptor Staticness="Static" AccessRightKinds="Private" Description="Static fields (private)"&gt;&lt;ElementKinds&gt;&lt;Kind Name="FIELD" /&gt;&lt;/ElementKinds&gt;&lt;/Descriptor&gt;&lt;Policy Inspect="True" Prefix="_" Suffix="" Style="aaBb" /&gt;&lt;/Policy&gt;</s:String>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpKeepExistingMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpPlaceEmbeddedOnSameLineMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpUseContinuousIndentInsideBracesMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EAlwaysTreatStructAsNotReorderableMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateBlankLinesAroundFieldToBlankLinesAroundProperty/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EPredefinedNamingRulesToUserRulesUpgrade/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/PatternsAndTemplates/StructuralSearch/Pattern/=546845333F49494AB6CF8F0477A0F71D/@KeyIndexDefined">True</s:Boolean>
 	<s:String x:Key="/Default/PatternsAndTemplates/StructuralSearch/Pattern/=546845333F49494AB6CF8F0477A0F71D/Comment/@EntryValue">Replace argument null check using throw expression with Guard clause</s:String>
 	<s:Boolean x:Key="/Default/PatternsAndTemplates/StructuralSearch/Pattern/=546845333F49494AB6CF8F0477A0F71D/CustomPatternPlaceholder/=argument/@KeyIndexDefined">True</s:Boolean>

benchmarks/Serialization/SerializationBenchmarkBase.cs

@@ -41,7 +41,7 @@ protected SerializationBenchmarkBase()
 
         var linkBuilder = new FakeLinkBuilder();
         var metaBuilder = new NoMetaBuilder();
-        IQueryConstraintProvider[] constraintProviders = Array.Empty<IQueryConstraintProvider>();
+        IQueryConstraintProvider[] constraintProviders = [];
         var resourceDefinitionAccessor = new NeverResourceDefinitionAccessor();
         var sparseFieldSetCache = new SparseFieldSetCache(constraintProviders, resourceDefinitionAccessor);
         var requestQueryStringAccessor = new FakeRequestQueryStringAccessor();

docs/docfx.json

@@ -24,6 +24,9 @@
                     "internals/**.md",
                     "toc.yml",
                     "*.md"
+                ],
+                "exclude": [
+                    "**/README.md"
                 ]
             }
         ],

docs/request-examples/index.md

@@ -1,3 +1,7 @@
+---
+_disableToc: true
+---
+
 # Example requests
 
 These requests have been generated against the "GettingStarted" application and are updated on every deployment.

docs/request-examples/toc.md

@@ -10,7 +10,7 @@ if ($LastExitCode -ne 0) {
 
 $outputPath = [System.IO.Path]::Combine([System.IO.Path]::GetTempPath(), 'jetbrains-inspectcode-results.xml')
 $resultPath = [System.IO.Path]::Combine([System.IO.Path]::GetTempPath(), 'jetbrains-inspectcode-results.html')
-dotnet jb inspectcode JsonApiDotNetCore.sln --dotnetcoresdk=$(dotnet --version) --build --output="$outputPath" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --properties:RunAnalyzers=false --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
+dotnet jb inspectcode JsonApiDotNetCore.sln --dotnetcoresdk=$(dotnet --version) --build --output="$outputPath" --format="xml" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --properties:RunAnalyzers=false --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
 
 if ($LastExitCode -ne 0) {
     throw "Code inspection failed with exit code $LastExitCode"

inspectcode.ps1

@@ -300,7 +300,7 @@ private static ConstantExpression CreateConstantForMemberIsNull(Type type)
 
             if (getter != null)
             {
-                object? value = getter.Invoke(null, Array.Empty<object>());
+                object? value = getter.Invoke(null, []);
                 return Expression.Constant(value, type);
             }
         }

src/Examples/NoEntityFrameworkExample/NullSafeExpressionRewriter.cs

@@ -201,7 +201,7 @@ private static void WriteObject(StringBuilder builder, object? value)
 
     private static bool HasToStringOverload(Type type)
     {
-        MethodInfo? toStringMethod = type.GetMethod("ToString", Array.Empty<Type>());
+        MethodInfo? toStringMethod = type.GetMethod("ToString", []);
         return toStringMethod != null && toStringMethod.DeclaringType != typeof(object);
     }
 

src/JsonApiDotNetCore/Middleware/TraceLogWriter.cs

@@ -52,6 +52,8 @@ public LogicalExpression(LogicalOperator @operator, IImmutableList<FilterExpress
     {
         ArgumentGuard.NotNull(filters);
 
+        // Workaround for https://youtrack.jetbrains.com/issue/RSRP-496512/Invalid-Use-collection-expression-suggestion.
+        // ReSharper disable once UseCollectionExpression
         ImmutableArray<FilterExpression> terms = filters.WhereNotNull().ToImmutableArray();
 
         return terms.Length > 1 ? new LogicalExpression(@operator, terms) : terms.FirstOrDefault();

src/JsonApiDotNetCore/Queries/Expressions/LogicalExpression.cs

@@ -49,7 +49,7 @@ internal FieldChainPattern(FieldTypes choices, bool atLeastOne, bool atMostOne,
     /// </summary>
     /// <remarks>
     /// Patterns are similar to regular expressions, but a lot simpler. They consist of a sequence of terms. A term can be a single character or a character
-    /// choice, optionally followed by a quantifier.
+    /// choice. A term is optionally followed by a quantifier.
     /// <p>
     /// The following characters can be used:
     /// <list type="table">
@@ -58,18 +58,26 @@ internal FieldChainPattern(FieldTypes choices, bool atLeastOne, bool atMostOne,
     /// <description>
     /// Matches a to-many relationship.
     /// </description>
+    /// </item>
+    /// <item>
     /// <term>O</term>
     /// <description>
     /// Matches a to-one relationship.
     /// </description>
+    /// </item>
+    /// <item>
     /// <term>R</term>
     /// <description>
     /// Matches a relationship.
     /// </description>
+    /// </item>
+    /// <item>
     /// <term>A</term>
     /// <description>
     /// Matches an attribute.
     /// </description>
+    /// </item>
+    /// <item>
     /// <term>F</term>
     /// <description>
     /// Matches a field.
@@ -86,15 +94,19 @@ internal FieldChainPattern(FieldTypes choices, bool atLeastOne, bool atMostOne,
     /// <item>
     /// <term>?</term>
     /// <description>
-    /// Matches its term zero or one times.
+    /// Matches its preceding term zero or one times.
     /// </description>
+    /// </item>
+    /// <item>
     /// <term>*</term>
     /// <description>
-    /// Matches its term zero or more times.
+    /// Matches its preceding term zero or more times.
     /// </description>
+    /// </item>
+    /// <item>
     /// <term>+</term>
     /// <description>
-    /// Matches its term one or more times.
+    /// Matches its preceding term one or more times.
     /// </description>
     /// </item>
     /// </list>

src/JsonApiDotNetCore/QueryStrings/FieldChains/FieldChainPattern.cs

@@ -13,22 +13,22 @@ public interface IDocumentAdapter
     /// <list type="bullet">
     /// <item>
     /// <description>
-    /// <code><![CDATA[IList<OperationContainer>]]></code> (operations)
+    /// <c><![CDATA[IList<OperationContainer>]]></c> (operations)
     /// </description>
     /// </item>
     /// <item>
     /// <description>
-    /// <code><![CDATA[ISet<IIdentifiable>]]></code> (to-many relationship, unknown relationship)
+    /// <c><![CDATA[ISet<IIdentifiable>]]></c> (to-many relationship, unknown relationship)
     /// </description>
     /// </item>
     /// <item>
     /// <description>
-    /// <code><![CDATA[IIdentifiable]]></code> (resource, to-one relationship)
+    /// <c><![CDATA[IIdentifiable]]></c> (resource, to-one relationship)
     /// </description>
     /// </item>
     /// <item>
     /// <description>
-    /// <code><![CDATA[null]]></code> (to-one relationship)
+    /// <c><![CDATA[null]]></c> (to-one relationship)
     /// </description>
     /// </item>
     /// </list>

src/JsonApiDotNetCore/Serialization/Request/Adapters/IDocumentAdapter.cs

@@ -12,32 +12,32 @@ public interface IResponseModelAdapter
     /// <list type="bullet">
     /// <item>
     /// <description>
-    /// <code><![CDATA[IEnumerable<IIdentifiable>]]></code>
+    /// <c><![CDATA[IEnumerable<IIdentifiable>]]></c>
     /// </description>
     /// </item>
     /// <item>
     /// <description>
-    /// <code><![CDATA[IIdentifiable]]></code>
+    /// <c><![CDATA[IIdentifiable]]></c>
     /// </description>
     /// </item>
     /// <item>
     /// <description>
-    /// <code><![CDATA[null]]></code>
+    /// <c><![CDATA[null]]></c>
     /// </description>
     /// </item>
     /// <item>
     /// <description>
-    /// <code><![CDATA[IEnumerable<OperationContainer?>]]></code>
+    /// <c><![CDATA[IEnumerable<OperationContainer?>]]></c>
     /// </description>
     /// </item>
     /// <item>
     /// <description>
-    /// <code><![CDATA[IEnumerable<ErrorObject>]]></code>
+    /// <c><![CDATA[IEnumerable<ErrorObject>]]></c>
     /// </description>
     /// </item>
     /// <item>
     /// <description>
-    /// <code><![CDATA[ErrorObject]]></code>
+    /// <c><![CDATA[ErrorObject]]></c>
     /// </description>
     /// </item>
     /// </list>

src/JsonApiDotNetCore/Serialization/Response/IResponseModelAdapter.cs

@@ -214,7 +214,7 @@ private string GetLinkForPagination(int pageOffset, string? pageSizeValue)
         };
 
         UriComponents components = _options.UseRelativeLinks ? UriComponents.PathAndQuery : UriComponents.AbsoluteUri;
-        return builder.Uri.GetComponents(components, UriFormat.SafeUnescaped);
+        return builder.Uri.GetComponents(components, UriFormat.UriEscaped);
     }
 
     private string GetQueryStringInPaginationLink(int pageOffset, string? pageSizeValue)

src/JsonApiDotNetCore/Serialization/Response/LinkBuilder.cs

@@ -12,7 +12,7 @@ public sealed class ImageContainer : Identifiable<long>
     public string FileName { get; set; } = null!;
 
     [Attr]
-    public byte[] Data { get; set; } = Array.Empty<byte>();
+    public byte[] Data { get; set; } = [];
 
     [Attr]
     public byte[]? Thumbnail { get; set; }

test/JsonApiDotNetCoreTests/IntegrationTests/Blobs/ImageContainer.cs

@@ -85,6 +85,10 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
 
         responseDocument.Data.ManyValue.ShouldHaveCount(1);
         responseDocument.Data.ManyValue[0].Attributes.ShouldContainKey("someString").With(value => value.Should().Be(resource.SomeString));
+
+        responseDocument.Links.ShouldNotBeNull();
+        responseDocument.Links.Self.Should().Be("http://localhost/filterableResources?filter=equals(someString,'This%2c+that+%26+more+%2b+some')");
+        responseDocument.Links.First.Should().Be("http://localhost/filterableResources?filter=equals(someString,%27This,%20that%20%26%20more%20%2B%20some%27)");
     }
 
     [Fact]

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

@@ -1766,7 +1766,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
         });
 
         tandemStore.AssertLeftType<Tandem>();
-        tandemStore.AssertRightTypes(Array.Empty<Type>());
+        tandemStore.AssertRightTypes([]);
     }
 
     [Fact]

test/JsonApiDotNetCoreTests/IntegrationTests/ResourceInheritance/ResourceInheritanceWriteTests.cs

@@ -82,7 +82,7 @@ public override Task OnWriteSucceededAsync(TResource resource, WriteOperationKin
 
     private void EnsureSnapshot(TResource leftType, IIdentifiable? rightResourceId = null)
     {
-        IIdentifiable[] rightResourceIds = rightResourceId != null ? [rightResourceId] : Array.Empty<IIdentifiable>();
+        IIdentifiable[] rightResourceIds = rightResourceId != null ? [rightResourceId] : [];
 
         EnsureSnapshot(leftType, rightResourceIds);
     }