Extract the feedback strings for the non-Free assessments out of the assessments

[FAMarfuaty]

Context

• Previously in this PR Update toolings and dependencies in yoastseo package, we exposed all non-Free code in the yoastseo module which was subsequently exposed and bundled in the Free plugin. As a result, all the translation strings that are part of the non-free code (e.g. Premium assessments) are also bundled in the Free plugin.
• This PR is to make sure that those translation strings that are not meant for for the Free plugin, are not bundled and uploaded to translate.wordpress.org.

Summary

This PR can be summarized in the following changelog entry:

• Removes translation strings that are not meant for the Yoast SEO Free version from the plugin.
• [yoastseo] Removes the product assessment registration from product assessors. These assessments must now be registered via the worker worker.registerAssessment().
• [yoastseo] Outputs the feedback strings of the following assessments as a non-translation string by default: image alt tags, keyphrase distribution, title, product SKU, product identifier, word complexity, lists, and text alignment assessments. The default feedback strings can be overridden through the assessment config callbacks.getResultTexts, for example with text in the form of translation strings.

Relevant technical choices:

• The createAnchorOpeningTag inside the assessment is now called after the default and custom configs are merged. This is to make sure that custom urlTitle and urlCallToAction are always turned into an anchor opening tag.
• The default feedback strings for the following assessments are also slightly changed so that they don't contain variables other than the anchor opening tag of the urlTitle and urlCallToAction:
  • word complexity
  • image alt tags
  • text alignment
• This is because inside the assessment file, we do not use the translation function _n() anymore which can take plural variables. As a result, I decided to change the feedback strings inside the assessment to use generic string that doesn't mention a number.
• In wordpress-seo-premium, wpseo-woocommerce and shopify-seo, the translation strings for the assessments above are provided that contain the number variables.
• More background on the approach taken can be found in this doc.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Checking translation strings

• Build the plugin
• In your IDE, go to js/dist/externals/analysis.js
• Confirm that there are no translation strings inside the following assessments:
  • image alt tags, keyphrase distribution, title, product SKU, product identifier, word complexity, lists, and text alignment assessments.

Test premium assessments

⚠️ The purpose of this test scenario is to make sure that for the following assessments, we still get the same feedback strings for all criteria and the correct URLs that include tracking parameters (e.g. PHP version, WordPress version, etc.)

• Test together with this accompanying PR: https://github.com/Yoast/wordpress-seo-premium/pull/4473

• Install and activate Yoast SEO and Yoast SEO Premium

• Create a post with at least 15 sentences

Keyphrase distribution

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA, including the parameters (it SHOULD include tracking parameters (e.g. PHP version, WordPress version, etc.))
  • Title URL: https://yoa.st/33q (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/33u (link placement is in bold in the feedback strings)

Title

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA, including the parameters (it SHOULD include tracking parameters (e.g. PHP version, WordPress version, etc.))
  • Title URL: https://yoa.st/4nh (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/4ni (link placement is in bold in the feedback strings)

Word complexity

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA, including the parameters (it SHOULD include tracking parameters (e.g. PHP version, WordPress version, etc.))
  • Title URL: https://yoa.st/4ls (link placement is in bold in the feedback strings)
  • Call to action URL:https://yoa.st/4lt (link placement is in bold in the feedback strings)

Text alignment

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA, including the parameters (it SHOULD include tracking parameters (e.g. PHP version, WordPress version, etc.))
  • Title URL: https://yoa.st/assessment-alignment (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/assessment-alignment-cta (link placement is in bold in the feedback strings)

Test product assessments in WooCommerce

• ⚠️ The purpose of this test scenario is to make sure that for the following assessments:

  • we still get the same feedback strings for all criteria and the correct URLs that include tracking parameters (e.g. PHP version, WordPress version, etc.)
  • the edit button for product SKU and product identifier assessments are still working

• Test together with this accompanying PR: https://github.com/Yoast/wpseo-woocommerce/pull/1014. The test instructions specifically for the translation string generation can be found in this PR.

• Install and activate Yoast SEO, Yoast SEO Premium, WooCommerce Yoast SEO

• Set the site language to English

• Create a product

Lists

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA, including the parameters (it SHOULD include tracking parameters (e.g. PHP version, WordPress version, etc.))
  • Title URL: https://yoa.st/4fe (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/4ff (link placement is in bold in the feedback strings)

Image alt tags

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA, including the parameters (it SHOULD include tracking parameters (e.g. PHP version, WordPress version, etc.))
  • Title URL: https://yoa.st/33c (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/33d (link placement is in bold in the feedback strings)

Product SKU

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA, including the parameters (it SHOULD include tracking parameters (e.g. PHP version, WordPress version, etc.))
  • Title URL: https://yoa.st/4lw (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/4lx (link placement is in bold in the feedback strings)
• When the traffic light is not green, confirm that you can see the edit button next to the assessment feedback
• Click on the edit button and confirm that this takes you to the Yoast metabox to fill in the product identifiers

Product identifier

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA, including the parameters (it SHOULD include tracking parameters (e.g. PHP version, WordPress version, etc.))
  • Title URL: https://yoa.st/4ly (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/4lz (link placement is in bold in the feedback strings)
• When the traffic light is not green, confirm that you can see the edit button next to the assessment feedback
• Click on the edit button and confirm that this takes you to the Yoast metabox to fill in the product identifiers

Test product assessments and premium assessments in Shopify

• Test together with this accompanying PR: https://github.com/Yoast/shopify-seo/pull/2017
• Create a product with at least 15 sentences

Keyphrase distribution

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA
  • Title URL: https://yoa.st/shopify30 (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/shopify31 (link placement is in bold in the feedback strings)

Word complexity

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA
  • Title URL: https://yoa.st/shopify77 (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/shopify78 (link placement is in bold in the feedback strings)

Lists

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA
  • Title URL: https://yoa.st/shopify38 (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/shopify39 (link placement is in bold in the feedback strings)

Image alt tags

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA, including the parameters (it SHOULD include tracking parameters (e.g. PHP version, WordPress version, etc.))
  • Title URL: https://yoa.st/shopify40 (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/shopify41(link placement is in bold in the feedback strings)

Product SKU

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA
  • Title URL: https://yoa.st/shopify79 (link placement is in bold in the feedback strings)
  • Call to action https://yoa.st/shopify80 (link placement is in bold in the feedback strings)
• When the traffic light is not green, confirm that you DON'T see the edit button next to the assessment feedback

Barcode

• Use this table as a guide and hit all assessment criteria
• Confirm that you get the same feedback strings for each criterion
• Confirm that you get the correct URL when hovering over the assessment's title and assessment's CTA
  • Title URL: https://yoa.st/shopify81 (link placement is in bold in the feedback strings)
  • Call to action URL: https://yoa.st/shopify82(link placement is in bold in the feedback strings)
• When the traffic light is not green, confirm that you DON'T see the edit button next to the assessment feedback

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:

• No further impact other than what's covered in the testing instruction above.

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 https://github.com/Yoast/lingo-other-tasks/issues/417

[coveralls]

Pull Request Test Coverage Report for Build 27ae60ae4795cce415985f4301e61d59f1f7922a

Details

• 83 of 83 (100.0%) changed or added relevant lines in 9 files are covered.
• No unchanged relevant lines lost coverage.
• Overall first build on experiment/do-not-expose-non-free-code at 57.207%

---

Totals
Change from base Build 827c263bb8e5e6a0d944727a8e20f6de43480d39:	57.2%
Covered Lines:	13274
Relevant Lines:	22827

---

💛 - Coveralls

[mhkuu]

CR & ACC: ✅