electron/spec/api-web-contents-spec.js

1353 строки
44 KiB
JavaScript

'use strict'
const assert = require('assert')
const ChildProcess = require('child_process')
const fs = require('fs')
const os = require('os')
const http = require('http')
const path = require('path')
const { closeWindow } = require('./window-helpers')
const { emittedOnce } = require('./events-helpers')
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const features = process.electronBinding('features')
const { ipcRenderer, remote, clipboard } = require('electron')
const { BrowserWindow, webContents, ipcMain, session } = remote
const { expect } = chai
const isCi = remote.getGlobal('isCi')
chai.use(dirtyChai)
/* The whole webContents API doesn't use standard callbacks */
/* eslint-disable standard/no-callback-literal */
describe('webContents module', () => {
const fixtures = path.resolve(__dirname, 'fixtures')
let w
beforeEach(() => {
w = new BrowserWindow({
show: false,
width: 400,
height: 400,
webPreferences: {
backgroundThrottling: false,
nodeIntegration: true,
webviewTag: true
}
})
})
afterEach(() => closeWindow(w).then(() => { w = null }))
describe('loadURL() promise API', () => {
it('resolves when done loading', async () => {
await expect(w.loadURL('about:blank')).to.eventually.be.fulfilled
})
it('resolves when done loading a file URL', async () => {
await expect(w.loadFile(path.join(fixtures, 'pages', 'base-page.html'))).to.eventually.be.fulfilled
})
it('rejects when failing to load a file URL', async () => {
await expect(w.loadURL('file:non-existent')).to.eventually.be.rejected
.and.have.property('code', 'ERR_FILE_NOT_FOUND')
})
it('rejects when loading fails due to DNS not resolved', async () => {
await expect(w.loadURL('https://err.name.not.resolved')).to.eventually.be.rejected
.and.have.property('code', 'ERR_NAME_NOT_RESOLVED')
})
it('rejects when navigation is cancelled due to a bad scheme', async () => {
await expect(w.loadURL('bad-scheme://foo')).to.eventually.be.rejected
.and.have.property('code', 'ERR_FAILED')
})
it('sets appropriate error information on rejection', async () => {
let err
try {
await w.loadURL('file:non-existent')
} catch (e) {
err = e
}
expect(err).not.to.be.null()
expect(err.code).to.eql('ERR_FILE_NOT_FOUND')
expect(err.errno).to.eql(-6)
expect(err.url).to.eql(process.platform === 'win32' ? 'file://non-existent/' : 'file:///non-existent')
})
it('rejects if the load is aborted', async () => {
const s = http.createServer((req, res) => { /* never complete the request */ })
await new Promise(resolve => s.listen(0, '127.0.0.1', resolve))
const { port } = s.address()
const p = expect(w.loadURL(`http://127.0.0.1:${port}`)).to.eventually.be.rejectedWith(Error, /ERR_ABORTED/)
// load a different file before the first load completes, causing the
// first load to be aborted.
await w.loadFile(path.join(fixtures, 'pages', 'base-page.html'))
await p
s.close()
})
it("doesn't reject when a subframe fails to load", async () => {
let resp = null
const s = http.createServer((req, res) => {
res.writeHead(200, { 'Content-Type': 'text/html' })
res.write('<iframe src="http://err.name.not.resolved"></iframe>')
resp = res
// don't end the response yet
})
await new Promise(resolve => s.listen(0, '127.0.0.1', resolve))
const { port } = s.address()
const p = new Promise(resolve => {
w.webContents.on('did-fail-load', (event, errorCode, errorDescription, validatedURL, isMainFrame, frameProcessId, frameRoutingId) => {
if (!isMainFrame) {
resolve()
}
})
})
const main = w.loadURL(`http://127.0.0.1:${port}`)
await p
resp.end()
await main
s.close()
})
it("doesn't resolve when a subframe loads", async () => {
let resp = null
const s = http.createServer((req, res) => {
res.writeHead(200, { 'Content-Type': 'text/html' })
res.write('<iframe src="data:text/html,hi"></iframe>')
resp = res
// don't end the response yet
})
await new Promise(resolve => s.listen(0, '127.0.0.1', resolve))
const { port } = s.address()
const p = new Promise(resolve => {
w.webContents.on('did-frame-finish-load', (event, errorCode, errorDescription, validatedURL, isMainFrame, frameProcessId, frameRoutingId) => {
if (!isMainFrame) {
resolve()
}
})
})
const main = w.loadURL(`http://127.0.0.1:${port}`)
await p
resp.destroy() // cause the main request to fail
await expect(main).to.eventually.be.rejected
.and.have.property('errno', -355) // ERR_INCOMPLETE_CHUNKED_ENCODING
s.close()
})
})
describe('getAllWebContents() API', () => {
it('returns an array of web contents', (done) => {
w.webContents.on('devtools-opened', () => {
const all = webContents.getAllWebContents().sort((a, b) => {
return a.id - b.id
})
assert.ok(all.length >= 4)
assert.strictEqual(all[0].getType(), 'window')
assert.strictEqual(all[all.length - 2].getType(), 'webview')
assert.strictEqual(all[all.length - 1].getType(), 'remote')
done()
})
w.loadFile(path.join(fixtures, 'pages', 'webview-zoom-factor.html'))
w.webContents.on('did-attach-webview', () => {
w.webContents.openDevTools()
})
})
})
describe('getFocusedWebContents() API', () => {
it('returns the focused web contents', (done) => {
if (isCi) return done()
const specWebContents = remote.getCurrentWebContents()
assert.strictEqual(specWebContents.id, webContents.getFocusedWebContents().id)
specWebContents.once('devtools-opened', () => {
assert.strictEqual(specWebContents.devToolsWebContents.id, webContents.getFocusedWebContents().id)
specWebContents.closeDevTools()
})
specWebContents.once('devtools-closed', () => {
assert.strictEqual(specWebContents.id, webContents.getFocusedWebContents().id)
done()
})
specWebContents.openDevTools()
})
it('does not crash when called on a detached dev tools window', (done) => {
const specWebContents = w.webContents
specWebContents.once('devtools-opened', () => {
assert.doesNotThrow(() => {
webContents.getFocusedWebContents()
})
specWebContents.closeDevTools()
})
specWebContents.once('devtools-closed', () => {
assert.doesNotThrow(() => {
webContents.getFocusedWebContents()
})
done()
})
specWebContents.openDevTools({ mode: 'detach' })
w.inspectElement(100, 100)
})
})
describe('setDevToolsWebContents() API', () => {
it('sets arbitry webContents as devtools', (done) => {
const devtools = new BrowserWindow({ show: false })
devtools.webContents.once('dom-ready', () => {
assert.ok(devtools.getURL().startsWith('chrome-devtools://devtools'))
devtools.webContents.executeJavaScript('InspectorFrontendHost.constructor.name', (name) => {
assert.ok(name, 'InspectorFrontendHostImpl')
devtools.destroy()
done()
})
})
w.webContents.setDevToolsWebContents(devtools.webContents)
w.webContents.openDevTools()
})
})
describe('isFocused() API', () => {
it('returns false when the window is hidden', () => {
BrowserWindow.getAllWindows().forEach((window) => {
assert.strictEqual(!window.isVisible() && window.webContents.isFocused(), false)
})
})
})
describe('isCurrentlyAudible() API', () => {
it('returns whether audio is playing', async () => {
const webContents = remote.getCurrentWebContents()
const context = new window.AudioContext()
// Start in suspended state, because of the
// new web audio api policy.
context.suspend()
const oscillator = context.createOscillator()
oscillator.connect(context.destination)
oscillator.start()
let p = emittedOnce(webContents, '-audio-state-changed')
await context.resume()
const [, audible] = await p
assert(webContents.isCurrentlyAudible() === audible)
expect(webContents.isCurrentlyAudible()).to.be.true()
p = emittedOnce(webContents, '-audio-state-changed')
oscillator.stop()
await p
expect(webContents.isCurrentlyAudible()).to.be.false()
oscillator.disconnect()
context.close()
})
})
describe('getWebPreferences() API', () => {
it('should not crash when called for devTools webContents', (done) => {
w.webContents.openDevTools()
w.webContents.once('devtools-opened', () => {
assert(!w.devToolsWebContents.getWebPreferences())
done()
})
})
})
describe('openDevTools() API', () => {
it('can show window with activation', async () => {
const focused = emittedOnce(w, 'focus')
w.show()
await focused
assert.strictEqual(w.isFocused(), true)
const devtoolsOpened = emittedOnce(w.webContents, 'devtools-opened')
w.webContents.openDevTools({ mode: 'detach', activate: true })
await devtoolsOpened
assert.strictEqual(w.isFocused(), false)
})
it('can show window without activation', async () => {
const devtoolsOpened = emittedOnce(w.webContents, 'devtools-opened')
w.webContents.openDevTools({ mode: 'detach', activate: false })
await devtoolsOpened
assert.strictEqual(w.isDevToolsOpened(), true)
})
})
describe('before-input-event event', () => {
it('can prevent document keyboard events', async () => {
await w.loadFile(path.join(fixtures, 'pages', 'key-events.html'))
const keyDown = new Promise(resolve => {
ipcMain.once('keydown', (event, key) => resolve(key))
})
ipcRenderer.sendSync('prevent-next-input-event', 'a', w.webContents.id)
w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'a' })
w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'b' })
assert.strictEqual(await keyDown, 'b')
})
it('has the correct properties', async () => {
await w.loadFile(path.join(fixtures, 'pages', 'base-page.html'))
const testBeforeInput = async (opts) => {
const modifiers = []
if (opts.shift) modifiers.push('shift')
if (opts.control) modifiers.push('control')
if (opts.alt) modifiers.push('alt')
if (opts.meta) modifiers.push('meta')
if (opts.isAutoRepeat) modifiers.push('isAutoRepeat')
const p = emittedOnce(w.webContents, 'before-input-event')
w.webContents.sendInputEvent({
type: opts.type,
keyCode: opts.keyCode,
modifiers: modifiers
})
const [, input] = await p
assert.strictEqual(input.type, opts.type)
assert.strictEqual(input.key, opts.key)
assert.strictEqual(input.code, opts.code)
assert.strictEqual(input.isAutoRepeat, opts.isAutoRepeat)
assert.strictEqual(input.shift, opts.shift)
assert.strictEqual(input.control, opts.control)
assert.strictEqual(input.alt, opts.alt)
assert.strictEqual(input.meta, opts.meta)
}
await testBeforeInput({
type: 'keyDown',
key: 'A',
code: 'KeyA',
keyCode: 'a',
shift: true,
control: true,
alt: true,
meta: true,
isAutoRepeat: true
})
await testBeforeInput({
type: 'keyUp',
key: '.',
code: 'Period',
keyCode: '.',
shift: false,
control: true,
alt: true,
meta: false,
isAutoRepeat: false
})
await testBeforeInput({
type: 'keyUp',
key: '!',
code: 'Digit1',
keyCode: '1',
shift: true,
control: false,
alt: false,
meta: true,
isAutoRepeat: false
})
await testBeforeInput({
type: 'keyUp',
key: 'Tab',
code: 'Tab',
keyCode: 'Tab',
shift: false,
control: true,
alt: false,
meta: false,
isAutoRepeat: true
})
})
})
describe('devtools window', () => {
let testFn = it
if (process.platform === 'darwin' && isCi) {
testFn = it.skip
}
if (process.platform === 'win32' && isCi) {
testFn = it.skip
}
try {
// We have other tests that check if native modules work, if we fail to require
// robotjs let's skip this test to avoid false negatives
require('robotjs')
} catch (err) {
testFn = it.skip
}
testFn('can receive and handle menu events', async function () {
this.timeout(5000)
w.show()
w.loadFile(path.join(fixtures, 'pages', 'key-events.html'))
// Ensure the devtools are loaded
w.webContents.closeDevTools()
const opened = emittedOnce(w.webContents, 'devtools-opened')
w.webContents.openDevTools()
await opened
await emittedOnce(w.webContents.devToolsWebContents, 'did-finish-load')
w.webContents.devToolsWebContents.focus()
// Focus an input field
await w.webContents.devToolsWebContents.executeJavaScript(
`const input = document.createElement('input');
document.body.innerHTML = '';
document.body.appendChild(input)
input.focus();`
)
// Write something to the clipboard
clipboard.writeText('test value')
// Fake a paste request using robotjs to emulate a REAL keyboard paste event
require('robotjs').keyTap('v', process.platform === 'darwin' ? ['command'] : ['control'])
const start = Date.now()
let val
// Check every now and again for the pasted value (paste is async)
while (val !== 'test value' && Date.now() - start <= 1000) {
val = await w.webContents.devToolsWebContents.executeJavaScript(
`document.querySelector('input').value`
)
await new Promise(resolve => setTimeout(resolve, 10))
}
// Once we're done expect the paste to have been successful
expect(val).to.equal('test value', 'value should eventually become the pasted value')
})
})
describe('sendInputEvent(event)', () => {
beforeEach(async () => {
await w.loadFile(path.join(fixtures, 'pages', 'key-events.html'))
})
it('can send keydown events', (done) => {
ipcMain.once('keydown', (event, key, code, keyCode, shiftKey, ctrlKey, altKey) => {
assert.strictEqual(key, 'a')
assert.strictEqual(code, 'KeyA')
assert.strictEqual(keyCode, 65)
assert.strictEqual(shiftKey, false)
assert.strictEqual(ctrlKey, false)
assert.strictEqual(altKey, false)
done()
})
w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'A' })
})
it('can send keydown events with modifiers', (done) => {
ipcMain.once('keydown', (event, key, code, keyCode, shiftKey, ctrlKey, altKey) => {
assert.strictEqual(key, 'Z')
assert.strictEqual(code, 'KeyZ')
assert.strictEqual(keyCode, 90)
assert.strictEqual(shiftKey, true)
assert.strictEqual(ctrlKey, true)
assert.strictEqual(altKey, false)
done()
})
w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'Z', modifiers: ['shift', 'ctrl'] })
})
it('can send keydown events with special keys', (done) => {
ipcMain.once('keydown', (event, key, code, keyCode, shiftKey, ctrlKey, altKey) => {
assert.strictEqual(key, 'Tab')
assert.strictEqual(code, 'Tab')
assert.strictEqual(keyCode, 9)
assert.strictEqual(shiftKey, false)
assert.strictEqual(ctrlKey, false)
assert.strictEqual(altKey, true)
done()
})
w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'Tab', modifiers: ['alt'] })
})
it('can send char events', (done) => {
ipcMain.once('keypress', (event, key, code, keyCode, shiftKey, ctrlKey, altKey) => {
assert.strictEqual(key, 'a')
assert.strictEqual(code, 'KeyA')
assert.strictEqual(keyCode, 65)
assert.strictEqual(shiftKey, false)
assert.strictEqual(ctrlKey, false)
assert.strictEqual(altKey, false)
done()
})
w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'A' })
w.webContents.sendInputEvent({ type: 'char', keyCode: 'A' })
})
it('can send char events with modifiers', (done) => {
ipcMain.once('keypress', (event, key, code, keyCode, shiftKey, ctrlKey, altKey) => {
assert.strictEqual(key, 'Z')
assert.strictEqual(code, 'KeyZ')
assert.strictEqual(keyCode, 90)
assert.strictEqual(shiftKey, true)
assert.strictEqual(ctrlKey, true)
assert.strictEqual(altKey, false)
done()
})
w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'Z' })
w.webContents.sendInputEvent({ type: 'char', keyCode: 'Z', modifiers: ['shift', 'ctrl'] })
})
})
it('supports inserting CSS', (done) => {
w.loadURL('about:blank')
w.webContents.insertCSS('body { background-repeat: round; }')
w.webContents.executeJavaScript('window.getComputedStyle(document.body).getPropertyValue("background-repeat")', (result) => {
assert.strictEqual(result, 'round')
done()
})
})
it('supports inspecting an element in the devtools', (done) => {
w.loadURL('about:blank')
w.webContents.once('devtools-opened', () => {
done()
})
w.webContents.inspectElement(10, 10)
})
describe('startDrag({file, icon})', () => {
it('throws errors for a missing file or a missing/empty icon', () => {
assert.throws(() => {
w.webContents.startDrag({ icon: path.join(fixtures, 'assets', 'logo.png') })
}, /Must specify either 'file' or 'files' option/)
assert.throws(() => {
w.webContents.startDrag({ file: __filename })
}, /Must specify 'icon' option/)
if (process.platform === 'darwin') {
assert.throws(() => {
w.webContents.startDrag({ file: __filename, icon: __filename })
}, /Must specify non-empty 'icon' option/)
}
})
})
describe('focus()', () => {
describe('when the web contents is hidden', () => {
it('does not blur the focused window', (done) => {
ipcMain.once('answer', (event, parentFocused, childFocused) => {
assert.strictEqual(parentFocused, true)
assert.strictEqual(childFocused, false)
done()
})
w.show()
w.loadFile(path.join(fixtures, 'pages', 'focus-web-contents.html'))
})
})
})
describe('getOSProcessId()', () => {
it('returns a valid procress id', async () => {
assert.strictEqual(w.webContents.getOSProcessId(), 0)
await w.loadURL('about:blank')
const pid = w.webContents.getOSProcessId()
expect(pid).to.be.above(0)
})
})
describe('zoom api', () => {
const zoomScheme = remote.getGlobal('zoomScheme')
const hostZoomMap = {
host1: 0.3,
host2: 0.7,
host3: 0.2
}
before((done) => {
const protocol = session.defaultSession.protocol
protocol.registerStringProtocol(zoomScheme, (request, callback) => {
const response = `<script>
const {ipcRenderer, remote} = require('electron')
ipcRenderer.send('set-zoom', window.location.hostname)
ipcRenderer.on(window.location.hostname + '-zoom-set', () => {
const zoomLevel = remote.getCurrentWebContents().getZoomLevel()
ipcRenderer.send(window.location.hostname + '-zoom-level', zoomLevel)
})
</script>`
callback({ data: response, mimeType: 'text/html' })
}, (error) => done(error))
})
after((done) => {
const protocol = session.defaultSession.protocol
protocol.unregisterProtocol(zoomScheme, (error) => done(error))
})
it('can set the correct zoom level', async () => {
try {
await w.loadURL('about:blank')
const zoomLevel = w.webContents.getZoomLevel()
expect(zoomLevel).to.eql(0.0)
w.webContents.setZoomLevel(0.5)
const newZoomLevel = w.webContents.getZoomLevel()
expect(newZoomLevel).to.eql(0.5)
} finally {
w.webContents.setZoomLevel(0)
}
})
// TODO(codebytere): remove when promisification is complete
it('can set the correct zoom level (callback)', async () => {
try {
await w.loadURL('about:blank')
const zoomLevel = await new Promise(resolve => w.webContents.getZoomLevel(resolve))
expect(zoomLevel).to.eql(0.0)
w.webContents.setZoomLevel(0.5)
const newZoomLevel = await new Promise(resolve => w.webContents.getZoomLevel(resolve))
expect(newZoomLevel).to.eql(0.5)
} finally {
w.webContents.setZoomLevel(0)
}
})
it('can persist zoom level across navigation', (done) => {
let finalNavigation = false
ipcMain.on('set-zoom', (e, host) => {
const zoomLevel = hostZoomMap[host]
if (!finalNavigation) w.webContents.setZoomLevel(zoomLevel)
e.sender.send(`${host}-zoom-set`)
})
ipcMain.on('host1-zoom-level', (e, zoomLevel) => {
const expectedZoomLevel = hostZoomMap.host1
assert.strictEqual(zoomLevel, expectedZoomLevel)
if (finalNavigation) {
done()
} else {
w.loadURL(`${zoomScheme}://host2`)
}
})
ipcMain.once('host2-zoom-level', (e, zoomLevel) => {
const expectedZoomLevel = hostZoomMap.host2
assert.strictEqual(zoomLevel, expectedZoomLevel)
finalNavigation = true
w.webContents.goBack()
})
w.loadURL(`${zoomScheme}://host1`)
})
it('can propagate zoom level across same session', (done) => {
const w2 = new BrowserWindow({
show: false
})
w2.webContents.on('did-finish-load', () => {
const zoomLevel1 = w.webContents.getZoomLevel()
assert.strictEqual(zoomLevel1, hostZoomMap.host3)
const zoomLevel2 = w2.webContents.getZoomLevel()
assert.strictEqual(zoomLevel1, zoomLevel2)
w2.setClosable(true)
w2.close()
done()
})
w.webContents.on('did-finish-load', () => {
w.webContents.setZoomLevel(hostZoomMap.host3)
w2.loadURL(`${zoomScheme}://host3`)
})
w.loadURL(`${zoomScheme}://host3`)
})
it('cannot propagate zoom level across different session', (done) => {
const w2 = new BrowserWindow({
show: false,
webPreferences: {
partition: 'temp'
}
})
const protocol = w2.webContents.session.protocol
protocol.registerStringProtocol(zoomScheme, (request, callback) => {
callback('hello')
}, (error) => {
if (error) return done(error)
w2.webContents.on('did-finish-load', () => {
const zoomLevel1 = w.webContents.getZoomLevel()
assert.strictEqual(zoomLevel1, hostZoomMap.host3)
const zoomLevel2 = w2.webContents.getZoomLevel()
assert.strictEqual(zoomLevel2, 0)
assert.notStrictEqual(zoomLevel1, zoomLevel2)
protocol.unregisterProtocol(zoomScheme, (error) => {
if (error) return done(error)
w2.setClosable(true)
w2.close()
done()
})
})
w.webContents.on('did-finish-load', () => {
w.webContents.setZoomLevel(hostZoomMap.host3)
w2.loadURL(`${zoomScheme}://host3`)
})
w.loadURL(`${zoomScheme}://host3`)
})
})
it('can persist when it contains iframe', (done) => {
const server = http.createServer((req, res) => {
setTimeout(() => {
res.end()
}, 200)
})
server.listen(0, '127.0.0.1', () => {
const url = 'http://127.0.0.1:' + server.address().port
const content = `<iframe src=${url}></iframe>`
w.webContents.on('did-frame-finish-load', (e, isMainFrame) => {
if (!isMainFrame) {
const zoomLevel = w.webContents.getZoomLevel()
assert.strictEqual(zoomLevel, 2.0)
w.webContents.setZoomLevel(0)
server.close()
done()
}
})
w.webContents.on('dom-ready', () => {
w.webContents.setZoomLevel(2.0)
})
w.loadURL(`data:text/html,${content}`)
})
})
it('cannot propagate when used with webframe', (done) => {
let finalZoomLevel = 0
const w2 = new BrowserWindow({
show: false
})
w2.webContents.on('did-finish-load', () => {
const zoomLevel1 = w.webContents.getZoomLevel()
assert.strictEqual(zoomLevel1, finalZoomLevel)
const zoomLevel2 = w2.webContents.getZoomLevel()
assert.strictEqual(zoomLevel2, 0)
assert.notStrictEqual(zoomLevel1, zoomLevel2)
w2.setClosable(true)
w2.close()
done()
})
ipcMain.once('temporary-zoom-set', (e, zoomLevel) => {
w2.loadFile(path.join(fixtures, 'pages', 'c.html'))
finalZoomLevel = zoomLevel
})
w.loadFile(path.join(fixtures, 'pages', 'webframe-zoom.html'))
})
it('cannot persist zoom level after navigation with webFrame', (done) => {
let initialNavigation = true
const source = `
const {ipcRenderer, webFrame} = require('electron')
webFrame.setZoomLevel(0.6)
ipcRenderer.send('zoom-level-set', webFrame.getZoomLevel())
`
w.webContents.on('did-finish-load', () => {
if (initialNavigation) {
w.webContents.executeJavaScript(source, () => {})
} else {
const zoomLevel = w.webContents.getZoomLevel()
assert.strictEqual(zoomLevel, 0)
done()
}
})
ipcMain.once('zoom-level-set', (e, zoomLevel) => {
assert.strictEqual(zoomLevel, 0.6)
w.loadFile(path.join(fixtures, 'pages', 'd.html'))
initialNavigation = false
})
w.loadFile(path.join(fixtures, 'pages', 'c.html'))
})
})
describe('webrtc ip policy api', () => {
it('can set and get webrtc ip policies', () => {
const policies = [
'default',
'default_public_interface_only',
'default_public_and_private_interfaces',
'disable_non_proxied_udp'
]
policies.forEach((policy) => {
w.webContents.setWebRTCIPHandlingPolicy(policy)
assert.strictEqual(w.webContents.getWebRTCIPHandlingPolicy(), policy)
})
})
})
describe('will-prevent-unload event', () => {
it('does not emit if beforeunload returns undefined', (done) => {
w.once('closed', () => {
done()
})
w.webContents.on('will-prevent-unload', (e) => {
assert.fail('should not have fired')
})
w.loadFile(path.join(fixtures, 'api', 'close-beforeunload-undefined.html'))
})
it('emits if beforeunload returns false', (done) => {
w.webContents.on('will-prevent-unload', () => {
done()
})
w.loadFile(path.join(fixtures, 'api', 'close-beforeunload-false.html'))
})
it('supports calling preventDefault on will-prevent-unload events', (done) => {
ipcRenderer.send('prevent-next-will-prevent-unload', w.webContents.id)
w.once('closed', () => done())
w.loadFile(path.join(fixtures, 'api', 'close-beforeunload-false.html'))
})
})
describe('render view deleted events', () => {
let server = null
before((done) => {
server = http.createServer((req, res) => {
const respond = () => {
if (req.url === '/redirect-cross-site') {
res.setHeader('Location', `${server.cross_site_url}/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', () => {
server.url = `http://127.0.0.1:${server.address().port}`
server.cross_site_url = `http://localhost:${server.address().port}`
done()
})
})
after(() => {
server.close()
server = null
})
it('does not emit current-render-view-deleted when speculative RVHs are deleted', (done) => {
let currentRenderViewDeletedEmitted = false
w.webContents.once('destroyed', () => {
assert.strictEqual(currentRenderViewDeletedEmitted, false, 'current-render-view-deleted was emitted')
done()
})
const renderViewDeletedHandler = () => {
currentRenderViewDeletedEmitted = true
}
w.webContents.on('current-render-view-deleted', renderViewDeletedHandler)
w.webContents.on('did-finish-load', (e) => {
w.webContents.removeListener('current-render-view-deleted', renderViewDeletedHandler)
w.close()
})
w.loadURL(`${server.url}/redirect-cross-site`)
})
it('emits current-render-view-deleted if the current RVHs are deleted', (done) => {
let currentRenderViewDeletedEmitted = false
w.webContents.once('destroyed', () => {
assert.strictEqual(currentRenderViewDeletedEmitted, true, 'current-render-view-deleted wasn\'t emitted')
done()
})
w.webContents.on('current-render-view-deleted', () => {
currentRenderViewDeletedEmitted = true
})
w.webContents.on('did-finish-load', (e) => {
w.close()
})
w.loadURL(`${server.url}/redirect-cross-site`)
})
it('emits render-view-deleted if any RVHs are deleted', (done) => {
let rvhDeletedCount = 0
w.webContents.once('destroyed', () => {
const expectedRenderViewDeletedEventCount = 3 // 1 speculative upon redirection + 2 upon window close.
assert.strictEqual(rvhDeletedCount, expectedRenderViewDeletedEventCount, 'render-view-deleted wasn\'t emitted the expected nr. of times')
done()
})
w.webContents.on('render-view-deleted', () => {
rvhDeletedCount++
})
w.webContents.on('did-finish-load', (e) => {
w.close()
})
w.loadURL(`${server.url}/redirect-cross-site`)
})
})
describe('setIgnoreMenuShortcuts(ignore)', () => {
it('does not throw', () => {
assert.strictEqual(w.webContents.setIgnoreMenuShortcuts(true), undefined)
assert.strictEqual(w.webContents.setIgnoreMenuShortcuts(false), undefined)
})
})
describe('create()', () => {
it('does not crash on exit', async () => {
const appPath = path.join(__dirname, 'fixtures', 'api', 'leak-exit-webcontents.js')
const electronPath = remote.getGlobal('process').execPath
const appProcess = ChildProcess.spawn(electronPath, [appPath])
const [code] = await emittedOnce(appProcess, 'close')
expect(code).to.equal(0)
})
})
// Destroying webContents in its event listener is going to crash when
// Electron is built in Debug mode.
xdescribe('destroy()', () => {
let server
before((done) => {
server = http.createServer((request, response) => {
switch (request.url) {
case '/404':
response.statusCode = '404'
response.end()
break
case '/301':
response.statusCode = '301'
response.setHeader('Location', '/200')
response.end()
break
case '/200':
response.statusCode = '200'
response.end('hello')
break
default:
done('unsupported endpoint')
}
}).listen(0, '127.0.0.1', () => {
server.url = 'http://127.0.0.1:' + server.address().port
done()
})
})
after(() => {
server.close()
server = null
})
it('should not crash when invoked synchronously inside navigation observer', (done) => {
const events = [
{ name: 'did-start-loading', url: `${server.url}/200` },
{ name: 'dom-ready', url: `${server.url}/200` },
{ name: 'did-stop-loading', url: `${server.url}/200` },
{ name: 'did-finish-load', url: `${server.url}/200` },
// FIXME: Multiple Emit calls inside an observer assume that object
// will be alive till end of the observer. Synchronous `destroy` api
// violates this contract and crashes.
// { name: 'did-frame-finish-load', url: `${server.url}/200` },
{ name: 'did-fail-load', url: `${server.url}/404` }
]
const responseEvent = 'webcontents-destroyed'
function * genNavigationEvent () {
let eventOptions = null
while ((eventOptions = events.shift()) && events.length) {
eventOptions.responseEvent = responseEvent
ipcRenderer.send('test-webcontents-navigation-observer', eventOptions)
yield 1
}
}
const gen = genNavigationEvent()
ipcRenderer.on(responseEvent, () => {
if (!gen.next().value) done()
})
gen.next()
})
})
describe('did-change-theme-color event', () => {
it('is triggered with correct theme color', (done) => {
let count = 0
w.webContents.on('did-change-theme-color', (e, color) => {
if (count === 0) {
count += 1
assert.strictEqual(color, '#FFEEDD')
w.loadFile(path.join(fixtures, 'pages', 'base-page.html'))
} else if (count === 1) {
assert.strictEqual(color, null)
done()
}
})
w.loadFile(path.join(fixtures, 'pages', 'theme-color.html'))
})
})
describe('console-message event', () => {
it('is triggered with correct log message', (done) => {
w.webContents.on('console-message', (e, level, message) => {
// Don't just assert as Chromium might emit other logs that we should ignore.
if (message === 'a') {
done()
}
})
w.loadFile(path.join(fixtures, 'pages', 'a.html'))
})
})
describe('ipc-message event', () => {
it('emits when the renderer process sends an asynchronous message', async () => {
const webContents = remote.getCurrentWebContents()
const promise = emittedOnce(webContents, 'ipc-message')
ipcRenderer.send('message', 'Hello World!')
const [, channel, message] = await promise
expect(channel).to.equal('message')
expect(message).to.equal('Hello World!')
})
})
describe('ipc-message-sync event', () => {
it('emits when the renderer process sends a synchronous message', async () => {
const webContents = remote.getCurrentWebContents()
const promise = emittedOnce(webContents, 'ipc-message-sync')
ipcRenderer.send('handle-next-ipc-message-sync', 'foobar')
const result = ipcRenderer.sendSync('message', 'Hello World!')
const [, channel, message] = await promise
expect(channel).to.equal('message')
expect(message).to.equal('Hello World!')
expect(result).to.equal('foobar')
})
})
describe('referrer', () => {
it('propagates referrer information to new target=_blank windows', (done) => {
const server = http.createServer((req, res) => {
if (req.url === '/should_have_referrer') {
assert.strictEqual(req.headers.referer, 'http://127.0.0.1:' + server.address().port + '/')
return done()
}
res.end('<a id="a" href="/should_have_referrer" target="_blank">link</a>')
})
server.listen(0, '127.0.0.1', () => {
const url = 'http://127.0.0.1:' + server.address().port + '/'
w.webContents.once('did-finish-load', () => {
w.webContents.once('new-window', (event, newUrl, frameName, disposition, options, features, referrer) => {
assert.strictEqual(referrer.url, url)
assert.strictEqual(referrer.policy, 'no-referrer-when-downgrade')
})
w.webContents.executeJavaScript('a.click()')
})
w.loadURL(url)
})
})
// TODO(jeremy): window.open() in a real browser passes the referrer, but
// our hacked-up window.open() shim doesn't. It should.
xit('propagates referrer information to windows opened with window.open', (done) => {
const server = http.createServer((req, res) => {
if (req.url === '/should_have_referrer') {
assert.strictEqual(req.headers.referer, 'http://127.0.0.1:' + server.address().port + '/')
return done()
}
res.end('')
})
server.listen(0, '127.0.0.1', () => {
const url = 'http://127.0.0.1:' + server.address().port + '/'
w.webContents.once('did-finish-load', () => {
w.webContents.once('new-window', (event, newUrl, frameName, disposition, options, features, referrer) => {
assert.strictEqual(referrer.url, url)
assert.strictEqual(referrer.policy, 'no-referrer-when-downgrade')
})
w.webContents.executeJavaScript('window.open(location.href + "should_have_referrer")')
})
w.loadURL(url)
})
})
})
describe('webframe messages in sandboxed contents', () => {
it('responds to executeJavaScript', async () => {
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox: true
}
})
await w.loadURL('about:blank')
const result = await w.webContents.executeJavaScript('37 + 5')
assert.strictEqual(result, 42)
})
// TODO(miniak): remove when promisification is complete
it('responds to executeJavaScript (callback)', (done) => {
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox: true
}
})
w.webContents.once('did-finish-load', () => {
w.webContents.executeJavaScript('37 + 5', (result) => {
assert.strictEqual(result, 42)
done()
})
})
w.loadURL('about:blank')
})
})
describe('preload-error event', () => {
const generateSpecs = (description, sandbox) => {
describe(description, () => {
const tmpPreload = path.join(os.tmpdir(), 'preload.js')
before((done) => {
fs.writeFile(tmpPreload, '', done)
})
after((done) => {
fs.unlink(tmpPreload, () => done())
})
it('is triggered when unhandled exception is thrown', async () => {
const preload = path.join(fixtures, 'module', 'preload-error-exception.js')
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox,
preload
}
})
const promise = emittedOnce(w.webContents, 'preload-error')
w.loadURL('about:blank')
const [, preloadPath, error] = await promise
expect(preloadPath).to.equal(preload)
expect(error.message).to.equal('Hello World!')
})
it('is triggered on syntax errors', async () => {
const preload = path.join(fixtures, 'module', 'preload-error-syntax.js')
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox,
preload
}
})
const promise = emittedOnce(w.webContents, 'preload-error')
w.loadURL('about:blank')
const [, preloadPath, error] = await promise
expect(preloadPath).to.equal(preload)
expect(error.message).to.equal('foobar is not defined')
})
it('is triggered when preload script loading fails', async () => {
const preload = path.join(fixtures, 'module', 'preload-invalid.js')
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox,
preload
}
})
const promise = emittedOnce(w.webContents, 'preload-error')
w.loadURL('about:blank')
const [, preloadPath, error] = await promise
expect(preloadPath).to.equal(preload)
expect(error.message).to.contain('preload-invalid.js')
})
it('is triggered when preload script is outside of app path', async () => {
const preload = tmpPreload
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox,
preload
}
})
const promise = emittedOnce(w.webContents, 'preload-error')
w.loadURL('about:blank')
const [, preloadPath, error] = await promise
expect(preloadPath).to.equal(preload)
expect(error.message).to.contain('Preload scripts outside of app path are not allowed')
})
})
}
generateSpecs('without sandbox', false)
generateSpecs('with sandbox', true)
})
describe('takeHeapSnapshot()', () => {
it('works with sandboxed renderers', async () => {
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox: true
}
})
await w.loadURL('about:blank')
const filePath = path.join(remote.app.getPath('temp'), 'test.heapsnapshot')
const cleanup = () => {
try {
fs.unlinkSync(filePath)
} catch (e) {
// ignore error
}
}
try {
await w.webContents.takeHeapSnapshot(filePath)
const stats = fs.statSync(filePath)
expect(stats.size).not.to.be.equal(0)
} finally {
cleanup()
}
})
it('fails with invalid file path', async () => {
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox: true
}
})
await w.loadURL('about:blank')
const promise = w.webContents.takeHeapSnapshot('')
return expect(promise).to.be.eventually.rejectedWith(Error, 'takeHeapSnapshot failed')
})
})
describe('setBackgroundThrottling()', () => {
it('does not crash when allowing', (done) => {
w.webContents.setBackgroundThrottling(true)
done()
})
it('does not crash when disallowing', (done) => {
w.destroy()
w = new BrowserWindow({
show: false,
width: 400,
height: 400,
webPreferences: {
backgroundThrottling: true
}
})
w.webContents.setBackgroundThrottling(false)
done()
})
it('does not crash when called via BrowserWindow', (done) => {
w.setBackgroundThrottling(true)
done()
})
})
describe('getPrinterList()', () => {
before(function () {
if (!features.isPrintingEnabled()) {
return closeWindow(w).then(() => {
w = null
this.skip()
})
}
})
it('can get printer list', async () => {
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox: true
}
})
await w.loadURL('data:text/html,%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E')
const printers = w.webContents.getPrinters()
assert.strictEqual(Array.isArray(printers), true)
})
})
describe('printToPDF()', () => {
before(function () {
if (!features.isPrintingEnabled()) {
return closeWindow(w).then(() => {
w = null
this.skip()
})
}
})
it('can print to PDF', async () => {
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox: true
}
})
await w.loadURL('data:text/html,%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E')
const data = await w.webContents.printToPDF({})
assert.strictEqual(data instanceof Buffer, true)
assert.notStrictEqual(data.length, 0)
})
// TODO(miniak): remove when promisification is complete
it('can print to PDF (callback)', (done) => {
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
sandbox: true
}
})
w.webContents.once('did-finish-load', () => {
w.webContents.printToPDF({}, function (error, data) {
assert.strictEqual(error, null)
assert.strictEqual(data instanceof Buffer, true)
assert.notStrictEqual(data.length, 0)
done()
})
})
w.loadURL('data:text/html,%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E')
})
})
})