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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
const { ASRouter } = ChromeUtils.import(
"resource://activity-stream/lib/ASRouter.jsm"
);
const { RemoteSettings } = ChromeUtils.importESModule(
"resource://services-settings/remote-settings.sys.mjs"
);
const { CFRMessageProvider } = ChromeUtils.importESModule(
"resource://activity-stream/lib/CFRMessageProvider.sys.mjs"
);
const { CFRPageActions } = ChromeUtils.import(
"resource://activity-stream/lib/CFRPageActions.jsm"
);
/**
* Load and modify a message for the test.
*/
add_setup(async function () {
const initialMsgCount = ASRouter.state.messages.length;
const heartbeatMsg = (await CFRMessageProvider.getMessages()).find(
m => m.id === "HEARTBEAT_TACTIC_2"
);
const testMessage = {
...heartbeatMsg,
groups: ["messaging-experiments"],
targeting: "true",
// Ensure no overlap due to frequency capping with other tests
id: `HEARTBEAT_MESSAGE_${Date.now()}`,
};
const client = RemoteSettings("cfr");
await client.db.importChanges({}, Date.now(), [testMessage], {
clear: true,
});
// Force the CFR provider cache to 0 by modifying updateCycleInMs
await SpecialPowers.pushPrefEnv({
set: [
[
"browser.newtabpage.activity-stream.asrouter.providers.cfr",
`{"id":"cfr","enabled":true,"type":"remote-settings","collection":"cfr","updateCycleInMs":0}`,
],
],
});
// Reload the providers
await ASRouter._updateMessageProviders();
await ASRouter.loadMessagesFromAllProviders();
await BrowserTestUtils.waitForCondition(
() => ASRouter.state.messages.length > initialMsgCount,
"Should load the extra heartbeat message"
);
BrowserTestUtils.waitForCondition(
() => ASRouter.state.messages.find(m => m.id === testMessage.id),
"Wait to load the message"
);
const msg = ASRouter.state.messages.find(m => m.id === testMessage.id);
Assert.equal(msg.targeting, "true");
Assert.equal(msg.groups[0], "messaging-experiments");
registerCleanupFunction(async () => {
await client.db.clear();
// Reload the providers
await ASRouter._updateMessageProviders();
await ASRouter.loadMessagesFromAllProviders();
await BrowserTestUtils.waitForCondition(
() => ASRouter.state.messages.length === initialMsgCount,
"Should reset messages"
);
await SpecialPowers.popPrefEnv();
});
});
/**
* Test group frequency capping.
* Message has a lifetime frequency of 3 but it's group has a lifetime frequency
* of 2. It should only show up twice.
* We update the provider to remove any daily limitations so it should show up
* on every new tab load.
*/
add_task(async function test_heartbeat_tactic_2() {
const TEST_URL = "http://example.com";
const msg = ASRouter.state.messages.find(m =>
m.groups.includes("messaging-experiments")
);
Assert.ok(msg, "Message found");
const groupConfiguration = {
id: "messaging-experiments",
enabled: true,
frequency: { lifetime: 2 },
};
const client = RemoteSettings("message-groups");
await client.db.importChanges({}, Date.now(), [groupConfiguration], {
clear: true,
});
// Force the WNPanel provider cache to 0 by modifying updateCycleInMs
await SpecialPowers.pushPrefEnv({
set: [
[
"browser.newtabpage.activity-stream.asrouter.providers.message-groups",
`{"id":"message-groups","enabled":true,"type":"remote-settings","collection":"message-groups","updateCycleInMs":0}`,
],
],
});
await BrowserTestUtils.waitForCondition(async () => {
const msgs = await client.get();
return msgs.find(m => m.id === groupConfiguration.id);
}, "Wait for RS message");
// Reload the providers
await ASRouter._updateMessageProviders();
await ASRouter.loadAllMessageGroups();
let groupState = await BrowserTestUtils.waitForCondition(
() => ASRouter.state.groups.find(g => g.id === groupConfiguration.id),
"Wait for group config to load"
);
Assert.ok(groupState, "Group config found");
Assert.ok(groupState.enabled, "Group is enabled");
let tab1 = await BrowserTestUtils.openNewForegroundTab(gBrowser, TEST_URL);
BrowserTestUtils.loadURIString(tab1.linkedBrowser, TEST_URL);
let chiclet = document.getElementById("contextual-feature-recommendation");
Assert.ok(chiclet, "CFR chiclet element found (tab1)");
await BrowserTestUtils.waitForCondition(
() => !chiclet.hidden,
"Chiclet should be visible (tab1)"
);
await BrowserTestUtils.waitForCondition(
() =>
ASRouter.state.messageImpressions[msg.id] &&
ASRouter.state.messageImpressions[msg.id].length === 1,
"First impression recorded"
);
BrowserTestUtils.removeTab(tab1);
let tab2 = await BrowserTestUtils.openNewForegroundTab(gBrowser, TEST_URL);
BrowserTestUtils.loadURIString(tab2.linkedBrowser, TEST_URL);
Assert.ok(chiclet, "CFR chiclet element found (tab2)");
await BrowserTestUtils.waitForCondition(
() => !chiclet.hidden,
"Chiclet should be visible (tab2)"
);
await BrowserTestUtils.waitForCondition(
() =>
ASRouter.state.messageImpressions[msg.id] &&
ASRouter.state.messageImpressions[msg.id].length === 2,
"Second impression recorded"
);
Assert.ok(
!ASRouter.isBelowFrequencyCaps(msg),
"Should have reached freq limit"
);
BrowserTestUtils.removeTab(tab2);
let tab3 = await BrowserTestUtils.openNewForegroundTab(gBrowser, TEST_URL);
BrowserTestUtils.loadURIString(tab3.linkedBrowser, TEST_URL);
await BrowserTestUtils.waitForCondition(
() => chiclet.hidden,
"Heartbeat button should be hidden"
);
Assert.equal(
ASRouter.state.messageImpressions[msg.id] &&
ASRouter.state.messageImpressions[msg.id].length,
2,
"Number of impressions did not increase"
);
BrowserTestUtils.removeTab(tab3);
info("Cleanup");
await client.db.clear();
// Reset group impressions
await ASRouter.resetGroupsState();
// Reload the providers
await ASRouter._updateMessageProviders();
await ASRouter.loadMessagesFromAllProviders();
await SpecialPowers.popPrefEnv();
CFRPageActions.clearRecommendations();
});
|
