Support tracking events on standard hyperlinks

Aperta
#415 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
html, javascript

Direzione di ricerca

Inizia individuando l’implementazione di Segment e gli entry point esistenti sendTrackEvent e sendTrackingLogEvent. Esamina come vengono esportati gli helper di analytics e come vengono gestiti i clic sui link nei consumer. Il lavoro è completo quando i consumer possono importare e usare un helper per i collegamenti ipertestuali nativi che invia l’evento prima di un aggiornamento completo della pagina.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Context

@edx/frontend-platform provides an analytics service interface and a Segment implementation for tracking events (custom events, page events, identify events). The Segment implementation relies on helper functions from Segment.js, including:

  • global.analytics.track (via sendTrackEvent)
  • global.analytics.page (via sendPageEvent)
  • global.analytics.identify (via identifyAuthenticatedUser)

@edx/frontend-platform also exports a sendTrackingLogEvent function to send events to the tracking log, which includes event that are sent to our partners as part of our data share agreements (e.g., for their research purposes). These events are sent via a POST request to the configured trackingLogApiUrl (i.e., ${config.LMS_BASE_URL}/event)

Problem

We occasionally run into use cases where we need to dispatch an event when a user clicks on a native HTML hyperlink that triggers a full page refresh. However, using sendTrackEvent and/or sendTrackingLogEvent in this situation is not possible because the browser navigates away from the current page without giving the asynchronous event enough time to fire.

Segment provides a trackLink method that is not currently utilized by @edx/frontend-platform. However, its implementation relies on event listeners on a DOM element (i.e., hyperlink), which isn't compatible in a React world with frequent component re-rendering. For example, on component mount, an event listener might get set, but then on a component re-render, the underlying DOM element with the aforementioned event listener got re-rendered so its effectively a new DOM element that would need an event listener added again. Similarly, when a component unmounts, there's no way to clear the event listener with trackLink which leads to potentially unwanted behavior.

As such, for tracking events of native HTML hyperlinks that trigger a full page refresh, consumers have had to implement their own workarounds, e.g.:

  • Preventing default link behavior (i.e., event.preventDefault()), dispatching the event, and then awaiting a Promise to resolve after an intentional delay before forcing navigation with global.location.href.
  • Preventing default link behavior (i.e., event.preventDefault()) dispatching the event, then waiting for a setTimeout to execute after an intentional delay before forcing navigation with global.location.href.

Acceptance Criteria

  • Ensure consumers of @edx/frontend-platform can import/use a helper function to track events asynchronously when clicking on a native HTML hyperlink that triggers a full page refresh.
Lingua principale
JavaScript
Stelle
38
Fork
90
Merge medio
3m
PR unite (30g)
4

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openedx/frontend-platform

Tutte le issue di openedx/frontend-platform

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.