chromium-spec.ts 153 KB

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