Merge branch 'release-v4.0.0' into release

Author: rosahbruno

.dictionary

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 76 
+personal_ws-1.1 en 82 
 API's
 APIs
 BUGFIX
@@ -12,8 +12,10 @@ ESM
 Glean's
 Gzip
 HTTPS
+IndexedDB
 JSDoc
 JWK
+LocalStorage
 MPL
 PingType
 PlatformInfo
@@ -30,6 +32,7 @@ UI
 UUID
 UploadResult
 UploadResultStatus
+async
 benchmarking
 boolean
 booleans
@@ -63,10 +66,12 @@ mdroettboom
 mozilla
 npm
 prerelease
+queueing
 runtime
 schemas
 setRawNanos
 setUploadEnabled
+ssr
 timespan
 travis
 unminified
@@ -77,8 +82,3 @@ uuid
 virtualenv
 webext
 webpack
-async
-queueing
-LocalStorage
-IndexedDB
-ssr

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Unreleased changes
 
-[Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0-pre.3...main)
+[Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0...main)
+
+# v4.0.0 (2024-01-24)
+
+[Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0-pre.3...v4.0.0)
+
+* This is the official release based on the v4.x.x-pre.x releases.
 
 # v4.0.0-pre.3 (2023-12-22)
 

automation/package-lock.json

@@ -22,6 +22,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.client.annotation.experimentation_id |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |An experimentation identifier derived and provided by the application for the purpose of experimentation enrollment.  |[Bug 1848201](https://bugzilla.mozilla.org/show_bug.cgi?id=1848201#c5)||never |1 |
 | glean.error.invalid_label |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Counts the number of times a metric was set with an invalid label. The labels are the `category.name` identifier of the metric.  |[Bug 1499761](https://bugzilla.mozilla.org/show_bug.cgi?id=1499761#c5)||never |1 |
 | glean.error.invalid_overflow |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Counts the number of times a metric was set a value that overflowed. The labels are the `category.name` identifier of the metric.  |[Bug 1591912](https://bugzilla.mozilla.org/show_bug.cgi?id=1591912#c3)||never |1 |
 | glean.error.invalid_state |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Counts the number of times a timing metric was used incorrectly. The labels are the `category.name` identifier of the metric.  |[Bug 1499761](https://bugzilla.mozilla.org/show_bug.cgi?id=1499761#c5)||never |1 |

docs/reference/metrics.md

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

glean/package-lock.json

@@ -53,6 +53,8 @@ export interface ConfigurationInterface {
   // Allow the client to explicitly specify whether they want to automatically capture
   // element clicks.
   readonly enableAutoElementClickEvents?: boolean,
+  // Experimentation identifier to be set in all pings
+  experimentationId?: string,
 }
 
 // Important: the `Configuration` should only be used internally by the Glean singleton.
@@ -66,6 +68,7 @@ export class Configuration implements ConfigurationInterface {
   readonly migrateFromLegacyStorage?: boolean;
   readonly enableAutoPageLoadEvents?: boolean;
   readonly enableAutoElementClickEvents?: boolean;
+  experimentationId?: string;
 
   // Debug configuration.
   debug: DebugOptions;
@@ -81,6 +84,7 @@ export class Configuration implements ConfigurationInterface {
     this.migrateFromLegacyStorage = config?.migrateFromLegacyStorage;
     this.enableAutoPageLoadEvents = config?.enableAutoPageLoadEvents;
     this.enableAutoElementClickEvents = config?.enableAutoElementClickEvents;
+    this.experimentationId = config?.experimentationId;
 
     this.debug = {};
 

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 = "4.0.0-pre.3";
+export const GLEAN_VERSION = "4.0.0";
 
 // The name of a "ping" that will include Glean ping_info metrics,
 // such as ping sequence numbers.

glean/src/core/config.ts

@@ -8,7 +8,12 @@ import type Platform from "../platform/index.js";
 import { CLIENT_INFO_STORAGE, KNOWN_CLIENT_ID } from "./constants.js";
 import { Configuration } from "./config.js";
 import PingUploadManager from "./upload/manager.js";
-import { extractBooleanFromString, isBoolean, isString, sanitizeApplicationId } from "./utils.js";
+import {
+  extractBooleanFromString,
+  isBoolean,
+  isString,
+  sanitizeApplicationId,
+} from "./utils.js";
 import { CoreMetrics } from "./internal_metrics.js";
 import { DatetimeMetric } from "./metrics/types/datetime.js";
 import CorePings from "./internal_pings.js";
@@ -26,7 +31,7 @@ const LOG_TAG = "core.Glean";
 enum DebugOption {
   DebugTag = "DebugTag",
   SourceTags = "SourceTags",
-  LogPings = "LogPings"
+  LogPings = "LogPings",
 }
 type DebugOptionValue = keyof typeof DebugOption;
 
@@ -36,7 +41,10 @@ type DebugOptionValue = keyof typeof DebugOption;
  * @param option The debug option key to set.
  * @param value The value of the debug option.
  */
-const setDebugOptionInSessionStorage = (option: DebugOptionValue, value: boolean | string | string[]) => {
+const setDebugOptionInSessionStorage = (
+  option: DebugOptionValue,
+  value: boolean | string | string[]
+) => {
   const key = `Glean.${option.toString()}`;
 
   switch (option) {
@@ -58,7 +66,9 @@ const setDebugOptionInSessionStorage = (option: DebugOptionValue, value: boolean
  * @param option The debug option key to fetch the value of.
  * @returns The stringified value.
  */
-const getDebugOptionFromSessionStorage = (option: DebugOptionValue): string | undefined => {
+const getDebugOptionFromSessionStorage = (
+  option: DebugOptionValue
+): string | undefined => {
   return sessionStorage.getItem(`Glean.${option.toString()}`) || undefined;
 };
 
@@ -185,7 +195,10 @@ namespace Glean {
    */
   function setDebugOptionsFromSessionStorage() {
     // If we cannot access browser APIs, we do nothing.
-    if (typeof window === "undefined" || typeof window.sessionStorage === "undefined") {
+    if (
+      typeof window === "undefined" ||
+      typeof window.sessionStorage === "undefined"
+    ) {
       return;
     }
 
@@ -259,7 +272,11 @@ namespace Glean {
     }
 
     if (!Context.platform) {
-      log(LOG_TAG, "Unable to initialize Glean, platform has not been set.", LoggingLevel.Error);
+      log(
+        LOG_TAG,
+        "Unable to initialize Glean, platform has not been set.",
+        LoggingLevel.Error
+      );
       return;
     }
 
@@ -383,7 +400,7 @@ namespace Glean {
         [
           "Changing upload enabled before Glean is initialized is not supported.\n",
           "Pass the correct state into `initialize`.\n",
-          "See documentation at https://mozilla.github.io/glean/book/user/general-api.html#initializing-the-glean-sdk`"
+          "See documentation at https://mozilla.github.io/glean/book/user/general-api.html#initializing-the-glean-sdk`",
         ],
         LoggingLevel.Error
       );
@@ -409,6 +426,15 @@ namespace Glean {
     }
   }
 
+  /**
+   * Sets the experimentation identifier
+   *
+   * @param experimentationId The string identifier to set
+   */
+  export function setExperimentationId(experimentationId: string): void {
+    Context.config.experimentationId = experimentationId;
+  }
+
   /**
    * Sets the `logPings` debug option.
    *
@@ -484,12 +510,16 @@ namespace Glean {
       return;
     }
 
-    if (Context.isPlatformSet() && Context.platform.name !== platform.name && !Context.testing) {
+    if (
+      Context.isPlatformSet() &&
+      Context.platform.name !== platform.name &&
+      !Context.testing
+    ) {
       log(
         LOG_TAG,
         [
           `IMPOSSIBLE: Attempted to change Glean's targeted platform",
-            "from "${Context.platform.name}" to "${platform.name}". Ignoring.`
+            "from "${Context.platform.name}" to "${platform.name}". Ignoring.`,
         ],
         LoggingLevel.Error
       );
@@ -506,17 +536,22 @@ declare global {
       setLogPings: (flag: boolean) => void;
       setDebugViewTag: (value: string) => void;
       setSourceTags: (value: string[]) => void;
-    }
+    };
   }
 }
 
 // Only set `Glean` values whenever running inside of a browser.
-if (typeof window !== "undefined" && typeof window.sessionStorage !== "undefined") {
+if (
+  typeof window !== "undefined" &&
+  typeof window.sessionStorage !== "undefined"
+) {
   window.Glean = {
     setLogPings: (flag: boolean) => {
       setDebugOptionInSessionStorage(DebugOption.LogPings, flag);
       Glean.setLogPings(flag);
-      console.log("Pings will be logged to the console until this tab is closed.");
+      console.log(
+        "Pings will be logged to the console until this tab is closed."
+      );
     },
     setDebugViewTag: (value: string) => {
       setDebugOptionInSessionStorage(DebugOption.DebugTag, value);
@@ -528,8 +563,10 @@ if (typeof window !== "undefined" && typeof window.sessionStorage !== "undefined
     setSourceTags: (value: string[]) => {
       setDebugOptionInSessionStorage(DebugOption.SourceTags, value);
       Glean.setSourceTags(value);
-      console.log("Pings will be given the specified tags until the tab is closed.");
-    }
+      console.log(
+        "Pings will be given the specified tags until the tab is closed."
+      );
+    },
   };
 }