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

Adds alert center redux store #21649

Merged
merged 12 commits into from
Sep 25, 2024
Merged

Conversation

vraja-pro
Copy link
Contributor

@vraja-pro vraja-pro commented Sep 20, 2024

Context

Summary

This PR can be summarized in the following changelog entry:

  • Adds alert center to dashboard redux store.

Relevant technical choices:

  • I added a method to get the message from the notification object for the paragraphs.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Go to Yoast SEO -> General page and check you notifications and problems. ( You can trigger notification by adding new content types and resetting the indexables in the yoast test helper, you can trigger problems by disabling Search engine visibility in the Settings->Reading)
  • Add the following line in wp-config.php or snippets plugin:
define( 'YOAST_SEO_NEW_DASHBOARD_UI', true );
  • Go to Yoast SEO -> General page
  • Check you see the same problems and notifications.
  • Check the number in the title of the problems and notifications matched the number of active alerts.
  • Hide notifications and check the number has changed in the title, the notification has moved to the hidden Collapsible and the hidden Collapsible has the right number of hidden notifications.
  • Hide more than one notification and check the translation has changed to plural (e.g. hidden notifications, hidden problems) in the Collapsible.
  • Restore notifications and problems from the hidden Collapsible and check the Collapsible disappears.
  • Hide only one notification/problem and check the label is singular (e.g hidden problem, hidden notification.
  • Hide all notification and check a text appears under the title: "No new notifications."
  • Refresh and check changes were saved.

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 Add Notifications to Alert center

@vraja-pro vraja-pro added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Sep 20, 2024
@coveralls
Copy link

coveralls commented Sep 20, 2024

Pull Request Test Coverage Report for Build d2aa0ec4ff7ec63ba5b6c5cb96cc410a3fa28b67

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

  • 1 of 52 (1.92%) changed or added relevant lines in 7 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+5.2%) to 54.475%

Changes Missing Coverage Covered Lines Changed/Added Lines %
admin/class-yoast-notification.php 0 2 0.0%
packages/js/src/dashboard/components/notifications.js 0 2 0.0%
packages/js/src/dashboard/components/problems.js 0 4 0.0%
src/helpers/notification-helper.php 0 6 0.0%
packages/js/src/dashboard/components/alerts-list.js 0 9 0.0%
packages/js/src/dashboard/store/alert-center.js 0 28 0.0%
Files with Coverage Reduction New Missed Lines %
packages/js/src/dashboard/components/notifications.js 1 0.0%
Totals Coverage Status
Change from base Build 9df74654c5e7c4056b63d95a59e204a300afd402: 5.2%
Covered Lines: 29533
Relevant Lines: 54476

💛 - Coveralls

@vraja-pro vraja-pro force-pushed the 272-add-notifications-to-alert-center branch from 09358f2 to c9090da Compare September 20, 2024 12:28
Copy link
Member

@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 🏗️

packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved
packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved
packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved
packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved
packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved
packages/js/src/dashboard/store/index.js Outdated Show resolved Hide resolved
packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved
admin/class-yoast-notification.php Show resolved Hide resolved
const slice = createSlice( {
name: "alertCenter",
initialState: createInitialAlertCenterState(),
extraReducers: ( builder ) => {
Copy link
Member

Choose a reason for hiding this comment

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

No toggle status or error support?

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 think its something to ask UX what we want to do for error or request status?

@vraja-pro vraja-pro force-pushed the 272-add-notifications-to-alert-center branch from 03782f4 to 677ac37 Compare September 24, 2024 07:20
Copy link
Member

@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 ❓
Really liking the refactor to not pre-group 😄
I commented some more. Besides maybe the tests these are just that, comments. Feel free to leave them or address the tests in a follow-up?

packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved

export const alertCenterControls = {
[ TOGGLE_ALERT_VISIBILITY ]: async( { payload } ) => {
const formData = new URLSearchParams();
Copy link
Member

Choose a reason for hiding this comment

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

If we ever run into encoding issues, we could try to switch this to FormData

packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved
packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved
packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved
packages/js/src/dashboard/store/alert-center.js Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

You could write tests for these?

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 tests for the new components
I added tests for the store but it was difficult to test the happy path with the toggleAlert with regular js object for a state.

vraja-pro and others added 3 commits September 24, 2024 10:56
Co-authored-by: Igor <35524806+igorschoester@users.noreply.github.com>
@vraja-pro vraja-pro force-pushed the 272-add-notifications-to-alert-center branch from daab8a5 to a749b19 Compare September 24, 2024 11:07
use global ajaxurl

use ajaxurl from store
@vraja-pro vraja-pro force-pushed the 272-add-notifications-to-alert-center branch from a749b19 to 0698366 Compare September 24, 2024 11:18
Copy link
Member

@pls78 pls78 left a comment

Choose a reason for hiding this comment

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

CR && Acc: ✅

@pls78 pls78 added this to the 23.6 milestone Sep 25, 2024
@pls78 pls78 merged commit e43b852 into trunk Sep 25, 2024
31 of 33 checks passed
@pls78 pls78 deleted the 272-add-notifications-to-alert-center branch September 25, 2024 12:30
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.

4 participants