Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[Full changelog](https://github.com/mozilla/glean.js/compare/v4.1.0-pre.0...main)

* [#1895](https://github.com/mozilla/glean.js/pull/1895): Improve automatic click events for nested elements.

# v4.1.0-pre.0 (2024-03-05)

[Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0...v4.1.0-pre.0)
Expand Down
32 changes: 26 additions & 6 deletions glean/src/core/glean_metrics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,25 @@ namespace GleanMetrics {
});
}

/**
* Construct click event context for a given element.
*
* The element should have at least one of the data-glean-{x} attributes where x corresponds
* to the keys of ElementClickEventContext).
*
* @param element Element object.
* @returns ElementClickEventContext
*/
function constructClickEventContextForElement(element: Element) {
const dataset = (element as HTMLElement).dataset;
const elementClickEventContext: ElementClickEventContext = {
...(dataset.gleanId && { id: dataset.gleanId }),
...(dataset.gleanType && { type: dataset.gleanType }),
...(dataset.gleanLabel && { label: dataset.gleanLabel })
};
return elementClickEventContext;
}

/**
* Handler for "click" events on a document.
*
Expand All @@ -106,14 +125,15 @@ namespace GleanMetrics {
* @param event Event object.
*/
export function handleClickEvent(event: Event) {
const htmlElement = event.target as HTMLElement;
const clickedElement = event.target as Element;
const closestElementWithClickAttributes: Element | null = clickedElement.closest("[data-glean-id], [data-glean-type], [data-glean-label]");

const elementClickEventContext: ElementClickEventContext = {};
if (htmlElement?.dataset?.gleanId) elementClickEventContext.id = htmlElement?.dataset?.gleanId;
if (htmlElement?.dataset?.gleanType) elementClickEventContext.type = htmlElement?.dataset?.gleanType;
if (htmlElement?.dataset?.gleanLabel) elementClickEventContext.label = htmlElement?.dataset?.gleanLabel;
if (!closestElementWithClickAttributes) {
return;
}

if (Object.keys(elementClickEventContext).length > 0) recordElementClick(elementClickEventContext);
const elementClickEventContext: ElementClickEventContext = constructClickEventContextForElement(closestElementWithClickAttributes);
recordElementClick(elementClickEventContext);
}

/**
Expand Down