Ensure the Site Kit setup notification is not shown when the Welcome modal is present.
Feature Description
Ensure the Site Kit setup notification is not shown when the Welcome modal is present.
See the Site Kit setup success notification section in the Design Doc.
Do not alter or remove anything below. The following sections will be managed by moderators only.
Acceptance criteria
- The existing “Congrats on completing the setup for Site Kit!” setup success notification is not shown when the user lands on the dashboard from the initial setup flow and sees the Welcome modal.
- If the user disconnects and reconnects Site Kit, having already seen and dismissed the Welcome modal, the existing setup success notification is shown.
- These changes are gated behind the
setupFlowRefreshfeature flag.
Implementation Brief
See the implementation guide in the Design Doc for guidelines on how to implement this issue.
- [ ] Update
assets/js/components/key-metrics-setup/KeyMetricsSetupApp.js- [ ] Update the
submitChangescallback so that thenotificationquery param is always set, regardless of!isInitialSetupFlow.
- [ ] Update the
- [ ] Update the
ModuleSetupSuccessNotificationnotification'scheckRequirementsfunction inassets/js/googlesitekit/notifications/register-defaults.js- [ ] Check if the modal has been dismissed using
isItemDismissedwith the tour version slug ("welcome-modal-with-tour") - [ ] If
setupFlowRefreshis enabled AND the welcome modal has NOT been dismissed, returnfalse
- [ ] Check if the modal has been dismissed using
- [ ] Update
assets/js/components/WelcomeModal.tsx- [ ] In the
dismissModalcallback, unset the "notification" and "slug" query params so that refreshing after dismissal does not cause the success notification to appear
- [ ] In the
Test Coverage
- Update the
KeyMetricsSetupApptests since setting the query param is no longer conditional tosetupFlowRefresh
QA Brief
Changelog entry
Hey @abdelmalekkkkk, thanks for drafting this IB.
One small detail - we don't want to set the slug query param in KeyMetricsSetupApp when isInitialSetupFlow is true, only the notification param. This is because we want to show the site setup success notification when reconnecting, not the Analytics module success notification.
Thanks @techanvil. I updated the IB accordingly.
Thanks @abdelmalekkkkk, that's great. LGTM!
IB ✅