Trigger the afterPingCollection event at the expected time

Author: brizental

glean/src/core/pings/database.ts

@@ -42,10 +42,9 @@ export interface PingPayload extends JSONObject {
   metrics?: MetricsPayload,
   events?: JSONArray,
 }
-
 export interface PingInternalRepresentation extends JSONObject {
   path: string,
-  payload: PingPayload,
+  payload: JSONObject,
   headers?: Record<string, string>
 }
 
@@ -117,7 +116,7 @@ class PingsDatabase {
   async recordPing(
     path: string,
     identifier: string,
-    payload: PingPayload,
+    payload: JSONObject,
     headers?: Record<string, string>
   ): Promise<void> {
     const ping: PingInternalRepresentation = {

glean/src/core/pings/maker.ts

@@ -10,6 +10,8 @@ import TimeUnit from "../metrics/time_unit";
 import { ClientInfo, PingInfo, PingPayload } from "../pings/database";
 import PingType from "../pings";
 import Glean from "../glean";
+import CoreEvents from "../events";
+import { JSONObject } from "../utils";
 
 // The moment the current Glean.js session started.
 const GLEAN_START_TIME = new Date();
@@ -206,27 +208,35 @@ function makePath(identifier: string, ping: PingType): string {
 /**
  * Collects and stores a ping on the pings database.
  *
+ * This function will trigger the `AfterPingCollection` event.
+ * This event is triggered **after** logging the ping, which happens if `logPings` is set.
+ * We will log the payload before it suffers any change by plugins instrumenting this event.
+ *
  * @param identifier The pings UUID identifier.
  * @param ping The ping to submit.
  * @param reason An optional reason code to include in the ping.
  *
  * @returns A promise that is resolved once collection and storing is done.
  */
 export async function collectAndStorePing(identifier: string, ping: PingType, reason?: string): Promise<void> {
-  const payload = await collectPing(ping, reason);
-  if (!payload) {
+  const collectedPayload = await collectPing(ping, reason);
+  if (!collectedPayload) {
     return;
   }
 
   if (Glean.logPings) {
-    console.info(JSON.stringify(payload, null, 2));
+    console.info(JSON.stringify(collectedPayload, null, 2));
   }
 
   const headers = getPingHeaders();
+
+  const modifiedPayload = await CoreEvents.afterPingCollection.trigger(collectedPayload);
+  const finalPayload = modifiedPayload ? modifiedPayload : collectedPayload;
+
   return Glean.pingsDatabase.recordPing(
     makePath(identifier, ping),
     identifier,
-    payload,
+    finalPayload,
     headers
   );
 }

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

@@ -3,16 +3,27 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import assert from "assert";
+import sinon from "sinon";
 
 import PingType from "../../../src/core/pings";
 import * as PingMaker from "../../../src/core/pings/maker";
 import Glean from "../../../src/core/glean";
+import CoreEvents from "../../../src/core/events";
+import Plugin from "../../../src/plugins";
+import { PingPayload } from "../../../src/core/pings/database";
+import { JSONObject } from "../../../src/core/utils";
+
+const sandbox = sinon.createSandbox();
 
 describe("PingMaker", function() {
   beforeEach(async function() {
     await Glean.testResetGlean("something something");
   });
 
+  afterEach(function () {
+    sandbox.restore();
+  });
+
   it("ping info must contain a non-empty start and end time", async function() {
     const ping = new PingType({
       name: "custom",
@@ -100,4 +111,38 @@ describe("PingMaker", function() {
     assert.strictEqual(await PingMaker.getSequenceNumber(ping2), 11);
     assert.strictEqual(await PingMaker.getSequenceNumber(ping1), 13);
   });
+
+  it("collect and store triggers the AfterPingCollection and deals with possible result correctly", async function () {
+    // Disable ping uploading for it not to interfere with this tests.
+    sandbox.stub(Glean["pingUploader"], "triggerUpload").callsFake(() => Promise.resolve());
+
+    class MockPlugin extends Plugin<typeof CoreEvents["afterPingCollection"]> {
+      constructor() {
+        super(CoreEvents["afterPingCollection"].name, "mockPlugin");
+      }
+
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      action(_payload: PingPayload): Promise<JSONObject> {
+        return Promise.resolve({ "you": "got mocked!" });
+      }
+    }
+
+    await Glean.testUninitialize();
+    await Glean.testInitialize("something something", true, { plugins: [ new MockPlugin() ]});
+    const ping = new PingType({
+      name: "ping",
+      includeClientId: true,
+      sendIfEmpty: true,
+    });
+
+    await PingMaker.collectAndStorePing("ident", ping);
+    const recordedPing = (await Glean.pingsDatabase.getAllPings())["ident"];
+    assert.deepStrictEqual(recordedPing.payload, { "you": "got mocked!" });
+
+    await Glean.testUninitialize();
+    await Glean.testInitialize("something something", true);
+    await PingMaker.collectAndStorePing("ident", ping);
+    const recordedPingNoPlugin = (await Glean.pingsDatabase.getAllPings())["ident"];
+    assert.notDeepStrictEqual(recordedPingNoPlugin.payload, { "you": "got mocked!" });
+  });
 });