Stringify extras values when building ping payload

Author: brizental

glean/src/core/metrics/events_database/index.ts

@@ -278,7 +278,7 @@ class EventsDatabase {
    * 1. Sorts event by execution counter and timestamp;
    * 2. Applies offset to events timestamps;
    * 3. Removes the first event if it is a `glean.restarted` event;
-   * 4. Removes reserved extra keys.
+   * 4. Removes reserved extra keys and stringifies all extras values.
    *
    * @param pingName The name of the ping for which the payload is being prepared.
    * @param pingData An unsorted list of events.
@@ -368,7 +368,7 @@ class EventsDatabase {
       );
     }
 
-    return sortedEvents.map((e) => RecordedEvent.toJSONObject(e.withoutReservedExtras()));
+    return sortedEvents.map((e) => RecordedEvent.toJSONObject(e.payload()));
   }
 
   /**

glean/src/core/metrics/events_database/recorded_event.ts

@@ -48,6 +48,20 @@ export class RecordedEvent {
     );
   }
 
+  private static withTransformedExtras(
+    e: RecordedEvent,
+    transformFn: (extras: ExtraMap) => ExtraMap
+  ): RecordedEvent {
+    const extras = e.extra || {};
+    const transformedExtras = transformFn(extras);
+    return new RecordedEvent(
+      e.category,
+      e.name,
+      e.timestamp,
+      (transformedExtras && Object.keys(transformedExtras).length > 0) ? transformedExtras : undefined
+    );
+  }
+
   /**
    * Add another extra key to a RecordedEvent object.
    *
@@ -69,19 +83,38 @@ export class RecordedEvent {
    * @returns A new RecordedEvent object.
    */
   withoutReservedExtras(): RecordedEvent {
-    const extras = this.extra || {};
-    const filteredExtras = Object.keys(extras)
-      .filter(key => !GLEAN_RESERVED_EXTRA_KEYS.includes(key))
-      .reduce((obj: ExtraMap, key) => {
-        obj[key] = extras[key];
-        return obj;
-      }, {});
+    return RecordedEvent.withTransformedExtras(
+      this,
+      (extras: ExtraMap): ExtraMap => {
+        return Object.keys(extras)
+        .filter(key => !GLEAN_RESERVED_EXTRA_KEYS.includes(key))
+        .reduce((obj: ExtraMap, key) => {
+          obj[key] = extras[key];
+          return obj;
+        }, {});
+      }
+    );
+  }
 
-    return new RecordedEvent(
-      this.category,
-      this.name,
-      this.timestamp,
-      (filteredExtras && Object.keys(filteredExtras).length > 0) ? filteredExtras : undefined
+  /**
+   * Generate a new RecordedEvent object,
+   * in the format expected on ping payloads.
+   *
+   * Strips reserved extra keys
+   * and stringifies all event extras.
+   *
+   * @returns A new RecordedEvent object.
+   */
+  payload(): RecordedEvent {
+    return RecordedEvent.withTransformedExtras(
+      this.withoutReservedExtras(),
+      (extras: ExtraMap): ExtraMap => {
+        return Object.keys(extras)
+          .reduce((extra: Record<string, string>, key) => {
+            extra[key] = extras[key].toString();
+            return extra;
+          }, {});
+      }
     );
   }
 }

glean/tests/integration/schema/metrics.yaml

@@ -139,9 +139,15 @@ for_testing:
     send_in_pings:
       - testing
     extra_keys:
-      sample:
-        description: |
-          Sample extra key.
+      sample_string:
+        description: Sample string extra key.
+        type: string
+      sample_boolean:
+        description: Sample boolean extra key.
+        type: boolean
+      sample_quantity:
+        description: Sample quantity extra key.
+        type: quantity
   quantity:
     type: quantity
     description: |

glean/tests/integration/schema/schema.spec.ts

@@ -60,7 +60,11 @@ describe("schema", function() {
     metrics.boolean.set(false);
     metrics.counter.add(10);
     metrics.datetime.set();
-    metrics.event.record({ sample: "hey" });
+    metrics.event.record({
+      sample_string: "hey",
+      sample_boolean: false,
+      sample_quantity: 42,
+    });
     metrics.labeledBoolean["a_label"].set(true);
     metrics.labeledCounter["a_label"].add();
     metrics.labeledString["a_label"].set("ho");