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

Deprecate the Wordproof feature #21424

Merged
merged 3 commits into from
Jun 11, 2024
Merged

Deprecate the Wordproof feature #21424

merged 3 commits into from
Jun 11, 2024

Conversation

enricobattocchi
Copy link
Member

@enricobattocchi enricobattocchi commented Jun 4, 2024

Context

Summary

This PR can be summarized in the following changelog entry:

  • Deprecates the Wordproof feature.
  • Deprecates the following classes: Wordproof, Wordproof_App_Config, Wordproof_Helper, Wordproof_Integration_Active_Conditional, Wordproof_Plugin_Inactive_Conditional, Wordproof_Translations.

Relevant technical choices:

  • These options will remain stored in the database:
_transient_wordproof_authorize_current_url
wordproof_settings
wordproof_balance
wordproof_access_token
wordproof_source_id
  • all the pages edited while having the Wordproof feature on will have a _yoast_wpseo_wordproof_timestamp meta.
  • we plan to remove the above in a later release, so people can still downgrade if they need.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Install the current release version of Yoast SEO (you probably need to do this in a publicly accessible site, like TasteWP)
  • enable the Wordproof integration in Yoast SEO > Integrations
  • edit the Privacy page (you should already have a draft one) and add the Wordproof timestamp, then publish
  • edit and save some other pages, without adding Wordproof (you should not be able)
  • a plus:
    • install WooSEO and Woocommerce
    • set a page as Terms and Conditions one in the WooCommerce settings
    • edit that page and timestamp it too
  • switch to this PR
  • visit the integrations page and see the WordProof card is not there anymore
  • visit the pages with the timestamp and see they don't show it anymore
  • edit them and see that you can't see the Wordproof section anymore
    • check that you don't get any PHP or JS error
  • add a new page and save it
  • check the wp_postmeta table and see the new page does not have a _yoast_wpseo_wordproof_timestamp meta
  • search for wordproof in the options and see you don't find it anymore in the wpseo row

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 #

@enricobattocchi enricobattocchi added the changelog: other Needs to be included in the 'Other' category in the changelog label Jun 4, 2024
@enricobattocchi enricobattocchi self-assigned this Jun 4, 2024
Copy link

composer.lock

Dev Package changes

Package Operation From To About
wordproof/wordpress-sdk remove 1.3.5 - -

Settings · Docs · Powered by Private Packagist

@coveralls
Copy link

coveralls commented Jun 4, 2024

Pull Request Test Coverage Report for Build 5cc2ae1d6dcb51dfc78271ef3375aff69e0c5b37

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 2 files are covered.
  • 687 unchanged lines in 11 files lost coverage.
  • Overall coverage increased (+0.2%) to 52.856%

Changes Missing Coverage Covered Lines Changed/Added Lines %
packages/js/src/containers/AdvancedSettings.js 0 1 0.0%
packages/js/src/integrations-page/other-integrations.js 0 1 0.0%
Files with Coverage Reduction New Missed Lines %
packages/js/src/containers/AdvancedSettings.js 1 0.0%
src/integrations/admin/integrations-page.php 1 0.0%
src/integrations/watchers/indexable-home-page-watcher.php 1 97.67%
src/integrations/watchers/indexable-term-watcher.php 1 97.37%
packages/js/src/components/AdvancedSettings.js 2 0.0%
src/helpers/indexable-helper.php 2 84.72%
src/integrations/watchers/indexable-post-watcher.php 6 93.75%
src/integrations/watchers/indexable-author-watcher.php 7 75.0%
src/repositories/indexable-hierarchy-repository.php 12 76.92%
src/builders/indexable-link-builder.php 13 92.2%
Totals Coverage Status
Change from base Build 5026f0cf53b9a2c8123f59b0c15079469bdcda6c: 0.2%
Covered Lines: 28341
Relevant Lines: 54218

💛 - Coveralls

@enricobattocchi enricobattocchi marked this pull request as ready for review June 10, 2024 21:07
@enricobattocchi enricobattocchi removed their assignment Jun 10, 2024
@thijsoo thijsoo self-assigned this Jun 11, 2024
Copy link
Contributor

@thijsoo thijsoo left a comment

Choose a reason for hiding this comment

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

CR + ACC 👍

@thijsoo thijsoo added this to the 23.0 milestone Jun 11, 2024
@thijsoo thijsoo merged commit a8818d4 into trunk Jun 11, 2024
35 checks passed
@thijsoo thijsoo deleted the deprecate-wordproof branch June 11, 2024 10:58
@hardikgohil7988
Copy link

@tatasha2004 @oksanayoast
I've tested this PR by verifying the current vs beta version with:

  • WordProof Integration card
  • WordProof Integration with WP Page
  • WordProof Integration with Woo Page
  • WordProof meta in Database

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: other Needs to be included in the 'Other' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants