Fix flaky specs: Emails Budgets Selected/Unselected investment #2695
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
javierv
commented
Jul 3, 2018
| @@ -152,13 +152,13 @@ def investments_orders | |||
| end | |||
|
|
|||
| def email_selected | |||
| investments.selected.each do |investment| | |||
| investments.selected.order(:id).each do |investment| | |||
There was a problem hiding this comment.
The commit message says:
Ordering by id is certainly not very elegant; however, ordering by
another field likecreated_atis dangerous because the record could be
created at (almost) the exact same time.
However, created_at stores the time up to microseconds, so the chance of two records being created at the exact same time is zero.
These tests were failing randomly because there is no guarantee the methods `Budget#email_selected` and `Budget#email_unselected` will always send the emails in the same order, because `investments.selected` and `investments.unselected` don't necessarily return the records in the order they were created. Ordering by id is certainly not very elegant; however, ordering by another field like `created_at` is dangerous because the record could be created at (almost) the exact same time. Related to issue consuldemocracy#2446 and issue consuldemocracy#2519.
javierv
force-pushed
the
2446_and_2519-fix_flaky_emails_spec
branch
from
e1412da
to
37eaf29
Compare
javierv
changed the title
|
Great! 👌 |
This was referenced Aug 10, 2018
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.
References
Objectives
Fix the flaky specs in
spec/features/emails_spec.rb:431("Emails Budgets Selected investment") andspec/features/emails_spec.rb:454("Emails Budgets Unselected investment").Explain why the test is flaky, or under which conditions/scenario it fails randomly
The code in both specs is similar, so here's one of them (unnecessary lines omitted):
The test assumes the last email sent will be the one addressed to the author of the last investment created. However, this isn't always the case. The code in
budget.email_selectedis:And this code doesn't always return the selected investments in the order they were created, since postgresql by default doesn't guarantee in which order the records will be returned.
Explain why your PR fixes it
By ordering the selected investments by ID, we ensure the last email is sent to the author of the last created investment, as the specs assume.
Notes
open_last_emaildoesn't always return the email for the last created investment.