Merge pull request #40 from topcoder-platform/develop

Support pagination

Author: callmekatootie

README.md

@@ -16,6 +16,7 @@ Configuration for the application is at config/default.js and config/production.
 - AUTH_SECRET: TC Authentication secret
 - VALID_ISSUERS: valid issuers for TC authentication
 - PAGE_SIZE: the default pagination limit
+- MAX_PAGE_SIZE: the maximum pagination size
 - API_VERSION: the API version
 - AWS_ACCESS_KEY_ID: The AWS access key
 - AWS_SECRET_ACCESS_KEY: The AWS secret key

config/default.js

@@ -11,6 +11,7 @@ module.exports = {
     : '["https://topcoder-dev.auth0.com/", "https://api.topcoder.com"]',
 
   PAGE_SIZE: process.env.PAGE_SIZE || 20,
+  MAX_PAGE_SIZE: parseInt(process.env.MAX_PAGE_SIZE) || 100,
   API_VERSION: process.env.API_VERSION || 'api/1.0',
 
   AWS_ACCESS_KEY_ID: process.env.AWS_ACCESS_KEY_ID,

src/bootstrap.js

@@ -2,9 +2,14 @@
  * add logger and joi to services
  */
 
+const config = require('config')
 const fs = require('fs')
 const path = require('path')
 const logger = require('./common/logger')
+const joi = require('@hapi/joi')
+
+joi.id = () => joi.number().integer().min(1)
+joi.pageSize = () => joi.number().integer().min(1).max(config.get('MAX_PAGE_SIZE'))
 
 /**
  * add logger and joi schema to service

src/common/service-helper.js

@@ -285,7 +285,11 @@ function getServiceMethods (Model, createSchema, patchSchema, searchSchema, buil
   }
 
   search.schema = {
-    query: searchSchema,
+    query: {
+      page: joi.id(),
+      perPage: joi.pageSize(),
+      ...searchSchema
+    },
     auth: joi.object()
   }