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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
ChromeUtils.defineESModuleGetters(this, {
TelemetryTestUtils: "resource://testing-common/TelemetryTestUtils.sys.mjs",
});
const { MacAttribution } = ChromeUtils.importESModule(
"resource:///modules/MacAttribution.sys.mjs"
);
const { AttributionIOUtils } = ChromeUtils.importESModule(
"resource:///modules/AttributionCode.sys.mjs"
);
const { sinon } = ChromeUtils.importESModule(
"resource://testing-common/Sinon.sys.mjs"
);
async function assertCacheExistsAndIsEmpty() {
// We should have written to the cache, and be able to read back
// with no errors.
const histogram = Services.telemetry.getHistogramById(
"BROWSER_ATTRIBUTION_ERRORS"
);
histogram.clear();
ok(await AttributionIOUtils.exists(AttributionCode.attributionFile.path));
Assert.deepEqual(
"",
new TextDecoder().decode(
await AttributionIOUtils.read(AttributionCode.attributionFile.path)
)
);
AttributionCode._clearCache();
let result = await AttributionCode.getAttrDataAsync();
Assert.deepEqual(result, {}, "Should be able to get cached result");
Assert.deepEqual({}, histogram.snapshot().values || {});
}
add_task(async function test_write_error() {
const sandbox = sinon.createSandbox();
let attributionSvc = Cc["@mozilla.org/mac-attribution;1"].getService(
Ci.nsIMacAttributionService
);
attributionSvc.setReferrerUrl(
MacAttribution.applicationPath,
"https://example.com?content=content",
true
);
await AttributionCode.deleteFileAsync();
AttributionCode._clearCache();
const histogram = Services.telemetry.getHistogramById(
"BROWSER_ATTRIBUTION_ERRORS"
);
let oldExists = AttributionIOUtils.exists;
let oldWrite = AttributionIOUtils.write;
try {
// Clear any existing telemetry
histogram.clear();
// Force the file to not exist and then cause a write error. This is delicate
// because various background tasks may invoke `IOUtils.writeAtomic` while
// this test is running. Be careful to only stub the one call.
AttributionIOUtils.exists = () => false;
AttributionIOUtils.write = () => {
throw new Error("write_error");
};
// Try to read the attribution code.
let result = await AttributionCode.getAttrDataAsync();
Assert.deepEqual(
result,
{ content: "content" },
"Should be able to get a result even if the file doesn't write"
);
TelemetryTestUtils.assertHistogram(histogram, INDEX_WRITE_ERROR, 1);
} finally {
AttributionIOUtils.exists = oldExists;
AttributionIOUtils.write = oldWrite;
await AttributionCode.deleteFileAsync();
AttributionCode._clearCache();
histogram.clear();
sandbox.restore();
}
});
add_task(async function test_unusual_referrer() {
// This referrer URL looks malformed, but the malformed bits are dropped, so
// it's actually ok. This is what allows extraneous bits like `fbclid` tags
// to be ignored.
let attributionSvc = Cc["@mozilla.org/mac-attribution;1"].getService(
Ci.nsIMacAttributionService
);
attributionSvc.setReferrerUrl(
MacAttribution.applicationPath,
"https://example.com?content=&=campaign",
true
);
await AttributionCode.deleteFileAsync();
AttributionCode._clearCache();
const histogram = Services.telemetry.getHistogramById(
"BROWSER_ATTRIBUTION_ERRORS"
);
try {
// Clear any existing telemetry
histogram.clear();
// Try to read the attribution code
await AttributionCode.getAttrDataAsync();
let result = await AttributionCode.getAttrDataAsync();
Assert.deepEqual(result, {}, "Should be able to get empty result");
Assert.deepEqual({}, histogram.snapshot().values || {});
await assertCacheExistsAndIsEmpty();
} finally {
await AttributionCode.deleteFileAsync();
AttributionCode._clearCache();
histogram.clear();
}
});
add_task(async function test_blank_referrer() {
let attributionSvc = Cc["@mozilla.org/mac-attribution;1"].getService(
Ci.nsIMacAttributionService
);
attributionSvc.setReferrerUrl(MacAttribution.applicationPath, "", true);
await AttributionCode.deleteFileAsync();
AttributionCode._clearCache();
const histogram = Services.telemetry.getHistogramById(
"BROWSER_ATTRIBUTION_ERRORS"
);
try {
// Clear any existing telemetry
histogram.clear();
// Try to read the attribution code
let result = await AttributionCode.getAttrDataAsync();
Assert.deepEqual(result, {}, "Should be able to get empty result");
Assert.deepEqual({}, histogram.snapshot().values || {});
await assertCacheExistsAndIsEmpty();
} finally {
await AttributionCode.deleteFileAsync();
AttributionCode._clearCache();
histogram.clear();
}
});
add_task(async function test_no_referrer() {
const sandbox = sinon.createSandbox();
let newApplicationPath = MacAttribution.applicationPath + ".test";
sandbox.stub(MacAttribution, "applicationPath").get(() => newApplicationPath);
await AttributionCode.deleteFileAsync();
AttributionCode._clearCache();
const histogram = Services.telemetry.getHistogramById(
"BROWSER_ATTRIBUTION_ERRORS"
);
try {
// Clear any existing telemetry
histogram.clear();
// Try to read the attribution code
await AttributionCode.getAttrDataAsync();
let result = await AttributionCode.getAttrDataAsync();
Assert.deepEqual(result, {}, "Should be able to get empty result");
Assert.deepEqual({}, histogram.snapshot().values || {});
await assertCacheExistsAndIsEmpty();
} finally {
await AttributionCode.deleteFileAsync();
AttributionCode._clearCache();
histogram.clear();
sandbox.restore();
}
});
add_task(async function test_broken_referrer() {
let attributionSvc = Cc["@mozilla.org/mac-attribution;1"].getService(
Ci.nsIMacAttributionService
);
attributionSvc.setReferrerUrl(
MacAttribution.applicationPath,
"https://example.com?content=content",
true
);
// This uses macOS internals to change the GUID so that it will look like the
// application has quarantine data but nothing will be pressent in the
// quarantine database. This shouldn't happen in the wild.
function generateQuarantineGUID() {
let str = Services.uuid.generateUUID().toString().toUpperCase();
// Strip {}.
return str.substring(1, str.length - 1);
}
// These magic constants are macOS GateKeeper flags.
let string = [
"01c1",
"5991b778",
"Safari.app",
generateQuarantineGUID(),
].join(";");
let bytes = new TextEncoder().encode(string);
await IOUtils.setMacXAttr(
MacAttribution.applicationPath,
"com.apple.quarantine",
bytes
);
await AttributionCode.deleteFileAsync();
AttributionCode._clearCache();
const histogram = Services.telemetry.getHistogramById(
"BROWSER_ATTRIBUTION_ERRORS"
);
try {
// Clear any existing telemetry
histogram.clear();
// Try to read the attribution code
await AttributionCode.getAttrDataAsync();
let result = await AttributionCode.getAttrDataAsync();
Assert.deepEqual(result, {}, "Should be able to get empty result");
TelemetryTestUtils.assertHistogram(histogram, INDEX_QUARANTINE_ERROR, 1);
histogram.clear();
await assertCacheExistsAndIsEmpty();
} finally {
await AttributionCode.deleteFileAsync();
AttributionCode._clearCache();
histogram.clear();
}
});
|
