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: Name Field validation in Feedback page #2330

Merged
merged 1 commit into from
Oct 17, 2024

Conversation

akash70629
Copy link
Contributor

@akash70629 akash70629 commented Oct 17, 2024

Changes proposed

The "Name" field on the Feedback page only accepts alphabetical letters (a-z, A-Z). Currently, the field does not allow users to input symbols and special characters, which may lead to invalid or spam submissions.

Fixes Issue

Closes #2329

Screenshots

Before
image

After
image

Checklist

  • I agree to follow this project's Code of Conduct
  • I'm a GSSOC'24 contributor
  • I'm a hacktoberfest 2024 contributor

Summary by CodeRabbit

  • New Features
    • Implemented input validation for the name field in the feedback form, allowing only alphabetic characters and spaces.
    • Introduced custom error messages for improved user feedback during input errors.

Copy link

vercel bot commented Oct 17, 2024

@akash70629 is attempting to deploy a commit to the Vivek Prajapati's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Oct 17, 2024

Walkthrough

The changes in the Feedback.jsx file introduce input validation for the name field in the feedback form. A pattern attribute is added to ensure that only alphabetic characters and spaces are permitted. Additionally, two event handlers, onInvalid and onInput, are implemented to manage custom validity messages, enhancing the user experience by providing immediate feedback on input errors.

Changes

File Path Change Summary
src/User/components/FeedbackForm/Feedback.jsx Added input validation for the name field with a pattern attribute; implemented onInvalid and onInput event handlers for custom validity messages.

Assessment against linked issues

Objective Addressed Explanation
Name field should only accept alphabetical letters (a-z, A-Z) (#2329)

🐰 In the feedback form, we now have a rule,
Only letters allowed, that’s the new tool!
Type your name with joy, no symbols in sight,
With clear messages guiding, it feels just right!
Hop along, dear users, your feedback we seek,
A cleaner, safer space, together we speak! 🐇✨


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

🧹 Outside diff range and nitpick comments (2)
src/User/components/FeedbackForm/Feedback.jsx (2)

171-177: Improve name validation and error handling

The changes successfully implement the required validation for the name field, addressing the issue mentioned in #2329. However, there are a few points to consider for improvement:

  1. The error message could be more specific about allowing spaces.
  2. The current pattern doesn't account for names with hyphens or apostrophes, which are common in some names.
  3. The implementation doesn't handle the case where a user pastes invalid content into the field.

Consider the following improvements:

  1. Update the error message to be more specific:
e.target.setCustomValidity('Please enter a valid name using only letters and spaces.');
  1. Modify the pattern to allow for hyphens and apostrophes:
pattern="[a-zA-Z' -]+"
  1. Add an onChange handler to validate pasted content:
onChange={(e) => {
  handleNameChange(e);
  e.target.checkValidity();
}}

These changes will make the validation more robust and user-friendly while still meeting the requirements of the PR.


171-177: Consider applying similar validation to other fields

While the changes successfully implement validation for the name field, it's worth considering if similar validation should be applied to other fields in the form, such as the email field. This would ensure consistency in form validation and improve overall data quality.

Consider implementing custom validation for the email field as well. For example:

<input
  type="email"
  id="email"
  value={email}
  onChange={handleEmailChange}
  placeholder="Enter your email"
  required
  pattern="[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}"
  onInvalid={(e) => {
    e.target.setCustomValidity('Please enter a valid email address.');
  }}
  onInput={(e) => {
    e.target.setCustomValidity('');
  }}
/>

This would provide a more robust validation for the email field, enhancing the overall form validation strategy.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 22699fa and cacd177.

📒 Files selected for processing (1)
  • src/User/components/FeedbackForm/Feedback.jsx (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
src/User/components/FeedbackForm/Feedback.jsx (1)

171-177: Confirmation: PR objectives and linked issue addressed

The implemented changes successfully address the PR objectives and resolve the issue described in #2329. The name field now restricts input to alphabetical characters and spaces, preventing the submission of symbols and special characters.

This implementation effectively enhances the validation of the "Name" field as requested, improving the overall quality of submissions and reducing the potential for spam or invalid entries.

@akash70629 akash70629 changed the title Fix: Name Field validation in Feedback page 🛠️ Fix: Name Field validation in Feedback page Oct 17, 2024
Copy link

vercel bot commented Oct 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
vigybag ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 17, 2024 4:42pm

@codervivek5 codervivek5 merged commit f5f67e6 into codervivek5:main Oct 17, 2024
2 checks passed
Copy link

Congratulations, Your pull request has been successfully merged 🥳🎉 Thank you for your contribution to the project 🚀 Keep Contributing!! ✨

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.

🐞BUG : Name Field validation in Feedback page
2 participants