This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
Store API: Refactored validation handling and introduced woocommerce_store_api_cart_errors hook
#5904
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
|
Size Change: 0 B Total Size: 863 kB ℹ️ View Unchanged
|
xristos3490
force-pushed
the
refactor/cart-order-validation-handling
branch
from
578fcae to
8115fa4
Compare
9 tasks
|
This pretty much supersedes #5874 (it is a bit broader in scope as it is meant to add some extra clarity around ongoing discussions on extensibility, consistency, and code re-use). |
mikejolley
added
focus: rest api
mikejolley
reviewed
Feb 23, 2022
|
I tried to merge with Update: This branch is in line with |
PanosSynetos
force-pushed
the
refactor/cart-order-validation-handling
branch
from
682e19b to
6381251
Compare
xristos3490
force-pushed
the
refactor/cart-order-validation-handling
branch
from
2a4ac9d to
492ca88
Compare
mikejolley
reviewed
Mar 1, 2022
mikejolley
reviewed
Mar 1, 2022
mikejolley
reviewed
Mar 1, 2022
mikejolley
reviewed
Mar 1, 2022
This action can be used by third party developers to add extra 'errors' in cart route responses. This is meant to function as a replacement of the legacy 'woocommerce_check_cart_items' hook.
The new action can be used to modify the finalized draft order object. Additionally, developers can use it to throw a RouteException in order to prevent access to the checkout block. The PR also shuffles some existing code that checks the order instance and sets the draft order ID before the 'woocommerce_blocks_checkout_update_order_meta' gets fired.
…er_meta' docblock on the effect of exceptions thrown from callbacks
mikejolley
force-pushed
the
refactor/cart-order-validation-handling
branch
from
c2095ce to
83bbf2d
Compare
mikejolley
changed the title
__experimental_woocommerce_store_api_cart_errors hook
mikejolley
approved these changes
Mar 2, 2022
mikejolley
changed the title
__experimental_woocommerce_store_api_cart_errors hookwoocommerce_store_api_cart_errors hook
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This refactor is based on how the system handles the
InvalidStockLevelsInCartExceptionand aims to create a more DRY error validation architecture.Currently, when there are multiple _(stock-related)_errors raised from the cart contents, the system will group them in a single
WP_Errorinstance with a "409 Conflict" code. During the REST response, these errors are deconstructed into multiple error keys. One error/key.This PR replaces the
InvalidStockLevelsInCartExceptionwith a more genericInvalidCartExceptionthat should handle every validation-related error from the core, stock, or 3PD.In addition, the
InvalidCartExceptionis designed to handle multiple errors in its ownWP_Error.When a
validate_xxxxmethod throws anInvalidCartExceptioncontaining multiple errors:WP_Errorobjects; the final REST response will be the same.InvalidStockLevelsInCartExceptionis that the system will have the original error codes instead of "409 Conflict".In a nutshell:
InvalidCartExceptionclass to be used in all errors related to the cart validity.validate_xxxxmethods.__experimental_woocommerce_store_api_validate_cartand thewoocommerce_check_cart_itemsare connected. It seems like a good path for deprecating the latter in the API. See Next Steps # 2__experimental_woocommerce_store_api_validate_carthook is called in the cart and checkout context to create consistency.What's changed
RouteExceptionis now handled in both the cart and checkout flows, as previously, were only held in the cart flow.Example 3PD cart validation usage:
The snippet above adds multiple errors, and the result is handled accordingly: https://d.pr/i/vPircs (checkout) and https://d.pr/i/alWAW9 (cart).
A present use-case:
Conditional Shipping and Payments extension is a condition-based restriction system that could potentially produce complex business restrictions. Throwing a
WP_Errorobject containing multiple errors is crucial for correctly handling all situations.Next steps:
contextargument invalidate_cart()and control whether the__experimental_woocommerce_store_api_validate_cartor thewoocommerce_check_cart_itemsshould fire. Perhaps, for performance reasons, we need to only run thewoocommerce_check_cart_itemslegacy hook in the checkout context to avoid handling WC notices to exceptions all the time.contextargument by moving thewoocommerce_check_cart_itemsdirectly inside theCheckout::get_route_post_response; it will be deprecated, so it shouldn't be a clean-code issue.Accessibility
prefers-reduced-motionOther Checks
Testing
Automated Tests
User Facing Testing
None.
Changelog