Merge branch 'development' into create-script-output-list-files-containing-linting-errors

Author: bconti123

.github/workflows/pr-instructions.yml

@@ -28,7 +28,7 @@ jobs:
           echo ${{ steps.instruction.outputs.result }} > addingPrInstructions/artifact/artifact.txt
       
       - name: Upload Artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: adding-pr-instructions-artifact
           path: addingPrInstructions/artifact/

CONTRIBUTING.md

@@ -106,7 +106,7 @@ Note: Understanding how git remotes work will make collaborating much easier. Yo
 
 ### **2.3 Get up and running**
 
-1. Install NVM (Node Version Manager). NVM allows you to easily manage and switch between multiple versions of Node.
+1. Install [NVM (Node Version Manager)](https://github.com/nvm-sh/nvm). NVM allows you to easily manage and switch between multiple versions of Node.
 
    - Verify the installation: `nvm --version`
    - Once NVM is verified, run the following commands from the root of the project:

backend/controllers/project.controller.js

@@ -130,4 +130,26 @@ ProjectController.bulkUpdateManagedByUsers = async function (req, res) {
   }
 };
 
+// Update onboard/offboard visibility for a project
+ProjectController.updateOnboardOffboardVisibility = async function (req, res) {
+  const { ProjectId } = req.params;
+  const { onboardOffboardVisible } = req.body;
+
+  try {
+    const project = await Project.findByIdAndUpdate(
+      ProjectId,
+      { onboardOffboardVisible },
+      { new: true }
+    );
+
+    if (!project) {
+      return res.status(404).send({ message: 'Project not found' });
+    }
+
+    return res.status(200).send(project);
+  } catch (err) {
+    return res.status(400).send({ message: 'Error updating visibility', error: err.message });
+  }
+};
+
 module.exports = ProjectController;

backend/models/project.model.js

@@ -16,49 +16,51 @@ Idea for the future: programmingLanguages, numberGithubContributions (pull these
 */
 
 const projectSchema = mongoose.Schema({
-    name: { type: String, trim: true },
-    description: { type: String, trim: true },
-    githubIdentifier: { type: String, trim: true },
-    projectStatus: { type: String },                    // Active, Completed, or Paused
-    location: { type: String, trim: true },                         // DTLA, Westside, South LA, or Remote (hacknight)
-    //teamMembers: { type: String },                    // commented since we should be able to get this from Project Team Members table
-    createdDate: { type: Date, default: Date.now },     // date/time project was created
-    completedDate: { type: Date },                      // only if Status = Completed, date/time completed
-    githubUrl: { type: String, trim: true },                        // link to main repo
-    slackUrl: { type: String, trim: true },                         // link to Slack channel
-    googleDriveUrl: { type: String, trim: true },
-    googleDriveId: { type: String },
-    hflaWebsiteUrl: { type: String, trim: true },
-    videoConferenceLink: { type: String },
-    lookingDescription: { type: String },               // narrative on what the project is looking for
-    recruitingCategories: [{ type: String }],           // same as global Skills picklist
-    partners: [{ type: String }],                       // any third-party partners on the project, e.g. City of LA
-    managedByUsers: [{ type: String }]                  // Which users may manage this project.                 
+  name: { type: String, trim: true },
+  description: { type: String, trim: true },
+  githubIdentifier: { type: String, trim: true },
+  projectStatus: { type: String }, // Active, Completed, or Paused
+  location: { type: String, trim: true }, // DTLA, Westside, South LA, or Remote (hacknight)
+  //teamMembers: { type: String },                    // commented since we should be able to get this from Project Team Members table
+  createdDate: { type: Date, default: Date.now }, // date/time project was created
+  completedDate: { type: Date }, // only if Status = Completed, date/time completed
+  githubUrl: { type: String, trim: true }, // link to main repo
+  slackUrl: { type: String, trim: true }, // link to Slack channel
+  googleDriveUrl: { type: String, trim: true },
+  googleDriveId: { type: String },
+  hflaWebsiteUrl: { type: String, trim: true },
+  videoConferenceLink: { type: String },
+  lookingDescription: { type: String }, // narrative on what the project is looking for
+  recruitingCategories: [{ type: String }], // same as global Skills picklist
+  partners: [{ type: String }], // any third-party partners on the project, e.g. City of LA
+  managedByUsers: [{ type: String }], // Which users may manage this project.
+  onboardOffboardVisible: { type: Boolean, default: true }, // Whether onboarding/offboarding forms are visible on the project page
 });
 
-projectSchema.methods.serialize = function() {
-    return {
-        id: this._id,
-        name: this.name,
-        description: this.description,
-        githubIdentifier: this.githubIdentifier,
-        // owner: this.owner,
-        projectStatus: this.projectStatus,
-        location: this.location,
-        //teamMembers: this.teamMembers,
-        createdDate: this.createdDate,
-        completedDate: this.completedDate,
-        githubUrl: this.githubUrl,
-        slackUrl: this.slackUrl,
-        googleDriveUrl: this.googleDriveUrl,
-        googleDriveId: this.googleDriveId,
-        hflaWebsiteUrl: this.hflaWebsiteUrl,
-        videoConferenceLink: this.videoConferenceLink,
-        lookingDescription: this.lookingDescription,
-        recruitingCategories: this.recruitingCategories,
-        partners: this.partners,
-        managedByUsers: this.managedByUsers
-    };
+projectSchema.methods.serialize = function () {
+  return {
+    id: this._id,
+    name: this.name,
+    description: this.description,
+    githubIdentifier: this.githubIdentifier,
+    // owner: this.owner,
+    projectStatus: this.projectStatus,
+    location: this.location,
+    //teamMembers: this.teamMembers,
+    createdDate: this.createdDate,
+    completedDate: this.completedDate,
+    githubUrl: this.githubUrl,
+    slackUrl: this.slackUrl,
+    googleDriveUrl: this.googleDriveUrl,
+    googleDriveId: this.googleDriveId,
+    hflaWebsiteUrl: this.hflaWebsiteUrl,
+    videoConferenceLink: this.videoConferenceLink,
+    lookingDescription: this.lookingDescription,
+    recruitingCategories: this.recruitingCategories,
+    partners: this.partners,
+    managedByUsers: this.managedByUsers,
+    onboardOffboardVisible: this.onboardOffboardVisible,
+  };
 };
 
 const Project = mongoose.model('Project', projectSchema);

backend/package.json

@@ -56,7 +56,7 @@
     "morgan": "^1.10.0",
     "node-cron": "^2.0.3",
     "node-fetch": "^2.6.7",
-    "nodemailer": "^7.0.7"
+    "nodemailer": "^7.0.11"
   },
   "directories": {
     "test": "test"

backend/routers/healthCheck.router.test.js

@@ -0,0 +1,42 @@
+// Mock the healthCheck controller
+jest.mock('../controllers/healthCheck.controller.js');
+
+// Import the healthCheck router and controller
+const healthCheck = require('./healthCheck.router.js');
+const { HealthCheckController } = require('../controllers');
+
+// Create a mock test server
+const express = require('express');
+const supertest = require('supertest');
+const testapp = express();
+testapp.use('/api/healthcheck', healthCheck);
+
+// Set up mock request for the controller
+const request = supertest(testapp);
+
+describe('Unit testing for Health Check Router', () => {
+  // Clear all mocks after each test
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('READ', () => {
+    it('should return status code 200 and message "I\'m Alive" with GET /api/healthcheck', async (done) => {
+      // Mock the controller method
+      HealthCheckController.isAlive.mockImplementationOnce((req, res) => {
+        res.status(200).send("I'm Alive!");
+      });
+
+      // Call GET API endpoint
+      const response = await request.get('/api/healthcheck');
+
+      // Test
+      expect(HealthCheckController.isAlive).toHaveBeenCalled();
+      expect(response.status).toBe(200);
+      expect(response.text).toBe("I'm Alive!");
+
+      // Marks completion of the test
+      done();
+    });
+  });
+});

backend/routers/projects.router.js

@@ -22,4 +22,7 @@ router.patch('/:ProjectId', AuthUtil.verifyCookie, ProjectController.updateManag
 // Bulk update for editing project members
 router.post('/bulk-updates', AuthUtil.verifyCookie, ProjectController.bulkUpdateManagedByUsers);
 
+// Update onboard/offboard visibility for a project
+router.patch('/:ProjectId/visibility', AuthUtil.verifyCookie, ProjectController.updateOnboardOffboardVisibility);
+
 module.exports = router;

backend/scripts/deleteProject/README.md

@@ -0,0 +1,143 @@
+# Delete Project Script - Modular Structure
+
+This directory contains the modular implementation of the project deletion script.
+
+## File Structure
+
+```
+deleteProject/
+├── README.md          # This file
+├── index.js           # Main orchestration file (entry point)
+├── config.js          # Configuration constants (database names)
+├── utils.js           # Utility functions (validation, CLI parsing, help)
+├── finders.js         # Database query functions (find related records)
+├── displays.js        # Display functions (show detailed information)
+└── deleters.js        # Deletion functions (delete/update operations)
+```
+
+## Module Descriptions
+
+### `index.js`
+
+Main orchestration file that coordinates the entire deletion process.
+
+- Parses command-line arguments
+- Validates input and environment
+- Connects to MongoDB
+- Orchestrates the find → display → delete workflow
+- Handles errors and cleanup
+
+### `config.js`
+
+Configuration constants used throughout the script.
+
+- Database names (production, development, test)
+- Can be extended with other configuration values
+
+### `utils.js`
+
+Utility and helper functions.
+
+- `checkEnv()` - Validates required environment variables
+- `isValidObjectId()` - Validates MongoDB ObjectId format
+- `getProjectIdFromArgs()` - Extracts project ID from CLI arguments
+- `printHelp()` - Displays usage information
+
+### `finders.js`
+
+Database query functions for finding related records.
+
+- `findProject()` - Find the project by ID
+- `findProjectEvents()` - Find all events for the project
+- `findEventCheckIns()` - Find all check-ins for project events
+- `findProjectTeamMembers()` - Find team members
+- `findUsersReferencingProject()` - Find users with project references
+- `findRelatedRecurringEvents()` - Find recurring events
+
+### `displays.js`
+
+Display functions for showing detailed record information.
+
+- `displayUserDetails()` - Show user information
+- `displayEventDetails()` - Show event information
+- `displayCheckInDetails()` - Show check-in information (with user lookup)
+- `displayProjectTeamMemberDetails()` - Show team member information
+- `displayRecurringEventDetails()` - Show recurring event information
+
+### `deleters.js`
+
+Deletion and update functions.
+
+- `deleteCheckIns()` - Delete check-in records
+- `deleteProjectTeamMembers()` - Delete team member records
+- `updateUsersRemoveProject()` - Remove project references from users
+- `deleteEvents()` - Delete event records
+- `deleteRecurringEvents()` - Delete recurring event records
+- `deleteProject()` - Delete the project itself
+
+## Usage
+
+### From the deleteProject directory:
+
+```bash
+node index.js --project-id=<PROJECT_ID> [options]
+```
+
+### From the scripts directory (backwards compatible):
+
+```bash
+node deleteProjectAndAssociatedRecords.js --project-id=<PROJECT_ID> [options]
+```
+
+### Options:
+
+- `--project-id=<ID>` - MongoDB ObjectId of the project to delete (REQUIRED)
+- `--prod` - Operate on production database
+- `--live` - Operate on development/staging database
+- `--test` - Operate on test database
+- `--mock` - Dry run (no actual deletion)
+- `--execute` - Execute the deletion
+- `--help` - Show help message
+
+## Examples
+
+```bash
+# Dry run on production
+node index.js --project-id=644748563212e6001fbca24a --prod --mock
+
+# Execute on test database
+node index.js --project-id=644748563212e6001fbca24a --test --execute
+
+# Execute on production (with 5-second warning)
+node index.js --project-id=644748563212e6001fbca24a --prod --execute
+```
+
+## Safety Features
+
+1. **Mock mode** - Preview all changes before executing
+2. **5-second warning** - Countdown for production/live databases
+3. **Validation** - Validates project ID and environment variables
+4. **Detailed output** - Shows exactly what will be deleted
+5. **Orphan detection** - Identifies orphaned check-ins
+
+## Deletion Order
+
+The script follows this order to maintain referential integrity:
+
+1. Check-ins
+2. Project team members
+3. User references (updated, not deleted)
+4. Events
+5. Recurring events
+6. Project
+
+## Environment Requirements
+
+- `MIGRATION_DB_URI` - MongoDB connection string
+
+Load from `backend/.env` file.
+
+## See Also
+
+- Main documentation: `tmp/GUIDE.md`
+- Manual deletion steps for MongoDB Compass users

backend/scripts/deleteProject/config.js

@@ -0,0 +1,14 @@
+/**
+ * Configuration constants for project deletion script
+ */
+
+// Database names
+const PROD_DB_NAME = 'db'; // Actual production database
+const DEV_DB_NAME = 'vrms-test'; // Development/staging database
+const DEV_TEST_DB_NAME = 'vrms-populate-projects-test'; // Test database for migration
+
+module.exports = {
+  PROD_DB_NAME,
+  DEV_DB_NAME,
+  DEV_TEST_DB_NAME,
+};