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

Makes sure the slug is synced correctly when the post is in draft. #21182

Merged
merged 3 commits into from Mar 5, 2024

Conversation

thijsoo
Copy link
Contributor

@thijsoo thijsoo commented Feb 28, 2024

Context

  • When you save a post with Elementor for the first time we override the slug to the elementor-* name. We don't want this to happen and we want to follow the correct slug.

Summary

This PR can be summarized in the following changelog entry:

  • Fixes a bug where an unneeded redirect would be created when a post was first published in Elementor.

Relevant technical choices:

  • I added a custom slug creator to make sure we are inline with what the WordPress backend also does when you publish a post.
  • I also added a check to only sync this field when to post is still in draft. This is because when you have published a post the slug change needs to be conscious and unrelated to the post title changing.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Enable Elementor / Premium / Free.
  • Create a new post in Elementor and change the title to Test post
  • Publish the post and make sure the slug is test-post. Also make sure there are no new redirects in the redirect manager.
  • Edit the post and change the title to something else. Update the post and make sure the slug is still the same.

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:

  • Make sure this also works with different permalink structures.

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 #

…not override the default slug based on the post title.
@thijsoo thijsoo added the changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog label Feb 28, 2024
@thijsoo thijsoo force-pushed the 21172-elementor-unneeded-redirect-is-created branch from 4ac868c to ae853df Compare February 28, 2024 13:37
@thijsoo thijsoo linked an issue Feb 28, 2024 that may be closed by this pull request
11 tasks
@coveralls
Copy link

coveralls commented Feb 28, 2024

Pull Request Test Coverage Report for Build 236a704db13f5d88faf6d3f3a9dfa8157bf45dbb

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 2 (0.0%) changed or added relevant lines in 1 file are covered.
  • 138 unchanged lines in 11 files lost coverage.
  • Overall coverage increased (+0.08%) to 53.236%

Changes Missing Coverage Covered Lines Changed/Added Lines %
packages/js/src/watchers/elementorWatcher.js 0 2 0.0%
Files with Coverage Reduction New Missed Lines %
packages/js/src/first-time-configuration/tailwind-components/steps/indexation/configuration-indexation.js 3 0.0%
packages/js/src/first-time-configuration/tailwind-components/steps/indexation/indexation-step.js 3 0.0%
packages/js/src/first-time-configuration/tailwind-components/steps/finish/finish-step.js 4 0.0%
packages/js/src/first-time-configuration/tailwind-components/steps/social-profiles/social-field-array.js 5 0.0%
packages/js/src/first-time-configuration/tailwind-components/base/image-select.js 7 0.0%
packages/js/src/first-time-configuration/tailwind-components/configuration-stepper-buttons.js 9 0.0%
packages/js/src/first-time-configuration/tailwind-components/stepper.js 10 0.0%
packages/js/src/first-time-configuration/tailwind-components/base/alert.js 12 0.0%
packages/js/src/term-edit.js 12 0.0%
packages/js/src/analysis/TermDataCollector.js 28 41.11%
Totals Coverage Status
Change from base Build d617035e737c3d5cb371ac38b1cc86352567f31a: 0.08%
Covered Lines: 29098
Relevant Lines: 54997

💛 - Coveralls

Copy link
Member

@igorschoester igorschoester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CR && AC ✅

Nice find!

However, as discussed, it might be worth it to use cleanForSlug from the @wordpress/url package, to keep up-to-date automatically.

https://github.com/WordPress/gutenberg/tree/trunk/packages/url#cleanforslug

Copy link
Member

@igorschoester igorschoester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ✅

@igorschoester igorschoester added this to the 22.4 milestone Mar 5, 2024
@igorschoester igorschoester merged commit 98afcf5 into trunk Mar 5, 2024
17 checks passed
@igorschoester igorschoester deleted the 21172-elementor-unneeded-redirect-is-created branch March 5, 2024 14:09
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.

Elementor: Unneeded redirect is created
3 participants