Merge branch 'develop' into website-backend-368-2

Author: bhk31

CONTRIBUTING.md

@@ -1,4 +1,3 @@
-
 # Contributing to Real Dev Squad API
 
 - [Getting Started](#getting-started)
@@ -25,19 +24,22 @@ The script associated with `npm run test` will run all tests that ensures that y
 repository. This will run the lint, integration and unit tests.
 
 ##### `npm run lint`
+
 Runs the lint checks in the project.
 
 ##### `npm run generate-api-schema`
+
 Generates the API schema in the file `public/apiSchema.json`.
 
 ##### `npm run validate-setup`
-Runs the test for checking local development setup is working properly or not.
 
+Runs the test for checking local development setup is working properly or not.
 
 ## Project Structure
+
 The following project structure should be followed:
 
-``` shell script
+```shell script
 |-- website-backend
     |-- config
     |   |-- custom-environment-variables.js
@@ -89,6 +91,7 @@ The following project structure should be followed:
 ```
 
 ## Generating Authentication Token
+
 - Run the project locally, make sure the server is listening to requests
 - Navigate to `https://github.com/login/oauth/authorize?client_id=<GITHUB_CLIENT_ID>`
 - Authorize the application
@@ -97,8 +100,8 @@ The following project structure should be followed:
 - For non-production environments, authentication is also supported with the `Authorization` header.
 - Authorization header: `Authorization: Bearer <token>`
 
-
 ## Testing Guidelines
+
 - Libraries used in testing in the project:
   - [mocha](https://mochajs.org/): Test framework
   - [chai](https://www.chaijs.com/): Assertion library
@@ -110,6 +113,7 @@ The following project structure should be followed:
   - Java version 1.8 or higher.
 
 ## Using Firebase Emulator Locally
+
 - [Firebase Local Emulator Suite](https://firebase.google.com/docs/emulator-suite) can be used locally as the DB for the project
 - Pre-requisites:
   - Node.js version 8.0 or higher.
@@ -119,15 +123,18 @@ The following project structure should be followed:
 - [Future] You can view the emulator UI at: `http://localhost:4000`
 
 ## Running test scripts on Windows
+
 - Git Bash is recommended for running test scripts on Windows.
 - Run `npm run test-integration` for running integration tests.
 - Run `npm run test-unit` for running unit tests.
-- Make sure to close the emulator window after running the tests in order to avoid the blocking of the port for the next tests to run. 
+- Make sure the server is not running.
+- Make sure to close the emulator window after running the tests in order to avoid the blocking of the port for the next tests to run.
 - For e.g - After running the integration tests, close the emulator window and then run the command for unit tests.
 
 ## Pull request guidelines
+
 - Ensure that the tests pass locally before raising a PR.
 - All pull requests should have base as the develop branch.
 - Every pull request should have associated issue(s) on our [issue tracker](https://github.com/Real-Dev-Squad/website-backend/issues).
 - For any non-trivial fixes and features, unit and integration tests must be added. The PR reviewer should not approve/merge PR(s) that lack these.
-- The PR(s) should be merged only after the CI passes.
+- The PR(s) should be merged only after the CI passes.

constants/tasks.js

@@ -8,7 +8,8 @@ const TASK_STATUS = {
   ACTIVE: 'active',
   ASSIGNED: 'assigned',
   BLOCKED: 'blocked',
-  COMPLETED: 'completed'
+  COMPLETED: 'completed',
+  UNASSIGNED: 'unAssigned'
 }
 
 module.exports = { TASK_TYPE, TASK_STATUS }

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
 }

controllers/tasks.js

@@ -1,4 +1,5 @@
 const tasks = require('../models/tasks')
+const { TASK_STATUS } = require('../constants/tasks')
 /**
  * Creates new task
  *
@@ -52,8 +53,15 @@ const fetchTasks = async (req, res) => {
  */
 const getUserTasks = async (req, res) => {
   try {
+    const { status } = req.query
     const { username } = req.params
-    const allTasks = await tasks.fetchUserTasks(username)
+    let allTasks = []
+
+    if (!Object.values(TASK_STATUS).includes(status)) {
+      return res.boom.notFound('Status not found!')
+    }
+
+    allTasks = await tasks.fetchUserTasks(username, status ? [status] : [])
 
     if (allTasks.userNotFound) {
       return res.boom.notFound('User doesn\'t exist')

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

@@ -13,21 +13,23 @@ const userModel = firestore.collection('users')
 
 const fetchMembers = async () => {
   try {
-    const snapshot = await userModel.where('isMember', '==', true).get()
+    const snapshot = await userModel.get()
 
     const allMembers = []
 
     if (!snapshot.empty) {
       snapshot.forEach((doc) => {
-        allMembers.push({
+        const memberData = doc.data()
+        const curatedMemberData = {
           id: doc.id,
-          ...doc.data(),
+          ...memberData,
           tokens: undefined,
           phone: undefined,
           email: undefined
-        })
-      }
-      )
+        }
+        curatedMemberData.isMember = !!(memberData.roles && memberData.roles.member)
+        allMembers.push(curatedMemberData)
+      })
     }
 
     return allMembers
@@ -37,6 +39,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
 }