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
|
/**
* Bug 1247843 - A test case for testing whether the channel used to load favicon
* has correct classFlags.
* Note that this test is modified based on browser_favicon_userContextId.js.
*/
const CC = Components.Constructor;
// eslint-disable-next-line @microsoft/sdl/no-insecure-url
const TEST_SITE = "http://example.net";
const TEST_THIRD_PARTY_SITE = "http://mochi.test:8888";
const TEST_PAGE =
TEST_SITE + "/browser/browser/base/content/test/favicons/file_favicon.html";
const FAVICON_URI =
TEST_SITE + "/browser/browser/base/content/test/favicons/file_favicon.png";
const TEST_THIRD_PARTY_PAGE =
TEST_SITE +
"/browser/browser/base/content/test/favicons/file_favicon_thirdParty.html";
const THIRD_PARTY_FAVICON_URI =
TEST_THIRD_PARTY_SITE +
"/browser/browser/base/content/test/favicons/file_favicon.png";
ChromeUtils.defineESModuleGetters(this, {
PlacesTestUtils: "resource://testing-common/PlacesTestUtils.sys.mjs",
PromiseUtils: "resource://gre/modules/PromiseUtils.sys.mjs",
});
let systemPrincipal = Services.scriptSecurityManager.getSystemPrincipal();
function clearAllImageCaches() {
var tools = Cc["@mozilla.org/image/tools;1"].getService(Ci.imgITools);
var imageCache = tools.getImgCacheForDocument(window.document);
imageCache.clearCache(true); // true=chrome
imageCache.clearCache(false); // false=content
}
function clearAllPlacesFavicons() {
return new Promise(resolve => {
Services.obs.addObserver(function observer() {
Services.obs.removeObserver(observer, "places-favicons-expired");
resolve();
}, "places-favicons-expired");
PlacesUtils.favicons.expireAllFavicons();
});
}
function FaviconObserver(aPageURI, aFaviconURL, aTailingEnabled) {
this.reset(aPageURI, aFaviconURL, aTailingEnabled);
}
FaviconObserver.prototype = {
observe(aSubject, aTopic, aData) {
// Make sure that the topic is 'http-on-modify-request'.
if (aTopic === "http-on-modify-request") {
let httpChannel = aSubject.QueryInterface(Ci.nsIHttpChannel);
let reqLoadInfo = httpChannel.loadInfo;
// Make sure this is a favicon request.
if (httpChannel.URI.spec !== this._faviconURL) {
return;
}
let cos = aSubject.QueryInterface(Ci.nsIClassOfService);
if (!cos) {
ok(false, "Http channel should implement nsIClassOfService.");
return;
}
if (!reqLoadInfo) {
ok(false, "Should have load info.");
return;
}
let haveTailFlag = !!(cos.classFlags & Ci.nsIClassOfService.Tail);
info("classFlags=" + cos.classFlags);
is(haveTailFlag, this._tailingEnabled, "Should have correct cos flag.");
} else {
ok(false, "Received unexpected topic: ", aTopic);
}
this._faviconLoaded.resolve();
},
reset(aPageURI, aFaviconURL, aTailingEnabled) {
this._faviconURL = aFaviconURL;
this._faviconLoaded = PromiseUtils.defer();
this._tailingEnabled = aTailingEnabled;
},
get promise() {
return this._faviconLoaded.promise;
},
};
function waitOnFaviconLoaded(aFaviconURL) {
return PlacesTestUtils.waitForNotification("favicon-changed", events =>
events.some(e => e.faviconUrl == aFaviconURL)
);
}
async function doTest(aTestPage, aFaviconURL, aTailingEnabled) {
let pageURI = Services.io.newURI(aTestPage);
// Create the observer object for observing favion channels.
let observer = new FaviconObserver(pageURI, aFaviconURL, aTailingEnabled);
let promiseWaitOnFaviconLoaded = waitOnFaviconLoaded(aFaviconURL);
// Add the observer earlier in case we miss it.
Services.obs.addObserver(observer, "http-on-modify-request");
// Open the tab.
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser, aTestPage);
// Waiting for favicon requests are all made.
await observer.promise;
// Waiting for favicon loaded.
await promiseWaitOnFaviconLoaded;
Services.obs.removeObserver(observer, "http-on-modify-request");
// Close the tab.
BrowserTestUtils.removeTab(tab);
}
async function setupTailingPreference(aTailingEnabled) {
await SpecialPowers.pushPrefEnv({
set: [["network.http.tailing.enabled", aTailingEnabled]],
});
}
async function cleanup() {
// Clear all cookies.
Services.cookies.removeAll();
// Clear cache.
Services.cache2.clear();
// Clear Places favicon caches.
await clearAllPlacesFavicons();
// Clear all image caches and network caches.
clearAllImageCaches();
// Clear Places history.
await PlacesUtils.history.clear();
}
// A clean up function to prevent affecting other tests.
registerCleanupFunction(async () => {
await cleanup();
});
add_task(async function test_favicon_with_tailing_enabled() {
await cleanup();
let tailingEnabled = true;
await setupTailingPreference(tailingEnabled);
await doTest(TEST_PAGE, FAVICON_URI, tailingEnabled);
});
add_task(async function test_favicon_with_tailing_disabled() {
await cleanup();
let tailingEnabled = false;
await setupTailingPreference(tailingEnabled);
await doTest(TEST_THIRD_PARTY_PAGE, THIRD_PARTY_FAVICON_URI, tailingEnabled);
});
|
