Merge pull request #124 from sumitd94/develop

Add logic to fetch & create tasks

Author: ankurnarkhede

controllers/tasksController.js

@@ -0,0 +1,66 @@
+const tasks = require('../models/tasks')
+/**
+ * Creates new task
+ *
+ * @param req {Object} - Express request object
+ * @param req.body {Object} - Task object
+ * @param res {Object} - Express response object
+ */
+const addNewTask = async (req, res) => {
+  try {
+    const task = await tasks.updateTask(req.body)
+    return res.json({
+      message: 'Task created successfully!',
+      task: task.taskDetails,
+      id: task.taskId
+    })
+  } catch (err) {
+    logger.error(`Error while creating new task: ${err}`)
+    return res.boom.badImplementation('An internal server error occurred')
+  }
+}
+/**
+ * Fetches all the tasks
+ *
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express response object
+ */
+const fetchTasks = async (req, res) => {
+  try {
+    const allTasks = await tasks.fetchTasks()
+    return res.json({
+      message: 'Tasks returned successfully!',
+      tasks: allTasks.length > 0 ? allTasks : []
+    })
+  } catch (err) {
+    logger.error(`Error while fetching tasks ${err}`)
+    return res.boom.badImplementation('An internal server error occurred')
+  }
+}
+
+/**
+ * Updates the task
+ *
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express response object
+ */
+const updateTask = async (req, res) => {
+  try {
+    const task = await tasks.fetchTask(req.params.id)
+    if (!task.taskData) {
+      return res.boom.notFound('Task not found')
+    }
+
+    await tasks.updateTask(req.body, req.params.id)
+    return res.status(204).send()
+  } catch (err) {
+    logger.error(`Error while updating user: ${err}`)
+    return res.boom.badImplementation('An internal server error occurred')
+  }
+}
+
+module.exports = {
+  addNewTask,
+  fetchTasks,
+  updateTask
+}

middlewares/validators/tasks.js

@@ -0,0 +1,78 @@
+const joi = require('joi')
+
+const createTask = async (req, res, next) => {
+  const schema = joi.object().keys({
+    title: joi.string().required(),
+    purpose: joi.string().required(),
+    featureUrl: joi.string().optional(),
+    type: joi.string().required(),
+    links: joi.array().items(joi.string()),
+    endsOn: joi.string(),
+    startedOn: joi.string().required(),
+    status: joi.string().required(),
+    ownerId: joi.string().required(),
+    percentCompleted: joi.number().optional(),
+    dependsOn: joi.array().items(joi.string()),
+    participants: joi.array().items(joi.string()),
+    completionAward: joi.object().keys({
+      gold: joi.number(),
+      silver: joi.number(),
+      bronze: joi.number()
+    }).optional(),
+    lossRate: joi.object().keys({
+      gold: joi.number(),
+      silver: joi.number(),
+      bronze: joi.number()
+    }).optional(),
+    isNoteworthy: joi.bool().optional()
+  })
+
+  try {
+    await schema.validateAsync(req.body)
+    next()
+  } catch (error) {
+    logger.error(`Error validating createTask payload : ${error}`)
+    res.boom.badRequest(error.details[0].message)
+  }
+}
+
+const updateTask = async (req, res, next) => {
+  const schema = joi.object().keys({
+    title: joi.string().optional(),
+    purpose: joi.string().optional(),
+    featureUrl: joi.string().optional(),
+    type: joi.string().optional(),
+    links: joi.array().items(joi.string()),
+    endsOn: joi.string().optional(),
+    startedOn: joi.string().optional(),
+    status: joi.string().optional(),
+    ownerId: joi.string().optional(),
+    percentCompleted: joi.number().optional(),
+    dependsOn: joi.array().items(joi.string()),
+    participants: joi.array().items(joi.string()),
+    completionAward: joi.object().keys({
+      gold: joi.number(),
+      silver: joi.number(),
+      bronze: joi.number()
+    }).optional(),
+    lossRate: joi.object().keys({
+      gold: joi.number(),
+      silver: joi.number(),
+      bronze: joi.number()
+    }).optional(),
+    isNoteworthy: joi.bool().optional()
+  })
+
+  try {
+    await schema.validateAsync(req.body)
+    next()
+  } catch (error) {
+    logger.error(`Error validating updateTask payload : ${error}`)
+    res.boom.badRequest(error.details[0].message)
+  }
+}
+
+module.exports = {
+  createTask,
+  updateTask
+}

models/tasks.js

@@ -0,0 +1,71 @@
+const firestore = require('../utils/firestore')
+const tasksModel = firestore.collection('tasks')
+
+/**
+ * Adds and Updates tasks
+ *
+ * @param taskData { Object }: task data object to be stored in DB
+ * @param taskId { string }: taskid which will be used to update the task in DB
+ * @return {Promise<{taskId: string}>}
+ */
+const updateTask = async (taskData, taskId = null) => {
+  try {
+    if (taskId) {
+      const task = await tasksModel.doc(taskId).get()
+      await tasksModel.doc(taskId).set({
+        ...task.data(),
+        ...taskData
+      })
+      return { taskId }
+    }
+    const taskInfo = await tasksModel.add(taskData)
+    const newlyCreatedTaskData = await fetchTask(taskInfo.id)
+    return { taskId: taskInfo.id, taskDetails: newlyCreatedTaskData.taskData }
+  } catch (err) {
+    logger.error('Error in creating task', err)
+    throw err
+  }
+}
+
+/**
+ * Fetch all tasks
+ *
+ * @return {Promise<tasks|Array>}
+ */
+const fetchTasks = async () => {
+  try {
+    const tasksSnapshot = await tasksModel.get()
+    const tasks = []
+    tasksSnapshot.forEach((task) => {
+      tasks.push({
+        id: task.id,
+        ...task.data()
+      })
+    })
+    return tasks
+  } catch (err) {
+    logger.error('error getting tasks', err)
+    throw err
+  }
+}
+
+/**
+ * Fetch a task
+ * @param taskId { string }: taskid which will be used to fetch the task
+ * @return {Promise<taskData|Object>}
+ */
+const fetchTask = async (taskId) => {
+  try {
+    const task = await tasksModel.doc(taskId).get()
+    return { taskData: task.data() }
+  } catch (err) {
+    logger.error('Error retrieving task data', err)
+    throw err
+  }
+}
+
+module.exports = {
+  updateTask,
+  fetchTasks,
+  fetchTask
+}

routes/index.js

@@ -5,6 +5,7 @@ app.use('/healthcheck', require('./healthCheck.js'))
 app.use('/auth', require('./auth.js'))
 app.use('/users', require('./users.js'))
 app.use('/members', require('./members.js'))
+app.use('/tasks', require('./tasks'))
 app.use('/challenges', require('./challenges.js'))
 app.use('/pullrequests', require('./pullrequests.js'))
 

routes/tasks.js

@@ -0,0 +1,84 @@
+const express = require('express')
+const router = express.Router()
+const tasksController = require('../controllers/tasksController')
+const { createTask, updateTask } = require('../middlewares/validators/tasks')
+
+/**
+ * @swagger
+ * /tasks:
+ *  get:
+ *   summary: Used to get all the tasks
+ *   responses:
+ *     200:
+ *       description: returns tasks
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/tasks'
+ *     500:
+ *       description: badImplementation
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/errors/badImplementation'
+ */
+
+router.get('/', tasksController.fetchTasks)
+
+/**
+ * @swagger
+ * /tasks:
+ *  post:
+ *   summary: Used to create new task
+ *   requestBody:
+ *     description: Task data
+ *     content:
+ *       application/json:
+ *         schema:
+ *           $ref: '#/components/schemas/tasks'
+ *   responses:
+ *     200:
+ *       description: returns newly created task
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/tasks'
+ *     500:
+ *       description: badImplementation
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/errors/badImplementation'
+ */
+router.post('/', createTask, tasksController.addNewTask)
+
+/**
+ * @swagger
+ * /tasks:
+ *  patch:
+ *   summary: Used to update task details
+ *   requestBody:
+ *     description: Task data to be updated
+ *     content:
+ *       application/json:
+ *         schema:
+ *           $ref: '#/components/schemas/tasks'
+ *   responses:
+ *     204:
+ *       description: no content
+ *     404:
+ *       description: notFound
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/errors/notFound'
+ *     500:
+ *       description: badImplementation
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/errors/badImplementation'
+ */
+router.patch('/:id', updateTask, tasksController.updateTask)
+
+module.exports = router