Merged feature/pagination into develop

Author: jaredcnance

.gitlab-ci.yml

@@ -8,13 +8,7 @@ before_script:
 build:
  stage: build
  script:
-  - 'dotnet pack ./src/JsonApiDotNetCore -c Release -o ./artifacts'
+  - dotnet pack ./src/JsonApiDotNetCore -c Release -o ./artifacts
+  - mono /bin/NuGet.exe push artifacts/**.nupkg -ApiKey $NUGET_KEY
  only:
    - master
-
-publish:
-  stage: deploy
-  script:
-   - 'mono /bin/NuGet.exe push ./artifacts/*.nupkg $NUGET_KEY -Source $NUGET_SOURCE'
-  only:
-   - master

README.md

@@ -27,6 +27,10 @@
 - [ ] Ability to disable dasherization of names
 - [ ] Rename ContextEntity ?? 
 
+# Generators
+
+- TODO: Document usage of the yeoman jadn generator
+
 ## Usage
 
 - Add Middleware
@@ -147,3 +151,13 @@ You can add a namespace to the URL by specifying it in `ConfigureServices`:
 services.AddJsonApi<AppDbContext>(
     opt => opt.Namespace = "api/v1");
 ```
+
+## Pagination
+
+If you would like pagination implemented by default, you can specify the page size
+when setting up the services:
+
+```
+ services.AddJsonApi<AppDbContext>(
+     opt => opt.DefaultPageSize = 10);
+```

src/JsonApiDotNetCore/Builders/LinkBuilder.cs

@@ -36,12 +36,12 @@ private string GetNamespaceFromPath(string path, string entityName)
 
         public string GetSelfRelationLink(string parent, string parentId, string child)
         {
-            return $"{_context.BasePath}/{parent.Dasherize()}/{parentId}/relationships/{child.Dasherize()}";
+            return $"{_context.BasePath}/relationships/{child.Dasherize()}";
         }
 
         public string GetRelatedRelationLink(string parent, string parentId, string child)
         {
-            return $"{_context.BasePath}/{parent.Dasherize()}/{parentId}/{child.Dasherize()}";
+            return $"{_context.BasePath}/{child.Dasherize()}";
         }
     }
 }

src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs

@@ -3,5 +3,6 @@ namespace JsonApiDotNetCore.Configuration
     public class JsonApiOptions
     {
         public string Namespace { get; set; }
+        public int DefaultPageSize { get; set; }
     }
 }

src/JsonApiDotNetCore/Controllers/JsonApiController.cs

@@ -1,8 +1,10 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
 using JsonApiDotNetCore.Data;
 using JsonApiDotNetCore.Extensions;
+using JsonApiDotNetCore.Internal.Query;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Mvc;
@@ -36,6 +38,7 @@ public JsonApiController(
             ILoggerFactory loggerFactory)
         {
             _jsonApiContext = jsonApiContext.ApplyContext<T>();
+
             _entities = entityRepository;
 
             _logger = loggerFactory.CreateLogger<JsonApiController<T, TId>>();
@@ -47,21 +50,25 @@ public JsonApiController(
             IJsonApiContext jsonApiContext,
             IEntityRepository<T, TId> entityRepository)
         {
+            _jsonApiContext = jsonApiContext.ApplyContext<T>();
             _jsonApiContext = jsonApiContext;
             _entities = entityRepository;
         }
 
         [HttpGet]
-        public virtual IActionResult Get()
+        public virtual async Task<IActionResult> GetAsync()
         {
             var entities = _entities.Get();
 
             entities = ApplySortAndFilterQuery(entities);
 
-            if(_jsonApiContext.QuerySet != null)
+            if (_jsonApiContext.QuerySet != null && _jsonApiContext.QuerySet.IncludedRelationships != null && _jsonApiContext.QuerySet.IncludedRelationships.Count > 0)
                 entities = IncludeRelationships(entities, _jsonApiContext.QuerySet.IncludedRelationships);
 
-            return Ok(entities);
+            // pagination should be done last since it will execute the query
+            var pagedEntities = await ApplyPageQueryAsync(entities);
+
+            return Ok(pagedEntities);
         }
 
         [HttpGet("{id}")]
@@ -142,12 +149,6 @@ public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] T entity)
             return Ok(updatedEntity);
         }
 
-        // [HttpPatch("{id}/{relationship}")]
-        // public virtual IActionResult PatchRelationship(int id, string relation) 
-        // {
-        //     return Ok("Patch Id/relationship");
-        // }
-
         [HttpDelete("{id}")]
         public virtual async Task<IActionResult> DeleteAsync(TId id)
         {
@@ -159,26 +160,37 @@ public virtual async Task<IActionResult> DeleteAsync(TId id)
             return Ok();
         }
 
-        // [HttpDelete("{id}/{relationship}")]
-        // public virtual IActionResult Delete(int id, string relation) 
-        // {
-        //     return Ok("Delete Id/relationship");
-        // }
-
         private IQueryable<T> ApplySortAndFilterQuery(IQueryable<T> entities)
         {
             var query = _jsonApiContext.QuerySet;
 
             if(_jsonApiContext.QuerySet == null)
                 return entities;
 
-            entities = _entities.Filter(entities, query.Filter);
+            if(query.Filter != null)
+                entities = _entities.Filter(entities, query.Filter);
 
-            entities = _entities.Sort(entities, query.SortParameters);
+            if(query.SortParameters != null && query.SortParameters.Count > 0)
+                entities = _entities.Sort(entities, query.SortParameters);
 
             return entities;
         }
 
+        private async Task<IEnumerable<T>> ApplyPageQueryAsync(IQueryable<T> entities)
+        {
+            if(_jsonApiContext.Options.DefaultPageSize == 0 && (_jsonApiContext.QuerySet == null || _jsonApiContext.QuerySet.PageQuery.PageSize == 0))
+                return entities;
+
+            var query = _jsonApiContext.QuerySet?.PageQuery ?? new PageQuery();
+            
+            var pageNumber = query.PageOffset > 0 ? query.PageOffset : 1;
+            var pageSize = query.PageSize > 0 ? query.PageSize : _jsonApiContext.Options.DefaultPageSize;
+
+            _logger?.LogInformation($"Applying paging query. Fetching page {pageNumber} with {pageSize} entities");
+
+            return await _entities.PageAsync(entities, pageSize, pageNumber);
+        }
+
         private IQueryable<T> IncludeRelationships(IQueryable<T> entities, List<string> relationships)
         {
             _jsonApiContext.IncludedRelationships = relationships;

src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs

@@ -132,5 +132,16 @@ public IQueryable<TEntity> Include(IQueryable<TEntity> entities, string relation
             throw new JsonApiException("400", "Invalid relationship",
                 $"{entity.EntityName} does not have a relationship named {relationshipName}");
         }
+
+        public async Task<IEnumerable<TEntity>> PageAsync(IQueryable<TEntity> entities, int pageSize, int pageNumber)
+        {
+            if(pageSize > 0)
+                return await entities
+                    .Skip((pageNumber - 1) * pageSize)
+                    .Take(pageSize)
+                    .ToListAsync();
+
+            return await entities.ToListAsync();
+        }
     }
 }

src/JsonApiDotNetCore/Data/IEntityRepository.cs

@@ -23,6 +23,8 @@ public interface IEntityRepository<TEntity, in TId>
 
         IQueryable<TEntity> Sort(IQueryable<TEntity> entities, List<SortQuery> sortQueries);
 
+        Task<IEnumerable<TEntity>> PageAsync(IQueryable<TEntity> entities, int pageSize, int pageNumber);
+
         Task<TEntity> GetAsync(TId id);
 
         Task<TEntity> GetAndIncludeAsync(TId id, string relationshipName);

src/JsonApiDotNetCore/Extensions/ServiceProviderExtensions.cs

@@ -30,25 +30,25 @@ public static void AddJsonApi<TContext>(this IServiceCollection services, Action
         private static void _addInternals<TContext>(IServiceCollection services, JsonApiOptions jsonApiOptions)
             where TContext : DbContext
         {
-            services.AddJsonApiInternals<TContext>();
+            services.AddJsonApiInternals<TContext>(jsonApiOptions);
             services.AddMvc()
                 .AddMvcOptions(opt => {
                     opt.Filters.Add(typeof(JsonApiExceptionFilter));
                     opt.SerializeAsJsonApi(jsonApiOptions);
                 });
         }
 
-        public static void AddJsonApiInternals<TContext>(this IServiceCollection services) 
+        public static void AddJsonApiInternals<TContext>(this IServiceCollection services, JsonApiOptions jsonApiOptions) 
             where TContext : DbContext
         {
             var contextGraphBuilder = new ContextGraphBuilder<TContext>();
             var contextGraph = contextGraphBuilder.Build();
 
             services.AddScoped(typeof(DbContext), typeof(TContext));
-
             services.AddScoped(typeof(IEntityRepository<>), typeof(DefaultEntityRepository<>));
             services.AddScoped(typeof(IEntityRepository<,>), typeof(DefaultEntityRepository<,>));
 
+            services.AddSingleton<JsonApiOptions>(jsonApiOptions);
             services.AddSingleton<IContextGraph>(contextGraph);
             services.AddScoped<IJsonApiContext,JsonApiContext>();
             services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();

src/JsonApiDotNetCore/Internal/Query/PageQuery.cs

@@ -0,0 +1,8 @@
+namespace JsonApiDotNetCore.Internal.Query
+{
+    public class PageQuery
+    {
+       public int PageSize { get; set; }
+       public int PageOffset { get; set; }
+    }
+}

src/JsonApiDotNetCore/Internal/Query/QuerySet.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using JsonApiDotNetCore.Extensions;
@@ -10,13 +11,16 @@ public class QuerySet
     {
         IJsonApiContext _jsonApiContext;
 
-        public QuerySet(IJsonApiContext jsonApiContext, IQueryCollection query)
+        public QuerySet(
+            IJsonApiContext jsonApiContext, 
+            IQueryCollection query)
         {
             _jsonApiContext = jsonApiContext;
             BuildQuerySet(query);
         }
 
         public FilterQuery Filter { get; set; }
+        public PageQuery PageQuery { get; set; }
         public List<SortQuery> SortParameters { get; set; }
         public List<string> IncludedRelationships { get; set; }
 
@@ -40,6 +44,11 @@ private void BuildQuerySet(IQueryCollection query)
                 {
                     IncludedRelationships = ParseIncludedRelationships(pair.Value);
                 }
+
+                if (pair.Key.StartsWith("page"))
+                {
+                    PageQuery = ParsePageQuery(pair.Key, pair.Value);
+                }
             }
         }
 
@@ -49,12 +58,28 @@ private FilterQuery ParseFilterQuery(string key, string value)
             var propertyName = key.Split('[', ']')[1];
             var attribute = GetAttribute(propertyName);
 
-            if(attribute == null)
+            if (attribute == null)
                 return null;
-
+            
             return new FilterQuery(attribute, value);
         }
 
+        private PageQuery ParsePageQuery(string key, string value)
+        {
+            // expected input = page[size]=10
+            //                  page[number]=1
+            PageQuery = PageQuery ?? new PageQuery();
+
+            var propertyName = key.Split('[', ']')[1];
+            
+            if (propertyName == "size")
+                PageQuery.PageSize = Convert.ToInt32(value);
+            else if (propertyName == "number")
+                PageQuery.PageOffset = Convert.ToInt32(value);
+
+            return PageQuery;
+        }
+
         // sort=id,name
         // sort=-id
         private List<SortQuery> ParseSortParameters(string value)
@@ -88,7 +113,7 @@ private List<string> ParseIncludedRelationships(string value)
         private AttrAttribute GetAttribute(string propertyName)
         {
             return _jsonApiContext.RequestEntity.Attributes
-                .FirstOrDefault(attr => 
+                .FirstOrDefault(attr =>
                     attr.InternalAttributeName.ToLower() == propertyName.ToLower()
             );
         }