Add flexibility to Spree::Order#restart_checkout_flow
#4369
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
This new spec fails and shows that with a very simple customization
the method `Spree::Order#restart_checkout_flow` can misbehave when
the order cannot transition forward from the `cart` state by raising
a `StateMachines::InvalidTransition` error.
This happens because of this line from `#restart_checkout_flow`:
next! if !line_items.empty?
This line assumes that the order can always transition from `cart` to
the next state, if it has line items. The `if` guard exists exactly
for that reason: trying to `next!` an order without line items raises
the above mentioned `StateMachines::InvalidTransition` error.
This line was modified with c9eb45d for no other reason than fixing
some specs, according to the commit message.
Like exposed with the previous commit, the bang version of `next` has the drawback that it raises an error when it cannot advance the order state machine, which may happen especially when the order state machine has been customized. In general, restarting the checkout flow for an order should be able to advance the order to the previous state, but this may not be the case if some attributes of the order changed before calling this method and now the order cannot advance anymore. In that situation, the previous code was going to raise an error but that seemed to be a bug, since there doesn't seem to be anything wrong with keeping the order in cart state, if it cannot advance.
jarednorman
approved these changes
May 11, 2022
forkata
approved these changes
May 11, 2022
waiting-for-dev
added a commit
to nebulab/solidus
that referenced
this pull request
Aug 11, 2023
solidusio#4369 introduced a regression where when calling `Spree::Order#restart_checkout_flow` on an empty order, an error would be added to the order. That happened when calling `#next` and the validation failed because no line items were present. We restore the previous behavior where we only try going to the `"address"` state if the order has line items.
3 tasks
waiting-for-dev
added a commit
to nebulab/solidus
that referenced
this pull request
Aug 14, 2023
solidusio#4369 introduced a regression where when calling `Spree::Order#restart_checkout_flow` on an empty order, an error would be added to the order. That happened when calling `#next` and the validation failed because no line items were present. We restore the previous behavior where we only try going to the `"address"` state if the order has line items.
github-actions bot
pushed a commit
that referenced
this pull request
Aug 14, 2023
#4369 introduced a regression where when calling `Spree::Order#restart_checkout_flow` on an empty order, an error would be added to the order. That happened when calling `#next` and the validation failed because no line items were present. We restore the previous behavior where we only try going to the `"address"` state if the order has line items. (cherry picked from commit 82c7bdf)
github-actions bot
pushed a commit
that referenced
this pull request
Aug 14, 2023
#4369 introduced a regression where when calling `Spree::Order#restart_checkout_flow` on an empty order, an error would be added to the order. That happened when calling `#next` and the validation failed because no line items were present. We restore the previous behavior where we only try going to the `"address"` state if the order has line items. (cherry picked from commit 82c7bdf)
github-actions bot
pushed a commit
that referenced
this pull request
Aug 14, 2023
#4369 introduced a regression where when calling `Spree::Order#restart_checkout_flow` on an empty order, an error would be added to the order. That happened when calling `#next` and the validation failed because no line items were present. We restore the previous behavior where we only try going to the `"address"` state if the order has line items. (cherry picked from commit 82c7bdf)
github-actions bot
pushed a commit
that referenced
this pull request
Aug 14, 2023
#4369 introduced a regression where when calling `Spree::Order#restart_checkout_flow` on an empty order, an error would be added to the order. That happened when calling `#next` and the validation failed because no line items were present. We restore the previous behavior where we only try going to the `"address"` state if the order has line items. (cherry picked from commit 82c7bdf)
github-actions bot
pushed a commit
that referenced
this pull request
Aug 14, 2023
#4369 introduced a regression where when calling `Spree::Order#restart_checkout_flow` on an empty order, an error would be added to the order. That happened when calling `#next` and the validation failed because no line items were present. We restore the previous behavior where we only try going to the `"address"` state if the order has line items. (cherry picked from commit 82c7bdf)
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
When the checkout flow is customized, the current version of the method
Spree::Order#restart_checkout_flowmay raiseStateMachines::InvalidTransitionwhich are not really necessary and meaningful. The error is caused by the linethat force-advances the order state from cart to the next state. This doesn't seem to be necessary, and forces stores that experience this situation to override the method definition or find workarounds in order to handle these scenarios. The bang version
next!was introduced with c9eb45d apparently only for fixing specs.Please refer to this PR commit messages for further details.
Checklist: