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

Remove UA counterparts after SK no longer shows UA data beginning September 25 #6786

Closed
nfmohit opened this issue Mar 28, 2023 · 9 comments
Closed
Labels
Exp: SP Module: Analytics Google Analytics module related issues P0 High priority Type: Enhancement Improvement of an existing feature

Comments

@nfmohit
Copy link
Collaborator

nfmohit commented Mar 28, 2023

Feature Description

Around 90 days after the UA cut-off, Site Kit will no longer show any UA data anymore naturally. At this point, it will not be relevant to keep elements related to UA in Site Kit. Hence, they should be removed.

Here is the relevant part in the design doc.


Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

Implementation Brief

  • In assets/js/components/notifications/BannerNotifications.js:
    • Remove the usage of the <SwitchGA4DashboardViewNotification /> component.
  • In assets/js/modules/analytics/datastore/base.js:
    • Remove usages of the shouldPromptGA4DashboardView function.
  • In assets/js/modules/analytics/datastore/settings.js:
    • Remove the shouldPromptGA4DashboardView function.
  • Remove the Dashboard view setting display and toggle added to the Analytics module settings.
    • To do so, revert all the changes made in PR Add dashboardView toggle in Analytics settings. #6723 to files in the assets/js/modules/analytics/components/settings folder.
    • In assets/sass/components/settings/_googlesitekit-settings-module.scss:
      • Remove styles for the .googlesitekit-settings-module__meta-item--dashboard-view class.
  • Remove the New badges added to indicate new GA4 metrics.
    • To do so, revert changes made in PR Add New Metric Badges to GA4 specific metrics  #6776 for the following files:
      • assets/js/modules/analytics/components/module/ModulePopularPagesWidgetGA4.js
      • assets/js/modules/search-console/components/dashboard/SearchFunnelWidgetGA4/Overview/index.js
  • Remove all usages of the EnableUniversalAnalytics component in the following files:
    • assets/js/modules/analytics/components/setup/SetupFormGA4.js
    • assets/js/modules/analytics/components/settings/SettingsForm.js
  • The Analytics module SettingsView should be restructured following this Figma screen.
    • In assets/js/modules/analytics/components/settings/SettingsView.js:
      • Add a new setting meta item at the first position before all other settings, labelled Account, which should display the account ID. This can be copied over from assets/js/modules/analytics/components/settings/GA4SettingsView.js.
      • Remove the usage of the <UASettingsView /> component.
    • In assets/js/modules/analytics/components/settings/GA4SettingsView.js:
      • Remove the Account setting meta item.
  • Remove the following files:
    • assets/js/components/notifications/SwitchGA4DashboardViewNotification.js
    • assets/js/components/notifications/SwitchGA4DashboardViewNotification.stories.js
    • assets/js/modules/analytics/components/common/EnableUniversalAnalytics.js

Test Coverage

QA Brief

  • Go through the Site Kit set up flows both with Analytics and without. For the version without, set up Analytics after testing without.
  • View and edit Analytics settings. Ensure no errors occur.
  • Set up Dashboard sharing for Analytics. Ensure a second user can view the shared dashboard.

In all of these scenarios, no UA/GA4 Dashboard View switcher should appear and UA components should not appear in the dashboard view, settings view, or settings edit.

It would also be preferable to upgrade an existing site that had UA Analytics enabled and the UA dashboard enabled. It should show the GA4 dashboard after upgrading to the latest version of Site Kit in develop.

Changelog entry

  • Remove option to connect Universal Analytics and update dashboard to show GA4 only.
@nfmohit nfmohit added P1 Medium priority Type: Enhancement Improvement of an existing feature Module: Analytics Google Analytics module related issues labels Mar 28, 2023
@nfmohit nfmohit assigned nfmohit and aaemnnosttv and unassigned nfmohit and aaemnnosttv Mar 28, 2023
@aaemnnosttv
Copy link
Collaborator

Thanks @nfmohit – this looks like a good start. Of course there is a lot more to do about UA than is encompassed here, but I think it makes sense to have this issue dedicated to the GA4-reporting-specific transitional related bits. We'll probably need several more issues to migrate Analytics back to a single module going forward.

  • This should only be included in the Site Kit update/release that goes on/right after September 1, 2023.

While correct, since everything here is about removing code that is no longer used, the timing can be flexible and should probably be worded to be more like "after" a certain date, but also to check with @marrrmarrr and/or myself first before merging. As such it is not particularly time-sensitive, but more that we want to ensure it is not merged before we're ready. That is, doing this later would be fine, but not early :)

I assume we'd also want to remove the corresponding setting itself as well?

We probably want to keep the component itself (since it's no longer metric-specific) – we'll probably be using it somewhere else anyways, but we should make it clear that this is only about the use of the badges for GA4 metrics, not the component itself 👍

Similar to above, any related persistent settings/values should also be removed, not just the component.

@nfmohit
Copy link
Collaborator Author

nfmohit commented Mar 29, 2023

Thanks @nfmohit – this looks like a good start. Of course there is a lot more to do about UA than is encompassed here, but I think it makes sense to have this issue dedicated to the GA4-reporting-specific transitional related bits. We'll probably need several more issues to migrate Analytics back to a single module going forward.

Understood and agreed, thank you!

  • This should only be included in the Site Kit update/release that goes on/right after September 1, 2023.

While correct, since everything here is about removing code that is no longer used, the timing can be flexible and should probably be worded to be more like "after" a certain date, but also to check with @marrrmarrr and/or myself first before merging. As such it is not particularly time-sensitive, but more that we want to ensure it is not merged before we're ready. That is, doing this later would be fine, but not early :)

Updated, thanks!

I assume we'd also want to remove the corresponding setting itself as well?

Correct, updated, thank you!

We probably want to keep the component itself (since it's no longer metric-specific) – we'll probably be using it somewhere else anyways, but we should make it clear that this is only about the use of the badges for GA4 metrics, not the component itself 👍

Agreed. Updated to clarify, thanks!

Similar to above, any related persistent settings/values should also be removed, not just the component.

I re-checked and discussed it internally. There aren't any other settings/values to remove at this point, thank you!

Thank you, @aaemnnosttv!

@nfmohit nfmohit assigned aaemnnosttv and unassigned nfmohit Mar 29, 2023
@aaemnnosttv aaemnnosttv changed the title [~September 1] Remove UA counterparts after SK no longer shows UA data Remove UA counterparts after SK no longer shows UA data Mar 31, 2023
@aaemnnosttv
Copy link
Collaborator

Made a few tweaks to the wording but this should be good to go now 👍 On to IB 🚀

@aaemnnosttv aaemnnosttv removed their assignment Mar 31, 2023
@nfmohit nfmohit self-assigned this Mar 31, 2023
@nfmohit nfmohit removed their assignment Mar 31, 2023
@tofumatt tofumatt self-assigned this Apr 2, 2023
@tofumatt
Copy link
Collaborator

tofumatt commented Apr 7, 2023

I think this IB covers it—if anything else is found in Execution that's fine, IBs like this are good baseline guidelines but it can be tough to spot everything in advance.

IB ✅

@tofumatt tofumatt removed their assignment Apr 7, 2023
@hussain-t hussain-t self-assigned this Apr 17, 2023
@mxbclang mxbclang changed the title Remove UA counterparts after SK no longer shows UA data [~Oct 1] Remove UA counterparts after SK no longer shows UA data Apr 25, 2023
@mxbclang mxbclang added P2 Low priority and removed P1 Medium priority labels Apr 25, 2023
@nfmohit
Copy link
Collaborator Author

nfmohit commented Aug 3, 2023

I have just added a new AC to this issue:

The Dashboard View Indicator added in Add visual indicator for GA4 vs. UA dashboard #6938 should be removed from both Main and Entity dashboards.

  • This AC was added later on 3 August 2023 as the Dashboard View Indicator wasn't available when this issue was specced. It was added mid-flight during the epic execution.

Apologies for adding it at this stage. I only added it since it needs to be removed alongside other elements mentioned in this issue and is a relatively small change. Thanks!

CC: @hussain-t @aaemnnosttv @tofumatt @bethanylang

@mxbclang
Copy link

mxbclang commented Aug 3, 2023

Noting that per discussion with @marrrmarrr in Slack, this issue will be scheduled for Sprint 110 so that it will be included in v.1.110.0, releasing September 25.

@mxbclang mxbclang changed the title [~Oct 1] Remove UA counterparts after SK no longer shows UA data Remove UA counterparts after SK no longer shows UA data beginning September 25 Aug 9, 2023
@tofumatt tofumatt self-assigned this Sep 11, 2023
@tofumatt tofumatt removed their assignment Sep 14, 2023
@techanvil techanvil assigned techanvil and tofumatt and unassigned techanvil Sep 18, 2023
@tofumatt tofumatt assigned techanvil and unassigned tofumatt Sep 18, 2023
@techanvil techanvil assigned tofumatt and unassigned techanvil Sep 18, 2023
@tofumatt tofumatt assigned techanvil and unassigned tofumatt Sep 18, 2023
@techanvil techanvil assigned tofumatt and unassigned techanvil Sep 19, 2023
@tofumatt tofumatt assigned techanvil and unassigned tofumatt Sep 19, 2023
@techanvil techanvil assigned tofumatt and unassigned techanvil Sep 20, 2023
@tofumatt tofumatt assigned techanvil and unassigned tofumatt Sep 20, 2023
@techanvil
Copy link
Collaborator

This is ready to merge once it's been given the go-ahead by @marrrmarrr as per the AC.

@techanvil
Copy link
Collaborator

Mariya has given the signal, this is getting merged! 🎉

@techanvil techanvil removed their assignment Sep 21, 2023
@wpdarren wpdarren self-assigned this Sep 21, 2023
@wpdarren
Copy link
Collaborator

wpdarren commented Sep 21, 2023

QA Update: ✅

Verified:

Tested with a new Analytics account that just has a GA4 property

  • Set up a new site with and without SC and Analytics.

    • No errors on front end or in the console when setting up
    • No errors in the console on the main dashboard.
    • Changed date period for reporting, 7, 14, 28 and 90 days to ensure no errors occur on the main dashboard.
    • Made sure the widgets were GA4 components.
    • No errors in the console on the entity dashboard.
    • Changed date period for reporting, 7, 14, 28 and 90 days to ensure no errors occur on the entity dashboard.
    • Made sure the widgets were GA4 components.
  • Checked Analytics settings and no reference to the dashboard view or UA can be found here.

    • No errors in the console within view or edit settings.
    • Created new GA account, property, etc. from within settings.

Tested with an Analytics account that has a UA and GA4 property.

  • Used oi.ie as my test site: with SC and Analytics. No toggle appears when setting up Analytics

    • No errors on front end or in the console when setting up
    • No errors in the console on the main dashboard.
    • Changed date period for reporting, 7, 14, 28 and 90 days to ensure no errors occur on the main dashboard.
    • Made sure the widgets were GA4 components.
    • No errors in the console on the entity dashboard.
    • Changed date period for reporting, 7, 14, 28 and 90 days to ensure no errors occur on the entity dashboard.
    • Made sure the widgets were GA4 components.
  • Checked Analytics settings and no reference to the dashboard view or UA can be found here.

    • No errors in the console within view or edit settings.
    • Created new GA account, property, etc. from within settings.
  • Setup Dashboard Sharing for Analytics

    • No errors in the console on the main view only dashboard.
    • Changed date period for reporting, 7, 14, 28 and 90 days to ensure no errors occur on the main view only dashboard.
    • Made sure the widgets were GA4 components.
    • No errors in the console on the view only entity dashboard.
    • Changed date period for reporting, 7, 14, 28 and 90 days to ensure no errors occur on the view only entity dashboard.
    • Made sure the widgets were GA4 components.
Screenshots

image
image
image
image
image
image
image
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Exp: SP Module: Analytics Google Analytics module related issues P0 High priority Type: Enhancement Improvement of an existing feature
Projects
None yet
Development

No branches or pull requests

7 participants