Merge pull request #351 from Real-Dev-Squad/migrate-member-userRole

Script to migrate user roles

Author: ankurnarkhede

controllers/members.js

@@ -1,4 +1,4 @@
-const memberQuery = require('../models/members')
+const { fetchMembers, migrateUsers, deleteIsMemberProperty } = require('../models/members')
 const tasks = require('../models/tasks')
 
 /**
@@ -10,7 +10,7 @@ const tasks = require('../models/tasks')
 
 const getMembers = async (req, res) => {
   try {
-    const allMembers = await memberQuery.fetchMembers()
+    const allMembers = await fetchMembers()
 
     return res.json({
       message: allMembers.length ? 'Members returned successfully!' : 'No member found',
@@ -31,7 +31,7 @@ const getMembers = async (req, res) => {
 
 const getIdleMembers = async (req, res) => {
   try {
-    const allMembers = await memberQuery.fetchMembers()
+    const allMembers = await fetchMembers()
     const taskParticipants = await tasks.fetchActiveTaskMembers()
     const idleMembers = allMembers?.filter(({ id }) => !taskParticipants.has(id))
     const idleMemberUserNames = idleMembers?.map((member) => member.username)
@@ -46,7 +46,47 @@ const getIdleMembers = async (req, res) => {
   }
 }
 
+/**
+ * Returns the lists of usernames migrated
+ *
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express response object
+ */
+const migrateUserRoles = async (req, res) => {
+  try {
+    const migratedUserData = await migrateUsers()
+    return res.json({
+      message: 'Users migrated successfully',
+      ...migratedUserData
+    })
+  } catch (error) {
+    logger.error(`Error while migrating user roles: ${error}`)
+    return res.boom.badImplementation('Something went wrong. Please contact admin')
+  }
+}
+
+/**
+ * Returns the lists of usernames whose isMember property was deleted
+ *
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express response object
+ */
+const deleteIsMember = async (req, res) => {
+  try {
+    const deletedIsMemberData = await deleteIsMemberProperty()
+    return res.json({
+      message: 'Users isMember deleted successfully',
+      ...deletedIsMemberData
+    })
+  } catch (error) {
+    logger.error(`Error while deleting isMember: ${error}`)
+    return res.boom.badImplementation('Something went wrong. Please contact admin')
+  }
+}
+
 module.exports = {
   getMembers,
-  getIdleMembers
+  getIdleMembers,
+  migrateUserRoles,
+  deleteIsMember
 }

docs/swaggerDefinition.js

@@ -398,6 +398,17 @@ const swaggerOptions = {
             }
           }
         },
+        migratedUsers: {
+          type: 'object',
+          properties: {
+            count: {
+              type: 'number'
+            },
+            users: {
+              type: 'array'
+            }
+          }
+        },
         users: {
           type: 'object',
           properties: {

models/members.js

@@ -37,6 +37,67 @@ const fetchMembers = async () => {
   }
 }
 
+/**
+ * Migrate user roles
+ * @return {Promise<usersMigrated|Object>}
+ */
+const migrateUsers = async () => {
+  try {
+    const userSnapShot = await userModel.where('isMember', '==', true).get()
+    const migratedUsers = []
+
+    const usersArr = []
+
+    userSnapShot.forEach(doc => usersArr.push({ id: doc.id, ...doc.data() }))
+
+    for (const user of usersArr) {
+      const roles = { ...user.roles, member: true }
+
+      await userModel.doc(user.id).set({
+        ...user,
+        roles
+      })
+
+      migratedUsers.push(user.username)
+    }
+
+    return { count: migratedUsers.length, users: migratedUsers }
+  } catch (err) {
+    logger.error('Error migrating user roles', err)
+    throw err
+  }
+}
+
+/**
+ * Deletes isMember property from user object
+ * @return {Promise<usersMigrated|Object>}
+ */
+const deleteIsMemberProperty = async () => {
+  try {
+    const userSnapShot = await userModel.where('roles', '!=', false).get()
+    const migratedUsers = []
+
+    const usersArr = []
+
+    userSnapShot.forEach(doc => usersArr.push({ id: doc.id, ...doc.data() }))
+
+    for (const user of usersArr) {
+      delete user.isMember
+
+      await userModel.doc(user.id).set({ ...user })
+
+      migratedUsers.push(user.username)
+    }
+
+    return { count: migratedUsers.length, users: migratedUsers }
+  } catch (err) {
+    logger.error('Error deleting isMember property', err)
+    throw err
+  }
+}
+
 module.exports = {
-  fetchMembers
+  fetchMembers,
+  migrateUsers,
+  deleteIsMemberProperty
 }

public/apiSchema.json

@@ -1,6 +1,8 @@
 const express = require('express')
 const router = express.Router()
-const members = require('../controllers/members')
+const { getMembers, getIdleMembers, migrateUserRoles, deleteIsMember } = require('../controllers/members')
+const { authorizeUser } = require('../middlewares/authorization')
+const authenticate = require('../middlewares/authenticate')
 const { addRecruiter } = require('../controllers/recruiters')
 const { validateRecruiter } = require('../middlewares/validators/recruiter')
 
@@ -26,7 +28,7 @@ const { validateRecruiter } = require('../middlewares/validators/recruiter')
  *               $ref: '#/components/schemas/errors/badImplementation'
  */
 
-router.get('/', members.getMembers)
+router.get('/', getMembers)
 
 /**
  * @swagger
@@ -50,7 +52,7 @@ router.get('/', members.getMembers)
  *               $ref: '#/components/schemas/errors/badImplementation'
  */
 
-router.get('/idle', members.getIdleMembers)
+router.get('/idle', getIdleMembers)
 
 /**
  * @swagger
@@ -84,4 +86,74 @@ router.get('/idle', members.getIdleMembers)
 
 router.post('/intro/:username', validateRecruiter, addRecruiter)
 
+/**
+ * @swagger
+ * /members/member-to-role-migration:
+ *  patch:
+ *   summary: One time call to update roles of the users
+ *   tags:
+ *     - Members
+ *   responses:
+ *     200:
+ *       description: Details of the users migrated
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/migratedUsers'
+ *     401:
+ *       description: unAuthorized
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/errors/unAuthorized'
+ *     403:
+ *       description: forbidden
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/errors/forbidden'
+ *     500:
+ *       description: badImplementation
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/errors/badImplementation'
+ */
+router.patch('/member-to-role-migration', authenticate, authorizeUser('superUser'), migrateUserRoles)
+
+/**
+ * @swagger
+ * /members/delete-isMember:
+ *  patch:
+ *   summary: One time call to remove isMember field for all the migrated users
+ *   tags:
+ *     - Members
+ *   responses:
+ *     200:
+ *       description: Details of the users migrated
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/migratedUsers'
+ *     401:
+ *       description: unAuthorized
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/errors/unAuthorized'
+ *     403:
+ *       description: forbidden
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/errors/forbidden'
+ *     500:
+ *       description: badImplementation
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/errors/badImplementation'
+ */
+router.patch('/delete-isMember', authenticate, authorizeUser('superUser'), deleteIsMember)
+
 module.exports = router