api-web-contents-spec.ts 77 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174
  1. import { expect } from 'chai';
  2. import { AddressInfo } from 'net';
  3. import * as path from 'path';
  4. import * as fs from 'fs';
  5. import * as http from 'http';
  6. import { BrowserWindow, ipcMain, webContents, session, WebContents, app, BrowserView } from 'electron/main';
  7. import { clipboard } from 'electron/common';
  8. import { emittedOnce } from './events-helpers';
  9. import { closeAllWindows } from './window-helpers';
  10. import { ifdescribe, ifit, delay, defer } from './spec-helpers';
  11. const pdfjs = require('pdfjs-dist');
  12. const fixturesPath = path.resolve(__dirname, '..', 'spec', 'fixtures');
  13. const mainFixturesPath = path.resolve(__dirname, 'fixtures');
  14. const features = process._linkedBinding('electron_common_features');
  15. describe('webContents module', () => {
  16. describe('getAllWebContents() API', () => {
  17. afterEach(closeAllWindows);
  18. it('returns an array of web contents', async () => {
  19. const w = new BrowserWindow({
  20. show: false,
  21. webPreferences: { webviewTag: true }
  22. });
  23. w.loadFile(path.join(fixturesPath, 'pages', 'webview-zoom-factor.html'));
  24. await emittedOnce(w.webContents, 'did-attach-webview');
  25. w.webContents.openDevTools();
  26. await emittedOnce(w.webContents, 'devtools-opened');
  27. const all = webContents.getAllWebContents().sort((a, b) => {
  28. return a.id - b.id;
  29. });
  30. expect(all).to.have.length(3);
  31. expect(all[0].getType()).to.equal('window');
  32. expect(all[all.length - 2].getType()).to.equal('webview');
  33. expect(all[all.length - 1].getType()).to.equal('remote');
  34. });
  35. });
  36. describe('fromId()', () => {
  37. it('returns undefined for an unknown id', () => {
  38. expect(webContents.fromId(12345)).to.be.undefined();
  39. });
  40. });
  41. describe('fromDevToolsTargetId()', () => {
  42. it('returns WebContents for attached DevTools target', async () => {
  43. const w = new BrowserWindow({ show: false });
  44. await w.loadURL('about:blank');
  45. try {
  46. await w.webContents.debugger.attach('1.3');
  47. const { targetInfo } = await w.webContents.debugger.sendCommand('Target.getTargetInfo');
  48. expect(webContents.fromDevToolsTargetId(targetInfo.targetId)).to.equal(w.webContents);
  49. } finally {
  50. await w.webContents.debugger.detach();
  51. }
  52. });
  53. it('returns undefined for an unknown id', () => {
  54. expect(webContents.fromDevToolsTargetId('nope')).to.be.undefined();
  55. });
  56. });
  57. describe('will-prevent-unload event', function () {
  58. afterEach(closeAllWindows);
  59. it('does not emit if beforeunload returns undefined in a BrowserWindow', async () => {
  60. const w = new BrowserWindow({ show: false });
  61. w.webContents.once('will-prevent-unload', () => {
  62. expect.fail('should not have fired');
  63. });
  64. await w.loadFile(path.join(__dirname, 'fixtures', 'api', 'beforeunload-undefined.html'));
  65. const wait = emittedOnce(w, 'closed');
  66. w.close();
  67. await wait;
  68. });
  69. it('does not emit if beforeunload returns undefined in a BrowserView', async () => {
  70. const w = new BrowserWindow({ show: false });
  71. const view = new BrowserView();
  72. w.setBrowserView(view);
  73. view.setBounds(w.getBounds());
  74. view.webContents.once('will-prevent-unload', () => {
  75. expect.fail('should not have fired');
  76. });
  77. await view.webContents.loadFile(path.join(__dirname, 'fixtures', 'api', 'beforeunload-undefined.html'));
  78. const wait = emittedOnce(w, 'closed');
  79. w.close();
  80. await wait;
  81. });
  82. it('emits if beforeunload returns false in a BrowserWindow', async () => {
  83. const w = new BrowserWindow({ show: false });
  84. await w.loadFile(path.join(__dirname, 'fixtures', 'api', 'beforeunload-false.html'));
  85. w.close();
  86. await emittedOnce(w.webContents, 'will-prevent-unload');
  87. });
  88. it('emits if beforeunload returns false in a BrowserView', async () => {
  89. const w = new BrowserWindow({ show: false });
  90. const view = new BrowserView();
  91. w.setBrowserView(view);
  92. view.setBounds(w.getBounds());
  93. await view.webContents.loadFile(path.join(__dirname, 'fixtures', 'api', 'beforeunload-false.html'));
  94. w.close();
  95. await emittedOnce(view.webContents, 'will-prevent-unload');
  96. });
  97. it('supports calling preventDefault on will-prevent-unload events in a BrowserWindow', async () => {
  98. const w = new BrowserWindow({ show: false });
  99. w.webContents.once('will-prevent-unload', event => event.preventDefault());
  100. await w.loadFile(path.join(__dirname, 'fixtures', 'api', 'beforeunload-false.html'));
  101. const wait = emittedOnce(w, 'closed');
  102. w.close();
  103. await wait;
  104. });
  105. });
  106. describe('webContents.send(channel, args...)', () => {
  107. afterEach(closeAllWindows);
  108. it('throws an error when the channel is missing', () => {
  109. const w = new BrowserWindow({ show: false });
  110. expect(() => {
  111. (w.webContents.send as any)();
  112. }).to.throw('Missing required channel argument');
  113. expect(() => {
  114. w.webContents.send(null as any);
  115. }).to.throw('Missing required channel argument');
  116. });
  117. it('does not block node async APIs when sent before document is ready', (done) => {
  118. // Please reference https://github.com/electron/electron/issues/19368 if
  119. // this test fails.
  120. ipcMain.once('async-node-api-done', () => {
  121. done();
  122. });
  123. const w = new BrowserWindow({
  124. show: false,
  125. webPreferences: {
  126. nodeIntegration: true,
  127. sandbox: false,
  128. contextIsolation: false
  129. }
  130. });
  131. w.loadFile(path.join(fixturesPath, 'pages', 'send-after-node.html'));
  132. setTimeout(() => {
  133. w.webContents.send('test');
  134. }, 50);
  135. });
  136. });
  137. ifdescribe(features.isPrintingEnabled())('webContents.print()', () => {
  138. let w: BrowserWindow;
  139. beforeEach(() => {
  140. w = new BrowserWindow({ show: false });
  141. });
  142. afterEach(closeAllWindows);
  143. it('throws when invalid settings are passed', () => {
  144. expect(() => {
  145. // @ts-ignore this line is intentionally incorrect
  146. w.webContents.print(true);
  147. }).to.throw('webContents.print(): Invalid print settings specified.');
  148. });
  149. it('throws when an invalid callback is passed', () => {
  150. expect(() => {
  151. // @ts-ignore this line is intentionally incorrect
  152. w.webContents.print({}, true);
  153. }).to.throw('webContents.print(): Invalid optional callback provided.');
  154. });
  155. ifit(process.platform !== 'linux')('throws when an invalid deviceName is passed', () => {
  156. expect(() => {
  157. w.webContents.print({ deviceName: 'i-am-a-nonexistent-printer' }, () => {});
  158. }).to.throw('webContents.print(): Invalid deviceName provided.');
  159. });
  160. it('throws when an invalid pageSize is passed', () => {
  161. expect(() => {
  162. // @ts-ignore this line is intentionally incorrect
  163. w.webContents.print({ pageSize: 'i-am-a-bad-pagesize' }, () => {});
  164. }).to.throw('Unsupported pageSize: i-am-a-bad-pagesize');
  165. });
  166. it('throws when an invalid custom pageSize is passed', () => {
  167. expect(() => {
  168. w.webContents.print({
  169. pageSize: {
  170. width: 100,
  171. height: 200
  172. }
  173. });
  174. }).to.throw('height and width properties must be minimum 352 microns.');
  175. });
  176. it('does not crash with custom margins', () => {
  177. expect(() => {
  178. w.webContents.print({
  179. silent: true,
  180. margins: {
  181. marginType: 'custom',
  182. top: 1,
  183. bottom: 1,
  184. left: 1,
  185. right: 1
  186. }
  187. });
  188. }).to.not.throw();
  189. });
  190. });
  191. describe('webContents.executeJavaScript', () => {
  192. describe('in about:blank', () => {
  193. const expected = 'hello, world!';
  194. const expectedErrorMsg = 'woops!';
  195. const code = `(() => "${expected}")()`;
  196. const asyncCode = `(() => new Promise(r => setTimeout(() => r("${expected}"), 500)))()`;
  197. const badAsyncCode = `(() => new Promise((r, e) => setTimeout(() => e("${expectedErrorMsg}"), 500)))()`;
  198. const errorTypes = new Set([
  199. Error,
  200. ReferenceError,
  201. EvalError,
  202. RangeError,
  203. SyntaxError,
  204. TypeError,
  205. URIError
  206. ]);
  207. let w: BrowserWindow;
  208. before(async () => {
  209. w = new BrowserWindow({ show: false, webPreferences: { contextIsolation: false } });
  210. await w.loadURL('about:blank');
  211. });
  212. after(closeAllWindows);
  213. it('resolves the returned promise with the result', async () => {
  214. const result = await w.webContents.executeJavaScript(code);
  215. expect(result).to.equal(expected);
  216. });
  217. it('resolves the returned promise with the result if the code returns an asyncronous promise', async () => {
  218. const result = await w.webContents.executeJavaScript(asyncCode);
  219. expect(result).to.equal(expected);
  220. });
  221. it('rejects the returned promise if an async error is thrown', async () => {
  222. await expect(w.webContents.executeJavaScript(badAsyncCode)).to.eventually.be.rejectedWith(expectedErrorMsg);
  223. });
  224. it('rejects the returned promise with an error if an Error.prototype is thrown', async () => {
  225. for (const error of errorTypes) {
  226. await expect(w.webContents.executeJavaScript(`Promise.reject(new ${error.name}("Wamp-wamp"))`))
  227. .to.eventually.be.rejectedWith(error);
  228. }
  229. });
  230. });
  231. describe('on a real page', () => {
  232. let w: BrowserWindow;
  233. beforeEach(() => {
  234. w = new BrowserWindow({ show: false });
  235. });
  236. afterEach(closeAllWindows);
  237. let server: http.Server = null as unknown as http.Server;
  238. let serverUrl: string = null as unknown as string;
  239. before((done) => {
  240. server = http.createServer((request, response) => {
  241. response.end();
  242. }).listen(0, '127.0.0.1', () => {
  243. serverUrl = 'http://127.0.0.1:' + (server.address() as AddressInfo).port;
  244. done();
  245. });
  246. });
  247. after(() => {
  248. server.close();
  249. });
  250. it('works after page load and during subframe load', async () => {
  251. await w.loadURL(serverUrl);
  252. // initiate a sub-frame load, then try and execute script during it
  253. await w.webContents.executeJavaScript(`
  254. var iframe = document.createElement('iframe')
  255. iframe.src = '${serverUrl}/slow'
  256. document.body.appendChild(iframe)
  257. null // don't return the iframe
  258. `);
  259. await w.webContents.executeJavaScript('console.log(\'hello\')');
  260. });
  261. it('executes after page load', async () => {
  262. const executeJavaScript = w.webContents.executeJavaScript('(() => "test")()');
  263. w.loadURL(serverUrl);
  264. const result = await executeJavaScript;
  265. expect(result).to.equal('test');
  266. });
  267. });
  268. });
  269. describe('webContents.executeJavaScriptInIsolatedWorld', () => {
  270. let w: BrowserWindow;
  271. before(async () => {
  272. w = new BrowserWindow({ show: false, webPreferences: { contextIsolation: true } });
  273. await w.loadURL('about:blank');
  274. });
  275. it('resolves the returned promise with the result', async () => {
  276. await w.webContents.executeJavaScriptInIsolatedWorld(999, [{ code: 'window.X = 123' }]);
  277. const isolatedResult = await w.webContents.executeJavaScriptInIsolatedWorld(999, [{ code: 'window.X' }]);
  278. const mainWorldResult = await w.webContents.executeJavaScript('window.X');
  279. expect(isolatedResult).to.equal(123);
  280. expect(mainWorldResult).to.equal(undefined);
  281. });
  282. });
  283. describe('loadURL() promise API', () => {
  284. let w: BrowserWindow;
  285. beforeEach(async () => {
  286. w = new BrowserWindow({ show: false });
  287. });
  288. afterEach(closeAllWindows);
  289. it('resolves when done loading', async () => {
  290. await expect(w.loadURL('about:blank')).to.eventually.be.fulfilled();
  291. });
  292. it('resolves when done loading a file URL', async () => {
  293. await expect(w.loadFile(path.join(fixturesPath, 'pages', 'base-page.html'))).to.eventually.be.fulfilled();
  294. });
  295. it('rejects when failing to load a file URL', async () => {
  296. await expect(w.loadURL('file:non-existent')).to.eventually.be.rejected()
  297. .and.have.property('code', 'ERR_FILE_NOT_FOUND');
  298. });
  299. // Temporarily disable on WOA until
  300. // https://github.com/electron/electron/issues/20008 is resolved
  301. const testFn = (process.platform === 'win32' && process.arch === 'arm64' ? it.skip : it);
  302. testFn('rejects when loading fails due to DNS not resolved', async () => {
  303. await expect(w.loadURL('https://err.name.not.resolved')).to.eventually.be.rejected()
  304. .and.have.property('code', 'ERR_NAME_NOT_RESOLVED');
  305. });
  306. it('rejects when navigation is cancelled due to a bad scheme', async () => {
  307. await expect(w.loadURL('bad-scheme://foo')).to.eventually.be.rejected()
  308. .and.have.property('code', 'ERR_FAILED');
  309. });
  310. it('sets appropriate error information on rejection', async () => {
  311. let err: any;
  312. try {
  313. await w.loadURL('file:non-existent');
  314. } catch (e) {
  315. err = e;
  316. }
  317. expect(err).not.to.be.null();
  318. expect(err.code).to.eql('ERR_FILE_NOT_FOUND');
  319. expect(err.errno).to.eql(-6);
  320. expect(err.url).to.eql(process.platform === 'win32' ? 'file://non-existent/' : 'file:///non-existent');
  321. });
  322. it('rejects if the load is aborted', async () => {
  323. const s = http.createServer(() => { /* never complete the request */ });
  324. await new Promise<void>(resolve => s.listen(0, '127.0.0.1', resolve));
  325. const { port } = s.address() as AddressInfo;
  326. const p = expect(w.loadURL(`http://127.0.0.1:${port}`)).to.eventually.be.rejectedWith(Error, /ERR_ABORTED/);
  327. // load a different file before the first load completes, causing the
  328. // first load to be aborted.
  329. await w.loadFile(path.join(fixturesPath, 'pages', 'base-page.html'));
  330. await p;
  331. s.close();
  332. });
  333. it("doesn't reject when a subframe fails to load", async () => {
  334. let resp = null as unknown as http.ServerResponse;
  335. const s = http.createServer((req, res) => {
  336. res.writeHead(200, { 'Content-Type': 'text/html' });
  337. res.write('<iframe src="http://err.name.not.resolved"></iframe>');
  338. resp = res;
  339. // don't end the response yet
  340. });
  341. await new Promise<void>(resolve => s.listen(0, '127.0.0.1', resolve));
  342. const { port } = s.address() as AddressInfo;
  343. const p = new Promise<void>(resolve => {
  344. w.webContents.on('did-fail-load', (event, errorCode, errorDescription, validatedURL, isMainFrame) => {
  345. if (!isMainFrame) {
  346. resolve();
  347. }
  348. });
  349. });
  350. const main = w.loadURL(`http://127.0.0.1:${port}`);
  351. await p;
  352. resp.end();
  353. await main;
  354. s.close();
  355. });
  356. it("doesn't resolve when a subframe loads", async () => {
  357. let resp = null as unknown as http.ServerResponse;
  358. const s = http.createServer((req, res) => {
  359. res.writeHead(200, { 'Content-Type': 'text/html' });
  360. res.write('<iframe src="about:blank"></iframe>');
  361. resp = res;
  362. // don't end the response yet
  363. });
  364. await new Promise<void>(resolve => s.listen(0, '127.0.0.1', resolve));
  365. const { port } = s.address() as AddressInfo;
  366. const p = new Promise<void>(resolve => {
  367. w.webContents.on('did-frame-finish-load', (event, isMainFrame) => {
  368. if (!isMainFrame) {
  369. resolve();
  370. }
  371. });
  372. });
  373. const main = w.loadURL(`http://127.0.0.1:${port}`);
  374. await p;
  375. resp.destroy(); // cause the main request to fail
  376. await expect(main).to.eventually.be.rejected()
  377. .and.have.property('errno', -355); // ERR_INCOMPLETE_CHUNKED_ENCODING
  378. s.close();
  379. });
  380. });
  381. describe('getFocusedWebContents() API', () => {
  382. afterEach(closeAllWindows);
  383. const testFn = (process.platform === 'win32' && process.arch === 'arm64' ? it.skip : it);
  384. testFn('returns the focused web contents', async () => {
  385. const w = new BrowserWindow({ show: true });
  386. await w.loadFile(path.join(__dirname, 'fixtures', 'blank.html'));
  387. expect(webContents.getFocusedWebContents().id).to.equal(w.webContents.id);
  388. const devToolsOpened = emittedOnce(w.webContents, 'devtools-opened');
  389. w.webContents.openDevTools();
  390. await devToolsOpened;
  391. expect(webContents.getFocusedWebContents().id).to.equal(w.webContents.devToolsWebContents!.id);
  392. const devToolsClosed = emittedOnce(w.webContents, 'devtools-closed');
  393. w.webContents.closeDevTools();
  394. await devToolsClosed;
  395. expect(webContents.getFocusedWebContents().id).to.equal(w.webContents.id);
  396. });
  397. it('does not crash when called on a detached dev tools window', async () => {
  398. const w = new BrowserWindow({ show: true });
  399. w.webContents.openDevTools({ mode: 'detach' });
  400. w.webContents.inspectElement(100, 100);
  401. // For some reason we have to wait for two focused events...?
  402. await emittedOnce(w.webContents, 'devtools-focused');
  403. expect(() => { webContents.getFocusedWebContents(); }).to.not.throw();
  404. // Work around https://github.com/electron/electron/issues/19985
  405. await delay();
  406. const devToolsClosed = emittedOnce(w.webContents, 'devtools-closed');
  407. w.webContents.closeDevTools();
  408. await devToolsClosed;
  409. expect(() => { webContents.getFocusedWebContents(); }).to.not.throw();
  410. });
  411. });
  412. describe('setDevToolsWebContents() API', () => {
  413. afterEach(closeAllWindows);
  414. it('sets arbitrary webContents as devtools', async () => {
  415. const w = new BrowserWindow({ show: false });
  416. const devtools = new BrowserWindow({ show: false });
  417. const promise = emittedOnce(devtools.webContents, 'dom-ready');
  418. w.webContents.setDevToolsWebContents(devtools.webContents);
  419. w.webContents.openDevTools();
  420. await promise;
  421. expect(devtools.webContents.getURL().startsWith('devtools://devtools')).to.be.true();
  422. const result = await devtools.webContents.executeJavaScript('InspectorFrontendHost.constructor.name');
  423. expect(result).to.equal('InspectorFrontendHostImpl');
  424. devtools.destroy();
  425. });
  426. });
  427. describe('isFocused() API', () => {
  428. it('returns false when the window is hidden', async () => {
  429. const w = new BrowserWindow({ show: false });
  430. await w.loadURL('about:blank');
  431. expect(w.isVisible()).to.be.false();
  432. expect(w.webContents.isFocused()).to.be.false();
  433. });
  434. });
  435. describe('isCurrentlyAudible() API', () => {
  436. afterEach(closeAllWindows);
  437. it('returns whether audio is playing', async () => {
  438. const w = new BrowserWindow({ show: false });
  439. await w.loadURL('about:blank');
  440. await w.webContents.executeJavaScript(`
  441. window.context = new AudioContext
  442. // Start in suspended state, because of the
  443. // new web audio api policy.
  444. context.suspend()
  445. window.oscillator = context.createOscillator()
  446. oscillator.connect(context.destination)
  447. oscillator.start()
  448. `);
  449. let p = emittedOnce(w.webContents, '-audio-state-changed');
  450. w.webContents.executeJavaScript('context.resume()');
  451. await p;
  452. expect(w.webContents.isCurrentlyAudible()).to.be.true();
  453. p = emittedOnce(w.webContents, '-audio-state-changed');
  454. w.webContents.executeJavaScript('oscillator.stop()');
  455. await p;
  456. expect(w.webContents.isCurrentlyAudible()).to.be.false();
  457. });
  458. });
  459. describe('openDevTools() API', () => {
  460. afterEach(closeAllWindows);
  461. it('can show window with activation', async () => {
  462. const w = new BrowserWindow({ show: false });
  463. const focused = emittedOnce(w, 'focus');
  464. w.show();
  465. await focused;
  466. expect(w.isFocused()).to.be.true();
  467. const blurred = emittedOnce(w, 'blur');
  468. w.webContents.openDevTools({ mode: 'detach', activate: true });
  469. await Promise.all([
  470. emittedOnce(w.webContents, 'devtools-opened'),
  471. emittedOnce(w.webContents, 'devtools-focused')
  472. ]);
  473. await blurred;
  474. expect(w.isFocused()).to.be.false();
  475. });
  476. it('can show window without activation', async () => {
  477. const w = new BrowserWindow({ show: false });
  478. const devtoolsOpened = emittedOnce(w.webContents, 'devtools-opened');
  479. w.webContents.openDevTools({ mode: 'detach', activate: false });
  480. await devtoolsOpened;
  481. expect(w.webContents.isDevToolsOpened()).to.be.true();
  482. });
  483. });
  484. describe('before-input-event event', () => {
  485. afterEach(closeAllWindows);
  486. it('can prevent document keyboard events', async () => {
  487. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  488. await w.loadFile(path.join(fixturesPath, 'pages', 'key-events.html'));
  489. const keyDown = new Promise(resolve => {
  490. ipcMain.once('keydown', (event, key) => resolve(key));
  491. });
  492. w.webContents.once('before-input-event', (event, input) => {
  493. if (input.key === 'a') event.preventDefault();
  494. });
  495. w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'a' });
  496. w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'b' });
  497. expect(await keyDown).to.equal('b');
  498. });
  499. it('has the correct properties', async () => {
  500. const w = new BrowserWindow({ show: false });
  501. await w.loadFile(path.join(fixturesPath, 'pages', 'base-page.html'));
  502. const testBeforeInput = async (opts: any) => {
  503. const modifiers = [];
  504. if (opts.shift) modifiers.push('shift');
  505. if (opts.control) modifiers.push('control');
  506. if (opts.alt) modifiers.push('alt');
  507. if (opts.meta) modifiers.push('meta');
  508. if (opts.isAutoRepeat) modifiers.push('isAutoRepeat');
  509. const p = emittedOnce(w.webContents, 'before-input-event');
  510. w.webContents.sendInputEvent({
  511. type: opts.type,
  512. keyCode: opts.keyCode,
  513. modifiers: modifiers as any
  514. });
  515. const [, input] = await p;
  516. expect(input.type).to.equal(opts.type);
  517. expect(input.key).to.equal(opts.key);
  518. expect(input.code).to.equal(opts.code);
  519. expect(input.isAutoRepeat).to.equal(opts.isAutoRepeat);
  520. expect(input.shift).to.equal(opts.shift);
  521. expect(input.control).to.equal(opts.control);
  522. expect(input.alt).to.equal(opts.alt);
  523. expect(input.meta).to.equal(opts.meta);
  524. };
  525. await testBeforeInput({
  526. type: 'keyDown',
  527. key: 'A',
  528. code: 'KeyA',
  529. keyCode: 'a',
  530. shift: true,
  531. control: true,
  532. alt: true,
  533. meta: true,
  534. isAutoRepeat: true
  535. });
  536. await testBeforeInput({
  537. type: 'keyUp',
  538. key: '.',
  539. code: 'Period',
  540. keyCode: '.',
  541. shift: false,
  542. control: true,
  543. alt: true,
  544. meta: false,
  545. isAutoRepeat: false
  546. });
  547. await testBeforeInput({
  548. type: 'keyUp',
  549. key: '!',
  550. code: 'Digit1',
  551. keyCode: '1',
  552. shift: true,
  553. control: false,
  554. alt: false,
  555. meta: true,
  556. isAutoRepeat: false
  557. });
  558. await testBeforeInput({
  559. type: 'keyUp',
  560. key: 'Tab',
  561. code: 'Tab',
  562. keyCode: 'Tab',
  563. shift: false,
  564. control: true,
  565. alt: false,
  566. meta: false,
  567. isAutoRepeat: true
  568. });
  569. });
  570. });
  571. // On Mac, zooming isn't done with the mouse wheel.
  572. ifdescribe(process.platform !== 'darwin')('zoom-changed', () => {
  573. afterEach(closeAllWindows);
  574. it('is emitted with the correct zoom-in info', async () => {
  575. const w = new BrowserWindow({ show: false });
  576. await w.loadFile(path.join(fixturesPath, 'pages', 'base-page.html'));
  577. const testZoomChanged = async () => {
  578. w.webContents.sendInputEvent({
  579. type: 'mouseWheel',
  580. x: 300,
  581. y: 300,
  582. deltaX: 0,
  583. deltaY: 1,
  584. wheelTicksX: 0,
  585. wheelTicksY: 1,
  586. modifiers: ['control', 'meta']
  587. });
  588. const [, zoomDirection] = await emittedOnce(w.webContents, 'zoom-changed');
  589. expect(zoomDirection).to.equal('in');
  590. };
  591. await testZoomChanged();
  592. });
  593. it('is emitted with the correct zoom-out info', async () => {
  594. const w = new BrowserWindow({ show: false });
  595. await w.loadFile(path.join(fixturesPath, 'pages', 'base-page.html'));
  596. const testZoomChanged = async () => {
  597. w.webContents.sendInputEvent({
  598. type: 'mouseWheel',
  599. x: 300,
  600. y: 300,
  601. deltaX: 0,
  602. deltaY: -1,
  603. wheelTicksX: 0,
  604. wheelTicksY: -1,
  605. modifiers: ['control', 'meta']
  606. });
  607. const [, zoomDirection] = await emittedOnce(w.webContents, 'zoom-changed');
  608. expect(zoomDirection).to.equal('out');
  609. };
  610. await testZoomChanged();
  611. });
  612. });
  613. describe('sendInputEvent(event)', () => {
  614. let w: BrowserWindow;
  615. beforeEach(async () => {
  616. w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  617. await w.loadFile(path.join(fixturesPath, 'pages', 'key-events.html'));
  618. });
  619. afterEach(closeAllWindows);
  620. it('can send keydown events', async () => {
  621. const keydown = emittedOnce(ipcMain, 'keydown');
  622. w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'A' });
  623. const [, key, code, keyCode, shiftKey, ctrlKey, altKey] = await keydown;
  624. expect(key).to.equal('a');
  625. expect(code).to.equal('KeyA');
  626. expect(keyCode).to.equal(65);
  627. expect(shiftKey).to.be.false();
  628. expect(ctrlKey).to.be.false();
  629. expect(altKey).to.be.false();
  630. });
  631. it('can send keydown events with modifiers', async () => {
  632. const keydown = emittedOnce(ipcMain, 'keydown');
  633. w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'Z', modifiers: ['shift', 'ctrl'] });
  634. const [, key, code, keyCode, shiftKey, ctrlKey, altKey] = await keydown;
  635. expect(key).to.equal('Z');
  636. expect(code).to.equal('KeyZ');
  637. expect(keyCode).to.equal(90);
  638. expect(shiftKey).to.be.true();
  639. expect(ctrlKey).to.be.true();
  640. expect(altKey).to.be.false();
  641. });
  642. it('can send keydown events with special keys', async () => {
  643. const keydown = emittedOnce(ipcMain, 'keydown');
  644. w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'Tab', modifiers: ['alt'] });
  645. const [, key, code, keyCode, shiftKey, ctrlKey, altKey] = await keydown;
  646. expect(key).to.equal('Tab');
  647. expect(code).to.equal('Tab');
  648. expect(keyCode).to.equal(9);
  649. expect(shiftKey).to.be.false();
  650. expect(ctrlKey).to.be.false();
  651. expect(altKey).to.be.true();
  652. });
  653. it('can send char events', async () => {
  654. const keypress = emittedOnce(ipcMain, 'keypress');
  655. w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'A' });
  656. w.webContents.sendInputEvent({ type: 'char', keyCode: 'A' });
  657. const [, key, code, keyCode, shiftKey, ctrlKey, altKey] = await keypress;
  658. expect(key).to.equal('a');
  659. expect(code).to.equal('KeyA');
  660. expect(keyCode).to.equal(65);
  661. expect(shiftKey).to.be.false();
  662. expect(ctrlKey).to.be.false();
  663. expect(altKey).to.be.false();
  664. });
  665. it('can send char events with modifiers', async () => {
  666. const keypress = emittedOnce(ipcMain, 'keypress');
  667. w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'Z' });
  668. w.webContents.sendInputEvent({ type: 'char', keyCode: 'Z', modifiers: ['shift', 'ctrl'] });
  669. const [, key, code, keyCode, shiftKey, ctrlKey, altKey] = await keypress;
  670. expect(key).to.equal('Z');
  671. expect(code).to.equal('KeyZ');
  672. expect(keyCode).to.equal(90);
  673. expect(shiftKey).to.be.true();
  674. expect(ctrlKey).to.be.true();
  675. expect(altKey).to.be.false();
  676. });
  677. });
  678. describe('insertCSS', () => {
  679. afterEach(closeAllWindows);
  680. it('supports inserting CSS', async () => {
  681. const w = new BrowserWindow({ show: false });
  682. w.loadURL('about:blank');
  683. await w.webContents.insertCSS('body { background-repeat: round; }');
  684. const result = await w.webContents.executeJavaScript('window.getComputedStyle(document.body).getPropertyValue("background-repeat")');
  685. expect(result).to.equal('round');
  686. });
  687. it('supports removing inserted CSS', async () => {
  688. const w = new BrowserWindow({ show: false });
  689. w.loadURL('about:blank');
  690. const key = await w.webContents.insertCSS('body { background-repeat: round; }');
  691. await w.webContents.removeInsertedCSS(key);
  692. const result = await w.webContents.executeJavaScript('window.getComputedStyle(document.body).getPropertyValue("background-repeat")');
  693. expect(result).to.equal('repeat');
  694. });
  695. });
  696. describe('inspectElement()', () => {
  697. afterEach(closeAllWindows);
  698. it('supports inspecting an element in the devtools', (done) => {
  699. const w = new BrowserWindow({ show: false });
  700. w.loadURL('about:blank');
  701. w.webContents.once('devtools-opened', () => { done(); });
  702. w.webContents.inspectElement(10, 10);
  703. });
  704. });
  705. describe('startDrag({file, icon})', () => {
  706. it('throws errors for a missing file or a missing/empty icon', () => {
  707. const w = new BrowserWindow({ show: false });
  708. expect(() => {
  709. w.webContents.startDrag({ icon: path.join(fixturesPath, 'assets', 'logo.png') } as any);
  710. }).to.throw('Must specify either \'file\' or \'files\' option');
  711. expect(() => {
  712. w.webContents.startDrag({ file: __filename } as any);
  713. }).to.throw('\'icon\' parameter is required');
  714. expect(() => {
  715. w.webContents.startDrag({ file: __filename, icon: path.join(mainFixturesPath, 'blank.png') });
  716. }).to.throw(/Failed to load image from path (.+)/);
  717. });
  718. });
  719. describe('focus APIs', () => {
  720. describe('focus()', () => {
  721. afterEach(closeAllWindows);
  722. it('does not blur the focused window when the web contents is hidden', async () => {
  723. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
  724. w.show();
  725. await w.loadURL('about:blank');
  726. w.focus();
  727. const child = new BrowserWindow({ show: false });
  728. child.loadURL('about:blank');
  729. child.webContents.focus();
  730. const currentFocused = w.isFocused();
  731. const childFocused = child.isFocused();
  732. child.close();
  733. expect(currentFocused).to.be.true();
  734. expect(childFocused).to.be.false();
  735. });
  736. });
  737. const moveFocusToDevTools = async (win: BrowserWindow) => {
  738. const devToolsOpened = emittedOnce(win.webContents, 'devtools-opened');
  739. win.webContents.openDevTools({ mode: 'right' });
  740. await devToolsOpened;
  741. win.webContents.devToolsWebContents!.focus();
  742. };
  743. describe('focus event', () => {
  744. afterEach(closeAllWindows);
  745. it('is triggered when web contents is focused', async () => {
  746. const w = new BrowserWindow({ show: false });
  747. await w.loadURL('about:blank');
  748. await moveFocusToDevTools(w);
  749. const focusPromise = emittedOnce(w.webContents, 'focus');
  750. w.webContents.focus();
  751. await expect(focusPromise).to.eventually.be.fulfilled();
  752. });
  753. it('is triggered when BrowserWindow is focused', async () => {
  754. const window1 = new BrowserWindow({ show: false });
  755. const window2 = new BrowserWindow({ show: false });
  756. await Promise.all([
  757. window1.loadURL('about:blank'),
  758. window2.loadURL('about:blank')
  759. ]);
  760. const focusPromise1 = emittedOnce(window1.webContents, 'focus');
  761. const focusPromise2 = emittedOnce(window2.webContents, 'focus');
  762. window1.showInactive();
  763. window2.showInactive();
  764. window1.focus();
  765. await expect(focusPromise1).to.eventually.be.fulfilled();
  766. window2.focus();
  767. await expect(focusPromise2).to.eventually.be.fulfilled();
  768. });
  769. });
  770. describe('blur event', () => {
  771. afterEach(closeAllWindows);
  772. it('is triggered when web contents is blurred', async () => {
  773. const w = new BrowserWindow({ show: true });
  774. await w.loadURL('about:blank');
  775. w.webContents.focus();
  776. const blurPromise = emittedOnce(w.webContents, 'blur');
  777. await moveFocusToDevTools(w);
  778. await expect(blurPromise).to.eventually.be.fulfilled();
  779. });
  780. });
  781. });
  782. describe('getOSProcessId()', () => {
  783. afterEach(closeAllWindows);
  784. it('returns a valid procress id', async () => {
  785. const w = new BrowserWindow({ show: false });
  786. expect(w.webContents.getOSProcessId()).to.equal(0);
  787. await w.loadURL('about:blank');
  788. expect(w.webContents.getOSProcessId()).to.be.above(0);
  789. });
  790. });
  791. describe('getMediaSourceId()', () => {
  792. afterEach(closeAllWindows);
  793. it('returns a valid stream id', () => {
  794. const w = new BrowserWindow({ show: false });
  795. expect(w.webContents.getMediaSourceId(w.webContents)).to.be.a('string').that.is.not.empty();
  796. });
  797. });
  798. describe('userAgent APIs', () => {
  799. it('can set the user agent (functions)', () => {
  800. const w = new BrowserWindow({ show: false });
  801. const userAgent = w.webContents.getUserAgent();
  802. w.webContents.setUserAgent('my-user-agent');
  803. expect(w.webContents.getUserAgent()).to.equal('my-user-agent');
  804. w.webContents.setUserAgent(userAgent);
  805. expect(w.webContents.getUserAgent()).to.equal(userAgent);
  806. });
  807. it('can set the user agent (properties)', () => {
  808. const w = new BrowserWindow({ show: false });
  809. const userAgent = w.webContents.userAgent;
  810. w.webContents.userAgent = 'my-user-agent';
  811. expect(w.webContents.userAgent).to.equal('my-user-agent');
  812. w.webContents.userAgent = userAgent;
  813. expect(w.webContents.userAgent).to.equal(userAgent);
  814. });
  815. });
  816. describe('audioMuted APIs', () => {
  817. it('can set the audio mute level (functions)', () => {
  818. const w = new BrowserWindow({ show: false });
  819. w.webContents.setAudioMuted(true);
  820. expect(w.webContents.isAudioMuted()).to.be.true();
  821. w.webContents.setAudioMuted(false);
  822. expect(w.webContents.isAudioMuted()).to.be.false();
  823. });
  824. it('can set the audio mute level (functions)', () => {
  825. const w = new BrowserWindow({ show: false });
  826. w.webContents.audioMuted = true;
  827. expect(w.webContents.audioMuted).to.be.true();
  828. w.webContents.audioMuted = false;
  829. expect(w.webContents.audioMuted).to.be.false();
  830. });
  831. });
  832. describe('zoom api', () => {
  833. const hostZoomMap: Record<string, number> = {
  834. host1: 0.3,
  835. host2: 0.7,
  836. host3: 0.2
  837. };
  838. before(() => {
  839. const protocol = session.defaultSession.protocol;
  840. protocol.registerStringProtocol(standardScheme, (request, callback) => {
  841. const response = `<script>
  842. const {ipcRenderer} = require('electron')
  843. ipcRenderer.send('set-zoom', window.location.hostname)
  844. ipcRenderer.on(window.location.hostname + '-zoom-set', () => {
  845. ipcRenderer.send(window.location.hostname + '-zoom-level')
  846. })
  847. </script>`;
  848. callback({ data: response, mimeType: 'text/html' });
  849. });
  850. });
  851. after(() => {
  852. const protocol = session.defaultSession.protocol;
  853. protocol.unregisterProtocol(standardScheme);
  854. });
  855. afterEach(closeAllWindows);
  856. it('throws on an invalid zoomFactor', async () => {
  857. const w = new BrowserWindow({ show: false });
  858. await w.loadURL('about:blank');
  859. expect(() => {
  860. w.webContents.setZoomFactor(0.0);
  861. }).to.throw(/'zoomFactor' must be a double greater than 0.0/);
  862. expect(() => {
  863. w.webContents.setZoomFactor(-2.0);
  864. }).to.throw(/'zoomFactor' must be a double greater than 0.0/);
  865. });
  866. it('can set the correct zoom level (functions)', async () => {
  867. const w = new BrowserWindow({ show: false });
  868. try {
  869. await w.loadURL('about:blank');
  870. const zoomLevel = w.webContents.getZoomLevel();
  871. expect(zoomLevel).to.eql(0.0);
  872. w.webContents.setZoomLevel(0.5);
  873. const newZoomLevel = w.webContents.getZoomLevel();
  874. expect(newZoomLevel).to.eql(0.5);
  875. } finally {
  876. w.webContents.setZoomLevel(0);
  877. }
  878. });
  879. it('can set the correct zoom level (properties)', async () => {
  880. const w = new BrowserWindow({ show: false });
  881. try {
  882. await w.loadURL('about:blank');
  883. const zoomLevel = w.webContents.zoomLevel;
  884. expect(zoomLevel).to.eql(0.0);
  885. w.webContents.zoomLevel = 0.5;
  886. const newZoomLevel = w.webContents.zoomLevel;
  887. expect(newZoomLevel).to.eql(0.5);
  888. } finally {
  889. w.webContents.zoomLevel = 0;
  890. }
  891. });
  892. it('can set the correct zoom factor (functions)', async () => {
  893. const w = new BrowserWindow({ show: false });
  894. try {
  895. await w.loadURL('about:blank');
  896. const zoomFactor = w.webContents.getZoomFactor();
  897. expect(zoomFactor).to.eql(1.0);
  898. w.webContents.setZoomFactor(0.5);
  899. const newZoomFactor = w.webContents.getZoomFactor();
  900. expect(newZoomFactor).to.eql(0.5);
  901. } finally {
  902. w.webContents.setZoomFactor(1.0);
  903. }
  904. });
  905. it('can set the correct zoom factor (properties)', async () => {
  906. const w = new BrowserWindow({ show: false });
  907. try {
  908. await w.loadURL('about:blank');
  909. const zoomFactor = w.webContents.zoomFactor;
  910. expect(zoomFactor).to.eql(1.0);
  911. w.webContents.zoomFactor = 0.5;
  912. const newZoomFactor = w.webContents.zoomFactor;
  913. expect(newZoomFactor).to.eql(0.5);
  914. } finally {
  915. w.webContents.zoomFactor = 1.0;
  916. }
  917. });
  918. it('can persist zoom level across navigation', (done) => {
  919. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  920. let finalNavigation = false;
  921. ipcMain.on('set-zoom', (e, host) => {
  922. const zoomLevel = hostZoomMap[host];
  923. if (!finalNavigation) w.webContents.zoomLevel = zoomLevel;
  924. e.sender.send(`${host}-zoom-set`);
  925. });
  926. ipcMain.on('host1-zoom-level', (e) => {
  927. try {
  928. const zoomLevel = e.sender.getZoomLevel();
  929. const expectedZoomLevel = hostZoomMap.host1;
  930. expect(zoomLevel).to.equal(expectedZoomLevel);
  931. if (finalNavigation) {
  932. done();
  933. } else {
  934. w.loadURL(`${standardScheme}://host2`);
  935. }
  936. } catch (e) {
  937. done(e);
  938. }
  939. });
  940. ipcMain.once('host2-zoom-level', (e) => {
  941. try {
  942. const zoomLevel = e.sender.getZoomLevel();
  943. const expectedZoomLevel = hostZoomMap.host2;
  944. expect(zoomLevel).to.equal(expectedZoomLevel);
  945. finalNavigation = true;
  946. w.webContents.goBack();
  947. } catch (e) {
  948. done(e);
  949. }
  950. });
  951. w.loadURL(`${standardScheme}://host1`);
  952. });
  953. it('can propagate zoom level across same session', async () => {
  954. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
  955. const w2 = new BrowserWindow({ show: false });
  956. defer(() => {
  957. w2.setClosable(true);
  958. w2.close();
  959. });
  960. await w.loadURL(`${standardScheme}://host3`);
  961. w.webContents.zoomLevel = hostZoomMap.host3;
  962. await w2.loadURL(`${standardScheme}://host3`);
  963. const zoomLevel1 = w.webContents.zoomLevel;
  964. expect(zoomLevel1).to.equal(hostZoomMap.host3);
  965. const zoomLevel2 = w2.webContents.zoomLevel;
  966. expect(zoomLevel1).to.equal(zoomLevel2);
  967. });
  968. it('cannot propagate zoom level across different session', async () => {
  969. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
  970. const w2 = new BrowserWindow({
  971. show: false,
  972. webPreferences: {
  973. partition: 'temp'
  974. }
  975. });
  976. const protocol = w2.webContents.session.protocol;
  977. protocol.registerStringProtocol(standardScheme, (request, callback) => {
  978. callback('hello');
  979. });
  980. defer(() => {
  981. w2.setClosable(true);
  982. w2.close();
  983. protocol.unregisterProtocol(standardScheme);
  984. });
  985. await w.loadURL(`${standardScheme}://host3`);
  986. w.webContents.zoomLevel = hostZoomMap.host3;
  987. await w2.loadURL(`${standardScheme}://host3`);
  988. const zoomLevel1 = w.webContents.zoomLevel;
  989. expect(zoomLevel1).to.equal(hostZoomMap.host3);
  990. const zoomLevel2 = w2.webContents.zoomLevel;
  991. expect(zoomLevel2).to.equal(0);
  992. expect(zoomLevel1).to.not.equal(zoomLevel2);
  993. });
  994. it('can persist when it contains iframe', (done) => {
  995. const w = new BrowserWindow({ show: false });
  996. const server = http.createServer((req, res) => {
  997. setTimeout(() => {
  998. res.end();
  999. }, 200);
  1000. });
  1001. server.listen(0, '127.0.0.1', () => {
  1002. const url = 'http://127.0.0.1:' + (server.address() as AddressInfo).port;
  1003. const content = `<iframe src=${url}></iframe>`;
  1004. w.webContents.on('did-frame-finish-load', (e, isMainFrame) => {
  1005. if (!isMainFrame) {
  1006. try {
  1007. const zoomLevel = w.webContents.zoomLevel;
  1008. expect(zoomLevel).to.equal(2.0);
  1009. w.webContents.zoomLevel = 0;
  1010. done();
  1011. } catch (e) {
  1012. done(e);
  1013. } finally {
  1014. server.close();
  1015. }
  1016. }
  1017. });
  1018. w.webContents.on('dom-ready', () => {
  1019. w.webContents.zoomLevel = 2.0;
  1020. });
  1021. w.loadURL(`data:text/html,${content}`);
  1022. });
  1023. });
  1024. it('cannot propagate when used with webframe', async () => {
  1025. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  1026. const w2 = new BrowserWindow({ show: false });
  1027. const temporaryZoomSet = emittedOnce(ipcMain, 'temporary-zoom-set');
  1028. w.loadFile(path.join(fixturesPath, 'pages', 'webframe-zoom.html'));
  1029. await temporaryZoomSet;
  1030. const finalZoomLevel = w.webContents.getZoomLevel();
  1031. await w2.loadFile(path.join(fixturesPath, 'pages', 'c.html'));
  1032. const zoomLevel1 = w.webContents.zoomLevel;
  1033. const zoomLevel2 = w2.webContents.zoomLevel;
  1034. w2.setClosable(true);
  1035. w2.close();
  1036. expect(zoomLevel1).to.equal(finalZoomLevel);
  1037. expect(zoomLevel2).to.equal(0);
  1038. expect(zoomLevel1).to.not.equal(zoomLevel2);
  1039. });
  1040. describe('with unique domains', () => {
  1041. let server: http.Server;
  1042. let serverUrl: string;
  1043. let crossSiteUrl: string;
  1044. before((done) => {
  1045. server = http.createServer((req, res) => {
  1046. setTimeout(() => res.end('hey'), 0);
  1047. });
  1048. server.listen(0, '127.0.0.1', () => {
  1049. serverUrl = `http://127.0.0.1:${(server.address() as AddressInfo).port}`;
  1050. crossSiteUrl = `http://localhost:${(server.address() as AddressInfo).port}`;
  1051. done();
  1052. });
  1053. });
  1054. after(() => {
  1055. server.close();
  1056. });
  1057. it('cannot persist zoom level after navigation with webFrame', async () => {
  1058. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  1059. const source = `
  1060. const {ipcRenderer, webFrame} = require('electron')
  1061. webFrame.setZoomLevel(0.6)
  1062. ipcRenderer.send('zoom-level-set', webFrame.getZoomLevel())
  1063. `;
  1064. const zoomLevelPromise = emittedOnce(ipcMain, 'zoom-level-set');
  1065. await w.loadURL(serverUrl);
  1066. await w.webContents.executeJavaScript(source);
  1067. let [, zoomLevel] = await zoomLevelPromise;
  1068. expect(zoomLevel).to.equal(0.6);
  1069. const loadPromise = emittedOnce(w.webContents, 'did-finish-load');
  1070. await w.loadURL(crossSiteUrl);
  1071. await loadPromise;
  1072. zoomLevel = w.webContents.zoomLevel;
  1073. expect(zoomLevel).to.equal(0);
  1074. });
  1075. });
  1076. });
  1077. describe('webrtc ip policy api', () => {
  1078. afterEach(closeAllWindows);
  1079. it('can set and get webrtc ip policies', () => {
  1080. const w = new BrowserWindow({ show: false });
  1081. const policies = [
  1082. 'default',
  1083. 'default_public_interface_only',
  1084. 'default_public_and_private_interfaces',
  1085. 'disable_non_proxied_udp'
  1086. ];
  1087. policies.forEach((policy) => {
  1088. w.webContents.setWebRTCIPHandlingPolicy(policy as any);
  1089. expect(w.webContents.getWebRTCIPHandlingPolicy()).to.equal(policy);
  1090. });
  1091. });
  1092. });
  1093. describe('render view deleted events', () => {
  1094. let server: http.Server;
  1095. let serverUrl: string;
  1096. let crossSiteUrl: string;
  1097. before((done) => {
  1098. server = http.createServer((req, res) => {
  1099. const respond = () => {
  1100. if (req.url === '/redirect-cross-site') {
  1101. res.setHeader('Location', `${crossSiteUrl}/redirected`);
  1102. res.statusCode = 302;
  1103. res.end();
  1104. } else if (req.url === '/redirected') {
  1105. res.end('<html><script>window.localStorage</script></html>');
  1106. } else if (req.url === '/first-window-open') {
  1107. res.end(`<html><script>window.open('${serverUrl}/second-window-open', 'first child');</script></html>`);
  1108. } else if (req.url === '/second-window-open') {
  1109. res.end('<html><script>window.open(\'wrong://url\', \'second child\');</script></html>');
  1110. } else {
  1111. res.end();
  1112. }
  1113. };
  1114. setTimeout(respond, 0);
  1115. });
  1116. server.listen(0, '127.0.0.1', () => {
  1117. serverUrl = `http://127.0.0.1:${(server.address() as AddressInfo).port}`;
  1118. crossSiteUrl = `http://localhost:${(server.address() as AddressInfo).port}`;
  1119. done();
  1120. });
  1121. });
  1122. after(() => {
  1123. server.close();
  1124. });
  1125. afterEach(closeAllWindows);
  1126. it('does not emit current-render-view-deleted when speculative RVHs are deleted', async () => {
  1127. const w = new BrowserWindow({ show: false });
  1128. let currentRenderViewDeletedEmitted = false;
  1129. const renderViewDeletedHandler = () => {
  1130. currentRenderViewDeletedEmitted = true;
  1131. };
  1132. w.webContents.on('current-render-view-deleted' as any, renderViewDeletedHandler);
  1133. w.webContents.on('did-finish-load', () => {
  1134. w.webContents.removeListener('current-render-view-deleted' as any, renderViewDeletedHandler);
  1135. w.close();
  1136. });
  1137. const destroyed = emittedOnce(w.webContents, 'destroyed');
  1138. w.loadURL(`${serverUrl}/redirect-cross-site`);
  1139. await destroyed;
  1140. expect(currentRenderViewDeletedEmitted).to.be.false('current-render-view-deleted was emitted');
  1141. });
  1142. it('does not emit current-render-view-deleted when speculative RVHs are deleted', async () => {
  1143. const parentWindow = new BrowserWindow({ show: false });
  1144. let currentRenderViewDeletedEmitted = false;
  1145. let childWindow: BrowserWindow | null = null;
  1146. const destroyed = emittedOnce(parentWindow.webContents, 'destroyed');
  1147. const renderViewDeletedHandler = () => {
  1148. currentRenderViewDeletedEmitted = true;
  1149. };
  1150. const childWindowCreated = new Promise<void>((resolve) => {
  1151. app.once('browser-window-created', (event, window) => {
  1152. childWindow = window;
  1153. window.webContents.on('current-render-view-deleted' as any, renderViewDeletedHandler);
  1154. resolve();
  1155. });
  1156. });
  1157. parentWindow.loadURL(`${serverUrl}/first-window-open`);
  1158. await childWindowCreated;
  1159. childWindow!.webContents.removeListener('current-render-view-deleted' as any, renderViewDeletedHandler);
  1160. parentWindow.close();
  1161. await destroyed;
  1162. expect(currentRenderViewDeletedEmitted).to.be.false('child window was destroyed');
  1163. });
  1164. it('emits current-render-view-deleted if the current RVHs are deleted', async () => {
  1165. const w = new BrowserWindow({ show: false });
  1166. let currentRenderViewDeletedEmitted = false;
  1167. w.webContents.on('current-render-view-deleted' as any, () => {
  1168. currentRenderViewDeletedEmitted = true;
  1169. });
  1170. w.webContents.on('did-finish-load', () => {
  1171. w.close();
  1172. });
  1173. const destroyed = emittedOnce(w.webContents, 'destroyed');
  1174. w.loadURL(`${serverUrl}/redirect-cross-site`);
  1175. await destroyed;
  1176. expect(currentRenderViewDeletedEmitted).to.be.true('current-render-view-deleted wasn\'t emitted');
  1177. });
  1178. it('emits render-view-deleted if any RVHs are deleted', async () => {
  1179. const w = new BrowserWindow({ show: false });
  1180. let rvhDeletedCount = 0;
  1181. w.webContents.on('render-view-deleted' as any, () => {
  1182. rvhDeletedCount++;
  1183. });
  1184. w.webContents.on('did-finish-load', () => {
  1185. w.close();
  1186. });
  1187. const destroyed = emittedOnce(w.webContents, 'destroyed');
  1188. w.loadURL(`${serverUrl}/redirect-cross-site`);
  1189. await destroyed;
  1190. const expectedRenderViewDeletedEventCount = 1;
  1191. expect(rvhDeletedCount).to.equal(expectedRenderViewDeletedEventCount, 'render-view-deleted wasn\'t emitted the expected nr. of times');
  1192. });
  1193. });
  1194. describe('setIgnoreMenuShortcuts(ignore)', () => {
  1195. afterEach(closeAllWindows);
  1196. it('does not throw', () => {
  1197. const w = new BrowserWindow({ show: false });
  1198. expect(() => {
  1199. w.webContents.setIgnoreMenuShortcuts(true);
  1200. w.webContents.setIgnoreMenuShortcuts(false);
  1201. }).to.not.throw();
  1202. });
  1203. });
  1204. const crashPrefs = [
  1205. {
  1206. nodeIntegration: true
  1207. },
  1208. {
  1209. sandbox: true
  1210. }
  1211. ];
  1212. const nicePrefs = (o: any) => {
  1213. let s = '';
  1214. for (const key of Object.keys(o)) {
  1215. s += `${key}=${o[key]}, `;
  1216. }
  1217. return `(${s.slice(0, s.length - 2)})`;
  1218. };
  1219. for (const prefs of crashPrefs) {
  1220. describe(`crash with webPreferences ${nicePrefs(prefs)}`, () => {
  1221. let w: BrowserWindow;
  1222. beforeEach(async () => {
  1223. w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
  1224. await w.loadURL('about:blank');
  1225. });
  1226. afterEach(closeAllWindows);
  1227. it('isCrashed() is false by default', () => {
  1228. expect(w.webContents.isCrashed()).to.equal(false);
  1229. });
  1230. it('forcefullyCrashRenderer() crashes the process with reason=killed||crashed', async () => {
  1231. expect(w.webContents.isCrashed()).to.equal(false);
  1232. const crashEvent = emittedOnce(w.webContents, 'render-process-gone');
  1233. w.webContents.forcefullyCrashRenderer();
  1234. const [, details] = await crashEvent;
  1235. expect(details.reason === 'killed' || details.reason === 'crashed').to.equal(true, 'reason should be killed || crashed');
  1236. expect(w.webContents.isCrashed()).to.equal(true);
  1237. });
  1238. it('a crashed process is recoverable with reload()', async () => {
  1239. expect(w.webContents.isCrashed()).to.equal(false);
  1240. w.webContents.forcefullyCrashRenderer();
  1241. w.webContents.reload();
  1242. expect(w.webContents.isCrashed()).to.equal(false);
  1243. });
  1244. });
  1245. }
  1246. // Destroying webContents in its event listener is going to crash when
  1247. // Electron is built in Debug mode.
  1248. describe('destroy()', () => {
  1249. let server: http.Server;
  1250. let serverUrl: string;
  1251. before((done) => {
  1252. server = http.createServer((request, response) => {
  1253. switch (request.url) {
  1254. case '/net-error':
  1255. response.destroy();
  1256. break;
  1257. case '/200':
  1258. response.end();
  1259. break;
  1260. default:
  1261. done('unsupported endpoint');
  1262. }
  1263. }).listen(0, '127.0.0.1', () => {
  1264. serverUrl = 'http://127.0.0.1:' + (server.address() as AddressInfo).port;
  1265. done();
  1266. });
  1267. });
  1268. after(() => {
  1269. server.close();
  1270. });
  1271. const events = [
  1272. { name: 'did-start-loading', url: '/200' },
  1273. { name: 'dom-ready', url: '/200' },
  1274. { name: 'did-stop-loading', url: '/200' },
  1275. { name: 'did-finish-load', url: '/200' },
  1276. // FIXME: Multiple Emit calls inside an observer assume that object
  1277. // will be alive till end of the observer. Synchronous `destroy` api
  1278. // violates this contract and crashes.
  1279. { name: 'did-frame-finish-load', url: '/200' },
  1280. { name: 'did-fail-load', url: '/net-error' }
  1281. ];
  1282. for (const e of events) {
  1283. it(`should not crash when invoked synchronously inside ${e.name} handler`, async function () {
  1284. // This test is flaky on Windows CI and we don't know why, but the
  1285. // purpose of this test is to make sure Electron does not crash so it
  1286. // is fine to retry this test for a few times.
  1287. this.retries(3);
  1288. const contents = (webContents as any).create() as WebContents;
  1289. const originalEmit = contents.emit.bind(contents);
  1290. contents.emit = (...args) => { return originalEmit(...args); };
  1291. contents.once(e.name as any, () => (contents as any).destroy());
  1292. const destroyed = emittedOnce(contents, 'destroyed');
  1293. contents.loadURL(serverUrl + e.url);
  1294. await destroyed;
  1295. });
  1296. }
  1297. });
  1298. describe('did-change-theme-color event', () => {
  1299. afterEach(closeAllWindows);
  1300. it('is triggered with correct theme color', (done) => {
  1301. const w = new BrowserWindow({ show: true });
  1302. let count = 0;
  1303. w.webContents.on('did-change-theme-color', (e, color) => {
  1304. try {
  1305. if (count === 0) {
  1306. count += 1;
  1307. expect(color).to.equal('#FFEEDD');
  1308. w.loadFile(path.join(fixturesPath, 'pages', 'base-page.html'));
  1309. } else if (count === 1) {
  1310. expect(color).to.be.null();
  1311. done();
  1312. }
  1313. } catch (e) {
  1314. done(e);
  1315. }
  1316. });
  1317. w.loadFile(path.join(fixturesPath, 'pages', 'theme-color.html'));
  1318. });
  1319. });
  1320. describe('console-message event', () => {
  1321. afterEach(closeAllWindows);
  1322. it('is triggered with correct log message', (done) => {
  1323. const w = new BrowserWindow({ show: true });
  1324. w.webContents.on('console-message', (e, level, message) => {
  1325. // Don't just assert as Chromium might emit other logs that we should ignore.
  1326. if (message === 'a') {
  1327. done();
  1328. }
  1329. });
  1330. w.loadFile(path.join(fixturesPath, 'pages', 'a.html'));
  1331. });
  1332. });
  1333. describe('ipc-message event', () => {
  1334. afterEach(closeAllWindows);
  1335. it('emits when the renderer process sends an asynchronous message', async () => {
  1336. const w = new BrowserWindow({ show: true, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  1337. await w.webContents.loadURL('about:blank');
  1338. w.webContents.executeJavaScript(`
  1339. require('electron').ipcRenderer.send('message', 'Hello World!')
  1340. `);
  1341. const [, channel, message] = await emittedOnce(w.webContents, 'ipc-message');
  1342. expect(channel).to.equal('message');
  1343. expect(message).to.equal('Hello World!');
  1344. });
  1345. });
  1346. describe('ipc-message-sync event', () => {
  1347. afterEach(closeAllWindows);
  1348. it('emits when the renderer process sends a synchronous message', async () => {
  1349. const w = new BrowserWindow({ show: true, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  1350. await w.webContents.loadURL('about:blank');
  1351. const promise: Promise<[string, string]> = new Promise(resolve => {
  1352. w.webContents.once('ipc-message-sync', (event, channel, arg) => {
  1353. event.returnValue = 'foobar' as any;
  1354. resolve([channel, arg]);
  1355. });
  1356. });
  1357. const result = await w.webContents.executeJavaScript(`
  1358. require('electron').ipcRenderer.sendSync('message', 'Hello World!')
  1359. `);
  1360. const [channel, message] = await promise;
  1361. expect(channel).to.equal('message');
  1362. expect(message).to.equal('Hello World!');
  1363. expect(result).to.equal('foobar');
  1364. });
  1365. });
  1366. describe('referrer', () => {
  1367. afterEach(closeAllWindows);
  1368. it('propagates referrer information to new target=_blank windows', (done) => {
  1369. const w = new BrowserWindow({ show: false });
  1370. const server = http.createServer((req, res) => {
  1371. if (req.url === '/should_have_referrer') {
  1372. try {
  1373. expect(req.headers.referer).to.equal(`http://127.0.0.1:${(server.address() as AddressInfo).port}/`);
  1374. return done();
  1375. } catch (e) {
  1376. return done(e);
  1377. } finally {
  1378. server.close();
  1379. }
  1380. }
  1381. res.end('<a id="a" href="/should_have_referrer" target="_blank">link</a>');
  1382. });
  1383. server.listen(0, '127.0.0.1', () => {
  1384. const url = 'http://127.0.0.1:' + (server.address() as AddressInfo).port + '/';
  1385. w.webContents.once('did-finish-load', () => {
  1386. w.webContents.once('new-window', (event, newUrl, frameName, disposition, options, features, referrer) => {
  1387. expect(referrer.url).to.equal(url);
  1388. expect(referrer.policy).to.equal('strict-origin-when-cross-origin');
  1389. });
  1390. w.webContents.executeJavaScript('a.click()');
  1391. });
  1392. w.loadURL(url);
  1393. });
  1394. });
  1395. // TODO(jeremy): window.open() in a real browser passes the referrer, but
  1396. // our hacked-up window.open() shim doesn't. It should.
  1397. xit('propagates referrer information to windows opened with window.open', (done) => {
  1398. const w = new BrowserWindow({ show: false });
  1399. const server = http.createServer((req, res) => {
  1400. if (req.url === '/should_have_referrer') {
  1401. try {
  1402. expect(req.headers.referer).to.equal(`http://127.0.0.1:${(server.address() as AddressInfo).port}/`);
  1403. return done();
  1404. } catch (e) {
  1405. return done(e);
  1406. }
  1407. }
  1408. res.end('');
  1409. });
  1410. server.listen(0, '127.0.0.1', () => {
  1411. const url = 'http://127.0.0.1:' + (server.address() as AddressInfo).port + '/';
  1412. w.webContents.once('did-finish-load', () => {
  1413. w.webContents.once('new-window', (event, newUrl, frameName, disposition, options, features, referrer) => {
  1414. expect(referrer.url).to.equal(url);
  1415. expect(referrer.policy).to.equal('no-referrer-when-downgrade');
  1416. });
  1417. w.webContents.executeJavaScript('window.open(location.href + "should_have_referrer")');
  1418. });
  1419. w.loadURL(url);
  1420. });
  1421. });
  1422. });
  1423. describe('webframe messages in sandboxed contents', () => {
  1424. afterEach(closeAllWindows);
  1425. it('responds to executeJavaScript', async () => {
  1426. const w = new BrowserWindow({ show: false, webPreferences: { sandbox: true } });
  1427. await w.loadURL('about:blank');
  1428. const result = await w.webContents.executeJavaScript('37 + 5');
  1429. expect(result).to.equal(42);
  1430. });
  1431. });
  1432. describe('preload-error event', () => {
  1433. afterEach(closeAllWindows);
  1434. const generateSpecs = (description: string, sandbox: boolean) => {
  1435. describe(description, () => {
  1436. it('is triggered when unhandled exception is thrown', async () => {
  1437. const preload = path.join(fixturesPath, 'module', 'preload-error-exception.js');
  1438. const w = new BrowserWindow({
  1439. show: false,
  1440. webPreferences: {
  1441. sandbox,
  1442. preload
  1443. }
  1444. });
  1445. const promise = emittedOnce(w.webContents, 'preload-error');
  1446. w.loadURL('about:blank');
  1447. const [, preloadPath, error] = await promise;
  1448. expect(preloadPath).to.equal(preload);
  1449. expect(error.message).to.equal('Hello World!');
  1450. });
  1451. it('is triggered on syntax errors', async () => {
  1452. const preload = path.join(fixturesPath, 'module', 'preload-error-syntax.js');
  1453. const w = new BrowserWindow({
  1454. show: false,
  1455. webPreferences: {
  1456. sandbox,
  1457. preload
  1458. }
  1459. });
  1460. const promise = emittedOnce(w.webContents, 'preload-error');
  1461. w.loadURL('about:blank');
  1462. const [, preloadPath, error] = await promise;
  1463. expect(preloadPath).to.equal(preload);
  1464. expect(error.message).to.equal('foobar is not defined');
  1465. });
  1466. it('is triggered when preload script loading fails', async () => {
  1467. const preload = path.join(fixturesPath, 'module', 'preload-invalid.js');
  1468. const w = new BrowserWindow({
  1469. show: false,
  1470. webPreferences: {
  1471. sandbox,
  1472. preload
  1473. }
  1474. });
  1475. const promise = emittedOnce(w.webContents, 'preload-error');
  1476. w.loadURL('about:blank');
  1477. const [, preloadPath, error] = await promise;
  1478. expect(preloadPath).to.equal(preload);
  1479. expect(error.message).to.contain('preload-invalid.js');
  1480. });
  1481. });
  1482. };
  1483. generateSpecs('without sandbox', false);
  1484. generateSpecs('with sandbox', true);
  1485. });
  1486. describe('takeHeapSnapshot()', () => {
  1487. afterEach(closeAllWindows);
  1488. it('works with sandboxed renderers', async () => {
  1489. const w = new BrowserWindow({
  1490. show: false,
  1491. webPreferences: {
  1492. sandbox: true
  1493. }
  1494. });
  1495. await w.loadURL('about:blank');
  1496. const filePath = path.join(app.getPath('temp'), 'test.heapsnapshot');
  1497. const cleanup = () => {
  1498. try {
  1499. fs.unlinkSync(filePath);
  1500. } catch (e) {
  1501. // ignore error
  1502. }
  1503. };
  1504. try {
  1505. await w.webContents.takeHeapSnapshot(filePath);
  1506. const stats = fs.statSync(filePath);
  1507. expect(stats.size).not.to.be.equal(0);
  1508. } finally {
  1509. cleanup();
  1510. }
  1511. });
  1512. it('fails with invalid file path', async () => {
  1513. const w = new BrowserWindow({
  1514. show: false,
  1515. webPreferences: {
  1516. sandbox: true
  1517. }
  1518. });
  1519. await w.loadURL('about:blank');
  1520. const promise = w.webContents.takeHeapSnapshot('');
  1521. return expect(promise).to.be.eventually.rejectedWith(Error, 'takeHeapSnapshot failed');
  1522. });
  1523. });
  1524. describe('setBackgroundThrottling()', () => {
  1525. afterEach(closeAllWindows);
  1526. it('does not crash when allowing', () => {
  1527. const w = new BrowserWindow({ show: false });
  1528. w.webContents.setBackgroundThrottling(true);
  1529. });
  1530. it('does not crash when called via BrowserWindow', () => {
  1531. const w = new BrowserWindow({ show: false });
  1532. (w as any).setBackgroundThrottling(true);
  1533. });
  1534. it('does not crash when disallowing', () => {
  1535. const w = new BrowserWindow({ show: false, webPreferences: { backgroundThrottling: true } });
  1536. w.webContents.setBackgroundThrottling(false);
  1537. });
  1538. });
  1539. describe('getBackgroundThrottling()', () => {
  1540. afterEach(closeAllWindows);
  1541. it('works via getter', () => {
  1542. const w = new BrowserWindow({ show: false });
  1543. w.webContents.setBackgroundThrottling(false);
  1544. expect(w.webContents.getBackgroundThrottling()).to.equal(false);
  1545. w.webContents.setBackgroundThrottling(true);
  1546. expect(w.webContents.getBackgroundThrottling()).to.equal(true);
  1547. });
  1548. it('works via property', () => {
  1549. const w = new BrowserWindow({ show: false });
  1550. w.webContents.backgroundThrottling = false;
  1551. expect(w.webContents.backgroundThrottling).to.equal(false);
  1552. w.webContents.backgroundThrottling = true;
  1553. expect(w.webContents.backgroundThrottling).to.equal(true);
  1554. });
  1555. it('works via BrowserWindow', () => {
  1556. const w = new BrowserWindow({ show: false });
  1557. (w as any).setBackgroundThrottling(false);
  1558. expect((w as any).getBackgroundThrottling()).to.equal(false);
  1559. (w as any).setBackgroundThrottling(true);
  1560. expect((w as any).getBackgroundThrottling()).to.equal(true);
  1561. });
  1562. });
  1563. ifdescribe(features.isPrintingEnabled())('getPrinters()', () => {
  1564. afterEach(closeAllWindows);
  1565. it('can get printer list', async () => {
  1566. const w = new BrowserWindow({ show: false, webPreferences: { sandbox: true } });
  1567. await w.loadURL('about:blank');
  1568. const printers = w.webContents.getPrinters();
  1569. expect(printers).to.be.an('array');
  1570. });
  1571. });
  1572. ifdescribe(features.isPrintingEnabled())('getPrintersAsync()', () => {
  1573. afterEach(closeAllWindows);
  1574. it('can get printer list', async () => {
  1575. const w = new BrowserWindow({ show: false, webPreferences: { sandbox: true } });
  1576. await w.loadURL('about:blank');
  1577. const printers = await w.webContents.getPrintersAsync();
  1578. expect(printers).to.be.an('array');
  1579. });
  1580. });
  1581. ifdescribe(features.isPrintingEnabled())('printToPDF()', () => {
  1582. let w: BrowserWindow;
  1583. beforeEach(async () => {
  1584. w = new BrowserWindow({ show: false, webPreferences: { sandbox: true } });
  1585. await w.loadURL('data:text/html,<h1>Hello, World!</h1>');
  1586. });
  1587. afterEach(closeAllWindows);
  1588. it('rejects on incorrectly typed parameters', async () => {
  1589. const badTypes = {
  1590. marginsType: 'terrible',
  1591. scaleFactor: 'not-a-number',
  1592. landscape: [],
  1593. pageRanges: { oops: 'im-not-the-right-key' },
  1594. headerFooter: '123',
  1595. printSelectionOnly: 1,
  1596. printBackground: 2,
  1597. pageSize: 'IAmAPageSize'
  1598. };
  1599. // These will hard crash in Chromium unless we type-check
  1600. for (const [key, value] of Object.entries(badTypes)) {
  1601. const param = { [key]: value };
  1602. await expect(w.webContents.printToPDF(param)).to.eventually.be.rejected();
  1603. }
  1604. });
  1605. it('can print to PDF', async () => {
  1606. const data = await w.webContents.printToPDF({});
  1607. expect(data).to.be.an.instanceof(Buffer).that.is.not.empty();
  1608. });
  1609. it('does not crash when called multiple times in parallel', async () => {
  1610. const promises = [];
  1611. for (let i = 0; i < 3; i++) {
  1612. promises.push(w.webContents.printToPDF({}));
  1613. }
  1614. const results = await Promise.all(promises);
  1615. for (const data of results) {
  1616. expect(data).to.be.an.instanceof(Buffer).that.is.not.empty();
  1617. }
  1618. });
  1619. it('does not crash when called multiple times in sequence', async () => {
  1620. const results = [];
  1621. for (let i = 0; i < 3; i++) {
  1622. const result = await w.webContents.printToPDF({});
  1623. results.push(result);
  1624. }
  1625. for (const data of results) {
  1626. expect(data).to.be.an.instanceof(Buffer).that.is.not.empty();
  1627. }
  1628. });
  1629. // TODO(codebytere): Re-enable after Chromium fixes upstream v8_scriptormodule_legacy_lifetime crash.
  1630. xdescribe('using a large document', () => {
  1631. beforeEach(async () => {
  1632. w = new BrowserWindow({ show: false, webPreferences: { sandbox: true } });
  1633. await w.loadFile(path.join(__dirname, 'fixtures', 'api', 'print-to-pdf.html'));
  1634. });
  1635. afterEach(closeAllWindows);
  1636. it('respects custom settings', async () => {
  1637. const data = await w.webContents.printToPDF({
  1638. pageRanges: {
  1639. from: 0,
  1640. to: 2
  1641. },
  1642. landscape: true
  1643. });
  1644. const doc = await pdfjs.getDocument(data).promise;
  1645. // Check that correct # of pages are rendered.
  1646. expect(doc.numPages).to.equal(3);
  1647. // Check that PDF is generated in landscape mode.
  1648. const firstPage = await doc.getPage(1);
  1649. const { width, height } = firstPage.getViewport({ scale: 100 });
  1650. expect(width).to.be.greaterThan(height);
  1651. });
  1652. });
  1653. });
  1654. describe('PictureInPicture video', () => {
  1655. afterEach(closeAllWindows);
  1656. it('works as expected', async function () {
  1657. const w = new BrowserWindow({ show: false, webPreferences: { sandbox: true } });
  1658. await w.loadFile(path.join(fixturesPath, 'api', 'picture-in-picture.html'));
  1659. if (!await w.webContents.executeJavaScript('document.createElement(\'video\').canPlayType(\'video/webm; codecs="vp8.0"\')')) {
  1660. this.skip();
  1661. }
  1662. const result = await w.webContents.executeJavaScript(
  1663. `runTest(${features.isPictureInPictureEnabled()})`, true);
  1664. expect(result).to.be.true();
  1665. });
  1666. });
  1667. describe('devtools window', () => {
  1668. let hasRobotJS = false;
  1669. try {
  1670. // We have other tests that check if native modules work, if we fail to require
  1671. // robotjs let's skip this test to avoid false negatives
  1672. require('robotjs');
  1673. hasRobotJS = true;
  1674. } catch (err) { /* no-op */ }
  1675. afterEach(closeAllWindows);
  1676. // NB. on macOS, this requires that you grant your terminal the ability to
  1677. // control your computer. Open System Preferences > Security & Privacy >
  1678. // Privacy > Accessibility and grant your terminal the permission to control
  1679. // your computer.
  1680. ifit(hasRobotJS)('can receive and handle menu events', async () => {
  1681. const w = new BrowserWindow({ show: true, webPreferences: { nodeIntegration: true } });
  1682. w.loadFile(path.join(fixturesPath, 'pages', 'key-events.html'));
  1683. // Ensure the devtools are loaded
  1684. w.webContents.closeDevTools();
  1685. const opened = emittedOnce(w.webContents, 'devtools-opened');
  1686. w.webContents.openDevTools();
  1687. await opened;
  1688. await emittedOnce(w.webContents.devToolsWebContents!, 'did-finish-load');
  1689. w.webContents.devToolsWebContents!.focus();
  1690. // Focus an input field
  1691. await w.webContents.devToolsWebContents!.executeJavaScript(`
  1692. const input = document.createElement('input')
  1693. document.body.innerHTML = ''
  1694. document.body.appendChild(input)
  1695. input.focus()
  1696. `);
  1697. // Write something to the clipboard
  1698. clipboard.writeText('test value');
  1699. const pasted = w.webContents.devToolsWebContents!.executeJavaScript(`new Promise(resolve => {
  1700. document.querySelector('input').addEventListener('paste', (e) => {
  1701. resolve(e.target.value)
  1702. })
  1703. })`);
  1704. // Fake a paste request using robotjs to emulate a REAL keyboard paste event
  1705. require('robotjs').keyTap('v', process.platform === 'darwin' ? ['command'] : ['control']);
  1706. const val = await pasted;
  1707. // Once we're done expect the paste to have been successful
  1708. expect(val).to.equal('test value', 'value should eventually become the pasted value');
  1709. });
  1710. });
  1711. describe('Shared Workers', () => {
  1712. afterEach(closeAllWindows);
  1713. it('can get multiple shared workers', async () => {
  1714. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  1715. const ready = emittedOnce(ipcMain, 'ready');
  1716. w.loadFile(path.join(fixturesPath, 'api', 'shared-worker', 'shared-worker.html'));
  1717. await ready;
  1718. const sharedWorkers = w.webContents.getAllSharedWorkers();
  1719. expect(sharedWorkers).to.have.lengthOf(2);
  1720. expect(sharedWorkers[0].url).to.contain('shared-worker');
  1721. expect(sharedWorkers[1].url).to.contain('shared-worker');
  1722. });
  1723. it('can inspect a specific shared worker', async () => {
  1724. const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
  1725. const ready = emittedOnce(ipcMain, 'ready');
  1726. w.loadFile(path.join(fixturesPath, 'api', 'shared-worker', 'shared-worker.html'));
  1727. await ready;
  1728. const sharedWorkers = w.webContents.getAllSharedWorkers();
  1729. const devtoolsOpened = emittedOnce(w.webContents, 'devtools-opened');
  1730. w.webContents.inspectSharedWorkerById(sharedWorkers[0].id);
  1731. await devtoolsOpened;
  1732. const devtoolsClosed = emittedOnce(w.webContents, 'devtools-closed');
  1733. w.webContents.closeDevTools();
  1734. await devtoolsClosed;
  1735. });
  1736. });
  1737. describe('login event', () => {
  1738. afterEach(closeAllWindows);
  1739. let server: http.Server;
  1740. let serverUrl: string;
  1741. let serverPort: number;
  1742. let proxyServer: http.Server;
  1743. let proxyServerPort: number;
  1744. before((done) => {
  1745. server = http.createServer((request, response) => {
  1746. if (request.url === '/no-auth') {
  1747. return response.end('ok');
  1748. }
  1749. if (request.headers.authorization) {
  1750. response.writeHead(200, { 'Content-type': 'text/plain' });
  1751. return response.end(request.headers.authorization);
  1752. }
  1753. response
  1754. .writeHead(401, { 'WWW-Authenticate': 'Basic realm="Foo"' })
  1755. .end('401');
  1756. }).listen(0, '127.0.0.1', () => {
  1757. serverPort = (server.address() as AddressInfo).port;
  1758. serverUrl = `http://127.0.0.1:${serverPort}`;
  1759. done();
  1760. });
  1761. });
  1762. before((done) => {
  1763. proxyServer = http.createServer((request, response) => {
  1764. if (request.headers['proxy-authorization']) {
  1765. response.writeHead(200, { 'Content-type': 'text/plain' });
  1766. return response.end(request.headers['proxy-authorization']);
  1767. }
  1768. response
  1769. .writeHead(407, { 'Proxy-Authenticate': 'Basic realm="Foo"' })
  1770. .end();
  1771. }).listen(0, '127.0.0.1', () => {
  1772. proxyServerPort = (proxyServer.address() as AddressInfo).port;
  1773. done();
  1774. });
  1775. });
  1776. afterEach(async () => {
  1777. await session.defaultSession.clearAuthCache();
  1778. });
  1779. after(() => {
  1780. server.close();
  1781. proxyServer.close();
  1782. });
  1783. it('is emitted when navigating', async () => {
  1784. const [user, pass] = ['user', 'pass'];
  1785. const w = new BrowserWindow({ show: false });
  1786. let eventRequest: any;
  1787. let eventAuthInfo: any;
  1788. w.webContents.on('login', (event, request, authInfo, cb) => {
  1789. eventRequest = request;
  1790. eventAuthInfo = authInfo;
  1791. event.preventDefault();
  1792. cb(user, pass);
  1793. });
  1794. await w.loadURL(serverUrl);
  1795. const body = await w.webContents.executeJavaScript('document.documentElement.textContent');
  1796. expect(body).to.equal(`Basic ${Buffer.from(`${user}:${pass}`).toString('base64')}`);
  1797. expect(eventRequest.url).to.equal(serverUrl + '/');
  1798. expect(eventAuthInfo.isProxy).to.be.false();
  1799. expect(eventAuthInfo.scheme).to.equal('basic');
  1800. expect(eventAuthInfo.host).to.equal('127.0.0.1');
  1801. expect(eventAuthInfo.port).to.equal(serverPort);
  1802. expect(eventAuthInfo.realm).to.equal('Foo');
  1803. });
  1804. it('is emitted when a proxy requests authorization', async () => {
  1805. const customSession = session.fromPartition(`${Math.random()}`);
  1806. await customSession.setProxy({ proxyRules: `127.0.0.1:${proxyServerPort}`, proxyBypassRules: '<-loopback>' });
  1807. const [user, pass] = ['user', 'pass'];
  1808. const w = new BrowserWindow({ show: false, webPreferences: { session: customSession } });
  1809. let eventRequest: any;
  1810. let eventAuthInfo: any;
  1811. w.webContents.on('login', (event, request, authInfo, cb) => {
  1812. eventRequest = request;
  1813. eventAuthInfo = authInfo;
  1814. event.preventDefault();
  1815. cb(user, pass);
  1816. });
  1817. await w.loadURL(`${serverUrl}/no-auth`);
  1818. const body = await w.webContents.executeJavaScript('document.documentElement.textContent');
  1819. expect(body).to.equal(`Basic ${Buffer.from(`${user}:${pass}`).toString('base64')}`);
  1820. expect(eventRequest.url).to.equal(`${serverUrl}/no-auth`);
  1821. expect(eventAuthInfo.isProxy).to.be.true();
  1822. expect(eventAuthInfo.scheme).to.equal('basic');
  1823. expect(eventAuthInfo.host).to.equal('127.0.0.1');
  1824. expect(eventAuthInfo.port).to.equal(proxyServerPort);
  1825. expect(eventAuthInfo.realm).to.equal('Foo');
  1826. });
  1827. it('cancels authentication when callback is called with no arguments', async () => {
  1828. const w = new BrowserWindow({ show: false });
  1829. w.webContents.on('login', (event, request, authInfo, cb) => {
  1830. event.preventDefault();
  1831. cb();
  1832. });
  1833. await w.loadURL(serverUrl);
  1834. const body = await w.webContents.executeJavaScript('document.documentElement.textContent');
  1835. expect(body).to.equal('401');
  1836. });
  1837. });
  1838. describe('page-title-updated event', () => {
  1839. afterEach(closeAllWindows);
  1840. it('is emitted with a full title for pages with no navigation', async () => {
  1841. const bw = new BrowserWindow({ show: false });
  1842. await bw.loadURL('about:blank');
  1843. bw.webContents.executeJavaScript('child = window.open("", "", "show=no"); null');
  1844. const [, child] = await emittedOnce(app, 'web-contents-created');
  1845. bw.webContents.executeJavaScript('child.document.title = "new title"');
  1846. const [, title] = await emittedOnce(child, 'page-title-updated');
  1847. expect(title).to.equal('new title');
  1848. });
  1849. });
  1850. describe('crashed event', () => {
  1851. it('does not crash main process when destroying WebContents in it', (done) => {
  1852. const contents = (webContents as any).create({ nodeIntegration: true });
  1853. contents.once('crashed', () => {
  1854. contents.destroy();
  1855. done();
  1856. });
  1857. contents.loadURL('about:blank').then(() => contents.forcefullyCrashRenderer());
  1858. });
  1859. });
  1860. describe('context-menu event', () => {
  1861. afterEach(closeAllWindows);
  1862. it('emits when right-clicked in page', async () => {
  1863. const w = new BrowserWindow({ show: false });
  1864. await w.loadFile(path.join(fixturesPath, 'pages', 'base-page.html'));
  1865. const promise = emittedOnce(w.webContents, 'context-menu');
  1866. // Simulate right-click to create context-menu event.
  1867. const opts = { x: 0, y: 0, button: 'right' as any };
  1868. w.webContents.sendInputEvent({ ...opts, type: 'mouseDown' });
  1869. w.webContents.sendInputEvent({ ...opts, type: 'mouseUp' });
  1870. const [, params] = await promise;
  1871. expect(params.pageURL).to.equal(w.webContents.getURL());
  1872. expect(params.frame).to.be.an('object');
  1873. expect(params.x).to.be.a('number');
  1874. expect(params.y).to.be.a('number');
  1875. });
  1876. });
  1877. it('emits a cancelable event before creating a child webcontents', async () => {
  1878. const w = new BrowserWindow({
  1879. show: false,
  1880. webPreferences: {
  1881. sandbox: true
  1882. }
  1883. });
  1884. w.webContents.on('-will-add-new-contents' as any, (event: any, url: any) => {
  1885. expect(url).to.equal('about:blank');
  1886. event.preventDefault();
  1887. });
  1888. let wasCalled = false;
  1889. w.webContents.on('new-window' as any, () => {
  1890. wasCalled = true;
  1891. });
  1892. await w.loadURL('about:blank');
  1893. await w.webContents.executeJavaScript('window.open(\'about:blank\')');
  1894. await new Promise((resolve) => { process.nextTick(resolve); });
  1895. expect(wasCalled).to.equal(false);
  1896. await closeAllWindows();
  1897. });
  1898. });