Implement Vote Routes, Logging, and Error Handling Enhancements

[nicholas-source]

Description:

This pull request introduces the foundational vote functionality for the EchoVote decentralized voting system. It includes routes and service methods for casting votes, fetching votes, counting votes, and enhancing the overall robustness of the application with logging and error-handling mechanisms.

Summary of Changes:

1. Vote Routes and Services:

   • Implemented POST Route for Casting Votes:
     • Added a route to cast a vote for a specific proposal, requiring proposalId and voteOption in the request body.
   • GET Route for Fetching Voter's Vote:
     • Created a route to retrieve a specific voter's vote on a given proposal.
   • Additional Vote Count Routes:
     • Implemented routes to get the vote count by option and the total votes for a proposal.
   • These routes integrate seamlessly with the Stacks smart contract functions via the service layer.
   • Commit: feat(votes): add vote routes and service methods for casting, fetching, and counting votes.

2. Request Logging Middleware:

   • Added Request Logger:
     • Introduced middleware to log incoming HTTP requests, including method, URL, and timestamp.
     • Enhances visibility into API traffic and aids in debugging and monitoring system activity.
   • Commit: feat(logging): add request logger middleware to log incoming requests.

3. Global Error Handling Middleware:

   • Implemented Global Error Handler:
     • Added middleware to catch and handle errors globally across the Express application.
     • In production, stack traces are hidden to prevent leakage of sensitive information, while development mode provides full details for easier debugging.
   • Commit: feat(error-handling): add global error handler middleware.

4. Proposal Routes Placeholder:

   • Added Placeholder Routes for Proposals:
     • Included basic structure for proposal-related functionality to be implemented in future iterations.
     • This allows the proposal framework to be established while focusing on vote functionality.
   • Commit: feat(proposals): integrate proposal routes placeholder.

5. Network Configuration Refactor:

   • Extracted Network Logic into Utility Function:
     • Refactored logic determining the network (mainnet/testnet) into a reusable utility function.
     • This reduces duplication and ensures consistency across the codebase.
   • Commit: refactor(network): extract network configuration logic into utility function.

6. Input Validation and Sanitization:

   • Added Input Validation:
     • Introduced express-validator for validating and sanitizing input in vote routes.
     • Ensures proposal IDs and vote options are valid integers and that voter addresses are well-formed, strengthening security.
   • Commit: security(validation): add input validation and sanitization to vote routes.

7. Enhanced Error Handling Security:

   • Prevented Stack Trace Exposure:
     • Modified the global error handler to only expose error messages in production, while stack traces are available in development mode.
     • Protects against potential security vulnerabilities by avoiding stack trace exposure in production environments.
   • Commit: security(error-handling): prevent stack trace exposure in production mode.

8. Removal of Placeholder Proposal Route:

   • Reverted Placeholder Proposal Route:
     • Removed the previously added placeholder proposal route until it is fully implemented to avoid confusion in the codebase.
     • This route will be reintroduced once full proposal functionality is developed.
   • Commit: revert(proposals): remove placeholder proposal route until fully implemented.

Next Steps:

• Continue developing the proposal functionalities to reintroduce and integrate them with the voting system.
• Enhance testing coverage to ensure reliability and security.

Reviewers:

• @Senior_Developer
• @Smart_Contract Specialist with Clarity
• @QA_Engineer
• @Team_Lead