iceweasel-start-page/test/unit/lib/UTEventReporting.test.js

import {
  UTSessionPing,
  UTTrailheadEnrollPing,
  UTUserEventPing,
} from "test/schemas/pings";
import {GlobalOverrider} from "test/unit/utils";
import {UTEventReporting} from "lib/UTEventReporting.jsm";

const FAKE_EVENT_PING_PC = {
  "event": "CLICK",
  "source": "TOP_SITES",
  "addon_version": "123",
  "user_prefs": 63,
  "session_id": "abc",
  "page": "about:newtab",
  "action_position": 5,
  "locale": "en-US",
};
const FAKE_SESSION_PING_PC = {
  "session_duration": 1234,
  "addon_version": "123",
  "user_prefs": 63,
  "session_id": "abc",
  "page": "about:newtab",
  "locale": "en-US",
};
const FAKE_EVENT_PING_UT = [
  "activity_stream", "event", "CLICK", "TOP_SITES", {
    "addon_version": "123",
    "user_prefs": "63",
    "session_id": "abc",
    "page": "about:newtab",
    "action_position": "5",
  },
];
const FAKE_SESSION_PING_UT = [
  "activity_stream", "end", "session", "1234", {
    "addon_version": "123",
    "user_prefs": "63",
    "session_id": "abc",
    "page": "about:newtab",
  },
];
const FAKE_TRAILHEAD_ENROLL_EVENT = {
  experiment: "activity-stream-trailhead-firstrun-interrupts",
  type: "as-firstrun",
  branch: "supercharge",
};
const FAKE_TRAILHEAD_ENROLL_EVENT_UT = [
  "activity_stream", "enroll", "preference_study", "activity-stream-trailhead-firstrun-interrupts", {
    experimentType: "as-firstrun",
    branch: "supercharge",
  },
];

describe("UTEventReporting", () => {
  let globals;
  let sandbox;
  let utEvents;

  beforeEach(() => {
    globals = new GlobalOverrider();
    sandbox = globals.sandbox;
    sandbox.stub(global.Services.telemetry, "setEventRecordingEnabled");
    sandbox.stub(global.Services.telemetry, "recordEvent");

    utEvents = new UTEventReporting();
  });

  afterEach(() => {
    globals.restore();
  });

  describe("#sendUserEvent()", () => {
    it("should queue up the correct data to send to Events Telemetry", async () => {
      utEvents.sendUserEvent(FAKE_EVENT_PING_PC);
      assert.calledWithExactly(global.Services.telemetry.recordEvent, ...FAKE_EVENT_PING_UT);

      let ping = global.Services.telemetry.recordEvent.firstCall.args;
      assert.validate(ping, UTUserEventPing);
    });
  });

  describe("#sendSessionEndEvent()", () => {
    it("should queue up the correct data to send to Events Telemetry", async () => {
      utEvents.sendSessionEndEvent(FAKE_SESSION_PING_PC);
      assert.calledWithExactly(global.Services.telemetry.recordEvent, ...FAKE_SESSION_PING_UT);

      let ping = global.Services.telemetry.recordEvent.firstCall.args;
      assert.validate(ping, UTSessionPing);
    });
  });

  describe("#sendTrailheadEnrollEvent()", () => {
    it("should queue up the correct data to send to Events Telemetry", async () => {
      utEvents.sendTrailheadEnrollEvent(FAKE_TRAILHEAD_ENROLL_EVENT);
      assert.calledWithExactly(global.Services.telemetry.recordEvent, ...FAKE_TRAILHEAD_ENROLL_EVENT_UT);

      let ping = global.Services.telemetry.recordEvent.firstCall.args;
      assert.validate(ping, UTTrailheadEnrollPing);
    });
  });

  describe("#uninit()", () => {
    it("should call setEventRecordingEnabled with a false value", () => {
      assert.equal(global.Services.telemetry.setEventRecordingEnabled.firstCall.args[0], "activity_stream");
      assert.equal(global.Services.telemetry.setEventRecordingEnabled.firstCall.args[1], true);

      utEvents.uninit();
      assert.equal(global.Services.telemetry.setEventRecordingEnabled.secondCall.args[0], "activity_stream");
      assert.equal(global.Services.telemetry.setEventRecordingEnabled.secondCall.args[1], false);
    });
  });
});