Handled edge cases, enhanced the code, and wrote new tests

Author: Vividh25

controllers/badge.js

@@ -1,4 +1,5 @@
 const badgeQuery = require('../models/badges')
+const logger = require('../utils/logger')
 
 /**
  * Get badges data
@@ -22,11 +23,20 @@ const getBadges = async (req, res) => {
 
 const getUserBadges = async (req, res) => {
   try {
-    const allUserBadges = await badgeQuery.fetchUserBadges(req.params.username)
-    return res.json({
-      message: 'User badges returned successfully!',
-      userBadges: allUserBadges
-    })
+    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')
+    }
   } catch (error) {
     logger.error(`Error while fetching all user badges: ${error}`)
     return res.boom.serverUnavailable('Something went wrong please contact admin')

models/badges.js

@@ -1,5 +1,6 @@
 const firestore = require('../utils/firestore')
 const badgeModel = firestore.collection('badges')
+const { fetchUser } = require('../models/users')
 
 /**
  * Fetches the data about our badges
@@ -35,20 +36,19 @@ const fetchBadges = async ({
 
 const fetchUserBadges = async (username) => {
   try {
-    const snapshot = await badgeModel.get()
-    const allBadges = []
-    snapshot.forEach((doc) => {
-      allBadges.push(doc.data())
-    })
-    const userBadges = []
-    allBadges.forEach((badge) => {
-      badge.users.forEach((user) => {
-        if (user === username) {
-          userBadges.push({ title: badge.title, description: badge.description })
+    const result = await fetchUser({ username })
+    if (result.userExists) {
+      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 userBadges
+      return { userExists: true, userBadges: userBadges }
+    }
+    return { userExists: false, userBadges: [] }
   } catch (err) {
     logger.error('Error retrieving user badges', err)
     return err

test/fixtures/userBadges/userBadges.js

@@ -0,0 +1,23 @@
+/**
+ * User's badges response
+ * Multiple responses can be added to the object if required
+ *
+ * @return {Object}
+ */
+
+const userFound = {
+  userExists: true,
+  userBadges: [{ title: 'badgeTitle', description: 'badgeDes' }]
+}
+
+const userNotFound = {
+  userExists: false,
+  userBadges: []
+}
+
+const badgesEmpty = {
+  userExists: true,
+  userBadges: []
+}
+
+module.exports = { userFound, userNotFound, badgesEmpty }

test/integration/userBadges.test.js

@@ -1,14 +1,22 @@
 const chai = require('chai')
 const { expect } = chai
+const sinon = require('sinon')
 const chaiHttp = require('chai-http')
+const badges = require('../../models/badges')
+const userBadges = require('../fixtures/userBadges/userBadges')
 
 const app = require('../../server')
 
 chai.use(chaiHttp)
 
 describe('User badges', function () {
   describe('GET /badges/:username', function () {
+    afterEach(function () {
+      badges.fetchUserBadges.restore()
+    })
+
     it('Should get the list of user badges', function (done) {
+      sinon.stub(badges, 'fetchUserBadges').returns(userBadges.userFound)
       chai
         .request(app)
         .get('/badges/ankush')
@@ -19,6 +27,34 @@ describe('User badges', function () {
           expect(res.body.message).to.equal('User badges returned successfully!')
           expect(res.body.userBadges).to.be.a('array')
 
+          return done()
+        })
+    })
+    it('Should return a not found message if the user in not found', function (done) {
+      sinon.stub(badges, 'fetchUserBadges').returns(userBadges.userNotFound)
+      chai
+        .request(app)
+        .get('/badges/invalidUsername')
+        .end((err, res) => {
+          if (err) { return done() }
+          expect(res).to.have.status(404)
+          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()
         })
     })