Merge branch 'develop' into bugfix/issue957

Author: iamYashSinha

.github/workflows/test.yml

@@ -11,6 +11,7 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    timeout-minutes: 5
 
     strategy:
       matrix:

CONTRIBUTING.md

@@ -101,15 +101,19 @@ The following project structure should be followed:
 - Authorization header: `Authorization: Bearer <token>`
 
 ## Production login:
-https://github.com/login/oauth/authorize?client_id=23c78f66ab7964e5ef97
+
+https://api.realdevsquad.com/auth/github/login
 
 ### Production login - Cookie:
+
 rds-session
 
 ## Staging login:
-https://github.com/login/oauth/authorize?client_id=ebb301661e883a85bf9a
 
-### Staging login - Cookie: 
+https://staging-api.realdevsquad.com/auth/github/login
+
+### Staging login - Cookie:
+
 rds-session-staging
 
 ## Testing Guidelines
@@ -155,3 +159,16 @@ export FIRESTORE_EMULATOR_HOST="localhost:<Firebase emulator PORT>"
 - 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.
+
+## Certain issues you may face while running the tests:
+
+- Java version is not above 11
+- When we run yarn test, it runs both the unit and integration tests (in this order). So after the unit tests are done, the java process is not killed automatically and when our integration test run it gives error.
+- Error: connect ECONNREFUSED ::1:8081
+
+## Possible solutions for above issues (in particular order):
+
+- Java version above 11 is needed for firebase tool version >= 11
+- Either manually kill the java process after unit tests are done or run both the tests separately by running the test commands.
+- Add 'host : 0.0.0.0' to both firestore and ui object in firebase.json file if it is not added.
+  for more info refer this : https://github.com/Real-Dev-Squad/website-backend/issues/918

config/default.js

@@ -46,6 +46,9 @@ module.exports = {
         authRedirection: "/goto",
       },
     },
+    discordBot: {
+      baseUrl: "<DISCORD_BOT_BASE_URL>",
+    },
   },
 
   cors: {

constants/monitor.js

@@ -0,0 +1,15 @@
+const RESOURCE_CREATED_SUCCESSFULLY = "Resource created successfully.";
+const RESOURCE_UPDATED_SUCCESSFULLY = "Resource updated successfully.";
+const RESOURCE_RETRIEVED_SUCCESSFULLY = "Resource retrieved successfully.";
+const RESOURCE_NOT_FOUND = "Resource not found.";
+const RESOURCE_ALREADY_TRACKED = "Resource is already being tracked.";
+
+const RESPONSE_MESSAGES = {
+  RESOURCE_CREATED_SUCCESSFULLY,
+  RESOURCE_UPDATED_SUCCESSFULLY,
+  RESOURCE_RETRIEVED_SUCCESSFULLY,
+  RESOURCE_NOT_FOUND,
+  RESOURCE_ALREADY_TRACKED,
+};
+
+module.exports = { RESPONSE_MESSAGES };

constants/progresses.js

@@ -3,6 +3,8 @@ const PROGRESS_DOCUMENT_RETRIEVAL_SUCCEEDED = "Progress document retrieved succe
 const PROGRESS_DOCUMENT_NOT_FOUND = "No progress records found.";
 const PROGRESS_ALREADY_CREATED = "Progress for the day has already been created.";
 const MILLISECONDS_IN_DAY = 24 * 60 * 60 * 1000;
+const INTERNAL_SERVER_ERROR_MESSAGE =
+  "The server has encountered an unexpected error. Please contact the administrator for more information.";
 
 const RESPONSE_MESSAGES = {
   PROGRESS_DOCUMENT_CREATED_SUCCEEDED,
@@ -11,4 +13,17 @@ const RESPONSE_MESSAGES = {
   PROGRESS_ALREADY_CREATED,
 };
 
-module.exports = { RESPONSE_MESSAGES, MILLISECONDS_IN_DAY };
+const TYPE_MAP = {
+  user: "userId",
+  task: "taskId",
+};
+
+const VALID_PROGRESS_TYPES = ["task", "user"];
+
+module.exports = {
+  RESPONSE_MESSAGES,
+  MILLISECONDS_IN_DAY,
+  INTERNAL_SERVER_ERROR_MESSAGE,
+  TYPE_MAP,
+  VALID_PROGRESS_TYPES,
+};

constants/rateLimiting.js

@@ -0,0 +1,8 @@
+const TOO_MANY_REQUESTS = {
+  ERROR_TYPE: "Too Many Requests",
+  STATUS_CODE: 429,
+};
+
+module.exports = {
+  TOO_MANY_REQUESTS,
+};

constants/roles.js

@@ -4,6 +4,7 @@ const ROLES = {
   APPOWNER: "app_owner",
   MEMBER: "member",
   ARCHIVED: "archived",
+  INDISCORD: "in_discord",
 };
 
 module.exports = ROLES;

constants/tasks.js

@@ -5,18 +5,11 @@ const TASK_TYPE = {
 };
 
 const TASK_STATUS = {
-  // old task workflow
-  ACTIVE: "IN_PROGRESS",
-  "HIGH PRIORITY": "HIGH PRIORITY",
-  PENDING: "IN_PROGRESS",
+  AVAILABLE: "AVAILABLE",
   ASSIGNED: "ASSIGNED",
-  BLOCKED: "BLOCKED",
   COMPLETED: "COMPLETED",
-
-  // new task workflow
   IN_PROGRESS: "IN_PROGRESS",
-  UNASSIGNED: "AVAILABLE",
-  AVAILABLE: "AVAILABLE",
+  BLOCKED: "BLOCKED",
   SMOKE_TESTING: "SMOKE_TESTING",
   NEEDS_REVIEW: "NEEDS_REVIEW",
   IN_REVIEW: "IN_REVIEW",
@@ -26,8 +19,10 @@ const TASK_STATUS = {
   REGRESSION_CHECK: "REGRESSION_CHECK",
   RELEASED: "RELEASED",
   VERIFIED: "VERIFIED",
+  DONE: "DONE",
 };
 
+// TODO: convert this to new task status
 const TASK_STATUS_OLD = {
   OLD_ACTIVE: "active",
   OLD_BLOCKED: "blocked",

constants/users.js

@@ -13,6 +13,7 @@ const USER_STATUS = {
 const ALLOWED_FILTER_PARAMS = {
   ITEM_TAG: ["levelId", "levelName", "levelValue", "tagId"],
   USER_STATE: ["state"],
+  ROLE: ["role"],
 };
 
 module.exports = { profileStatus, USER_STATUS, ALLOWED_FILTER_PARAMS };

controllers/monitor.js

@@ -0,0 +1,188 @@
+const { Conflict, NotFound } = require("http-errors");
+const { INTERNAL_SERVER_ERROR_MESSAGE } = require("../constants/progresses");
+const {
+  createTrackedProgressDocument,
+  updateTrackedProgressDocument,
+  getTrackedProgressDocuments,
+} = require("../models/monitor");
+const { RESPONSE_MESSAGES } = require("../constants/monitor");
+const { RESOURCE_CREATED_SUCCESSFULLY, RESOURCE_UPDATED_SUCCESSFULLY, RESOURCE_RETRIEVED_SUCCESSFULLY } =
+  RESPONSE_MESSAGES;
+/**
+ * @typedef {Object} TrackedProgressRequestBody
+ * @property {string} type - The type of tracked progress ("user" or "task").
+ * @property {string} [userId] - The user ID (required if type is "user").
+ * @property {string} [taskId] - The task ID (required if type is "task").
+ * @property {boolean} monitored - Indicates if the progress is currently being tracked.
+ * @property {number} [frequency=1] - The frequency of tracking.By default 1 if not specified
+ */
+
+/**
+ * @typedef {Object} TrackedProgressResponseData
+ * @property {string} id - The ID of the tracked progress document.
+ * @property {string} type - The type of tracked progress ("user" or "task").
+ * @property {string} userId - The user ID.
+ * @property {boolean} monitored - Indicates if the progress is currently being tracked.
+ * @property {number} frequency - The frequency of tracking.
+ * @property {string} createdAt - The timestamp when the document was created.
+ * @property {string} updatedAt - The timestamp when the document was last updated.
+ */
+
+/**
+ * @typedef {Object} TrackedProgressResponse
+ * @property {TrackedProgressResponseData} data - The data of the tracked progress document.
+ * @property {string} message - The success message.
+ */
+
+/**
+ * Controller function for creating a tracked progress document.
+ *
+ * @param {Express.Request} req - The Express request object.
+ * @param {TrackedProgressRequestBody} req.body - The Request body object.
+ * @param {Express.Response} res - The Express response object.
+ * @returns {Promise<void>} - A Promise that resolves when the response has been sent.
+ */
+
+const createTrackedProgressController = async (req, res) => {
+  try {
+    const data = await createTrackedProgressDocument({ ...req.body });
+    return res.status(201).json({
+      message: RESOURCE_CREATED_SUCCESSFULLY,
+      data,
+    });
+  } catch (error) {
+    if (error instanceof Conflict) {
+      return res.status(409).json({
+        message: error.message,
+      });
+    } else if (error instanceof NotFound) {
+      return res.status(404).json({
+        message: error.message,
+      });
+    }
+    return res.status(500).json({
+      message: INTERNAL_SERVER_ERROR_MESSAGE,
+    });
+  }
+};
+
+/**
+ * @typedef {Object} UpdateTrackedProgressRequestParams
+ * @property {string} type - The type of tracked progress ("user" or "task").
+ * @property {string} id - The ID of the tracked progress document.
+ */
+
+/**
+ * @typedef {Object} UpdateTrackedProgressRequestBody
+ * @property {number} frequency - The frequency of tracking.
+ * @property {boolean} monitored - Indicates if the progress is currently being tracked.
+ */
+
+/**
+ * @typedef {Object} UpdateTrackedProgressResponseData
+ * @property {string} id - The ID of the tracked progress document.
+ * @property {string} createdAt - The timestamp when the document was created.
+ * @property {string} type - The type of tracked progress ("user" or "task").
+ * @property {string} userId - The user ID.
+ * @property {number} frequency - The frequency of tracking.
+ * @property {boolean} monitored - Indicates if the progress is currently being tracked.
+ * @property {string} updatedAt - The timestamp when the document was last updated.
+ */
+
+/**
+ * @typedef {Object} UpdateTrackedProgressResponse
+ * @property {UpdateTrackedProgressResponseData} data - The data of the tracked progress document.
+ * @property {string} message - The success message.
+ */
+
+/**
+ * Controller function for updating a tracked progress document.
+ *
+ * @param {Express.Request} req - The Express request object.
+ * @param {UpdateTrackedProgressRequestParams} req.params - The request path parameters.
+ * @param {UpdateTrackedProgressRequestBody} req.body - The request body object.
+ * @param {Express.Response} res - The Express response object.
+ * @returns {Promise<void>} - A Promise that resolves when the response has been sent.
+ */
+
+const updateTrackedProgressController = async (req, res) => {
+  try {
+    const data = await updateTrackedProgressDocument({ ...req });
+    return res.status(200).json({
+      data,
+      message: RESOURCE_UPDATED_SUCCESSFULLY,
+    });
+  } catch (error) {
+    if (error instanceof NotFound) {
+      return res.status(404).json({
+        message: error.message,
+      });
+    }
+    return res.status(500).json({
+      message: INTERNAL_SERVER_ERROR_MESSAGE,
+    });
+  }
+};
+
+/**
+ * @typedef {Object} GetTrackedProgressRequestParams
+ * @property {string} [type] - The type of tracked progress ("user" or "task").
+ * @property {string} [monitored] - Indicates if the progress is currently being tracked.
+ * @property {string} [userId] - The ID of the User who is currently being tracked.
+ * @property {string} [taskId] - The ID of the task which is currently being tracked.
+ */
+
+/**
+ * @typedef {Object} TrackedProgressData
+ * @property {string} id - The ID of the tracked progress document.
+ * @property {boolean} monitored - Indicates if the progress is currently being tracked.
+ * @property {string} createdAt - The timestamp when the document was created.
+ * @property {string} type - The type of tracked progress ("user" or "task").
+ * @property {string} [userId] - The user ID.
+ * @property {string} [taskId] - The task ID.
+ * @property {number} frequency - The frequency of tracking.
+ * @property {string} updatedAt - The timestamp when the document was last updated.
+ */
+
+/**
+ * @typedef {Object} GetTrackedProgressResponse
+ * @property {string} message - The success message.
+ * @property {TrackedProgressData | TrackedProgressData[]} data - The data of the tracked progress document(s).
+ */
+
+/**
+ * Controller function for retrieving tracked progress documents.
+ *
+ * @param {Express.Request} req - The Express request object.
+ * @param {Express.Response} res - The Express response object.
+ * @returns {Promise<void>} A Promise that resolves when the response has been sent.
+ */
+
+const getTrackedProgressController = async (req, res) => {
+  try {
+    const data = await getTrackedProgressDocuments({ ...req.query });
+    return res.status(200).json({
+      message: RESOURCE_RETRIEVED_SUCCESSFULLY,
+      data,
+    });
+  } catch (error) {
+    if (error instanceof NotFound) {
+      const response = {
+        message: error.message,
+      };
+      if (req.query.type) {
+        response.data = [];
+      }
+      return res.status(404).json(response);
+    }
+    return res.status(500).json({
+      message: INTERNAL_SERVER_ERROR_MESSAGE,
+    });
+  }
+};
+
+module.exports = {
+  createTrackedProgressController,
+  updateTrackedProgressController,
+  getTrackedProgressController,
+};