Compound and collection attributes

.github/workflows/build.yml

@@ -48,8 +48,6 @@ jobs:
       uses: actions/setup-dotnet@v6
       with:
         dotnet-version: |
-          8.0.*
-          9.0.*
           10.0.*
     - name: Show installed versions
       shell: pwsh
@@ -154,8 +152,6 @@ jobs:
       uses: actions/setup-dotnet@v6
       with:
         dotnet-version: |
-          8.0.*
-          9.0.*
           10.0.*
     - name: Git checkout
       uses: actions/checkout@v7
@@ -212,8 +208,6 @@ jobs:
       uses: actions/setup-dotnet@v6
       with:
         dotnet-version: |
-          8.0.*
-          9.0.*
           10.0.*
     - name: Git checkout
       uses: actions/checkout@v7

.github/workflows/codeql.yml

@@ -30,8 +30,6 @@ jobs:
       uses: actions/setup-dotnet@v6
       with:
         dotnet-version: |
-          8.0.*
-          9.0.*
           10.0.*
     - name: Git checkout
       uses: actions/checkout@v7

Directory.Build.targets

@@ -14,4 +14,16 @@
       <Analyzer Remove="@(Analyzer)" Condition="'%(Filename)' == 'xunit.analyzers'" />
     </ItemGroup>
   </Target>
+
+  <!--
+    Workaround for Coverlet 8.0.1: NetCoreSharedFrameworkResolver only searches for <ModuleName>.runtimeconfig.json
+    to resolve shared framework assemblies (Microsoft.AspNetCore.App) for Cecil during instrumentation.
+    For class libraries, no such file exists by default, causing Cecil to fail resolving Microsoft.Extensions.Logging.Abstractions.
+    Copying the test project's runtimeconfig.json as JsonApiDotNetCore.runtimeconfig.json provides the resolver with the needed framework paths.
+  -->
+  <Target Name="CopyRuntimeConfigForCoverlet"
+    Condition="($(MSBuildProjectName.EndsWith('Tests')) Or '$(MSBuildProjectName)' == 'TestBuildingBlocks') And '$(GenerateRuntimeConfigurationFiles)' == 'true' And Exists('$(ProjectRuntimeConfigFilePath)')"
+    AfterTargets="GenerateBuildRuntimeConfigurationFiles">
+    <Copy SourceFiles="$(ProjectRuntimeConfigFilePath)" DestinationFiles="$(TargetDir)JsonApiDotNetCore.runtimeconfig.json" SkipUnchangedFiles="true" />
+  </Target>
 </Project>

JsonApiDotNetCore.slnx.DotSettings

@@ -3,7 +3,6 @@
 	<s:Int64 x:Key="/Default/CodeEditing/NullCheckPatterns/PatternTypeNamesToPriority/=JetBrains_002EReSharper_002EFeature_002EServices_002ECSharp_002ENullChecking_002EIfThenThrowPattern/@EntryIndexedValue">2000</s:Int64>
 	<s:Int64 x:Key="/Default/CodeEditing/NullCheckPatterns/PatternTypeNamesToPriority/=JetBrains_002EReSharper_002EFeature_002EServices_002ECSharp_002ENullChecking_002EThrowExpressionNullCheckPattern/@EntryIndexedValue">3000</s:Int64>
 	<s:Boolean x:Key="/Default/CodeInspection/CodeAnnotations/PropagateAnnotations/@EntryValue">False</s:Boolean>
-	<s:String x:Key="/Default/CodeInspection/ExcludedFiles/GeneratedFilesAndFolders/=58FE19B6_002DF84A_002D990C_002DB25F_002DE37C391C3BD3_002Ff_003AReadOnlySet_002Ecs/@EntryIndexedValue">58FE19B6-F84A-990C-B25F-E37C391C3BD3/f:ReadOnlySet.cs</s:String>
 	<s:String x:Key="/Default/CodeInspection/Highlighting/AnalysisEnabled/@EntryValue">SOLUTION</s:String>
 	<s:Boolean x:Key="/Default/CodeInspection/Highlighting/IdentifierHighlightingEnabled/@EntryValue">True</s:Boolean>
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=ArgumentsStyleAnonymousFunction/@EntryIndexedValue">SUGGESTION</s:String>
@@ -600,6 +599,7 @@
 	<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/Environment/TreeGridPresentableViewStyle/CompactMode/@EntryValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/GrammarAndSpelling/GrammarChecking/Exceptions/=type_0020of_0020a/@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 ArgumentNullException.ThrowIfNull</s:String>
 	<s:Boolean x:Key="/Default/PatternsAndTemplates/StructuralSearch/Pattern/=546845333F49494AB6CF8F0477A0F71D/CustomPatternPlaceholder/=argument/@KeyIndexDefined">True</s:Boolean>

ROADMAP.md

@@ -6,7 +6,7 @@ This document provides an overview of the direction this project is heading and
 
 We have an interest in the following topics. It's too soon yet to decide whether they'll make it into v5.x or in a later major version.
 
-- Query strings on JSON-mapped columns [#1439](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1439)
+- Compound attributes and collections (query strings, JSON columns, complex types) [#1439](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1439) (Implemented)
 - Optimistic concurrency [#1119](https://github.com/json-api-dotnet/JsonApiDotNetCore/pull/1119)
 - Idempotency [#1132](https://github.com/json-api-dotnet/JsonApiDotNetCore/pull/1132)
 - Fluent API [#776](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/776)

benchmarks/Serialization/SerializationBenchmarkBase.cs

@@ -43,11 +43,11 @@ protected SerializationBenchmarkBase()
         var metaBuilder = new NoMetaBuilder();
         IQueryConstraintProvider[] constraintProviders = [];
         var resourceDefinitionAccessor = new NeverResourceDefinitionAccessor();
-        var sparseFieldSetCache = new SparseFieldSetCache(constraintProviders, resourceDefinitionAccessor);
+        var sparseFieldSetEvaluator = new SparseFieldSetEvaluator(constraintProviders, resourceDefinitionAccessor);
         var requestQueryStringAccessor = new FakeRequestQueryStringAccessor();
 
         ResponseModelAdapter = new ResponseModelAdapter(request, options, linkBuilder, metaBuilder, resourceDefinitionAccessor, evaluatedIncludeCache,
-            sparseFieldSetCache, requestQueryStringAccessor);
+            sparseFieldSetEvaluator, requestQueryStringAccessor);
     }
 
     protected abstract JsonApiRequest CreateJsonApiRequest(IResourceGraph resourceGraph);

docs/api/index.md

@@ -84,7 +84,7 @@ Commonly used types are listed in the following sections.
     - <xref:JsonApiDotNetCore.Serialization.Response.ResponseModelAdapter> implements <xref:JsonApiDotNetCore.Serialization.Response.IResponseModelAdapter>
 - <xref:JsonApiDotNetCore.Serialization.Objects.Document>
 - <xref:JsonApiDotNetCore.Queries.IEvaluatedIncludeCache>
-- <xref:JsonApiDotNetCore.Queries.SparseFieldSetCache> implements <xref:JsonApiDotNetCore.Queries.ISparseFieldSetCache>
+- <xref:JsonApiDotNetCore.Queries.SparseFieldSetEvaluator> implements <xref:JsonApiDotNetCore.Queries.ISparseFieldSetEvaluator>
 
 ## Error handling
 

docs/usage/faq.md

@@ -133,7 +133,7 @@ Here are some injectable request-scoped types to be aware of:
 - `ITargetedFields`: Lists the attributes and relationships from an incoming POST/PATCH resource request. Any fields missing there should not be stored (partial updates).
 - `IEnumerable<IQueryConstraintProvider>`: Provides access to the parsed query string parameters.
 - `IEvaluatedIncludeCache`: This tells the response serializer which related resources to render.
-- `ISparseFieldSetCache`: This tells the response serializer which fields to render in the `attributes` and `relationships` objects.
+- `ISparseFieldSetEvaluator`: This tells the response serializer which fields to render in the `attributes` and `relationships` objects.
 
 You may also want to inject the singletons `IJsonApiOptions` (which contains settings such as default page size) and `IResourceGraph` (the JSON:API model of resources, attributes and relationships).
 

package-versions.props

@@ -16,7 +16,6 @@
     <InheritDocVersion>2.0.*</InheritDocVersion>
     <MiniValidationVersion>0.10.*</MiniValidationVersion>
     <ReadableExpressionsVersion>4.1.*</ReadableExpressionsVersion>
-    <SystemTextJsonVersion>10.0.*</SystemTextJsonVersion>
     <TestSdkVersion>18.11.*</TestSdkVersion>
     <XunitVersion>2.9.*</XunitVersion>
     <XunitVisualStudioVersion>4.0.*</XunitVisualStudioVersion>
@@ -28,24 +27,6 @@
 
     <!-- Non-published dependencies (these are safe to update, won't cause a breaking change) -->
     <AspNetCoreVersion>10.0.*</AspNetCoreVersion>
-    <EntityFrameworkCoreVersion>10.0.*-*</EntityFrameworkCoreVersion>
-  </PropertyGroup>
-
-  <PropertyGroup Condition="'$(TargetFramework)' == 'net9.0'">
-    <!-- Published dependencies (only update on major version change) -->
-    <EntityFrameworkCoreFrozenVersion>N/A</EntityFrameworkCoreFrozenVersion>
-
-    <!-- Non-published dependencies (these are safe to update, won't cause a breaking change) -->
-    <AspNetCoreVersion>9.0.*</AspNetCoreVersion>
-    <EntityFrameworkCoreVersion>9.0.*</EntityFrameworkCoreVersion>
-  </PropertyGroup>
-
-  <PropertyGroup Condition="'$(TargetFramework)' == 'net8.0'">
-    <!-- Published dependencies (only update on major version change) -->
-    <EntityFrameworkCoreFrozenVersion>8.0.0</EntityFrameworkCoreFrozenVersion>
-
-    <!-- Non-published dependencies (these are safe to update, won't cause a breaking change) -->
-    <AspNetCoreVersion>8.0.*</AspNetCoreVersion>
-    <EntityFrameworkCoreVersion>8.0.*</EntityFrameworkCoreVersion>
+    <EntityFrameworkCoreVersion>10.0.*</EntityFrameworkCoreVersion>
   </PropertyGroup>
 </Project>

src/Examples/DapperExample/DapperExample.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net10.0</TargetFrameworks>
   </PropertyGroup>
 
   <Import Project="..\..\..\package-versions.props" />
@@ -15,8 +15,7 @@
     <PackageReference Include="Dapper" Version="$(DapperVersion)" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Relational" Version="$(EntityFrameworkCoreVersion)" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="$(EntityFrameworkCoreVersion)" />
-    <PackageReference Include="Microting.EntityFrameworkCore.MySql" Condition="'$(TargetFramework)' != 'net9.0' And '$(TargetFramework)' != 'net8.0'" Version="$(EntityFrameworkCoreVersion)" />
+    <PackageReference Include="Microting.EntityFrameworkCore.MySql" Version="$(EntityFrameworkCoreVersion)" />
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="$(EntityFrameworkCoreVersion)" />
-    <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" Condition="'$(TargetFramework)' == 'net9.0' Or '$(TargetFramework)' == 'net8.0'" Version="$(EntityFrameworkCoreVersion)" />
   </ItemGroup>
 </Project>

src/Examples/DapperExample/Program.cs

@@ -30,11 +30,7 @@
     }
     case DatabaseProvider.MySql:
     {
-#if NET8_0
-        ServerVersion serverVersion = ServerVersion.AutoDetect(connectionString);
-#else
         ServerVersion serverVersion = await ServerVersion.AutoDetectAsync(connectionString);
-#endif
 
         builder.Services.AddMySql<AppDbContext>(connectionString, serverVersion, optionsAction: options => SetDbContextDebugOptions(options));
 

src/Examples/DatabasePerTenantExample/DatabasePerTenantExample.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net10.0</TargetFrameworks>
   </PropertyGroup>
 
   <Import Project="..\..\..\package-versions.props" />

src/Examples/GettingStarted/GettingStarted.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net10.0</TargetFrameworks>
   </PropertyGroup>
 
   <Import Project="..\..\..\package-versions.props" />

src/Examples/JsonApiDotNetCoreExample/JsonApiDotNetCoreExample.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net10.0</TargetFrameworks>
   </PropertyGroup>
 
   <Import Project="..\..\..\package-versions.props" />

src/Examples/MultiDbContextExample/MultiDbContextExample.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net10.0</TargetFrameworks>
   </PropertyGroup>
 
   <Import Project="..\..\..\package-versions.props" />

src/Examples/NoEntityFrameworkExample/NoEntityFrameworkExample.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net10.0</TargetFrameworks>
   </PropertyGroup>
 
   <Import Project="..\..\..\package-versions.props" />

src/Examples/NoEntityFrameworkExample/Services/InMemoryResourceService.cs

@@ -85,6 +85,7 @@ private void LogFiltersInTopScope()
 
         FilterExpression[] filtersInTopScope = _constraintProviders
             .SelectMany(provider => provider.GetConstraints())
+            .OfType<RelationshipChainExpressionInScope>()
             .Where(constraint => constraint.Scope == null)
             .Select(constraint => constraint.Expression)
             .OfType<FilterExpression>()

src/Examples/ReportsExample/ReportsExample.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net10.0</TargetFrameworks>
   </PropertyGroup>
 
   <Import Project="..\..\..\package-versions.props" />

src/JsonApiDotNetCore.Annotations/Configuration/CompoundType.cs

@@ -0,0 +1,102 @@
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace JsonApiDotNetCore.Configuration;
+
+/// <summary>
+/// Metadata about the shape of a compound JSON:API attribute in the resource graph.
+/// </summary>
+[PublicAPI]
+public sealed class CompoundType : IAttributeContainer
+{
+    private readonly Dictionary<string, AttrAttribute> _attributesByPublicName = [];
+    private readonly Dictionary<string, AttrAttribute> _attributesByPropertyName = [];
+
+    /// <inheritdoc />
+    public Type ClrType { get; }
+
+    /// <inheritdoc />
+    public IReadOnlyCollection<AttrAttribute> Attributes { get; }
+
+    public CompoundType(Type clrType, IReadOnlyCollection<AttrAttribute> attributes)
+    {
+        ArgumentNullException.ThrowIfNull(clrType);
+        ArgumentNullException.ThrowIfNull(attributes);
+
+        ClrType = clrType;
+        Attributes = attributes;
+
+        foreach (AttrAttribute attribute in Attributes)
+        {
+            _attributesByPublicName.Add(attribute.PublicName, attribute);
+            _attributesByPropertyName.Add(attribute.Property.Name, attribute);
+        }
+    }
+
+    /// <inheritdoc />
+    public AttrAttribute GetAttributeByPublicName(string publicName)
+    {
+        AttrAttribute? attribute = FindAttributeByPublicName(publicName);
+        return attribute ?? throw new InvalidOperationException($"Attribute '{publicName}' does not exist on compound type '{ClrType.Name}'.");
+    }
+
+    /// <inheritdoc />
+    public AttrAttribute? FindAttributeByPublicName(string publicName)
+    {
+        ArgumentNullException.ThrowIfNull(publicName);
+
+        return _attributesByPublicName.GetValueOrDefault(publicName);
+    }
+
+    /// <inheritdoc />
+    public AttrAttribute GetAttributeByPropertyName(string propertyName)
+    {
+        AttrAttribute? attribute = FindAttributeByPropertyName(propertyName);
+        return attribute ?? throw new InvalidOperationException($"Attribute for property '{propertyName}' does not exist on compound type '{ClrType.Name}'.");
+    }
+
+    /// <inheritdoc />
+    public AttrAttribute? FindAttributeByPropertyName(string propertyName)
+    {
+        ArgumentNullException.ThrowIfNull(propertyName);
+
+        return _attributesByPropertyName.GetValueOrDefault(propertyName);
+    }
+
+    /// <inheritdoc />
+    public override string ToString()
+    {
+        return ClrType.Name;
+    }
+
+    /// <inheritdoc />
+    public override bool Equals(object? obj)
+    {
+        if (ReferenceEquals(this, obj))
+        {
+            return true;
+        }
+
+        if (obj is null || GetType() != obj.GetType())
+        {
+            return false;
+        }
+
+        var other = (CompoundType)obj;
+        return ClrType == other.ClrType && Attributes.SequenceEqual(other.Attributes);
+    }
+
+    /// <inheritdoc />
+    public override int GetHashCode()
+    {
+        var hashCode = new HashCode();
+        hashCode.Add(ClrType);
+
+        foreach (AttrAttribute attribute in Attributes)
+        {
+            hashCode.Add(attribute);
+        }
+
+        return hashCode.ToHashCode();
+    }
+}

src/JsonApiDotNetCore.Annotations/Configuration/IAttributeContainer.cs

@@ -0,0 +1,41 @@
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace JsonApiDotNetCore.Configuration;
+
+/// <summary>
+/// Metadata about the shape of a type that contains JSON:API attributes.
+/// </summary>
+[PublicAPI]
+public interface IAttributeContainer
+{
+    /// <summary>
+    /// The CLR type of the container.
+    /// </summary>
+    Type ClrType { get; }
+
+    /// <summary>
+    /// The attributes in this container.
+    /// </summary>
+    IReadOnlyCollection<AttrAttribute> Attributes { get; }
+
+    /// <summary>
+    /// Gets the attribute for the specified publicly exposed name. Throws an <see cref="InvalidOperationException" /> when not found.
+    /// </summary>
+    AttrAttribute GetAttributeByPublicName(string publicName);
+
+    /// <summary>
+    /// Attempts to find an attribute by its publicly exposed name. Returns <c>null</c> when not found.
+    /// </summary>
+    AttrAttribute? FindAttributeByPublicName(string publicName);
+
+    /// <summary>
+    /// Gets the attribute for the specified property name. Throws an <see cref="InvalidOperationException" /> when not found.
+    /// </summary>
+    AttrAttribute GetAttributeByPropertyName(string propertyName);
+
+    /// <summary>
+    /// Attempts to find an attribute by its property name. Returns <c>null</c> when not found.
+    /// </summary>
+    AttrAttribute? FindAttributeByPropertyName(string propertyName);
+}