Support tracking events on standard hyperlinks
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
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(viasendTrackEvent)global.analytics.page(viasendPageEvent)global.analytics.identify(viaidentifyAuthenticatedUser)
@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 aPromiseto resolve after an intentional delay before forcing navigation withglobal.location.href. - Preventing default link behavior (i.e.,
event.preventDefault()) dispatching the event, then waiting for asetTimeoutto execute after an intentional delay before forcing navigation withglobal.location.href.
Acceptance Criteria
- Ensure consumers of
@edx/frontend-platformcan 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
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di openedx/frontend-platform
-
a11y
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
openedx/frontend-platform#745 · 3 commenti ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 45/100
openedx/frontend-platform#892 · 4 commenti ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100
openedx/frontend-platform#837 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
openedx/frontend-platform#835 · 1 commento ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
openedx/frontend-platform#833 ·
Tutte le issue di openedx/frontend-platform
Issue simili
-
marketing
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
enhancement good first issue help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
enhancement good first issue severity: low
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
TMHSDigital/Static_Chess#163 ·
I maintainer di solito rispondono entro 1 giorno
-
[Bug] Account menu (footer ⚙) doesn't dismiss on outside click — stays open and covers the Bot listAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
Fei2411/DeepSeek-Bot#1693 ·
-
area-templates triage:bot-seen triage:needs-human
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
microsoft/aspire#22356 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno