dom/browser-element/mochitest/browserElement_ContextmenuEvents.js@b8a032363ba2
dom/browser-element/mochitest/browserElement_ContextmenuEvents.js
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
1 'use strict';
3 SimpleTest.waitForExplicitFinish();
4 browserElementTestHelpers.setEnabledPref(true);
5 browserElementTestHelpers.addPermission();
7 let audioUrl = 'http://mochi.test:8888/tests/dom/browser-element/mochitest/audio.ogg';
8 let videoUrl = 'http://mochi.test:8888/tests/dom/browser-element/mochitest/short-video.ogv';
10 function runTests() {
11 createIframe(function onIframeLoaded() {
12 checkEmptyContextMenu();
13 });
14 }
16 function checkEmptyContextMenu() {
17 sendContextMenuTo('body', function onContextMenu(detail) {
18 is(detail.contextmenu, null, 'Body context clicks have no context menu');
20 checkInnerContextMenu();
21 });
22 }
24 function checkInnerContextMenu() {
25 sendContextMenuTo('#inner-link', function onContextMenu(detail) {
26 is(detail.systemTargets.length, 1, 'Includes anchor data');
27 is(detail.contextmenu.items.length, 2, 'Inner clicks trigger correct menu');
29 checkCustomContextMenu();
30 });
31 }
33 function checkCustomContextMenu() {
34 sendContextMenuTo('#menu1-trigger', function onContextMenu(detail) {
35 is(detail.contextmenu.items.length, 2, 'trigger custom contextmenu');
37 checkNestedContextMenu();
38 });
39 }
41 function checkNestedContextMenu() {
42 sendContextMenuTo('#menu2-trigger', function onContextMenu(detail) {
43 var innerMenu = detail.contextmenu.items.filter(function(x) {
44 return x.type === 'menu';
45 });
46 is(detail.systemTargets.length, 2, 'Includes anchor and img data');
47 ok(innerMenu.length > 0, 'Menu contains a nested menu');
49 checkPreviousContextMenuHandler();
50 });
51 }
53 // Finished testing the data passed to the contextmenu handler,
54 // now we start selecting contextmenu items
55 function checkPreviousContextMenuHandler() {
56 // This is previously triggered contextmenu data, since we have
57 // fired subsequent contextmenus this should not be mistaken
58 // for a current menuitem
59 var detail = previousContextMenuDetail;
60 var previousId = detail.contextmenu.items[0].id;
61 checkContextMenuCallbackForId(detail, previousId, function onCallbackFired(label) {
62 is(label, null, 'Callback label should be empty since this handler is old');
64 checkCurrentContextMenuHandler();
65 });
66 }
68 function checkCurrentContextMenuHandler() {
69 // This triggers a current menuitem
70 var detail = currentContextMenuDetail;
72 var innerMenu = detail.contextmenu.items.filter(function(x) {
73 return x.type === 'menu';
74 });
76 var currentId = innerMenu[0].items[1].id;
77 checkContextMenuCallbackForId(detail, currentId, function onCallbackFired(label) {
78 is(label, 'inner 2', 'Callback label should be set correctly');
80 checkAgainCurrentContextMenuHandler();
81 });
82 }
84 function checkAgainCurrentContextMenuHandler() {
85 // Once an item it selected, subsequent selections are ignored
86 var detail = currentContextMenuDetail;
88 var innerMenu = detail.contextmenu.items.filter(function(x) {
89 return x.type === 'menu';
90 });
92 var currentId = innerMenu[0].items[1].id;
93 checkContextMenuCallbackForId(detail, currentId, function onCallbackFired(label) {
94 is(label, null, 'Callback label should be empty since this handler has already been used');
96 checkCallbackWithPreventDefault();
97 });
98 };
100 // Finished testing callbacks if the embedder calls preventDefault() on the
101 // mozbrowsercontextmenu event, now we start checking for some cases where the embedder
102 // does not want to call preventDefault() for some reasons.
103 function checkCallbackWithPreventDefault() {
104 sendContextMenuTo('#menu1-trigger', function onContextMenu(detail) {
105 var id = detail.contextmenu.items[0].id;
106 checkContextMenuCallbackForId(detail, id, function onCallbackFired(label) {
107 is(label, 'foo', 'Callback label should be set correctly');
109 checkCallbackWithoutPreventDefault();
110 });
111 });
112 }
114 function checkCallbackWithoutPreventDefault() {
115 sendContextMenuTo('#menu1-trigger', function onContextMenu(detail) {
116 var id = detail.contextmenu.items[0].id;
117 checkContextMenuCallbackForId(detail, id, function onCallbackFired(label) {
118 is(label, null, 'Callback label should be null');
120 checkImageContextMenu();
121 });
122 }, /* ignorePreventDefault */ true);
123 }
125 function checkImageContextMenu() {
126 sendContextMenuTo('#menu3-trigger', function onContextMenu(detail) {
127 var target = detail.systemTargets[0];
128 is(target.nodeName, 'IMG', 'Reports correct nodeName');
129 is(target.data.uri, 'example.png', 'Reports correct uri');
131 checkVideoContextMenu();
132 }, /* ignorePreventDefault */ true);
133 }
135 function checkVideoContextMenu() {
136 sendContextMenuTo('#menu4-trigger', function onContextMenu(detail) {
137 var target = detail.systemTargets[0];
138 is(target.nodeName, 'VIDEO', 'Reports correct nodeName');
139 is(target.data.uri, videoUrl, 'Reports uri correctly in data');
140 is(target.data.hasVideo, true, 'Video data in video tag does "hasVideo"');
142 checkAudioContextMenu();
143 }, /* ignorePreventDefault */ true);
144 }
146 function checkAudioContextMenu() {
147 sendContextMenuTo('#menu6-trigger', function onContextMenu(detail) {
148 var target = detail.systemTargets[0];
149 is(target.nodeName, 'AUDIO', 'Reports correct nodeName');
150 is(target.data.uri, audioUrl, 'Reports uri correctly in data');
152 checkAudioinVideoContextMenu();
153 }, /* ignorePreventDefault */ true);
154 }
156 function checkAudioinVideoContextMenu() {
157 sendSrcTo('#menu5-trigger', audioUrl, function onSrcSet() {
158 sendContextMenuTo('#menu5-trigger', function onContextMenu(detail) {
159 var target = detail.systemTargets[0];
160 is(target.nodeName, 'VIDEO', 'Reports correct nodeName');
161 is(target.data.uri, audioUrl, 'Reports uri correctly in data');
162 is(target.data.hasVideo, false, 'Audio data in video tag reports no "hasVideo"');
164 SimpleTest.finish();
165 }, /* ignorePreventDefault */ true);
166 });
167 }
169 /* Helpers */
170 var mm = null;
171 var previousContextMenuDetail = null;
172 var currentContextMenuDetail = null;
174 function sendSrcTo(selector, src, callback) {
175 mm.sendAsyncMessage('setsrc', { 'selector': selector, 'src': src });
176 mm.addMessageListener('test:srcset', function onSrcSet(msg) {
177 mm.removeMessageListener('test:srcset', onSrcSet);
178 callback();
179 });
180 }
182 function sendContextMenuTo(selector, callback, ignorePreventDefault) {
183 iframe.addEventListener('mozbrowsercontextmenu', function oncontextmenu(e) {
184 iframe.removeEventListener(e.type, oncontextmenu);
186 // The embedder should call preventDefault() on the event if it will handle
187 // it. Not calling preventDefault() means it won't handle the event and
188 // should not be able to deal with context menu callbacks.
189 if (ignorePreventDefault !== true) {
190 e.preventDefault();
191 }
193 // Keep a reference to previous/current contextmenu event details.
194 previousContextMenuDetail = currentContextMenuDetail;
195 currentContextMenuDetail = e.detail;
197 setTimeout(function() { callback(e.detail); });
198 });
200 mm.sendAsyncMessage('contextmenu', { 'selector': selector });
201 }
203 function checkContextMenuCallbackForId(detail, id, callback) {
204 mm.addMessageListener('test:callbackfired', function onCallbackFired(msg) {
205 mm.removeMessageListener('test:callbackfired', onCallbackFired);
207 msg = SpecialPowers.wrap(msg);
208 setTimeout(function() { callback(msg.data.label); });
209 });
211 detail.contextMenuItemSelected(id);
212 }
215 var iframe = null;
216 function createIframe(callback) {
217 iframe = document.createElement('iframe');
218 SpecialPowers.wrap(iframe).mozbrowser = true;
220 iframe.src = 'data:text/html,<html>' +
221 '<body>' +
222 '<menu type="context" id="menu1" label="firstmenu">' +
223 '<menuitem label="foo" onclick="window.onContextMenuCallbackFired(event)"></menuitem>' +
224 '<menuitem label="bar" onclick="window.onContextMenuCallbackFired(event)"></menuitem>' +
225 '</menu>' +
226 '<menu type="context" id="menu2" label="secondmenu">' +
227 '<menuitem label="outer" onclick="window.onContextMenuCallbackFired(event)"></menuitem>' +
228 '<menu>' +
229 '<menuitem label="inner 1"></menuitem>' +
230 '<menuitem label="inner 2" onclick="window.onContextMenuCallbackFired(event)"></menuitem>' +
231 '</menu>' +
232 '</menu>' +
233 '<div id="menu1-trigger" contextmenu="menu1"><a id="inner-link" href="foo.html">Menu 1</a></div>' +
234 '<a href="bar.html" contextmenu="menu2"><img id="menu2-trigger" src="example.png" /></a>' +
235 '<img id="menu3-trigger" src="example.png" />' +
236 '<video id="menu4-trigger" src="' + videoUrl + '"></video>' +
237 '<video id="menu5-trigger" preload="metadata"></video>' +
238 '<audio id="menu6-trigger" src="' + audioUrl + '"></audio>' +
239 '</body></html>';
240 document.body.appendChild(iframe);
242 // The following code will be included in the child
243 // =========================================================================
244 function iframeScript() {
245 addMessageListener('contextmenu', function onContextMenu(msg) {
246 var document = content.document;
247 var evt = document.createEvent('HTMLEvents');
248 evt.initEvent('contextmenu', true, true);
249 document.querySelector(msg.data.selector).dispatchEvent(evt);
250 });
252 addMessageListener('setsrc', function onContextMenu(msg) {
253 var wrappedTarget = content.document.querySelector(msg.data.selector);
254 var target = XPCNativeWrapper.unwrap(wrappedTarget);
255 target.addEventListener('loadedmetadata', function() {
256 sendAsyncMessage('test:srcset');
257 });
258 target.src = msg.data.src;
259 });
261 addMessageListener('browser-element-api:call', function onCallback(msg) {
262 if (msg.data.msg_name != 'fire-ctx-callback')
263 return;
265 /* Use setTimeout in order to react *after* the platform */
266 content.setTimeout(function() {
267 sendAsyncMessage('test:callbackfired', { label: label });
268 label = null;
269 });
270 });
272 var label = null;
273 XPCNativeWrapper.unwrap(content).onContextMenuCallbackFired = function(e) {
274 label = e.target.getAttribute('label');
275 };
276 }
277 // =========================================================================
279 iframe.addEventListener('mozbrowserloadend', function onload(e) {
280 iframe.removeEventListener(e.type, onload);
281 mm = SpecialPowers.getBrowserFrameMessageManager(iframe);
282 mm.loadFrameScript('data:,(' + iframeScript.toString() + ')();', false);
284 // Now we're ready, let's start testing.
285 callback();
286 });
287 }
289 addEventListener('testready', runTests);
