Ensure promotion codes don't trigger ActiveRecord::RecordNotUnique errors on save #4228
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
Promotion codes are always stored in the database in lowercase. Up to
this commit, the transformation of the in-memory value of a code was
performed in a `before_save` callback.
This implementation led to a weird behavior that can easily be
reproduced with a fresh Solidus install:
- create a first promotion, with a single promotion code (e.g. "test")
- attempt to create another promotion, with the exact same value for the
single promotion code
=> triggers a flash error messages which states "Codes is invalid"
- attempt to re-save the same form, this time with a single promotion
code with the value "TEST"
=> the page crashes due to an `ActiveRecord::RecordNotUnique` error
The expected error handling would be that any input that would end up
matching an existing code (after having been stripped of spaces &
downcased) should trigger the same flash error rather than crash the
page.
This behavior can be achieved by normalizing values earlier in a
`before_validation` callback: that way, the validation callback will
query the database using a stripped/downcased value and, should a match
be found, set an error on the model instance as expected.
jcsanti
changed the title
waiting-for-dev
approved these changes
Dec 27, 2021
kennyadsl
approved these changes
Dec 27, 2021
This was referenced Dec 27, 2021
Merged
waiting-for-dev
added a commit
that referenced
this pull request
Jan 5, 2022
Backport #4228 to V2.11
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.
Description
Promotion codes are always stored in the database in lowercase. Up to this PR, the transformation of the in-memory value of a code was performed in a
before_savecallback.This implementation led to a weird behavior that can easily be reproduced with a fresh Solidus install:
Screen.Recording.2021-12-24.at.13.02.24.mov
The expected error handling would be that any input that would end up matching an existing code (after having been stripped of spaces & downcased) should trigger the same flash error rather than crash the page.
This behavior can be achieved by normalizing values earlier in a
before_validationcallback: that way, the validation callback will query the database using a stripped/downcased value and, should a match be found, set an error on the model instance as expected.Checklist:
[ ] I have updated Guides and README accordingly to this change (if needed)