Implement and export createPaginationMeta helper.

webiny · Oct 27, 2018 · eec6a1d · eec6a1d
1 parent 97b014d
commit eec6a1d
Show file tree

Hide file tree

Showing 16 changed files with 188 additions and 54 deletions.
diff --git a/packages/webiny-api-cms/src/dataSource/schemas/pageResolvers/listPages.js b/packages/webiny-api-cms/src/dataSource/schemas/pageResolvers/listPages.js
@@ -1,5 +1,6 @@
 // @flow
 import type { Entity, EntityCollection } from "webiny-entity";
+import { createPaginationMeta } from "webiny-entity";
 import { ListResponse } from "webiny-api/graphql/responses";
 
 type EntityFetcher = (context: Object) => Class<Entity>;
@@ -39,19 +40,12 @@ export default (entityFetcher: EntityFetcher) => async (
     };
 
     const pages: EntityCollection<Entity> = await entityClass.find({ sql });
-
-    const meta: Object = {
-        page,
-        perPage,
-        count: pages.length,
-        totalCount: pages.getMeta().totalCount
-    };
-
-    meta.totalPages = Math.ceil(meta.totalCount / meta.perPage);
-    meta.to = (meta.page - 1) * meta.perPage + meta.count;
-    meta.from = meta.to - meta.count + 1;
-    meta.nextPage = meta.page < meta.totalPages ? meta.page + 1 : null;
-    meta.previousPage = meta.page === 1 ? null : meta.page - 1;
-
-    return new ListResponse(pages, meta);
+    return new ListResponse(
+        pages,
+        createPaginationMeta({
+            page,
+            perPage,
+            totalCount: pages.getMeta().totalCount
+        })
+    );
 };
diff --git a/packages/webiny-api/src/graphql/crudResolvers.js b/packages/webiny-api/src/graphql/crudResolvers.js
@@ -61,16 +61,7 @@ export const resolveList = (entityFetcher: EntityFetcher) => async (
         sort: args.sort
     });
 
-    const meta = data.getParams();
-    meta.count = data.length;
-    meta.totalCount = data.getMeta().totalCount;
-    meta.totalPages = Math.ceil(meta.totalCount / meta.perPage);
-    meta.to = (meta.page - 1) * meta.perPage + meta.count;
-    meta.from = meta.to - meta.count + 1;
-    meta.nextPage = meta.page < meta.totalPages ? meta.page + 1 : null;
-    meta.previousPage = meta.page === 1 ? null : meta.page - 1;
-
-    return new ListResponse(data, meta);
+    return new ListResponse(data, data.getMeta());
 };
 
 export const resolveCreate = (entityFetcher: EntityFetcher) => async (

diff --git a/packages/webiny-api/src/graphql/schema/genericTypes.js b/packages/webiny-api/src/graphql/schema/genericTypes.js
@@ -8,7 +8,6 @@ export const genericTypes = () => {
         }
         
         type ListMeta {
-            count: Int
             totalCount: Int
             totalPages: Int
             page: Int
@@ -30,4 +29,4 @@ export const genericTypes = () => {
             data: JSON
         }
   `;
-};
+};
diff --git a/packages/webiny-app-admin/src/views/ApiTokens/graphql.js b/packages/webiny-app-admin/src/views/ApiTokens/graphql.js
@@ -1,11 +1,18 @@
+// @flow
 import gql from "graphql-tag";
 
 const fields = `
     id token name description groups { id name } roles { id name }
 `;
 
 export const loadApiTokens = gql`
-    query LoadApiTokens($where: JSON, $sort: JSON, $page: Int, $perPage: Int, $search: SearchInput) {
+    query LoadApiTokens(
+        $where: JSON
+        $sort: JSON
+        $page: Int
+        $perPage: Int
+        $search: SearchInput
+    ) {
         security {
             tokens: listApiTokens(
                 where: $where
@@ -21,9 +28,7 @@ export const loadApiTokens = gql`
                     createdOn
                 }
                 meta {
-                    count
                     totalCount
-                    totalPages
                     to
                     from
                     nextPage

diff --git a/packages/webiny-app-admin/src/views/Groups/graphql.js b/packages/webiny-app-admin/src/views/Groups/graphql.js
@@ -26,9 +26,7 @@ export const loadGroups = gql`
                     createdOn
                 }
                 meta {
-                    count
                     totalCount
-                    totalPages
                     to
                     from
                     nextPage

diff --git a/packages/webiny-app-admin/src/views/Roles/graphql.js b/packages/webiny-app-admin/src/views/Roles/graphql.js
@@ -1,3 +1,4 @@
+// @flow
 import gql from "graphql-tag";
 
 const fields = `
@@ -33,9 +34,7 @@ export const loadRoles = gql`
                     createdOn
                 }
                 meta {
-                    count
                     totalCount
-                    totalPages
                     to
                     from
                     nextPage

diff --git a/packages/webiny-app-admin/src/views/Users/graphql.js b/packages/webiny-app-admin/src/views/Users/graphql.js
@@ -1,3 +1,4 @@
+// @flow
 import gql from "graphql-tag";
 
 const fields = `
@@ -26,9 +27,7 @@ export const loadUsers = gql`
                     createdOn
                 }
                 meta {
-                    count
                     totalCount
-                    totalPages
                     to
                     from
                     nextPage

diff --git a/packages/webiny-app-cms/src/admin/graphql/pages.js b/packages/webiny-app-cms/src/admin/graphql/pages.js
@@ -1,3 +1,4 @@
+// @flow
 import gql from "graphql-tag";
 
 const error = `
@@ -45,13 +46,9 @@ export const listPages = gql`
                     }
                 }
                 meta {
-                    count
                     totalCount
-                    from
                     to
-                    page
-                    totalPages
-                    perPage
+                    from
                     nextPage
                     previousPage
                 }

diff --git a/packages/webiny-app-cms/src/admin/views/Categories/graphql.js b/packages/webiny-app-cms/src/admin/views/Categories/graphql.js
@@ -1,3 +1,4 @@
+// @flow
 import gql from "graphql-tag";
 
 const fields = `
@@ -9,7 +10,13 @@ const fields = `
 `;
 
 export const loadCategories = gql`
-    query LoadCategories($where: JSON, $sort: JSON, $page: Int, $perPage: Int, $search: SearchInput) {
+    query LoadCategories(
+        $where: JSON
+        $sort: JSON
+        $page: Int
+        $perPage: Int
+        $search: SearchInput
+    ) {
         cms {
             categories: listCategories(
                 where: $where
@@ -26,9 +33,7 @@ export const loadCategories = gql`
                     createdOn
                 }
                 meta {
-                    count
                     totalCount
-                    totalPages
                     to
                     from
                     nextPage

diff --git a/packages/webiny-entity-mysql/src/mysqlDriver.js b/packages/webiny-entity-mysql/src/mysqlDriver.js
@@ -2,7 +2,7 @@
 import _ from "lodash";
 import mdbid from "mdbid";
 import type { Connection, Pool } from "mysql";
-import { Entity, Driver, QueryResult } from "webiny-entity";
+import { Entity, Driver, QueryResult, createPaginationMeta } from "webiny-entity";
 import { MySQLConnection } from "webiny-mysql-connection";
 import { Attribute } from "webiny-model";
 import type {
@@ -173,7 +173,13 @@ class MySQLDriver extends Driver {
         const sql = new Select(clonedOptions, entity).generate();
         const results = await this.getConnection().query([sql, "SELECT FOUND_ROWS() as count"]);
 
-        return new QueryResult(results[0], { totalCount: results[1][0].count });
+        const meta = createPaginationMeta({
+            totalCount: results[1][0].count,
+            page: options.page,
+            perPage: options.perPage
+        });
+
+        return new QueryResult(results[0], meta);
     }
 
     async findOne(

diff --git a/packages/webiny-entity/__tests__/createPaginationMeta.test.js b/packages/webiny-entity/__tests__/createPaginationMeta.test.js
@@ -0,0 +1,90 @@
+import { createPaginationMeta } from "webiny-entity";
+
+describe("createPaginationMeta test", () => {
+    test("should return correct pagination meta data", async () => {
+        let meta = createPaginationMeta({
+            page: 1,
+            perPage: 10,
+            totalCount: 100
+        });
+
+        expect(meta).toEqual({
+            from: 1,
+            nextPage: 2,
+            page: 1,
+            perPage: 10,
+            previousPage: null,
+            to: 10,
+            totalCount: 100,
+            totalPages: 10
+        });
+
+        meta = createPaginationMeta({
+            totalCount: 100,
+            page: 3,
+            perPage: 7
+        });
+
+        expect(meta).toEqual({
+            page: 3,
+            perPage: 7,
+            totalCount: 100,
+            from: 15,
+            nextPage: 4,
+            previousPage: 2,
+            to: 21,
+            totalPages: 15
+        });
+
+        meta = createPaginationMeta({
+            totalCount: 100,
+            page: 3,
+            perPage: 10
+        });
+
+        expect(meta).toEqual({
+            from: 21,
+            nextPage: 4,
+            page: 3,
+            perPage: 10,
+            previousPage: 2,
+            to: 30,
+            totalCount: 100,
+            totalPages: 10
+        });
+
+        meta = createPaginationMeta({
+            totalCount: 15,
+            page: 3,
+            perPage: 6
+        });
+
+        expect(meta).toEqual({
+            from: 13,
+            nextPage: null,
+            page: 3,
+            perPage: 6,
+            previousPage: 2,
+            to: 15,
+            totalCount: 15,
+            totalPages: 3
+        });
+
+        meta = createPaginationMeta({
+            totalCount: 0,
+            page: 1,
+            perPage: 10
+        });
+
+        expect(meta).toEqual({
+            page: 1,
+            perPage: 10,
+            nextPage: null,
+            previousPage: null,
+            to: 0,
+            from: 0,
+            totalCount: 0,
+            totalPages: 0
+        });
+    });
+});
diff --git a/packages/webiny-entity/__tests__/entityCollection.test.js b/packages/webiny-entity/__tests__/entityCollection.test.js
@@ -41,12 +41,6 @@ describe("EntityCollection test", () => {
         expect(collection.getParams().a).toEqual(123);
     });
 
-    test("setTotalCount/getTotalCount methods must work correctly", async () => {
-        const collection = new EntityCollection();
-        collection.setTotalCount(444);
-        expect(collection.getTotalCount()).toEqual(444);
-    });
-
     test("setMeta/getMeta methods must work correctly", async () => {
         const collection = new EntityCollection();
         collection.setMeta({ a: 123 });

diff --git a/packages/webiny-entity/index.js b/packages/webiny-entity/index.js
@@ -7,6 +7,7 @@ export { default as EntityPoolEntry } from "./src/entityPoolEntry";
 export { default as EntityCollection } from "./src/entityCollection";
 export { default as EntityAttributesContainer } from "./src/entityAttributesContainer";
 export { default as QueryResult } from "./src/queryResult";
+export { default as createPaginationMeta } from "./src/createPaginationMeta";
 export { default as Driver } from "./src/driver";
 export { default as EventHandler } from "./src/eventHandler";
 

diff --git a/packages/webiny-entity/src/createPaginationMeta.js b/packages/webiny-entity/src/createPaginationMeta.js
@@ -0,0 +1,52 @@
+// @flow
+type PaginationMeta = {
+    page: number,
+    perPage: number,
+    totalCount: number,
+
+    totalPages: ?number,
+    from: ?number,
+    to: ?number,
+    nextPage: ?number,
+    previousPage: ?number
+};
+
+type Params = {
+    page: number,
+    perPage: number,
+    totalCount: number
+};
+
+export default (params: ?Params): PaginationMeta => {
+    const meta: PaginationMeta = {
+        page: 0,
+        perPage: 0,
+        totalCount: 0,
+        totalPages: null,
+        from: null,
+        to: null,
+        nextPage: null,
+        previousPage: null,
+        ...params
+    };
+
+    if (meta.page && meta.perPage) {
+        meta.totalPages = Math.ceil(meta.totalCount / meta.perPage);
+
+        if (meta.totalCount) {
+            meta.from = 1 + meta.perPage * (meta.page - 1);
+        } else {
+            meta.from = 0;
+        }
+
+        meta.to = meta.perPage * meta.page;
+        if (meta.to > meta.totalCount) {
+            meta.to = meta.totalCount;
+        }
+
+        meta.nextPage = meta.page < meta.totalPages ? meta.page + 1 : null;
+        meta.previousPage = meta.page === 1 ? null : meta.page - 1;
+    }
+
+    return meta;
+};