feat: archive users/members from the members page (#427)

* feat: archive members

* generated api schema

* added: check if user is already archived or not

* bug fix

* added: optional chaining

* added: move to member model.

* added: integration test for testing archive member feature

* key changed to camelCase

* Added: requested changes

* added: requested changes

* added: requested changes

* bug fix

* fix: typo

* removed unwanted code.

* removed unwanted code

* Fixed schema

* added: requested changes

* added: requested changes

Author: MehulKChaudhari

controllers/members.js

@@ -1,5 +1,5 @@
 const { ROLES } = require('../constants/users')
-const { fetchUsers, migrateUsers, deleteIsMemberProperty, fetchUsersWithRole, moveToMembers: updateToMemberRole } = require('../models/members')
+const members = require('../models/members')
 const tasks = require('../models/tasks')
 const { fetchUser } = require('../models/users')
 
@@ -14,7 +14,7 @@ const ERROR_MESSAGE = 'Something went wrong. Please try again or contact admin'
 
 const getMembers = async (req, res) => {
   try {
-    const allUsers = await fetchUsers()
+    const allUsers = await members.fetchUsers()
 
     return res.json({
       message: allUsers.length ? 'Members returned successfully!' : 'No member found',
@@ -35,7 +35,7 @@ const getMembers = async (req, res) => {
 
 const getIdleMembers = async (req, res) => {
   try {
-    const onlyMembers = await fetchUsersWithRole(ROLES.MEMBER)
+    const onlyMembers = await members.fetchUsersWithRole(ROLES.MEMBER)
     const taskParticipants = await tasks.fetchActiveTaskMembers()
     const idleMembers = onlyMembers?.filter(({ id }) => !taskParticipants.has(id))
     const idleMemberUserNames = idleMembers?.map((member) => member.username)
@@ -62,7 +62,7 @@ const moveToMembers = async (req, res) => {
     const { username } = req.params
     const result = await fetchUser({ username })
     if (result.userExists) {
-      const successObject = await updateToMemberRole(result.user.id)
+      const successObject = await members.moveToMembers(result.user.id)
       if (successObject.isAlreadyMember) {
         return res.boom.badRequest('User is already a member')
       }
@@ -84,7 +84,7 @@ const moveToMembers = async (req, res) => {
 
 const migrateUserRoles = async (req, res) => {
   try {
-    const migratedUserData = await migrateUsers()
+    const migratedUserData = await members.migrateUsers()
     return res.json({
       message: 'Users migrated successfully',
       ...migratedUserData
@@ -103,7 +103,7 @@ const migrateUserRoles = async (req, res) => {
  */
 const deleteIsMember = async (req, res) => {
   try {
-    const deletedIsMemberData = await deleteIsMemberProperty()
+    const deletedIsMemberData = await members.deleteIsMemberProperty()
     return res.json({
       message: 'Users isMember deleted successfully',
       ...deletedIsMemberData
@@ -114,7 +114,33 @@ const deleteIsMember = async (req, res) => {
   }
 }
 
+/**
+ * Archives old member from new members list.
+*
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express response object
+ */
+
+const archiveMembers = async (req, res) => {
+  try {
+    const { username } = req.params
+    const user = await fetchUser({ username })
+    if (user?.userExists) {
+      const successObject = await members.addArchiveRoleToMembers(user.user.id)
+      if (successObject.isArchived) {
+        return res.boom.badRequest('User is already archived')
+      }
+      return res.status(204).send()
+    }
+    return res.boom.notFound("User doesn't exist")
+  } catch (err) {
+    logger.error(`Error while retriving contributions ${err}`)
+    return res.boom.badImplementation(ERROR_MESSAGE)
+  }
+}
+
 module.exports = {
+  archiveMembers,
   getMembers,
   getIdleMembers,
   moveToMembers,

models/members.js

@@ -148,8 +148,31 @@ const fetchUsersWithRole = async (role) => {
   }
 }
 
+/**
+ * changes the role of a new user to member
+ * @param userId { String }: User id of user to be modified
+ * @return { Object }: whether moveToMember was successful or not and whether user is already a member or not
+ */
+
+const addArchiveRoleToMembers = async (userId) => {
+  try {
+    const userDoc = await userModel.doc(userId).get()
+    const user = userDoc.data()
+    if (user?.roles?.archivedMember) return { isArchived: true }
+    const roles = { ...user.roles, archivedMember: true }
+    await userModel.doc(userId).update({
+      roles
+    })
+    return { isArchived: false }
+  } catch (err) {
+    logger.error('Error updating user', err)
+    throw err
+  }
+}
+
 module.exports = {
   moveToMembers,
+  addArchiveRoleToMembers,
   fetchUsers,
   migrateUsers,
   deleteIsMemberProperty,

package-lock.json

@@ -14,7 +14,7 @@
     "generate-api-schema": "node utils/generateAPISchema.js"
   },
   "dependencies": {
-    "axios": "^0.21.2",
+    "axios": "^0.21.1",
     "cloudinary": "^1.25.1",
     "config": "^3.3.6",
     "cookie-parser": "~1.4.5",

package.json

@@ -1,6 +1,6 @@
 const express = require('express')
 const router = express.Router()
-const { getMembers, getIdleMembers, migrateUserRoles, deleteIsMember, moveToMembers } = require('../controllers/members')
+const members = require('../controllers/members')
 const { authorizeUser } = require('../middlewares/authorization')
 const authenticate = require('../middlewares/authenticate')
 const { addRecruiter } = require('../controllers/recruiters')
@@ -29,7 +29,7 @@ const { SUPER_USER } = require('../constants/roles')
  *               $ref: '#/components/schemas/errors/badImplementation'
  */
 
-router.get('/', getMembers)
+router.get('/', members.getMembers)
 
 /**
  * @swagger
@@ -53,7 +53,7 @@ router.get('/', getMembers)
  *               $ref: '#/components/schemas/errors/badImplementation'
  */
 
-router.get('/idle', getIdleMembers)
+router.get('/idle', members.getIdleMembers)
 
 /**
  * @swagger
@@ -131,7 +131,7 @@ router.post('/intro/:username', validateRecruiter, addRecruiter)
  *               $ref: '#/components/schemas/errors/serverUnavailable'
  */
 
-router.patch('/moveToMembers/:username', authenticate, authorizeUser(SUPER_USER), moveToMembers)
+router.patch('/moveToMembers/:username', authenticate, authorizeUser(SUPER_USER), members.moveToMembers)
 /**
  * @swagger
  * /members/member-to-role-migration:
@@ -165,7 +165,7 @@ router.patch('/moveToMembers/:username', authenticate, authorizeUser(SUPER_USER)
  *           schema:
  *             $ref: '#/components/schemas/errors/badImplementation'
  */
-router.patch('/member-to-role-migration', authenticate, authorizeUser('superUser'), migrateUserRoles)
+router.patch('/member-to-role-migration', authenticate, authorizeUser('superUser'), members.migrateUserRoles)
 
 /**
  * @swagger
@@ -200,6 +200,52 @@ router.patch('/member-to-role-migration', authenticate, authorizeUser('superUser
  *           schema:
  *             $ref: '#/components/schemas/errors/badImplementation'
  */
-router.patch('/delete-isMember', authenticate, authorizeUser('superUser'), deleteIsMember)
+router.patch('/delete-isMember', authenticate, authorizeUser('superUser'), members.deleteIsMember)
+
+/**
+ * @swagger
+ * /archiveMembers/:username:
+ *   patch:
+ *     summary: Changes the role of a old member(the username provided in params) in new members list to archive_member
+ *     tags:
+ *       - Members
+ *     security:
+ *       - bearerAuth: []
+ *     responses:
+ *       204:
+ *         description: no content
+ *       400:
+ *         description: badRequest
+ *         content:
+ *           application/json:
+ *             schema:
+ *                type: object
+ *                properties:
+ *                  message:
+ *                    type: string
+ *                    example: User Already is a member
+ *
+ *       401:
+ *         description: unAuthorized
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/errors/unAuthorized'
+ *       404:
+ *         description: notFound
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/errors/notFound'
+ *
+ *       500:
+ *         description: serverUnavailable
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/errors/serverUnavailable'
+ */
+
+router.patch('/archiveMembers/:username', authenticate, authorizeUser(SUPER_USER), members.archiveMembers)
 
 module.exports = router

public/apiSchema.json

@@ -110,7 +110,28 @@ module.exports = () => {
       },
       status: 'active',
       roles: {
-        app_owner: true
+        app_owner: true,
+        archivedMember: true
+      }
+    },
+    {
+      username: 'mehul',
+      first_name: 'Mehul',
+      last_name: 'Chaudhari',
+      yoe: 0,
+      img: './img.png',
+      github_id: 'mehulkchaudhari',
+      linkedin_id: 'mehulkchaudhari',
+      twitter_id: 'mehulkchaudhari',
+      phone: '1234567891',
+      email: '[email protected]',
+      tokens: {
+        githubAccessToken: 'githubAccessToken'
+      },
+      status: 'active',
+      roles: {
+        member: true,
+        archivedMember: true
       }
     }
   ]

routes/members.js

@@ -19,6 +19,9 @@ const superUser = userData[4]
 const userAlreadyMember = userData[0]
 const userToBeMadeMember = userData[1]
 const nonSuperUser = userData[2]
+const userDoesNotExists = userData[1]
+const userToBeArchived = userData[3]
+const userAlreadyArchived = userData[5]
 
 describe('Members', function () {
   let jwt
@@ -185,4 +188,81 @@ describe('Members', function () {
       })
     })
   })
+
+  describe('PATCH /members/archiveMembers/:username', function () {
+    before(async function () {
+      await cleanDb()
+      const userId = await addUser(superUser)
+      jwt = authService.generateAuthToken({ userId })
+    })
+
+    it("Should return 404 if user doesn't exist", function (done) {
+      chai
+        .request(app)
+        .patch(`/members/archiveMembers/${userDoesNotExists.username}`)
+        .set('cookie', `${cookieName}=${jwt}`)
+        .end((err, res) => {
+          if (err) { return done(err) }
+          expect(res).to.have.status(404)
+          expect(res.body).to.be.a('object')
+          expect(res.body.message).to.equal("User doesn't exist")
+          return done()
+        })
+    })
+
+    it('Should archive the user', function (done) {
+      addUser(userToBeArchived).then(() => {
+        chai
+          .request(app)
+          .patch(`/members/archiveMembers/${userToBeArchived.username}`)
+          .set('cookie', `${cookieName}=${jwt}`)
+          .end((err, res) => {
+            if (err) { return done(err) }
+
+            expect(res).to.have.status(204)
+            /* eslint-disable no-unused-expressions */
+            expect(res.body).to.be.a('object').to.be.empty
+
+            return done()
+          })
+      })
+    })
+
+    it('Should return 400 if user is already archived', function (done) {
+      addUser(userAlreadyArchived).then(() => {
+        chai
+          .request(app)
+          .patch(`/members/archiveMembers/${userAlreadyArchived.username}`)
+          .set('cookie', `${cookieName}=${jwt}`)
+          .end((err, res) => {
+            if (err) { return done(err) }
+
+            expect(res).to.have.status(400)
+            expect(res.body).to.be.a('object')
+            expect(res.body.message).to.equal('User is already archived')
+
+            return done()
+          })
+      })
+    })
+
+    it('Should return 401 if user is not a super user', function (done) {
+      addUser(nonSuperUser).then(nonSuperUserId => {
+        const nonSuperUserJwt = authService.generateAuthToken({ nonSuperUserId })
+        chai
+          .request(app)
+          .patch(`/members/moveToMembers/${nonSuperUser.username}`)
+          .set('cookie', `${cookieName}=${nonSuperUserJwt}`)
+          .end((err, res) => {
+            if (err) { return done(err) }
+
+            expect(res).to.have.status(401)
+            expect(res.body).to.be.a('object')
+            expect(res.body.message).to.equal('You are not authorized for this action.')
+
+            return done()
+          })
+      })
+    })
+  })
 })