feat: log search interactions to APM

[rwd]

Summary:

• Logs two user search interactions: performing a search, with number of results; clicking on a search result
• When loading a search by SSR, defers logging to the client-side so that session ID may always be logged

Detail:

• Adds a new custom pkg vue-session-id which generates a session ID with uuid and stores it in sessionStorage
• Adds a new mixin elasticApmReporter which:
  • provides a method logApmTransaction which:
    • accepts an optional object argument with name and labels properties for the transaction to log to APM, and stores it to the component data
    • if client-side, and a transaction object is stored in the component data:
      • adds session ID to the transaction labels
      • send the transaction to APM
      • waits 100 ms before closing the APM transaction, as otherwise the agent appears to discard the almost-immediate transaction
      • clears the transaction object from the component data
  • when mounted, calls logApmTransaction to log any transaction object already stored in the component data, e.g. from server-side hydration
• In SearchInterface:
  • changes the API params from a computed property to one derived on-demand, so that they don't change when the user clicks a search result, which would prevent them being used in that interaction logging
  • uses the elasticApmReporter mixin to log search interactions for fetching results and clicking a result
• In ItemPreviewCard:
  • adds props to support custom event listeners for the click and auxclick events on the cards, used for the search result click logging
• In the Record API search plugin:
  • stop adding the contentTier filter there, and instead have all callers of the search method add them (via an exported function) if needed. (So that the contentTier filter gets logged to APM.)

[github-actions]

JIRA ticket: EC-6318

[github-actions]

Preview deployment: https://pr-2036.portal-js.dev.eanadev.org/

[lbiedinger]

The user buttons and the copyright and type info section in the list view also cause events to fire when they're clicked on.

Adding an @click.stop="" attribute to the wrapper div in portal/src/components/user/UserButtons.vue looks like it successfully prevents this from happening.

[rwd]

@lbiedinger to prevent clicking the user buttons from logging the search interaction, I have used @click.stop as you suggested, but put it into ItemPreviewCard instead of within UserButtons.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

95.5% Coverage
0.0% Duplication