Enable to enforce pagination disabled per relationship

Author: bkoelman

src/JsonApiDotNetCore.Annotations/Resources/Annotations/HasManyAttribute.cs

@@ -50,6 +50,18 @@ public HasManyCapabilities Capabilities
         set => _capabilities = value;
     }
 
+    /// <summary>
+    /// When set to <c>true</c>, overrules the default page size, the page size from a resource definition, and the
+    /// <c>
+    /// page[size]
+    /// </c>
+    /// query string parameter by forcibly turning off pagination on the related resources for this relationship.
+    /// </summary>
+    /// <remarks>
+    /// Caution: only use this when the number of related resources (along with their nested includes) is known to always be small.
+    /// </remarks>
+    public bool DisablePagination { get; set; }
+
     public HasManyAttribute()
     {
         _lazyIsManyToMany = new Lazy<bool>(EvaluateIsManyToMany, LazyThreadSafetyMode.PublicationOnly);

src/JsonApiDotNetCore.Annotations/Resources/Annotations/HasManyAttribute.netstandard.cs

@@ -11,4 +11,7 @@ public sealed class HasManyAttribute : RelationshipAttribute
 {
     /// <summary />
     public HasManyCapabilities Capabilities { get; set; }
+
+    /// <summary />
+    public bool DisablePagination { get; set; }
 }

src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs

@@ -105,7 +105,8 @@ public interface IJsonApiOptions
     bool IncludeTotalResourceCount { get; }
 
     /// <summary>
-    /// The page size (10 by default) that is used when not specified in query string. Set to <c>null</c> to not use pagination by default.
+    /// The page size (10 by default) that is used when not specified in query string. Set to <c>null</c> to not use pagination by default. This setting can
+    /// be overruled per relationship by setting <see cref="HasManyAttribute.DisablePagination" /> to <c>true</c>.
     /// </summary>
     PageSize? DefaultPageSize { get; }
 

src/JsonApiDotNetCore/Queries/Expressions/QueryExpressionRewriter.cs

@@ -124,7 +124,7 @@ public override QueryExpression VisitIsType(IsTypeExpression expression, TArgume
 
         if (newElements.Count != 0)
         {
-            var newExpression = new SortExpression(newElements);
+            var newExpression = new SortExpression(newElements, expression.IsAutoGenerated);
             return newExpression.Equals(expression) ? expression : newExpression;
         }
 

src/JsonApiDotNetCore/Queries/Expressions/SortExpression.cs

@@ -13,16 +13,27 @@ namespace JsonApiDotNetCore.Queries.Expressions;
 [PublicAPI]
 public class SortExpression : QueryExpression
 {
+    /// <summary>
+    /// Indicates whether this expression was generated by JsonApiDotNetCore to ensure a deterministic order.
+    /// </summary>
+    internal bool IsAutoGenerated { get; }
+
     /// <summary>
     /// One or more elements to sort on.
     /// </summary>
     public IImmutableList<SortElementExpression> Elements { get; }
 
     public SortExpression(IImmutableList<SortElementExpression> elements)
+        : this(elements, false)
+    {
+    }
+
+    internal SortExpression(IImmutableList<SortElementExpression> elements, bool isAutoGenerated)
     {
         ArgumentGuard.NotNullNorEmpty(elements);
 
         Elements = elements;
+        IsAutoGenerated = isAutoGenerated;
     }
 
     public override TResult Accept<TArgument, TResult>(QueryExpressionVisitor<TArgument, TResult> visitor, TArgument argument)
@@ -37,7 +48,7 @@ public override string ToString()
 
     public override string ToFullString()
     {
-        return string.Join(",", Elements.Select(child => child.ToFullString()));
+        return $"{string.Join(",", Elements.Select(child => child.ToFullString()))}{(IsAutoGenerated ? " (auto-generated)" : "")}";
     }
 
     public override bool Equals(object? obj)
@@ -54,12 +65,13 @@ public override bool Equals(object? obj)
 
         var other = (SortExpression)obj;
 
-        return Elements.SequenceEqual(other.Elements);
+        return IsAutoGenerated == other.IsAutoGenerated && Elements.SequenceEqual(other.Elements);
     }
 
     public override int GetHashCode()
     {
         var hashCode = new HashCode();
+        hashCode.Add(IsAutoGenerated);
 
         foreach (SortElementExpression element in Elements)
         {

src/JsonApiDotNetCore/Queries/QueryLayerComposer.cs

@@ -243,12 +243,13 @@ private IImmutableSet<IncludeElementExpression> ProcessIncludeSet(IImmutableSet<
 
                 ResourceType resourceType = includeElement.Relationship.RightType;
                 bool isToManyRelationship = includeElement.Relationship is HasManyAttribute;
+                bool allowPagination = includeElement.Relationship is HasManyAttribute { DisablePagination: false };
 
                 var subLayer = new QueryLayer(resourceType)
                 {
                     Filter = isToManyRelationship ? GetFilter(expressionsInCurrentScope, resourceType) : null,
                     Sort = isToManyRelationship ? GetSort(expressionsInCurrentScope, resourceType) : null,
-                    Pagination = isToManyRelationship ? GetPagination(expressionsInCurrentScope, resourceType) : null,
+                    Pagination = isToManyRelationship && allowPagination ? GetPagination(expressionsInCurrentScope, resourceType) : null,
                     Selection = GetSelectionForSparseAttributeSet(resourceType)
                 };
 
@@ -384,12 +385,25 @@ public QueryLayer WrapLayerForSecondaryEndpoint<TId>(QueryLayer secondaryLayer,
         FilterExpression? primaryFilter = GetFilter(Array.Empty<QueryExpression>(), primaryResourceType);
         AttrAttribute primaryIdAttribute = GetIdAttribute(primaryResourceType);
 
-        return new QueryLayer(primaryResourceType)
+        var primaryLayer = new QueryLayer(primaryResourceType)
         {
             Include = RewriteIncludeForSecondaryEndpoint(innerInclude, relationship),
             Filter = CreateFilterByIds([primaryId], primaryIdAttribute, primaryFilter),
             Selection = primarySelection
         };
+
+        if (relationship is HasManyAttribute { DisablePagination: true } && secondaryLayer.Pagination != null)
+        {
+            secondaryLayer.Pagination = null;
+            _paginationContext.PageSize = null;
+
+            if (secondaryLayer.Sort is { IsAutoGenerated: true })
+            {
+                secondaryLayer.Sort = null;
+            }
+        }
+
+        return primaryLayer;
     }
 
     private IncludeExpression RewriteIncludeForSecondaryEndpoint(IncludeExpression? relativeInclude, RelationshipAttribute secondaryRelationship)
@@ -554,7 +568,7 @@ private SortExpression CreateSortById(ResourceType resourceType)
     {
         AttrAttribute idAttribute = GetIdAttribute(resourceType);
         var idAscendingSort = new SortElementExpression(new ResourceFieldChainExpression(idAttribute), true);
-        return new SortExpression(ImmutableArray.Create(idAscendingSort));
+        return new SortExpression(ImmutableArray.Create(idAscendingSort), true);
     }
 
     protected virtual PaginationExpression GetPagination(IReadOnlyCollection<QueryExpression> expressionsInScope, ResourceType resourceType)

test/AnnotationTests/Models/TreeNode.cs

@@ -17,6 +17,7 @@ public sealed class TreeNode : Identifiable<long>
     [HasOne(PublicName = "orders", Capabilities = HasOneCapabilities.AllowView | HasOneCapabilities.AllowInclude, Links = LinkTypes.All)]
     public TreeNode? Parent { get; set; }
 
-    [HasMany(PublicName = "orders", Capabilities = HasManyCapabilities.AllowView | HasManyCapabilities.AllowFilter, Links = LinkTypes.All)]
+    [HasMany(PublicName = "orders", Capabilities = HasManyCapabilities.AllowView | HasManyCapabilities.AllowFilter, Links = LinkTypes.All,
+        DisablePagination = true)]
     public ISet<TreeNode> Children { get; set; } = new HashSet<TreeNode>();
 }

test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/Appointment.cs

@@ -20,6 +20,9 @@ public sealed class Appointment : Identifiable<int>
     [Attr]
     public DateTimeOffset EndTime { get; set; }
 
-    [HasMany]
+    [HasOne]
+    public Calendar? Calendar { get; set; }
+
+    [HasMany(DisablePagination = true)]
     public IList<Reminder> Reminders { get; set; } = new List<Reminder>();
 }