Skip to content

Commit 0100ddf

Browse files
spike83spike83
committed
Feat: added pagination with metadata
- metadata to indicate the count of pages and total count of records - acceptance tests pagination in combination with filters and sorting
1 parent 8dd97a9 commit 0100ddf

11 files changed

Lines changed: 357 additions & 7 deletions

‎JSONAPI.AcceptanceTests.EntityFrameworkTestWebApp.Tests/Fixtures/Pagination/GetAllResponsePaged-2-2.json‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"meta": {
3+
"total-pages": 2,
4+
"total-count": 4
5+
},
6+
"data": [
7+
{
8+
"type": "posts",
9+
"id": "203",
10+
"attributes": {
11+
"content": "Post 3 content",
12+
"created": "2015-02-07T11:11:00.0000000+00:00",
13+
"title": "Post 3"
14+
},
15+
"relationships": {
16+
"author": {
17+
"links": {
18+
"self": "https://www.example.com/posts/203/relationships/author",
19+
"related": "https://www.example.com/posts/203/author"
20+
}
21+
},
22+
"comments": {
23+
"links": {
24+
"self": "https://www.example.com/posts/203/relationships/comments",
25+
"related": "https://www.example.com/posts/203/comments"
26+
}
27+
},
28+
"tags": {
29+
"links": {
30+
"self": "https://www.example.com/posts/203/relationships/tags",
31+
"related": "https://www.example.com/posts/203/tags"
32+
}
33+
}
34+
}
35+
},
36+
{
37+
"type": "posts",
38+
"id": "204",
39+
"attributes": {
40+
"content": "Post 4 content",
41+
"created": "2015-02-08T06:59:00.0000000+00:00",
42+
"title": "Post 4"
43+
},
44+
"relationships": {
45+
"author": {
46+
"links": {
47+
"self": "https://www.example.com/posts/204/relationships/author",
48+
"related": "https://www.example.com/posts/204/author"
49+
}
50+
},
51+
"comments": {
52+
"links": {
53+
"self": "https://www.example.com/posts/204/relationships/comments",
54+
"related": "https://www.example.com/posts/204/comments"
55+
}
56+
},
57+
"tags": {
58+
"links": {
59+
"self": "https://www.example.com/posts/204/relationships/tags",
60+
"related": "https://www.example.com/posts/204/tags"
61+
}
62+
}
63+
}
64+
}
65+
]
66+
}

‎JSONAPI.AcceptanceTests.EntityFrameworkTestWebApp.Tests/Fixtures/Pagination/GetFilterPaged-1-2-sorted-desc.json‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"meta": {
3+
"total-pages": 2,
4+
"total-count": 3
5+
},
6+
"data": [
7+
{
8+
"type": "users",
9+
"id": "410",
10+
"attributes": {
11+
"first-name": "Sally",
12+
"last-name": "Burns"
13+
},
14+
"relationships": {
15+
"comments": {
16+
"links": {
17+
"self": "https://www.example.com/users/410/relationships/comments",
18+
"related": "https://www.example.com/users/410/comments"
19+
}
20+
},
21+
"posts": {
22+
"links": {
23+
"self": "https://www.example.com/users/410/relationships/posts",
24+
"related": "https://www.example.com/users/410/posts"
25+
}
26+
},
27+
"user-groups": {
28+
"links": {
29+
"self": "https://www.example.com/users/410/relationships/user-groups",
30+
"related": "https://www.example.com/users/410/user-groups"
31+
}
32+
}
33+
}
34+
},
35+
{
36+
"type": "users",
37+
"id": "406",
38+
"attributes": {
39+
"first-name": "Ed",
40+
"last-name": "Burns"
41+
},
42+
"relationships": {
43+
"comments": {
44+
"links": {
45+
"self": "https://www.example.com/users/406/relationships/comments",
46+
"related": "https://www.example.com/users/406/comments"
47+
}
48+
},
49+
"posts": {
50+
"links": {
51+
"self": "https://www.example.com/users/406/relationships/posts",
52+
"related": "https://www.example.com/users/406/posts"
53+
}
54+
},
55+
"user-groups": {
56+
"links": {
57+
"self": "https://www.example.com/users/406/relationships/user-groups",
58+
"related": "https://www.example.com/users/406/user-groups"
59+
}
60+
}
61+
}
62+
}
63+
]
64+
}

‎JSONAPI.AcceptanceTests.EntityFrameworkTestWebApp.Tests/Fixtures/Pagination/GetFilterPaged-1-2-sorted.json‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"meta": {
3+
"total-pages": 2,
4+
"total-count": 3
5+
},
6+
"data": [
7+
{
8+
"type": "users",
9+
"id": "409",
10+
"attributes": {
11+
"first-name": "Charlie",
12+
"last-name": "Burns"
13+
},
14+
"relationships": {
15+
"comments": {
16+
"links": {
17+
"self": "https://www.example.com/users/409/relationships/comments",
18+
"related": "https://www.example.com/users/409/comments"
19+
}
20+
},
21+
"posts": {
22+
"links": {
23+
"self": "https://www.example.com/users/409/relationships/posts",
24+
"related": "https://www.example.com/users/409/posts"
25+
}
26+
},
27+
"user-groups": {
28+
"links": {
29+
"self": "https://www.example.com/users/409/relationships/user-groups",
30+
"related": "https://www.example.com/users/409/user-groups"
31+
}
32+
}
33+
}
34+
},
35+
{
36+
"type": "users",
37+
"id": "406",
38+
"attributes": {
39+
"first-name": "Ed",
40+
"last-name": "Burns"
41+
},
42+
"relationships": {
43+
"comments": {
44+
"links": {
45+
"self": "https://www.example.com/users/406/relationships/comments",
46+
"related": "https://www.example.com/users/406/comments"
47+
}
48+
},
49+
"posts": {
50+
"links": {
51+
"self": "https://www.example.com/users/406/relationships/posts",
52+
"related": "https://www.example.com/users/406/posts"
53+
}
54+
},
55+
"user-groups": {
56+
"links": {
57+
"self": "https://www.example.com/users/406/relationships/user-groups",
58+
"related": "https://www.example.com/users/406/user-groups"
59+
}
60+
}
61+
}
62+
}
63+
]
64+
}

‎JSONAPI.AcceptanceTests.EntityFrameworkTestWebApp.Tests/Fixtures/Pagination/GetFilterPaged-2-1.json‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"meta": {
3+
"total-pages": 3,
4+
"total-count": 3
5+
},
6+
"data": [
7+
{
8+
"type": "users",
9+
"id": "409",
10+
"attributes": {
11+
"first-name": "Charlie",
12+
"last-name": "Burns"
13+
},
14+
"relationships": {
15+
"comments": {
16+
"links": {
17+
"self": "https://www.example.com/users/409/relationships/comments",
18+
"related": "https://www.example.com/users/409/comments"
19+
}
20+
},
21+
"posts": {
22+
"links": {
23+
"self": "https://www.example.com/users/409/relationships/posts",
24+
"related": "https://www.example.com/users/409/posts"
25+
}
26+
},
27+
"user-groups": {
28+
"links": {
29+
"self": "https://www.example.com/users/409/relationships/user-groups",
30+
"related": "https://www.example.com/users/409/user-groups"
31+
}
32+
}
33+
}
34+
}
35+
]
36+
}

‎JSONAPI.AcceptanceTests.EntityFrameworkTestWebApp.Tests/JSONAPI.AcceptanceTests.EntityFrameworkTestWebApp.Tests.csproj‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@
106106
<Compile Include="CreatingResourcesTests.cs" />
107107
<Compile Include="DeletingResourcesTests.cs" />
108108
<Compile Include="ErrorsTests.cs" />
109+
<Compile Include="PaginationTests.cs" />
109110
<Compile Include="FetchingResourcesTests.cs" />
110111
<Compile Include="HeterogeneousTests.cs" />
111112
<Compile Include="MappedTests.cs" />
@@ -271,8 +272,13 @@
271272
<EmbeddedResource Include="Fixtures\UpdatingResources\Responses\PatchWithAttributeUpdateResponseID.json" />
272273
<EmbeddedResource Include="Fixtures\UpdatingResources\Requests\PatchWithAttributeUpdateRequestLongId.json" />
273274
<EmbeddedResource Include="Fixtures\UpdatingResources\Responses\PatchWithAttributeUpdateResponseLongId.json" />
275+
<EmbeddedResource Include="Fixtures\Pagination\GetAllResponsePaged-2-2.json" />
276+
<EmbeddedResource Include="Fixtures\Pagination\GetFilterPaged-2-1.json" />
277+
<EmbeddedResource Include="Fixtures\Pagination\GetFilterPaged-1-2-sorted.json" />
278+
<EmbeddedResource Include="Fixtures\Pagination\GetFilterPaged-1-2-sorted-desc.json" />
274279
<None Include="packages.config" />
275280
</ItemGroup>
281+
<ItemGroup />
276282
<Choose>
277283
<When Condition="'$(VisualStudioVersion)' == '10.0' And '$(IsCodedUITest)' == 'True'">
278284
<ItemGroup>

‎JSONAPI.AcceptanceTests.EntityFrameworkTestWebApp.Tests/PaginationTests.cs‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
using System.Net;
2+
using System.Threading.Tasks;
3+
using Microsoft.VisualStudio.TestTools.UnitTesting;
4+
5+
namespace JSONAPI.AcceptanceTests.EntityFrameworkTestWebApp.Tests
6+
{
7+
[TestClass]
8+
public class PaginationTests : AcceptanceTestsBase
9+
{
10+
[TestMethod]
11+
[DeploymentItem(@"Data\Comment.csv", @"Data")]
12+
[DeploymentItem(@"Data\Post.csv", @"Data")]
13+
[DeploymentItem(@"Data\PostTagLink.csv", @"Data")]
14+
[DeploymentItem(@"Data\Tag.csv", @"Data")]
15+
[DeploymentItem(@"Data\User.csv", @"Data")]
16+
public async Task GetPage2Post2()
17+
{
18+
using (var effortConnection = GetEffortConnection())
19+
{
20+
var response = await SubmitGet(effortConnection, "posts?page[number]=1&page[size]=2");
21+
22+
await AssertResponseContent(response, @"Fixtures\Pagination\GetAllResponsePaged-2-2.json", HttpStatusCode.OK);
23+
}
24+
}
25+
26+
[TestMethod]
27+
[DeploymentItem(@"Data\Comment.csv", @"Data")]
28+
[DeploymentItem(@"Data\Post.csv", @"Data")]
29+
[DeploymentItem(@"Data\PostTagLink.csv", @"Data")]
30+
[DeploymentItem(@"Data\Tag.csv", @"Data")]
31+
[DeploymentItem(@"Data\User.csv", @"Data")]
32+
public async Task GetWithFilter()
33+
{
34+
using (var effortConnection = GetEffortConnection())
35+
{
36+
var response = await SubmitGet(effortConnection, "users?filter[last-name]=Burns&page[number]=1&page[size]=1");
37+
38+
await AssertResponseContent(response, @"Fixtures\Pagination\GetFilterPaged-2-1.json", HttpStatusCode.OK);
39+
}
40+
}
41+
42+
43+
[TestMethod]
44+
[DeploymentItem(@"Data\Comment.csv", @"Data")]
45+
[DeploymentItem(@"Data\Post.csv", @"Data")]
46+
[DeploymentItem(@"Data\PostTagLink.csv", @"Data")]
47+
[DeploymentItem(@"Data\Tag.csv", @"Data")]
48+
[DeploymentItem(@"Data\User.csv", @"Data")]
49+
public async Task GetWithFilterSortedAscTest()
50+
{
51+
using (var effortConnection = GetEffortConnection())
52+
{
53+
var response = await SubmitGet(effortConnection, "users?filter[last-name]=Burns&page[number]=0&page[size]=2&sort=first-name");
54+
55+
await AssertResponseContent(response, @"Fixtures\Pagination\GetFilterPaged-1-2-sorted.json", HttpStatusCode.OK);
56+
}
57+
}
58+
59+
60+
[TestMethod]
61+
[DeploymentItem(@"Data\Comment.csv", @"Data")]
62+
[DeploymentItem(@"Data\Post.csv", @"Data")]
63+
[DeploymentItem(@"Data\PostTagLink.csv", @"Data")]
64+
[DeploymentItem(@"Data\Tag.csv", @"Data")]
65+
[DeploymentItem(@"Data\User.csv", @"Data")]
66+
public async Task GetWithFilterSortedDescTest()
67+
{
68+
using (var effortConnection = GetEffortConnection())
69+
{
70+
var response = await SubmitGet(effortConnection, "users?filter[last-name]=Burns&page[number]=0&page[size]=2&sort=-first-name");
71+
72+
await AssertResponseContent(response, @"Fixtures\Pagination\GetFilterPaged-1-2-sorted-desc.json", HttpStatusCode.OK);
73+
}
74+
}
75+
76+
}
77+
}

‎JSONAPI/Documents/Builders/DefaultQueryableResourceCollectionDocumentBuilder.cs‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
using System.Linq;
1+
using System;
2+
using System.Linq;
23
using System.Net.Http;
34
using System.Threading;
45
using System.Threading.Tasks;
56
using JSONAPI.Http;
67
using JSONAPI.QueryableTransformers;
8+
using Newtonsoft.Json.Linq;
79

810
namespace JSONAPI.Documents.Builders
911
{
@@ -60,7 +62,14 @@ public async Task<IResourceCollectionDocument> BuildDocument<T>(IQueryable<T> qu
6062
protected virtual Task<IMetadata> GetDocumentMetadata<T>(IQueryable<T> originalQuery, IQueryable<T> filteredQuery, IOrderedQueryable<T> sortedQuery,
6163
IPaginationTransformResult<T> paginationResult, CancellationToken cancellationToken)
6264
{
63-
return Task.FromResult((IMetadata)null);
65+
var metadata = new Metadata();
66+
if (paginationResult.PaginationWasApplied) {
67+
metadata.MetaObject.Add("total-pages", (int)Math.Ceiling((decimal)filteredQuery.Count() / paginationResult.PageSize));
68+
metadata.MetaObject.Add("total-count", filteredQuery.Count());
69+
}
70+
if (metadata.MetaObject.HasValues)
71+
return Task.FromResult((IMetadata)metadata);
72+
return Task.FromResult((IMetadata) null);
6473
}
6574
}
6675
}

‎JSONAPI/Documents/Metadata.cs‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
using Newtonsoft.Json.Linq;
2+
3+
namespace JSONAPI.Documents
4+
{
5+
/// <summary>
6+
/// Default implementation of <see cref="IMetadata"/>
7+
/// </summary>
8+
public class Metadata : IMetadata
9+
{
10+
public Metadata()
11+
{
12+
MetaObject = new JObject();
13+
}
14+
public JObject MetaObject { get; }
15+
}
16+
}

‎JSONAPI/JSONAPI.csproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
<Compile Include="Core\ResourceTypeRelationship.cs" />
9191
<Compile Include="Core\ToManyResourceTypeRelationship.cs" />
9292
<Compile Include="Core\ToOneResourceTypeRelationship.cs" />
93+
<Compile Include="Documents\Metadata.cs" />
9394
<Compile Include="Http\DefaultSortExpressionExtractor.cs" />
9495
<Compile Include="Http\DocumentMaterializerLocator.cs" />
9596
<Compile Include="Http\IDocumentMaterializerLocator.cs" />

0 commit comments

Comments
 (0)