Explicitly specify email uniqueness validator as case insensitive #889
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes deprecation warning from Rails 6.0.x versions: > DEPRECATION WARNING: Uniqueness validator will no longer enforce case sensitive comparison in Rails 6.1. To continue case sensitive comparison on the :email attribute in User model, pass `case_sensitive: true` option explicitly to the uniqueness validator.
sidonath
reviewed
Feb 3, 2021
| @@ -143,7 +143,7 @@ module Validations | |||
| validates :email, | |||
| email: { strict_mode: true }, | |||
| presence: true, | |||
| uniqueness: { allow_blank: true }, | |||
| uniqueness: { allow_blank: true, case_sensitive: false }, | |||
There was a problem hiding this comment.
@unixmonkey @mjankowski I believe this was supposed to be case_sensitive: true.
This actually changes the logic quite a bit, since it builds the queries on LOWER(email) instead of email. This change broke our app because we didn't have an index on lower(email), so our queries started timing out 😞
This was originally changed in 56f0f04.
Also, the deprecation warning said we should set this to true if want to keep the behavior:
To continue case sensitive comparison
on the :email attribute in User model, passcase_sensitive: true
option explicitly to the uniqueness validator.
This can make a big difference in performance and requires everyone to change their indexes, so it's not really a backwards compatible change. I'd suggest updating to case_sensitive: true and doing a bugfix release.
sidonath
added a commit
to 80pctsols/clearance
that referenced
this pull request
Feb 3, 2021
In thoughtbot#889, `case_sensitive` setting of the `uniqueness` validator was set to `false` to prevent deprecation warnings from Rails. However, the setting should have been set to `true` to preserve backwards-compatibility. The deprecation warning said: > To **continue** case sensitive comparison > on the :email attribute in User model, pass case_sensitive: true > option explicitly to the uniqueness validator. Setting it to `false`, made ActiveRecord generate User queries on `LOWER(email)` instead of on `email`. The apps that didn't have an index on `LOWER(email)` would have faced performance issues. This was mentioned in an old commit that originally made the switch from `false` to the implicit `true`: thoughtbot@56f0f04
MottiniMauro
pushed a commit
that referenced
this pull request
Feb 26, 2021
In #889, `case_sensitive` setting of the `uniqueness` validator was set to `false` to prevent deprecation warnings from Rails. However, the setting should have been set to `true` to preserve backwards-compatibility. The deprecation warning said: > To **continue** case sensitive comparison > on the :email attribute in User model, pass case_sensitive: true > option explicitly to the uniqueness validator. Setting it to `false`, made ActiveRecord generate User queries on `LOWER(email)` instead of on `email`. The apps that didn't have an index on `LOWER(email)` would have faced performance issues. This was mentioned in an old commit that originally made the switch from `false` to the implicit `true`: 56f0f04
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes deprecation warning from Rails 6.0.x versions:
Since the
case_sensitiveoption has been supported on Rails since 1.x, this should be completely safe, while also being explicit enough for Rails 6+ to not throw any deprecation warnings.