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: allow single quotes in default email validator #2717

Merged
merged 1 commit into from
Mar 5, 2024

Conversation

limonte
Copy link
Member

@limonte limonte commented Mar 3, 2024

fixes #2715

Summary by CodeRabbit

  • Tests
    • Added tests for email and URL validation using various formats.
  • Bug Fixes
    • Updated email validation to support apostrophes in the local part of the email address.

Copy link
Contributor

coderabbitai bot commented Mar 3, 2024

Walkthrough

The recent changes focus on enhancing input validation for email addresses by allowing apostrophes in the local part, aligning with official specifications. Additionally, the update includes tests for validating email and URL inputs against various formats, ensuring that the validation logic accurately identifies valid and invalid inputs according to defined standards.

Changes

Files Change Summary
cypress/e2e/inputs.cy.js Added tests for email and URL validation with various formats.
src/.../defaultInputValidators.js Updated the email validation function to allow apostrophes in the local part of an email address.

Assessment against linked issues

Objective Addressed Explanation
Input Types - Email (#2715): Allow apostrophes in the local part of an email address.
Input Types - Email (#2715): Ensure the validator aligns with RFC 5322 and Wikipedia email address syntax guidelines.
Input Types - Email (#2715): Fix the issue where valid emails like "jim.o'brien@domain.com" are marked as invalid.

Poem

In the code where bugs once nestled deep,
A rabbit hopped, no hill too steep.
With a leap and bound, it fixed the snare,
Apostrophes in emails, now fair.

🐰 Across the fields of code, it sprang,
Ensuring validations sang.
A tale of emails, now told right,
Under the moon's soft, gleaming light.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e95900c and e30bf34.
Files selected for processing (2)
  • cypress/e2e/inputs.cy.js (1 hunks)
  • src/utils/defaultInputValidators.js (1 hunks)
Additional comments: 3
src/utils/defaultInputValidators.js (1)
  • 8-8: The updated regex for the email validator correctly includes an apostrophe (') in the local part of the email address, aligning with RFC 5322 standards. This change ensures that email addresses like "o'test@example.com" are now considered valid. Good job on updating the regex to be more inclusive of valid email address characters.
cypress/e2e/inputs.cy.js (2)
  • 588-607: The addition of tests for the default email validator, including cases with apostrophes in the email address, is a great way to ensure the recent changes to the email validation logic are correctly implemented. These tests cover both valid and invalid email formats, which is essential for maintaining the reliability of the email validator. It's good practice to include such comprehensive tests whenever validation logic is updated.
  • 608-625: The new tests for the default URL validator, covering various valid and invalid URL formats, are well-implemented. These tests ensure that the URL validation logic is robust and can accurately distinguish between valid and invalid URLs. Including tests for different URL schemes and special cases like "localhost" domains is a good practice for ensuring comprehensive validation coverage.

@limonte limonte merged commit e4b7a3a into main Mar 5, 2024
2 checks passed
@limonte limonte deleted the fix/email-address-default-validator-quote branch March 5, 2024 14:22
github-actions bot pushed a commit that referenced this pull request Mar 5, 2024
## [11.10.6](v11.10.5...v11.10.6) (2024-03-05)

### Bug Fixes

* allow single quotes in default email validator ([#2717](#2717)) ([e4b7a3a](e4b7a3a))
@limonte
Copy link
Member Author

limonte commented Mar 5, 2024

🎉 This PR is included in version 11.10.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Input Types - Email
1 participant