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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const { BaseAction } = ChromeUtils.importESModule(
"resource://normandy/actions/BaseAction.sys.mjs"
);
const { ClientEnvironment } = ChromeUtils.importESModule(
"resource://normandy/lib/ClientEnvironment.sys.mjs"
);
const { EventEmitter } = ChromeUtils.importESModule(
"resource://normandy/lib/EventEmitter.sys.mjs"
);
const { Heartbeat } = ChromeUtils.importESModule(
"resource://normandy/lib/Heartbeat.sys.mjs"
);
const { Normandy } = ChromeUtils.importESModule(
"resource://normandy/Normandy.sys.mjs"
);
const { ExperimentAPI } = ChromeUtils.importESModule(
"resource://nimbus/ExperimentAPI.sys.mjs"
);
const { ExperimentFakes } = ChromeUtils.importESModule(
"resource://testing-common/NimbusTestUtils.sys.mjs"
);
const { RecipeRunner } = ChromeUtils.importESModule(
"resource://normandy/lib/RecipeRunner.sys.mjs"
);
const { RemoteSettings } = ChromeUtils.importESModule(
"resource://services-settings/remote-settings.sys.mjs"
);
const { JsonSchema } = ChromeUtils.importESModule(
"resource://gre/modules/JsonSchema.sys.mjs"
);
const SURVEY = {
surveyId: "a survey",
message: "test message",
engagementButtonLabel: "",
thanksMessage: "thanks!",
postAnswerUrl: "https://example.com",
learnMoreMessage: "Learn More",
learnMoreUrl: "https://example.com",
repeatOption: "once",
};
// See properties.payload in
// https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/main/schemas/telemetry/heartbeat/heartbeat.4.schema.json
const PAYLOAD_SCHEMA = {
additionalProperties: false,
anyOf: [
{
required: ["closedTS"],
},
{
required: ["windowClosedTS"],
},
],
properties: {
closedTS: {
minimum: 0,
type: "integer",
},
engagedTS: {
minimum: 0,
type: "integer",
},
expiredTS: {
minimum: 0,
type: "integer",
},
flowId: {
pattern:
"^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
type: "string",
},
learnMoreTS: {
minimum: 0,
type: "integer",
},
offeredTS: {
minimum: 0,
type: "integer",
},
score: {
minimum: 1,
type: "integer",
},
surveyId: {
type: "string",
},
surveyVersion: {
pattern: "^([0-9]+|[a-fA-F0-9]{64})$",
type: "string",
},
testing: {
type: "boolean",
},
version: {
maximum: 1,
minimum: 1,
type: "number",
},
votedTS: {
minimum: 0,
type: "integer",
},
windowClosedTS: {
minimum: 0,
type: "integer",
},
},
required: ["version", "flowId", "offeredTS", "surveyId", "surveyVersion"],
type: "object",
};
function assertSurvey(actual, expected) {
for (const key of Object.keys(actual)) {
if (["flowId", "postAnswerUrl", "surveyVersion"].includes(key)) {
continue;
}
Assert.equal(
actual[key],
expected[key],
`Heartbeat should receive correct ${key} parameter`
);
}
Assert.equal(actual.surveyVersion, "1");
Assert.ok(actual.postAnswerUrl.startsWith(expected.postAnswerUrl));
}
decorate_task(
withStubbedHeartbeat(),
withClearStorage(),
async function testLegacyHeartbeatTrigger({ heartbeatClassStub }) {
const sandbox = sinon.createSandbox();
const cleanupEnrollment = await ExperimentFakes.enrollWithFeatureConfig({
featureId: "legacyHeartbeat",
value: {
survey: SURVEY,
},
});
const client = RemoteSettings("normandy-recipes-capabilities");
sandbox.stub(client, "get").resolves([]);
try {
await RecipeRunner.run();
Assert.equal(
heartbeatClassStub.args.length,
1,
"Heartbeat should be instantiated once"
);
assertSurvey(heartbeatClassStub.args[0][1], SURVEY);
await cleanupEnrollment();
} finally {
sandbox.restore();
}
}
);
decorate_task(
withClearStorage(),
async function testLegacyHeartbeatPingPayload() {
const sandbox = sinon.createSandbox();
const cleanupEnrollment = await ExperimentFakes.enrollWithFeatureConfig({
featureId: "legacyHeartbeat",
value: {
survey: SURVEY,
},
});
const client = RemoteSettings("normandy-recipes-capabilities");
sandbox.stub(client, "get").resolves([]);
// Override Heartbeat so we can get the instance and manipulate it directly.
const heartbeatDeferred = Promise.withResolvers();
class TestHeartbeat extends Heartbeat {
constructor(...args) {
super(...args);
heartbeatDeferred.resolve(this);
}
}
ShowHeartbeatAction.overrideHeartbeatForTests(TestHeartbeat);
try {
await RecipeRunner.run();
const heartbeat = await heartbeatDeferred.promise;
// We are going to simulate the timer timing out, so we do not want it to
// *actually* time out.
heartbeat.endTimerIfPresent("surveyEndTimer");
const notice = await heartbeat.noticePromise;
await notice.updateComplete;
const telemetrySentPromise = new Promise(resolve => {
heartbeat.eventEmitter.once("TelemetrySent", payload =>
resolve(payload)
);
});
// This method would be triggered when the timer timed out. This will
// trigger telemetry to be submitted.
heartbeat.close();
const payload = await telemetrySentPromise;
const result = JsonSchema.validate(payload, PAYLOAD_SCHEMA);
Assert.ok(result.valid);
Assert.equal(payload.surveyVersion, "1");
await cleanupEnrollment();
} finally {
ShowHeartbeatAction.overrideHeartbeatForTests();
sandbox.restore();
}
}
);
|
