1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624 |
- import { expect } from 'chai';
- import { BrowserWindow, WebContents, session, ipcMain, app, protocol, webContents } from 'electron/main';
- import { emittedOnce } from './events-helpers';
- import { closeAllWindows } from './window-helpers';
- import * as https from 'https';
- import * as http from 'http';
- import * as path from 'path';
- import * as fs from 'fs';
- import * as url from 'url';
- import * as ChildProcess from 'child_process';
- import { EventEmitter } from 'events';
- import { promisify } from 'util';
- import { ifit, ifdescribe, delay, defer } from './spec-helpers';
- import { AddressInfo } from 'net';
- import { PipeTransport } from './pipe-transport';
- const features = process._linkedBinding('electron_common_features');
- const fixturesPath = path.resolve(__dirname, '..', 'spec', 'fixtures');
- describe('reporting api', () => {
- // TODO(nornagon): this started failing a lot on CI. Figure out why and fix
- // it.
- it.skip('sends a report for a deprecation', async () => {
- const reports = new EventEmitter();
- // The Reporting API only works on https with valid certs. To dodge having
- // to set up a trusted certificate, hack the validator.
- session.defaultSession.setCertificateVerifyProc((req, cb) => {
- cb(0);
- });
- const certPath = path.join(fixturesPath, 'certificates');
- const options = {
- key: fs.readFileSync(path.join(certPath, 'server.key')),
- cert: fs.readFileSync(path.join(certPath, 'server.pem')),
- ca: [
- fs.readFileSync(path.join(certPath, 'rootCA.pem')),
- fs.readFileSync(path.join(certPath, 'intermediateCA.pem'))
- ],
- requestCert: true,
- rejectUnauthorized: false
- };
- const server = https.createServer(options, (req, res) => {
- if (req.url === '/report') {
- let data = '';
- req.on('data', (d) => { data += d.toString('utf-8'); });
- req.on('end', () => {
- reports.emit('report', JSON.parse(data));
- });
- }
- res.setHeader('Report-To', JSON.stringify({
- group: 'default',
- max_age: 120,
- endpoints: [{ url: `https://localhost:${(server.address() as any).port}/report` }]
- }));
- res.setHeader('Content-Type', 'text/html');
- // using the deprecated `webkitRequestAnimationFrame` will trigger a
- // "deprecation" report.
- res.end('<script>webkitRequestAnimationFrame(() => {})</script>');
- });
- await new Promise(resolve => server.listen(0, '127.0.0.1', resolve));
- const bw = new BrowserWindow({
- show: false
- });
- try {
- const reportGenerated = emittedOnce(reports, 'report');
- const url = `https://localhost:${(server.address() as any).port}/a`;
- await bw.loadURL(url);
- const [report] = await reportGenerated;
- expect(report).to.be.an('array');
- expect(report[0].type).to.equal('deprecation');
- expect(report[0].url).to.equal(url);
- expect(report[0].body.id).to.equal('PrefixedRequestAnimationFrame');
- } finally {
- bw.destroy();
- server.close();
- }
- });
- });
- describe('window.postMessage', () => {
- afterEach(async () => {
- await closeAllWindows();
- });
- it('sets the source and origin correctly', async () => {
- const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
- w.loadURL(`file://${fixturesPath}/pages/window-open-postMessage-driver.html`);
- const [, message] = await emittedOnce(ipcMain, 'complete');
- expect(message.data).to.equal('testing');
- expect(message.origin).to.equal('file://');
- expect(message.sourceEqualsOpener).to.equal(true);
- expect(message.eventOrigin).to.equal('file://');
- });
- });
- describe('focus handling', () => {
- let webviewContents: WebContents = null as unknown as WebContents;
- let w: BrowserWindow = null as unknown as BrowserWindow;
- beforeEach(async () => {
- w = new BrowserWindow({
- show: true,
- webPreferences: {
- nodeIntegration: true,
- webviewTag: true
- }
- });
- const webviewReady = emittedOnce(w.webContents, 'did-attach-webview');
- await w.loadFile(path.join(fixturesPath, 'pages', 'tab-focus-loop-elements.html'));
- const [, wvContents] = await webviewReady;
- webviewContents = wvContents;
- await emittedOnce(webviewContents, 'did-finish-load');
- w.focus();
- });
- afterEach(() => {
- webviewContents = null as unknown as WebContents;
- w.destroy();
- w = null as unknown as BrowserWindow;
- });
- const expectFocusChange = async () => {
- const [, focusedElementId] = await emittedOnce(ipcMain, 'focus-changed');
- return focusedElementId;
- };
- describe('a TAB press', () => {
- const tabPressEvent: any = {
- type: 'keyDown',
- keyCode: 'Tab'
- };
- it('moves focus to the next focusable item', async () => {
- let focusChange = expectFocusChange();
- w.webContents.sendInputEvent(tabPressEvent);
- let focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-element-1', `should start focused in element-1, it's instead in ${focusedElementId}`);
- focusChange = expectFocusChange();
- w.webContents.sendInputEvent(tabPressEvent);
- focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-element-2', `focus should've moved to element-2, it's instead in ${focusedElementId}`);
- focusChange = expectFocusChange();
- w.webContents.sendInputEvent(tabPressEvent);
- focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-wv-element-1', `focus should've moved to the webview's element-1, it's instead in ${focusedElementId}`);
- focusChange = expectFocusChange();
- webviewContents.sendInputEvent(tabPressEvent);
- focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-wv-element-2', `focus should've moved to the webview's element-2, it's instead in ${focusedElementId}`);
- focusChange = expectFocusChange();
- webviewContents.sendInputEvent(tabPressEvent);
- focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-element-3', `focus should've moved to element-3, it's instead in ${focusedElementId}`);
- focusChange = expectFocusChange();
- w.webContents.sendInputEvent(tabPressEvent);
- focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-element-1', `focus should've looped back to element-1, it's instead in ${focusedElementId}`);
- });
- });
- describe('a SHIFT + TAB press', () => {
- const shiftTabPressEvent: any = {
- type: 'keyDown',
- modifiers: ['Shift'],
- keyCode: 'Tab'
- };
- it('moves focus to the previous focusable item', async () => {
- let focusChange = expectFocusChange();
- w.webContents.sendInputEvent(shiftTabPressEvent);
- let focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-element-3', `should start focused in element-3, it's instead in ${focusedElementId}`);
- focusChange = expectFocusChange();
- w.webContents.sendInputEvent(shiftTabPressEvent);
- focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-wv-element-2', `focus should've moved to the webview's element-2, it's instead in ${focusedElementId}`);
- focusChange = expectFocusChange();
- webviewContents.sendInputEvent(shiftTabPressEvent);
- focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-wv-element-1', `focus should've moved to the webview's element-1, it's instead in ${focusedElementId}`);
- focusChange = expectFocusChange();
- webviewContents.sendInputEvent(shiftTabPressEvent);
- focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-element-2', `focus should've moved to element-2, it's instead in ${focusedElementId}`);
- focusChange = expectFocusChange();
- w.webContents.sendInputEvent(shiftTabPressEvent);
- focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-element-1', `focus should've moved to element-1, it's instead in ${focusedElementId}`);
- focusChange = expectFocusChange();
- w.webContents.sendInputEvent(shiftTabPressEvent);
- focusedElementId = await focusChange;
- expect(focusedElementId).to.equal('BUTTON-element-3', `focus should've looped back to element-3, it's instead in ${focusedElementId}`);
- });
- });
- });
- describe('web security', () => {
- afterEach(closeAllWindows);
- let server: http.Server;
- let serverUrl: string;
- before(async () => {
- server = http.createServer((req, res) => {
- res.setHeader('Content-Type', 'text/html');
- res.end('<body>');
- });
- await new Promise(resolve => server.listen(0, '127.0.0.1', resolve));
- serverUrl = `http://localhost:${(server.address() as any).port}`;
- });
- after(() => {
- server.close();
- });
- it('engages CORB when web security is not disabled', async () => {
- const w = new BrowserWindow({ show: true, webPreferences: { webSecurity: true, nodeIntegration: true } });
- const p = emittedOnce(ipcMain, 'success');
- await w.loadURL(`data:text/html,<script>
- const s = document.createElement('script')
- s.src = "${serverUrl}"
- // The script will load successfully but its body will be emptied out
- // by CORB, so we don't expect a syntax error.
- s.onload = () => { require('electron').ipcRenderer.send('success') }
- document.documentElement.appendChild(s)
- </script>`);
- await p;
- });
- it('bypasses CORB when web security is disabled', async () => {
- const w = new BrowserWindow({ show: true, webPreferences: { webSecurity: false, nodeIntegration: true } });
- const p = emittedOnce(ipcMain, 'success');
- await w.loadURL(`data:text/html,
- <script>
- window.onerror = (e) => { require('electron').ipcRenderer.send('success', e) }
- </script>
- <script src="${serverUrl}"></script>`);
- await p;
- });
- it('engages CORS when web security is not disabled', async () => {
- const w = new BrowserWindow({ show: false, webPreferences: { webSecurity: true, nodeIntegration: true } });
- const p = emittedOnce(ipcMain, 'response');
- await w.loadURL(`data:text/html,<script>
- (async function() {
- try {
- await fetch('${serverUrl}');
- require('electron').ipcRenderer.send('response', 'passed');
- } catch {
- require('electron').ipcRenderer.send('response', 'failed');
- }
- })();
- </script>`);
- const [, response] = await p;
- expect(response).to.equal('failed');
- });
- it('bypasses CORS when web security is disabled', async () => {
- const w = new BrowserWindow({ show: false, webPreferences: { webSecurity: false, nodeIntegration: true } });
- const p = emittedOnce(ipcMain, 'response');
- await w.loadURL(`data:text/html,<script>
- (async function() {
- try {
- await fetch('${serverUrl}');
- require('electron').ipcRenderer.send('response', 'passed');
- } catch {
- require('electron').ipcRenderer.send('response', 'failed');
- }
- })();
- </script>`);
- const [, response] = await p;
- expect(response).to.equal('passed');
- });
- describe('accessing file://', () => {
- async function loadFile (w: BrowserWindow) {
- const thisFile = url.format({
- pathname: __filename.replace(/\\/g, '/'),
- protocol: 'file',
- slashes: true
- });
- await w.loadURL(`data:text/html,<script>
- function loadFile() {
- return new Promise((resolve) => {
- fetch('${thisFile}').then(
- () => resolve('loaded'),
- () => resolve('failed')
- )
- });
- }
- </script>`);
- return await w.webContents.executeJavaScript('loadFile()');
- }
- it('is forbidden when web security is enabled', async () => {
- const w = new BrowserWindow({ show: false, webPreferences: { webSecurity: true } });
- const result = await loadFile(w);
- expect(result).to.equal('failed');
- });
- it('is allowed when web security is disabled', async () => {
- const w = new BrowserWindow({ show: false, webPreferences: { webSecurity: false } });
- const result = await loadFile(w);
- expect(result).to.equal('loaded');
- });
- });
- describe('wasm-eval csp', () => {
- async function loadWasm (csp: string) {
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- sandbox: true,
- enableBlinkFeatures: 'WebAssemblyCSP'
- }
- });
- await w.loadURL(`data:text/html,<head>
- <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self' 'unsafe-inline' ${csp}">
- </head>
- <script>
- function loadWasm() {
- const wasmBin = new Uint8Array([0, 97, 115, 109, 1, 0, 0, 0])
- return new Promise((resolve) => {
- WebAssembly.instantiate(wasmBin).then(() => {
- resolve('loaded')
- }).catch((error) => {
- resolve(error.message)
- })
- });
- }
- </script>`);
- return await w.webContents.executeJavaScript('loadWasm()');
- }
- it('wasm codegen is disallowed by default', async () => {
- const r = await loadWasm('');
- expect(r).to.equal('WebAssembly.instantiate(): Wasm code generation disallowed by embedder');
- });
- it('wasm codegen is allowed with "wasm-eval" csp', async () => {
- const r = await loadWasm("'wasm-eval'");
- expect(r).to.equal('loaded');
- });
- });
- it('does not crash when multiple WebContent are created with web security disabled', () => {
- const options = { webPreferences: { webSecurity: false } };
- const w1 = new BrowserWindow(options);
- w1.loadURL(serverUrl);
- const w2 = new BrowserWindow(options);
- w2.loadURL(serverUrl);
- });
- });
- describe('command line switches', () => {
- let appProcess: ChildProcess.ChildProcessWithoutNullStreams | undefined;
- afterEach(() => {
- if (appProcess && !appProcess.killed) {
- appProcess.kill();
- appProcess = undefined;
- }
- });
- describe('--lang switch', () => {
- const currentLocale = app.getLocale();
- const testLocale = async (locale: string, result: string, printEnv: boolean = false) => {
- const appPath = path.join(fixturesPath, 'api', 'locale-check');
- const args = [appPath, `--set-lang=${locale}`];
- if (printEnv) {
- args.push('--print-env');
- }
- appProcess = ChildProcess.spawn(process.execPath, args);
- let output = '';
- appProcess.stdout.on('data', (data) => { output += data; });
- await emittedOnce(appProcess.stdout, 'end');
- output = output.replace(/(\r\n|\n|\r)/gm, '');
- expect(output).to.equal(result);
- };
- it('should set the locale', async () => testLocale('fr', 'fr'));
- it('should not set an invalid locale', async () => testLocale('asdfkl', currentLocale));
- const lcAll = String(process.env.LC_ALL);
- ifit(process.platform === 'linux')('current process has a valid LC_ALL env', async () => {
- // The LC_ALL env should not be set to DOM locale string.
- expect(lcAll).to.not.equal(app.getLocale());
- });
- ifit(process.platform === 'linux')('should not change LC_ALL', async () => testLocale('fr', lcAll, true));
- ifit(process.platform === 'linux')('should not change LC_ALL when setting invalid locale', async () => testLocale('asdfkl', lcAll, true));
- ifit(process.platform === 'linux')('should not change LC_ALL when --lang is not set', async () => testLocale('', lcAll, true));
- });
- describe('--remote-debugging-pipe switch', () => {
- it('should expose CDP via pipe', async () => {
- const electronPath = process.execPath;
- appProcess = ChildProcess.spawn(electronPath, ['--remote-debugging-pipe'], {
- stdio: ['pipe', 'pipe', 'pipe', 'pipe', 'pipe']
- });
- const stdio = appProcess.stdio as unknown as [NodeJS.ReadableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.ReadableStream];
- const pipe = new PipeTransport(stdio[3], stdio[4]);
- const versionPromise = new Promise(resolve => { pipe.onmessage = resolve; });
- pipe.send({ id: 1, method: 'Browser.getVersion', params: {} });
- const message = (await versionPromise) as any;
- expect(message.id).to.equal(1);
- expect(message.result.product).to.contain('Chrome');
- expect(message.result.userAgent).to.contain('Electron');
- });
- it('should override --remote-debugging-port switch', async () => {
- const electronPath = process.execPath;
- appProcess = ChildProcess.spawn(electronPath, ['--remote-debugging-pipe', '--remote-debugging-port=0'], {
- stdio: ['pipe', 'pipe', 'pipe', 'pipe', 'pipe']
- });
- let stderr = '';
- appProcess.stderr.on('data', (data: string) => { stderr += data; });
- const stdio = appProcess.stdio as unknown as [NodeJS.ReadableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.ReadableStream];
- const pipe = new PipeTransport(stdio[3], stdio[4]);
- const versionPromise = new Promise(resolve => { pipe.onmessage = resolve; });
- pipe.send({ id: 1, method: 'Browser.getVersion', params: {} });
- const message = (await versionPromise) as any;
- expect(message.id).to.equal(1);
- expect(stderr).to.not.include('DevTools listening on');
- });
- it('should shut down Electron upon Browser.close CDP command', async () => {
- const electronPath = process.execPath;
- appProcess = ChildProcess.spawn(electronPath, ['--remote-debugging-pipe'], {
- stdio: ['pipe', 'pipe', 'pipe', 'pipe', 'pipe']
- });
- const stdio = appProcess.stdio as unknown as [NodeJS.ReadableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.ReadableStream];
- const pipe = new PipeTransport(stdio[3], stdio[4]);
- pipe.send({ id: 1, method: 'Browser.close', params: {} });
- await new Promise(resolve => { appProcess!.on('exit', resolve); });
- });
- });
- describe('--remote-debugging-port switch', () => {
- it('should display the discovery page', (done) => {
- const electronPath = process.execPath;
- let output = '';
- appProcess = ChildProcess.spawn(electronPath, ['--remote-debugging-port=']);
- appProcess.stderr.on('data', (data) => {
- output += data;
- const m = /DevTools listening on ws:\/\/127.0.0.1:(\d+)\//.exec(output);
- if (m) {
- appProcess!.stderr.removeAllListeners('data');
- const port = m[1];
- http.get(`http://127.0.0.1:${port}`, (res) => {
- try {
- expect(res.statusCode).to.eql(200);
- expect(parseInt(res.headers['content-length']!)).to.be.greaterThan(0);
- done();
- } catch (e) {
- done(e);
- } finally {
- res.destroy();
- }
- });
- }
- });
- });
- });
- });
- describe('chromium features', () => {
- afterEach(closeAllWindows);
- describe('accessing key names also used as Node.js module names', () => {
- it('does not crash', (done) => {
- const w = new BrowserWindow({ show: false });
- w.webContents.once('did-finish-load', () => { done(); });
- w.webContents.once('crashed', () => done(new Error('WebContents crashed.')));
- w.loadFile(path.join(fixturesPath, 'pages', 'external-string.html'));
- });
- });
- describe('loading jquery', () => {
- it('does not crash', (done) => {
- const w = new BrowserWindow({ show: false });
- w.webContents.once('did-finish-load', () => { done(); });
- w.webContents.once('crashed', () => done(new Error('WebContents crashed.')));
- w.loadFile(path.join(__dirname, 'fixtures', 'pages', 'jquery.html'));
- });
- });
- describe('navigator.languages', () => {
- it('should return the system locale only', async () => {
- const appLocale = app.getLocale();
- const w = new BrowserWindow({ show: false });
- await w.loadURL('about:blank');
- const languages = await w.webContents.executeJavaScript('navigator.languages');
- expect(languages.length).to.be.greaterThan(0);
- expect(languages).to.contain(appLocale);
- });
- });
- describe('navigator.serviceWorker', () => {
- it('should register for file scheme', (done) => {
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- nodeIntegration: true,
- partition: 'sw-file-scheme-spec'
- }
- });
- w.webContents.on('ipc-message', (event, channel, message) => {
- if (channel === 'reload') {
- w.webContents.reload();
- } else if (channel === 'error') {
- done(message);
- } else if (channel === 'response') {
- expect(message).to.equal('Hello from serviceWorker!');
- session.fromPartition('sw-file-scheme-spec').clearStorageData({
- storages: ['serviceworkers']
- }).then(() => done());
- }
- });
- w.webContents.on('crashed', () => done(new Error('WebContents crashed.')));
- w.loadFile(path.join(fixturesPath, 'pages', 'service-worker', 'index.html'));
- });
- it('should register for intercepted file scheme', (done) => {
- const customSession = session.fromPartition('intercept-file');
- customSession.protocol.interceptBufferProtocol('file', (request, callback) => {
- let file = url.parse(request.url).pathname!;
- if (file[0] === '/' && process.platform === 'win32') file = file.slice(1);
- const content = fs.readFileSync(path.normalize(file));
- const ext = path.extname(file);
- let type = 'text/html';
- if (ext === '.js') type = 'application/javascript';
- callback({ data: content, mimeType: type } as any);
- });
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- nodeIntegration: true,
- session: customSession
- }
- });
- w.webContents.on('ipc-message', (event, channel, message) => {
- if (channel === 'reload') {
- w.webContents.reload();
- } else if (channel === 'error') {
- done(`unexpected error : ${message}`);
- } else if (channel === 'response') {
- expect(message).to.equal('Hello from serviceWorker!');
- customSession.clearStorageData({
- storages: ['serviceworkers']
- }).then(() => {
- customSession.protocol.uninterceptProtocol('file');
- done();
- });
- }
- });
- w.webContents.on('crashed', () => done(new Error('WebContents crashed.')));
- w.loadFile(path.join(fixturesPath, 'pages', 'service-worker', 'index.html'));
- });
- it('should not crash when nodeIntegration is enabled', (done) => {
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- nodeIntegration: true,
- nodeIntegrationInWorker: true,
- partition: 'sw-file-scheme-worker-spec'
- }
- });
- w.webContents.on('ipc-message', (event, channel, message) => {
- if (channel === 'reload') {
- w.webContents.reload();
- } else if (channel === 'error') {
- done(`unexpected error : ${message}`);
- } else if (channel === 'response') {
- expect(message).to.equal('Hello from serviceWorker!');
- session.fromPartition('sw-file-scheme-worker-spec').clearStorageData({
- storages: ['serviceworkers']
- }).then(() => done());
- }
- });
- w.webContents.on('crashed', () => done(new Error('WebContents crashed.')));
- w.loadFile(path.join(fixturesPath, 'pages', 'service-worker', 'index.html'));
- });
- });
- describe('navigator.geolocation', () => {
- before(function () {
- if (!features.isFakeLocationProviderEnabled()) {
- return this.skip();
- }
- });
- it('returns error when permission is denied', async () => {
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- nodeIntegration: true,
- partition: 'geolocation-spec'
- }
- });
- const message = emittedOnce(w.webContents, 'ipc-message');
- w.webContents.session.setPermissionRequestHandler((wc, permission, callback) => {
- if (permission === 'geolocation') {
- callback(false);
- } else {
- callback(true);
- }
- });
- w.loadFile(path.join(fixturesPath, 'pages', 'geolocation', 'index.html'));
- const [, channel] = await message;
- expect(channel).to.equal('success', 'unexpected response from geolocation api');
- });
- });
- describe('form submit', () => {
- let server: http.Server;
- let serverUrl: string;
- before(async () => {
- server = http.createServer((req, res) => {
- let body = '';
- req.on('data', (chunk) => {
- body += chunk;
- });
- res.setHeader('Content-Type', 'application/json');
- req.on('end', () => {
- res.end(`body:${body}`);
- });
- });
- await new Promise(resolve => server.listen(0, '127.0.0.1', resolve));
- serverUrl = `http://localhost:${(server.address() as any).port}`;
- });
- after(async () => {
- server.close();
- await closeAllWindows();
- });
- [true, false].forEach((isSandboxEnabled) =>
- describe(`sandbox=${isSandboxEnabled}`, () => {
- it('posts data in the same window', async () => {
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- sandbox: isSandboxEnabled
- }
- });
- await w.loadFile(path.join(fixturesPath, 'pages', 'form-with-data.html'));
- const loadPromise = emittedOnce(w.webContents, 'did-finish-load');
- w.webContents.executeJavaScript(`
- const form = document.querySelector('form')
- form.action = '${serverUrl}';
- form.submit();
- `);
- await loadPromise;
- const res = await w.webContents.executeJavaScript('document.body.innerText');
- expect(res).to.equal('body:greeting=hello');
- });
- it('posts data to a new window with target=_blank', async () => {
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- sandbox: isSandboxEnabled
- }
- });
- await w.loadFile(path.join(fixturesPath, 'pages', 'form-with-data.html'));
- const windowCreatedPromise = emittedOnce(app, 'browser-window-created');
- w.webContents.executeJavaScript(`
- const form = document.querySelector('form')
- form.action = '${serverUrl}';
- form.target = '_blank';
- form.submit();
- `);
- const [, newWin] = await windowCreatedPromise;
- const res = await newWin.webContents.executeJavaScript('document.body.innerText');
- expect(res).to.equal('body:greeting=hello');
- });
- })
- );
- });
- describe('window.open', () => {
- for (const show of [true, false]) {
- it(`inherits parent visibility over parent {show=${show}} option`, async () => {
- const w = new BrowserWindow({ show });
- // toggle visibility
- if (show) {
- w.hide();
- } else {
- w.show();
- }
- defer(() => { w.close(); });
- const newWindow = emittedOnce(w.webContents, 'new-window');
- w.loadFile(path.join(fixturesPath, 'pages', 'window-open.html'));
- const [,,,, options] = await newWindow;
- expect(options.show).to.equal(w.isVisible());
- });
- }
- it('disables node integration when it is disabled on the parent window for chrome devtools URLs', async () => {
- const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
- w.loadURL('about:blank');
- w.webContents.executeJavaScript(`
- b = window.open('devtools://devtools/bundled/inspector.html', '', 'nodeIntegration=no,show=no')
- `);
- const [, contents] = await emittedOnce(app, 'web-contents-created');
- const typeofProcessGlobal = await contents.executeJavaScript('typeof process');
- expect(typeofProcessGlobal).to.equal('undefined');
- });
- it('disables JavaScript when it is disabled on the parent window', async () => {
- const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } });
- w.webContents.loadURL('about:blank');
- const windowUrl = require('url').format({
- pathname: `${fixturesPath}/pages/window-no-javascript.html`,
- protocol: 'file',
- slashes: true
- });
- w.webContents.executeJavaScript(`
- b = window.open(${JSON.stringify(windowUrl)}, '', 'javascript=no,show=no')
- `);
- const [, contents] = await emittedOnce(app, 'web-contents-created');
- await emittedOnce(contents, 'did-finish-load');
- // Click link on page
- contents.sendInputEvent({ type: 'mouseDown', clickCount: 1, x: 1, y: 1 });
- contents.sendInputEvent({ type: 'mouseUp', clickCount: 1, x: 1, y: 1 });
- const [, window] = await emittedOnce(app, 'browser-window-created');
- const preferences = window.webContents.getLastWebPreferences();
- expect(preferences.javascript).to.be.false();
- });
- it('handles cycles when merging the parent options into the child options', async () => {
- const foo = {} as any;
- foo.bar = foo;
- foo.baz = {
- hello: {
- world: true
- }
- };
- foo.baz2 = foo.baz;
- const w = new BrowserWindow({ show: false, foo: foo } as any);
- w.loadFile(path.join(fixturesPath, 'pages', 'window-open.html'));
- const [,,,, options] = await emittedOnce(w.webContents, 'new-window');
- expect(options.show).to.be.false();
- expect((options as any).foo).to.deep.equal({
- bar: undefined,
- baz: {
- hello: {
- world: true
- }
- },
- baz2: {
- hello: {
- world: true
- }
- }
- });
- });
- it('defines a window.location getter', async () => {
- let targetURL: string;
- if (process.platform === 'win32') {
- targetURL = `file:///${fixturesPath.replace(/\\/g, '/')}/pages/base-page.html`;
- } else {
- targetURL = `file://${fixturesPath}/pages/base-page.html`;
- }
- const w = new BrowserWindow({ show: false });
- w.loadURL('about:blank');
- w.webContents.executeJavaScript(`{ b = window.open(${JSON.stringify(targetURL)}); null }`);
- const [, window] = await emittedOnce(app, 'browser-window-created');
- await emittedOnce(window.webContents, 'did-finish-load');
- expect(await w.webContents.executeJavaScript('b.location.href')).to.equal(targetURL);
- });
- it('defines a window.location setter', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadURL('about:blank');
- w.webContents.executeJavaScript('{ b = window.open("about:blank"); null }');
- const [, { webContents }] = await emittedOnce(app, 'browser-window-created');
- await emittedOnce(webContents, 'did-finish-load');
- // When it loads, redirect
- w.webContents.executeJavaScript(`{ b.location = ${JSON.stringify(`file://${fixturesPath}/pages/base-page.html`)}; null }`);
- await emittedOnce(webContents, 'did-finish-load');
- });
- it('defines a window.location.href setter', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadURL('about:blank');
- w.webContents.executeJavaScript('{ b = window.open("about:blank"); null }');
- const [, { webContents }] = await emittedOnce(app, 'browser-window-created');
- await emittedOnce(webContents, 'did-finish-load');
- // When it loads, redirect
- w.webContents.executeJavaScript(`{ b.location.href = ${JSON.stringify(`file://${fixturesPath}/pages/base-page.html`)}; null }`);
- await emittedOnce(webContents, 'did-finish-load');
- });
- it('open a blank page when no URL is specified', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadURL('about:blank');
- w.webContents.executeJavaScript('{ b = window.open(); null }');
- const [, { webContents }] = await emittedOnce(app, 'browser-window-created');
- await emittedOnce(webContents, 'did-finish-load');
- expect(await w.webContents.executeJavaScript('b.location.href')).to.equal('about:blank');
- });
- it('open a blank page when an empty URL is specified', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadURL('about:blank');
- w.webContents.executeJavaScript('{ b = window.open(\'\'); null }');
- const [, { webContents }] = await emittedOnce(app, 'browser-window-created');
- await emittedOnce(webContents, 'did-finish-load');
- expect(await w.webContents.executeJavaScript('b.location.href')).to.equal('about:blank');
- });
- it('sets the window title to the specified frameName', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadURL('about:blank');
- w.webContents.executeJavaScript('{ b = window.open(\'\', \'hello\'); null }');
- const [, window] = await emittedOnce(app, 'browser-window-created');
- expect(window.getTitle()).to.equal('hello');
- });
- it('does not throw an exception when the frameName is a built-in object property', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadURL('about:blank');
- w.webContents.executeJavaScript('{ b = window.open(\'\', \'__proto__\'); null }');
- const [, window] = await emittedOnce(app, 'browser-window-created');
- expect(window.getTitle()).to.equal('__proto__');
- });
- it('denies custom open when nativeWindowOpen: true', async () => {
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- contextIsolation: false,
- nodeIntegration: true,
- nativeWindowOpen: true
- }
- });
- w.loadURL('about:blank');
- const previousListeners = process.listeners('uncaughtException');
- process.removeAllListeners('uncaughtException');
- try {
- const uncaughtException = new Promise<Error>(resolve => {
- process.once('uncaughtException', resolve);
- });
- expect(await w.webContents.executeJavaScript(`(${function () {
- const { ipc } = process._linkedBinding('electron_renderer_ipc');
- return ipc.sendSync(true, 'ELECTRON_GUEST_WINDOW_MANAGER_WINDOW_OPEN', ['', '', ''])[0];
- }})()`)).to.be.null();
- const exception = await uncaughtException;
- expect(exception.message).to.match(/denied: expected native window\.open/);
- } finally {
- previousListeners.forEach(l => process.on('uncaughtException', l));
- }
- });
- });
- describe('window.opener', () => {
- it('is null for main window', async () => {
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- nodeIntegration: true
- }
- });
- w.loadFile(path.join(fixturesPath, 'pages', 'window-opener.html'));
- const [, channel, opener] = await emittedOnce(w.webContents, 'ipc-message');
- expect(channel).to.equal('opener');
- expect(opener).to.equal(null);
- });
- });
- describe('navigator.mediaDevices', () => {
- afterEach(closeAllWindows);
- afterEach(() => {
- session.defaultSession.setPermissionCheckHandler(null);
- });
- it('can return labels of enumerated devices', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
- const labels = await w.webContents.executeJavaScript('navigator.mediaDevices.enumerateDevices().then(ds => ds.map(d => d.label))');
- expect(labels.some((l: any) => l)).to.be.true();
- });
- it('does not return labels of enumerated devices when permission denied', async () => {
- session.defaultSession.setPermissionCheckHandler(() => false);
- const w = new BrowserWindow({ show: false });
- w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
- const labels = await w.webContents.executeJavaScript('navigator.mediaDevices.enumerateDevices().then(ds => ds.map(d => d.label))');
- expect(labels.some((l: any) => l)).to.be.false();
- });
- it('returns the same device ids across reloads', async () => {
- const ses = session.fromPartition('persist:media-device-id');
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- nodeIntegration: true,
- session: ses
- }
- });
- w.loadFile(path.join(fixturesPath, 'pages', 'media-id-reset.html'));
- const [, firstDeviceIds] = await emittedOnce(ipcMain, 'deviceIds');
- const [, secondDeviceIds] = await emittedOnce(ipcMain, 'deviceIds', () => w.webContents.reload());
- expect(firstDeviceIds).to.deep.equal(secondDeviceIds);
- });
- it('can return new device id when cookie storage is cleared', async () => {
- const ses = session.fromPartition('persist:media-device-id');
- const w = new BrowserWindow({
- show: false,
- webPreferences: {
- nodeIntegration: true,
- session: ses
- }
- });
- w.loadFile(path.join(fixturesPath, 'pages', 'media-id-reset.html'));
- const [, firstDeviceIds] = await emittedOnce(ipcMain, 'deviceIds');
- await ses.clearStorageData({ storages: ['cookies'] });
- const [, secondDeviceIds] = await emittedOnce(ipcMain, 'deviceIds', () => w.webContents.reload());
- expect(firstDeviceIds).to.not.deep.equal(secondDeviceIds);
- });
- });
- describe('window.opener access', () => {
- const scheme = 'app';
- const fileUrl = `file://${fixturesPath}/pages/window-opener-location.html`;
- const httpUrl1 = `${scheme}://origin1`;
- const httpUrl2 = `${scheme}://origin2`;
- const fileBlank = `file://${fixturesPath}/pages/blank.html`;
- const httpBlank = `${scheme}://origin1/blank`;
- const table = [
- { parent: fileBlank, child: httpUrl1, nodeIntegration: false, nativeWindowOpen: false, openerAccessible: false },
- { parent: fileBlank, child: httpUrl1, nodeIntegration: false, nativeWindowOpen: true, openerAccessible: false },
- { parent: fileBlank, child: httpUrl1, nodeIntegration: true, nativeWindowOpen: false, openerAccessible: true },
- { parent: fileBlank, child: httpUrl1, nodeIntegration: true, nativeWindowOpen: true, openerAccessible: false },
- { parent: httpBlank, child: fileUrl, nodeIntegration: false, nativeWindowOpen: false, openerAccessible: false },
- // {parent: httpBlank, child: fileUrl, nodeIntegration: false, nativeWindowOpen: true, openerAccessible: false}, // can't window.open()
- { parent: httpBlank, child: fileUrl, nodeIntegration: true, nativeWindowOpen: false, openerAccessible: true },
- // {parent: httpBlank, child: fileUrl, nodeIntegration: true, nativeWindowOpen: true, openerAccessible: false}, // can't window.open()
- // NB. this is different from Chrome's behavior, which isolates file: urls from each other
- { parent: fileBlank, child: fileUrl, nodeIntegration: false, nativeWindowOpen: false, openerAccessible: true },
- { parent: fileBlank, child: fileUrl, nodeIntegration: false, nativeWindowOpen: true, openerAccessible: true },
- { parent: fileBlank, child: fileUrl, nodeIntegration: true, nativeWindowOpen: false, openerAccessible: true },
- { parent: fileBlank, child: fileUrl, nodeIntegration: true, nativeWindowOpen: true, openerAccessible: true },
- { parent: httpBlank, child: httpUrl1, nodeIntegration: false, nativeWindowOpen: false, openerAccessible: true },
- { parent: httpBlank, child: httpUrl1, nodeIntegration: false, nativeWindowOpen: true, openerAccessible: true },
- { parent: httpBlank, child: httpUrl1, nodeIntegration: true, nativeWindowOpen: false, openerAccessible: true },
- { parent: httpBlank, child: httpUrl1, nodeIntegration: true, nativeWindowOpen: true, openerAccessible: true },
- { parent: httpBlank, child: httpUrl2, nodeIntegration: false, nativeWindowOpen: false, openerAccessible: false },
- { parent: httpBlank, child: httpUrl2, nodeIntegration: false, nativeWindowOpen: true, openerAccessible: false },
- { parent: httpBlank, child: httpUrl2, nodeIntegration: true, nativeWindowOpen: false, openerAccessible: true },
- { parent: httpBlank, child: httpUrl2, nodeIntegration: true, nativeWindowOpen: true, openerAccessible: false }
- ];
- const s = (url: string) => url.startsWith('file') ? 'file://...' : url;
- before(() => {
- protocol.registerFileProtocol(scheme, (request, callback) => {
- if (request.url.includes('blank')) {
- callback(`${fixturesPath}/pages/blank.html`);
- } else {
- callback(`${fixturesPath}/pages/window-opener-location.html`);
- }
- });
- });
- after(() => {
- protocol.unregisterProtocol(scheme);
- });
- afterEach(closeAllWindows);
- describe('when opened from main window', () => {
- for (const { parent, child, nodeIntegration, nativeWindowOpen, openerAccessible } of table) {
- for (const sandboxPopup of [false, true]) {
- const description = `when parent=${s(parent)} opens child=${s(child)} with nodeIntegration=${nodeIntegration} nativeWindowOpen=${nativeWindowOpen} sandboxPopup=${sandboxPopup}, child should ${openerAccessible ? '' : 'not '}be able to access opener`;
- it(description, async () => {
- const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, nativeWindowOpen } });
- w.webContents.once('new-window', (e, url, frameName, disposition, options) => {
- options!.webPreferences!.sandbox = sandboxPopup;
- });
- await w.loadURL(parent);
- const childOpenerLocation = await w.webContents.executeJavaScript(`new Promise(resolve => {
- window.addEventListener('message', function f(e) {
- resolve(e.data)
- })
- window.open(${JSON.stringify(child)}, "", "show=no,nodeIntegration=${nodeIntegration ? 'yes' : 'no'}")
- })`);
- if (openerAccessible) {
- expect(childOpenerLocation).to.be.a('string');
- } else {
- expect(childOpenerLocation).to.be.null();
- }
- });
- }
- }
- });
- describe('when opened from <webview>', () => {
- for (const { parent, child, nodeIntegration, nativeWindowOpen, openerAccessible } of table) {
- const description = `when parent=${s(parent)} opens child=${s(child)} with nodeIntegration=${nodeIntegration} nativeWindowOpen=${nativeWindowOpen}, child should ${openerAccessible ? '' : 'not '}be able to access opener`;
- // WebView erroneously allows access to the parent window when nativeWindowOpen is false.
- const skip = !nativeWindowOpen && !openerAccessible;
- ifit(!skip)(description, async () => {
- // This test involves three contexts:
- // 1. The root BrowserWindow in which the test is run,
- // 2. A <webview> belonging to the root window,
- // 3. A window opened by calling window.open() from within the <webview>.
- // We are testing whether context (3) can access context (2) under various conditions.
- // This is context (1), the base window for the test.
- const w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, webviewTag: true } });
- await w.loadURL('about:blank');
- const parentCode = `new Promise((resolve) => {
- // This is context (3), a child window of the WebView.
- const child = window.open(${JSON.stringify(child)}, "", "show=no")
- window.addEventListener("message", e => {
- resolve(e.data)
- })
- })`;
- const childOpenerLocation = await w.webContents.executeJavaScript(`new Promise((resolve, reject) => {
- // This is context (2), a WebView which will call window.open()
- const webview = new WebView()
- webview.setAttribute('nodeintegration', '${nodeIntegration ? 'on' : 'off'}')
- webview.setAttribute('webpreferences', 'nativeWindowOpen=${nativeWindowOpen ? 'yes' : 'no'}')
- webview.setAttribute('allowpopups', 'on')
- webview.src = ${JSON.stringify(parent + '?p=' + encodeURIComponent(child))}
- webview.addEventListener('dom-ready', async () => {
- webview.executeJavaScript(${JSON.stringify(parentCode)}).then(resolve, reject)
- })
- document.body.appendChild(webview)
- })`);
- if (openerAccessible) {
- expect(childOpenerLocation).to.be.a('string');
- } else {
- expect(childOpenerLocation).to.be.null();
- }
- });
- }
- });
- });
- describe('storage', () => {
- describe('custom non standard schemes', () => {
- const protocolName = 'storage';
- let contents: WebContents;
- before(() => {
- protocol.registerFileProtocol(protocolName, (request, callback) => {
- const parsedUrl = url.parse(request.url);
- let filename;
- switch (parsedUrl.pathname) {
- case '/localStorage' : filename = 'local_storage.html'; break;
- case '/sessionStorage' : filename = 'session_storage.html'; break;
- case '/WebSQL' : filename = 'web_sql.html'; break;
- case '/indexedDB' : filename = 'indexed_db.html'; break;
- case '/cookie' : filename = 'cookie.html'; break;
- default : filename = '';
- }
- callback({ path: `${fixturesPath}/pages/storage/${filename}` });
- });
- });
- after(() => {
- protocol.unregisterProtocol(protocolName);
- });
- beforeEach(() => {
- contents = (webContents as any).create({
- nodeIntegration: true
- });
- });
- afterEach(() => {
- (contents as any).destroy();
- contents = null as any;
- });
- it('cannot access localStorage', async () => {
- const response = emittedOnce(ipcMain, 'local-storage-response');
- contents.loadURL(protocolName + '://host/localStorage');
- const [, error] = await response;
- expect(error).to.equal('Failed to read the \'localStorage\' property from \'Window\': Access is denied for this document.');
- });
- it('cannot access sessionStorage', async () => {
- const response = emittedOnce(ipcMain, 'session-storage-response');
- contents.loadURL(`${protocolName}://host/sessionStorage`);
- const [, error] = await response;
- expect(error).to.equal('Failed to read the \'sessionStorage\' property from \'Window\': Access is denied for this document.');
- });
- it('cannot access WebSQL database', async () => {
- const response = emittedOnce(ipcMain, 'web-sql-response');
- contents.loadURL(`${protocolName}://host/WebSQL`);
- const [, error] = await response;
- expect(error).to.equal('Failed to execute \'openDatabase\' on \'Window\': Access to the WebDatabase API is denied in this context.');
- });
- it('cannot access indexedDB', async () => {
- const response = emittedOnce(ipcMain, 'indexed-db-response');
- contents.loadURL(`${protocolName}://host/indexedDB`);
- const [, error] = await response;
- expect(error).to.equal('Failed to execute \'open\' on \'IDBFactory\': access to the Indexed Database API is denied in this context.');
- });
- it('cannot access cookie', async () => {
- const response = emittedOnce(ipcMain, 'cookie-response');
- contents.loadURL(`${protocolName}://host/cookie`);
- const [, error] = await response;
- expect(error).to.equal('Failed to set the \'cookie\' property on \'Document\': Access is denied for this document.');
- });
- });
- describe('can be accessed', () => {
- let server: http.Server;
- let serverUrl: string;
- let serverCrossSiteUrl: string;
- before((done) => {
- server = http.createServer((req, res) => {
- const respond = () => {
- if (req.url === '/redirect-cross-site') {
- res.setHeader('Location', `${serverCrossSiteUrl}/redirected`);
- res.statusCode = 302;
- res.end();
- } else if (req.url === '/redirected') {
- res.end('<html><script>window.localStorage</script></html>');
- } else {
- res.end();
- }
- };
- setTimeout(respond, 0);
- });
- server.listen(0, '127.0.0.1', () => {
- serverUrl = `http://127.0.0.1:${(server.address() as AddressInfo).port}`;
- serverCrossSiteUrl = `http://localhost:${(server.address() as AddressInfo).port}`;
- done();
- });
- });
- after(() => {
- server.close();
- server = null as any;
- });
- afterEach(closeAllWindows);
- const testLocalStorageAfterXSiteRedirect = (testTitle: string, extraPreferences = {}) => {
- it(testTitle, async () => {
- const w = new BrowserWindow({
- show: false,
- ...extraPreferences
- });
- let redirected = false;
- w.webContents.on('crashed', () => {
- expect.fail('renderer crashed / was killed');
- });
- w.webContents.on('did-redirect-navigation', (event, url) => {
- expect(url).to.equal(`${serverCrossSiteUrl}/redirected`);
- redirected = true;
- });
- await w.loadURL(`${serverUrl}/redirect-cross-site`);
- expect(redirected).to.be.true('didnt redirect');
- });
- };
- testLocalStorageAfterXSiteRedirect('after a cross-site redirect');
- testLocalStorageAfterXSiteRedirect('after a cross-site redirect in sandbox mode', { sandbox: true });
- });
- describe('enableWebSQL webpreference', () => {
- const standardScheme = (global as any).standardScheme;
- const origin = `${standardScheme}://fake-host`;
- const filePath = path.join(fixturesPath, 'pages', 'storage', 'web_sql.html');
- const sqlPartition = 'web-sql-preference-test';
- const sqlSession = session.fromPartition(sqlPartition);
- const securityError = 'An attempt was made to break through the security policy of the user agent.';
- let contents: WebContents, w: BrowserWindow;
- before(() => {
- sqlSession.protocol.registerFileProtocol(standardScheme, (request, callback) => {
- callback({ path: filePath });
- });
- });
- after(() => {
- sqlSession.protocol.unregisterProtocol(standardScheme);
- });
- afterEach(async () => {
- if (contents) {
- (contents as any).destroy();
- contents = null as any;
- }
- await closeAllWindows();
- (w as any) = null;
- });
- it('default value allows websql', async () => {
- contents = (webContents as any).create({
- session: sqlSession,
- nodeIntegration: true
- });
- contents.loadURL(origin);
- const [, error] = await emittedOnce(ipcMain, 'web-sql-response');
- expect(error).to.be.null();
- });
- it('when set to false can disallow websql', async () => {
- contents = (webContents as any).create({
- session: sqlSession,
- nodeIntegration: true,
- enableWebSQL: false
- });
- contents.loadURL(origin);
- const [, error] = await emittedOnce(ipcMain, 'web-sql-response');
- expect(error).to.equal(securityError);
- });
- it('when set to false does not disable indexedDB', async () => {
- contents = (webContents as any).create({
- session: sqlSession,
- nodeIntegration: true,
- enableWebSQL: false
- });
- contents.loadURL(origin);
- const [, error] = await emittedOnce(ipcMain, 'web-sql-response');
- expect(error).to.equal(securityError);
- const dbName = 'random';
- const result = await contents.executeJavaScript(`
- new Promise((resolve, reject) => {
- try {
- let req = window.indexedDB.open('${dbName}');
- req.onsuccess = (event) => {
- let db = req.result;
- resolve(db.name);
- }
- req.onerror = (event) => { resolve(event.target.code); }
- } catch (e) {
- resolve(e.message);
- }
- });
- `);
- expect(result).to.equal(dbName);
- });
- it('child webContents can override when the embedder has allowed websql', async () => {
- w = new BrowserWindow({
- show: false,
- webPreferences: {
- nodeIntegration: true,
- webviewTag: true,
- session: sqlSession
- }
- });
- w.webContents.loadURL(origin);
- const [, error] = await emittedOnce(ipcMain, 'web-sql-response');
- expect(error).to.be.null();
- const webviewResult = emittedOnce(ipcMain, 'web-sql-response');
- await w.webContents.executeJavaScript(`
- new Promise((resolve, reject) => {
- const webview = new WebView();
- webview.setAttribute('src', '${origin}');
- webview.setAttribute('webpreferences', 'enableWebSQL=0');
- webview.setAttribute('partition', '${sqlPartition}');
- webview.setAttribute('nodeIntegration', 'on');
- document.body.appendChild(webview);
- webview.addEventListener('dom-ready', () => resolve());
- });
- `);
- const [, childError] = await webviewResult;
- expect(childError).to.equal(securityError);
- });
- it('child webContents cannot override when the embedder has disallowed websql', async () => {
- w = new BrowserWindow({
- show: false,
- webPreferences: {
- nodeIntegration: true,
- enableWebSQL: false,
- webviewTag: true,
- session: sqlSession
- }
- });
- w.webContents.loadURL('data:text/html,<html></html>');
- const webviewResult = emittedOnce(ipcMain, 'web-sql-response');
- await w.webContents.executeJavaScript(`
- new Promise((resolve, reject) => {
- const webview = new WebView();
- webview.setAttribute('src', '${origin}');
- webview.setAttribute('webpreferences', 'enableWebSQL=1');
- webview.setAttribute('partition', '${sqlPartition}');
- webview.setAttribute('nodeIntegration', 'on');
- document.body.appendChild(webview);
- webview.addEventListener('dom-ready', () => resolve());
- });
- `);
- const [, childError] = await webviewResult;
- expect(childError).to.equal(securityError);
- });
- it('child webContents can use websql when the embedder has allowed websql', async () => {
- w = new BrowserWindow({
- show: false,
- webPreferences: {
- nodeIntegration: true,
- webviewTag: true,
- session: sqlSession
- }
- });
- w.webContents.loadURL(origin);
- const [, error] = await emittedOnce(ipcMain, 'web-sql-response');
- expect(error).to.be.null();
- const webviewResult = emittedOnce(ipcMain, 'web-sql-response');
- await w.webContents.executeJavaScript(`
- new Promise((resolve, reject) => {
- const webview = new WebView();
- webview.setAttribute('src', '${origin}');
- webview.setAttribute('webpreferences', 'enableWebSQL=1');
- webview.setAttribute('partition', '${sqlPartition}');
- webview.setAttribute('nodeIntegration', 'on');
- document.body.appendChild(webview);
- webview.addEventListener('dom-ready', () => resolve());
- });
- `);
- const [, childError] = await webviewResult;
- expect(childError).to.be.null();
- });
- });
- });
- ifdescribe(features.isPDFViewerEnabled())('PDF Viewer', () => {
- const pdfSource = url.format({
- pathname: path.join(__dirname, 'fixtures', 'cat.pdf').replace(/\\/g, '/'),
- protocol: 'file',
- slashes: true
- });
- it('opens when loading a pdf resource as top level navigation', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadURL(pdfSource);
- const [, contents] = await emittedOnce(app, 'web-contents-created');
- expect(contents.getURL()).to.equal('chrome-extension://mhjfbmdgcfjbbpaeojofohoefgiehjai/index.html');
- await new Promise((resolve) => {
- contents.on('did-finish-load', resolve);
- contents.on('did-frame-finish-load', resolve);
- });
- });
- it('opens when loading a pdf resource in a iframe', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadFile(path.join(__dirname, 'fixtures', 'pages', 'pdf-in-iframe.html'));
- const [, contents] = await emittedOnce(app, 'web-contents-created');
- expect(contents.getURL()).to.equal('chrome-extension://mhjfbmdgcfjbbpaeojofohoefgiehjai/index.html');
- await new Promise((resolve) => {
- contents.on('did-finish-load', resolve);
- contents.on('did-frame-finish-load', resolve);
- });
- });
- });
- describe('window.history', () => {
- describe('window.history.pushState', () => {
- it('should push state after calling history.pushState() from the same url', async () => {
- const w = new BrowserWindow({ show: false });
- await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
- // History should have current page by now.
- expect((w.webContents as any).length()).to.equal(1);
- const waitCommit = emittedOnce(w.webContents, 'navigation-entry-committed');
- w.webContents.executeJavaScript('window.history.pushState({}, "")');
- await waitCommit;
- // Initial page + pushed state.
- expect((w.webContents as any).length()).to.equal(2);
- });
- });
- });
- describe('chrome://media-internals', () => {
- it('loads the page successfully', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadURL('chrome://media-internals');
- const pageExists = await w.webContents.executeJavaScript(
- "window.hasOwnProperty('chrome') && window.chrome.hasOwnProperty('send')"
- );
- expect(pageExists).to.be.true();
- });
- });
- describe('chrome://webrtc-internals', () => {
- it('loads the page successfully', async () => {
- const w = new BrowserWindow({ show: false });
- w.loadURL('chrome://webrtc-internals');
- const pageExists = await w.webContents.executeJavaScript(
- "window.hasOwnProperty('chrome') && window.chrome.hasOwnProperty('send')"
- );
- expect(pageExists).to.be.true();
- });
- });
- });
- describe('font fallback', () => {
- async function getRenderedFonts (html: string) {
- const w = new BrowserWindow({ show: false });
- try {
- await w.loadURL(`data:text/html,${html}`);
- w.webContents.debugger.attach();
- const sendCommand = (method: string, commandParams?: any) => w.webContents.debugger.sendCommand(method, commandParams);
- const { nodeId } = (await sendCommand('DOM.getDocument')).root.children[0];
- await sendCommand('CSS.enable');
- const { fonts } = await sendCommand('CSS.getPlatformFontsForNode', { nodeId });
- return fonts;
- } finally {
- w.close();
- }
- }
- it('should use Helvetica for sans-serif on Mac, and Arial on Windows and Linux', async () => {
- const html = '<body style="font-family: sans-serif">test</body>';
- const fonts = await getRenderedFonts(html);
- expect(fonts).to.be.an('array');
- expect(fonts).to.have.length(1);
- if (process.platform === 'win32') { expect(fonts[0].familyName).to.equal('Arial'); } else if (process.platform === 'darwin') { expect(fonts[0].familyName).to.equal('Helvetica'); } else if (process.platform === 'linux') { expect(fonts[0].familyName).to.equal('DejaVu Sans'); } // I think this depends on the distro? We don't specify a default.
- });
- ifit(process.platform !== 'linux')('should fall back to Japanese font for sans-serif Japanese script', async function () {
- const html = `
- <html lang="ja-JP">
- <head>
- <meta charset="utf-8" />
- </head>
- <body style="font-family: sans-serif">test 智史</body>
- </html>
- `;
- const fonts = await getRenderedFonts(html);
- expect(fonts).to.be.an('array');
- expect(fonts).to.have.length(1);
- if (process.platform === 'win32') { expect(fonts[0].familyName).to.be.oneOf(['Meiryo', 'Yu Gothic']); } else if (process.platform === 'darwin') { expect(fonts[0].familyName).to.equal('Hiragino Kaku Gothic ProN'); }
- });
- });
- describe('iframe using HTML fullscreen API while window is OS-fullscreened', () => {
- const fullscreenChildHtml = promisify(fs.readFile)(
- path.join(fixturesPath, 'pages', 'fullscreen-oopif.html')
- );
- let w: BrowserWindow, server: http.Server;
- before(() => {
- server = http.createServer(async (_req, res) => {
- res.writeHead(200, { 'Content-Type': 'text/html' });
- res.write(await fullscreenChildHtml);
- res.end();
- });
- server.listen(8989, '127.0.0.1');
- });
- beforeEach(() => {
- w = new BrowserWindow({
- show: true,
- fullscreen: true,
- webPreferences: {
- nodeIntegration: true,
- nodeIntegrationInSubFrames: true
- }
- });
- });
- afterEach(async () => {
- await closeAllWindows();
- (w as any) = null;
- server.close();
- });
- it('can fullscreen from out-of-process iframes (OOPIFs)', async () => {
- const fullscreenChange = emittedOnce(ipcMain, 'fullscreenChange');
- const html =
- '<iframe style="width: 0" frameborder=0 src="http://localhost:8989" allowfullscreen></iframe>';
- w.loadURL(`data:text/html,${html}`);
- await fullscreenChange;
- const fullscreenWidth = await w.webContents.executeJavaScript(
- "document.querySelector('iframe').offsetWidth"
- );
- expect(fullscreenWidth > 0).to.be.true();
- await w.webContents.executeJavaScript(
- "document.querySelector('iframe').contentWindow.postMessage('exitFullscreen', '*')"
- );
- await delay(500);
- const width = await w.webContents.executeJavaScript(
- "document.querySelector('iframe').offsetWidth"
- );
- expect(width).to.equal(0);
- });
- it('can fullscreen from in-process iframes', async () => {
- const fullscreenChange = emittedOnce(ipcMain, 'fullscreenChange');
- w.loadFile(path.join(fixturesPath, 'pages', 'fullscreen-ipif.html'));
- await fullscreenChange;
- const fullscreenWidth = await w.webContents.executeJavaScript(
- "document.querySelector('iframe').offsetWidth"
- );
- expect(fullscreenWidth > 0).to.true();
- await w.webContents.executeJavaScript('document.exitFullscreen()');
- const width = await w.webContents.executeJavaScript(
- "document.querySelector('iframe').offsetWidth"
- );
- expect(width).to.equal(0);
- });
- });
- describe('navigator.clipboard', () => {
- let w: BrowserWindow;
- before(async () => {
- w = new BrowserWindow({
- show: false,
- webPreferences: {
- enableBlinkFeatures: 'Serial'
- }
- });
- await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
- });
- const readClipboard: any = () => {
- return w.webContents.executeJavaScript(`
- navigator.clipboard.read().then(clipboard => clipboard.toString()).catch(err => err.message);
- `, true);
- };
- after(closeAllWindows);
- afterEach(() => {
- session.defaultSession.setPermissionRequestHandler(null);
- });
- it('returns clipboard contents when a PermissionRequestHandler is not defined', async () => {
- const clipboard = await readClipboard();
- expect(clipboard).to.not.equal('Read permission denied.');
- });
- it('returns an error when permission denied', async () => {
- session.defaultSession.setPermissionRequestHandler((wc, permission, callback) => {
- if (permission === 'clipboard-read') {
- callback(false);
- } else {
- callback(true);
- }
- });
- const clipboard = await readClipboard();
- expect(clipboard).to.equal('Read permission denied.');
- });
- it('returns clipboard contents when permission is granted', async () => {
- session.defaultSession.setPermissionRequestHandler((wc, permission, callback) => {
- if (permission === 'clipboard-read') {
- callback(true);
- } else {
- callback(false);
- }
- });
- const clipboard = await readClipboard();
- expect(clipboard).to.not.equal('Read permission denied.');
- });
- });
- describe('navigator.bluetooth', () => {
- let w: BrowserWindow;
- before(async () => {
- w = new BrowserWindow({
- show: false,
- webPreferences: {
- enableBlinkFeatures: 'WebBluetooth'
- }
- });
- await w.loadFile(path.join(fixturesPath, 'pages', 'blank.html'));
- });
- after(closeAllWindows);
- it('can request bluetooth devices', async () => {
- const bluetooth = await w.webContents.executeJavaScript(`
- navigator.bluetooth.requestDevice({ acceptAllDevices: true}).then(device => "Found a device!").catch(err => err.message);`, true);
- expect(bluetooth).to.be.oneOf(['Found a device!', 'Bluetooth adapter not available.', 'User cancelled the requestDevice() chooser.']);
- });
- });
|