test: remove usage of 'remote' module from webview spec (#20048)
This commit is contained in:
Jeremy Apthorp
GitHub
parent
cad73732c0
commit
96c3fec855
11 changed files with 567 additions and 508 deletions
548
spec-main/webview-spec.ts
Normal file
548
spec-main/webview-spec.ts
Normal file
|
|
@ -0,0 +1,548 @@
|
|||
import * as path from 'path'
|
||||
import { BrowserWindow, session, ipcMain, app, WebContents } from 'electron'
|
||||
import { closeAllWindows } from './window-helpers'
|
||||
import { emittedOnce } from './events-helpers'
|
||||
import { expect } from 'chai'
|
||||
|
||||
async function loadWebView(w: WebContents, attributes: Record<string, string>): Promise<void> {
|
||||
await w.executeJavaScript(`
|
||||
new Promise((resolve, reject) => {
|
||||
const webview = new WebView()
|
||||
for (const [k, v] of Object.entries(${JSON.stringify(attributes)})) {
|
||||
webview.setAttribute(k, v)
|
||||
}
|
||||
document.body.appendChild(webview)
|
||||
webview.addEventListener('did-finish-load', () => {
|
||||
resolve()
|
||||
})
|
||||
})
|
||||
`)
|
||||
}
|
||||
|
||||
describe('<webview> tag', function () {
|
||||
const fixtures = path.join(__dirname, '..', 'spec', 'fixtures')
|
||||
|
||||
afterEach(closeAllWindows)
|
||||
|
||||
it('works without script tag in page', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
webviewTag: true,
|
||||
nodeIntegration: true
|
||||
}
|
||||
})
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-no-script.html'))
|
||||
await emittedOnce(ipcMain, 'pong')
|
||||
})
|
||||
|
||||
it('works with sandbox', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
webviewTag: true,
|
||||
nodeIntegration: true,
|
||||
sandbox: true
|
||||
}
|
||||
})
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-isolated.html'))
|
||||
await emittedOnce(ipcMain, 'pong')
|
||||
})
|
||||
|
||||
it('works with contextIsolation', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
webviewTag: true,
|
||||
nodeIntegration: true,
|
||||
contextIsolation: true
|
||||
}
|
||||
})
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-isolated.html'))
|
||||
await emittedOnce(ipcMain, 'pong')
|
||||
})
|
||||
|
||||
it('works with contextIsolation + sandbox', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
webviewTag: true,
|
||||
nodeIntegration: true,
|
||||
contextIsolation: true,
|
||||
sandbox: true
|
||||
}
|
||||
})
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-isolated.html'))
|
||||
await emittedOnce(ipcMain, 'pong')
|
||||
})
|
||||
|
||||
it('is disabled by default', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
preload: path.join(fixtures, 'module', 'preload-webview.js'),
|
||||
nodeIntegration: true
|
||||
}
|
||||
})
|
||||
|
||||
const webview = emittedOnce(ipcMain, 'webview')
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-no-script.html'))
|
||||
const [, type] = await webview
|
||||
|
||||
expect(type).to.equal('undefined', 'WebView still exists')
|
||||
})
|
||||
|
||||
// FIXME(deepak1556): Ch69 follow up.
|
||||
xdescribe('document.visibilityState/hidden', () => {
|
||||
afterEach(() => {
|
||||
ipcMain.removeAllListeners('pong')
|
||||
})
|
||||
|
||||
it('updates when the window is shown after the ready-to-show event', async () => {
|
||||
const w = new BrowserWindow({ show: false })
|
||||
const readyToShowSignal = emittedOnce(w, 'ready-to-show')
|
||||
const pongSignal1 = emittedOnce(ipcMain, 'pong')
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-visibilitychange.html'))
|
||||
await pongSignal1
|
||||
const pongSignal2 = emittedOnce(ipcMain, 'pong')
|
||||
await readyToShowSignal
|
||||
w.show()
|
||||
|
||||
const [, visibilityState, hidden] = await pongSignal2
|
||||
expect(visibilityState).to.equal('visible')
|
||||
expect(hidden).to.be.false()
|
||||
})
|
||||
|
||||
it('inherits the parent window visibility state and receives visibilitychange events', async () => {
|
||||
const w = new BrowserWindow({ show: false })
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-visibilitychange.html'))
|
||||
const [, visibilityState, hidden] = await emittedOnce(ipcMain, 'pong')
|
||||
expect(visibilityState).to.equal('hidden')
|
||||
expect(hidden).to.be.true()
|
||||
|
||||
// We have to start waiting for the event
|
||||
// before we ask the webContents to resize.
|
||||
const getResponse = emittedOnce(ipcMain, 'pong')
|
||||
w.webContents.emit('-window-visibility-change', 'visible')
|
||||
|
||||
return getResponse.then(([, visibilityState, hidden]) => {
|
||||
expect(visibilityState).to.equal('visible')
|
||||
expect(hidden).to.be.false()
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('did-attach-webview event', () => {
|
||||
it('is emitted when a webview has been attached', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
webviewTag: true,
|
||||
nodeIntegration: true
|
||||
}
|
||||
})
|
||||
const didAttachWebview = emittedOnce(w.webContents, 'did-attach-webview')
|
||||
const webviewDomReady = emittedOnce(ipcMain, 'webview-dom-ready')
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-did-attach-event.html'))
|
||||
|
||||
const [, webContents] = await didAttachWebview
|
||||
const [, id] = await webviewDomReady
|
||||
expect(webContents.id).to.equal(id)
|
||||
})
|
||||
})
|
||||
|
||||
it('loads devtools extensions registered on the parent window', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
webviewTag: true,
|
||||
nodeIntegration: true
|
||||
}
|
||||
})
|
||||
BrowserWindow.removeDevToolsExtension('foo')
|
||||
|
||||
const extensionPath = path.join(fixtures, 'devtools-extensions', 'foo')
|
||||
BrowserWindow.addDevToolsExtension(extensionPath)
|
||||
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-devtools.html'))
|
||||
|
||||
const [, { runtimeId, tabId }] = await emittedOnce(ipcMain, 'answer')
|
||||
expect(runtimeId).to.equal('foo')
|
||||
expect(tabId).to.be.not.equal(w.webContents.id)
|
||||
})
|
||||
|
||||
describe('zoom behavior', () => {
|
||||
const zoomScheme = standardScheme
|
||||
const webviewSession = session.fromPartition('webview-temp')
|
||||
|
||||
before((done) => {
|
||||
const protocol = webviewSession.protocol
|
||||
protocol.registerStringProtocol(zoomScheme, (request, callback) => {
|
||||
callback('hello')
|
||||
}, (error) => done(error))
|
||||
})
|
||||
|
||||
after((done) => {
|
||||
const protocol = webviewSession.protocol
|
||||
protocol.unregisterProtocol(zoomScheme, (error) => done(error))
|
||||
})
|
||||
|
||||
it('inherits the zoomFactor of the parent window', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
webviewTag: true,
|
||||
nodeIntegration: true,
|
||||
zoomFactor: 1.2
|
||||
}
|
||||
})
|
||||
const zoomEventPromise = emittedOnce(ipcMain, 'webview-parent-zoom-level')
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-zoom-factor.html'))
|
||||
|
||||
const [, zoomFactor, zoomLevel] = await zoomEventPromise
|
||||
expect(zoomFactor).to.equal(1.2)
|
||||
expect(zoomLevel).to.equal(1)
|
||||
})
|
||||
|
||||
it('maintains zoom level on navigation', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
webviewTag: true,
|
||||
nodeIntegration: true,
|
||||
zoomFactor: 1.2
|
||||
}
|
||||
})
|
||||
const promise = new Promise((resolve) => {
|
||||
ipcMain.on('webview-zoom-level', (event, zoomLevel, zoomFactor, newHost, final) => {
|
||||
if (!newHost) {
|
||||
expect(zoomFactor).to.equal(1.44)
|
||||
expect(zoomLevel).to.equal(2.0)
|
||||
} else {
|
||||
expect(zoomFactor).to.equal(1.2)
|
||||
expect(zoomLevel).to.equal(1)
|
||||
}
|
||||
|
||||
if (final) {
|
||||
resolve()
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-custom-zoom-level.html'))
|
||||
|
||||
await promise
|
||||
})
|
||||
|
||||
it('maintains zoom level when navigating within same page', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
webviewTag: true,
|
||||
nodeIntegration: true,
|
||||
zoomFactor: 1.2
|
||||
}
|
||||
})
|
||||
const promise = new Promise((resolve) => {
|
||||
ipcMain.on('webview-zoom-in-page', (event, zoomLevel, zoomFactor, final) => {
|
||||
expect(zoomFactor).to.equal(1.44)
|
||||
expect(zoomLevel).to.equal(2.0)
|
||||
|
||||
if (final) {
|
||||
resolve()
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-in-page-navigate.html'))
|
||||
|
||||
await promise
|
||||
})
|
||||
|
||||
it('inherits zoom level for the origin when available', async () => {
|
||||
const w = new BrowserWindow({
|
||||
show: false,
|
||||
webPreferences: {
|
||||
webviewTag: true,
|
||||
nodeIntegration: true,
|
||||
zoomFactor: 1.2
|
||||
}
|
||||
})
|
||||
w.loadFile(path.join(fixtures, 'pages', 'webview-origin-zoom-level.html'))
|
||||
|
||||
const [, zoomLevel] = await emittedOnce(ipcMain, 'webview-origin-zoom-level')
|
||||
expect(zoomLevel).to.equal(2.0)
|
||||
})
|
||||
})
|
||||
|
||||
describe('nativeWindowOpen option', () => {
|
||||
let w: BrowserWindow
|
||||
beforeEach(async () => {
|
||||
w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, webviewTag: true } })
|
||||
await w.loadURL('about:blank')
|
||||
})
|
||||
afterEach(closeAllWindows)
|
||||
|
||||
it('opens window of about:blank with cross-scripting enabled', async () => {
|
||||
// Don't wait for loading to finish.
|
||||
loadWebView(w.webContents, {
|
||||
allowpopups: 'on',
|
||||
nodeintegration: 'on',
|
||||
webpreferences: 'nativeWindowOpen=1',
|
||||
src: `file://${path.join(fixtures, 'api', 'native-window-open-blank.html')}`
|
||||
})
|
||||
|
||||
const [, content] = await emittedOnce(ipcMain, 'answer')
|
||||
expect(content).to.equal('Hello')
|
||||
})
|
||||
|
||||
it('opens window of same domain with cross-scripting enabled', async () => {
|
||||
// Don't wait for loading to finish.
|
||||
loadWebView(w.webContents, {
|
||||
allowpopups: 'on',
|
||||
nodeintegration: 'on',
|
||||
webpreferences: 'nativeWindowOpen=1',
|
||||
src: `file://${path.join(fixtures, 'api', 'native-window-open-file.html')}`
|
||||
})
|
||||
|
||||
const [, content] = await emittedOnce(ipcMain, 'answer')
|
||||
expect(content).to.equal('Hello')
|
||||
})
|
||||
|
||||
it('returns null from window.open when allowpopups is not set', async () => {
|
||||
// Don't wait for loading to finish.
|
||||
loadWebView(w.webContents, {
|
||||
nodeintegration: 'on',
|
||||
webpreferences: 'nativeWindowOpen=1',
|
||||
src: `file://${path.join(fixtures, 'api', 'native-window-open-no-allowpopups.html')}`
|
||||
})
|
||||
|
||||
const [, { windowOpenReturnedNull }] = await emittedOnce(ipcMain, 'answer')
|
||||
expect(windowOpenReturnedNull).to.be.true()
|
||||
})
|
||||
|
||||
it('blocks accessing cross-origin frames', async () => {
|
||||
// Don't wait for loading to finish.
|
||||
loadWebView(w.webContents, {
|
||||
allowpopups: 'on',
|
||||
nodeintegration: 'on',
|
||||
webpreferences: 'nativeWindowOpen=1',
|
||||
src: `file://${path.join(fixtures, 'api', 'native-window-open-cross-origin.html')}`
|
||||
})
|
||||
|
||||
const [, content] = await emittedOnce(ipcMain, 'answer')
|
||||
const expectedContent =
|
||||
'Blocked a frame with origin "file://" from accessing a cross-origin frame.'
|
||||
|
||||
expect(content).to.equal(expectedContent)
|
||||
})
|
||||
|
||||
it('emits a new-window event', async () => {
|
||||
// Don't wait for loading to finish.
|
||||
const attributes = {
|
||||
allowpopups: 'on',
|
||||
nodeintegration: 'on',
|
||||
webpreferences: 'nativeWindowOpen=1',
|
||||
src: `file://${fixtures}/pages/window-open.html`
|
||||
}
|
||||
const { url, frameName } = await w.webContents.executeJavaScript(`
|
||||
new Promise((resolve, reject) => {
|
||||
const webview = document.createElement('webview')
|
||||
for (const [k, v] of Object.entries(${JSON.stringify(attributes)})) {
|
||||
webview.setAttribute(k, v)
|
||||
}
|
||||
document.body.appendChild(webview)
|
||||
webview.addEventListener('new-window', (e) => {
|
||||
resolve({url: e.url, frameName: e.frameName})
|
||||
})
|
||||
})
|
||||
`)
|
||||
|
||||
expect(url).to.equal('http://host/')
|
||||
expect(frameName).to.equal('host')
|
||||
})
|
||||
|
||||
it('emits a browser-window-created event', async () => {
|
||||
// Don't wait for loading to finish.
|
||||
loadWebView(w.webContents, {
|
||||
allowpopups: 'on',
|
||||
webpreferences: 'nativeWindowOpen=1',
|
||||
src: `file://${fixtures}/pages/window-open.html`
|
||||
})
|
||||
|
||||
await emittedOnce(app, 'browser-window-created')
|
||||
})
|
||||
|
||||
it('emits a web-contents-created event', (done) => {
|
||||
app.on('web-contents-created', function listener (event, contents) {
|
||||
if (contents.getType() === 'window') {
|
||||
app.removeListener('web-contents-created', listener)
|
||||
done()
|
||||
}
|
||||
})
|
||||
loadWebView(w.webContents, {
|
||||
allowpopups: 'on',
|
||||
webpreferences: 'nativeWindowOpen=1',
|
||||
src: `file://${fixtures}/pages/window-open.html`
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('webpreferences attribute', () => {
|
||||
let w: BrowserWindow
|
||||
beforeEach(async () => {
|
||||
w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, webviewTag: true } })
|
||||
await w.loadURL('about:blank')
|
||||
})
|
||||
afterEach(closeAllWindows)
|
||||
|
||||
it('can enable context isolation', async () => {
|
||||
loadWebView(w.webContents, {
|
||||
allowpopups: 'yes',
|
||||
preload: `file://${fixtures}/api/isolated-preload.js`,
|
||||
src: `file://${fixtures}/api/isolated.html`,
|
||||
webpreferences: 'contextIsolation=yes'
|
||||
})
|
||||
|
||||
const [, data] = await emittedOnce(ipcMain, 'isolated-world')
|
||||
expect(data).to.deep.equal({
|
||||
preloadContext: {
|
||||
preloadProperty: 'number',
|
||||
pageProperty: 'undefined',
|
||||
typeofRequire: 'function',
|
||||
typeofProcess: 'object',
|
||||
typeofArrayPush: 'function',
|
||||
typeofFunctionApply: 'function',
|
||||
typeofPreloadExecuteJavaScriptProperty: 'undefined'
|
||||
},
|
||||
pageContext: {
|
||||
preloadProperty: 'undefined',
|
||||
pageProperty: 'string',
|
||||
typeofRequire: 'undefined',
|
||||
typeofProcess: 'undefined',
|
||||
typeofArrayPush: 'number',
|
||||
typeofFunctionApply: 'boolean',
|
||||
typeofPreloadExecuteJavaScriptProperty: 'number',
|
||||
typeofOpenedWindow: 'object'
|
||||
}
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('permission request handlers', () => {
|
||||
let w: BrowserWindow
|
||||
beforeEach(async () => {
|
||||
w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, webviewTag: true } })
|
||||
await w.loadURL('about:blank')
|
||||
})
|
||||
afterEach(closeAllWindows)
|
||||
|
||||
const partition = 'permissionTest'
|
||||
|
||||
function setUpRequestHandler(webContentsId: number, requestedPermission: string) {
|
||||
return new Promise((resolve, reject) => {
|
||||
session.fromPartition(partition).setPermissionRequestHandler(function (webContents, permission, callback) {
|
||||
if (webContents.id === webContentsId) {
|
||||
// requestMIDIAccess with sysex requests both midi and midiSysex so
|
||||
// grant the first midi one and then reject the midiSysex one
|
||||
if (requestedPermission === 'midiSysex' && permission === 'midi') {
|
||||
return callback(true)
|
||||
}
|
||||
|
||||
try {
|
||||
expect(permission).to.equal(requestedPermission)
|
||||
} catch (e) {
|
||||
return reject(e)
|
||||
}
|
||||
callback(false)
|
||||
resolve()
|
||||
}
|
||||
})
|
||||
})
|
||||
}
|
||||
afterEach(() => {
|
||||
session.fromPartition(partition).setPermissionRequestHandler(null)
|
||||
})
|
||||
|
||||
// This is disabled because CI machines don't have cameras or microphones,
|
||||
// so Chrome responds with "NotFoundError" instead of
|
||||
// "PermissionDeniedError". It should be re-enabled if we find a way to mock
|
||||
// the presence of a microphone & camera.
|
||||
xit('emits when using navigator.getUserMedia api', async () => {
|
||||
const errorFromRenderer = emittedOnce(ipcMain, 'message')
|
||||
loadWebView(w.webContents, {
|
||||
src: `file://${fixtures}/pages/permissions/media.html`,
|
||||
partition,
|
||||
nodeintegration: 'on'
|
||||
})
|
||||
const [, webViewContents] = await emittedOnce(app, 'web-contents-created')
|
||||
setUpRequestHandler(webViewContents.id, 'media')
|
||||
const [, errorName] = await errorFromRenderer
|
||||
expect(errorName).to.equal('PermissionDeniedError')
|
||||
})
|
||||
|
||||
it('emits when using navigator.geolocation api', async () => {
|
||||
const errorFromRenderer = emittedOnce(ipcMain, 'message')
|
||||
loadWebView(w.webContents, {
|
||||
src: `file://${fixtures}/pages/permissions/geolocation.html`,
|
||||
partition,
|
||||
nodeintegration: 'on'
|
||||
})
|
||||
const [, webViewContents] = await emittedOnce(app, 'web-contents-created')
|
||||
setUpRequestHandler(webViewContents.id, 'geolocation')
|
||||
const [, error] = await errorFromRenderer
|
||||
expect(error).to.equal('User denied Geolocation')
|
||||
})
|
||||
|
||||
it('emits when using navigator.requestMIDIAccess without sysex api', async () => {
|
||||
const errorFromRenderer = emittedOnce(ipcMain, 'message')
|
||||
loadWebView(w.webContents, {
|
||||
src: `file://${fixtures}/pages/permissions/midi.html`,
|
||||
partition,
|
||||
nodeintegration: 'on'
|
||||
})
|
||||
const [, webViewContents] = await emittedOnce(app, 'web-contents-created')
|
||||
setUpRequestHandler(webViewContents.id, 'midi')
|
||||
const [, error] = await errorFromRenderer
|
||||
expect(error).to.equal('SecurityError')
|
||||
})
|
||||
|
||||
it('emits when using navigator.requestMIDIAccess with sysex api', async () => {
|
||||
const errorFromRenderer = emittedOnce(ipcMain, 'message')
|
||||
loadWebView(w.webContents, {
|
||||
src: `file://${fixtures}/pages/permissions/midi-sysex.html`,
|
||||
partition,
|
||||
nodeintegration: 'on'
|
||||
})
|
||||
const [, webViewContents] = await emittedOnce(app, 'web-contents-created')
|
||||
setUpRequestHandler(webViewContents.id, 'midiSysex')
|
||||
const [, error] = await errorFromRenderer
|
||||
expect(error).to.equal('SecurityError')
|
||||
})
|
||||
|
||||
it('emits when accessing external protocol', async () => {
|
||||
loadWebView(w.webContents, {
|
||||
src: `magnet:test`,
|
||||
partition,
|
||||
})
|
||||
const [, webViewContents] = await emittedOnce(app, 'web-contents-created')
|
||||
await setUpRequestHandler(webViewContents.id, 'openExternal')
|
||||
})
|
||||
|
||||
it('emits when using Notification.requestPermission', async () => {
|
||||
const errorFromRenderer = emittedOnce(ipcMain, 'message')
|
||||
loadWebView(w.webContents, {
|
||||
src: `file://${fixtures}/pages/permissions/notification.html`,
|
||||
partition,
|
||||
nodeintegration: 'on'
|
||||
})
|
||||
const [, webViewContents] = await emittedOnce(app, 'web-contents-created')
|
||||
|
||||
await setUpRequestHandler(webViewContents.id, 'notifications')
|
||||
|
||||
const [, error] = await errorFromRenderer
|
||||
expect(error).to.equal('denied')
|
||||
})
|
||||
})
|
||||
|
||||
})
|
||||
Loading…
Add table
Add a link
Reference in a new issue