Merge pull request #779 from mozilla/172777-qt-fixes

Bug 172777 - Apply workarounds to known Qt JS issues

Author: Michael Droettboom

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.20.0...main)
 
+* [#754](https://github.com/mozilla/glean.js/pull/754): Change target ECMAScript target from 2015 to 2016 when building for Qt.
+* [#779](https://github.com/mozilla/glean.js/pull/779): Add a number of workarounds for the Qt Javascript engine.
+
 # v0.20.0 (2021-09-17)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.19.0...v0.20.0)
@@ -10,7 +13,6 @@
 * [#695](https://github.com/mozilla/glean.js/pull/695): Implement PlatformInfo module for the Node.js platform.
 * [#695](https://github.com/mozilla/glean.js/pull/730): Implement Uploader module for the Node.js platform.
 
-
 # v0.19.0 (2021-09-03)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.18.1...v0.19.0)

glean/src/core/dispatcher.ts

@@ -79,9 +79,7 @@ class Dispatcher {
   // i.e. a Shutdown command is in the queue.
   private shuttingDown = false;
   // A promise containing the current execution promise.
-  //
-  // This is `undefined` in case there is no ongoing execution of tasks.
-  private currentJob?: Promise<void>;
+  private currentJob = Promise.resolve();
 
   constructor(readonly maxPreInitQueueSize = 100, readonly logTag = LOG_TAG) {
     this.queue = [];
@@ -176,9 +174,10 @@ class Dispatcher {
       // that was launched inside another task.
       this.currentJob
         .then(() => {
-          this.currentJob = undefined;
+          // eslint-disable-next-line @typescript-eslint/no-this-alias
+          const that = this;
           if (this.state === DispatcherState.Processing) {
-            this.state = DispatcherState.Idle;
+            that.state = DispatcherState.Idle;
           }
         })
         .catch(error => {
@@ -374,7 +373,7 @@ class Dispatcher {
     this.shuttingDown = true;
     this.launchInternal({ command: Commands.Shutdown });
     this.resume();
-    return this.currentJob || Promise.resolve();
+    return this.currentJob;
   }
 
   /**
@@ -388,7 +387,7 @@ class Dispatcher {
    * @returns The promise.
    */
   async testBlockOnQueue(): Promise<void> {
-    return this.currentJob && await this.currentJob;
+    return await this.currentJob;
   }
 
   /**

glean/src/core/glean.ts

@@ -86,7 +86,7 @@ class Glean {
    */
   private static async onUploadEnabled(): Promise<void> {
     Context.uploadEnabled = true;
-    await Glean.coreMetrics.initialize(Glean.instance._config, Glean.platform, Context.metricsDatabase);
+    await Glean.coreMetrics.initialize(Glean.instance._config, Glean.platform);
   }
 
   /**

glean/src/core/internal_metrics.ts

@@ -11,9 +11,9 @@ import TimeUnit from "./metrics/time_unit.js";
 import { generateUUIDv4 } from "./utils.js";
 import type { ConfigurationInterface } from "./config.js";
 import type Platform from "../platform/index.js";
-import type MetricsDatabase from "./metrics/database.js";
 import { Lifetime } from "./metrics/lifetime.js";
 import log, { LoggingLevel } from "./log.js";
+import { Context } from "./context.js";
 
 const LOG_TAG = "core.InternalMetrics";
 
@@ -100,9 +100,9 @@ export class CoreMetrics {
     });
   }
 
-  async initialize(config: ConfigurationInterface, platform: Platform, metricsDatabase: MetricsDatabase): Promise<void> {
-    await this.initializeClientId(metricsDatabase);
-    await this.initializeFirstRunDate(metricsDatabase);
+  async initialize(config: ConfigurationInterface, platform: Platform): Promise<void> {
+    await this.initializeClientId();
+    await this.initializeFirstRunDate();
     await StringMetricType._private_setUndispatched(this.os, await platform.info.os());
     await StringMetricType._private_setUndispatched(this.osVersion, await platform.info.osVersion());
     await StringMetricType._private_setUndispatched(this.architecture, await platform.info.arch());
@@ -114,12 +114,10 @@ export class CoreMetrics {
   /**
    * Generates and sets the client_id if it is not set,
    * or if the current value is currepted.
-   *
-   * @param metricsDatabase The metrics database.
    */
-  private async initializeClientId(metricsDatabase: MetricsDatabase): Promise<void> {
+  private async initializeClientId(): Promise<void> {
     let needNewClientId = false;
-    const clientIdData = await metricsDatabase.getMetric(CLIENT_INFO_STORAGE, this.clientId);
+    const clientIdData = await Context.metricsDatabase.getMetric(CLIENT_INFO_STORAGE, this.clientId);
     if (clientIdData) {
       try {
         const currentClientId = createMetric("uuid", clientIdData);
@@ -141,11 +139,9 @@ export class CoreMetrics {
 
   /**
    * Generates and sets the first_run_date if it is not set.
-   *
-   * @param metricsDatabase The metrics database.
    */
-  private async initializeFirstRunDate(metricsDatabase: MetricsDatabase): Promise<void> {
-    const firstRunDate = await metricsDatabase.getMetric(
+  private async initializeFirstRunDate(): Promise<void> {
+    const firstRunDate = await Context.metricsDatabase.getMetric(
       CLIENT_INFO_STORAGE,
       this.firstRunDate
     );

glean/src/core/metrics/database.ts

@@ -162,7 +162,7 @@ class MetricsDatabase {
     }
 
     const store = this._chooseStore(metric.lifetime);
-    const storageKey = await metric.identifier(this);
+    const storageKey = await metric.identifier();
     for (const ping of metric.sendInPings) {
       const finalTransformFn = (v?: JSONValue): JSONValue => transformFn(v).get();
       await store.update([ping, metric.type, storageKey], finalTransformFn);
@@ -231,7 +231,7 @@ class MetricsDatabase {
     metric: MetricType
   ): Promise<T | undefined> {
     const store = this._chooseStore(metric.lifetime);
-    const storageKey = await metric.identifier(this);
+    const storageKey = await metric.identifier();
     const value = await store.get([ping, metric.type, storageKey]);
     if (!isUndefined(value) && !validateMetricInternalRepresentation<T>(metric.type, value)) {
       log(

glean/src/core/metrics/index.ts

@@ -4,7 +4,6 @@
 
 import type { JSONValue } from "../utils.js";
 import type { Lifetime } from "./lifetime.js";
-import type MetricsDatabase from "./database.js";
 import type { ErrorType } from "../error/error_type.js";
 import { isUndefined } from "../utils.js";
 import { getValidDynamicLabel } from "./types/labeled.js";
@@ -82,17 +81,16 @@ export abstract class MetricType implements CommonMetricData {
   /**
    * The metric's unique identifier, including the category, name and label.
    *
-   * @param metricsDatabase The metrics database.
    * @returns The generated identifier. If `category` is empty, it's ommitted. Otherwise,
    *          it's the combination of the metric's `category`, `name` and `label`.
    */
-  async identifier(metricsDatabase: MetricsDatabase): Promise<string> {
+  async identifier(): Promise<string> {
     const baseIdentifier = this.baseIdentifier();
 
     // We need to use `isUndefined` and cannot use `(this.dynamicLabel)` because we want
     // empty strings to propagate as dynamic labels, so that erros are potentially recorded.
     if (!isUndefined(this.dynamicLabel)) {
-      return await getValidDynamicLabel(metricsDatabase, this);
+      return await getValidDynamicLabel(this);
     } else {
       return baseIdentifier;
     }

glean/src/core/metrics/types/labeled.ts

@@ -6,7 +6,6 @@ import type { CommonMetricData, MetricType } from "../index.js";
 import type CounterMetricType from "./counter.js";
 import type BooleanMetricType from "./boolean.js";
 import type StringMetricType from "./string.js";
-import type MetricsDatabase from "../database.js";
 import type { JSONValue } from "../../utils.js";
 import { Metric } from "../metric.js";
 import { Context } from "../../context.js";
@@ -93,11 +92,10 @@ export function stripLabel(identifier: string): string {
  * valid. If not, record an error and store data in the "__other__"
  * label.
  *
- * @param metricsDatabase the metrics database.
  * @param metric the metric to record to.
  * @returns a valid label that can be used to store data.
  */
-export async function getValidDynamicLabel(metricsDatabase: MetricsDatabase, metric: MetricType): Promise<string> {
+export async function getValidDynamicLabel(metric: MetricType): Promise<string> {
   // Note that we assume `metric.dynamicLabel` to always be available within this function.
   // This is a safe assumptions because we should only call `getValidDynamicLabel` if we have
   // a dynamic label.
@@ -108,14 +106,14 @@ export async function getValidDynamicLabel(metricsDatabase: MetricsDatabase, met
   const key = combineIdentifierAndLabel(metric.baseIdentifier(), metric.dynamicLabel);
 
   for (const ping of metric.sendInPings) {
-    if (await metricsDatabase.hasMetric(metric.lifetime, ping, metric.type, key)) {
+    if (await Context.metricsDatabase.hasMetric(metric.lifetime, ping, metric.type, key)) {
       return key;
     }
   }
 
   let numUsedKeys = 0;
   for (const ping of metric.sendInPings) {
-    numUsedKeys += await metricsDatabase.countByBaseIdentifier(
+    numUsedKeys += await Context.metricsDatabase.countByBaseIdentifier(
       metric.lifetime,
       ping,
       metric.type,