Merge pull request #1686 from Real-Dev-Squad/develop

Dev to Main sync

Author: prakashchoudhary07

.github/pull_request_template.md

@@ -0,0 +1,37 @@
+Date: `change date here`
+
+Developer Name: `developer name here`
+
+----
+
+## Issue Ticket Number:- 
+- add issue ticket number here e.g `#923`
+
+## Description: 
+Add description of the PR here
+
+
+Is Under Feature Flag 
+- [x] Yes
+- [ ] No
+
+Database changes
+- [ ] Yes
+- [x] No
+
+Breaking changes (If your feature is breaking/missing something please mention pending tickets)
+- [ ] Yes
+- [x] No
+
+Is Development Tested?
+
+- [x] Yes
+- [ ] No
+
+Tested in staging?
+
+- [x] Yes
+- [ ] No
+
+### Add relevant Screenshot below ( e.g test coverage etc. )
+

constants/taskRequests.ts

@@ -4,10 +4,45 @@ const TASK_REQUEST_STATUS = {
   PENDING: "PENDING",
   DENIED: "DENIED",
 };
-
+const TASK_REQUEST_ERROR_MESSAGE = {
+  INVALID_PREV: "Invalid 'prev' value",
+  INVALID_NEXT: "Invalid 'next' value",
+};
 const TASK_REQUEST_TYPE = {
   ASSIGNMENT: "ASSIGNMENT",
   CREATION: "CREATION",
 };
+const TASK_REQUEST_FILTER_KEYS = {
+  status: "status",
+  "request-type": "requestType",
+};
+const TASK_REQUEST_FILTER_VALUES = {
+  pending: "PENDING",
+  approved: "APPROVED",
+  denied: "DENIED",
+  assignment: "ASSIGNMENT",
+  creation: "CREATION",
+};
+const TASK_REQUEST_SORT_KEYS = {
+  created: "createdAt",
+  requestors: "usersCount",
+};
+const TASK_REQUEST_SORT_VALUES = {
+  asc: "asc",
+  desc: "desc",
+};
+const MIGRATION_TYPE = {
+  ADD_NEW_FIELDS: "add-new-fields",
+  REMOVE_OLD_FIELDS: "remove-redundant-fields",
+};
 
-module.exports = { TASK_REQUEST_STATUS, TASK_REQUEST_TYPE };
+module.exports = {
+  TASK_REQUEST_STATUS,
+  TASK_REQUEST_TYPE,
+  TASK_REQUEST_FILTER_KEYS,
+  TASK_REQUEST_FILTER_VALUES,
+  TASK_REQUEST_SORT_KEYS,
+  TASK_REQUEST_ERROR_MESSAGE,
+  TASK_REQUEST_SORT_VALUES,
+  MIGRATION_TYPE
+};

controllers/issues.js

@@ -1,6 +1,7 @@
 const issuesService = require("../services/issuesService");
 const tasks = require("../models/tasks");
 const { SOMETHING_WENT_WRONG } = require("../constants/errorMessages");
+const githubService = require("../services/githubService");
 
 /**
  * Get the issues of the repo
@@ -10,9 +11,18 @@ const { SOMETHING_WENT_WRONG } = require("../constants/errorMessages");
 
 const getIssues = async (req, res) => {
   try {
-    const { q: queryString } = req.query;
+    const { q: queryString, dev } = req.query;
     let issues = {};
-    if (queryString) {
+    const githubOrg = config.get("githubApi.org");
+    const githubIssuerUrlPattern = new RegExp(`^https://github.com/${githubOrg}/.+/issues/\\d+$`);
+
+    if (githubIssuerUrlPattern.test(queryString) && dev === "true") {
+      const url = new URL(queryString);
+      const issueUrlPaths = url.pathname.split("/");
+      const repositoryName = issueUrlPaths[2];
+      const issueNumber = issueUrlPaths[4];
+      issues.data = [await githubService.fetchIssuesById(repositoryName, issueNumber)];
+    } else if (queryString) {
       const searchedIssues = await issuesService.searchOrgIssues(queryString);
       issues.data = searchedIssues?.data?.items ?? [];
     } else {

controllers/tasksRequests.js

@@ -1,5 +1,5 @@
 const { INTERNAL_SERVER_ERROR, SOMETHING_WENT_WRONG } = require("../constants/errorMessages");
-const { TASK_REQUEST_TYPE } = require("../constants/taskRequests");
+const { TASK_REQUEST_TYPE, MIGRATION_TYPE } = require("../constants/taskRequests");
 const { addLog } = require("../models/logs");
 const taskRequestsModel = require("../models/taskRequests");
 const tasksModel = require("../models/tasks.js");
@@ -10,18 +10,20 @@ const usersUtils = require("../utils/users");
 const fetchTaskRequests = async (_, res) => {
   try {
     const { dev } = _.query;
-    const data = await taskRequestsModel.fetchTaskRequests(dev === "true");
-
-    if (data.length > 0) {
-      return res.status(200).json({
-        message: "Task requests returned successfully",
-        data,
-      });
+    let data;
+    if (dev === "true") {
+      data = await taskRequestsModel.fetchPaginatedTaskRequests(_.query);
+      if (data.error) {
+        return res.status(data.statusCode).json(data);
+      }
+    } else {
+      data = {};
+      data.data = await taskRequestsModel.fetchTaskRequests(true);
     }
 
-    return res.status(404).json({
-      message: "Task requests not found",
-      data,
+    return res.status(200).json({
+      message: "Task requests returned successfully",
+      ...data,
     });
   } catch (err) {
     logger.error("Error while fetching task requests", err);
@@ -213,10 +215,34 @@ const approveTaskRequest = async (req, res) => {
   }
 };
 
+const migrateTaskRequests = async (req, res) => {
+  try {
+    const { action } = req.query;
+    let responseData;
+    switch (action) {
+      case MIGRATION_TYPE.ADD_NEW_FIELDS: {
+        responseData = await taskRequestsModel.addNewFields();
+        break;
+      }
+      case MIGRATION_TYPE.REMOVE_OLD_FIELDS: {
+        responseData = await taskRequestsModel.removeOldField();
+        break;
+      }
+      default: {
+        return res.boom.badRequest("Unknown action");
+      }
+    }
+    return res.json({ message: "Task requests migration successful", ...responseData });
+  } catch (err) {
+    logger.error("Error in migration scripts", err);
+    return res.boom.badImplementation(INTERNAL_SERVER_ERROR);
+  }
+};
 module.exports = {
   approveTaskRequest,
   addOrUpdate,
   fetchTaskRequests,
   fetchTaskRequestById,
   addTaskRequests,
+  migrateTaskRequests,
 };

middlewares/validators/task-requests.js

@@ -1,8 +1,9 @@
 const joi = require("joi");
-const { TASK_REQUEST_TYPE } = require("../../constants/taskRequests");
+const { RQLQueryParser } = require("../../utils/RQLParser");
 const githubOrg = config.get("githubApi.org");
 const githubBaseUrl = config.get("githubApi.baseUrl");
 const githubIssuerUrlPattern = new RegExp(`^${githubBaseUrl}/repos/${githubOrg}/.+/issues/\\d+$`);
+const { TASK_REQUEST_STATUS, TASK_REQUEST_TYPE } = require("../../constants/taskRequests");
 
 const postTaskRequests = async (req, res, next) => {
   const taskAssignmentSchema = joi
@@ -40,6 +41,61 @@ const postTaskRequests = async (req, res, next) => {
   }
 };
 
+const getTaskRequests = async (req, res, next) => {
+  const queryParamsSchema = joi
+    .object()
+    .keys({
+      dev: joi.bool().optional().sensitive(),
+      prev: joi.string().optional(),
+      next: joi.string().optional(),
+      size: joi.number().integer().positive().min(1).max(100).optional(),
+      q: joi.string().optional(),
+    })
+    .without("prev", "next")
+    .with("prev", "size")
+    .with("next", "size");
+
+  const filtersSchema = joi.object().keys({
+    status: joi
+      .array()
+      .items(
+        joi.object().keys({
+          value: joi.string().valid(...Object.values(TASK_REQUEST_STATUS).map((value) => value.toLowerCase())),
+          operator: joi.string().optional(),
+        })
+      )
+      .optional(),
+    "request-type": joi
+      .array()
+      .items(
+        joi.object().keys({
+          value: joi.string().valid(...Object.values(TASK_REQUEST_TYPE).map((value) => value.toLowerCase())),
+          operator: joi.string().optional(),
+        })
+      )
+      .optional(),
+  });
+
+  const sortSchema = joi.object().keys({
+    created: joi.string().valid("asc", "desc").optional(),
+    requestors: joi.string().valid("asc", "desc").optional(),
+  });
+  try {
+    const { q: queryString } = req.query;
+    const rqlQueryParser = new RQLQueryParser(queryString);
+
+    await Promise.all([
+      filtersSchema.validateAsync(rqlQueryParser.getFilterQueries()),
+      sortSchema.validateAsync(rqlQueryParser.getSortQueries()),
+      queryParamsSchema.validateAsync(req.query),
+    ]);
+    next();
+  } catch (error) {
+    logger.error(`Error validating get task requests payload : ${error}`);
+    res.boom.badRequest(error?.details?.[0]?.message || error?.message);
+  }
+};
 module.exports = {
+  getTaskRequests,
   postTaskRequests,
 };