Add Patch method

Author: sumitd94

controllers/tasksController.js

@@ -8,10 +8,10 @@ const taskQuery = require('../models/tasks')
  */
 const addNewTask = async (req, res) => {
   try {
-    const task = await taskQuery.addTask(req.body)
+    const task = await taskQuery.updateTask(req.body)
     return res.json({
       message: 'Task created successfully!',
-      task: req.body,
+      task: task.taskDetails,
       id: task.taskId
     })
   } catch (err) {
@@ -29,7 +29,7 @@ const fetchTasks = async (req, res) => {
   try {
     const allTasks = await taskQuery.fetchTasks()
     if (allTasks.length > 0) {
-      return res.status(200).json({
+      return res.json({
         message: 'Tasks returned successfully!',
         tasks: allTasks
       })
@@ -41,7 +41,29 @@ const fetchTasks = async (req, res) => {
   }
 }
 
+/**
+ * Updates the task
+ *
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express response object
+ */
+const updateTask = async (req, res) => {
+  try {
+    const task = await taskQuery.fetchTask(req.params.id)
+    if (!task.taskData) {
+      return res.boom.notFound('Task not found')
+    }
+
+    await taskQuery.updateTask(req.body, req.params.id)
+    return res.status(204).send()
+  } catch (err) {
+    logger.error(`Error while updating user: ${err}`)
+    return res.boom.serverUnavailable('Something went wrong please contact admin')
+  }
+}
+
 module.exports = {
   addNewTask,
-  fetchTasks
+  fetchTasks,
+  updateTask
 }

models/tasks.js

@@ -2,15 +2,25 @@ const firestore = require('../utils/firestore')
 const tasksModel = firestore.collection('tasks')
 
 /**
- * Adds new task
+ * 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 addTask = async (taskData) => {
+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)
-    return { taskId: taskInfo.id }
+    const newlyCreatedTaskData = await fetchTask(taskInfo.id)
+    return { taskId: taskInfo.id, taskDetails: newlyCreatedTaskData.taskData }
   } catch (err) {
     logger.error('Error in creating task', err)
     throw err
@@ -39,7 +49,23 @@ const fetchTasks = async () => {
   }
 }
 
+/**
+ * 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 = {
-  addTask,
-  fetchTasks
+  updateTask,
+  fetchTasks,
+  fetchTask
 }

routes/tasks.js

@@ -5,6 +5,7 @@ const tasksController = require('../controllers/tasksController')
 /**
  * @swagger
  * /tasks:
+ *  get:
  *   summary: Used to get all the tasks
  *   responses:
  *     200:
@@ -32,6 +33,7 @@ router.get('/', tasksController.fetchTasks)
 /**
  * @swagger
  * /tasks:
+ *  post:
  *   summary: Used to create new task
  *   responses:
  *     200:
@@ -49,4 +51,27 @@ router.get('/', tasksController.fetchTasks)
  */
 router.post('/', tasksController.addNewTask)
 
+/**
+ * @swagger
+ * /tasks:
+ *  patch:
+ *   summary: Used to update task details
+ *   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', tasksController.updateTask)
+
 module.exports = router

utils/swaggerDefinition.js

@@ -61,7 +61,11 @@ const swaggerOptions = {
             },
             links: {
               type: 'array',
-              items: []
+              items: {
+                link1: {
+                  type: 'string'
+                }
+              }
             },
             endsOn: {
               type: 'string'