Made the code clean

Author: Vividh25

controllers/badge.js

@@ -1,5 +1,4 @@
 const badgeQuery = require('../models/badges')
-const logger = require('../utils/logger')
 
 /**
  * Get badges data
@@ -24,19 +23,9 @@ const getBadges = async (req, res) => {
 const getUserBadges = async (req, res) => {
   try {
     const result = await badgeQuery.fetchUserBadges(req.params.username)
-    if (result.userExists) {
-      if (result.userBadges.length === 0) {
-        return res.json({
-          message: 'This user does not have any badges'
-        })
-      }
-      return res.json({
-        message: 'User badges returned successfully!',
-        userBadges: result.userBadges
-      })
-    } else {
-      return res.boom.notFound('The user does not exist')
-    }
+    return result.userExists
+      ? res.json({ message: 'User badges returned successfully!', userBadges: result.userBadges })
+      : res.boom.notFound('The user does not exist')
   } catch (error) {
     logger.error(`Error while fetching all user badges: ${error}`)
     return res.boom.serverUnavailable('Something went wrong please contact admin')

models/badges.js

@@ -36,19 +36,20 @@ const fetchBadges = async ({
 
 const fetchUserBadges = async (username) => {
   try {
+    const userBadges = []
+    let userExists = false
     const result = await fetchUser({ username })
     if (result.userExists) {
+      userExists = true
       const userID = result.user.id
       const snapshot = await badgeModel.get()
-      const userBadges = []
       snapshot.forEach((item) => {
         if (item.data().users.includes(userID)) {
           userBadges.push({ title: item.data().title, description: item.data().description })
         }
       })
-      return { userExists: true, userBadges: userBadges }
     }
-    return { userExists: false, userBadges: [] }
+    return { userExists: userExists, userBadges: userBadges }
   } catch (err) {
     logger.error('Error retrieving user badges', err)
     return err

routes/badges.js

@@ -57,6 +57,12 @@ router.get('/', badge.getBadges)
  *                    type: array
  *                    items:
  *                      $ref: '#/components/schemas/userBadges'
+ *       404:
+ *         description: User not found
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/errors/notFound'
  *       503:
  *         description: serverUnavailable
  *         content:

test/fixtures/userBadges/userBadges.js

@@ -7,17 +7,12 @@
 
 const userFound = {
   userExists: true,
-  userBadges: [{ title: 'badgeTitle', description: 'badgeDes' }]
+  userBadges: [{ title: 'badgeTitle', description: 'badgeDescription' }]
 }
 
 const userNotFound = {
   userExists: false,
   userBadges: []
 }
 
-const badgesEmpty = {
-  userExists: true,
-  userBadges: []
-}
-
-module.exports = { userFound, userNotFound, badgesEmpty }
+module.exports = { userFound, userNotFound }

test/integration/userBadges.test.js

@@ -30,7 +30,7 @@ describe('User badges', function () {
           return done()
         })
     })
-    it('Should return a not found message if the user in not found', function (done) {
+    it('Should return a not found message if the user is not found', function (done) {
       sinon.stub(badges, 'fetchUserBadges').returns(userBadges.userNotFound)
       chai
         .request(app)
@@ -41,20 +41,6 @@ describe('User badges', function () {
           expect(res.body.error).to.equal('Not Found')
           expect(res.body.message).to.equal('The user does not exist')
 
-          return done()
-        })
-    })
-    it('Should return no badges found if the user does not have any badges', function (done) {
-      sinon.stub(badges, 'fetchUserBadges').returns(userBadges.badgesEmpty)
-      chai
-        .request(app)
-        .get('/badges/someuser')
-        .end((err, res) => {
-          if (err) { return done() }
-          expect(res).to.have.status(200)
-          expect(res.body).to.be.a('object')
-          expect(res.body.message).to.equal('This user does not have any badges')
-
           return done()
         })
     })