Merge pull request #1051 from brizental/1746375-less-is-more

Bug 1746375 - Apply various changes to make Glean.js bundle smaller

Author: Beatriz Rizental

benchmarks/size/max.js

@@ -15,6 +15,7 @@ import QuantityMetricType from "@mozilla/glean/private/metrics/quantity";
 import StringMetricType from "@mozilla/glean/private/metrics/string";
 import TextMetricType from "@mozilla/glean/private/metrics/text";
 import TimespanMetricType from "@mozilla/glean/private/metrics/timespan";
+import RateMetricType from "@mozilla/glean/private/metrics/rate";
 import UUIDMetricType from "@mozilla/glean/private/metrics/uuid";
 import URLMetricType from "@mozilla/glean/private/metrics/url";
 // Plugins
@@ -33,6 +34,7 @@ console.log(
   JSON.stringify(StringMetricType),
   JSON.stringify(TextMetricType),
   JSON.stringify(TimespanMetricType),
+  JSON.stringify(RateMetricType),
   JSON.stringify(UUIDMetricType),
   JSON.stringify(URLMetricType),
   JSON.stringify(PingEncryptionPlugin),

glean/.eslintrc

@@ -89,6 +89,9 @@
       "parser": "@typescript-eslint/parser",
       "parserOptions": {
         "project": ["./tsconfig.json"]
+      },
+      "rules": {
+        "@typescript-eslint/no-namespace": "off"
       }
     },
     {

glean/package.json

@@ -3,7 +3,7 @@
   "version": "0.29.0",
   "description": "An implementation of the Glean SDK, a modern cross-platform telemetry client, for JavaScript environments.",
   "type": "module",
-  "sideEffects": "false",
+  "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",
     "./private/metrics/*": "./dist/core/metrics/types/*.js",

glean/src/core/config.ts

@@ -6,12 +6,23 @@ import { DEFAULT_TELEMETRY_ENDPOINT, GLEAN_MAX_SOURCE_TAGS } from "./constants.j
 import type Plugin from "../plugins/index.js";
 import { validateHeader, validateURL } from "./utils.js";
 import type Uploader from "./upload/uploader.js";
-import type { DebugOptions } from "./debug_options.js";
 import log, { LoggingLevel } from "./log.js";
 import { Context } from "./context.js";
 
 const LOG_TAG = "core.Config";
 
+/**
+ * Lists Glean's debug options.
+ */
+export interface DebugOptions {
+  // Whether or not lot log pings when they are collected.
+  logPings?: boolean;
+  // The value of the X-Debug-ID header to be included in every ping.
+  debugViewTag?: string;
+  // The value of the X-Source-Tags header to be included in every ping.
+  sourceTags?: string[];
+}
+
 /**
  * Describes how to configure Glean.
  */
@@ -84,16 +95,24 @@ export class Configuration implements ConfigurationInterface {
     this.httpClient = config?.httpClient;
   }
 
-  get debugViewTag(): string {
-    return this.debug.debugViewTag || "";
+  get logPings(): boolean {
+    return this.debug.logPings || false;
+  }
+
+  set logPings(flag: boolean) {
+    this.debug.logPings = flag;
+  }
+
+  get debugViewTag(): string | undefined {
+    return this.debug.debugViewTag;
   }
 
-  set debugViewTag(tag: string) {
-    if (!validateHeader(tag)) {
+  set debugViewTag(tag: string | undefined) {
+    if (!validateHeader(tag || "")) {
       log(
         LOG_TAG,
         [
-          `"${tag}" is not a valid \`debugViewTag\` value.`,
+          `"${tag || ""}" is not a valid \`debugViewTag\` value.`,
           "Please make sure the value passed satisfies the regex `^[a-zA-Z0-9-]{1,20}$`."
         ],
         LoggingLevel.Error
@@ -105,15 +124,15 @@ export class Configuration implements ConfigurationInterface {
     this.debug.debugViewTag = tag;
   }
 
-  get sourceTags(): string[] {
-    return this.debug.sourceTags || [];
+  get sourceTags(): string[] | undefined {
+    return this.debug.sourceTags;
   }
 
-  set sourceTags(tags: string[]) {
-    if (tags.length < 1 || tags.length > GLEAN_MAX_SOURCE_TAGS) {
+  set sourceTags(tags: string[] | undefined) {
+    if (!tags || tags.length < 1 || tags.length > GLEAN_MAX_SOURCE_TAGS) {
       log(
         LOG_TAG,
-        `A list of tags cannot contain more than ${GLEAN_MAX_SOURCE_TAGS} elements.`,
+        `A list of tags cannot contain more than ${GLEAN_MAX_SOURCE_TAGS} elements or less than one.`,
         LoggingLevel.Error
       );
       return;

glean/src/core/context.ts

@@ -2,14 +2,14 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-import type { DebugOptions } from "./debug_options.js";
 import type MetricsDatabase from "./metrics/database.js";
 import type EventsDatabase from "./metrics/events_database/index.js";
 import type PingsDatabase from "./pings/database.js";
 import type ErrorManager from "./error/index.js";
 import type Platform from "../platform/index.js";
 import Dispatcher from "./dispatcher.js";
 import log, { LoggingLevel } from "./log.js";
+import type { Configuration } from "./config.js";
 
 const LOG_TAG = "core.Context";
 
@@ -39,7 +39,7 @@ export class Context {
   private _pingsDatabase!: PingsDatabase;
   private _errorManager!: ErrorManager;
   private _applicationId!: string;
-  private _debugOptions!: DebugOptions;
+  private _config!: Configuration;
 
   // Whether or not Glean is initialized.
   private _initialized = false;
@@ -191,22 +191,22 @@ export class Context {
     Context.instance._initialized = init;
   }
 
-  static get debugOptions(): DebugOptions {
-    if (typeof Context.instance._debugOptions === "undefined") {
+  static get config(): Configuration {
+    if (typeof Context.instance._config === "undefined") {
       log(
         LOG_TAG,
         [
-          "Attempted to access Context.debugOptions before it was set. This may cause unexpected behaviour.",
+          "Attempted to access Context.config before it was set. This may cause unexpected behaviour.",
         ],
         LoggingLevel.Trace
       );
     }
 
-    return Context.instance._debugOptions;
+    return Context.instance._config;
   }
 
-  static set debugOptions(options: DebugOptions) {
-    Context.instance._debugOptions = options;
+  static set config(config: Configuration) {
+    Context.instance._config = config;
   }
 
   static get startTime(): Date {