Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/be/refactor auth controller #1054

Merged

Conversation

ajhollid
Copy link
Collaborator

This PR refactors authController to remove some redundant checks.

getUserByEmail throws an Error at the db level if a user is not found, so a check to see if a user is found or not at the controller level is redundant.

Copy link

coderabbitai bot commented Oct 24, 2024

Walkthrough

The changes in this pull request primarily involve modifications to the authController.js and related test files. Key updates include adjustments to error handling, particularly changing the status codes for authentication failures and refining the logic for user management functions. The requestRecovery and deleteUser functions were streamlined by removing unnecessary user existence checks. Additionally, minor corrections were made in the userModule.js file, and corresponding tests were updated to reflect these changes in error handling and expected outcomes.

Changes

File Change Summary
Server/controllers/authController.js - Updated error handling for password mismatch (401 Unauthorized instead of 403 Forbidden).
- Streamlined requestRecovery function by removing user existence check.
- Modified deleteUser function to rely on subsequent logic for user existence.
Server/db/mongo/modules/userModule.js - Corrected comment from "returing" to "returning" in getUserByEmail function.
Server/tests/controllers/authController.test.js - Changed expected status code from 403 to 401 for incorrect password in editUser tests.
- Updated deleteUser test description and behavior to reflect error throwing for user not found.
- Ensured error message corresponds to errorMessages.DB_USER_NOT_FOUND in deleteUser tests.

Possibly related PRs

  • Feat/server auth controller tests #922: This PR introduces tests for the authController, including modifications to error handling and response expectations that align with the changes made in the main PR, particularly regarding the editUser and deleteUser functions.
  • Add endpoint to refresh auth token #981: This PR adds a new function refreshAuthToken to the authController.js, which is related to the overall authentication logic and error handling improvements made in the main PR.

Suggested reviewers

  • marcelluscaio

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
Server/controllers/authController.js (2)

349-368: Mom's spaghetti moment: Let's make this recovery flow bulletproof! 🍝

The removal of redundant user existence check is on point since getUserByEmail already throws if user isn't found. However, we should consider rate limiting these requests to prevent email flooding.

Consider adding rate limiting middleware for the recovery endpoint:

import rateLimit from 'express-rate-limit'

const recoveryLimiter = rateLimit({
  windowMs: 60 * 60 * 1000, // 1 hour
  max: 3 // limit each IP to 3 requests per windowMs
});

// Apply to your route
app.post('/api/recovery', recoveryLimiter, requestRecovery);

Line range hint 282-368: Knees weak, arms heavy: Let's level up our error game! 💪

The error handling is consistent, but we could make it even better by adding error codes to help client-side error handling.

Consider extending the error messages with codes:

// utils/messages.js
 export const errorMessages = {
-  AUTH_INCORRECT_PASSWORD: "Incorrect password",
+  AUTH_INCORRECT_PASSWORD: {
+    code: "AUTH001",
+    message: "Incorrect password"
+  },
   // ... other messages
 }

// In your controller
 const error = new Error(errorMessages.AUTH_INCORRECT_PASSWORD.message);
 error.code = errorMessages.AUTH_INCORRECT_PASSWORD.code;

This would help frontend developers handle specific error cases more reliably.

Server/tests/controllers/authController.test.js (1)

815-817: Test case needs to be more explicit about error handling.

The test case could be improved to better validate the error handling flow:

Consider this enhancement:

-	it("should throw an error if user is not found", async () => {
+	it("should propagate DB_USER_NOT_FOUND error when user doesn't exist", async () => {
 		jwt.decode.returns({ email: "[email protected]" });
-		req.db.getUserByEmail.throws(new Error(errorMessages.DB_USER_NOT_FOUND));
+		const notFoundError = new Error(errorMessages.DB_USER_NOT_FOUND);
+		notFoundError.status = 404;  // Explicitly set status
+		req.db.getUserByEmail.throws(notFoundError);
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 07a918b and 86eaae1.

📒 Files selected for processing (3)
  • Server/controllers/authController.js (2 hunks)
  • Server/db/mongo/modules/userModule.js (1 hunks)
  • Server/tests/controllers/authController.test.js (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • Server/db/mongo/modules/userModule.js
🔇 Additional comments (2)
Server/controllers/authController.js (1)

282-285: Yo dawg, that status code change is straight fire! 🔥

Changing from 403 to 401 for incorrect password is the right move. 401 Unauthorized is the proper status code when authentication fails (like wrong password), while 403 Forbidden is for when you're authenticated but don't have permission.

Server/tests/controllers/authController.test.js (1)

470-470: LGTM! Status code change aligns with HTTP standards.

The change from 403 to 401 for incorrect password is more appropriate as:

  • 401 indicates authentication failure (wrong credentials)
  • 403 would indicate authorization failure (valid credentials but insufficient permissions)

@ajhollid ajhollid merged commit 886d961 into bluewave-labs:develop Oct 25, 2024
1 check passed
@ajhollid ajhollid deleted the fix/be/refactor-auth-controller branch October 25, 2024 01:28
@coderabbitai coderabbitai bot mentioned this pull request Nov 12, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants