Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix settings routing bug with WooCommerce Shop base with category #21827

Merged
merged 1 commit into from
Nov 18, 2024

Conversation

enricobattocchi
Copy link
Member

@enricobattocchi enricobattocchi commented Nov 15, 2024

Context

Summary

This PR can be summarized in the following changelog entry:

  • Fixes a bug where the settings for a post type are inaccessible when the permalink structure includes special characters that require encoding, e.g., when WooCommerce products are set to use the "Shop base with category" permalink structure.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Install and activate WooCommerce
  • Go to Admin > Yoast SEO > Settings > Content types > Products
  • See the settings page loads
  • Go to Admin > Settings > Permalinks
  • Select 'Shop base with category'
  • Click 'Save Changes'
  • Go to Admin > Yoast SEO > Settings > Content types > Products
  • See the settings page loads
  • Go to Admin > Settings > Permalinks
  • for the Product permalinks, select "Custom base" and insert /shop/and~special_chars@$&+=α/
  • Click 'Save Changes'
  • Go to Admin > Yoast SEO > Settings > Content types > Products
  • See the settings page loads
  • think and test other ways to break it

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #21823

@enricobattocchi enricobattocchi added the changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog label Nov 15, 2024
@enricobattocchi enricobattocchi force-pushed the fix/settings-routing-bug branch from f1652c0 to 3d22f02 Compare November 15, 2024 14:32
@coveralls
Copy link

Pull Request Test Coverage Report for Build 4fc47b651f7977219ec90480c111d0190129ec20

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-2.7%) to 54.688%

Totals Coverage Status
Change from base Build e64062e063c5647c49686aa9ee507e1271850151: -2.7%
Covered Lines: 29751
Relevant Lines: 54691

💛 - Coveralls

@vraja-pro vraja-pro self-assigned this Nov 15, 2024
@vraja-pro
Copy link
Contributor

CR & AC ✅

@vraja-pro vraja-pro merged commit 3b484c3 into trunk Nov 18, 2024
22 of 23 checks passed
@vraja-pro vraja-pro deleted the fix/settings-routing-bug branch November 18, 2024 09:53
@mhkuu mhkuu added this to the 24.0 milestone Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to access settings for WooCommerce products when using variable in permalink structure (Regression)
4 participants