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

Save user emails lowercase (DEV-1164) #795

Merged
merged 1 commit into from
Dec 19, 2024

Conversation

mikefeldberg
Copy link
Contributor

@mikefeldberg mikefeldberg commented Dec 19, 2024

DEV-1164

Summary by Sourcery

Bug Fixes:

  • Fix issue where user emails were not saved in lowercase.

@mikefeldberg mikefeldberg self-assigned this Dec 19, 2024
Copy link

sourcery-ai bot commented Dec 19, 2024

Reviewer's Guide by Sourcery

This PR implements DEV-1164 by ensuring that user emails are saved in lowercase. It modifies the save method of the User model to convert the email to lowercase before saving. It also adds a test to verify the change.

Sequence diagram for email lowercase conversion during user save

sequenceDiagram
    participant Client
    participant User
    participant Database

    Client->>User: save(email='Test@Example.com')
    activate User
    Note over User: Convert email to lowercase
    User->>User: email = email.lower()
    User->>Database: save user with email='test@example.com'
    Database-->>User: confirmation
    User-->>Client: saved user
    deactivate User
Loading

Class diagram showing User model changes

classDiagram
    class User {
        +email: str
        +save(*args, **kwargs)
    }
    note for User "Modified save() method to convert email to lowercase"
Loading

File-Level Changes

Change Details Files
Convert user emails to lowercase before saving
  • Added a save method to the User model to convert the email to lowercase before saving it.
apps/betterangels-backend/accounts/models.py
Add a test to verify email lowercasing
  • Added a test case to check that the email is converted to lowercase when a user is created.
apps/betterangels-backend/accounts/tests/test_models.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @mikefeldberg - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@mikefeldberg mikefeldberg requested a review from tglaz December 19, 2024 20:14
@mikefeldberg mikefeldberg enabled auto-merge (squash) December 19, 2024 20:16
@mikefeldberg mikefeldberg merged commit 1368218 into main Dec 19, 2024
8 checks passed
@mikefeldberg mikefeldberg deleted the DEV-1164/lowercase-user-emails branch December 19, 2024 20:19

def test_save(self) -> None:
user = User.objects.create(username="lowercaseme", email="LOWERCASEME@EXAMPLE.COM")
self.assertEqual(user.email, "lowercaseme@example.com")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does the login code also downcase the input? @mikefeldberg

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

Successfully merging this pull request may close these issues.

3 participants