bluewave-labs / bluewave-uptime

BlueWave Uptime Monitor application
https://uptime-demo.bluewavelabs.ca/
GNU Affero General Public License v3.0
344 stars 30 forks source link

Feat/be/refactor #900

Closed ajhollid closed 4 days ago

ajhollid commented 4 days ago

This PR refactors back end for clarity and correctness

coderabbitai[bot] commented 4 days ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications across multiple files, focusing on refactoring user authentication functions, updating import paths, and enhancing error handling. Key changes include renaming several controller functions for clarity, restructuring the .gitignore file, and correcting import paths throughout the project. The changes aim to improve code organization, readability, and maintainability without altering the underlying functionality.

Changes

File Path Change Summary
.gitignore Updated to include patterns for ignoring JetBrains IDE files and retain specific exceptions.
Server/controllers/authController.js Refactored and renamed multiple user authentication functions for clarity; improved error handling.
Server/controllers/inviteController.js Renamed inviteController to issueInvitation, added JSDoc comments, and improved formatting.
Server/controllers/maintenanceWindowController.js Removed unused imports and corrected success message keys.
Server/controllers/monitorController.js Removed unused validation functions, improved documentation, and added a new method for demo monitors.
Server/db/FakeDb.js Updated import paths for Monitor and UserModel without changing functionality.
Server/db/models/Check.js Modified import paths for EmailService and Notification without altering schema or functionality.
Server/db/mongo/MongoDB.js Updated import paths for UserModel and AppSettings.
Server/db/mongo/modules/checkModule.js Adjusted import paths for models without changing functionality.
Server/db/mongo/modules/inviteModule.js Updated import path for InviteToken model.
Server/db/mongo/modules/maintenanceWindowModule.js Modified import path for MaintenanceWindow model.
Server/db/mongo/modules/monitorModule.js Corrected typos in error messages and updated import paths for models.
Server/db/mongo/modules/notificationModule.js Adjusted import path for Notification model.
Server/db/mongo/modules/pageSpeedCheckModule.js Updated import path for PageSpeedCheck model.
Server/db/mongo/modules/recoveryModule.js Modified import paths for UserModel and RecoveryToken.
Server/db/mongo/modules/settingsModule.js Updated import path for AppSettings model.
Server/db/mongo/modules/userModule.js Simplified import paths for UserModel and TeamModel.
Server/middleware/verifyJWT.js Changed import path for User model.
Server/routes/authRoute.js Updated import paths and renamed several controller functions for clarity.
Server/routes/checkRoute.js Changed import path for Monitor model without altering functionality.
Server/routes/maintenanceWindowRoute.js Updated import path for Monitor model.
Server/routes/settingsRoute.js Changed import path for Monitor model.
Server/service/pageSpeedService.js Updated import path for PageSpeedCheck model and improved error handling.
Server/service/settingsService.js Modified import path for AppSettings model.
Server/utils/messages.js Corrected typos and improved clarity in error and success messages.
Server/validation/joi.js Renamed inviteVerifciationBodyValidation to inviteVerificationBodyValidation.

Possibly related PRs

Suggested reviewers


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > ‼️ **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.