This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
Fix compatibility between the checkout block and the template editor. #9495
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
…epending on admin vs frontend
mikejolley
added
status: needs review
block: checkout
woocommercebot
requested review from
a team and
tarhi-saad
and removed request for
a team
|
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. |
|
Size Change: 0 B Total Size: 1.08 MB ℹ️ View Unchanged
|
gigitux
approved these changes
May 17, 2023
There was a problem hiding this comment.
Nice work! Thank you for working on this and for the explanation!
I found that (with the help of @senadir) this was due to wcBlocksConfig being missing when viewing the template editor. Eventually I found that we were rendering 2 wcSettings objects in the template editor, and one of them was missing wcBlocksConfig.
When you can, could you explain how you debug this?
I think that we can close this issue #9354
github-actions
bot
added
status: ready to merge
and removed
status: needs review
labels
Nothing special tbh; trial, error, and viewing source is where I noticed the two wcSettings objects defined. |
|
It should be noted that we went into an iframe vs main context rabbit hole, for future debuggers, that's unrelated. All JS in the template editor is run on the mainframe, only the final HTML is rendered in the iframe (via portals). |
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 fixes a conflict between block assets and the template editor. It reverts the change in #9332 and instead enqueues assets in the correct place.
To replicate the original issue:
This was a total pain to debug but to summarise, the fix in #9332 broke payment methods when editing the checkout block in the template editor. Payment method scripts were dequeued because the
wc-settingshook dependency was not registered soon enough.verify_payment_methods_dependenciesremoves payment method scripts if a dependency is missing to avoid breaking the main checkout block.Therefore I have reverted the #9332 change.
Reverting #9332 reintroduced the issue it fixed; broken image urls. I found that (with the help of @senadir) this was due to
wcBlocksConfigbeing missing when viewing the template editor. Eventually I found that we were rendering 2wcSettingsobjects in the template editor, and one of them was missingwcBlocksConfig.If you look at the changes in https://github.com/WordPress/gutenberg/pull/49655/files, you can see that the template editor calls
wp_print_footer_scripts. This was the problem. We enqueue asset data on 2 hooks:wp_print_footer_scriptsfor the frontend.admin_print_footer_scriptsfor the admin.So in this context we should only be using
admin_print_footer_scriptsto avoid the duplication. Adding a simpleis_admincheck resolves the issue.Reverts #9332
Fixes #9331
Testing
Confirm that the payment methods and shipping methods are rendered correctly, and image previews (cart items) are shown for the following test cases:
Template Editor
Page Editor
Without Gutenberg
WooCommerce Visibility
Changelog