Remove legacy search_console_error event

[aaemnnosttv]

Feature Description

There are a few uses in the codebase of an old tracked event that are no longer relevant and should be removed.

---

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

Acceptance criteria

• The following tracked event and all instances that have the same category, action, and label should be removed

  site-kit-wp/assets/js/modules/search-console/components/dashboard/DashboardImpressionsWidget.js

  Line 116 in 955f12b

  trackEvent( 'plugin_setup', 'search_console_error', error.message );

Implementation Brief

• Remove all trackEvent calls with search_console_error as the second argument, eg. from:
  • assets/js/components/wp-dashboard/WPDashboardClicks.js
  • assets/js/components/wp-dashboard/WPDashboardImpressions.js
  • assets/js/modules/search-console/components/dashboard/DashboardClicksWidget.js
  • assets/js/modules/search-console/components/dashboard/DashboardImpressionsWidget.js

Test Coverage

• Tests should not need updating.

QA Brief

• In the current revision, the plugin tracks data loading errors in the following four locations through GA with the plugin_setup category and search_console_error action:
  • In the WordPress Dashboard "Site Kit Summary" widget, the "Total Impressions" section.
  • In the WordPress Dashboard "Site Kit Summary" widget, the "Total Clicks" section.
  • In the Site Kit Dashboard "Search Funnel" section, the "Impressions" widget.
  • In the Site Kit Dashboard "Search Funnel" section, the "Clicks" widget.
• QAing this would require making sure this event is not tracked anymore for the above locations.
• This can be done by simulating errors in the above locations and not letting these widgets load data, and then using the Google Analytics Debugger Chrome Extension to make sure these errors are not tracked.
• The above-mentioned error can be simulated by setting a "Custom Site URL" using the Dev Settings plugin after the plugin setup and clearing the session storage.
• In order to see these events being tracked in the Site Kit Dashboard, the unifiedDashboard feature flag must be unchecked in the tester plugin.

Changelog entry

• N/A

[eugene-manuilov]

IB ✔️

[mohitwp]

QA Update ⚠️

@nfmohit I tried to reproduce this issue as per QAB on latest release branch. I'm not getting any search_console_error event on latest as well as on develop branch. How can I get this event ? Let me know if I missed any step here.

[wpdarren]

QA Update: ⚠️

@nfmohit just confirming what @mohitwp has mentioned - when we are on the latest release, and the search console error is triggered as per the QAB, we cannot see search_console_error in the log. I've also had a look at the custom events spreadsheet and it does not exist there either. Could you tell us how to trigger this currently? We can then switch to the develop branch and compare the two, to make sure that this is passing our tests.

We would need to get this into approved by EOD on Wednesday (tomorrow) Thanks! 😄

[nfmohit]

Thank you @mohitwp and @wpdarren!

I apologise for the delay on this one. This slipped through the cracks as I was busy catching up with everything after the vacation.

I'll re-review this ASAP right after the bug bash and it should be ready for you to check again first thing tomorrow.

[wpdarren]

QA Update: ⚠️

@nfmohit going on the QAB, the plugin_setup category AND search_console_error action should be appearing on the WP and Site Kit Dashboard on the latest release. I can confirm on the WP Dashboard, the GA event category and action can be found on 1.75.0 and when I switch to develop branch, it does not appear in the log ✅

The issue is, on the Site Kit Dashboard, the plugin_setup category and search_console_error action does not appear on 1.75.0. Can you confirm if it 100% should? Are you able to see these on the Site Kit Dashboard? In these types of situations it's good to see the initial issue so we know it has been fixed on develop.

[nfmohit]

@wpdarren I have updated the QAB. I had mistakenly forgotten to include that in order to see these events being tracked in the Site Kit Dashboard, the unifiedDashboard feature flag must be unchecked in the tester plugin.

Could you check if the feature flag is checked in your test setup, uncheck it and see if you can see the event being tracked?

I should also mention that:

• according to my tests, the unifiedDashboard feature is enabled by default in a fresh installation of 1.75.0. So, you'd need to install the tester plugin, in the tester plugin settings, set the Force enabled feature flags to Always override to track these events from the Site Kit Dashboard.
• These events won't be relevant within the Site Kit Dashboard anymore in the future anyway because the unifiedDashboard feature flag and relevant unused code is being removed as a part of Remove unifiedDashboard feature flag and unused code #5047.

[wpdarren]

QA Update: ✅

Nice work @nfmohit - that worked perfectly. Thank you for your help.

Verified:

I can confirm on the WP Dashboard and Site Kit Dashboard, the GA event category and action can be found on 1.75.0 and when I switch to develop branch, it does not appear in the log