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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
// We are forcing the actors to shutdown while queries are unresolved.
const { PromiseTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/PromiseTestUtils.sys.mjs"
);
PromiseTestUtils.allowMatchingRejectionsGlobally(
/Actor 'MessageHandlerFrame' destroyed before query 'MessageHandlerFrameParent:sendCommand' was resolved/
);
// The tests in this file assert the retry behavior for MessageHandler commands.
// We call "blocked" commands from resources/modules/windowglobal/retry.jsm and
// then trigger reload and navigations to simulate AbortErrors and force the
// MessageHandler to retry the commands, when possible.
// Test that without retry behavior, a pending command rejects when the
// underlying JSWindowActor pair is destroyed.
add_task(async function test_no_retry() {
const tab = BrowserTestUtils.addTab(
gBrowser,
"https://example.com/document-builder.sjs?html=tab"
);
await BrowserTestUtils.browserLoaded(tab.linkedBrowser);
const browsingContext = tab.linkedBrowser.browsingContext;
const rootMessageHandler = createRootMessageHandler("session-id-no-retry");
try {
info("Call a module method which will throw");
const onBlockedOneTime = rootMessageHandler.handleCommand({
moduleName: "retry",
commandName: "blockedOneTime",
destination: {
type: WindowGlobalMessageHandler.type,
id: browsingContext.id,
},
});
// Reloading the tab will reject the pending query with an AbortError.
await BrowserTestUtils.reloadTab(tab);
await Assert.rejects(
onBlockedOneTime,
e => e.name == "AbortError",
"Caught the expected abort error when reloading"
);
} finally {
await cleanup(rootMessageHandler, tab);
}
});
// Test various commands, which all need a different number of "retries" to
// succeed. Check that they only resolve when the expected number of "retries"
// was reached. For commands which require more "retries" than we allow, check
// that we still fail with an AbortError once all the attempts are consumed.
add_task(async function test_retry() {
const tab = BrowserTestUtils.addTab(
gBrowser,
"https://example.com/document-builder.sjs?html=tab"
);
await BrowserTestUtils.browserLoaded(tab.linkedBrowser);
const browsingContext = tab.linkedBrowser.browsingContext;
const rootMessageHandler = createRootMessageHandler("session-id-retry");
try {
// This command will return if called twice.
const onBlockedOneTime = rootMessageHandler.handleCommand({
moduleName: "retry",
commandName: "blockedOneTime",
destination: {
type: WindowGlobalMessageHandler.type,
id: browsingContext.id,
},
params: {
foo: "bar",
},
retryOnAbort: true,
});
// This command will return if called three times.
const onBlockedTenTimes = rootMessageHandler.handleCommand({
moduleName: "retry",
commandName: "blockedTenTimes",
destination: {
type: WindowGlobalMessageHandler.type,
id: browsingContext.id,
},
params: {
foo: "baz",
},
retryOnAbort: true,
});
// This command will return if called twelve times, which is greater than the
// maximum amount of retries allowed.
const onBlockedElevenTimes = rootMessageHandler.handleCommand({
moduleName: "retry",
commandName: "blockedElevenTimes",
destination: {
type: WindowGlobalMessageHandler.type,
id: browsingContext.id,
},
retryOnAbort: true,
});
info("Reload one time");
await BrowserTestUtils.reloadTab(tab);
info("blockedOneTime should resolve on the first retry");
let { callsToCommand, foo } = await onBlockedOneTime;
is(
callsToCommand,
2,
"The command was called twice (initial call + 1 retry)"
);
is(foo, "bar", "The parameter was sent when the command was retried");
// We already reloaded 1 time. Reload 9 more times to unblock blockedTenTimes.
for (let i = 2; i < 11; i++) {
info("blockedTenTimes/blockedElevenTimes should not have resolved yet");
ok(!(await hasPromiseResolved(onBlockedTenTimes)));
ok(!(await hasPromiseResolved(onBlockedElevenTimes)));
info(`Reload the tab (time: ${i})`);
await BrowserTestUtils.reloadTab(tab);
}
info("blockedTenTimes should resolve on the 10th reload");
({ callsToCommand, foo } = await onBlockedTenTimes);
is(
callsToCommand,
11,
"The command was called 11 times (initial call + 10 retry)"
);
is(foo, "baz", "The parameter was sent when the command was retried");
info("Reload one more time");
await BrowserTestUtils.reloadTab(tab);
info(
"The call to blockedElevenTimes now exceeds the maximum attempts allowed"
);
await Assert.rejects(
onBlockedElevenTimes,
e => e.name == "AbortError",
"Caught the expected abort error when reloading"
);
} finally {
await cleanup(rootMessageHandler, tab);
}
});
// Test cross-group navigations to check that the retry mechanism will
// transparently switch to the new Browsing Context created by the cross-group
// navigation.
add_task(async function test_retry_cross_group() {
const tab = BrowserTestUtils.addTab(
gBrowser,
"https://example.com/document-builder.sjs?html=COM" +
// Attach an unload listener to prevent the page from going into bfcache,
// so that pending queries will be rejected with an AbortError.
"<script type='text/javascript'>window.onunload = function() {};</script>"
);
await BrowserTestUtils.browserLoaded(tab.linkedBrowser);
const browsingContext = tab.linkedBrowser.browsingContext;
const rootMessageHandler = createRootMessageHandler(
"session-id-retry-cross-group"
);
try {
// This command hangs and only returns if the current domain is example.net.
// We send the command while on example.com, perform a series of reload and
// navigations, and the retry mechanism should allow onBlockedOnNetDomain to
// resolve.
const onBlockedOnNetDomain = rootMessageHandler.handleCommand({
moduleName: "retry",
commandName: "blockedOnNetDomain",
destination: {
type: WindowGlobalMessageHandler.type,
id: browsingContext.id,
},
params: {
foo: "bar",
},
retryOnAbort: true,
});
info("Reload one time");
await BrowserTestUtils.reloadTab(tab);
info("blockedOnNetDomain should not have resolved yet");
ok(!(await hasPromiseResolved(onBlockedOnNetDomain)));
info(
"Navigate to example.net with COOP headers to destroy browsing context"
);
await loadURL(
tab.linkedBrowser,
"https://example.net/document-builder.sjs?headers=Cross-Origin-Opener-Policy:same-origin&html=NET"
);
info("blockedOnNetDomain should resolve now");
let { foo } = await onBlockedOnNetDomain;
is(foo, "bar", "The parameter was sent when the command was retried");
} finally {
await cleanup(rootMessageHandler, tab);
}
});
async function cleanup(rootMessageHandler, tab) {
const browsingContext = tab.linkedBrowser.browsingContext;
// Cleanup global JSM state in the test module.
await rootMessageHandler.handleCommand({
moduleName: "retry",
commandName: "cleanup",
destination: {
type: WindowGlobalMessageHandler.type,
id: browsingContext.id,
},
});
rootMessageHandler.destroy();
gBrowser.removeTab(tab);
}
|
