Skip to content

fix the remounting of widgets on dashboard rerender#22164

Merged
igorschoester merged 2 commits intotrunkfrom
501-fix-remounting-of-widgets-on-the-dashboard
Apr 3, 2025
Merged

fix the remounting of widgets on dashboard rerender#22164
igorschoester merged 2 commits intotrunkfrom
501-fix-remounting-of-widgets-on-the-dashboard

Conversation

@vraja-pro
Copy link
Copy Markdown
Contributor

@vraja-pro vraja-pro commented Apr 2, 2025

Context

Summary

This PR can be summarized in the following changelog entry:

  • Fixes the remount of widgets on the dashboard.

Relevant technical choices:

  • Remove the widgetInstance type since it wasn't used any more. The reason for the widget instance in the first place was to support adding the same widget more than once. Currently it is not needed.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Make sure to configured site kit but do not connect yet.
  • Go to Yoast SEO -> General, check the dashboard has the scores widgets and the site kit setup widget.
  • Open the network tab and dismiss until next visit the site kit setup widget.
  • Check the request for the scores widget was not triggered. ( You can also see the animation is not triggered)
  • Connect to site kit, the site kit widgets should appear bellow and requests would appear int he network tab.
  • Click on the "Got it" to dismiss the site kit setup widget and check the network:
  • The site kit widgets should not trigger another request ( you can also see that by the widgets not rendering the loading state when dismissing the site kit set up widget.

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 Fix remounting of widgets on the dashboard.

@vraja-pro vraja-pro added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Apr 2, 2025
Base automatically changed from 495-dashboard-setup-the-package-in-the-free-monorepo to trunk April 2, 2025 12:23
@coveralls
Copy link
Copy Markdown

Pull Request Test Coverage Report for Build ca5d98d0ce37a2783f2f9bce018117a7ebbef189

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 54.434%

Totals Coverage Status
Change from base Build a35f8fb0dd8b83fa66de1891d6fee24cced29278: 0.0%
Covered Lines: 29563
Relevant Lines: 54783

💛 - Coveralls


/**
* @type {import("../index").WidgetType} WidgetType
* @type {import("../index").WidgetType} The widget type.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oops, that is indeed the comment and not the name as I thought 😅

Copy link
Copy Markdown
Contributor

@igorschoester igorschoester left a comment

Choose a reason for hiding this comment

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

CR && AT ✅

@igorschoester igorschoester added this to the 25.0 milestone Apr 3, 2025
@igorschoester igorschoester merged commit bcea5d9 into trunk Apr 3, 2025
20 checks passed
@igorschoester igorschoester deleted the 501-fix-remounting-of-widgets-on-the-dashboard branch April 3, 2025 08:56
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