Feed includes from query string to the serializer when custom resource service is used

Author: bkoelman

benchmarks/Serialization/OperationsSerializationBenchmarks.cs

@@ -2,6 +2,7 @@
 using BenchmarkDotNet.Attributes;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
+using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Internal;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.Objects;
@@ -130,6 +131,6 @@ protected override JsonApiRequest CreateJsonApiRequest(IResourceGraph resourceGr
 
     protected override IEvaluatedIncludeCache CreateEvaluatedIncludeCache(IResourceGraph resourceGraph)
     {
-        return new EvaluatedIncludeCache();
+        return new EvaluatedIncludeCache(Array.Empty<IQueryConstraintProvider>());
     }
 }

benchmarks/Serialization/ResourceSerializationBenchmarks.cs

@@ -4,6 +4,7 @@
 using JsonApiDotNetCore;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Middleware;
+using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Expressions;
 using JsonApiDotNetCore.Queries.Internal;
 using JsonApiDotNetCore.Resources.Annotations;
@@ -142,7 +143,7 @@ protected override IEvaluatedIncludeCache CreateEvaluatedIncludeCache(IResourceG
             }.ToImmutableHashSet())
         }.ToImmutableHashSet());
 
-        var cache = new EvaluatedIncludeCache();
+        var cache = new EvaluatedIncludeCache(Array.Empty<IQueryConstraintProvider>());
         cache.Set(include);
         return cache;
     }

src/JsonApiDotNetCore/Queries/Internal/EvaluatedIncludeCache.cs

@@ -5,19 +5,48 @@ namespace JsonApiDotNetCore.Queries.Internal;
 /// <inheritdoc />
 internal sealed class EvaluatedIncludeCache : IEvaluatedIncludeCache
 {
+    private readonly IEnumerable<IQueryConstraintProvider> _constraintProviders;
     private IncludeExpression? _include;
+    private bool _isAssigned;
+
+    public EvaluatedIncludeCache(IEnumerable<IQueryConstraintProvider> constraintProviders)
+    {
+        ArgumentGuard.NotNull(constraintProviders);
+
+        _constraintProviders = constraintProviders;
+    }
 
     /// <inheritdoc />
     public void Set(IncludeExpression include)
     {
         ArgumentGuard.NotNull(include);
 
         _include = include;
+        _isAssigned = true;
     }
 
     /// <inheritdoc />
     public IncludeExpression? Get()
     {
+        if (!_isAssigned)
+        {
+            // In case someone has replaced the built-in JsonApiResourceService with their own that "forgets" to populate the cache,
+            // then as a fallback, we feed the requested includes from query string to the response serializer.
+
+            // @formatter:wrap_chained_method_calls chop_always
+            // @formatter:keep_existing_linebreaks true
+
+            _include = _constraintProviders.SelectMany(provider => provider.GetConstraints())
+                .Where(constraint => constraint.Scope == null)
+                .Select(constraint => constraint.Expression)
+                .OfType<IncludeExpression>()
+                .FirstOrDefault();
+
+            // @formatter:keep_existing_linebreaks restore
+            // @formatter:wrap_chained_method_calls restore
+            _isAssigned = true;
+        }
+
         return _include;
     }
 }

test/JsonApiDotNetCoreTests/UnitTests/Serialization/Response/IncompleteResourceGraphTests.cs

@@ -34,7 +34,7 @@ public void Fails_when_derived_type_is_missing_in_resource_graph()
         var resourceDefinitionAccessor = new FakeResourceDefinitionAccessor();
         var sparseFieldSetCache = new SparseFieldSetCache(Array.Empty<IQueryConstraintProvider>(), resourceDefinitionAccessor);
         var requestQueryStringAccessor = new FakeRequestQueryStringAccessor();
-        var evaluatedIncludeCache = new EvaluatedIncludeCache();
+        var evaluatedIncludeCache = new EvaluatedIncludeCache(Array.Empty<IQueryConstraintProvider>());
 
         var responseModelAdapter = new ResponseModelAdapter(request, options, linkBuilder, metaBuilder, resourceDefinitionAccessor, evaluatedIncludeCache,
             sparseFieldSetCache, requestQueryStringAccessor);

test/JsonApiDotNetCoreTests/UnitTests/Serialization/Response/ResponseModelAdapterTests.cs

@@ -569,7 +569,7 @@ private ResponseModelAdapter CreateAdapter(IJsonApiOptions options, string? prim
             PrimaryId = primaryId
         };
 
-        var evaluatedIncludeCache = new EvaluatedIncludeCache();
+        var evaluatedIncludeCache = new EvaluatedIncludeCache(Array.Empty<IQueryConstraintProvider>());
         var linkBuilder = new FakeLinkBuilder();
         var metaBuilder = new FakeMetaBuilder();
         var resourceDefinitionAccessor = new FakeResourceDefinitionAccessor();