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

Converts the list assessment to use the HTML parser #21726

Merged
merged 6 commits into from
Oct 29, 2024

Conversation

mhkuu
Copy link
Contributor

@mhkuu mhkuu commented Oct 21, 2024

Context

  • We want to rely less on regular expressions for our assessments. Therefore, we convert the list assessment to use the HTML Parser.

Summary

This PR can be summarized in the following changelog entry:

  • Converts the list assessment to use the HTML parser.
  • [yoastseo] Converts the list assessment to use the HTML parser.
  • [shopify-seo] Converts the list assessment to use the HTML parser.

Relevant technical choices:

  • None.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

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:

  • The list assessment.

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/172

@mhkuu mhkuu added innovation Innovative issue. Relating to performance, memory or data-flow. changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog Shopify This PR impacts Shopify. labels Oct 21, 2024
@coveralls
Copy link

coveralls commented Oct 21, 2024

Pull Request Test Coverage Report for Build 63d0eb491ae49929262380332403fe2dde48f7e0

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

  • 3 of 3 (100.0%) changed or added relevant lines in 1 file are covered.
  • 81 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.008%) to 54.591%

Files with Coverage Reduction New Missed Lines %
packages/js/src/general/app.js 11 0.0%
packages/js/src/first-time-configuration/first-time-configuration-steps.js 70 0.0%
Totals Coverage Status
Change from base Build e77fc968b8abc0e6e1080657a553383ebffc5eb4: 0.008%
Covered Lines: 29664
Relevant Lines: 54619

💛 - Coveralls

@mhkuu mhkuu marked this pull request as ready for review October 23, 2024 11:00
@FAMarfuaty
Copy link
Contributor

In Shopify, I tested this PR together with this one https://github.com/Yoast/shopify-seo/pull/2017, since it's not merged yet. Otherwise Lists assessment is not available on product pages.

@FAMarfuaty
Copy link
Contributor

FAMarfuaty commented Oct 29, 2024

CR and acceptance test: Everything works well, I tested both on Woo products and Shopify products. I pushed some additional commits to make sure that the assessment only counts non-empty lists. Further discussion on this approach can be seen in this Slack thread.

@FAMarfuaty FAMarfuaty added this to the 23.9 milestone Oct 29, 2024
@FAMarfuaty FAMarfuaty merged commit 5ade049 into trunk Oct 29, 2024
15 checks passed
@FAMarfuaty FAMarfuaty deleted the html-parser/list-assessment branch October 29, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog innovation Innovative issue. Relating to performance, memory or data-flow. Shopify This PR impacts Shopify.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants