api-web-contents-spec.ts 77 KB

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