RfC: Work around inconsistent button click in promotion order spec #5782
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
b3802d3
to
75382c5
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5782 +/- ##
=======================================
Coverage 88.71% 88.71%
=======================================
Files 712 712
Lines 16893 16895 +2
=======================================
+ Hits 14987 14989 +2
Misses 1906 1906 ☔ View full report in Codecov by Sentry. |
75382c5
to
60fe006
Compare
e87aa77
to
97121d5
Compare
adammathys
approved these changes
Jun 11, 2024
97121d5
to
b9493da
Compare
It's cumbersome to find elements by CSS selectors to click them, and the new admin has a few instances where we have no standalone label.
Apparently, `find_button(...).click` will not consistently wait for the Javascript imported via importmaps to be loaded before execution. This adds a Controller that adds a data attribute to the body element of the page once it connects. This way we know the Stimulus controllers have loaded before testing their behavior in feature specs. See https://gist.github.com/adrienpoly/862846f5882796fdeb4fc85b260b3c5a for a similar solution. I am not a big fan of adding production code just to get specs stable, but this is the only solution I found that reliably works.
I'm getting a code coverage issue because the `ensure_js_is_ready` helper is only used in the `solidus_leagcy_promotions`. Adding a spec here for filtering by payment state.
b9493da
to
46888aa
Compare
mamhoff
added a commit
to mamhoff/solidus
that referenced
this pull request
Jun 12, 2024
We need to wait for the JS to be loaded and connected here, otherwise the click doesn't do anything. There is an alternative fix for this in solidusio#5782
mamhoff
added a commit
to mamhoff/solidus
that referenced
this pull request
Jun 12, 2024
This will keep clicking the Filter button until the promotions menu appears. The problem this fixes is that a few milliseconds after navigation, the JS controller that switches the filter bar out might not have loaded. Alternative fixes here: solidusio#5782 solidusio#5783
|
I'm keeping this open to see how folks feel about it. We can't keep adding |
|
Thanks for taking the time here @mamhoff, I've also tried multiple times to fix this spec, without success. If we can't find an "elegant" solution, may I suggest to use the flaky tag on the test? It will retry it a couple of times, making it transparent for us. Not great, but it won't slow us down at least. |
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.
Apparently,
find_button(...).clickwill not consistently wait for theStimulus JS to be loaded. This adds a small controller that simply
changes an attribute on the body, and expects that to be present before
running any feature specs.
See https://gist.github.com/adrienpoly/862846f5882796fdeb4fc85b260b3c5a
for inspiration.
I don't love to introduce code into the production build to get the tests stable, but I haven't found another good option that worked.