Merge pull request #54 from narekcat/issue-51

fix: for issue 51, add support sorting by 'GET /resources' endpoint

Author: rootelement

config/default.js

@@ -33,7 +33,7 @@ module.exports = {
     // AWS_SECRET_ACCESS_KEY: process.env.AWS_FAKE_KEY,
     AWS_REGION: process.env.AWS_REGION || 'us-east-1',
     IS_LOCAL_DB: process.env.IS_LOCAL_DB ? process.env.IS_LOCAL_DB === 'true' : true,
-    URL: process.env.DYNAMODB_URL || 'http://localhost:8000',
+    DYNAMODB_URL: process.env.DYNAMODB_URL || 'http://localhost:8000',
     AWS_READ_UNITS: process.env.AWS_READ_UNITS || 4,
     AWS_WRITE_UNITS: process.env.AWS_WRITE_UNITS || 2,
     TIMEOUT: process.env.DYNAMODB_TIMEOUT || 10000

docs/swagger.yaml

@@ -72,6 +72,16 @@ paths:
           format: UUID
           in: query
           required: false
+        - name: sortBy
+          type: string
+          description: Sort the results by the field.
+          in: query
+          required: false
+        - name: sortOrder
+          type: string
+          description: Order the results by the asc/desc.
+          in: query
+          required: false
       responses:
         '200':
           description: OK - the request was successful

src/controllers/ResourceController.js

@@ -11,7 +11,7 @@ const helper = require('../common/helper')
  * @param {Object} res the response
  */
 async function getResources (req, res) {
-  const result = await service.getResources(req.authUser, req.query.challengeId, req.query.roleId, req.query.page, req.query.perPage)
+  const result = await service.getResources(req.authUser, req.query.challengeId, req.query.roleId, req.query.page, req.query.perPage, req.query.sortBy, req.query.sortOrder)
   helper.setResHeaders(req, res, result)
   res.send(result.data)
 }

src/init-es.js

@@ -31,7 +31,11 @@ const initES = async () => {
     const body = { mappings: {} }
     body.mappings[config.get('ES.ES_TYPE')] = {
       properties: {
-        id: { type: 'keyword' }
+        id: { type: 'keyword' },
+        memberHandle: { 
+          type: 'text',
+          fielddata: true
+        }
       }
     }
 

src/scripts/create-tables.js

@@ -9,7 +9,7 @@ const logger = require('../common/logger')
 logger.info('Requesting to create tables...')
 
 const promises = []
-const skipModels = ['DynamoDB', 'MemberStats', 'MemberProfile']
+const skipModels = ['DynamoDB', 'MemberProfile']
 
 Object.keys(models).forEach(modelName => {
   if (!includes(skipModels, modelName)) {

src/services/ResourceService.js

@@ -44,7 +44,7 @@ async function checkAccess (currentUser, resources) {
  * @param {Number} perPage The number of items to list per page
  * @returns {Array} the search result
  */
-async function getResources (currentUser, challengeId, roleId, page, perPage) {
+async function getResources (currentUser, challengeId, roleId, page, perPage, sortBy, sortOrder) {
   if (!validateUUID(challengeId)) {
     throw new errors.BadRequestError(`Challenge ID ${challengeId} must be a valid v5 Challenge Id (UUID)`)
   }
@@ -118,7 +118,8 @@ async function getResources (currentUser, challengeId, roleId, page, perPage) {
         bool: {
           must: mustQuery
         }
-      }
+      },
+      sort: [{ [sortBy]: { 'order': sortOrder } }]
     }
   }
   const esClient = await helper.getESClient()
@@ -180,7 +181,9 @@ getResources.schema = {
   challengeId: Joi.id(),
   roleId: Joi.optionalId(),
   page: Joi.page(),
-  perPage: Joi.perPage()
+  perPage: Joi.perPage(),
+  sortBy: Joi.string().valid('memberHandle', 'created').required(),
+  sortOrder: Joi.string().valid('desc', 'asc').required()
 }
 
 /**