This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
Rename the checkout events #8381
Merged
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
alexflorisca
added
type: refactor
|
The release ZIP for this PR is accessible via: Script Dependencies ReportThere is no changed script dependency between this branch and trunk. This comment was automatically generated by the TypeScript Errors Report
🎉 🎉 This PR does not introduce new TS errors. |
|
Blocked by #8110 |
mikejolley
added
the
status: blocked
This reverts commit 38d66ed.
mikejolley
force-pushed
the
update/rename-checkout-events
branch
from
078da3a to
ebd0fa2
Compare
|
Size Change: +1.82 kB (0%) Total Size: 1.1 MB
ℹ️ View Unchanged
|
mikejolley
removed
the
status: blocked
|
I've rebased this and fixed the tests. Going to ask another reviewer to take a look. |
opr
approved these changes
Feb 15, 2023
| return function ( | ||
| ...args: Parameters< typeof onCheckoutValidationBeforeProcessing > | ||
| ) { | ||
| return function ( ...args: Parameters< typeof onCheckoutValidation > ) { | ||
| deprecated( 'onCheckoutBeforeProcessing', { | ||
| alternative: 'onCheckoutValidationBeforeProcessing', |
There was a problem hiding this comment.
Should this be updated since we're now deprecating onCheckoutValidationBeforeProcessing too
| return function ( ...args: Parameters< typeof onCheckoutValidation > ) { | ||
| deprecated( 'onCheckoutValidationBeforeProcessing', { | ||
| alternative: 'onCheckoutValidation', | ||
| plugin: 'WooCommerce Blocks', |
There was a problem hiding this comment.
Should we add links and version numbers to these deprecation messages?
mikejolley
added
the
needs: dev note
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 PR follows on from #8110 , where we refactored the payment status (mostly) and the checkout status. We drew diagrams and flows and went deep about how the checkout flow should look in terms of events and statuses. There was a lot that was confusing and one of those things were the checkout events.
So I've made the following changes here:
onCheckoutValidationBeforeProcessing. toonCheckoutValidationonCheckoutAfterProcessingWithSuccesstoonCheckoutSuccessonCheckoutAfterProcessingWithErrortoonCheckoutFailonPaymentProcessingtooPaymentSetupHopefully this is clearer to everyone going forward.
Here is what the happy path will look like after this PR and #8110
Testing
User Facing Testing
WooCommerce Visibility
Performance Impact
Dev Note
Some of the checkout event emitters have been renamed to better reflect their purpose. Deprecation is in place, so if you’re using the old emitter names your code will continue to work, but you may see a notice in the browser error console. The changes include are as follows.
onCheckoutValidationBeforeProcessing has been renamed to onCheckoutValidation . There is only one validation event during checkout so this makes it clearer where validation listeners should fire.
onCheckoutAfterProcessingWithSuccess has been renamed simply to onCheckoutSuccess since the processing part is not relevant and has no real meaning in this context. The same for onCheckoutAfterProcessingWithError which has dropped the prefix to become onCheckoutFail .
Finally, onPaymentProcessing has been renamed to onPaymentSetup . This is because it was unclear that no actual processing would take place during this event. The event emitter is only there to prepare the payment gateway to take payment when the checkout processes. onPaymentSetup reflects this more clearly.
Changelog