Skip to content

fix: email check validation to handle case in-sensitive email#6168

Merged
sriramveeraghanta merged 1 commit intopreviewfrom
fix-email-check-validation
Dec 7, 2024
Merged

fix: email check validation to handle case in-sensitive email#6168
sriramveeraghanta merged 1 commit intopreviewfrom
fix-email-check-validation

Conversation

@gurusainath
Copy link
Member

@gurusainath gurusainath commented Dec 7, 2024

Description

Added email check validation for lowering the email in the email-check endpoint.

Summary by CodeRabbit

  • New Features

    • Enhanced email handling by ensuring email addresses are converted to lowercase and stripped of whitespace before validation, improving consistency and reducing validation errors.
  • Bug Fixes

    • No specific bug fixes were addressed, but the changes may indirectly reduce potential validation errors related to email formatting.

@gurusainath gurusainath added the 🐛bug Something isn't working label Dec 7, 2024
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 7, 2024

Walkthrough

The changes involve modifications to the post methods of two classes: EmailCheckEndpoint and EmailCheckSpaceEndpoint. In both cases, a new line has been added to convert the email address to lowercase and strip whitespace before the validation process. This adjustment ensures consistent email formatting prior to validation without altering the existing control flow or error handling mechanisms.

Changes

File Path Change Summary
apiserver/plane/authentication/views/app/check.py Added line to post method in EmailCheckEndpoint to convert email to lowercase and strip whitespace.
apiserver/plane/authentication/views/space/check.py Added line to post method in EmailCheckSpaceEndpoint to convert email to lowercase and strip whitespace.

Poem

In the land of code where emails play,
A rabbit found a cleaner way.
With lowercase and spaces gone,
Validation now can carry on!
Hopping through checks, swift and bright,
Our emails shine, all done just right! 🐇✨


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 (3)
apiserver/plane/authentication/views/space/check.py (2)

63-63: LGTM! Consider adding a comment for clarity.

The email normalization is correctly placed and handles both case-insensitivity and whitespace. Consider adding a brief comment explaining the normalization step.

+        # Normalize email: convert to lowercase and remove whitespace
         email = str(email).lower().strip()

63-63: Consider extracting email normalization to a utility function.

Since this email normalization logic is duplicated in both endpoints, consider extracting it to a shared utility function to maintain DRY principles and ensure consistent email handling across the application.

# In plane/authentication/utils.py
def normalize_email(email):
    """
    Normalize email address by converting to lowercase and removing whitespace.
    
    Args:
        email: The email address to normalize
    Returns:
        str: Normalized email address
    """
    return str(email).lower().strip()

Then use it in both endpoints:

-        email = str(email).lower().strip()
+        email = normalize_email(email)
apiserver/plane/authentication/views/app/check.py (1)

63-65: LGTM! Minor style suggestion.

The email normalization logic is correct and the added comment improves clarity. However, the extra blank line at line 65 seems unnecessary.

         # Lower the email
         email = str(email).lower().strip()
-
         # Validate email
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 666ddf7 and dfc2c62.

📒 Files selected for processing (2)
  • apiserver/plane/authentication/views/app/check.py (1 hunks)
  • apiserver/plane/authentication/views/space/check.py (1 hunks)

@sriramveeraghanta sriramveeraghanta merged commit 9ee41ec into preview Dec 7, 2024
@sriramveeraghanta sriramveeraghanta deleted the fix-email-check-validation branch December 7, 2024 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🐛bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants