Fix: User-friendly error message for empty comments #3146
Conversation
WalkthroughThe pull request focuses on improving the error handling mechanism in the Changes
Assessment against linked issues
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/components/UserPortal/PostCard/PostCard.tsx (1)
228-236: Consider refining the error handling approach for more robust user feedback.While this new logic successfully strips out the technical prefix for comment validation errors, there are a few potential improvements:
- Localize the user-friendly message: If you plan to display the message in different languages, wrap the final string in a translation function (
t()) instead of callingtoast.errorwith a raw string.- Check for partial matches: Confirm that only comment-validation-specific errors get scrubbed. If other error messages contain “text:” or “Comment validation failed:”, they might be inadvertently stripped as well.
- Log the original error message if necessary: If you want to preserve the technical message for debugging, consider logging it or sending it to an external monitoring service rather than discarding it.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (1)
src/components/UserPortal/PostCard/PostCard.tsx(1 hunks)
palisadoes
dismissed
coderabbitai[bot]’s stale review
The base branch was changed.
|
Please submit your PRs against our Also if applicable, make sure your branch name is different from Closing. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #3146 +/- ##
============================================
+ Coverage 29.13% 88.89% +59.76%
============================================
Files 300 321 +21
Lines 7568 8412 +844
Branches 1652 1895 +243
============================================
+ Hits 2205 7478 +5273
+ Misses 5177 692 -4485
- Partials 186 242 +56 ☔ View full report in Codecov by Sentry. |
What kind of change does this PR introduce?
Bugfix
Issue Number:
Fixes #3142
Did you add tests for your changes?
Yes
Snapshots/Videos:
Before fix :
After fix :
If relevant, did you update the documentation?
No
Summary
This PR resolves the issue where submitting an empty comment displayed a technical error message (Comment validation failed: text: Path 'text' is required.). The error message is now replaced with a user-friendly one (Please enter a comment before submitting.), enhancing the user experience. The technical message remains in the logs for developers.
Does this PR introduce a breaking change?
No
Other information
Ensure to test the functionality with the updated backend (talawa-api) to verify the integration works as intended.
Have you read the contributing guide?
Yes
Summary by CodeRabbit