Implement/refactor GA tracking events for help menu and URL search

Feature Description

---

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

Acceptance criteria

• The click_outgoing_link GA event in the global_help_menu category should have its category adjusted to use {viewContext}_headerbar_helpmenu instead, where {viewContext} should be the current view context (see #4006 for related infrastructure).
• The help menu feature tour (also using global_help_menu as GA event category currently) should have its category adjusted to dashboard_headerbar_helpmenu (using VIEW_CONTEXT_DASHBOARD for the “dashboard” part). If straightforward, it would be actually preferable to also use {viewContext}_headerbar_helpmenu here (so that it automatically uses the current context), however hard-coding VIEW_CONTEXT_DASHBOARD is acceptable since the feature tour can currently only render there anyway.
• A new GA event open_urldetails should be added to the URL search widget in the Site Kit dashboard.
  • It should be triggered when the user actually submits, i.e. navigates away to that URL’s details page.
  • The event category for this should be “dashboard_urlsearch-widget” (using VIEW_CONTEXT_DASHBOARD for the “dashboard” part).
• Note that these events should be present in both the old and new header bar (see #4048).

Implementation Brief

Inside assets/js/components/help/HelpMenuLink.js:

• Import the View Context from assets/js/components/Root/ViewContextContext.js
• Pass this to the useContext hook to get the viewContext for the component:

import  ViewContextContext  from  'assets/js/components/Root/ViewContextContext';
import  {  useContext  }  from  '@wordpress/element';

const viewContext = useContext( ViewContextContext );

• Refactor the call to trackEvent so that the category (first argument) is ${viewContext}_headerbar_helpmenu instead of 'global_help_menu'

Inside assets/js/components/TourTooltips.js:

• As above, use the useContext hook and the ViewContextContext to determine the component’s viewContext.

• Add the following logic to the trackAllTourEvents function:

  • Create a variable, eventCategory
  • test the typeof gaEventCategory. If it is a 'function', call the function, passing in the viewContext as an argument. Assign the result to eventCategory.
  • Otherwise, fall back to the default, current behaviour and assign gaEventCategory
  • Refactor the rest of the logic in this function, replacing gaEventCategory references with the new eventCategory variable.
  • Update the documentation for the trackAllTourEvents function to reflect that gaEventCategory can now be a string or a function that takes the viewContext string and returns a string.

• Inside assets/js/components/TourTooltips.test.js

  • Make sure the existing tests still pass now that the component uses context
  • Add a test to cover the new scenario where a tour passes a function as gaEventCategory instead of a string

Inside assets/js/feature-tours/help-visibility.js:

• refactor the gaEventCategory property to be a function that takes a viewContext string and returns the following string: ${viewContext}_headerbar_helpmenu

Inside assets/js/googlesitekit/widgets/components/URLSearchWidget.js:

• Import trackEvent from assets/js/util/tracking/index.js
• As above, use the useContext hook and the ViewContextContext to determine the component’s viewContext.
• Inside the onClick callback, before the call to navigateTo, call trackEvent( viewContext, 'open_urldetails' )

Test Coverage

• As described in the IB.

QA Brief

• The help menu links and the help menu feature tour should use the new events described in the AC.
• The URLSearchWidget (the search bar entitled 'Search for individual page or post information` on the dashboard) should use the new event as per the AC.

Changelog entry

• N/A

[johnPhillips]

@eugene-manuilov I just spoke to @tofumatt and my understanding is that the final AC here is more of an FYI, as the header will likely use the same existing URL search component. I don’t think it requires anything in the IB.

[kuasha420]

QA: ✔️

Tested on main. LGTM!

• ✅ click_outgoing_links events are being fired with the correct {viewContext}_headerbar_helpmenu event category with the viewContext being correctly inferred as dashboard. module and pageDasboard accordingly.
• ✅ open_urldetails is firing with the dashboard_urlsearch-widget as category instead of dashboard_urlsearch-widget.
  • 
• ✅ Feature Tour tooltip is also using the new Event category.
  •