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

check if the caught error is an instance of HttpError #4190

Merged
merged 1 commit into from
Jan 11, 2025

Conversation

Baalmart
Copy link
Contributor

@Baalmart Baalmart commented Jan 11, 2025

Description

Error Handling in Pre-Save Hook:
In the pre-save hook, we were correctly checking for validation errors and creating an instance of HttpError with a specific message related to the field that failed validation. However, when this error is thrown, it is being caught in the static modify function.

Error Propagation:
In the modify function, when an error is caught, we were creating a new HttpError instance with a generic message ("Internal Server Error") and using error.message from the caught error. This results in the original validation error message being lost or replaced by a more generic one.

Final API Response:
The final response shows "Internal Server Error" because that is the message set in the catch block of the modify function, instead of propagating the original validation error.

Changes Made

  • Properly manage error propagation from the User model, check if the caught error is an instance of HttpError

Testing

  • Tested locally
  • Tested against staging environment
  • Relevant tests passed: [List test names]

Affected Services

  • Which services were modified:
    • Auth Service

Endpoints Ready for Testing

  • New endpoints ready for testing:
    • Update User

API Documentation Updated?

  • Yes, API documentation was updated
  • No, API documentation does not need updating

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling for user-related operations to provide more precise error messages and better error propagation.

Copy link
Contributor

coderabbitai bot commented Jan 11, 2025

📝 Walkthrough

Walkthrough

The pull request focuses on refining error handling within the User.js model in the authentication service. The modifications target the listStatistics, list, modify, and remove static methods, implementing a more robust error management strategy. The changes ensure that HTTP-specific errors are propagated directly, while other unexpected errors are transformed into a standardized internal server error format.

Changes

File Change Summary
src/auth-service/models/User.js Enhanced error handling in static methods to differentiate between HttpError and other error types

Possibly related issues

Possibly related PRs

Poem

In the realm of code, where errors dance and sway,
HttpErrors now find their rightful way
Catching exceptions with grace and might
Transforming chaos into structured light 🚀
A model of resilience, clean and bright!

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

codecov bot commented Jan 11, 2025

Codecov Report

Attention: Patch coverage is 0% with 11 lines in your changes missing coverage. Please review.

Project coverage is 12.09%. Comparing base (c04a0e2) to head (0a8612d).

Files with missing lines Patch % Lines
src/auth-service/models/User.js 0.00% 11 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           staging    #4190      +/-   ##
===========================================
- Coverage    12.09%   12.09%   -0.01%     
===========================================
  Files          137      137              
  Lines        17534    17542       +8     
  Branches       329      333       +4     
===========================================
  Hits          2121     2121              
- Misses       15413    15421       +8     
Files with missing lines Coverage Δ
src/auth-service/models/User.js 9.70% <0.00%> (-0.26%) ⬇️

Copy link
Contributor

@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

🧹 Nitpick comments (2)
src/auth-service/models/User.js (2)

1048-1050: Consider optimizing error logging.

While the error handling is correct, consider moving the error logging after the HttpError check to avoid logging expected errors.

-      logger.error(`🐛🐛 Internal Server Error -- ${error.message}`);
       if (error instanceof HttpError) {
         return next(error);
       }
+      logger.error(`🐛🐛 Internal Server Error -- ${error.message}`);

1090-1093: Consider optimizing error logging.

Similar to the modify method, consider moving the error logging after the HttpError check.

-      logger.error(`🐛🐛 Internal Server Error -- ${error.message}`);
       if (error instanceof HttpError) {
         return next(error);
       }
+      logger.error(`🐛🐛 Internal Server Error -- ${error.message}`);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c04a0e2 and 0a8612d.

📒 Files selected for processing (1)
  • src/auth-service/models/User.js (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build-push-deploy-auth-service
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (2)
src/auth-service/models/User.js (2)

789-792: LGTM! Proper error handling implementation.

The error handling logic correctly preserves HttpError instances while wrapping other errors appropriately.


1003-1006: LGTM! Consistent error handling pattern.

The error handling implementation maintains consistency with the listStatistics method.

Copy link
Contributor

Auth-service changes in this PR available for preview here

@Baalmart Baalmart merged commit 160977e into staging Jan 11, 2025
50 of 52 checks passed
@Baalmart Baalmart deleted the hf-user-profiles branch January 11, 2025 09:29
@Baalmart Baalmart mentioned this pull request Jan 11, 2025
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant