Merge pull request #1233 from brizental/1749494-build-date

Bug 1749494 - Include build date metric on client_info when present

Author: Beatriz Rizental

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.32.0...main)
 
+* [#1233](https://github.com/mozilla/glean.js/pull/1233): Add optional `buildDate` argument to `initialize` configuration. The build date can be generated by glean_parser.
+* [#1233](https://github.com/mozilla/glean.js/pull/1233): Update glean_parser to version 5.1.0.
+
 # v0.32.0 (2022-03-01)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.31.0...v0.32.0)

glean/package-lock.json

@@ -26,7 +26,7 @@ const LOG_TAG = "CLI";
 const VIRTUAL_ENVIRONMENT_DIR = process.env.VIRTUAL_ENV || path.join(process.cwd(), ".venv");
 
 // The version of glean_parser to install from PyPI.
-const GLEAN_PARSER_VERSION = "5.0.1";
+const GLEAN_PARSER_VERSION = "5.1.0";
 
 // This script runs a given Python module as a "main" module, like
 // `python -m module`. However, it first checks that the installed

glean/src/cli.ts

@@ -48,22 +48,19 @@ export interface ConfigurationInterface {
   readonly architecture?: string,
   // The user-visible version of the operating system (e.g. "1.2.3").
   readonly osVersion?: string,
+  // The build date, provided by glean_parser
+  readonly buildDate?: Date,
 }
 
 // Important: the `Configuration` should only be used internally by the Glean singleton.
 export class Configuration implements ConfigurationInterface {
-  // Application release channel (e.g. "beta" or "nightly").
   readonly channel?: string;
-  // The build identifier generated by the CI system (e.g. "1234/A").
   readonly appBuild?: string;
-  // The user visible version string fro the application running Glean.js.
   readonly appDisplayVersion?: string;
-  // The server pings are sent to.
   readonly serverEndpoint: string;
-  // The architecture of the device (e.g. "arm", "x86").
   readonly architecture?: string;
-  // The user-visible version of the operating system (e.g. "1.2.3").
   readonly osVersion?: string;
+  readonly buildDate?: Date;
 
   // Debug configuration.
   debug: DebugOptions;
@@ -76,6 +73,7 @@ export class Configuration implements ConfigurationInterface {
     this.appDisplayVersion = config?.appDisplayVersion;
     this.architecture = config?.architecture;
     this.osVersion = config?.osVersion;
+    this.buildDate = config?.buildDate;
 
     this.debug = {};
 

glean/src/core/config.ts

@@ -32,6 +32,7 @@ export class CoreMetrics {
   readonly appChannel: StringMetricType;
   readonly appBuild: StringMetricType;
   readonly appDisplayVersion: StringMetricType;
+  readonly buildDate: DatetimeMetricType;
 
 
   constructor() {
@@ -106,6 +107,14 @@ export class CoreMetrics {
       lifetime: Lifetime.Application,
       disabled: false,
     });
+
+    this.buildDate = new DatetimeMetricType({
+      name: "build_date",
+      category: "",
+      sendInPings: ["glean_client_info"],
+      lifetime: Lifetime.Application,
+      disabled: false,
+    }, "second");
   }
 
   async initialize(): Promise<void> {
@@ -120,6 +129,9 @@ export class CoreMetrics {
     if (Context.config.channel) {
       await this.appChannel.setUndispatched(Context.config.channel);
     }
+    if (Context.config.buildDate) {
+      await this.buildDate.setUndispatched();
+    }
   }
 
   /**

glean/src/core/internal_metrics.ts

@@ -180,6 +180,24 @@ glean.internal.metrics:
       - glean-team@mozilla.com
     expires: never
 
+  build_date:
+    type: datetime
+    time_unit: second
+    lifetime: application
+    send_in_pings:
+      - glean_client_info
+    description: |
+      The date & time the application was built.
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1742448
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1742448#c17
+    data_sensitivity:
+      - technical
+    notification_emails:
+      - glean-team@mozilla.com
+    expires: never
+
   first_run_date:
     type: datetime
     lifetime: user

glean/src/metrics.yaml

@@ -472,13 +472,20 @@ describe("Glean", function() {
     assert.strictEqual(await metric.testGetValue(), undefined);
   });
 
-  it("appBuild and appDisplayVersion are correctly reported", async function () {
+  it("appBuild, appDisplayVersion and buildDate are correctly reported", async function () {
     await testUninitializeGlean();
 
     const testBuild = "test";
     const testDisplayVersion = "1.2.3-stella";
 
-    await testInitializeGlean(testAppId, true, { appBuild: testBuild, appDisplayVersion: testDisplayVersion });
+    await testInitializeGlean(
+      testAppId,
+      true, {
+        appBuild: testBuild,
+        appDisplayVersion: testDisplayVersion,
+        buildDate: new Date(),
+      }
+    );
     await Context.dispatcher.testBlockOnQueue();
 
     assert.strictEqual(await Glean.coreMetrics.appBuild.testGetValue(), testBuild);

glean/tests/unit/core/glean.spec.ts

@@ -86,6 +86,7 @@ describe("PingMaker", function() {
       channel: "channel",
       appBuild:"build",
       appDisplayVersion: "display version",
+      buildDate: new Date(),
       serverEndpoint: "http://localhost:8080"
     });
 
@@ -97,6 +98,7 @@ describe("PingMaker", function() {
     assert.ok("os_version" in clientInfo2);
     assert.ok("architecture" in clientInfo2);
     assert.ok("locale" in clientInfo2);
+    assert.ok("build_date"in clientInfo2);
     assert.strictEqual(clientInfo2["app_channel"], "channel");
     assert.strictEqual(clientInfo2["app_build"], "build");
     assert.strictEqual(clientInfo2["app_display_version"], "display version");

glean/tests/unit/core/pings/maker.spec.ts

@@ -1 +1 @@
-glean_parser==5.0.1
+glean_parser==5.1.0