chromium-spec.ts 139 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560
  1. import { expect } from 'chai';
  2. import { BrowserWindow, WebContents, webFrameMain, session, ipcMain, app, protocol, webContents, dialog, MessageBoxOptions } from 'electron/main';
  3. import { closeAllWindows } from './lib/window-helpers';
  4. import * as https from 'node:https';
  5. import * as http from 'node:http';
  6. import * as path from 'node:path';
  7. import * as fs from 'node:fs';
  8. import * as url from 'node:url';
  9. import * as ChildProcess from 'node:child_process';
  10. import { EventEmitter, once } from 'node:events';
  11. import { ifit, ifdescribe, defer, itremote, listen } from './lib/spec-helpers';
  12. import { PipeTransport } from './pipe-transport';
  13. import * as ws from 'ws';
  14. import { setTimeout } from 'node:timers/promises';
  15. import { AddressInfo } from 'node:net';
  16. const features = process._linkedBinding('electron_common_features');
  17. const fixturesPath = path.resolve(__dirname, 'fixtures');
  18. const certPath = path.join(fixturesPath, 'certificates');
  19. describe('reporting api', () => {
  20. it('sends a report for an intervention', async () => {
  21. const reporting = new EventEmitter();
  22. // The Reporting API only works on https with valid certs. To dodge having
  23. // to set up a trusted certificate, hack the validator.
  24. session.defaultSession.setCertificateVerifyProc((req, cb) => {
  25. cb(0);
  26. });
  27. const options = {
  28. key: fs.readFileSync(path.join(certPath, 'server.key')),
  29. cert: fs.readFileSync(path.join(certPath, 'server.pem')),
  30. ca: [
  31. fs.readFileSync(path.join(certPath, 'rootCA.pem')),
  32. fs.readFileSync(path.join(certPath, 'intermediateCA.pem'))
  33. ],
  34. requestCert: true,
  35. rejectUnauthorized: false
  36. };
  37. const server = https.createServer(options, (req, res) => {
  38. if (req.url?.endsWith('report')) {
  39. let data = '';
  40. req.on('data', (d) => { data += d.toString('utf-8'); });
  41. req.on('end', () => {
  42. reporting.emit('report', JSON.parse(data));
  43. });
  44. }
  45. const { port } = server.address() as any;
  46. res.setHeader('Reporting-Endpoints', `default="https://localhost:${port}/report"`);
  47. res.setHeader('Content-Type', 'text/html');
  48. res.end('<script>window.navigator.vibrate(1)</script>');
  49. });
  50. await listen(server);
  51. const bw = new BrowserWindow({ show: false });
  52. try {
  53. const reportGenerated = once(reporting, 'report');
  54. await bw.loadURL(`https://localhost:${(server.address() as AddressInfo).port}/a`);
  55. const [reports] = await reportGenerated;
  56. expect(reports).to.be.an('array').with.lengthOf(1);
  57. const { type, url, body } = reports[0];
  58. expect(type).to.equal('intervention');
  59. expect(url).to.equal(url);
  60. expect(body.id).to.equal('NavigatorVibrate');
  61. expect(body.message).to.match(/Blocked call to navigator.vibrate because user hasn't tapped on the frame or any embedded frame yet/);
  62. } finally {
  63. bw.destroy();
  64. server.close();
  65. }
  66. });
  67. });
  68. describe('window.postMessage', () => {
  69. afterEach(async () => {
  70. await closeAllWindows();
  71. });
  72. it('sets the source and origin correctly', async () => {
  73. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  74. w.loadURL(`file://${fixturesPath}/pages/window-open-postMessage-driver.html`);
  75. const [, message] = await once(ipcMain, 'complete');
  76. expect(message.data).to.equal('testing');
  77. expect(message.origin).to.equal('file://');
  78. expect(message.sourceEqualsOpener).to.equal(true);
  79. expect(message.eventOrigin).to.equal('file://');
  80. });
  81. });
  82. describe('focus handling', () => {
  83. let webviewContents: WebContents;
  84. let w: BrowserWindow;
  85. beforeEach(async () => {
  86. w = new BrowserWindow({
  87. show: true,
  88. webPreferences: {
  89. nodeIntegration: true,
  90. webviewTag: true,
  91. contextIsolation: false
  92. }
  93. });
  94. const webviewReady = once(w.webContents, 'did-attach-webview') as Promise<[any, WebContents]>;
  95. await w.loadFile(path.join(fixturesPath, 'pages', 'tab-focus-loop-elements.html'));
  96. const [, wvContents] = await webviewReady;
  97. webviewContents = wvContents;
  98. await once(webviewContents, 'did-finish-load');
  99. w.focus();
  100. });
  101. afterEach(() => {
  102. webviewContents = null as unknown as WebContents;
  103. w.destroy();
  104. w = null as unknown as BrowserWindow;
  105. });
  106. const expectFocusChange = async () => {
  107. const [, focusedElementId] = await once(ipcMain, 'focus-changed');
  108. return focusedElementId;
  109. };
  110. describe('a TAB press', () => {
  111. const tabPressEvent: any = {
  112. type: 'keyDown',
  113. keyCode: 'Tab'
  114. };
  115. it('moves focus to the next focusable item', async () => {
  116. let focusChange = expectFocusChange();
  117. w.webContents.sendInputEvent(tabPressEvent);
  118. let focusedElementId = await focusChange;
  119. expect(focusedElementId).to.equal('BUTTON-element-1', `should start focused in element-1, it's instead in ${focusedElementId}`);
  120. focusChange = expectFocusChange();
  121. w.webContents.sendInputEvent(tabPressEvent);
  122. focusedElementId = await focusChange;
  123. expect(focusedElementId).to.equal('BUTTON-element-2', `focus should've moved to element-2, it's instead in ${focusedElementId}`);
  124. focusChange = expectFocusChange();
  125. w.webContents.sendInputEvent(tabPressEvent);
  126. focusedElementId = await focusChange;
  127. expect(focusedElementId).to.equal('BUTTON-wv-element-1', `focus should've moved to the webview's element-1, it's instead in ${focusedElementId}`);
  128. focusChange = expectFocusChange();
  129. webviewContents.sendInputEvent(tabPressEvent);
  130. focusedElementId = await focusChange;
  131. expect(focusedElementId).to.equal('BUTTON-wv-element-2', `focus should've moved to the webview's element-2, it's instead in ${focusedElementId}`);
  132. focusChange = expectFocusChange();
  133. webviewContents.sendInputEvent(tabPressEvent);
  134. focusedElementId = await focusChange;
  135. expect(focusedElementId).to.equal('BUTTON-element-3', `focus should've moved to element-3, it's instead in ${focusedElementId}`);
  136. focusChange = expectFocusChange();
  137. w.webContents.sendInputEvent(tabPressEvent);
  138. focusedElementId = await focusChange;
  139. expect(focusedElementId).to.equal('BUTTON-element-1', `focus should've looped back to element-1, it's instead in ${focusedElementId}`);
  140. });
  141. });
  142. describe('a SHIFT + TAB press', () => {
  143. const shiftTabPressEvent: any = {
  144. type: 'keyDown',
  145. modifiers: ['Shift'],
  146. keyCode: 'Tab'
  147. };
  148. it('moves focus to the previous focusable item', async () => {
  149. let focusChange = expectFocusChange();
  150. w.webContents.sendInputEvent(shiftTabPressEvent);
  151. let focusedElementId = await focusChange;
  152. expect(focusedElementId).to.equal('BUTTON-element-3', `should start focused in element-3, it's instead in ${focusedElementId}`);
  153. focusChange = expectFocusChange();
  154. w.webContents.sendInputEvent(shiftTabPressEvent);
  155. focusedElementId = await focusChange;
  156. expect(focusedElementId).to.equal('BUTTON-wv-element-2', `focus should've moved to the webview's element-2, it's instead in ${focusedElementId}`);
  157. focusChange = expectFocusChange();
  158. webviewContents.sendInputEvent(shiftTabPressEvent);
  159. focusedElementId = await focusChange;
  160. expect(focusedElementId).to.equal('BUTTON-wv-element-1', `focus should've moved to the webview's element-1, it's instead in ${focusedElementId}`);
  161. focusChange = expectFocusChange();
  162. webviewContents.sendInputEvent(shiftTabPressEvent);
  163. focusedElementId = await focusChange;
  164. expect(focusedElementId).to.equal('BUTTON-element-2', `focus should've moved to element-2, it's instead in ${focusedElementId}`);
  165. focusChange = expectFocusChange();
  166. w.webContents.sendInputEvent(shiftTabPressEvent);
  167. focusedElementId = await focusChange;
  168. expect(focusedElementId).to.equal('BUTTON-element-1', `focus should've moved to element-1, it's instead in ${focusedElementId}`);
  169. focusChange = expectFocusChange();
  170. w.webContents.sendInputEvent(shiftTabPressEvent);
  171. focusedElementId = await focusChange;
  172. expect(focusedElementId).to.equal('BUTTON-element-3', `focus should've looped back to element-3, it's instead in ${focusedElementId}`);
  173. });
  174. });
  175. });
  176. describe('web security', () => {
  177. afterEach(closeAllWindows);
  178. let server: http.Server;
  179. let serverUrl: string;
  180. before(async () => {
  181. server = http.createServer((req, res) => {
  182. res.setHeader('Content-Type', 'text/html');
  183. res.end('<body>');
  184. });
  185. serverUrl = (await listen(server)).url;
  186. });
  187. after(() => {
  188. server.close();
  189. });
  190. it('engages CORB when web security is not disabled', async () => {
  191. const w = new BrowserWindow({ show: false, webPreferences: { webSecurity: true, nodeIntegration: true, contextIsolation: false } });
  192. const p = once(ipcMain, 'success');
  193. await w.loadURL(`data:text/html,<script>
  194. const s = document.createElement('script')
  195. s.src = "${serverUrl}"
  196. // The script will not load under ORB, refs https://chromium-review.googlesource.com/c/chromium/src/+/3785025.
  197. // Before ORB an empty response is sent, which is now replaced by a network error.
  198. s.onerror = () => { require('electron').ipcRenderer.send('success') }
  199. document.documentElement.appendChild(s)
  200. </script>`);
  201. await p;
  202. });
  203. it('bypasses CORB when web security is disabled', async () => {
  204. const w = new BrowserWindow({ show: false, webPreferences: { webSecurity: false, nodeIntegration: true, contextIsolation: false } });
  205. const p = once(ipcMain, 'success');
  206. await w.loadURL(`data:text/html,
  207. <script>
  208. window.onerror = (e) => { require('electron').ipcRenderer.send('success', e) }
  209. </script>
  210. <script src="${serverUrl}"></script>`);
  211. await p;
  212. });
  213. it('engages CORS when web security is not disabled', async () => {
  214. const w = new BrowserWindow({ show: false, webPreferences: { webSecurity: true, nodeIntegration: true, contextIsolation: false } });
  215. const p = once(ipcMain, 'response');
  216. await w.loadURL(`data:text/html,<script>
  217. (async function() {
  218. try {
  219. await fetch('${serverUrl}');
  220. require('electron').ipcRenderer.send('response', 'passed');
  221. } catch {
  222. require('electron').ipcRenderer.send('response', 'failed');
  223. }
  224. })();
  225. </script>`);
  226. const [, response] = await p;
  227. expect(response).to.equal('failed');
  228. });
  229. it('bypasses CORS when web security is disabled', async () => {
  230. const w = new BrowserWindow({ show: false, webPreferences: { webSecurity: false, nodeIntegration: true, contextIsolation: false } });
  231. const p = once(ipcMain, 'response');
  232. await w.loadURL(`data:text/html,<script>
  233. (async function() {
  234. try {
  235. await fetch('${serverUrl}');
  236. require('electron').ipcRenderer.send('response', 'passed');
  237. } catch {
  238. require('electron').ipcRenderer.send('response', 'failed');
  239. }
  240. })();
  241. </script>`);
  242. const [, response] = await p;
  243. expect(response).to.equal('passed');
  244. });
  245. describe('accessing file://', () => {
  246. async function loadFile (w: BrowserWindow) {
  247. const thisFile = url.format({
  248. pathname: __filename.replaceAll('\\', '/'),
  249. protocol: 'file',
  250. slashes: true
  251. });
  252. await w.loadURL(`data:text/html,<script>
  253. function loadFile() {
  254. return new Promise((resolve) => {
  255. fetch('${thisFile}').then(
  256. () => resolve('loaded'),
  257. () => resolve('failed')
  258. )
  259. });
  260. }
  261. </script>`);
  262. return await w.webContents.executeJavaScript('loadFile()');
  263. }
  264. it('is forbidden when web security is enabled', async () => {
  265. const w = new BrowserWindow({ show: false, webPreferences: { webSecurity: true } });
  266. const result = await loadFile(w);
  267. expect(result).to.equal('failed');
  268. });
  269. it('is allowed when web security is disabled', async () => {
  270. const w = new BrowserWindow({ show: false, webPreferences: { webSecurity: false } });
  271. const result = await loadFile(w);
  272. expect(result).to.equal('loaded');
  273. });
  274. });
  275. describe('wasm-eval csp', () => {
  276. async function loadWasm (csp: string) {
  277. const w = new BrowserWindow({
  278. show: false,
  279. webPreferences: {
  280. sandbox: true,
  281. enableBlinkFeatures: 'WebAssemblyCSP'
  282. }
  283. });
  284. await w.loadURL(`data:text/html,<head>
  285. <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self' 'unsafe-inline' ${csp}">
  286. </head>
  287. <script>
  288. function loadWasm() {
  289. const wasmBin = new Uint8Array([0, 97, 115, 109, 1, 0, 0, 0])
  290. return new Promise((resolve) => {
  291. WebAssembly.instantiate(wasmBin).then(() => {
  292. resolve('loaded')
  293. }).catch((error) => {
  294. resolve(error.message)
  295. })
  296. });
  297. }
  298. </script>`);
  299. return await w.webContents.executeJavaScript('loadWasm()');
  300. }
  301. it('wasm codegen is disallowed by default', async () => {
  302. const r = await loadWasm('');
  303. expect(r).to.equal('WebAssembly.instantiate(): Refused to compile or instantiate WebAssembly module because \'unsafe-eval\' is not an allowed source of script in the following Content Security Policy directive: "script-src \'self\' \'unsafe-inline\'"');
  304. });
  305. it('wasm codegen is allowed with "wasm-unsafe-eval" csp', async () => {
  306. const r = await loadWasm("'wasm-unsafe-eval'");
  307. expect(r).to.equal('loaded');
  308. });
  309. });
  310. describe('csp', () => {
  311. for (const sandbox of [true, false]) {
  312. describe(`when sandbox: ${sandbox}`, () => {
  313. for (const contextIsolation of [true, false]) {
  314. describe(`when contextIsolation: ${contextIsolation}`, () => {
  315. it('prevents eval from running in an inline script', async () => {
  316. const w = new BrowserWindow({
  317. show: false,
  318. webPreferences: { sandbox, contextIsolation }
  319. });
  320. w.loadURL(`data:text/html,<head>
  321. <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self' 'unsafe-inline'">
  322. </head>
  323. <script>
  324. try {
  325. // We use console.log here because it is easier than making a
  326. // preload script, and the behavior under test changes when
  327. // contextIsolation: false
  328. console.log(eval('true'))
  329. } catch (e) {
  330. console.log(e.message)
  331. }
  332. </script>`);
  333. const [,, message] = await once(w.webContents, 'console-message');
  334. expect(message).to.match(/Refused to evaluate a string/);
  335. });
  336. it('does not prevent eval from running in an inline script when there is no csp', async () => {
  337. const w = new BrowserWindow({
  338. show: false,
  339. webPreferences: { sandbox, contextIsolation }
  340. });
  341. w.loadURL(`data:text/html,
  342. <script>
  343. try {
  344. // We use console.log here because it is easier than making a
  345. // preload script, and the behavior under test changes when
  346. // contextIsolation: false
  347. console.log(eval('true'))
  348. } catch (e) {
  349. console.log(e.message)
  350. }
  351. </script>`);
  352. const [,, message] = await once(w.webContents, 'console-message');
  353. expect(message).to.equal('true');
  354. });
  355. it('prevents eval from running in executeJavaScript', async () => {
  356. const w = new BrowserWindow({
  357. show: false,
  358. webPreferences: { sandbox, contextIsolation }
  359. });
  360. w.loadURL('data:text/html,<head><meta http-equiv="Content-Security-Policy" content="default-src \'self\'; script-src \'self\' \'unsafe-inline\'"></meta></head>');
  361. await expect(w.webContents.executeJavaScript('eval("true")')).to.be.rejected();
  362. });
  363. it('does not prevent eval from running in executeJavaScript when there is no csp', async () => {
  364. const w = new BrowserWindow({
  365. show: false,
  366. webPreferences: { sandbox, contextIsolation }
  367. });
  368. w.loadURL('data:text/html,');
  369. expect(await w.webContents.executeJavaScript('eval("true")')).to.be.true();
  370. });
  371. });
  372. }
  373. });
  374. }
  375. });
  376. it('does not crash when multiple WebContent are created with web security disabled', () => {
  377. const options = { show: false, webPreferences: { webSecurity: false } };
  378. const w1 = new BrowserWindow(options);
  379. w1.loadURL(serverUrl);
  380. const w2 = new BrowserWindow(options);
  381. w2.loadURL(serverUrl);
  382. });
  383. });
  384. describe('command line switches', () => {
  385. let appProcess: ChildProcess.ChildProcessWithoutNullStreams | undefined;
  386. afterEach(() => {
  387. if (appProcess && !appProcess.killed) {
  388. appProcess.kill();
  389. appProcess = undefined;
  390. }
  391. });
  392. describe('--lang switch', () => {
  393. const currentLocale = app.getLocale();
  394. const currentSystemLocale = app.getSystemLocale();
  395. const currentPreferredLanguages = JSON.stringify(app.getPreferredSystemLanguages());
  396. const testLocale = async (locale: string, result: string, printEnv: boolean = false) => {
  397. const appPath = path.join(fixturesPath, 'api', 'locale-check');
  398. const args = [appPath, `--set-lang=${locale}`];
  399. if (printEnv) {
  400. args.push('--print-env');
  401. }
  402. appProcess = ChildProcess.spawn(process.execPath, args);
  403. let output = '';
  404. appProcess.stdout.on('data', (data) => { output += data; });
  405. let stderr = '';
  406. appProcess.stderr.on('data', (data) => { stderr += data; });
  407. const [code, signal] = await once(appProcess, 'exit');
  408. if (code !== 0) {
  409. throw new Error(`Process exited with code "${code}" signal "${signal}" output "${output}" stderr "${stderr}"`);
  410. }
  411. output = output.replaceAll(/(\r\n|\n|\r)/gm, '');
  412. expect(output).to.equal(result);
  413. };
  414. it('should set the locale', async () => testLocale('fr', `fr|${currentSystemLocale}|${currentPreferredLanguages}`));
  415. it('should set the locale with country code', async () => testLocale('zh-CN', `zh-CN|${currentSystemLocale}|${currentPreferredLanguages}`));
  416. it('should not set an invalid locale', async () => testLocale('asdfkl', `${currentLocale}|${currentSystemLocale}|${currentPreferredLanguages}`));
  417. const lcAll = String(process.env.LC_ALL);
  418. ifit(process.platform === 'linux')('current process has a valid LC_ALL env', async () => {
  419. // The LC_ALL env should not be set to DOM locale string.
  420. expect(lcAll).to.not.equal(app.getLocale());
  421. });
  422. ifit(process.platform === 'linux')('should not change LC_ALL', async () => testLocale('fr', lcAll, true));
  423. ifit(process.platform === 'linux')('should not change LC_ALL when setting invalid locale', async () => testLocale('asdfkl', lcAll, true));
  424. ifit(process.platform === 'linux')('should not change LC_ALL when --lang is not set', async () => testLocale('', lcAll, true));
  425. });
  426. describe('--remote-debugging-pipe switch', () => {
  427. it('should expose CDP via pipe', async () => {
  428. const electronPath = process.execPath;
  429. appProcess = ChildProcess.spawn(electronPath, ['--remote-debugging-pipe'], {
  430. stdio: ['inherit', 'inherit', 'inherit', 'pipe', 'pipe']
  431. }) as ChildProcess.ChildProcessWithoutNullStreams;
  432. const stdio = appProcess.stdio as unknown as [NodeJS.ReadableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.ReadableStream];
  433. const pipe = new PipeTransport(stdio[3], stdio[4]);
  434. const versionPromise = new Promise(resolve => { pipe.onmessage = resolve; });
  435. pipe.send({ id: 1, method: 'Browser.getVersion', params: {} });
  436. const message = (await versionPromise) as any;
  437. expect(message.id).to.equal(1);
  438. expect(message.result.product).to.contain('Chrome');
  439. expect(message.result.userAgent).to.contain('Electron');
  440. });
  441. it('should override --remote-debugging-port switch', async () => {
  442. const electronPath = process.execPath;
  443. appProcess = ChildProcess.spawn(electronPath, ['--remote-debugging-pipe', '--remote-debugging-port=0'], {
  444. stdio: ['inherit', 'inherit', 'pipe', 'pipe', 'pipe']
  445. }) as ChildProcess.ChildProcessWithoutNullStreams;
  446. let stderr = '';
  447. appProcess.stderr.on('data', (data: string) => { stderr += data; });
  448. const stdio = appProcess.stdio as unknown as [NodeJS.ReadableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.ReadableStream];
  449. const pipe = new PipeTransport(stdio[3], stdio[4]);
  450. const versionPromise = new Promise(resolve => { pipe.onmessage = resolve; });
  451. pipe.send({ id: 1, method: 'Browser.getVersion', params: {} });
  452. const message = (await versionPromise) as any;
  453. expect(message.id).to.equal(1);
  454. expect(stderr).to.not.include('DevTools listening on');
  455. });
  456. it('should shut down Electron upon Browser.close CDP command', async () => {
  457. const electronPath = process.execPath;
  458. appProcess = ChildProcess.spawn(electronPath, ['--remote-debugging-pipe'], {
  459. stdio: ['inherit', 'inherit', 'inherit', 'pipe', 'pipe']
  460. }) as ChildProcess.ChildProcessWithoutNullStreams;
  461. const stdio = appProcess.stdio as unknown as [NodeJS.ReadableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.ReadableStream];
  462. const pipe = new PipeTransport(stdio[3], stdio[4]);
  463. pipe.send({ id: 1, method: 'Browser.close', params: {} });
  464. await once(appProcess, 'exit');
  465. });
  466. });
  467. describe('--remote-debugging-port switch', () => {
  468. it('should display the discovery page', (done) => {
  469. const electronPath = process.execPath;
  470. let output = '';
  471. appProcess = ChildProcess.spawn(electronPath, ['--remote-debugging-port=']);
  472. appProcess.stdout.on('data', (data) => {
  473. console.log(data);
  474. });
  475. appProcess.stderr.on('data', (data) => {
  476. console.log(data);
  477. output += data;
  478. const m = /DevTools listening on ws:\/\/127.0.0.1:(\d+)\//.exec(output);
  479. if (m) {
  480. appProcess!.stderr.removeAllListeners('data');
  481. const port = m[1];
  482. http.get(`http://127.0.0.1:${port}`, (res) => {
  483. try {
  484. expect(res.statusCode).to.eql(200);
  485. expect(parseInt(res.headers['content-length']!)).to.be.greaterThan(0);
  486. done();
  487. } catch (e) {
  488. done(e);
  489. } finally {
  490. res.destroy();
  491. }
  492. });
  493. }
  494. });
  495. });
  496. });
  497. });
  498. describe('chromium features', () => {
  499. afterEach(closeAllWindows);
  500. describe('accessing key names also used as Node.js module names', () => {
  501. it('does not crash', (done) => {
  502. const w = new BrowserWindow({ show: false });
  503. w.webContents.once('did-finish-load', () => { done(); });
  504. w.webContents.once('render-process-gone', () => done(new Error('WebContents crashed.')));
  505. w.loadFile(path.join(fixturesPath, 'pages', 'external-string.html'));
  506. });
  507. });
  508. describe('first party sets', () => {
  509. const fps = [
  510. 'https://fps-member1.glitch.me',
  511. 'https://fps-member2.glitch.me',
  512. 'https://fps-member3.glitch.me'
  513. ];
  514. it('loads first party sets', async () => {
  515. const appPath = path.join(fixturesPath, 'api', 'first-party-sets', 'base');
  516. const fpsProcess = ChildProcess.spawn(process.execPath, [appPath]);
  517. let output = '';
  518. fpsProcess.stdout.on('data', data => { output += data; });
  519. await once(fpsProcess, 'exit');
  520. expect(output).to.include(fps.join(','));
  521. });
  522. it('loads sets from the command line', async () => {
  523. const appPath = path.join(fixturesPath, 'api', 'first-party-sets', 'command-line');
  524. const args = [appPath, `--use-first-party-set=${fps}`];
  525. const fpsProcess = ChildProcess.spawn(process.execPath, args);
  526. let output = '';
  527. fpsProcess.stdout.on('data', data => { output += data; });
  528. await once(fpsProcess, 'exit');
  529. expect(output).to.include(fps.join(','));
  530. });
  531. });
  532. describe('loading jquery', () => {
  533. it('does not crash', (done) => {
  534. const w = new BrowserWindow({ show: false });
  535. w.webContents.once('did-finish-load', () => { done(); });
  536. w.webContents.once('render-process-gone', () => done(new Error('WebContents crashed.')));
  537. w.loadFile(path.join(__dirname, 'fixtures', 'pages', 'jquery.html'));
  538. });
  539. });
  540. describe('navigator.keyboard', () => {
  541. afterEach(closeAllWindows);
  542. it('getLayoutMap() should return a KeyboardLayoutMap object', async () => {
  543. const w = new BrowserWindow({ show: false });
  544. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  545. const size = await w.webContents.executeJavaScript(`
  546. navigator.keyboard.getLayoutMap().then(map => map.size)
  547. `);
  548. expect(size).to.be.a('number');
  549. });
  550. it('should lock the keyboard', async () => {
  551. const w = new BrowserWindow({ show: false });
  552. await w.loadFile(path.join(fixturesPath, 'pages', 'modal.html'));
  553. // Test that without lock, with ESC:
  554. // - the window leaves fullscreen
  555. // - the dialog is not closed
  556. const enterFS1 = once(w, 'enter-full-screen');
  557. await w.webContents.executeJavaScript('document.body.requestFullscreen()', true);
  558. await enterFS1;
  559. await w.webContents.executeJavaScript('document.getElementById(\'favDialog\').showModal()', true);
  560. const open1 = await w.webContents.executeJavaScript('document.getElementById(\'favDialog\').open');
  561. expect(open1).to.be.true();
  562. w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'Escape' });
  563. await setTimeout(1000);
  564. const openAfter1 = await w.webContents.executeJavaScript('document.getElementById(\'favDialog\').open');
  565. expect(openAfter1).to.be.true();
  566. expect(w.isFullScreen()).to.be.false();
  567. // Test that with lock, with ESC:
  568. // - the window does not leave fullscreen
  569. // - the dialog is closed
  570. const enterFS2 = once(w, 'enter-full-screen');
  571. await w.webContents.executeJavaScript(`
  572. navigator.keyboard.lock(['Escape']);
  573. document.body.requestFullscreen();
  574. `, true);
  575. await enterFS2;
  576. await w.webContents.executeJavaScript('document.getElementById(\'favDialog\').showModal()', true);
  577. const open2 = await w.webContents.executeJavaScript('document.getElementById(\'favDialog\').open');
  578. expect(open2).to.be.true();
  579. w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'Escape' });
  580. await setTimeout(1000);
  581. const openAfter2 = await w.webContents.executeJavaScript('document.getElementById(\'favDialog\').open');
  582. expect(openAfter2).to.be.false();
  583. expect(w.isFullScreen()).to.be.true();
  584. });
  585. });
  586. describe('navigator.languages', () => {
  587. it('should return the system locale only', async () => {
  588. const appLocale = app.getLocale();
  589. const w = new BrowserWindow({ show: false });
  590. await w.loadURL('about:blank');
  591. const languages = await w.webContents.executeJavaScript('navigator.languages');
  592. expect(languages.length).to.be.greaterThan(0);
  593. expect(languages).to.contain(appLocale);
  594. });
  595. });
  596. describe('navigator.serviceWorker', () => {
  597. it('should register for file scheme', (done) => {
  598. const w = new BrowserWindow({
  599. show: false,
  600. webPreferences: {
  601. nodeIntegration: true,
  602. partition: 'sw-file-scheme-spec',
  603. contextIsolation: false
  604. }
  605. });
  606. w.webContents.on('ipc-message', (event, channel, message) => {
  607. if (channel === 'reload') {
  608. w.webContents.reload();
  609. } else if (channel === 'error') {
  610. done(message);
  611. } else if (channel === 'response') {
  612. expect(message).to.equal('Hello from serviceWorker!');
  613. session.fromPartition('sw-file-scheme-spec').clearStorageData({
  614. storages: ['serviceworkers']
  615. }).then(() => done());
  616. }
  617. });
  618. w.webContents.on('render-process-gone', () => done(new Error('WebContents crashed.')));
  619. w.loadFile(path.join(fixturesPath, 'pages', 'service-worker', 'index.html'));
  620. });
  621. it('should register for intercepted file scheme', (done) => {
  622. const customSession = session.fromPartition('intercept-file');
  623. customSession.protocol.interceptBufferProtocol('file', (request, callback) => {
  624. let file = url.parse(request.url).pathname!;
  625. if (file[0] === '/' && process.platform === 'win32') file = file.slice(1);
  626. const content = fs.readFileSync(path.normalize(file));
  627. const ext = path.extname(file);
  628. let type = 'text/html';
  629. if (ext === '.js') type = 'application/javascript';
  630. callback({ data: content, mimeType: type } as any);
  631. });
  632. const w = new BrowserWindow({
  633. show: false,
  634. webPreferences: {
  635. nodeIntegration: true,
  636. session: customSession,
  637. contextIsolation: false
  638. }
  639. });
  640. w.webContents.on('ipc-message', (event, channel, message) => {
  641. if (channel === 'reload') {
  642. w.webContents.reload();
  643. } else if (channel === 'error') {
  644. done(`unexpected error : ${message}`);
  645. } else if (channel === 'response') {
  646. expect(message).to.equal('Hello from serviceWorker!');
  647. customSession.clearStorageData({
  648. storages: ['serviceworkers']
  649. }).then(() => {
  650. customSession.protocol.uninterceptProtocol('file');
  651. done();
  652. });
  653. }
  654. });
  655. w.webContents.on('render-process-gone', () => done(new Error('WebContents crashed.')));
  656. w.loadFile(path.join(fixturesPath, 'pages', 'service-worker', 'index.html'));
  657. });
  658. it('should register for custom scheme', (done) => {
  659. const customSession = session.fromPartition('custom-scheme');
  660. customSession.protocol.registerFileProtocol(serviceWorkerScheme, (request, callback) => {
  661. let file = url.parse(request.url).pathname!;
  662. if (file[0] === '/' && process.platform === 'win32') file = file.slice(1);
  663. callback({ path: path.normalize(file) } as any);
  664. });
  665. const w = new BrowserWindow({
  666. show: false,
  667. webPreferences: {
  668. nodeIntegration: true,
  669. session: customSession,
  670. contextIsolation: false
  671. }
  672. });
  673. w.webContents.on('ipc-message', (event, channel, message) => {
  674. if (channel === 'reload') {
  675. w.webContents.reload();
  676. } else if (channel === 'error') {
  677. done(`unexpected error : ${message}`);
  678. } else if (channel === 'response') {
  679. expect(message).to.equal('Hello from serviceWorker!');
  680. customSession.clearStorageData({
  681. storages: ['serviceworkers']
  682. }).then(() => {
  683. customSession.protocol.uninterceptProtocol(serviceWorkerScheme);
  684. done();
  685. });
  686. }
  687. });
  688. w.webContents.on('render-process-gone', () => done(new Error('WebContents crashed.')));
  689. w.loadFile(path.join(fixturesPath, 'pages', 'service-worker', 'custom-scheme-index.html'));
  690. });
  691. it('should not allow nodeIntegrationInWorker', async () => {
  692. const w = new BrowserWindow({
  693. show: false,
  694. webPreferences: {
  695. nodeIntegration: true,
  696. nodeIntegrationInWorker: true,
  697. partition: 'sw-file-scheme-worker-spec',
  698. contextIsolation: false
  699. }
  700. });
  701. await w.loadURL(`file://${fixturesPath}/pages/service-worker/empty.html`);
  702. const data = await w.webContents.executeJavaScript(`
  703. navigator.serviceWorker.register('worker-no-node.js', {
  704. scope: './'
  705. }).then(() => navigator.serviceWorker.ready)
  706. new Promise((resolve) => {
  707. navigator.serviceWorker.onmessage = event => resolve(event.data);
  708. });
  709. `);
  710. expect(data).to.equal('undefined undefined undefined undefined');
  711. });
  712. });
  713. describe('navigator.geolocation', () => {
  714. ifit(features.isFakeLocationProviderEnabled())('returns error when permission is denied', async () => {
  715. const w = new BrowserWindow({
  716. show: false,
  717. webPreferences: {
  718. nodeIntegration: true,
  719. partition: 'geolocation-spec',
  720. contextIsolation: false
  721. }
  722. });
  723. const message = once(w.webContents, 'ipc-message');
  724. w.webContents.session.setPermissionRequestHandler((wc, permission, callback) => {
  725. if (permission === 'geolocation') {
  726. callback(false);
  727. } else {
  728. callback(true);
  729. }
  730. });
  731. w.loadFile(path.join(fixturesPath, 'pages', 'geolocation', 'index.html'));
  732. const [, channel] = await message;
  733. expect(channel).to.equal('success', 'unexpected response from geolocation api');
  734. });
  735. ifit(!features.isFakeLocationProviderEnabled())('returns position when permission is granted', async () => {
  736. const w = new BrowserWindow({
  737. show: false,
  738. webPreferences: {
  739. partition: 'geolocation-spec'
  740. }
  741. });
  742. w.webContents.session.setPermissionRequestHandler((_wc, _permission, callback) => {
  743. callback(true);
  744. });
  745. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  746. const position = await w.webContents.executeJavaScript(`new Promise((resolve, reject) =>
  747. navigator.geolocation.getCurrentPosition(
  748. x => resolve({coords: x.coords, timestamp: x.timestamp}),
  749. err => reject(new Error(err.message))))`);
  750. expect(position).to.have.property('coords');
  751. expect(position).to.have.property('timestamp');
  752. });
  753. });
  754. describe('web workers', () => {
  755. let appProcess: ChildProcess.ChildProcessWithoutNullStreams | undefined;
  756. afterEach(() => {
  757. if (appProcess && !appProcess.killed) {
  758. appProcess.kill();
  759. appProcess = undefined;
  760. }
  761. });
  762. it('Worker with nodeIntegrationInWorker has access to self.module.paths', async () => {
  763. const appPath = path.join(__dirname, 'fixtures', 'apps', 'self-module-paths');
  764. appProcess = ChildProcess.spawn(process.execPath, [appPath]);
  765. const [code] = await once(appProcess, 'exit');
  766. expect(code).to.equal(0);
  767. });
  768. it('Worker can work', async () => {
  769. const w = new BrowserWindow({ show: false });
  770. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  771. const data = await w.webContents.executeJavaScript(`
  772. const worker = new Worker('../workers/worker.js');
  773. const message = 'ping';
  774. const eventPromise = new Promise((resolve) => { worker.onmessage = resolve; });
  775. worker.postMessage(message);
  776. eventPromise.then(t => t.data)
  777. `);
  778. expect(data).to.equal('ping');
  779. });
  780. it('Worker has no node integration by default', async () => {
  781. const w = new BrowserWindow({ show: false });
  782. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  783. const data = await w.webContents.executeJavaScript(`
  784. const worker = new Worker('../workers/worker_node.js');
  785. new Promise((resolve) => { worker.onmessage = e => resolve(e.data); })
  786. `);
  787. expect(data).to.equal('undefined undefined undefined undefined');
  788. });
  789. it('Worker has node integration with nodeIntegrationInWorker', async () => {
  790. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, nodeIntegrationInWorker: true, contextIsolation: false } });
  791. w.loadURL(`file://${fixturesPath}/pages/worker.html`);
  792. const [, data] = await once(ipcMain, 'worker-result');
  793. expect(data).to.equal('object function object function');
  794. });
  795. describe('SharedWorker', () => {
  796. it('can work', async () => {
  797. const w = new BrowserWindow({ show: false });
  798. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  799. const data = await w.webContents.executeJavaScript(`
  800. const worker = new SharedWorker('../workers/shared_worker.js');
  801. const message = 'ping';
  802. const eventPromise = new Promise((resolve) => { worker.port.onmessage = e => resolve(e.data); });
  803. worker.port.postMessage(message);
  804. eventPromise
  805. `);
  806. expect(data).to.equal('ping');
  807. });
  808. it('has no node integration by default', async () => {
  809. const w = new BrowserWindow({ show: false });
  810. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  811. const data = await w.webContents.executeJavaScript(`
  812. const worker = new SharedWorker('../workers/shared_worker_node.js');
  813. new Promise((resolve) => { worker.port.onmessage = e => resolve(e.data); })
  814. `);
  815. expect(data).to.equal('undefined undefined undefined undefined');
  816. });
  817. it('does not have node integration with nodeIntegrationInWorker', async () => {
  818. const w = new BrowserWindow({
  819. show: false,
  820. webPreferences: {
  821. nodeIntegration: true,
  822. nodeIntegrationInWorker: true,
  823. contextIsolation: false
  824. }
  825. });
  826. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  827. const data = await w.webContents.executeJavaScript(`
  828. const worker = new SharedWorker('../workers/shared_worker_node.js');
  829. new Promise((resolve) => { worker.port.onmessage = e => resolve(e.data); })
  830. `);
  831. expect(data).to.equal('undefined undefined undefined undefined');
  832. });
  833. });
  834. });
  835. describe('form submit', () => {
  836. let server: http.Server;
  837. let serverUrl: string;
  838. before(async () => {
  839. server = http.createServer((req, res) => {
  840. let body = '';
  841. req.on('data', (chunk) => {
  842. body += chunk;
  843. });
  844. res.setHeader('Content-Type', 'application/json');
  845. req.on('end', () => {
  846. res.end(`body:${body}`);
  847. });
  848. });
  849. serverUrl = (await listen(server)).url;
  850. });
  851. after(async () => {
  852. server.close();
  853. await closeAllWindows();
  854. });
  855. for (const isSandboxEnabled of [true, false]) {
  856. describe(`sandbox=${isSandboxEnabled}`, () => {
  857. it('posts data in the same window', async () => {
  858. const w = new BrowserWindow({
  859. show: false,
  860. webPreferences: {
  861. sandbox: isSandboxEnabled
  862. }
  863. });
  864. await w.loadFile(path.join(fixturesPath, 'pages', 'form-with-data.html'));
  865. const loadPromise = once(w.webContents, 'did-finish-load');
  866. w.webContents.executeJavaScript(`
  867. const form = document.querySelector('form')
  868. form.action = '${serverUrl}';
  869. form.submit();
  870. `);
  871. await loadPromise;
  872. const res = await w.webContents.executeJavaScript('document.body.innerText');
  873. expect(res).to.equal('body:greeting=hello');
  874. });
  875. it('posts data to a new window with target=_blank', async () => {
  876. const w = new BrowserWindow({
  877. show: false,
  878. webPreferences: {
  879. sandbox: isSandboxEnabled
  880. }
  881. });
  882. await w.loadFile(path.join(fixturesPath, 'pages', 'form-with-data.html'));
  883. const windowCreatedPromise = once(app, 'browser-window-created') as Promise<[any, BrowserWindow]>;
  884. w.webContents.executeJavaScript(`
  885. const form = document.querySelector('form')
  886. form.action = '${serverUrl}';
  887. form.target = '_blank';
  888. form.submit();
  889. `);
  890. const [, newWin] = await windowCreatedPromise;
  891. const res = await newWin.webContents.executeJavaScript('document.body.innerText');
  892. expect(res).to.equal('body:greeting=hello');
  893. });
  894. });
  895. }
  896. });
  897. describe('window.open', () => {
  898. for (const show of [true, false]) {
  899. it(`shows the child regardless of parent visibility when parent {show=${show}}`, async () => {
  900. const w = new BrowserWindow({ show });
  901. // toggle visibility
  902. if (show) {
  903. w.hide();
  904. } else {
  905. w.show();
  906. }
  907. defer(() => { w.close(); });
  908. const promise = once(app, 'browser-window-created') as Promise<[any, BrowserWindow]>;
  909. w.loadFile(path.join(fixturesPath, 'pages', 'window-open.html'));
  910. const [, newWindow] = await promise;
  911. expect(newWindow.isVisible()).to.equal(true);
  912. });
  913. }
  914. // FIXME(zcbenz): This test is making the spec runner hang on exit on Windows.
  915. ifit(process.platform !== 'win32')('disables node integration when it is disabled on the parent window', async () => {
  916. const windowUrl = url.pathToFileURL(path.join(fixturesPath, 'pages', 'window-opener-no-node-integration.html'));
  917. windowUrl.searchParams.set('p', `${fixturesPath}/pages/window-opener-node.html`);
  918. const w = new BrowserWindow({ show: false });
  919. w.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  920. const { eventData } = await w.webContents.executeJavaScript(`(async () => {
  921. const message = new Promise(resolve => window.addEventListener('message', resolve, {once: true}));
  922. const b = window.open(${JSON.stringify(windowUrl)}, '', 'show=false')
  923. const e = await message
  924. b.close();
  925. return {
  926. eventData: e.data
  927. }
  928. })()`);
  929. expect(eventData.isProcessGlobalUndefined).to.be.true();
  930. });
  931. it('disables node integration when it is disabled on the parent window for chrome devtools URLs', async () => {
  932. // NB. webSecurity is disabled because native window.open() is not
  933. // allowed to load devtools:// URLs.
  934. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, webSecurity: false } });
  935. w.loadURL('about:blank');
  936. w.webContents.executeJavaScript(`
  937. { b = window.open('devtools://devtools/bundled/inspector.html', '', 'nodeIntegration=no,show=no'); null }
  938. `);
  939. const [, contents] = await once(app, 'web-contents-created') as [any, WebContents];
  940. const typeofProcessGlobal = await contents.executeJavaScript('typeof process');
  941. expect(typeofProcessGlobal).to.equal('undefined');
  942. });
  943. it('can disable node integration when it is enabled on the parent window', async () => {
  944. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
  945. w.loadURL('about:blank');
  946. w.webContents.executeJavaScript(`
  947. { b = window.open('about:blank', '', 'nodeIntegration=no,show=no'); null }
  948. `);
  949. const [, contents] = await once(app, 'web-contents-created') as [any, WebContents];
  950. const typeofProcessGlobal = await contents.executeJavaScript('typeof process');
  951. expect(typeofProcessGlobal).to.equal('undefined');
  952. });
  953. // TODO(jkleinsc) fix this flaky test on WOA
  954. ifit(process.platform !== 'win32' || process.arch !== 'arm64')('disables JavaScript when it is disabled on the parent window', async () => {
  955. const w = new BrowserWindow({ show: true, webPreferences: { nodeIntegration: true } });
  956. w.webContents.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  957. const windowUrl = require('node:url').format({
  958. pathname: `${fixturesPath}/pages/window-no-javascript.html`,
  959. protocol: 'file',
  960. slashes: true
  961. });
  962. w.webContents.executeJavaScript(`
  963. { b = window.open(${JSON.stringify(windowUrl)}, '', 'javascript=no,show=no'); null }
  964. `);
  965. const [, contents] = await once(app, 'web-contents-created') as [any, WebContents];
  966. await once(contents, 'did-finish-load');
  967. // Click link on page
  968. contents.sendInputEvent({ type: 'mouseDown', clickCount: 1, x: 1, y: 1 });
  969. contents.sendInputEvent({ type: 'mouseUp', clickCount: 1, x: 1, y: 1 });
  970. const [, window] = await once(app, 'browser-window-created') as [any, BrowserWindow];
  971. const preferences = window.webContents.getLastWebPreferences();
  972. expect(preferences!.javascript).to.be.false();
  973. });
  974. it('defines a window.location getter', async () => {
  975. let targetURL: string;
  976. if (process.platform === 'win32') {
  977. targetURL = `file:///${fixturesPath.replaceAll('\\', '/')}/pages/base-page.html`;
  978. } else {
  979. targetURL = `file://${fixturesPath}/pages/base-page.html`;
  980. }
  981. const w = new BrowserWindow({ show: false });
  982. w.webContents.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  983. w.webContents.executeJavaScript(`{ b = window.open(${JSON.stringify(targetURL)}); null }`);
  984. const [, window] = await once(app, 'browser-window-created') as [any, BrowserWindow];
  985. await once(window.webContents, 'did-finish-load');
  986. expect(await w.webContents.executeJavaScript('b.location.href')).to.equal(targetURL);
  987. });
  988. it('defines a window.location setter', async () => {
  989. const w = new BrowserWindow({ show: false });
  990. w.webContents.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  991. w.webContents.executeJavaScript('{ b = window.open("about:blank"); null }');
  992. const [, { webContents }] = await once(app, 'browser-window-created') as [any, BrowserWindow];
  993. await once(webContents, 'did-finish-load');
  994. // When it loads, redirect
  995. w.webContents.executeJavaScript(`{ b.location = ${JSON.stringify(`file://${fixturesPath}/pages/base-page.html`)}; null }`);
  996. await once(webContents, 'did-finish-load');
  997. });
  998. it('defines a window.location.href setter', async () => {
  999. const w = new BrowserWindow({ show: false });
  1000. w.webContents.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  1001. w.webContents.executeJavaScript('{ b = window.open("about:blank"); null }');
  1002. const [, { webContents }] = await once(app, 'browser-window-created') as [any, BrowserWindow];
  1003. await once(webContents, 'did-finish-load');
  1004. // When it loads, redirect
  1005. w.webContents.executeJavaScript(`{ b.location.href = ${JSON.stringify(`file://${fixturesPath}/pages/base-page.html`)}; null }`);
  1006. await once(webContents, 'did-finish-load');
  1007. });
  1008. it('open a blank page when no URL is specified', async () => {
  1009. const w = new BrowserWindow({ show: false });
  1010. w.loadURL('about:blank');
  1011. w.webContents.executeJavaScript('{ b = window.open(); null }');
  1012. const [, { webContents }] = await once(app, 'browser-window-created') as [any, BrowserWindow];
  1013. await once(webContents, 'did-finish-load');
  1014. expect(await w.webContents.executeJavaScript('b.location.href')).to.equal('about:blank');
  1015. });
  1016. it('open a blank page when an empty URL is specified', async () => {
  1017. const w = new BrowserWindow({ show: false });
  1018. w.loadURL('about:blank');
  1019. w.webContents.executeJavaScript('{ b = window.open(\'\'); null }');
  1020. const [, { webContents }] = await once(app, 'browser-window-created') as [any, BrowserWindow];
  1021. await once(webContents, 'did-finish-load');
  1022. expect(await w.webContents.executeJavaScript('b.location.href')).to.equal('about:blank');
  1023. });
  1024. it('does not throw an exception when the frameName is a built-in object property', async () => {
  1025. const w = new BrowserWindow({ show: false });
  1026. w.loadURL('about:blank');
  1027. w.webContents.executeJavaScript('{ b = window.open(\'\', \'__proto__\'); null }');
  1028. const frameName = await new Promise((resolve) => {
  1029. w.webContents.setWindowOpenHandler(details => {
  1030. setImmediate(() => resolve(details.frameName));
  1031. return { action: 'allow' };
  1032. });
  1033. });
  1034. expect(frameName).to.equal('__proto__');
  1035. });
  1036. it('works when used in conjunction with the vm module', async () => {
  1037. const w = new BrowserWindow({
  1038. show: false,
  1039. webPreferences: {
  1040. nodeIntegration: true,
  1041. contextIsolation: false
  1042. }
  1043. });
  1044. await w.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  1045. const { contextObject } = await w.webContents.executeJavaScript(`(async () => {
  1046. const vm = require('node:vm');
  1047. const contextObject = { count: 1, type: 'gecko' };
  1048. window.open('');
  1049. vm.runInNewContext('count += 1; type = "chameleon";', contextObject);
  1050. return { contextObject };
  1051. })()`);
  1052. expect(contextObject).to.deep.equal({ count: 2, type: 'chameleon' });
  1053. });
  1054. // FIXME(nornagon): I'm not sure this ... ever was correct?
  1055. xit('inherit options of parent window', async () => {
  1056. const w = new BrowserWindow({ show: false, width: 123, height: 456 });
  1057. w.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  1058. const url = `file://${fixturesPath}/pages/window-open-size.html`;
  1059. const { width, height, eventData } = await w.webContents.executeJavaScript(`(async () => {
  1060. const message = new Promise(resolve => window.addEventListener('message', resolve, {once: true}));
  1061. const b = window.open(${JSON.stringify(url)}, '', 'show=false')
  1062. const e = await message
  1063. b.close();
  1064. const width = outerWidth;
  1065. const height = outerHeight;
  1066. return {
  1067. width,
  1068. height,
  1069. eventData: e.data
  1070. }
  1071. })()`);
  1072. expect(eventData).to.equal(`size: ${width} ${height}`);
  1073. expect(eventData).to.equal('size: 123 456');
  1074. });
  1075. it('does not override child options', async () => {
  1076. const w = new BrowserWindow({ show: false });
  1077. w.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  1078. const windowUrl = `file://${fixturesPath}/pages/window-open-size.html`;
  1079. const { eventData } = await w.webContents.executeJavaScript(`(async () => {
  1080. const message = new Promise(resolve => window.addEventListener('message', resolve, {once: true}));
  1081. const b = window.open(${JSON.stringify(windowUrl)}, '', 'show=no,width=350,height=450')
  1082. const e = await message
  1083. b.close();
  1084. return { eventData: e.data }
  1085. })()`);
  1086. expect(eventData).to.equal('size: 350 450');
  1087. });
  1088. it('loads preload script after setting opener to null', async () => {
  1089. const w = new BrowserWindow({ show: false });
  1090. w.webContents.setWindowOpenHandler(() => ({
  1091. action: 'allow',
  1092. overrideBrowserWindowOptions: {
  1093. webPreferences: {
  1094. preload: path.join(fixturesPath, 'module', 'preload.js')
  1095. }
  1096. }
  1097. }));
  1098. w.loadURL('about:blank');
  1099. w.webContents.executeJavaScript('window.child = window.open(); child.opener = null');
  1100. const [, { webContents }] = await once(app, 'browser-window-created');
  1101. const [,, message] = await once(webContents, 'console-message');
  1102. expect(message).to.equal('{"require":"function","module":"object","exports":"object","process":"object","Buffer":"function"}');
  1103. });
  1104. it('disables the <webview> tag when it is disabled on the parent window', async () => {
  1105. const windowUrl = url.pathToFileURL(path.join(fixturesPath, 'pages', 'window-opener-no-webview-tag.html'));
  1106. windowUrl.searchParams.set('p', `${fixturesPath}/pages/window-opener-webview.html`);
  1107. const w = new BrowserWindow({ show: false });
  1108. w.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  1109. const { eventData } = await w.webContents.executeJavaScript(`(async () => {
  1110. const message = new Promise(resolve => window.addEventListener('message', resolve, {once: true}));
  1111. const b = window.open(${JSON.stringify(windowUrl)}, '', 'webviewTag=no,contextIsolation=no,nodeIntegration=yes,show=no')
  1112. const e = await message
  1113. b.close();
  1114. return { eventData: e.data }
  1115. })()`);
  1116. expect(eventData.isWebViewGlobalUndefined).to.be.true();
  1117. });
  1118. it('throws an exception when the arguments cannot be converted to strings', async () => {
  1119. const w = new BrowserWindow({ show: false });
  1120. w.loadURL('about:blank');
  1121. await expect(
  1122. w.webContents.executeJavaScript('window.open(\'\', { toString: null })')
  1123. ).to.eventually.be.rejected();
  1124. await expect(
  1125. w.webContents.executeJavaScript('window.open(\'\', \'\', { toString: 3 })')
  1126. ).to.eventually.be.rejected();
  1127. });
  1128. it('does not throw an exception when the features include webPreferences', async () => {
  1129. const w = new BrowserWindow({ show: false });
  1130. w.loadURL('about:blank');
  1131. await expect(
  1132. w.webContents.executeJavaScript('window.open(\'\', \'\', \'show=no,webPreferences=\'); null')
  1133. ).to.eventually.be.fulfilled();
  1134. });
  1135. });
  1136. describe('window.opener', () => {
  1137. it('is null for main window', async () => {
  1138. const w = new BrowserWindow({
  1139. show: false,
  1140. webPreferences: {
  1141. nodeIntegration: true,
  1142. contextIsolation: false
  1143. }
  1144. });
  1145. w.loadFile(path.join(fixturesPath, 'pages', 'window-opener.html'));
  1146. const [, channel, opener] = await once(w.webContents, 'ipc-message');
  1147. expect(channel).to.equal('opener');
  1148. expect(opener).to.equal(null);
  1149. });
  1150. it('is not null for window opened by window.open', async () => {
  1151. const w = new BrowserWindow({
  1152. show: false,
  1153. webPreferences: {
  1154. nodeIntegration: true,
  1155. contextIsolation: false
  1156. }
  1157. });
  1158. w.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  1159. const windowUrl = `file://${fixturesPath}/pages/window-opener.html`;
  1160. const eventData = await w.webContents.executeJavaScript(`
  1161. const b = window.open(${JSON.stringify(windowUrl)}, '', 'show=no');
  1162. new Promise(resolve => window.addEventListener('message', resolve, {once: true})).then(e => e.data);
  1163. `);
  1164. expect(eventData).to.equal('object');
  1165. });
  1166. });
  1167. describe('window.opener.postMessage', () => {
  1168. it('sets source and origin correctly', async () => {
  1169. const w = new BrowserWindow({ show: false });
  1170. w.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  1171. const windowUrl = `file://${fixturesPath}/pages/window-opener-postMessage.html`;
  1172. const { sourceIsChild, origin } = await w.webContents.executeJavaScript(`
  1173. const b = window.open(${JSON.stringify(windowUrl)}, '', 'show=no');
  1174. new Promise(resolve => window.addEventListener('message', resolve, {once: true})).then(e => ({
  1175. sourceIsChild: e.source === b,
  1176. origin: e.origin
  1177. }));
  1178. `);
  1179. expect(sourceIsChild).to.be.true();
  1180. expect(origin).to.equal('file://');
  1181. });
  1182. it('supports windows opened from a <webview>', async () => {
  1183. const w = new BrowserWindow({ show: false, webPreferences: { webviewTag: true } });
  1184. w.loadURL('about:blank');
  1185. const childWindowUrl = url.pathToFileURL(path.join(fixturesPath, 'pages', 'webview-opener-postMessage.html'));
  1186. childWindowUrl.searchParams.set('p', `${fixturesPath}/pages/window-opener-postMessage.html`);
  1187. const message = await w.webContents.executeJavaScript(`
  1188. const webview = new WebView();
  1189. webview.allowpopups = true;
  1190. webview.setAttribute('webpreferences', 'contextIsolation=no');
  1191. webview.src = ${JSON.stringify(childWindowUrl)}
  1192. const consoleMessage = new Promise(resolve => webview.addEventListener('console-message', resolve, {once: true}));
  1193. document.body.appendChild(webview);
  1194. consoleMessage.then(e => e.message)
  1195. `);
  1196. expect(message).to.equal('message');
  1197. });
  1198. describe('targetOrigin argument', () => {
  1199. let serverURL: string;
  1200. let server: any;
  1201. beforeEach(async () => {
  1202. server = http.createServer((req, res) => {
  1203. res.writeHead(200);
  1204. const filePath = path.join(fixturesPath, 'pages', 'window-opener-targetOrigin.html');
  1205. res.end(fs.readFileSync(filePath, 'utf8'));
  1206. });
  1207. serverURL = (await listen(server)).url;
  1208. });
  1209. afterEach(() => {
  1210. server.close();
  1211. });
  1212. it('delivers messages that match the origin', async () => {
  1213. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  1214. w.loadFile(path.resolve(__dirname, 'fixtures', 'blank.html'));
  1215. const data = await w.webContents.executeJavaScript(`
  1216. window.open(${JSON.stringify(serverURL)}, '', 'show=no,contextIsolation=no,nodeIntegration=yes');
  1217. new Promise(resolve => window.addEventListener('message', resolve, {once: true})).then(e => e.data)
  1218. `);
  1219. expect(data).to.equal('deliver');
  1220. });
  1221. });
  1222. });
  1223. describe('IdleDetection', () => {
  1224. afterEach(closeAllWindows);
  1225. afterEach(() => {
  1226. session.defaultSession.setPermissionCheckHandler(null);
  1227. session.defaultSession.setPermissionRequestHandler(null);
  1228. });
  1229. it('can grant a permission request', async () => {
  1230. session.defaultSession.setPermissionRequestHandler(
  1231. (_wc, permission, callback) => {
  1232. callback(permission === 'idle-detection');
  1233. }
  1234. );
  1235. const w = new BrowserWindow({ show: false });
  1236. await w.loadFile(path.join(fixturesPath, 'pages', 'button.html'));
  1237. const permission = await w.webContents.executeJavaScript(`
  1238. new Promise((resolve, reject) => {
  1239. const button = document.getElementById('button');
  1240. button.addEventListener("click", async () => {
  1241. const permission = await IdleDetector.requestPermission();
  1242. resolve(permission);
  1243. });
  1244. button.click();
  1245. });
  1246. `, true);
  1247. expect(permission).to.eq('granted');
  1248. });
  1249. it('can deny a permission request', async () => {
  1250. session.defaultSession.setPermissionRequestHandler(
  1251. (_wc, permission, callback) => {
  1252. callback(permission !== 'idle-detection');
  1253. }
  1254. );
  1255. const w = new BrowserWindow({ show: false });
  1256. await w.loadFile(path.join(fixturesPath, 'pages', 'button.html'));
  1257. const permission = await w.webContents.executeJavaScript(`
  1258. new Promise((resolve, reject) => {
  1259. const button = document.getElementById('button');
  1260. button.addEventListener("click", async () => {
  1261. const permission = await IdleDetector.requestPermission();
  1262. resolve(permission);
  1263. });
  1264. button.click();
  1265. });
  1266. `, true);
  1267. expect(permission).to.eq('denied');
  1268. });
  1269. it('can allow the IdleDetector to start', async () => {
  1270. session.defaultSession.setPermissionCheckHandler((wc, permission) => {
  1271. return permission === 'idle-detection';
  1272. });
  1273. const w = new BrowserWindow({ show: false });
  1274. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  1275. const result = await w.webContents.executeJavaScript(`
  1276. const detector = new IdleDetector({ threshold: 60000 });
  1277. detector.start().then(() => {
  1278. return 'success';
  1279. }).catch(e => e.message);
  1280. `, true);
  1281. expect(result).to.eq('success');
  1282. });
  1283. it('can prevent the IdleDetector from starting', async () => {
  1284. session.defaultSession.setPermissionCheckHandler((wc, permission) => {
  1285. return permission !== 'idle-detection';
  1286. });
  1287. const w = new BrowserWindow({ show: false });
  1288. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  1289. const result = await w.webContents.executeJavaScript(`
  1290. const detector = new IdleDetector({ threshold: 60000 });
  1291. detector.start().then(() => {
  1292. console.log('success')
  1293. }).catch(e => e.message);
  1294. `, true);
  1295. expect(result).to.eq('Idle detection permission denied');
  1296. });
  1297. });
  1298. describe('navigator.mediaDevices', () => {
  1299. afterEach(closeAllWindows);
  1300. afterEach(() => {
  1301. session.defaultSession.setPermissionCheckHandler(null);
  1302. session.defaultSession.setPermissionRequestHandler(null);
  1303. });
  1304. it('can return labels of enumerated devices', async () => {
  1305. const w = new BrowserWindow({ show: false });
  1306. w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  1307. const labels = await w.webContents.executeJavaScript('navigator.mediaDevices.enumerateDevices().then(ds => ds.map(d => d.label))');
  1308. expect(labels.some((l: any) => l)).to.be.true();
  1309. });
  1310. it('does not return labels of enumerated devices when permission denied', async () => {
  1311. session.defaultSession.setPermissionCheckHandler(() => false);
  1312. const w = new BrowserWindow({ show: false });
  1313. w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  1314. const labels = await w.webContents.executeJavaScript('navigator.mediaDevices.enumerateDevices().then(ds => ds.map(d => d.label))');
  1315. expect(labels.some((l: any) => l)).to.be.false();
  1316. });
  1317. it('returns the same device ids across reloads', async () => {
  1318. const ses = session.fromPartition('persist:media-device-id');
  1319. const w = new BrowserWindow({
  1320. show: false,
  1321. webPreferences: {
  1322. nodeIntegration: true,
  1323. session: ses,
  1324. contextIsolation: false
  1325. }
  1326. });
  1327. w.loadFile(path.join(fixturesPath, 'pages', 'media-id-reset.html'));
  1328. const [, firstDeviceIds] = await once(ipcMain, 'deviceIds');
  1329. w.webContents.reload();
  1330. const [, secondDeviceIds] = await once(ipcMain, 'deviceIds');
  1331. expect(firstDeviceIds).to.deep.equal(secondDeviceIds);
  1332. });
  1333. it('can return new device id when cookie storage is cleared', async () => {
  1334. const ses = session.fromPartition('persist:media-device-id');
  1335. const w = new BrowserWindow({
  1336. show: false,
  1337. webPreferences: {
  1338. nodeIntegration: true,
  1339. session: ses,
  1340. contextIsolation: false
  1341. }
  1342. });
  1343. w.loadFile(path.join(fixturesPath, 'pages', 'media-id-reset.html'));
  1344. const [, firstDeviceIds] = await once(ipcMain, 'deviceIds');
  1345. await ses.clearStorageData({ storages: ['cookies'] });
  1346. w.webContents.reload();
  1347. const [, secondDeviceIds] = await once(ipcMain, 'deviceIds');
  1348. expect(firstDeviceIds).to.not.deep.equal(secondDeviceIds);
  1349. });
  1350. it('provides a securityOrigin to the request handler', async () => {
  1351. session.defaultSession.setPermissionRequestHandler(
  1352. (wc, permission, callback, details) => {
  1353. if (details.securityOrigin !== undefined) {
  1354. callback(true);
  1355. } else {
  1356. callback(false);
  1357. }
  1358. }
  1359. );
  1360. const w = new BrowserWindow({ show: false });
  1361. w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  1362. const labels = await w.webContents.executeJavaScript(`navigator.mediaDevices.getUserMedia({
  1363. video: {
  1364. mandatory: {
  1365. chromeMediaSource: "desktop",
  1366. minWidth: 1280,
  1367. maxWidth: 1280,
  1368. minHeight: 720,
  1369. maxHeight: 720
  1370. }
  1371. }
  1372. }).then((stream) => stream.getVideoTracks())`);
  1373. expect(labels.some((l: any) => l)).to.be.true();
  1374. });
  1375. it('fails with "not supported" for getDisplayMedia', async () => {
  1376. const w = new BrowserWindow({ show: false });
  1377. w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  1378. const { ok, err } = await w.webContents.executeJavaScript('navigator.mediaDevices.getDisplayMedia({video: true}).then(s => ({ok: true}), e => ({ok: false, err: e.message}))', true);
  1379. expect(ok).to.be.false();
  1380. expect(err).to.equal('Not supported');
  1381. });
  1382. });
  1383. describe('window.opener access', () => {
  1384. const scheme = 'app';
  1385. const fileUrl = `file://${fixturesPath}/pages/window-opener-location.html`;
  1386. const httpUrl1 = `${scheme}://origin1`;
  1387. const httpUrl2 = `${scheme}://origin2`;
  1388. const fileBlank = `file://${fixturesPath}/pages/blank.html`;
  1389. const httpBlank = `${scheme}://origin1/blank`;
  1390. const table = [
  1391. { parent: fileBlank, child: httpUrl1, nodeIntegration: false, openerAccessible: false },
  1392. { parent: fileBlank, child: httpUrl1, nodeIntegration: true, openerAccessible: false },
  1393. // {parent: httpBlank, child: fileUrl, nodeIntegration: false, openerAccessible: false}, // can't window.open()
  1394. // {parent: httpBlank, child: fileUrl, nodeIntegration: true, openerAccessible: false}, // can't window.open()
  1395. // NB. this is different from Chrome's behavior, which isolates file: urls from each other
  1396. { parent: fileBlank, child: fileUrl, nodeIntegration: false, openerAccessible: true },
  1397. { parent: fileBlank, child: fileUrl, nodeIntegration: true, openerAccessible: true },
  1398. { parent: httpBlank, child: httpUrl1, nodeIntegration: false, openerAccessible: true },
  1399. { parent: httpBlank, child: httpUrl1, nodeIntegration: true, openerAccessible: true },
  1400. { parent: httpBlank, child: httpUrl2, nodeIntegration: false, openerAccessible: false },
  1401. { parent: httpBlank, child: httpUrl2, nodeIntegration: true, openerAccessible: false }
  1402. ];
  1403. const s = (url: string) => url.startsWith('file') ? 'file://...' : url;
  1404. before(() => {
  1405. protocol.registerFileProtocol(scheme, (request, callback) => {
  1406. if (request.url.includes('blank')) {
  1407. callback(`${fixturesPath}/pages/blank.html`);
  1408. } else {
  1409. callback(`${fixturesPath}/pages/window-opener-location.html`);
  1410. }
  1411. });
  1412. });
  1413. after(() => {
  1414. protocol.unregisterProtocol(scheme);
  1415. });
  1416. afterEach(closeAllWindows);
  1417. describe('when opened from main window', () => {
  1418. for (const { parent, child, nodeIntegration, openerAccessible } of table) {
  1419. for (const sandboxPopup of [false, true]) {
  1420. const description = `when parent=${s(parent)} opens child=${s(child)} with nodeIntegration=${nodeIntegration} sandboxPopup=${sandboxPopup}, child should ${openerAccessible ? '' : 'not '}be able to access opener`;
  1421. it(description, async () => {
  1422. const w = new BrowserWindow({ show: true, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  1423. w.webContents.setWindowOpenHandler(() => ({
  1424. action: 'allow',
  1425. overrideBrowserWindowOptions: {
  1426. webPreferences: {
  1427. sandbox: sandboxPopup
  1428. }
  1429. }
  1430. }));
  1431. await w.loadURL(parent);
  1432. const childOpenerLocation = await w.webContents.executeJavaScript(`new Promise(resolve => {
  1433. window.addEventListener('message', function f(e) {
  1434. resolve(e.data)
  1435. })
  1436. window.open(${JSON.stringify(child)}, "", "show=no,nodeIntegration=${nodeIntegration ? 'yes' : 'no'}")
  1437. })`);
  1438. if (openerAccessible) {
  1439. expect(childOpenerLocation).to.be.a('string');
  1440. } else {
  1441. expect(childOpenerLocation).to.be.null();
  1442. }
  1443. });
  1444. }
  1445. }
  1446. });
  1447. describe('when opened from <webview>', () => {
  1448. for (const { parent, child, nodeIntegration, openerAccessible } of table) {
  1449. const description = `when parent=${s(parent)} opens child=${s(child)} with nodeIntegration=${nodeIntegration}, child should ${openerAccessible ? '' : 'not '}be able to access opener`;
  1450. it(description, async () => {
  1451. // This test involves three contexts:
  1452. // 1. The root BrowserWindow in which the test is run,
  1453. // 2. A <webview> belonging to the root window,
  1454. // 3. A window opened by calling window.open() from within the <webview>.
  1455. // We are testing whether context (3) can access context (2) under various conditions.
  1456. // This is context (1), the base window for the test.
  1457. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, webviewTag: true, contextIsolation: false } });
  1458. await w.loadURL('about:blank');
  1459. const parentCode = `new Promise((resolve) => {
  1460. // This is context (3), a child window of the WebView.
  1461. const child = window.open(${JSON.stringify(child)}, "", "show=no,contextIsolation=no,nodeIntegration=yes")
  1462. window.addEventListener("message", e => {
  1463. resolve(e.data)
  1464. })
  1465. })`;
  1466. const childOpenerLocation = await w.webContents.executeJavaScript(`new Promise((resolve, reject) => {
  1467. // This is context (2), a WebView which will call window.open()
  1468. const webview = new WebView()
  1469. webview.setAttribute('nodeintegration', '${nodeIntegration ? 'on' : 'off'}')
  1470. webview.setAttribute('webpreferences', 'contextIsolation=no')
  1471. webview.setAttribute('allowpopups', 'on')
  1472. webview.src = ${JSON.stringify(parent + '?p=' + encodeURIComponent(child))}
  1473. webview.addEventListener('dom-ready', async () => {
  1474. webview.executeJavaScript(${JSON.stringify(parentCode)}).then(resolve, reject)
  1475. })
  1476. document.body.appendChild(webview)
  1477. })`);
  1478. if (openerAccessible) {
  1479. expect(childOpenerLocation).to.be.a('string');
  1480. } else {
  1481. expect(childOpenerLocation).to.be.null();
  1482. }
  1483. });
  1484. }
  1485. });
  1486. });
  1487. describe('storage', () => {
  1488. describe('custom non standard schemes', () => {
  1489. const protocolName = 'storage';
  1490. let contents: WebContents;
  1491. before(() => {
  1492. protocol.registerFileProtocol(protocolName, (request, callback) => {
  1493. const parsedUrl = url.parse(request.url);
  1494. let filename;
  1495. switch (parsedUrl.pathname) {
  1496. case '/localStorage' : filename = 'local_storage.html'; break;
  1497. case '/sessionStorage' : filename = 'session_storage.html'; break;
  1498. case '/WebSQL' : filename = 'web_sql.html'; break;
  1499. case '/indexedDB' : filename = 'indexed_db.html'; break;
  1500. case '/cookie' : filename = 'cookie.html'; break;
  1501. default : filename = '';
  1502. }
  1503. callback({ path: `${fixturesPath}/pages/storage/${filename}` });
  1504. });
  1505. });
  1506. after(() => {
  1507. protocol.unregisterProtocol(protocolName);
  1508. });
  1509. beforeEach(() => {
  1510. contents = (webContents as typeof ElectronInternal.WebContents).create({
  1511. nodeIntegration: true,
  1512. contextIsolation: false
  1513. });
  1514. });
  1515. afterEach(() => {
  1516. contents.destroy();
  1517. contents = null as any;
  1518. });
  1519. it('cannot access localStorage', async () => {
  1520. const response = once(ipcMain, 'local-storage-response');
  1521. contents.loadURL(protocolName + '://host/localStorage');
  1522. const [, error] = await response;
  1523. expect(error).to.equal('Failed to read the \'localStorage\' property from \'Window\': Access is denied for this document.');
  1524. });
  1525. it('cannot access sessionStorage', async () => {
  1526. const response = once(ipcMain, 'session-storage-response');
  1527. contents.loadURL(`${protocolName}://host/sessionStorage`);
  1528. const [, error] = await response;
  1529. expect(error).to.equal('Failed to read the \'sessionStorage\' property from \'Window\': Access is denied for this document.');
  1530. });
  1531. it('cannot access WebSQL database', async () => {
  1532. const response = once(ipcMain, 'web-sql-response');
  1533. contents.loadURL(`${protocolName}://host/WebSQL`);
  1534. const [, error] = await response;
  1535. expect(error).to.equal('Failed to execute \'openDatabase\' on \'Window\': Access to the WebDatabase API is denied in this context.');
  1536. });
  1537. it('cannot access indexedDB', async () => {
  1538. const response = once(ipcMain, 'indexed-db-response');
  1539. contents.loadURL(`${protocolName}://host/indexedDB`);
  1540. const [, error] = await response;
  1541. expect(error).to.equal('Failed to execute \'open\' on \'IDBFactory\': access to the Indexed Database API is denied in this context.');
  1542. });
  1543. it('cannot access cookie', async () => {
  1544. const response = once(ipcMain, 'cookie-response');
  1545. contents.loadURL(`${protocolName}://host/cookie`);
  1546. const [, error] = await response;
  1547. expect(error).to.equal('Failed to set the \'cookie\' property on \'Document\': Access is denied for this document.');
  1548. });
  1549. });
  1550. describe('can be accessed', () => {
  1551. let server: http.Server;
  1552. let serverUrl: string;
  1553. let serverCrossSiteUrl: string;
  1554. before(async () => {
  1555. server = http.createServer((req, res) => {
  1556. const respond = () => {
  1557. if (req.url === '/redirect-cross-site') {
  1558. res.setHeader('Location', `${serverCrossSiteUrl}/redirected`);
  1559. res.statusCode = 302;
  1560. res.end();
  1561. } else if (req.url === '/redirected') {
  1562. res.end('<html><script>window.localStorage</script></html>');
  1563. } else {
  1564. res.end();
  1565. }
  1566. };
  1567. setTimeout().then(respond);
  1568. });
  1569. serverUrl = (await listen(server)).url;
  1570. serverCrossSiteUrl = serverUrl.replace('127.0.0.1', 'localhost');
  1571. });
  1572. after(() => {
  1573. server.close();
  1574. server = null as any;
  1575. });
  1576. afterEach(closeAllWindows);
  1577. const testLocalStorageAfterXSiteRedirect = (testTitle: string, extraPreferences = {}) => {
  1578. it(testTitle, async () => {
  1579. const w = new BrowserWindow({
  1580. show: false,
  1581. ...extraPreferences
  1582. });
  1583. let redirected = false;
  1584. w.webContents.on('render-process-gone', () => {
  1585. expect.fail('renderer crashed / was killed');
  1586. });
  1587. w.webContents.on('did-redirect-navigation', (event, url) => {
  1588. expect(url).to.equal(`${serverCrossSiteUrl}/redirected`);
  1589. redirected = true;
  1590. });
  1591. await w.loadURL(`${serverUrl}/redirect-cross-site`);
  1592. expect(redirected).to.be.true('didnt redirect');
  1593. });
  1594. };
  1595. testLocalStorageAfterXSiteRedirect('after a cross-site redirect');
  1596. testLocalStorageAfterXSiteRedirect('after a cross-site redirect in sandbox mode', { sandbox: true });
  1597. });
  1598. describe('enableWebSQL webpreference', () => {
  1599. const origin = `${standardScheme}://fake-host`;
  1600. const filePath = path.join(fixturesPath, 'pages', 'storage', 'web_sql.html');
  1601. const sqlPartition = 'web-sql-preference-test';
  1602. const sqlSession = session.fromPartition(sqlPartition);
  1603. const securityError = 'An attempt was made to break through the security policy of the user agent.';
  1604. let contents: WebContents, w: BrowserWindow;
  1605. before(() => {
  1606. sqlSession.protocol.registerFileProtocol(standardScheme, (request, callback) => {
  1607. callback({ path: filePath });
  1608. });
  1609. });
  1610. after(() => {
  1611. sqlSession.protocol.unregisterProtocol(standardScheme);
  1612. });
  1613. afterEach(async () => {
  1614. if (contents) {
  1615. contents.destroy();
  1616. contents = null as any;
  1617. }
  1618. await closeAllWindows();
  1619. (w as any) = null;
  1620. });
  1621. it('default value allows websql', async () => {
  1622. contents = (webContents as typeof ElectronInternal.WebContents).create({
  1623. session: sqlSession,
  1624. nodeIntegration: true,
  1625. contextIsolation: false
  1626. });
  1627. contents.loadURL(origin);
  1628. const [, error] = await once(ipcMain, 'web-sql-response');
  1629. expect(error).to.be.null();
  1630. });
  1631. it('when set to false can disallow websql', async () => {
  1632. contents = (webContents as typeof ElectronInternal.WebContents).create({
  1633. session: sqlSession,
  1634. nodeIntegration: true,
  1635. enableWebSQL: false,
  1636. contextIsolation: false
  1637. });
  1638. contents.loadURL(origin);
  1639. const [, error] = await once(ipcMain, 'web-sql-response');
  1640. expect(error).to.equal(securityError);
  1641. });
  1642. it('when set to false does not disable indexedDB', async () => {
  1643. contents = (webContents as typeof ElectronInternal.WebContents).create({
  1644. session: sqlSession,
  1645. nodeIntegration: true,
  1646. enableWebSQL: false,
  1647. contextIsolation: false
  1648. });
  1649. contents.loadURL(origin);
  1650. const [, error] = await once(ipcMain, 'web-sql-response');
  1651. expect(error).to.equal(securityError);
  1652. const dbName = 'random';
  1653. const result = await contents.executeJavaScript(`
  1654. new Promise((resolve, reject) => {
  1655. try {
  1656. let req = window.indexedDB.open('${dbName}');
  1657. req.onsuccess = (event) => {
  1658. let db = req.result;
  1659. resolve(db.name);
  1660. }
  1661. req.onerror = (event) => { resolve(event.target.code); }
  1662. } catch (e) {
  1663. resolve(e.message);
  1664. }
  1665. });
  1666. `);
  1667. expect(result).to.equal(dbName);
  1668. });
  1669. it('child webContents can override when the embedder has allowed websql', async () => {
  1670. w = new BrowserWindow({
  1671. show: false,
  1672. webPreferences: {
  1673. nodeIntegration: true,
  1674. webviewTag: true,
  1675. session: sqlSession,
  1676. contextIsolation: false
  1677. }
  1678. });
  1679. w.webContents.loadURL(origin);
  1680. const [, error] = await once(ipcMain, 'web-sql-response');
  1681. expect(error).to.be.null();
  1682. const webviewResult = once(ipcMain, 'web-sql-response');
  1683. await w.webContents.executeJavaScript(`
  1684. new Promise((resolve, reject) => {
  1685. const webview = new WebView();
  1686. webview.setAttribute('src', '${origin}');
  1687. webview.setAttribute('webpreferences', 'enableWebSQL=0,contextIsolation=no');
  1688. webview.setAttribute('partition', '${sqlPartition}');
  1689. webview.setAttribute('nodeIntegration', 'on');
  1690. document.body.appendChild(webview);
  1691. webview.addEventListener('dom-ready', () => resolve());
  1692. });
  1693. `);
  1694. const [, childError] = await webviewResult;
  1695. expect(childError).to.equal(securityError);
  1696. });
  1697. it('child webContents cannot override when the embedder has disallowed websql', async () => {
  1698. w = new BrowserWindow({
  1699. show: false,
  1700. webPreferences: {
  1701. nodeIntegration: true,
  1702. enableWebSQL: false,
  1703. webviewTag: true,
  1704. session: sqlSession,
  1705. contextIsolation: false
  1706. }
  1707. });
  1708. w.webContents.loadURL('data:text/html,<html></html>');
  1709. const webviewResult = once(ipcMain, 'web-sql-response');
  1710. await w.webContents.executeJavaScript(`
  1711. new Promise((resolve, reject) => {
  1712. const webview = new WebView();
  1713. webview.setAttribute('src', '${origin}');
  1714. webview.setAttribute('webpreferences', 'enableWebSQL=1,contextIsolation=no');
  1715. webview.setAttribute('partition', '${sqlPartition}');
  1716. webview.setAttribute('nodeIntegration', 'on');
  1717. document.body.appendChild(webview);
  1718. webview.addEventListener('dom-ready', () => resolve());
  1719. });
  1720. `);
  1721. const [, childError] = await webviewResult;
  1722. expect(childError).to.equal(securityError);
  1723. });
  1724. it('child webContents can use websql when the embedder has allowed websql', async () => {
  1725. w = new BrowserWindow({
  1726. show: false,
  1727. webPreferences: {
  1728. nodeIntegration: true,
  1729. webviewTag: true,
  1730. session: sqlSession,
  1731. contextIsolation: false
  1732. }
  1733. });
  1734. w.webContents.loadURL(origin);
  1735. const [, error] = await once(ipcMain, 'web-sql-response');
  1736. expect(error).to.be.null();
  1737. const webviewResult = once(ipcMain, 'web-sql-response');
  1738. await w.webContents.executeJavaScript(`
  1739. new Promise((resolve, reject) => {
  1740. const webview = new WebView();
  1741. webview.setAttribute('src', '${origin}');
  1742. webview.setAttribute('webpreferences', 'enableWebSQL=1,contextIsolation=no');
  1743. webview.setAttribute('partition', '${sqlPartition}');
  1744. webview.setAttribute('nodeIntegration', 'on');
  1745. document.body.appendChild(webview);
  1746. webview.addEventListener('dom-ready', () => resolve());
  1747. });
  1748. `);
  1749. const [, childError] = await webviewResult;
  1750. expect(childError).to.be.null();
  1751. });
  1752. });
  1753. describe('DOM storage quota increase', () => {
  1754. for (const storageName of ['localStorage', 'sessionStorage']) {
  1755. it(`allows saving at least 40MiB in ${storageName}`, async () => {
  1756. const w = new BrowserWindow({ show: false });
  1757. w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  1758. // Although JavaScript strings use UTF-16, the underlying
  1759. // storage provider may encode strings differently, muddling the
  1760. // translation between character and byte counts. However,
  1761. // a string of 40 * 2^20 characters will require at least 40MiB
  1762. // and presumably no more than 80MiB, a size guaranteed to
  1763. // to exceed the original 10MiB quota yet stay within the
  1764. // new 100MiB quota.
  1765. // Note that both the key name and value affect the total size.
  1766. const testKeyName = '_electronDOMStorageQuotaIncreasedTest';
  1767. const length = 40 * Math.pow(2, 20) - testKeyName.length;
  1768. await w.webContents.executeJavaScript(`
  1769. ${storageName}.setItem(${JSON.stringify(testKeyName)}, 'X'.repeat(${length}));
  1770. `);
  1771. // Wait at least one turn of the event loop to help avoid false positives
  1772. // Although not entirely necessary, the previous version of this test case
  1773. // failed to detect a real problem (perhaps related to DOM storage data caching)
  1774. // wherein calling `getItem` immediately after `setItem` would appear to work
  1775. // but then later (e.g. next tick) it would not.
  1776. await setTimeout(1);
  1777. try {
  1778. const storedLength = await w.webContents.executeJavaScript(`${storageName}.getItem(${JSON.stringify(testKeyName)}).length`);
  1779. expect(storedLength).to.equal(length);
  1780. } finally {
  1781. await w.webContents.executeJavaScript(`${storageName}.removeItem(${JSON.stringify(testKeyName)});`);
  1782. }
  1783. });
  1784. it(`throws when attempting to use more than 128MiB in ${storageName}`, async () => {
  1785. const w = new BrowserWindow({ show: false });
  1786. w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  1787. await expect((async () => {
  1788. const testKeyName = '_electronDOMStorageQuotaStillEnforcedTest';
  1789. const length = 128 * Math.pow(2, 20) - testKeyName.length;
  1790. try {
  1791. await w.webContents.executeJavaScript(`
  1792. ${storageName}.setItem(${JSON.stringify(testKeyName)}, 'X'.repeat(${length}));
  1793. `);
  1794. } finally {
  1795. await w.webContents.executeJavaScript(`${storageName}.removeItem(${JSON.stringify(testKeyName)});`);
  1796. }
  1797. })()).to.eventually.be.rejected();
  1798. });
  1799. }
  1800. });
  1801. describe('persistent storage', () => {
  1802. it('can be requested', async () => {
  1803. const w = new BrowserWindow({ show: false });
  1804. w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  1805. const grantedBytes = await w.webContents.executeJavaScript(`new Promise(resolve => {
  1806. navigator.webkitPersistentStorage.requestQuota(1024 * 1024, resolve);
  1807. })`);
  1808. expect(grantedBytes).to.equal(1048576);
  1809. });
  1810. });
  1811. });
  1812. ifdescribe(features.isPDFViewerEnabled())('PDF Viewer', () => {
  1813. const pdfSource = url.format({
  1814. pathname: path.join(__dirname, 'fixtures', 'cat.pdf').replaceAll('\\', '/'),
  1815. protocol: 'file',
  1816. slashes: true
  1817. });
  1818. it('successfully loads a PDF file', async () => {
  1819. const w = new BrowserWindow({ show: false });
  1820. w.loadURL(pdfSource);
  1821. await once(w.webContents, 'did-finish-load');
  1822. });
  1823. it('opens when loading a pdf resource as top level navigation', async () => {
  1824. const w = new BrowserWindow({ show: false });
  1825. w.loadURL(pdfSource);
  1826. const [, contents] = await once(app, 'web-contents-created') as [any, WebContents];
  1827. await once(contents, 'did-navigate');
  1828. expect(contents.getURL()).to.equal('chrome-extension://mhjfbmdgcfjbbpaeojofohoefgiehjai/index.html');
  1829. });
  1830. it('opens when loading a pdf resource in a iframe', async () => {
  1831. const w = new BrowserWindow({ show: false });
  1832. w.loadFile(path.join(__dirname, 'fixtures', 'pages', 'pdf-in-iframe.html'));
  1833. const [, contents] = await once(app, 'web-contents-created') as [any, WebContents];
  1834. await once(contents, 'did-navigate');
  1835. expect(contents.getURL()).to.equal('chrome-extension://mhjfbmdgcfjbbpaeojofohoefgiehjai/index.html');
  1836. });
  1837. });
  1838. describe('window.history', () => {
  1839. describe('window.history.pushState', () => {
  1840. it('should push state after calling history.pushState() from the same url', async () => {
  1841. const w = new BrowserWindow({ show: false });
  1842. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  1843. // History should have current page by now.
  1844. expect(w.webContents.navigationHistory.length()).to.equal(1);
  1845. const waitCommit = once(w.webContents, 'navigation-entry-committed');
  1846. w.webContents.executeJavaScript('window.history.pushState({}, "")');
  1847. await waitCommit;
  1848. // Initial page + pushed state.
  1849. expect(w.webContents.navigationHistory.length()).to.equal(2);
  1850. });
  1851. });
  1852. describe('window.history.back', () => {
  1853. it('should not allow sandboxed iframe to modify main frame state', async () => {
  1854. const w = new BrowserWindow({ show: false });
  1855. w.loadURL('data:text/html,<iframe sandbox="allow-scripts"></iframe>');
  1856. await Promise.all([
  1857. once(w.webContents, 'navigation-entry-committed'),
  1858. once(w.webContents, 'did-frame-navigate'),
  1859. once(w.webContents, 'did-navigate')
  1860. ]);
  1861. w.webContents.executeJavaScript('window.history.pushState(1, "")');
  1862. await Promise.all([
  1863. once(w.webContents, 'navigation-entry-committed'),
  1864. once(w.webContents, 'did-navigate-in-page')
  1865. ]);
  1866. w.webContents.once('navigation-entry-committed' as any, () => {
  1867. expect.fail('Unexpected navigation-entry-committed');
  1868. });
  1869. w.webContents.once('did-navigate-in-page', () => {
  1870. expect.fail('Unexpected did-navigate-in-page');
  1871. });
  1872. await w.webContents.mainFrame.frames[0].executeJavaScript('window.history.back()');
  1873. expect(await w.webContents.executeJavaScript('window.history.state')).to.equal(1);
  1874. expect(w.webContents.navigationHistory.getActiveIndex()).to.equal(1);
  1875. });
  1876. });
  1877. });
  1878. describe('chrome:// pages', () => {
  1879. const urls = [
  1880. 'chrome://accessibility',
  1881. 'chrome://gpu',
  1882. 'chrome://media-internals',
  1883. 'chrome://tracing',
  1884. 'chrome://webrtc-internals',
  1885. 'chrome://process-internals'
  1886. ];
  1887. for (const url of urls) {
  1888. describe(url, () => {
  1889. it('loads the page successfully', async () => {
  1890. const w = new BrowserWindow({ show: false });
  1891. await w.loadURL(url);
  1892. const host = url.substring('chrome://'.length);
  1893. const pageExists = await w.webContents.executeJavaScript(
  1894. `window.hasOwnProperty('chrome') && window.location.host === '${host}'`
  1895. );
  1896. expect(pageExists).to.be.true();
  1897. });
  1898. });
  1899. }
  1900. });
  1901. describe('document.hasFocus', () => {
  1902. it('has correct value when multiple windows are opened', async () => {
  1903. const w1 = new BrowserWindow({ show: true });
  1904. const w2 = new BrowserWindow({ show: true });
  1905. const w3 = new BrowserWindow({ show: false });
  1906. await w1.loadFile(path.join(__dirname, 'fixtures', 'blank.html'));
  1907. await w2.loadFile(path.join(__dirname, 'fixtures', 'blank.html'));
  1908. await w3.loadFile(path.join(__dirname, 'fixtures', 'blank.html'));
  1909. expect(webContents.getFocusedWebContents()?.id).to.equal(w2.webContents.id);
  1910. let focus = false;
  1911. focus = await w1.webContents.executeJavaScript(
  1912. 'document.hasFocus()'
  1913. );
  1914. expect(focus).to.be.false();
  1915. focus = await w2.webContents.executeJavaScript(
  1916. 'document.hasFocus()'
  1917. );
  1918. expect(focus).to.be.true();
  1919. focus = await w3.webContents.executeJavaScript(
  1920. 'document.hasFocus()'
  1921. );
  1922. expect(focus).to.be.false();
  1923. });
  1924. });
  1925. // https://developer.mozilla.org/en-US/docs/Web/API/NetworkInformation
  1926. describe('navigator.connection', () => {
  1927. it('returns the correct value', async () => {
  1928. const w = new BrowserWindow({ show: false });
  1929. w.webContents.session.enableNetworkEmulation({
  1930. latency: 500,
  1931. downloadThroughput: 6400,
  1932. uploadThroughput: 6400
  1933. });
  1934. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  1935. const rtt = await w.webContents.executeJavaScript('navigator.connection.rtt');
  1936. expect(rtt).to.be.a('number');
  1937. const downlink = await w.webContents.executeJavaScript('navigator.connection.downlink');
  1938. expect(downlink).to.be.a('number');
  1939. const effectiveTypes = ['slow-2g', '2g', '3g', '4g'];
  1940. const effectiveType = await w.webContents.executeJavaScript('navigator.connection.effectiveType');
  1941. expect(effectiveTypes).to.include(effectiveType);
  1942. });
  1943. });
  1944. describe('navigator.userAgentData', () => {
  1945. // These tests are done on an http server because navigator.userAgentData
  1946. // requires a secure context.
  1947. let server: http.Server;
  1948. let serverUrl: string;
  1949. before(async () => {
  1950. server = http.createServer((req, res) => {
  1951. res.setHeader('Content-Type', 'text/html');
  1952. res.end('');
  1953. });
  1954. serverUrl = (await listen(server)).url;
  1955. });
  1956. after(() => {
  1957. server.close();
  1958. });
  1959. describe('is not empty', () => {
  1960. it('by default', async () => {
  1961. const w = new BrowserWindow({ show: false });
  1962. await w.loadURL(serverUrl);
  1963. const platform = await w.webContents.executeJavaScript('navigator.userAgentData.platform');
  1964. expect(platform).not.to.be.empty();
  1965. });
  1966. it('when there is a session-wide UA override', async () => {
  1967. const ses = session.fromPartition(`${Math.random()}`);
  1968. ses.setUserAgent('foobar');
  1969. const w = new BrowserWindow({ show: false, webPreferences: { session: ses } });
  1970. await w.loadURL(serverUrl);
  1971. const platform = await w.webContents.executeJavaScript('navigator.userAgentData.platform');
  1972. expect(platform).not.to.be.empty();
  1973. });
  1974. it('when there is a WebContents-specific UA override', async () => {
  1975. const w = new BrowserWindow({ show: false });
  1976. w.webContents.setUserAgent('foo');
  1977. await w.loadURL(serverUrl);
  1978. const platform = await w.webContents.executeJavaScript('navigator.userAgentData.platform');
  1979. expect(platform).not.to.be.empty();
  1980. });
  1981. it('when there is a WebContents-specific UA override at load time', async () => {
  1982. const w = new BrowserWindow({ show: false });
  1983. await w.loadURL(serverUrl, {
  1984. userAgent: 'foo'
  1985. });
  1986. const platform = await w.webContents.executeJavaScript('navigator.userAgentData.platform');
  1987. expect(platform).not.to.be.empty();
  1988. });
  1989. });
  1990. describe('brand list', () => {
  1991. it('contains chromium', async () => {
  1992. const w = new BrowserWindow({ show: false });
  1993. await w.loadURL(serverUrl);
  1994. const brands = await w.webContents.executeJavaScript('navigator.userAgentData.brands');
  1995. expect(brands.map((b: any) => b.brand)).to.include('Chromium');
  1996. });
  1997. });
  1998. });
  1999. describe('Badging API', () => {
  2000. it('does not crash', async () => {
  2001. const w = new BrowserWindow({ show: false });
  2002. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  2003. await w.webContents.executeJavaScript('navigator.setAppBadge(42)');
  2004. await w.webContents.executeJavaScript('navigator.setAppBadge()');
  2005. await w.webContents.executeJavaScript('navigator.clearAppBadge()');
  2006. });
  2007. });
  2008. describe('navigator.webkitGetUserMedia', () => {
  2009. it('calls its callbacks', async () => {
  2010. const w = new BrowserWindow({ show: false });
  2011. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  2012. await w.webContents.executeJavaScript(`new Promise((resolve) => {
  2013. navigator.webkitGetUserMedia({
  2014. audio: true,
  2015. video: false
  2016. }, () => resolve(),
  2017. () => resolve());
  2018. })`);
  2019. });
  2020. });
  2021. describe('navigator.language', () => {
  2022. it('should not be empty', async () => {
  2023. const w = new BrowserWindow({ show: false });
  2024. await w.loadURL('about:blank');
  2025. expect(await w.webContents.executeJavaScript('navigator.language')).to.not.equal('');
  2026. });
  2027. });
  2028. describe('heap snapshot', () => {
  2029. it('does not crash', async () => {
  2030. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  2031. w.loadURL('about:blank');
  2032. await w.webContents.executeJavaScript('process._linkedBinding(\'electron_common_v8_util\').takeHeapSnapshot()');
  2033. });
  2034. });
  2035. // This is intentionally disabled on arm macs: https://chromium-review.googlesource.com/c/chromium/src/+/4143761
  2036. ifdescribe(process.platform === 'darwin' && process.arch !== 'arm64')('webgl', () => {
  2037. it('can be gotten as context in canvas', async () => {
  2038. const w = new BrowserWindow({ show: false });
  2039. w.loadURL('about:blank');
  2040. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  2041. const canWebglContextBeCreated = await w.webContents.executeJavaScript(`
  2042. document.createElement('canvas').getContext('webgl') != null;
  2043. `);
  2044. expect(canWebglContextBeCreated).to.be.true();
  2045. });
  2046. });
  2047. describe('iframe', () => {
  2048. it('does not have node integration', async () => {
  2049. const w = new BrowserWindow({ show: false });
  2050. await w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  2051. const result = await w.webContents.executeJavaScript(`
  2052. const iframe = document.createElement('iframe')
  2053. iframe.src = './set-global.html';
  2054. document.body.appendChild(iframe);
  2055. new Promise(resolve => iframe.onload = e => resolve(iframe.contentWindow.test))
  2056. `);
  2057. expect(result).to.equal('undefined undefined undefined');
  2058. });
  2059. });
  2060. describe('websockets', () => {
  2061. it('has user agent', async () => {
  2062. const server = http.createServer();
  2063. const { port } = await listen(server);
  2064. const wss = new ws.Server({ server: server });
  2065. const finished = new Promise<string | undefined>((resolve, reject) => {
  2066. wss.on('error', reject);
  2067. wss.on('connection', (ws, upgradeReq) => {
  2068. resolve(upgradeReq.headers['user-agent']);
  2069. });
  2070. });
  2071. const w = new BrowserWindow({ show: false });
  2072. w.loadURL('about:blank');
  2073. w.webContents.executeJavaScript(`
  2074. new WebSocket('ws://127.0.0.1:${port}');
  2075. `);
  2076. expect(await finished).to.include('Electron');
  2077. });
  2078. });
  2079. describe('fetch', () => {
  2080. it('does not crash', async () => {
  2081. const server = http.createServer((req, res) => {
  2082. res.end('test');
  2083. });
  2084. defer(() => server.close());
  2085. const { port } = await listen(server);
  2086. const w = new BrowserWindow({ show: false });
  2087. w.loadURL(`file://${fixturesPath}/pages/blank.html`);
  2088. const x = await w.webContents.executeJavaScript(`
  2089. fetch('http://127.0.0.1:${port}').then((res) => res.body.getReader())
  2090. .then((reader) => {
  2091. return reader.read().then((r) => {
  2092. reader.cancel();
  2093. return r.value;
  2094. });
  2095. })
  2096. `);
  2097. expect(x).to.deep.equal(new Uint8Array([116, 101, 115, 116]));
  2098. });
  2099. });
  2100. describe('Promise', () => {
  2101. before(() => {
  2102. ipcMain.handle('ping', (e, arg) => arg);
  2103. });
  2104. after(() => {
  2105. ipcMain.removeHandler('ping');
  2106. });
  2107. itremote('resolves correctly in Node.js calls', async () => {
  2108. await new Promise<void>((resolve, reject) => {
  2109. class XElement extends HTMLElement {}
  2110. customElements.define('x-element', XElement);
  2111. setImmediate(() => {
  2112. let called = false;
  2113. Promise.resolve().then(() => {
  2114. if (called) resolve();
  2115. else reject(new Error('wrong sequence'));
  2116. });
  2117. document.createElement('x-element');
  2118. called = true;
  2119. });
  2120. });
  2121. });
  2122. itremote('resolves correctly in Electron calls', async () => {
  2123. await new Promise<void>((resolve, reject) => {
  2124. class YElement extends HTMLElement {}
  2125. customElements.define('y-element', YElement);
  2126. require('electron').ipcRenderer.invoke('ping').then(() => {
  2127. let called = false;
  2128. Promise.resolve().then(() => {
  2129. if (called) resolve();
  2130. else reject(new Error('wrong sequence'));
  2131. });
  2132. document.createElement('y-element');
  2133. called = true;
  2134. });
  2135. });
  2136. });
  2137. });
  2138. describe('synchronous prompts', () => {
  2139. describe('window.alert(message, title)', () => {
  2140. itremote('throws an exception when the arguments cannot be converted to strings', () => {
  2141. expect(() => {
  2142. window.alert({ toString: null });
  2143. }).to.throw('Cannot convert object to primitive value');
  2144. });
  2145. it('shows a message box', async () => {
  2146. const w = new BrowserWindow({ show: false });
  2147. w.loadURL('about:blank');
  2148. const p = once(w.webContents, '-run-dialog');
  2149. w.webContents.executeJavaScript('alert("hello")', true);
  2150. const [info] = await p;
  2151. expect(info.frame).to.equal(w.webContents.mainFrame);
  2152. expect(info.messageText).to.equal('hello');
  2153. expect(info.dialogType).to.equal('alert');
  2154. });
  2155. it('does not crash if a webContents is destroyed while an alert is showing', async () => {
  2156. const w = new BrowserWindow({ show: false });
  2157. w.loadURL('about:blank');
  2158. const p = once(w.webContents, '-run-dialog');
  2159. w.webContents.executeJavaScript('alert("hello")', true);
  2160. await p;
  2161. w.webContents.close();
  2162. });
  2163. });
  2164. describe('window.confirm(message, title)', () => {
  2165. itremote('throws an exception when the arguments cannot be converted to strings', () => {
  2166. expect(() => {
  2167. (window.confirm as any)({ toString: null }, 'title');
  2168. }).to.throw('Cannot convert object to primitive value');
  2169. });
  2170. it('shows a message box', async () => {
  2171. const w = new BrowserWindow({ show: false });
  2172. w.loadURL('about:blank');
  2173. const p = once(w.webContents, '-run-dialog');
  2174. const resultPromise = w.webContents.executeJavaScript('confirm("hello")', true);
  2175. const [info, cb] = await p;
  2176. expect(info.frame).to.equal(w.webContents.mainFrame);
  2177. expect(info.messageText).to.equal('hello');
  2178. expect(info.dialogType).to.equal('confirm');
  2179. cb(true, '');
  2180. const result = await resultPromise;
  2181. expect(result).to.be.true();
  2182. });
  2183. });
  2184. describe('safeDialogs web preference', () => {
  2185. const originalShowMessageBox = dialog.showMessageBox;
  2186. afterEach(() => {
  2187. dialog.showMessageBox = originalShowMessageBox;
  2188. if (protocol.isProtocolHandled('https')) protocol.unhandle('https');
  2189. if (protocol.isProtocolHandled('file')) protocol.unhandle('file');
  2190. });
  2191. it('does not show the checkbox if not enabled', async () => {
  2192. const w = new BrowserWindow({ show: false, webPreferences: { safeDialogs: false } });
  2193. w.loadURL('about:blank');
  2194. // 1. The first alert() doesn't show the safeDialogs message.
  2195. dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: false });
  2196. await w.webContents.executeJavaScript('alert("hi")');
  2197. let recordedOpts: MessageBoxOptions | undefined;
  2198. dialog.showMessageBox = (bw, opts?: MessageBoxOptions) => {
  2199. recordedOpts = opts;
  2200. return Promise.resolve({ response: 0, checkboxChecked: false });
  2201. };
  2202. await w.webContents.executeJavaScript('alert("hi")');
  2203. expect(recordedOpts?.checkboxLabel).to.equal('');
  2204. });
  2205. it('is respected', async () => {
  2206. const w = new BrowserWindow({ show: false, webPreferences: { safeDialogs: true } });
  2207. w.loadURL('about:blank');
  2208. // 1. The first alert() doesn't show the safeDialogs message.
  2209. dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: false });
  2210. await w.webContents.executeJavaScript('alert("hi")');
  2211. // 2. The second alert() shows the message with a checkbox. Respond that we checked it.
  2212. let recordedOpts: MessageBoxOptions | undefined;
  2213. dialog.showMessageBox = (bw, opts?: MessageBoxOptions) => {
  2214. recordedOpts = opts;
  2215. return Promise.resolve({ response: 0, checkboxChecked: true });
  2216. };
  2217. await w.webContents.executeJavaScript('alert("hi")');
  2218. expect(recordedOpts?.checkboxLabel).to.be.a('string').with.length.above(0);
  2219. // 3. The third alert() shouldn't show a dialog.
  2220. dialog.showMessageBox = () => Promise.reject(new Error('unexpected showMessageBox'));
  2221. await w.webContents.executeJavaScript('alert("hi")');
  2222. });
  2223. it('shows the safeDialogMessage', async () => {
  2224. const w = new BrowserWindow({ show: false, webPreferences: { safeDialogs: true, safeDialogsMessage: 'foo bar' } });
  2225. w.loadURL('about:blank');
  2226. dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: false });
  2227. await w.webContents.executeJavaScript('alert("hi")');
  2228. let recordedOpts: MessageBoxOptions | undefined;
  2229. dialog.showMessageBox = (bw, opts?: MessageBoxOptions) => {
  2230. recordedOpts = opts;
  2231. return Promise.resolve({ response: 0, checkboxChecked: true });
  2232. };
  2233. await w.webContents.executeJavaScript('alert("hi")');
  2234. expect(recordedOpts?.checkboxLabel).to.equal('foo bar');
  2235. });
  2236. it('has persistent state across navigations', async () => {
  2237. const w = new BrowserWindow({ show: false, webPreferences: { safeDialogs: true } });
  2238. w.loadURL('about:blank');
  2239. // 1. The first alert() doesn't show the safeDialogs message.
  2240. dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: false });
  2241. await w.webContents.executeJavaScript('alert("hi")');
  2242. // 2. The second alert() shows the message with a checkbox. Respond that we checked it.
  2243. dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: true });
  2244. await w.webContents.executeJavaScript('alert("hi")');
  2245. // 3. The third alert() shouldn't show a dialog.
  2246. dialog.showMessageBox = () => Promise.reject(new Error('unexpected showMessageBox'));
  2247. await w.webContents.executeJavaScript('alert("hi")');
  2248. // 4. After navigating to the same origin, message boxes should still be hidden.
  2249. w.loadURL('about:blank');
  2250. await w.webContents.executeJavaScript('alert("hi")');
  2251. });
  2252. it('is separated by origin', async () => {
  2253. protocol.handle('https', () => new Response(''));
  2254. const w = new BrowserWindow({ show: false, webPreferences: { safeDialogs: true } });
  2255. w.loadURL('https://example1');
  2256. dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: false });
  2257. await w.webContents.executeJavaScript('alert("hi")');
  2258. dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: true });
  2259. await w.webContents.executeJavaScript('alert("hi")');
  2260. dialog.showMessageBox = () => Promise.reject(new Error('unexpected showMessageBox'));
  2261. await w.webContents.executeJavaScript('alert("hi")');
  2262. // A different origin is allowed to show message boxes after navigation.
  2263. w.loadURL('https://example2');
  2264. let dialogWasShown = false;
  2265. dialog.showMessageBox = () => {
  2266. dialogWasShown = true;
  2267. return Promise.resolve({ response: 0, checkboxChecked: false });
  2268. };
  2269. await w.webContents.executeJavaScript('alert("hi")');
  2270. expect(dialogWasShown).to.be.true();
  2271. // Navigating back to the first origin means alerts are blocked again.
  2272. w.loadURL('https://example1');
  2273. dialog.showMessageBox = () => Promise.reject(new Error('unexpected showMessageBox'));
  2274. await w.webContents.executeJavaScript('alert("hi")');
  2275. });
  2276. it('treats different file: paths as different origins', async () => {
  2277. protocol.handle('file', () => new Response(''));
  2278. const w = new BrowserWindow({ show: false, webPreferences: { safeDialogs: true } });
  2279. w.loadURL('file:///path/1');
  2280. dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: false });
  2281. await w.webContents.executeJavaScript('alert("hi")');
  2282. dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: true });
  2283. await w.webContents.executeJavaScript('alert("hi")');
  2284. dialog.showMessageBox = () => Promise.reject(new Error('unexpected showMessageBox'));
  2285. await w.webContents.executeJavaScript('alert("hi")');
  2286. w.loadURL('file:///path/2');
  2287. let dialogWasShown = false;
  2288. dialog.showMessageBox = () => {
  2289. dialogWasShown = true;
  2290. return Promise.resolve({ response: 0, checkboxChecked: false });
  2291. };
  2292. await w.webContents.executeJavaScript('alert("hi")');
  2293. expect(dialogWasShown).to.be.true();
  2294. });
  2295. });
  2296. describe('disableDialogs web preference', () => {
  2297. const originalShowMessageBox = dialog.showMessageBox;
  2298. afterEach(() => {
  2299. dialog.showMessageBox = originalShowMessageBox;
  2300. if (protocol.isProtocolHandled('https')) protocol.unhandle('https');
  2301. });
  2302. it('is respected', async () => {
  2303. const w = new BrowserWindow({ show: false, webPreferences: { disableDialogs: true } });
  2304. w.loadURL('about:blank');
  2305. dialog.showMessageBox = () => Promise.reject(new Error('unexpected message box'));
  2306. await w.webContents.executeJavaScript('alert("hi")');
  2307. });
  2308. });
  2309. });
  2310. describe('window.history', () => {
  2311. describe('window.history.go(offset)', () => {
  2312. itremote('throws an exception when the argument cannot be converted to a string', () => {
  2313. expect(() => {
  2314. (window.history.go as any)({ toString: null });
  2315. }).to.throw('Cannot convert object to primitive value');
  2316. });
  2317. });
  2318. });
  2319. describe('console functions', () => {
  2320. itremote('should exist', () => {
  2321. expect(console.log, 'log').to.be.a('function');
  2322. expect(console.error, 'error').to.be.a('function');
  2323. expect(console.warn, 'warn').to.be.a('function');
  2324. expect(console.info, 'info').to.be.a('function');
  2325. expect(console.debug, 'debug').to.be.a('function');
  2326. expect(console.trace, 'trace').to.be.a('function');
  2327. expect(console.time, 'time').to.be.a('function');
  2328. expect(console.timeEnd, 'timeEnd').to.be.a('function');
  2329. });
  2330. });
  2331. // FIXME(nornagon): this is broken on CI, it triggers:
  2332. // [FATAL:speech_synthesis.mojom-shared.h(237)] The outgoing message will
  2333. // trigger VALIDATION_ERROR_UNEXPECTED_NULL_POINTER at the receiving side
  2334. // (null text in SpeechSynthesisUtterance struct).
  2335. describe('SpeechSynthesis', () => {
  2336. itremote('should emit lifecycle events', async () => {
  2337. const sentence = `long sentence which will take at least a few seconds to
  2338. utter so that it's possible to pause and resume before the end`;
  2339. const utter = new SpeechSynthesisUtterance(sentence);
  2340. // Create a dummy utterance so that speech synthesis state
  2341. // is initialized for later calls.
  2342. speechSynthesis.speak(new SpeechSynthesisUtterance());
  2343. speechSynthesis.cancel();
  2344. speechSynthesis.speak(utter);
  2345. // paused state after speak()
  2346. expect(speechSynthesis.paused).to.be.false();
  2347. await new Promise((resolve) => { utter.onstart = resolve; });
  2348. // paused state after start event
  2349. expect(speechSynthesis.paused).to.be.false();
  2350. speechSynthesis.pause();
  2351. // paused state changes async, right before the pause event
  2352. expect(speechSynthesis.paused).to.be.false();
  2353. await new Promise((resolve) => { utter.onpause = resolve; });
  2354. expect(speechSynthesis.paused).to.be.true();
  2355. speechSynthesis.resume();
  2356. await new Promise((resolve) => { utter.onresume = resolve; });
  2357. // paused state after resume event
  2358. expect(speechSynthesis.paused).to.be.false();
  2359. await new Promise((resolve) => { utter.onend = resolve; });
  2360. });
  2361. });
  2362. });
  2363. describe('font fallback', () => {
  2364. async function getRenderedFonts (html: string) {
  2365. const w = new BrowserWindow({ show: false });
  2366. try {
  2367. await w.loadURL(`data:text/html,${html}`);
  2368. w.webContents.debugger.attach();
  2369. const sendCommand = (method: string, commandParams?: any) => w.webContents.debugger.sendCommand(method, commandParams);
  2370. const { nodeId } = (await sendCommand('DOM.getDocument')).root.children[0];
  2371. await sendCommand('CSS.enable');
  2372. const { fonts } = await sendCommand('CSS.getPlatformFontsForNode', { nodeId });
  2373. return fonts;
  2374. } finally {
  2375. w.close();
  2376. }
  2377. }
  2378. it('should use Helvetica for sans-serif on Mac, and Arial on Windows and Linux', async () => {
  2379. const html = '<body style="font-family: sans-serif">test</body>';
  2380. const fonts = await getRenderedFonts(html);
  2381. expect(fonts).to.be.an('array');
  2382. expect(fonts).to.have.length(1);
  2383. if (process.platform === 'win32') {
  2384. expect(fonts[0].familyName).to.equal('Arial');
  2385. } else if (process.platform === 'darwin') {
  2386. expect(fonts[0].familyName).to.equal('Helvetica');
  2387. } else if (process.platform === 'linux') {
  2388. expect(fonts[0].familyName).to.equal('DejaVu Sans');
  2389. } // I think this depends on the distro? We don't specify a default.
  2390. });
  2391. ifit(process.platform !== 'linux')('should fall back to Japanese font for sans-serif Japanese script', async function () {
  2392. const html = `
  2393. <html lang="ja-JP">
  2394. <head>
  2395. <meta charset="utf-8" />
  2396. </head>
  2397. <body style="font-family: sans-serif">test 智史</body>
  2398. </html>
  2399. `;
  2400. const fonts = await getRenderedFonts(html);
  2401. expect(fonts).to.be.an('array');
  2402. expect(fonts).to.have.length(1);
  2403. if (process.platform === 'win32') { expect(fonts[0].familyName).to.be.oneOf(['Meiryo', 'Yu Gothic']); } else if (process.platform === 'darwin') { expect(fonts[0].familyName).to.equal('Hiragino Kaku Gothic ProN'); }
  2404. });
  2405. });
  2406. describe('iframe using HTML fullscreen API while window is OS-fullscreened', () => {
  2407. const fullscreenChildHtml = fs.promises.readFile(
  2408. path.join(fixturesPath, 'pages', 'fullscreen-oopif.html')
  2409. );
  2410. let w: BrowserWindow;
  2411. let server: http.Server;
  2412. let crossSiteUrl: string;
  2413. beforeEach(async () => {
  2414. server = http.createServer(async (_req, res) => {
  2415. res.writeHead(200, { 'Content-Type': 'text/html' });
  2416. res.write(await fullscreenChildHtml);
  2417. res.end();
  2418. });
  2419. const serverUrl = (await listen(server)).url;
  2420. crossSiteUrl = serverUrl.replace('127.0.0.1', 'localhost');
  2421. w = new BrowserWindow({
  2422. show: true,
  2423. fullscreen: true,
  2424. webPreferences: {
  2425. nodeIntegration: true,
  2426. nodeIntegrationInSubFrames: true,
  2427. contextIsolation: false
  2428. }
  2429. });
  2430. });
  2431. afterEach(async () => {
  2432. await closeAllWindows();
  2433. (w as any) = null;
  2434. server.close();
  2435. });
  2436. ifit(process.platform !== 'darwin')('can fullscreen from out-of-process iframes (non-macOS)', async () => {
  2437. const fullscreenChange = once(ipcMain, 'fullscreenChange');
  2438. const html =
  2439. `<iframe style="width: 0" frameborder=0 src="${crossSiteUrl}" allowfullscreen></iframe>`;
  2440. w.loadURL(`data:text/html,${html}`);
  2441. await fullscreenChange;
  2442. const fullscreenWidth = await w.webContents.executeJavaScript(
  2443. "document.querySelector('iframe').offsetWidth"
  2444. );
  2445. expect(fullscreenWidth > 0).to.be.true();
  2446. await w.webContents.executeJavaScript(
  2447. "document.querySelector('iframe').contentWindow.postMessage('exitFullscreen', '*')"
  2448. );
  2449. await setTimeout(500);
  2450. const width = await w.webContents.executeJavaScript(
  2451. "document.querySelector('iframe').offsetWidth"
  2452. );
  2453. expect(width).to.equal(0);
  2454. });
  2455. ifit(process.platform === 'darwin')('can fullscreen from out-of-process iframes (macOS)', async () => {
  2456. await once(w, 'enter-full-screen');
  2457. const fullscreenChange = once(ipcMain, 'fullscreenChange');
  2458. const html =
  2459. `<iframe style="width: 0" frameborder=0 src="${crossSiteUrl}" allowfullscreen></iframe>`;
  2460. w.loadURL(`data:text/html,${html}`);
  2461. await fullscreenChange;
  2462. const fullscreenWidth = await w.webContents.executeJavaScript(
  2463. "document.querySelector('iframe').offsetWidth"
  2464. );
  2465. expect(fullscreenWidth > 0).to.be.true();
  2466. await w.webContents.executeJavaScript(
  2467. "document.querySelector('iframe').contentWindow.postMessage('exitFullscreen', '*')"
  2468. );
  2469. await once(w.webContents, 'leave-html-full-screen');
  2470. const width = await w.webContents.executeJavaScript(
  2471. "document.querySelector('iframe').offsetWidth"
  2472. );
  2473. expect(width).to.equal(0);
  2474. w.setFullScreen(false);
  2475. await once(w, 'leave-full-screen');
  2476. });
  2477. // TODO(jkleinsc) fix this flaky test on WOA
  2478. ifit(process.platform !== 'win32' || process.arch !== 'arm64')('can fullscreen from in-process iframes', async () => {
  2479. if (process.platform === 'darwin') await once(w, 'enter-full-screen');
  2480. const fullscreenChange = once(ipcMain, 'fullscreenChange');
  2481. w.loadFile(path.join(fixturesPath, 'pages', 'fullscreen-ipif.html'));
  2482. await fullscreenChange;
  2483. const fullscreenWidth = await w.webContents.executeJavaScript(
  2484. "document.querySelector('iframe').offsetWidth"
  2485. );
  2486. expect(fullscreenWidth > 0).to.true();
  2487. await w.webContents.executeJavaScript('document.exitFullscreen()');
  2488. const width = await w.webContents.executeJavaScript(
  2489. "document.querySelector('iframe').offsetWidth"
  2490. );
  2491. expect(width).to.equal(0);
  2492. });
  2493. });
  2494. describe('navigator.serial', () => {
  2495. let w: BrowserWindow;
  2496. before(async () => {
  2497. w = new BrowserWindow({
  2498. show: false
  2499. });
  2500. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  2501. });
  2502. const getPorts: any = () => {
  2503. return w.webContents.executeJavaScript(`
  2504. navigator.serial.requestPort().then(port => port.toString()).catch(err => err.toString());
  2505. `, true);
  2506. };
  2507. const notFoundError = 'NotFoundError: Failed to execute \'requestPort\' on \'Serial\': No port selected by the user.';
  2508. after(closeAllWindows);
  2509. afterEach(() => {
  2510. session.defaultSession.setPermissionCheckHandler(null);
  2511. session.defaultSession.removeAllListeners('select-serial-port');
  2512. });
  2513. it('does not return a port if select-serial-port event is not defined', async () => {
  2514. w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  2515. const port = await getPorts();
  2516. expect(port).to.equal(notFoundError);
  2517. });
  2518. it('does not return a port when permission denied', async () => {
  2519. w.webContents.session.on('select-serial-port', (event, portList, webContents, callback) => {
  2520. callback(portList[0].portId);
  2521. });
  2522. session.defaultSession.setPermissionCheckHandler(() => false);
  2523. const port = await getPorts();
  2524. expect(port).to.equal(notFoundError);
  2525. });
  2526. it('does not crash when select-serial-port is called with an invalid port', async () => {
  2527. w.webContents.session.on('select-serial-port', (event, portList, webContents, callback) => {
  2528. callback('i-do-not-exist');
  2529. });
  2530. const port = await getPorts();
  2531. expect(port).to.equal(notFoundError);
  2532. });
  2533. it('returns a port when select-serial-port event is defined', async () => {
  2534. let havePorts = false;
  2535. w.webContents.session.on('select-serial-port', (event, portList, webContents, callback) => {
  2536. if (portList.length > 0) {
  2537. havePorts = true;
  2538. callback(portList[0].portId);
  2539. } else {
  2540. callback('');
  2541. }
  2542. });
  2543. const port = await getPorts();
  2544. if (havePorts) {
  2545. expect(port).to.equal('[object SerialPort]');
  2546. } else {
  2547. expect(port).to.equal(notFoundError);
  2548. }
  2549. });
  2550. it('navigator.serial.getPorts() returns values', async () => {
  2551. let havePorts = false;
  2552. w.webContents.session.on('select-serial-port', (event, portList, webContents, callback) => {
  2553. if (portList.length > 0) {
  2554. havePorts = true;
  2555. callback(portList[0].portId);
  2556. } else {
  2557. callback('');
  2558. }
  2559. });
  2560. await getPorts();
  2561. if (havePorts) {
  2562. const grantedPorts = await w.webContents.executeJavaScript('navigator.serial.getPorts()');
  2563. expect(grantedPorts).to.not.be.empty();
  2564. }
  2565. });
  2566. it('supports port.forget()', async () => {
  2567. let forgottenPortFromEvent = {};
  2568. let havePorts = false;
  2569. w.webContents.session.on('select-serial-port', (event, portList, webContents, callback) => {
  2570. if (portList.length > 0) {
  2571. havePorts = true;
  2572. callback(portList[0].portId);
  2573. } else {
  2574. callback('');
  2575. }
  2576. });
  2577. w.webContents.session.on('serial-port-revoked', (event, details) => {
  2578. forgottenPortFromEvent = details.port;
  2579. });
  2580. await getPorts();
  2581. if (havePorts) {
  2582. const grantedPorts = await w.webContents.executeJavaScript('navigator.serial.getPorts()');
  2583. if (grantedPorts.length > 0) {
  2584. const forgottenPort = await w.webContents.executeJavaScript(`
  2585. navigator.serial.getPorts().then(async(ports) => {
  2586. const portInfo = await ports[0].getInfo();
  2587. await ports[0].forget();
  2588. if (portInfo.usbVendorId && portInfo.usbProductId) {
  2589. return {
  2590. vendorId: '' + portInfo.usbVendorId,
  2591. productId: '' + portInfo.usbProductId
  2592. }
  2593. } else {
  2594. return {};
  2595. }
  2596. })
  2597. `);
  2598. const grantedPorts2 = await w.webContents.executeJavaScript('navigator.serial.getPorts()');
  2599. expect(grantedPorts2.length).to.be.lessThan(grantedPorts.length);
  2600. if (forgottenPort.vendorId && forgottenPort.productId) {
  2601. expect(forgottenPortFromEvent).to.include(forgottenPort);
  2602. }
  2603. }
  2604. }
  2605. });
  2606. });
  2607. describe('window.getScreenDetails', () => {
  2608. let w: BrowserWindow;
  2609. before(async () => {
  2610. w = new BrowserWindow({
  2611. show: false
  2612. });
  2613. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  2614. });
  2615. after(closeAllWindows);
  2616. afterEach(() => {
  2617. session.defaultSession.setPermissionRequestHandler(null);
  2618. });
  2619. const getScreenDetails: any = () => {
  2620. return w.webContents.executeJavaScript('window.getScreenDetails().then(data => data.screens).catch(err => err.message)', true);
  2621. };
  2622. it('returns screens when a PermissionRequestHandler is not defined', async () => {
  2623. const screens = await getScreenDetails();
  2624. expect(screens).to.not.equal('Read permission denied.');
  2625. });
  2626. it('returns an error when permission denied', async () => {
  2627. session.defaultSession.setPermissionRequestHandler((wc, permission, callback) => {
  2628. if (permission === 'window-management') {
  2629. callback(false);
  2630. } else {
  2631. callback(true);
  2632. }
  2633. });
  2634. const screens = await getScreenDetails();
  2635. expect(screens).to.equal('Permission denied.');
  2636. });
  2637. it('returns screens when permission is granted', async () => {
  2638. session.defaultSession.setPermissionRequestHandler((wc, permission, callback) => {
  2639. if (permission === 'window-management') {
  2640. callback(true);
  2641. } else {
  2642. callback(false);
  2643. }
  2644. });
  2645. const screens = await getScreenDetails();
  2646. expect(screens).to.not.equal('Permission denied.');
  2647. });
  2648. });
  2649. describe('navigator.clipboard.read', () => {
  2650. let w: BrowserWindow;
  2651. before(async () => {
  2652. w = new BrowserWindow();
  2653. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  2654. });
  2655. const readClipboard: any = () => {
  2656. return w.webContents.executeJavaScript(`
  2657. navigator.clipboard.read().then(clipboard => clipboard.toString()).catch(err => err.message);
  2658. `, true);
  2659. };
  2660. after(closeAllWindows);
  2661. afterEach(() => {
  2662. session.defaultSession.setPermissionRequestHandler(null);
  2663. });
  2664. it('returns clipboard contents when a PermissionRequestHandler is not defined', async () => {
  2665. const clipboard = await readClipboard();
  2666. expect(clipboard).to.not.contain('Read permission denied.');
  2667. });
  2668. it('returns an error when permission denied', async () => {
  2669. session.defaultSession.setPermissionRequestHandler((wc, permission, callback) => {
  2670. if (permission === 'clipboard-read') {
  2671. callback(false);
  2672. } else {
  2673. callback(true);
  2674. }
  2675. });
  2676. const clipboard = await readClipboard();
  2677. expect(clipboard).to.contain('Read permission denied.');
  2678. });
  2679. it('returns clipboard contents when permission is granted', async () => {
  2680. session.defaultSession.setPermissionRequestHandler((wc, permission, callback) => {
  2681. if (permission === 'clipboard-read') {
  2682. callback(true);
  2683. } else {
  2684. callback(false);
  2685. }
  2686. });
  2687. const clipboard = await readClipboard();
  2688. expect(clipboard).to.not.contain('Read permission denied.');
  2689. });
  2690. });
  2691. describe('navigator.clipboard.write', () => {
  2692. let w: BrowserWindow;
  2693. before(async () => {
  2694. w = new BrowserWindow();
  2695. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  2696. });
  2697. const writeClipboard: any = () => {
  2698. return w.webContents.executeJavaScript(`
  2699. navigator.clipboard.writeText('Hello World!').catch(err => err.message);
  2700. `, true);
  2701. };
  2702. after(closeAllWindows);
  2703. afterEach(() => {
  2704. session.defaultSession.setPermissionRequestHandler(null);
  2705. });
  2706. it('returns clipboard contents when a PermissionRequestHandler is not defined', async () => {
  2707. const clipboard = await writeClipboard();
  2708. expect(clipboard).to.be.undefined();
  2709. });
  2710. it('returns an error when permission denied', async () => {
  2711. session.defaultSession.setPermissionRequestHandler((wc, permission, callback) => {
  2712. if (permission === 'clipboard-sanitized-write') {
  2713. callback(false);
  2714. } else {
  2715. callback(true);
  2716. }
  2717. });
  2718. const clipboard = await writeClipboard();
  2719. expect(clipboard).to.contain('Write permission denied.');
  2720. });
  2721. it('returns clipboard contents when permission is granted', async () => {
  2722. session.defaultSession.setPermissionRequestHandler((wc, permission, callback) => {
  2723. if (permission === 'clipboard-sanitized-write') {
  2724. callback(true);
  2725. } else {
  2726. callback(false);
  2727. }
  2728. });
  2729. const clipboard = await writeClipboard();
  2730. expect(clipboard).to.be.undefined();
  2731. });
  2732. });
  2733. ifdescribe((process.platform !== 'linux' || app.isUnityRunning()))('navigator.setAppBadge/clearAppBadge', () => {
  2734. let w: BrowserWindow;
  2735. const expectedBadgeCount = 42;
  2736. const fireAppBadgeAction: any = (action: string, value: any) => {
  2737. return w.webContents.executeJavaScript(`
  2738. navigator.${action}AppBadge(${value}).then(() => 'success').catch(err => err.message)`);
  2739. };
  2740. // For some reason on macOS changing the badge count doesn't happen right away, so wait
  2741. // until it changes.
  2742. async function waitForBadgeCount (value: number) {
  2743. let badgeCount = app.getBadgeCount();
  2744. while (badgeCount !== value) {
  2745. await setTimeout(10);
  2746. badgeCount = app.getBadgeCount();
  2747. }
  2748. return badgeCount;
  2749. }
  2750. describe('in the renderer', () => {
  2751. before(async () => {
  2752. w = new BrowserWindow({
  2753. show: false
  2754. });
  2755. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  2756. });
  2757. after(() => {
  2758. app.badgeCount = 0;
  2759. closeAllWindows();
  2760. });
  2761. it('setAppBadge can set a numerical value', async () => {
  2762. const result = await fireAppBadgeAction('set', expectedBadgeCount);
  2763. expect(result).to.equal('success');
  2764. expect(waitForBadgeCount(expectedBadgeCount)).to.eventually.equal(expectedBadgeCount);
  2765. });
  2766. it('setAppBadge can set an empty(dot) value', async () => {
  2767. const result = await fireAppBadgeAction('set');
  2768. expect(result).to.equal('success');
  2769. expect(waitForBadgeCount(0)).to.eventually.equal(0);
  2770. });
  2771. it('clearAppBadge can clear a value', async () => {
  2772. let result = await fireAppBadgeAction('set', expectedBadgeCount);
  2773. expect(result).to.equal('success');
  2774. expect(waitForBadgeCount(expectedBadgeCount)).to.eventually.equal(expectedBadgeCount);
  2775. result = await fireAppBadgeAction('clear');
  2776. expect(result).to.equal('success');
  2777. expect(waitForBadgeCount(0)).to.eventually.equal(0);
  2778. });
  2779. });
  2780. describe('in a service worker', () => {
  2781. beforeEach(async () => {
  2782. w = new BrowserWindow({
  2783. show: false,
  2784. webPreferences: {
  2785. nodeIntegration: true,
  2786. partition: 'sw-file-scheme-spec',
  2787. contextIsolation: false
  2788. }
  2789. });
  2790. });
  2791. afterEach(() => {
  2792. app.badgeCount = 0;
  2793. closeAllWindows();
  2794. });
  2795. it('setAppBadge can be called in a ServiceWorker', (done) => {
  2796. w.webContents.on('ipc-message', (event, channel, message) => {
  2797. if (channel === 'reload') {
  2798. w.webContents.reload();
  2799. } else if (channel === 'error') {
  2800. done(message);
  2801. } else if (channel === 'response') {
  2802. expect(message).to.equal('SUCCESS setting app badge');
  2803. expect(waitForBadgeCount(expectedBadgeCount)).to.eventually.equal(expectedBadgeCount);
  2804. session.fromPartition('sw-file-scheme-spec').clearStorageData({
  2805. storages: ['serviceworkers']
  2806. }).then(() => done());
  2807. }
  2808. });
  2809. w.webContents.on('render-process-gone', () => done(new Error('WebContents crashed.')));
  2810. w.loadFile(path.join(fixturesPath, 'pages', 'service-worker', 'badge-index.html'), { search: '?setBadge' });
  2811. });
  2812. it('clearAppBadge can be called in a ServiceWorker', (done) => {
  2813. w.webContents.on('ipc-message', (event, channel, message) => {
  2814. if (channel === 'reload') {
  2815. w.webContents.reload();
  2816. } else if (channel === 'setAppBadge') {
  2817. expect(message).to.equal('SUCCESS setting app badge');
  2818. expect(waitForBadgeCount(expectedBadgeCount)).to.eventually.equal(expectedBadgeCount);
  2819. } else if (channel === 'error') {
  2820. done(message);
  2821. } else if (channel === 'response') {
  2822. expect(message).to.equal('SUCCESS clearing app badge');
  2823. expect(waitForBadgeCount(expectedBadgeCount)).to.eventually.equal(expectedBadgeCount);
  2824. session.fromPartition('sw-file-scheme-spec').clearStorageData({
  2825. storages: ['serviceworkers']
  2826. }).then(() => done());
  2827. }
  2828. });
  2829. w.webContents.on('render-process-gone', () => done(new Error('WebContents crashed.')));
  2830. w.loadFile(path.join(fixturesPath, 'pages', 'service-worker', 'badge-index.html'), { search: '?clearBadge' });
  2831. });
  2832. });
  2833. });
  2834. describe('navigator.bluetooth', () => {
  2835. let w: BrowserWindow;
  2836. before(async () => {
  2837. w = new BrowserWindow({
  2838. show: false,
  2839. webPreferences: {
  2840. enableBlinkFeatures: 'WebBluetooth'
  2841. }
  2842. });
  2843. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  2844. });
  2845. after(closeAllWindows);
  2846. it('can request bluetooth devices', async () => {
  2847. const bluetooth = await w.webContents.executeJavaScript(`
  2848. navigator.bluetooth.requestDevice({ acceptAllDevices: true}).then(device => "Found a device!").catch(err => err.message);`, true);
  2849. expect(bluetooth).to.be.oneOf(['Found a device!', 'Bluetooth adapter not available.', 'User cancelled the requestDevice() chooser.']);
  2850. });
  2851. });
  2852. describe('navigator.hid', () => {
  2853. let w: BrowserWindow;
  2854. let server: http.Server;
  2855. let serverUrl: string;
  2856. before(async () => {
  2857. w = new BrowserWindow({
  2858. show: false
  2859. });
  2860. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  2861. server = http.createServer((req, res) => {
  2862. res.setHeader('Content-Type', 'text/html');
  2863. res.end('<body>');
  2864. });
  2865. serverUrl = (await listen(server)).url;
  2866. });
  2867. const requestDevices: any = () => {
  2868. return w.webContents.executeJavaScript(`
  2869. navigator.hid.requestDevice({filters: []}).then(device => device.toString()).catch(err => err.toString());
  2870. `, true);
  2871. };
  2872. after(() => {
  2873. server.close();
  2874. closeAllWindows();
  2875. });
  2876. afterEach(() => {
  2877. session.defaultSession.setPermissionCheckHandler(null);
  2878. session.defaultSession.setDevicePermissionHandler(null);
  2879. session.defaultSession.removeAllListeners('select-hid-device');
  2880. });
  2881. it('does not return a device if select-hid-device event is not defined', async () => {
  2882. w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  2883. const device = await requestDevices();
  2884. expect(device).to.equal('');
  2885. });
  2886. it('does not return a device when permission denied', async () => {
  2887. let selectFired = false;
  2888. w.webContents.session.on('select-hid-device', (event, details, callback) => {
  2889. selectFired = true;
  2890. callback();
  2891. });
  2892. session.defaultSession.setPermissionCheckHandler(() => false);
  2893. const device = await requestDevices();
  2894. expect(selectFired).to.be.false();
  2895. expect(device).to.equal('');
  2896. });
  2897. it('returns a device when select-hid-device event is defined', async () => {
  2898. let haveDevices = false;
  2899. let selectFired = false;
  2900. w.webContents.session.on('select-hid-device', (event, details, callback) => {
  2901. expect(details.frame).to.have.property('frameTreeNodeId').that.is.a('number');
  2902. selectFired = true;
  2903. if (details.deviceList.length > 0) {
  2904. haveDevices = true;
  2905. callback(details.deviceList[0].deviceId);
  2906. } else {
  2907. callback();
  2908. }
  2909. });
  2910. const device = await requestDevices();
  2911. expect(selectFired).to.be.true();
  2912. if (haveDevices) {
  2913. expect(device).to.contain('[object HIDDevice]');
  2914. } else {
  2915. expect(device).to.equal('');
  2916. }
  2917. if (haveDevices) {
  2918. // Verify that navigation will clear device permissions
  2919. const grantedDevices = await w.webContents.executeJavaScript('navigator.hid.getDevices()');
  2920. expect(grantedDevices).to.not.be.empty();
  2921. w.loadURL(serverUrl);
  2922. const [,,,,, frameProcessId, frameRoutingId] = await once(w.webContents, 'did-frame-navigate');
  2923. const frame = webFrameMain.fromId(frameProcessId, frameRoutingId);
  2924. expect(!!frame).to.be.true();
  2925. if (frame) {
  2926. const grantedDevicesOnNewPage = await frame.executeJavaScript('navigator.hid.getDevices()');
  2927. expect(grantedDevicesOnNewPage).to.be.empty();
  2928. }
  2929. }
  2930. });
  2931. it('returns a device when DevicePermissionHandler is defined', async () => {
  2932. let haveDevices = false;
  2933. let selectFired = false;
  2934. let gotDevicePerms = false;
  2935. w.webContents.session.on('select-hid-device', (event, details, callback) => {
  2936. selectFired = true;
  2937. if (details.deviceList.length > 0) {
  2938. const foundDevice = details.deviceList.find((device) => {
  2939. if (device.name && device.name !== '' && device.serialNumber && device.serialNumber !== '') {
  2940. haveDevices = true;
  2941. return true;
  2942. }
  2943. });
  2944. if (foundDevice) {
  2945. callback(foundDevice.deviceId);
  2946. return;
  2947. }
  2948. }
  2949. callback();
  2950. });
  2951. session.defaultSession.setDevicePermissionHandler(() => {
  2952. gotDevicePerms = true;
  2953. return true;
  2954. });
  2955. await w.webContents.executeJavaScript('navigator.hid.getDevices();', true);
  2956. const device = await requestDevices();
  2957. expect(selectFired).to.be.true();
  2958. if (haveDevices) {
  2959. expect(device).to.contain('[object HIDDevice]');
  2960. expect(gotDevicePerms).to.be.true();
  2961. } else {
  2962. expect(device).to.equal('');
  2963. }
  2964. });
  2965. it('excludes a device when a exclusionFilter is specified', async () => {
  2966. const exclusionFilters = <any>[];
  2967. let haveDevices = false;
  2968. let checkForExcludedDevice = false;
  2969. w.webContents.session.on('select-hid-device', (event, details, callback) => {
  2970. if (details.deviceList.length > 0) {
  2971. details.deviceList.find((device) => {
  2972. if (device.name && device.name !== '' && device.serialNumber && device.serialNumber !== '') {
  2973. if (checkForExcludedDevice) {
  2974. const compareDevice = {
  2975. vendorId: device.vendorId,
  2976. productId: device.productId
  2977. };
  2978. expect(compareDevice).to.not.equal(exclusionFilters[0], 'excluded device should not be returned');
  2979. } else {
  2980. haveDevices = true;
  2981. exclusionFilters.push({
  2982. vendorId: device.vendorId,
  2983. productId: device.productId
  2984. });
  2985. return true;
  2986. }
  2987. }
  2988. });
  2989. }
  2990. callback();
  2991. });
  2992. await requestDevices();
  2993. if (haveDevices) {
  2994. // We have devices to exclude, so check if exclusionFilters work
  2995. checkForExcludedDevice = true;
  2996. await w.webContents.executeJavaScript(`
  2997. navigator.hid.requestDevice({filters: [], exclusionFilters: ${JSON.stringify(exclusionFilters)}}).then(device => device.toString()).catch(err => err.toString());
  2998. `, true);
  2999. }
  3000. });
  3001. it('supports device.forget()', async () => {
  3002. let deletedDeviceFromEvent;
  3003. let haveDevices = false;
  3004. w.webContents.session.on('select-hid-device', (event, details, callback) => {
  3005. if (details.deviceList.length > 0) {
  3006. haveDevices = true;
  3007. callback(details.deviceList[0].deviceId);
  3008. } else {
  3009. callback();
  3010. }
  3011. });
  3012. w.webContents.session.on('hid-device-revoked', (event, details) => {
  3013. deletedDeviceFromEvent = details.device;
  3014. });
  3015. await requestDevices();
  3016. if (haveDevices) {
  3017. const grantedDevices = await w.webContents.executeJavaScript('navigator.hid.getDevices()');
  3018. if (grantedDevices.length > 0) {
  3019. const deletedDevice = await w.webContents.executeJavaScript(`
  3020. navigator.hid.getDevices().then(devices => {
  3021. devices[0].forget();
  3022. return {
  3023. vendorId: devices[0].vendorId,
  3024. productId: devices[0].productId,
  3025. name: devices[0].productName
  3026. }
  3027. })
  3028. `);
  3029. const grantedDevices2 = await w.webContents.executeJavaScript('navigator.hid.getDevices()');
  3030. expect(grantedDevices2.length).to.be.lessThan(grantedDevices.length);
  3031. if (deletedDevice.name !== '' && deletedDevice.productId && deletedDevice.vendorId) {
  3032. expect(deletedDeviceFromEvent).to.include(deletedDevice);
  3033. }
  3034. }
  3035. }
  3036. });
  3037. });
  3038. describe('navigator.usb', () => {
  3039. let w: BrowserWindow;
  3040. let server: http.Server;
  3041. let serverUrl: string;
  3042. before(async () => {
  3043. w = new BrowserWindow({
  3044. show: false
  3045. });
  3046. await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  3047. server = http.createServer((req, res) => {
  3048. res.setHeader('Content-Type', 'text/html');
  3049. res.end('<body>');
  3050. });
  3051. serverUrl = (await listen(server)).url;
  3052. });
  3053. const requestDevices: any = () => {
  3054. return w.webContents.executeJavaScript(`
  3055. navigator.usb.requestDevice({filters: []}).then(device => device.toString()).catch(err => err.toString());
  3056. `, true);
  3057. };
  3058. const notFoundError = 'NotFoundError: Failed to execute \'requestDevice\' on \'USB\': No device selected.';
  3059. after(() => {
  3060. server.close();
  3061. closeAllWindows();
  3062. });
  3063. afterEach(() => {
  3064. session.defaultSession.setPermissionCheckHandler(null);
  3065. session.defaultSession.setDevicePermissionHandler(null);
  3066. session.defaultSession.removeAllListeners('select-usb-device');
  3067. });
  3068. it('does not return a device if select-usb-device event is not defined', async () => {
  3069. w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
  3070. const device = await requestDevices();
  3071. expect(device).to.equal(notFoundError);
  3072. });
  3073. it('does not return a device when permission denied', async () => {
  3074. let selectFired = false;
  3075. w.webContents.session.on('select-usb-device', (event, details, callback) => {
  3076. selectFired = true;
  3077. callback();
  3078. });
  3079. session.defaultSession.setPermissionCheckHandler(() => false);
  3080. const device = await requestDevices();
  3081. expect(selectFired).to.be.false();
  3082. expect(device).to.equal(notFoundError);
  3083. });
  3084. it('returns a device when select-usb-device event is defined', async () => {
  3085. let haveDevices = false;
  3086. let selectFired = false;
  3087. w.webContents.session.on('select-usb-device', (event, details, callback) => {
  3088. expect(details.frame).to.have.property('frameTreeNodeId').that.is.a('number');
  3089. selectFired = true;
  3090. if (details.deviceList.length > 0) {
  3091. haveDevices = true;
  3092. callback(details.deviceList[0].deviceId);
  3093. } else {
  3094. callback();
  3095. }
  3096. });
  3097. const device = await requestDevices();
  3098. expect(selectFired).to.be.true();
  3099. if (haveDevices) {
  3100. expect(device).to.contain('[object USBDevice]');
  3101. } else {
  3102. expect(device).to.equal(notFoundError);
  3103. }
  3104. if (haveDevices) {
  3105. // Verify that navigation will clear device permissions
  3106. const grantedDevices = await w.webContents.executeJavaScript('navigator.usb.getDevices()');
  3107. expect(grantedDevices).to.not.be.empty();
  3108. w.loadURL(serverUrl);
  3109. const [,,,,, frameProcessId, frameRoutingId] = await once(w.webContents, 'did-frame-navigate');
  3110. const frame = webFrameMain.fromId(frameProcessId, frameRoutingId);
  3111. expect(!!frame).to.be.true();
  3112. if (frame) {
  3113. const grantedDevicesOnNewPage = await frame.executeJavaScript('navigator.usb.getDevices()');
  3114. expect(grantedDevicesOnNewPage).to.be.empty();
  3115. }
  3116. }
  3117. });
  3118. it('returns a device when DevicePermissionHandler is defined', async () => {
  3119. let haveDevices = false;
  3120. let selectFired = false;
  3121. let gotDevicePerms = false;
  3122. w.webContents.session.on('select-usb-device', (event, details, callback) => {
  3123. selectFired = true;
  3124. if (details.deviceList.length > 0) {
  3125. const foundDevice = details.deviceList.find((device) => {
  3126. if (device.productName && device.productName !== '' && device.serialNumber && device.serialNumber !== '') {
  3127. haveDevices = true;
  3128. return true;
  3129. }
  3130. });
  3131. if (foundDevice) {
  3132. callback(foundDevice.deviceId);
  3133. return;
  3134. }
  3135. }
  3136. callback();
  3137. });
  3138. session.defaultSession.setDevicePermissionHandler(() => {
  3139. gotDevicePerms = true;
  3140. return true;
  3141. });
  3142. await w.webContents.executeJavaScript('navigator.usb.getDevices();', true);
  3143. const device = await requestDevices();
  3144. expect(selectFired).to.be.true();
  3145. if (haveDevices) {
  3146. expect(device).to.contain('[object USBDevice]');
  3147. expect(gotDevicePerms).to.be.true();
  3148. } else {
  3149. expect(device).to.equal(notFoundError);
  3150. }
  3151. });
  3152. it('supports device.forget()', async () => {
  3153. let deletedDeviceFromEvent;
  3154. let haveDevices = false;
  3155. w.webContents.session.on('select-usb-device', (event, details, callback) => {
  3156. if (details.deviceList.length > 0) {
  3157. haveDevices = true;
  3158. callback(details.deviceList[0].deviceId);
  3159. } else {
  3160. callback();
  3161. }
  3162. });
  3163. w.webContents.session.on('usb-device-revoked', (event, details) => {
  3164. deletedDeviceFromEvent = details.device;
  3165. });
  3166. await requestDevices();
  3167. if (haveDevices) {
  3168. const grantedDevices = await w.webContents.executeJavaScript('navigator.usb.getDevices()');
  3169. if (grantedDevices.length > 0) {
  3170. const deletedDevice: Electron.USBDevice = await w.webContents.executeJavaScript(`
  3171. navigator.usb.getDevices().then(devices => {
  3172. devices[0].forget();
  3173. return {
  3174. vendorId: devices[0].vendorId,
  3175. productId: devices[0].productId,
  3176. productName: devices[0].productName
  3177. }
  3178. })
  3179. `);
  3180. const grantedDevices2 = await w.webContents.executeJavaScript('navigator.usb.getDevices()');
  3181. expect(grantedDevices2.length).to.be.lessThan(grantedDevices.length);
  3182. if (deletedDevice.productName !== '' && deletedDevice.productId && deletedDevice.vendorId) {
  3183. expect(deletedDeviceFromEvent).to.include(deletedDevice);
  3184. }
  3185. }
  3186. }
  3187. });
  3188. });