Skip to content

Dashboard: add tests for the Search Ranking Compare widget#22149

Merged
vraja-pro merged 3 commits intotrunkfrom
485-add-tests-for-the-searchrankingcompare-widget
Mar 27, 2025
Merged

Dashboard: add tests for the Search Ranking Compare widget#22149
vraja-pro merged 3 commits intotrunkfrom
485-add-tests-for-the-searchrankingcompare-widget

Conversation

@igorschoester
Copy link
Copy Markdown
Contributor

@igorschoester igorschoester commented Mar 27, 2025

Context

Summary

This PR can be summarized in the following changelog entry:

  • Adds tests for the Search Ranking Compare widget.

Relevant technical choices:

  • I did not test each individual component. Just the widget itself, more like an integration test
  • I changed the Trend component to output the sign in the same string, as otherwise I had to account for the indent in the code
  • I removed the data truthy check in the content as there is no valid way for that to not be there. If the server responds and there is no error, we have no reason for the data to be suddenly falsy
  • Not sure if that describe.each is totally necessary like that, as we repeat other tests. But the setup is the same for those, and I don't mind it also testing the tooltips if there are no averages.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Check the code
  • Run the test with coverage: yarn workspace @yoast/wordpress-seo test packages/js/tests/dashboard/widgets/search-ranking-compare-widget.test.js --coverage
  • Verify it has full coverage, including branches (check the report in the terminal output or open the HTML report inside the packages/js/coverage path)

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:

  • Tests, so it is covered by tooling.

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 https://github.com/Yoast/reserved-tasks/issues/485

@igorschoester igorschoester added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Mar 27, 2025
@coveralls
Copy link
Copy Markdown

Pull Request Test Coverage Report for Build 1c6597c26898fab5e9a4abfb239e510b1a2ce1d5

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.04%) to 54.85%

Totals Coverage Status
Change from base Build d72e49e7af6c5ca95f5205a826e3a3324359a066: 0.04%
Covered Lines: 29981
Relevant Lines: 55214

💛 - Coveralls

@vraja-pro
Copy link
Copy Markdown
Contributor

CR & AC ✅
Nice coverage!

@vraja-pro vraja-pro added this to the 24.9 milestone Mar 27, 2025
@vraja-pro vraja-pro merged commit a360dcc into trunk Mar 27, 2025
24 checks passed
@vraja-pro vraja-pro deleted the 485-add-tests-for-the-searchrankingcompare-widget branch March 27, 2025 11:35
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants