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.

Sign up for GitHub

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

Jump to bottom

Move generic site data into self contained objects. #21368

Open
wants to merge 7 commits into
base: trunk
Choose a base branch
from
Open

Move generic site data into self contained objects. #21368

wants to merge 7 commits into from

Conversation

thijsoo
Copy link
Contributor

@thijsoo thijsoo commented May 6, 2024 •
edited

Context

  • We want to refactor our script data and put all site information in one place.

Summary

This PR can be summarized in the following changelog entry:

  • Refactors site information script data.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Without this PR open a post and category. Add the following to your console and mark down the result:
wpseoScriptData.dismissedAlerts
wpseoScriptData.currentPromotions
wpseoScriptData.webinarIntroBlockEditorUrl
wpseoScriptData.blackFridayBlockEditorUrl
wpseoScriptData.linkParams
wpseoScriptData.pluginUrl
wpseoScriptData.wistiaEmbedPermission

wpseoScriptData.metabox.site_name
wpseoScriptData.metabox.contentLocale
wpseoScriptData.metabox.userLocale
wpseoScriptData.metabox.isRtl
wpseoScriptData.metabox.isPremium
wpseoScriptData.metabox.siteIconUrl
wpseoScriptData.metabox.search_url
wpseoScriptData.metabox.post_edit_url
wpseoScriptData.metabox.base_url

Only

 wpseoScriptData.metabox.search_url
wpseoScriptData.metabox.post_edit_url
wpseoScriptData.metabox.base_url

Should be different between posts and terms.

  • With the PR do this again and make sure the results are the same.

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 #

@thijsoo thijsoo added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label May 6, 2024
@thijsoo thijsoo linked an issue May 6, 2024 that may be closed by this pull request
Refactor website specific scriptdata to its own object #21351
Open
@thijsoo thijsoo marked this pull request as ready for review May 7, 2024 10:16
@coveralls
Copy link

Pull Request Test Coverage Report for Build 4dd641601cbdd7bf5701bd449c4dfe26ccbbaec5

Details

  • 77 of 127 (60.63%) changed or added relevant lines in 6 files are covered.
  • 1022 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.6%) to 53.254%
Changes Missing Coverage Covered Lines Changed/Added Lines %
src/editors/framework/site/term-site-information.php 34 35 97.14%
src/editors/framework/site/post-site-information.php 31 33 93.94%
src/editors/application/site/website-information-repository.php 0 7 0.0%
admin/metabox/class-metabox.php 0 10 0.0%
src/editors/framework/site/base-site-information.php 9 39 23.08%
Files with Coverage Reduction New Missed Lines %
admin/formatter/class-post-metabox-formatter.php 4 57.14%
src/generated/container.php 1018 0.0%
Totals Coverage Status
Change from base Build 640f7b16b262419a0e6486e2ab44f5e94131d787: 0.6%
Covered Lines: 28826
Relevant Lines: 54586
💛 - Coveralls

leonidasmi
leonidasmi reviewed May 28, 2024
View reviewed changes
Copy link
Contributor

@leonidasmi leonidasmi left a comment

Choose a reason for hiding this comment

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

CR: ❌

Also, the metabox is broken:
image

src/editors/domain/site/site-information-interface.php Outdated Show resolved Hide resolved
admin/metabox/class-metabox.php Outdated Show resolved Hide resolved
admin/metabox/class-metabox.php Outdated Show resolved Hide resolved
admin/taxonomy/class-taxonomy.php Outdated
*/
$repo = YoastSEO()->classes->get( Website_Information_Repository::class );
$repo->get_term_site_information()->set_term( get_term_by( 'id', $tag_id, $this::get_taxonomy() ) );
$script_data = array_merge_recursive( $repo->get_term_site_information()->get_site_information(), $script_data );
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's assign the $repo->get_term_site_information() result to a variable, so as to not call it twice here and in the line above.

src/editors/application/site/website-information-repository.php Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are we creating a repository that just returns instances of a couple of classes? We could just instantiate them in the metabox classes, without the use of a repository.

Unless I'm missing something...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added this because I wanted to follow the same as I did for all the other script data code, and I wanted the entry point for this to be in the application folder and not in the framework folder to more adhere to the Onion way.

src/editors/framework/site/base-site-information.php Outdated
Comment on lines 98 to 101
'dismissedAlerts' => $dismissed_alerts,
'currentPromotions' => $this->promotion_manager->get_current_promotions(),
'webinarIntroBlockEditorUrl' => $this->short_link_helper->get( 'https://yoa.st/webinar-intro-block-editor' ),
'blackFridayBlockEditorUrl' => ( $this->promotion_manager->is( 'black-friday-2023-checklist' ) ) ? $this->short_link_helper->get( 'https://yoa.st/black-friday-checklist' ) : '',
Copy link
Contributor

Choose a reason for hiding this comment

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

All these are post-specific and shouldn't be calculated on taxonomy loads.

admin/metabox/class-metabox.php Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leonidasmi leonidasmi leonidasmi left review comments

Assignees
No one assigned
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Refactor website specific scriptdata to its own object
3 participants
@thijsoo @coveralls @leonidasmi