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

dev to main sync
merged on 28 Jul 2023 21:34 IST

Author: RitikJaiswal75

.eslintrc.js

@@ -30,5 +30,5 @@ module.exports = {
     // Prettier for formatting
     "prettier/prettier": "error",
   },
-  ignorePatterns: ["public/*"],
+  ignorePatterns: ["public/*", "dist/*"],
 };

.github/workflows/codeql.yml

@@ -13,12 +13,12 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ "develop", main ]
+    branches: ["develop", main]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ "develop" ]
+    branches: ["develop"]
   schedule:
-    - cron: '15 19 * * 5'
+    - cron: "15 19 * * 5"
 
 jobs:
   analyze:
@@ -32,43 +32,42 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ["javascript"]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
 
-        
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    # - run: |
-    #   echo "Run, Build Application using script"
-    #   ./location_of_script_within_repo/buildscript.sh
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
-      with:
-        category: "/language:${{matrix.language}}"
+      # - run: |
+      #   echo "Run, Build Application using script"
+      #   ./location_of_script_within_repo/buildscript.sh
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{matrix.language}}"

.github/workflows/test.yml

@@ -18,10 +18,10 @@ jobs:
         node-version: [18.x]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: yarn
-    - run: yarn test
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: yarn
+      - run: yarn test

.mocharc.js

@@ -3,5 +3,7 @@
  * Info: https://mochajs.org/#configuring-mocha-nodejs
  */
 module.exports = {
-  timeout: '5000',
+  timeout: "5000",
+  extension: ["ts", "js"],
+  require: "ts-node/register",
 };

CHANGELOG.md

@@ -1,4 +1,5 @@
 # Real Dev Squad API Changelog
+
 All notable changes to this project will be documented in this file.
 
 <!--
@@ -11,12 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <!-- Sample changelog
 ## [Project Version] - YYYY-MM-DD
 
-### Added 
+### Added
 - Feature name added
 
 ### Changed
-### Deprecated 
+### Deprecated
 ### Removed
-### Fixed 
+### Fixed
 ### Security
 -->

README.md

@@ -54,7 +54,7 @@ yarn validate-setup
 
 Head over to [TDD Tests Files List](scripts/tests/tdd-files-list.txt), and add the list of your new (or old) test files.
 
-> You can use wildcard '*' in the filepaths
+> You can use wildcard '\*' in the filepaths
 
 Run TDD in watch mode. Exiting this command will print the coverage report. Try to achieve 100% coverage.
 

controllers/tasks.js

@@ -341,7 +341,7 @@ const updateTaskStatus = async (req, res, next) => {
       }
     }
 
-    if (isUserStatusEnabled && req.body.status === TASK_STATUS.COMPLETED && req.body.percentCompleted === 100) {
+    if (isUserStatusEnabled && req.body.status) {
       userStatusUpdate = await updateStatusOnTaskCompletion(userId);
     }
     return res.json({

docs/backendFlow.md

@@ -242,7 +242,7 @@ Tests are written using:
 - `scripts` : For different scripts needed for development & others
 - `Dependencies` : Modules needed for the project to work/ be functional
 - `devDependencies` : Dependencies only needed for the devlopment purpose
- 
+
 <br>
 
 ---

models/userStatus.js

@@ -331,22 +331,22 @@ const batchUpdateUsersStatus = async (users) => {
   const currentTimeStamp = new Date().getTime();
   const batch = firestore.batch();
   const summary = {
-    totalUsers: users.length,
-    totalUnprocessedUsers: 0,
-    totalOnboardingUsersAltered: 0,
-    totalOnboardingUsersUnAltered: 0,
-    totalActiveUsersAltered: 0,
-    totalActiveUsersUnAltered: 0,
-    totalIdleUsersAltered: 0,
-    totalIdleUsersUnAltered: 0,
+    usersCount: users.length,
+    unprocessedUsers: 0,
+    onboardingUsersAltered: 0,
+    onboardingUsersUnaltered: 0,
+    activeUsersAltered: 0,
+    activeUsersUnaltered: 0,
+    idleUsersAltered: 0,
+    idleUsersUnaltered: 0,
   };
 
   for (const { userId, state } of users) {
     let latestStatusData;
     try {
       latestStatusData = await getUserStatus(userId);
     } catch (error) {
-      summary.totalUnprocessedUsers++;
+      summary.unprocessedUsers++;
       continue;
     }
     const { id, userStatusExists, data } = latestStatusData;
@@ -364,14 +364,14 @@ const batchUpdateUsersStatus = async (users) => {
         userId,
         currentStatus: statusToUpdate,
       };
-      state === userState.ACTIVE ? summary.totalActiveUsersAltered++ : summary.totalIdleUsersAltered++;
+      state === userState.ACTIVE ? summary.activeUsersAltered++ : summary.idleUsersAltered++;
       batch.set(newUserStatusRef, newUserStatusData);
     } else {
       const {
         currentStatus: { state: currentState, until },
       } = data;
       if (currentState === state) {
-        currentState === userState.ACTIVE ? summary.totalActiveUsersUnAltered++ : summary.totalIdleUsersUnAltered++;
+        currentState === userState.ACTIVE ? summary.activeUsersUnaltered++ : summary.idleUsersUnaltered++;
         continue;
       }
       if (currentState === userState.ONBOARDING) {
@@ -380,13 +380,13 @@ const batchUpdateUsersStatus = async (users) => {
           const updatedStatusData = {
             currentStatus: statusToUpdate,
           };
-          summary.totalOnboardingUsersAltered++;
+          summary.onboardingUsersAltered++;
           batch.update(docRef, updatedStatusData);
         } else {
-          summary.totalOnboardingUsersUnAltered++;
+          summary.onboardingUsersUnaltered++;
         }
       } else {
-        state === userState.ACTIVE ? summary.totalActiveUsersAltered++ : summary.totalIdleUsersAltered++;
+        state === userState.ACTIVE ? summary.activeUsersAltered++ : summary.idleUsersAltered++;
         const docRef = userStatusModel.doc(id);
         const updatedStatusData =
           currentState === userState.OOO

nyc.config.js

@@ -5,7 +5,7 @@
 module.exports = {
   all: true,
   "check-coverage": false, // Will be enabled after reaching 50% coverage: https://github.com/Real-Dev-Squad/website-backend/issues/493
-  exclude: ["test/**", "mockdata/**", "docs/**", "public/**"],
+  exclude: ["test/**", "mockdata/**", "docs/**", "public/**", "dist/**"],
   reporter: ["text", "lcov", "text-summary"],
   reportDir: ".coverage",
   tempDir: ".coverage",