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
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
add_setup(async function () {
// The page action button is hidden by default.
// This tests the use of pageAction when the button is visible.
//
// TODO(Bug 1704171): this should technically be removed in a follow up
// and the tests in this file adapted to keep into account that:
// - The pageAction is pinned on the urlbar by default
// when shown, and hidden when is not available (same for the
// overflow menu when enabled)
BrowserPageActions.mainButtonNode.style.visibility = "visible";
registerCleanupFunction(() => {
BrowserPageActions.mainButtonNode.style.removeProperty("visibility");
});
});
async function test_clickData(testAsNonPersistent = false) {
let extension = ExtensionTestUtils.loadExtension({
manifest: {
page_action: {},
background: {
persistent: !testAsNonPersistent,
scripts: ["background.js"],
},
},
files: {
"background.js": async function background() {
function onClicked(_tab, info) {
let button = info.button;
let modifiers = info.modifiers;
browser.test.sendMessage("onClick", { button, modifiers });
}
browser.pageAction.onClicked.addListener(onClicked);
let [tab] = await browser.tabs.query({
active: true,
currentWindow: true,
});
await browser.pageAction.show(tab.id);
browser.test.sendMessage("ready");
},
},
});
const map = {
shiftKey: "Shift",
altKey: "Alt",
metaKey: "Command",
ctrlKey: "Ctrl",
};
function assertSingleModifier(info, modifier) {
if (modifier === "ctrlKey" && AppConstants.platform === "macosx") {
is(
info.modifiers.length,
2,
`MacCtrl modifier with control click on Mac`
);
is(
info.modifiers[1],
"MacCtrl",
`MacCtrl modifier with control click on Mac`
);
} else {
is(
info.modifiers.length,
1,
`No unnecessary modifiers for exactly one key on event`
);
}
is(info.modifiers[0], map[modifier], `Correct modifier on click event`);
}
async function testClickPageAction(doClick, doEnterKey) {
for (let modifier of Object.keys(map)) {
for (let i = 0; i < 2; i++) {
let clickEventData = { button: i };
clickEventData[modifier] = true;
await doClick(extension, window, clickEventData);
let info = await extension.awaitMessage("onClick");
is(info.button, i, `Correct button on click event`);
assertSingleModifier(info, modifier);
}
let keypressEventData = {};
keypressEventData[modifier] = true;
await doEnterKey(extension, keypressEventData);
let info = await extension.awaitMessage("onClick");
is(info.button, 0, `Key command emulates left click`);
assertSingleModifier(info, modifier);
}
}
await extension.startup();
await extension.awaitMessage("ready");
if (testAsNonPersistent) {
assertPersistentListeners(extension, "pageAction", "onClicked", {
primed: false,
});
info("Terminating the background event page");
await extension.terminateBackground();
assertPersistentListeners(extension, "pageAction", "onClicked", {
primed: true,
});
}
info("Clicking the pageAction");
await testClickPageAction(clickPageAction, triggerPageActionWithKeyboard);
if (testAsNonPersistent) {
await extension.awaitMessage("ready");
assertPersistentListeners(extension, "pageAction", "onClicked", {
primed: false,
});
}
await testClickPageAction(
clickPageActionInPanel,
triggerPageActionWithKeyboardInPanel
);
await extension.unload();
}
async function test_clickData_reset(testAsNonPersistent = false) {
let extension = ExtensionTestUtils.loadExtension({
manifest: {
browser_action: {
default_area: "navbar",
},
page_action: {},
background: {
persistent: !testAsNonPersistent,
scripts: ["background.js"],
},
},
files: {
"background.js": async function background() {
function onBrowserActionClicked(tab, info) {
// openPopup requires user interaction, such as a browser action click.
browser.pageAction.openPopup();
}
function onPageActionClicked(tab, info) {
browser.test.sendMessage("onClick", info);
}
browser.browserAction.onClicked.addListener(onBrowserActionClicked);
browser.pageAction.onClicked.addListener(onPageActionClicked);
let [tab] = await browser.tabs.query({
active: true,
currentWindow: true,
});
await browser.pageAction.show(tab.id);
browser.test.sendMessage("ready");
},
},
});
async function clickPageActionWithModifiers() {
await clickPageAction(extension, window, { button: 1, shiftKey: true });
let info = await extension.awaitMessage("onClick");
is(info.button, 1);
is(info.modifiers[0], "Shift");
}
function assertInfoReset(info) {
is(info.button, 0, `ClickData button reset properly`);
is(info.modifiers.length, 0, `ClickData modifiers reset properly`);
}
await extension.startup();
await extension.awaitMessage("ready");
if (testAsNonPersistent) {
assertPersistentListeners(extension, "pageAction", "onClicked", {
primed: false,
});
info("Terminating the background event page");
await extension.terminateBackground();
assertPersistentListeners(extension, "pageAction", "onClicked", {
primed: true,
});
}
info("Clicking the pageAction");
await clickPageActionWithModifiers();
if (testAsNonPersistent) {
await extension.awaitMessage("ready");
assertPersistentListeners(extension, "pageAction", "onClicked", {
primed: false,
});
}
await clickBrowserAction(extension);
assertInfoReset(await extension.awaitMessage("onClick"));
await clickPageActionWithModifiers();
await triggerPageActionWithKeyboard(extension);
assertInfoReset(await extension.awaitMessage("onClick"));
await extension.unload();
}
add_task(function test_clickData_MV2() {
return test_clickData(/* testAsNonPersistent */ false);
});
add_task(async function test_clickData_MV2_eventPage() {
await SpecialPowers.pushPrefEnv({
set: [["extensions.eventPages.enabled", true]],
});
await test_clickData(/* testAsNonPersistent */ true);
await SpecialPowers.popPrefEnv();
});
add_task(function test_clickData_reset_MV2() {
return test_clickData_reset(/* testAsNonPersistent */ false);
});
add_task(async function test_clickData_reset_MV2_eventPage() {
await SpecialPowers.pushPrefEnv({
set: [["extensions.eventPages.enabled", true]],
});
await test_clickData_reset(/* testAsNonPersistent */ true);
await SpecialPowers.popPrefEnv();
});
|
