challenges API refactored (#271)

* [WIP] challenges API refactored

* refactored challenges get and post

* validators for createChallenge

* using timestamps for date

* seperating get and post routes

* boom response changes

Co-authored-by: akshay shinde <[email protected]>

Author: correaswebert

controllers/challenge.js

@@ -3,37 +3,44 @@ const challengeQuery = require('../models/challenges')
 const ERROR_MESSAGE = 'Something went wrong. Please try again or contact admin'
 
 /**
- * Get the challenges or add the challenge
+ * Get the challenges
  * @param {Object} req - Express request object
  * @param {Object} res - Express response object
  */
 
-const sendChallengeResponse = async (req, res) => {
+const fetchChallenges = async (req, res) => {
   try {
-    if (req.method === 'GET') {
-      const allChallenges = await challengeQuery.fetchChallenges()
-      const promiseArray = await getParticipantsofChallenges(allChallenges)
-      const challengesWithParticipants = await Promise.all(promiseArray)
+    const allChallenges = await challengeQuery.fetchChallenges()
+    const promiseArray = await getParticipantsofChallenges(allChallenges)
+    const challengesWithParticipants = await Promise.all(promiseArray)
+    return res.json({
+      message: challengesWithParticipants.length ? 'Challenges returned successfully!' : 'No Challenges found',
+      challenges: challengesWithParticipants
+    })
+  } catch (err) {
+    logger.error(`Error while retrieving challenges ${err}`)
+    return res.boom.serverUnavailable(ERROR_MESSAGE)
+  }
+}
+
+/**
+ * Add a challenge
+ * @param {Object} req - Express request object
+ * @param {Object} res - Express response object
+ */
+
+const createChallenge = async (req, res) => {
+  try {
+    const challengeAdded = await challengeQuery.postChallenge(req.body)
+    if (challengeAdded) {
       return res.json({
-        message: challengesWithParticipants.length ? 'Challenges returned successfully!' : 'No Challenges found',
-        challenges: challengesWithParticipants
+        message: 'Challenge added successfully'
       })
     } else {
-      if (req.method === 'POST') {
-        const challengeAdded = await challengeQuery.postChallenge(req.body)
-        if (challengeAdded) {
-          return res.status(200).json({
-            message: 'Challenge added successfully',
-            challenges: challengeAdded
-          })
-        }
-      } else {
-        return res.boom.notFound('Unable to add challenge')
-      }
+      return res.boom.badRequest('Unable to add challenge')
     }
-    return ''
   } catch (err) {
-    logger.error(`Error while retriving challenges ${err}`)
+    logger.error(`Error while adding challenge ${err}`)
     return res.boom.serverUnavailable(ERROR_MESSAGE)
   }
 }
@@ -77,6 +84,7 @@ const subscribeToChallenge = async (req, res) => {
 }
 
 module.exports = {
-  sendChallengeResponse,
+  fetchChallenges,
+  createChallenge,
   subscribeToChallenge
 }

middlewares/validators/challenges.js

@@ -0,0 +1,22 @@
+const joi = require('joi')
+
+const createChallenge = async (req, res, next) => {
+  const schema = joi.object().strict().keys({
+    title: joi.string().required(),
+    level: joi.string().required(),
+    start_date: joi.number().required(),
+    end_date: joi.number().required()
+  })
+
+  try {
+    await schema.validateAsync(req.body)
+    next()
+  } catch (error) {
+    logger.error(`Error validating createChallenge payload : ${error}`)
+    res.boom.badRequest(error.details[0].message)
+  }
+}
+
+module.exports = {
+  createChallenge
+}

models/challenges.js

@@ -66,15 +66,17 @@ const fetchParticipantsData = async (participants) => {
 
 const postChallenge = async (challengeData) => {
   try {
-    const response = await challengesModel.add({
+    const { start_date: startDate, end_date: endDate } = challengeData
+    const startdate = new Firestore.Timestamp(startDate, 0)
+    const enddate = new Firestore.Timestamp(endDate, 0)
+    const challengeRef = await challengesModel.add({
       ...challengeData,
+      start_date: startdate,
+      end_date: enddate,
       participants: [],
       is_active: true
     })
-    const allChallenges = await fetchChallenges()
-    if (response.id && allChallenges.length > 0) {
-      return allChallenges
-    } else return ''
+    return challengeRef.id
   } catch (err) {
     logger.error(ERROR_MESSAGE, err)
     throw err

public/apiSchema.json

@@ -2,6 +2,7 @@ const express = require('express')
 const router = express.Router()
 const authenticate = require('../middlewares/authenticate')
 const challenges = require('../controllers/challenge')
+const { createChallenge } = require('../middlewares/validators/challenges')
 
 /**
  * @swagger
@@ -29,6 +30,12 @@ const challenges = require('../controllers/challenge')
  *           application/json:
  *             schema:
  *               $ref: '#/components/schemas/errors/serverUnavailable'
+ */
+router.get('/', authenticate, challenges.fetchChallenges)
+
+/**
+ * @swagger
+ * /challenges:
  *   post:
  *     summary: Post new challenge
  *     tags:
@@ -53,10 +60,7 @@ const challenges = require('../controllers/challenge')
  *             schema:
  *               $ref: '#/components/schemas/errors/serverUnavailable'
  */
-router
-  .route('/')
-  .get(authenticate, challenges.sendChallengeResponse)
-  .post(authenticate, challenges.sendChallengeResponse)
+router.post('/', authenticate, createChallenge, challenges.createChallenge)
 
 /**
  * @swagger
@@ -88,7 +92,6 @@ router
  *           application/json:
  *             schema:
  *               $ref: '#/components/schemas/errors/serverUnavailable'
- *
  */
 router.post('/subscribe', authenticate, challenges.subscribeToChallenge)