Excludes image captions from keyphrase in introduction assessment

[FAMarfuaty]

Context

• At the moment, if a post starts with an image with a caption, the caption will be recognized as the introduction.
• This is because in yoastseo package, we mark the text of a caption node as an implicit paragraph, and we check both implicit and explicit paragraphs in the keyphrase in introduction assessment.
• Based on this discussion on Slack, we agree to exclude the image captions from the assessment analysis. This PR is to implement this decision

Summary

This PR can be summarized in the following changelog entry:

• Excludes image captions from the keyphrase in introduction assessment: image captions at the beginning of a post will not be treated as an introduction anymore.
• [packages/yoastseo] Excludes image captions from the keyphrase in introduction assessment: image captions at the beginning of a post will not be treated as an introduction anymore.

Relevant technical choices:

• The filtering step is done inside the findKeywordInFirstParagraph.js to minimize the impact of potentially filtering captions for other assessments. This way we keep the impact minimally, only to keyphrase in introduction assessment.
• Inside findKeywordInFirstParagraph, we now also return the first paragraph itself. This will be useful when we use this helper in Premium to get the introduction that we send to the AI as prompt content.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

In Free

• Install and activate Yoast SEO
• Set the site language to English
• Create a post in Block editor/Gutenberg editor/Elementor Editor/ Classic editor
• Set a keyphrase
• Add a text with more than 300 words, make sure to add the keyphrase in the first paragraph and don't add the keyphrase anywhere else
• Go to the keyphrase in introduction assessment
• Confirm that the assessment returns with 🟢 green feedback
• Go to the keyphrase density assessment
• Confirm that the keyphrase density assessment recognizes one keyphrase occurrence
• Add an image with a caption that doesn't include the keyphrase
• Confirm that the assessment still returns with 🟢 green feedback
• Go to the keyphrase density assessment
• Confirm that the keyphrase density assessment still recognizes one keyphrase occurrence
• Repeat the step above in all editors

⚠️ Please also do some exploratory testing where for example you create a post that has an image with a caption at the beginning in Classic editor then open it in Block editor, and vice versa. Make sure that the solution still works.

In Premium

• Test together with https://github.com/Yoast/wordpress-seo-premium/pull/4321
• Please go to the PR above for the testing instruction

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:

• This PR should not have additional impact other than what has been already covered by 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/426

[mhkuu]

CR: I've added one test and fixed the other tests in the file, as we now return an additional property from this research, we can use https://jestjs.io/docs/expect#tomatchobjectobject to still compare with the old situation.

[coveralls]

Pull Request Test Coverage Report for Build d6e77a21c59f6eb95c7e05f8e9f21d9e9f41e091

Details

• 9 of 9 (100.0%) changed or added relevant lines in 3 files are covered.
• 3706 unchanged lines in 106 files lost coverage.
• Overall coverage decreased (-4.3%) to 48.357%

---

Files with Coverage Reduction	New Missed Lines	%
admin/class-option-tabs-formatter.php	1	0.0%
src/actions/configuration/first-time-configuration-action.php	1	91.84%
src/builders/indexable-home-page-builder.php	1	98.0%
src/builders/indexable-term-builder.php	1	99.15%
src/context/meta-tags-context.php	1	28.29%
src/generators/breadcrumbs-generator.php	1	64.23%
src/generators/schema/webpage.php	1	90.32%
src/integrations/blocks/structured-data-blocks.php	1	16.0%
src/integrations/settings-integration.php	1	28.49%
src/integrations/watchers/indexable-ancestor-watcher.php	1	98.41%

Totals
Change from base Build 3e0276ffc94471ff55a737ab6a3041cb8050eff9:	-4.3%
Covered Lines:	25038
Relevant Lines:	53628

---

💛 - Coveralls

[mhkuu]

ACC: Works as advertised 🎉

[mhkuu]

I've added a changelog item for Shopify as well. @sannevndrmeulen , due to time constraints, I have not been able to test this PR in Shopify. It could be that we need to add something additional there. Once we up the WordPress version in our Shopify app to a version that includes this PR, we can check that and act accordingly.

[FAMarfuaty]

I removed the Shopify label since there is no option to add captions to the image in Shopify. So the changes in this PR are irrelevant to Shopify