Feat: proper pagination responses

Chia-Network · Dec 28, 2021 · 5fb4019 · 5fb4019
1 parent 36009e8
commit 5fb4019
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 31 deletions.
diff --git a/src/controllers/helpers.js b/src/controllers/helpers.js
@@ -13,4 +13,16 @@ export const paginationParams = (page, limit) => {
     limit: limit ? limit : 15,
     offset: page ? page - 1 : 1,
   }
+}
+
+export const optionallyPaginatedResponse = ({count, rows}, page, limit) => {
+  if (page) {
+    return {
+      page,
+      pageCount: Math.max(count / (limit || 15)),
+      data: rows,
+    }
+  } else {
+    return rows;
+  }
 }
diff --git a/src/controllers/project.controller.js b/src/controllers/project.controller.js
@@ -11,7 +11,7 @@ import {
   RelatedProject,
 } from '../models';
 
-import { paginationParams } from './helpers';
+import { optionallyPaginatedResponse, paginationParams } from "./helpers";
 
 export const create = async (req, res) => {
   // When creating new projects assign a uuid to is so
@@ -41,13 +41,15 @@ export const findAll = async (req, res) => {
 
   const dialect = sequelize.getDialect();
 
+  let results;
+
   if (search) {
     if (dialect === 'sqlite') {
-      res.json(await Project.findAllSqliteFts(search, orgUid, paginationParams(page, limit)));
+      results = await Project.findAllSqliteFts(search, orgUid, paginationParams(page, limit));
     } else if (dialect === 'mysql') {
-      res.json(await Project.findAllMySQLFts(search, orgUid, paginationParams(page, limit)));
+      results = await Project.findAllMySQLFts(search, orgUid, paginationParams(page, limit));
     }
-    return;
+    return res.json(optionallyPaginatedResponse(results, page, limit));
   }
 
   if (req.query.onlyEssentialColumns) {
@@ -69,8 +71,11 @@ export const findAll = async (req, res) => {
       };
     }
 
-    res.json(await Project.findAll({ ...query, ...paginationParams(page, limit) }));
-    return;
+    return res.json(optionallyPaginatedResponse(
+      await Project.findAndCountAll({ ...query, ...paginationParams(page, limit) }),
+      page,
+      limit,
+    ));
   }
 
   const query = {
@@ -83,7 +88,7 @@ export const findAll = async (req, res) => {
     ],
   };
 
-  res.json(await Project.findAll(query));
+  return await Project.findAll(query);
 };
 
 export const findOne = async (req, res) => {

diff --git a/src/controllers/units.controller.js b/src/controllers/units.controller.js
@@ -3,6 +3,7 @@
 import { uuid as uuidv4 } from 'uuidv4';
 import { Staging, UnitMock, Unit, Qualification, Vintage } from '../models';
 import { paginationParams } from './helpers';
+import { optionallyPaginatedResponse, paginationParams } from "./helpers";
 
 export const create = async (req, res) => {
   try {
@@ -37,24 +38,21 @@ export const findAll = async (req, res) => {
   }
 
   if (req.query.onlyEssentialColumns) {
-    res.json(
-      await Unit.findAll({
-        attributes: [
-          'orgUid',
-          'unitLink',
-          'registry',
-          'unitType',
-          'unitCount',
-          'unitStatus',
-          'unitStatusDate',
-        ],
-      }),
-    );
-    return;
+    return res.json(optionallyPaginatedResponse(await Unit.findAndCountAll({
+      attributes: [
+        'orgUid',
+        'unitLink',
+        'registry',
+        'unitType',
+        'unitCount',
+        'unitStatus',
+        'unitStatusDate',
+      ],
+    }), page, limit));
   }
 
   res.json(
-    await Unit.findAll({
+    optionallyPaginatedResponse(await Unit.findAndCountAll({
       include: [
         {
           model: Qualification,
@@ -63,7 +61,7 @@ export const findAll = async (req, res) => {
         Vintage,
       ],
       ...paginationParams(page, limit),
-    }),
+    }), page, limit),
   );
 };
 

diff --git a/src/models/projects/projects.model.js b/src/models/projects/projects.model.js
@@ -12,6 +12,7 @@ import { Rating } from './../ratings';
 import { CoBenefit } from './../co-benefits';
 
 import ModelTypes from './projects.modeltypes.cjs';
+import { optionallyPaginatedResponse } from "../../controllers/helpers.js";
 
 class Project extends Model {
   static associate() {
@@ -23,7 +24,7 @@ class Project extends Model {
     Project.hasMany(ProjectLocation);
   }
 
-  static findAllMySQLFts(searchStr, orgUid, pagination) {
+  static async findAllMySQLFts(searchStr, orgUid, pagination) {
     const { offset, limit } = pagination;
     let sql = `
     SELECT * FROM projects WHERE MATCH (
@@ -53,13 +54,18 @@ class Project extends Model {
 
     sql = `${sql} ORDER BY relevance DESC LIMIT :limit OFFSET :offset`;
 
-    return sequelize.query(sql, {
-      model: Project,
-      replacements: { search: searchStr, orgUid },
-      mapToModel: true, // pass true here if you have any mapped fields
-      offset,
-      limit,
-    });
+    const count = await Project.count()
+
+    return {
+      count,
+      rows: await sequelize.query(sql, {
+        model: Project,
+        replacements: { search: searchStr, orgUid },
+        mapToModel: true, // pass true here if you have any mapped fields
+        offset,
+        limit,
+      })
+    };
   }
 
   static findAllSqliteFts(searchStr, orgUid, pagination ) {