Bug 1691068 - Implement log pings (#41)

Author: Beatriz Rizental

samples/qt-qml-app/generatedMetrics.js

@@ -0,0 +1,23 @@
+/* eslint-disable no-undef */
+/* eslint-disable no-unused-vars */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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/. */
+
+"use strict";
+
+const appStarted = new Glean.Glean._private.DatetimeMetricType({
+  category: "sample",
+  name: "app_started",
+  sendInPings: ["sample"],
+  lifetime: "ping",
+  disabled: false
+}, "millisecond");
+
+const buttonClicked = new Glean.Glean._private.CounterMetricType({
+  category: "sample",
+  name: "button_clicked",
+  sendInPings: ["sample"],
+  lifetime: "ping",
+  disabled: false
+}, "millisecond");

samples/qt-qml-app/generatedPings.js

@@ -0,0 +1,9 @@
+/* eslint-disable no-undef */
+/* eslint-disable no-unused-vars */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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/. */
+
+"use strict";
+
+const samplePing = new Glean.Glean._private.PingType("sample", true, false);

samples/qt-qml-app/main.qml

@@ -7,6 +7,9 @@ import QtQuick.Controls 2.0
 import QtGraphicalEffects 1.15
 
 import "../../dist/glean.js" as Glean;
+// These must be imported after Glean because they rely on Glean being in the environment.
+import "./generatedPings.js" as Pings;
+import "./generatedMetrics.js" as Metrics;
 
 Rectangle {
   id: screen
@@ -16,38 +19,54 @@ Rectangle {
   property int displayText: 0
 
   Button {
-    id: glean
-    text: "PUSH 👏 THIS 👏 BUTTON"
+    id: record
+    text: "Record"
+    anchors.horizontalCenter: ping.horizontalCenter
+    anchors.bottom: ping.bottom
+    anchors.bottomMargin: 80
+    palette.buttonText: "black"
+    palette.button: "#f1f1f1"
+    font.bold: true
+    onClicked: () => {
+      console.log("Adding to the `button_clicked` metric.")
+      Metrics.buttonClicked.add();
+    }
+  }
+
+  Button {
+    id: ping
+    text: "Submit ping"
     anchors.centerIn: parent
     palette.buttonText: "white"
     palette.button: "#ff5000"
     font.bold: true
     onClicked: () => {
       screen.displayText = 1;
-      console.info("Nothing will happen. Glean.js is not yet implemented.");
+      Pings.samplePing.submit();
     }
   }
 
   DropShadow {
-    anchors.fill: glean
+    anchors.fill: ping
     horizontalOffset: 7
     verticalOffset: -7
     radius: 0
     color: "#0059ab"
-    source: glean
+    source: ping
   }
 
   Text {
     id: consoleWarn
-    text: "Now, take a look at the logs on your terminal."
+    text: "A ping should have been submitted, please check you terminal for logs."
     visible: displayText
-    anchors.top: glean.bottom
+    anchors.top: ping.bottom
     anchors.topMargin: 30
-    anchors.horizontalCenter: glean.horizontalCenter
+    anchors.horizontalCenter: ping.horizontalCenter
   }
 
   Component.onCompleted: {
-    // Initialize Glean when the application starts.
-    Glean.Glean.initialize("qt-qml-app", true);
+    // Initialize Glean.
+    Glean.Glean.initialize("qt-qml-app", true, { debug: { logPings: true }});
+    Metrics.appStarted.set();
   }
 }

samples/web-extension/generatedMetrics.js

@@ -8,7 +8,7 @@ import Glean from "glean";
 
 export const webExtStarted = new Glean._private.DatetimeMetricType({
   category: "sample",
-  name: "webext_installed",
+  name: "webext_started",
   sendInPings: ["sample"],
   lifetime: "ping",
   disabled: false

samples/web-extension/index.js

@@ -8,8 +8,7 @@ import Glean from "glean";
 import { samplePing } from "./generatedPings";
 import { webExtStarted, popupOpened } from "./generatedMetrics";
 
-
-Glean.initialize("web-extension", true);
+Glean.initialize("web-extension", true, { debug: { logPings: true }});
 webExtStarted.set();
 
 // Listen for messages from the popup.

src/config.ts

@@ -5,6 +5,14 @@
 import { DEFAULT_TELEMETRY_ENDPOINT } from "./constants";
 import { validateURL } from "utils";
 
+/**
+ * Lists Glean's debug options.
+ */
+interface DebugOptions {
+  // Whether or not lot log pings when they are collected.
+  logPings?: boolean,
+}
+
 /**
  * Describes how to configure Glean.
  */
@@ -15,6 +23,8 @@ export interface ConfigurationInterface {
   readonly appDisplayVersion?: string,
   // The server pings are sent to.
   readonly serverEndpoint?: string,
+  // Debug configuration.
+  debug?: DebugOptions,
 }
 
 export class Configuration implements ConfigurationInterface {
@@ -24,11 +34,13 @@ export class Configuration implements ConfigurationInterface {
   readonly appDisplayVersion?: string;
   // The server pings are sent to.
   readonly serverEndpoint: string;
+  // Debug configuration.
+  debug?: DebugOptions;
 
   constructor(config?: ConfigurationInterface) {
     this.appBuild = config?.appBuild;
     this.appDisplayVersion = config?.appDisplayVersion;
-    this.appBuild = config?.appBuild;
+    this.debug = config?.debug;
 
     if (config?.serverEndpoint && !validateURL(config.serverEndpoint)) {
       throw new Error(

src/glean.ts

@@ -318,6 +318,15 @@ class Glean {
     return Glean.instance._config?.serverEndpoint;
   }
 
+  /**
+   * Whether or not to log pings upon collection.
+   *
+   * @returns Whether or not to log pings upon collection.
+   */
+  static get logPings(): boolean {
+    return Glean.instance._config?.debug?.logPings || false;
+  }
+
   /**
    * Gets this Gleans's instance dispatcher.
    *
@@ -373,6 +382,32 @@ class Glean {
     });
   }
 
+  /**
+   * Sets the `logPings` flag.
+   *
+   * When this flag is `true` pings will be logged to the console right before they are collected.
+   *
+   * @param flag Whether or not to log pings.
+   */
+  static setLogPings(flag: boolean): void {
+    Glean.dispatcher.launch(() => {
+      // It is guaranteed that _config will have a value here.
+      //
+      // All dispatched tasks are guaranteed to be run after initialize.
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      if (!Glean.instance._config!.debug) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        Glean.instance._config!.debug = {};
+      }
+
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      Glean.instance._config!.debug.logPings = flag;
+
+      // The dispatcher requires that dispatched functions return promises.
+      return Promise.resolve();
+    });
+  }
+
   /**
    * **Test-only API**
    *

src/index.ts

@@ -59,6 +59,18 @@ export = {
     Glean.setUploadEnabled(flag);
   },
 
+  /**
+   * Sets the `logPings` flag.
+   *
+   * When this flag is `true` pings will be logged
+   * to the console right before they are collected.
+   *
+   * @param flag Whether or not to log pings.
+   */
+  setLogPings(flag: boolean): void {
+    Glean.setLogPings(flag);
+  },
+
   _private: {
     PingType,
     BooleanMetricType,

src/pings/index.ts

@@ -2,9 +2,9 @@
  * 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 { v4 as UUIDv4 } from "uuid";
 
 import collectAndStorePing from "pings/maker";
+import { generateUUIDv4 } from "utils";
 import Glean from "glean";
 
 /**
@@ -60,7 +60,7 @@ class PingType {
         correctedReason = undefined;
       }
 
-      const identifier = UUIDv4();
+      const identifier = generateUUIDv4();
       await collectAndStorePing(identifier, this, correctedReason);
       return;
     });

src/pings/maker.ts

@@ -217,6 +217,11 @@ export async function collectAndStorePing(identifier: string, ping: PingType, re
   if (!payload) {
     return;
   }
+
+  if (Glean.logPings) {
+    console.info(JSON.stringify(payload, null, 2));
+  }
+
   const headers = getPingHeaders();
   return Glean.pingsDatabase.recordPing(
     makePath(identifier, ping),