Merge branch 'release-v5.0.6' into release

Author: jeddai

CHANGELOG.md

@@ -1,19 +1,28 @@
 # Unreleased changes
 
-[Full changelog](https://github.com/mozilla/glean.js/compare/v5.0.5...main)
+[Full changelog](https://github.com/mozilla/glean.js/compare/v5.0.6...main)
 
-# v5.0.5 (2025-07-17)
+# v5.0.6 (2025-09-15)
 
-* [#1993](https://github.com/mozilla/glean.js/pull/1993): Add try-catch around uses of sessionStorage and localStorage in core.
+# v5.0.6 (2025-09-15)
+
+[Full changelog](https://github.com/mozilla/glean.js/compare/v5.0.5...v5.0.6)
+
+* [#2010](https://github.com/mozilla/glean.js/pull/2010): Remove faulty check for sessionStorage to prevent uncaught error.
+* [#2011](https://github.com/mozilla/glean.js/pull/2011): Bug 1987158 - Capture page `url`/`referrer`/`title` with `recordElementClick()`.
+
+# v5.0.5 (2025-07-17)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v5.0.4...v5.0.5)
 
-# v5.0.4 (2025-04-02)
+* [#1993](https://github.com/mozilla/glean.js/pull/1993): Add try-catch around uses of sessionStorage and localStorage in core.
 
-* [#1977](https://github.com/mozilla/glean.js/pull/1977): Add try-catch around window.sessionStorage access to prevent uncaught error upon `import`.
+# v5.0.4 (2025-04-02)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v5.0.3...v5.0.4)
 
+* [#1977](https://github.com/mozilla/glean.js/pull/1977): Add try-catch around window.sessionStorage access to prevent uncaught error upon `import`.
+
 # v5.0.3 (2024-08-02)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v5.0.2...v5.0.3)

docs/reference/metrics.md

@@ -101,7 +101,7 @@ In addition to those built-in metrics, the following metrics are added to the pi
 
 | Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefox/Data_Collection) |
 | --- | --- | --- | --- | --- | --- | --- |
-| glean.element_click |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A event triggered whenever an html element is clicked on a page.  **Clicks are recorded only for those html elements that have at least one of the `data-glean-*` data attributes. By default, this event is not collected automatically. Collection can be turned on by clients via Glean configuration object (`enableAutoElementClickEvents`). Glean also provides a separate API for clients to record element clicks manually.**  |[Bug 1867294](https://bugzilla.mozilla.org/show_bug.cgi?id=1867294#c29)|<ul><li>id: An identifier of the element clicked. For automatic collection, its value is the element's `data-glean-id` data attribute value.</li><li>label: The label of the element clicked. For automatic collection, its value is the element's `data-glean-label` data attribute value.</li><li>type: The type of the element clicked. For automatic collection, its value is the element's `data-glean-type` data attribute value.</li></ul>|never |2 |
+| glean.element_click |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A event triggered whenever an html element is clicked on a page.  **Clicks are recorded only for those html elements that have at least one of the `data-glean-*` data attributes. By default, this event is not collected automatically. Collection can be turned on by clients via Glean configuration object (`enableAutoElementClickEvents`). Glean also provides a separate API for clients to record element clicks manually.**  |[Bug 1867294](https://bugzilla.mozilla.org/show_bug.cgi?id=1867294#c29)|<ul><li>id: An identifier of the element clicked. For automatic collection, its value is the element's `data-glean-id` data attribute value.</li><li>label: The label of the element clicked. For automatic collection, its value is the element's `data-glean-label` data attribute value.</li><li>referrer: The referrer of the page where the element was clicked.</li><li>title: The title of the page where the element was clicked.</li><li>type: The type of the element clicked. For automatic collection, its value is the element's `data-glean-type` data attribute value.</li><li>url: The URL of the page where the element was clicked.</li></ul>|never |2 |
 | glean.page_id |[uuid](https://mozilla.github.io/glean/book/user/metrics/uuid.html) |Uniquely identifies a page_load, not the page itself, for the purpose of associating other events with the specific page load event. This gets rotated with each page load and is sent along with each event ping.  |[Bug 1888430](https://bugzilla.mozilla.org/show_bug.cgi?id=1888430)||never |1 |
 | glean.page_load |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A event triggered whenever a page is loaded.  **This event by default is not collected automatically. This can be turned on by the client in the Glean configuration object (`enableAutoPageLoadEvents`). Glean provides a separate API for collecting the same page load data if the client wants to collect page loads manually.**  |[Bug 1867126](https://bugzilla.mozilla.org/show_bug.cgi?id=1867126#c8)|<ul><li>referrer: The page referrer.</li><li>title: The page title.</li><li>url: The page URL.</li></ul>|never |2 |
 

documentation/src/content/docs/automatic_instrumentation/click_events.md

@@ -36,6 +36,12 @@ An example HTML button that will fire a click event:
 </button>
 ```
 
+Glean also automatically captures the following values for click events:
+
+- url: `window.location.href`
+- referrer: `document.referrer`
+- title: `document.title`
+
 ## Click event API
 
 Glean.js provides an API for manually collecting click events.

glean/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@mozilla/glean",
-  "version": "5.0.5",
+  "version": "5.0.6",
   "description": "An implementation of the Glean SDK, a modern cross-platform telemetry client, for JavaScript environments.",
   "type": "module",
   "sideEffects": false,

glean/package.json

@@ -8,7 +8,7 @@ export const GLEAN_SCHEMA_VERSION = 1;
 //
 // PACKAGE_VERSION is defined as a global by webpack,
 // we need a default here for testing when the app is not build with webpack.
-export const GLEAN_VERSION = "5.0.5";
+export const GLEAN_VERSION = "5.0.6";
 
 // The name of a "ping" that will include Glean ping_info metrics,
 // such as ping sequence numbers.

glean/src/core/constants.ts

@@ -194,14 +194,6 @@ namespace Glean {
    * Fetch debug options from SessionStorage and set the Glean preInit debug options.
    */
   function setDebugOptionsFromSessionStorage() {
-    // If we cannot access browser APIs, we do nothing.
-    if (
-      typeof window === "undefined" ||
-      typeof window.sessionStorage === "undefined"
-    ) {
-      return;
-    }
-
     const logPings = getDebugOptionFromSessionStorage(DebugOption.LogPings);
     if (logPings) {
       preInitLogPings = extractBooleanFromString(logPings);

glean/src/core/glean.ts

@@ -21,6 +21,9 @@ type ElementClickEventContext = {
   id?: string;
   type?: string;
   label?: string;
+  url?: string;
+  referrer?: string;
+  title?: string;
 };
 
 /**
@@ -51,7 +54,7 @@ namespace GleanMetrics {
         disabled: false,
       },
       // extras defined in `src/metrics.yaml`.
-      ["id", "type", "label"]
+      ["id", "type", "label", "url", "referrer", "title"]
     ),
     pageId: new UUIDMetric(
       {
@@ -124,8 +127,24 @@ namespace GleanMetrics {
     const elementClickEventContext: ElementClickEventContext = {
       ...(dataset.gleanId && { id: dataset.gleanId }),
       ...(dataset.gleanType && { type: dataset.gleanType }),
-      ...(dataset.gleanLabel && { label: dataset.gleanLabel })
+      ...(dataset.gleanLabel && { label: dataset.gleanLabel }),
+      url:
+        (typeof window !== "undefined"
+          ? window.location.href
+          : "URL_NOT_PROVIDED_OR_AVAILABLE"
+        ),
+      referrer:
+        (typeof document !== "undefined"
+          ? document.referrer
+          : "REFERRER_NOT_PROVIDED_OR_AVAILABLE"
+        ),
+      title:
+        (typeof document !== "undefined"
+          ? document.title
+          : "TITLE_NOT_PROVIDED_OR_AVAILABLE"
+        ),
     };
+
     return elementClickEventContext;
   }
 

glean/src/core/glean_metrics.ts

@@ -539,6 +539,15 @@ glean:
       label:
         description: The label of the element clicked. For automatic collection, its value is the element's `data-glean-label` data attribute value.
         type: string
+      url:
+        description: The URL of the page where the element was clicked.
+        type: string
+      referrer:
+        description: The referrer of the page where the element was clicked.
+        type: string
+      title:
+        description: The title of the page where the element was clicked.
+        type: string
   page_id:
     type: uuid
     description: |