This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
Fix Product Query block hijacking all Query blocks queries #6952
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
The Product Query block was adding a filter to Gutenberg's core Query Loop block. When this filter was added once, it would from then on apply to all other Query Loop blocks (or variations thereof) on a page. This change makes sure that: 1. No filters are added in the first place if our custom `__woocommerceVariationProps` are not set. 2. The filter only gets run once.
sunyatasattva
added
type: bug
3 tasks
|
The release ZIP for this PR is accessible via: |
|
Size Change: 0 B Total Size: 868 kB ℹ️ View Unchanged
|
gigitux
approved these changes
Aug 23, 2022
…ub.com:woocommerce/woocommerce-gutenberg-products-block into fix/6950-product-query-hijacks-all-query-loops
Aljullu
added
the
skip-changelog
Aljullu
approved these changes
Aug 24, 2022
There was a problem hiding this comment.
Tested on my end too, and confirming it fixes the issue. 👌
I agree with Luigi that we can go ahead with this solution for now. We can always improve it in the future if we have any other ideas.
One thing we could try is to store $parsed_block into a class property, this way we don't need to pass it to the filter function every time. Something along these lines:
public function update_query( $pre_render, $parsed_block ) {
if ( 'core/query' !== $parsed_block['blockName'] || ! isset( $parsed_block['attrs']['__woocommerceVariationProps'] ) ) {
return;
}
$this->parsed_block = $parsed_block;
add_filter(
'gutenberg_build_query_vars_from_query_block',
array( $this, 'get_query_vars' ),
10,
1
);
}
public function get_query_vars( $query ) {
remove_filter(
'gutenberg_build_query_vars_from_query_block',
array( $this, 'get_query_vars' )
);
return $this->get_query_by_attributes( $query, $this->parsed_block );
}It has the benefit that we can remove the filter, with the expense that we need to add a property to the class. So leaving the final decision to you.
…ub.com:woocommerce/woocommerce-gutenberg-products-block into fix/6950-product-query-hijacks-all-query-loops
|
Thank you @Aljullu!! I've tested your implementation and it's great. You solved my conundrum! This is a much cleaner solution and I don't have the reservations I had before for this fix now! This made me a happy dev :D |
sunyatasattva
deleted the
fix/6950-product-query-hijacks-all-query-loops
branch
4 tasks
senadir
pushed a commit
to senadir/woocommerce-blocks
that referenced
this pull request
Nov 12, 2022
…ce#6952) * Fix Product Query block hijacking all Query blocks queries The Product Query block was adding a filter to Gutenberg's core Query Loop block. When this filter was added once, it would from then on apply to all other Query Loop blocks (or variations thereof) on a page. This change makes sure that: 1. No filters are added in the first place if our custom `__woocommerceVariationProps` are not set. 2. The filter only gets run once.
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.
The Product Query block was adding a filter to Gutenberg's core Query Loop block. When this filter was added once, it would from then on apply to all other Query Loop blocks (or variations thereof) on a page.
This change makes sure that:
__woocommerceVariationPropsare not set.
Fixes #6950
Testing
Automated Tests
User Facing Testing
WooCommerce Visibility
Performance Impact
Filters are still created, hooked and ran. They are not removed even when they have ran their course. Tradeoff explained above.
Changelog