summaryrefslogtreecommitdiffstats
path: root/browser/components/newtab/test/xpcshell/test_PanelTestProvider.js
blob: d5c5c19f0c9d766e28161951d4e8fa46697c4483 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

const { PanelTestProvider } = ChromeUtils.importESModule(
  "resource://activity-stream/lib/PanelTestProvider.sys.mjs"
);

const MESSAGE_VALIDATORS = {};
let EXPERIMENT_VALIDATOR;

add_setup(async function setup() {
  const validators = await makeValidators();

  EXPERIMENT_VALIDATOR = validators.experimentValidator;
  Object.assign(MESSAGE_VALIDATORS, validators.messageValidators);
});

add_task(async function test_PanelTestProvider() {
  const messages = await PanelTestProvider.getMessages();

  const EXPECTED_MESSAGE_COUNTS = {
    cfr_doorhanger: 1,
    milestone_message: 0,
    update_action: 1,
    whatsnew_panel_message: 7,
    spotlight: 2,
    pb_newtab: 2,
    toast_notification: 2,
  };

  const EXPECTED_TOTAL_MESSAGE_COUNT = Object.values(
    EXPECTED_MESSAGE_COUNTS
  ).reduce((a, b) => a + b, 0);

  Assert.strictEqual(
    messages.length,
    EXPECTED_TOTAL_MESSAGE_COUNT,
    "PanelTestProvider should have the correct number of messages"
  );

  const messageCounts = Object.assign(
    {},
    ...Object.keys(EXPECTED_MESSAGE_COUNTS).map(key => ({ [key]: 0 }))
  );

  for (const message of messages) {
    const validator = MESSAGE_VALIDATORS[message.template];
    Assert.ok(
      typeof validator !== "undefined",
      typeof validator !== "undefined"
        ? `Schema validator found for ${message.template}`
        : `No schema validator found for template ${message.template}. Please update this test to add one.`
    );
    assertValidates(
      validator,
      message,
      `Message ${message.id} validates as ${message.template} template`
    );
    assertValidates(
      EXPERIMENT_VALIDATOR,
      message,
      `Message ${message.id} validates as MessagingExperiment`
    );

    messageCounts[message.template]++;
  }

  for (const [template, count] of Object.entries(messageCounts)) {
    Assert.equal(
      count,
      EXPECTED_MESSAGE_COUNTS[template],
      `Expected ${EXPECTED_MESSAGE_COUNTS[template]} ${template} messages`
    );
  }
});

add_task(async function test_emptyMessage() {
  info(
    "Testing blank FxMS messages validate with the Messaging Experiment schema"
  );

  assertValidates(EXPERIMENT_VALIDATOR, {}, "Empty message should validate");
});