mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

test: promisify a bunch of tests (#16051)

Browse source 
* test: promisify a bunch of tests

* fix lint

* fix affinity tests

* more cowbell^Wawait

* less done
This commit is contained in:
Jeremy Apthorp 2018-12-18 22:44:03 -08:00 committed by Shelley Vohr
parent cc85946f55
commit ed3e5739dc
6 changed files with 200 additions and 265 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

108
spec/api-browser-window-affinity-spec.js
View file

@ -13,79 +13,63 @@ describe('BrowserWindow with affinity module', () => {
const myAffinityNameUpper = 'MYAFFINITY'
const anotherAffinityName = 'anotherAffinity'
function createWindowWithWebPrefs (webPrefs) {
return new Promise((resolve, reject) => {
async function createWindowWithWebPrefs (webPrefs) {
const w = new BrowserWindow({
show: false,
width: 400,
height: 400,
webPreferences: webPrefs || {}
})
w.webContents.on('did-finish-load', () => { resolve(w) })
w.loadFile(path.join(fixtures, 'api', 'blank.html'))
})
await w.loadFile(path.join(fixtures, 'api', 'blank.html'))
return w
}
function testAffinityProcessIds (name, webPreferences = {}) {
describe(name, () => {
let mAffinityWindow
before(done => {
createWindowWithWebPrefs({ affinity: myAffinityName, ...webPreferences })
.then((w) => {
mAffinityWindow = w
done()
})
before(async () => {
mAffinityWindow = await createWindowWithWebPrefs({ affinity: myAffinityName, ...webPreferences })
})
after(done => {
closeWindow(mAffinityWindow, { assertSingleWindow: false }).then(() => {
after(async () => {
await closeWindow(mAffinityWindow, { assertSingleWindow: false })
mAffinityWindow = null
done()
})
})
it('should have a different process id than a default window', done => {
createWindowWithWebPrefs({ ...webPreferences })
.then(w => {
it('should have a different process id than a default window', async () => {
const w = await createWindowWithWebPrefs({ ...webPreferences })
const affinityID = mAffinityWindow.webContents.getOSProcessId()
const wcID = w.webContents.getOSProcessId()
expect(affinityID).to.not.equal(wcID, 'Should have different OS process IDs')
closeWindow(w, { assertSingleWindow: false }).then(() => { done() })
})
await closeWindow(w, { assertSingleWindow: false })
})
it(`should have a different process id than a window with a different affinity '${anotherAffinityName}'`, done => {
createWindowWithWebPrefs({ affinity: anotherAffinityName, ...webPreferences })
.then(w => {
it(`should have a different process id than a window with a different affinity '${anotherAffinityName}'`, async () => {
const w = await createWindowWithWebPrefs({ affinity: anotherAffinityName, ...webPreferences })
const affinityID = mAffinityWindow.webContents.getOSProcessId()
const wcID = w.webContents.getOSProcessId()
expect(affinityID).to.not.equal(wcID, 'Should have different OS process IDs')
closeWindow(w, { assertSingleWindow: false }).then(() => { done() })
})
await closeWindow(w, { assertSingleWindow: false })
})
it(`should have the same OS process id than a window with the same affinity '${myAffinityName}'`, done => {
createWindowWithWebPrefs({ affinity: myAffinityName, ...webPreferences })
.then(w => {
it(`should have the same OS process id than a window with the same affinity '${myAffinityName}'`, async () => {
const w = await createWindowWithWebPrefs({ affinity: myAffinityName, ...webPreferences })
const affinityID = mAffinityWindow.webContents.getOSProcessId()
const wcID = w.webContents.getOSProcessId()
expect(affinityID).to.equal(wcID, 'Should have the same OS process ID')
closeWindow(w, { assertSingleWindow: false }).then(() => { done() })
})
await closeWindow(w, { assertSingleWindow: false })
})
it(`should have the same OS process id than a window with an equivalent affinity '${myAffinityNameUpper}' (case insensitive)`, done => {
createWindowWithWebPrefs({ affinity: myAffinityNameUpper, ...webPreferences })
.then(w => {
it(`should have the same OS process id than a window with an equivalent affinity '${myAffinityNameUpper}' (case insensitive)`, async () => {
const w = await createWindowWithWebPrefs({ affinity: myAffinityNameUpper, ...webPreferences })
const affinityID = mAffinityWindow.webContents.getOSProcessId()
const wcID = w.webContents.getOSProcessId()
expect(affinityID).to.equal(wcID, 'Should have the same OS process ID')
closeWindow(w, { assertSingleWindow: false }).then(() => { done() })
})
await closeWindow(w, { assertSingleWindow: false })
})
})
}
@ -114,83 +98,73 @@ describe('BrowserWindow with affinity module', () => {
})
}
it('disables node integration when specified to false', done => {
Promise.all([
it('disables node integration when specified to false', async () => {
const [, w] = await Promise.all([
testNodeIntegration(false),
createWindowWithWebPrefs({
affinity: affinityWithNodeTrue,
preload,
nodeIntegration: false
})
]).then(args => {
closeWindow(args[1], { assertSingleWindow: false }).then(() => { done() })
])
await closeWindow(w, { assertSingleWindow: false })
})
})
it('disables node integration when first window is false', done => {
Promise.all([
it('disables node integration when first window is false', async () => {
const [, w1] = await Promise.all([
testNodeIntegration(false),
createWindowWithWebPrefs({
affinity: affinityWithNodeTrue,
preload,
nodeIntegration: false
})
]).then(args => {
const w1 = args[1]
return Promise.all([
])
const [, w2] = await Promise.all([
testNodeIntegration(false),
w1,
createWindowWithWebPrefs({
affinity: affinityWithNodeTrue,
preload,
nodeIntegration: true
})
])
}).then(ws => {
return Promise.all([
closeWindow(ws[1], { assertSingleWindow: false }),
closeWindow(ws[2], { assertSingleWindow: false })
await Promise.all([
closeWindow(w1, { assertSingleWindow: false }),
closeWindow(w2, { assertSingleWindow: false })
])
}).then(() => { done() })
})
it('enables node integration when specified to true', done => {
Promise.all([
it('enables node integration when specified to true', async () => {
const [, w] = await Promise.all([
testNodeIntegration(true),
createWindowWithWebPrefs({
affinity: affinityWithNodeFalse,
preload,
nodeIntegration: true
})
]).then(args => {
closeWindow(args[1], { assertSingleWindow: false }).then(() => { done() })
})
])
await closeWindow(w, { assertSingleWindow: false })
})
it('enables node integration when first window is true', done => {
Promise.all([
it('enables node integration when first window is true', async () => {
const [, w1] = await Promise.all([
testNodeIntegration(true),
createWindowWithWebPrefs({
affinity: affinityWithNodeFalse,
preload,
nodeIntegration: true
})
]).then(args => {
const w1 = args[1]
return Promise.all([
])
const [, w2] = await Promise.all([
testNodeIntegration(true),
w1,
createWindowWithWebPrefs({
affinity: affinityWithNodeFalse,
preload,
nodeIntegration: false
})
])
}).then(ws => {
return Promise.all([
closeWindow(ws[1], { assertSingleWindow: false }),
closeWindow(ws[2], { assertSingleWindow: false })
await Promise.all([
closeWindow(w1, { assertSingleWindow: false }),
closeWindow(w2, { assertSingleWindow: false })
])
}).then(() => { done() })
})
})
})

111
spec/api-browser-window-spec.js
View file

@ -114,8 +114,8 @@ describe('BrowserWindow module', () => {
afterEach(closeTheWindow)
describe('BrowserWindow constructor', () => {
it('allows passing void 0 as the webContents', () => {
openTheWindow({
it('allows passing void 0 as the webContents', async () => {
await openTheWindow({
webContents: void 0
})
})
@ -159,7 +159,7 @@ describe('BrowserWindow module', () => {
})
it('should emit unload handler', (done) => {
w.webContents.on('did-finish-load', () => { w.close() })
w.webContents.once('did-finish-load', () => { w.close() })
w.once('closed', () => {
const test = path.join(fixtures, 'api', 'unload')
const content = fs.readFileSync(test)
@ -171,7 +171,7 @@ describe('BrowserWindow module', () => {
})
it('should emit beforeunload handler', (done) => {
w.once('onbeforeunload', () => { done() })
w.webContents.on('did-finish-load', () => { w.close() })
w.webContents.once('did-finish-load', () => { w.close() })
w.loadFile(path.join(fixtures, 'api', 'beforeunload-false.html'))
})
it('should not crash when invoked synchronously inside navigation observer', (done) => {
@ -292,15 +292,15 @@ describe('BrowserWindow module', () => {
describe('POST navigations', () => {
afterEach(() => { w.webContents.session.webRequest.onBeforeSendHeaders(null) })
it('supports specifying POST data', (done) => {
w.webContents.on('did-finish-load', () => done())
w.loadURL(server.url, { postData: postData })
it('supports specifying POST data', async () => {
await w.loadURL(server.url, { postData: postData })
})
it('sets the content type header on URL encoded forms', (done) => {
w.webContents.on('did-finish-load', () => {
it('sets the content type header on URL encoded forms', async () => {
await w.loadURL(server.url)
const requestDetails = new Promise(resolve => {
w.webContents.session.webRequest.onBeforeSendHeaders((details, callback) => {
assert.strictEqual(details.requestHeaders['content-type'], 'application/x-www-form-urlencoded')
done()
resolve(details)
})
})
w.webContents.executeJavaScript(`
form = document.createElement('form')
@ -309,14 +309,15 @@ describe('BrowserWindow module', () => {
form.target = '_blank'
form.submit()
`)
const details = await requestDetails
assert.strictEqual(details.requestHeaders['content-type'], 'application/x-www-form-urlencoded')
})
w.loadURL(server.url)
})
it('sets the content type header on multi part forms', (done) => {
w.webContents.on('did-finish-load', () => {
it('sets the content type header on multi part forms', async () => {
await w.loadURL(server.url)
const requestDetails = new Promise(resolve => {
w.webContents.session.webRequest.onBeforeSendHeaders((details, callback) => {
assert(details.requestHeaders['content-type'].startsWith('multipart/form-data; boundary=----WebKitFormBoundary'))
done()
resolve(details)
})
})
w.webContents.executeJavaScript(`
form = document.createElement('form')
@ -330,8 +331,8 @@ describe('BrowserWindow module', () => {
form.appendChild(file)
form.submit()
`)
})
w.loadURL(server.url)
const details = await requestDetails
assert(details.requestHeaders['content-type'].startsWith('multipart/form-data; boundary=----WebKitFormBoundary'))
})
})
@ -1277,27 +1278,20 @@ describe('BrowserWindow module', () => {
afterEach(() => { ipcMain.removeAllListeners('answer') })
describe('"preload" option', () => {
it('loads the script before other scripts in window', (done) => {
it('loads the script before other scripts in window', async () => {
const preload = path.join(fixtures, 'module', 'set-global.js')
ipcMain.once('answer', (event, test) => {
assert.strictEqual(test, 'preload')
done()
})
w.destroy()
w = new BrowserWindow({
show: false,
webPreferences: {
preload: preload
}
webPreferences: { preload }
})
const p = emittedOnce(ipcMain, 'answer')
w.loadFile(path.join(fixtures, 'api', 'preload.html'))
const [, test] = await p
expect(test).to.eql('preload')
})
it('can successfully delete the Buffer global', (done) => {
it('can successfully delete the Buffer global', async () => {
const preload = path.join(fixtures, 'module', 'delete-buffer.js')
ipcMain.once('answer', (event, test) => {
assert.strictEqual(test.toString(), 'buffer')
done()
})
w.destroy()
w = new BrowserWindow({
show: false,
@ -1305,15 +1299,16 @@ describe('BrowserWindow module', () => {
preload: preload
}
})
const p = emittedOnce(ipcMain, 'answer')
w.loadFile(path.join(fixtures, 'api', 'preload.html'))
const [, test] = await p
expect(test.toString()).to.eql('buffer')
})
it('has synchronous access to all eventual window APIs', async () => {
const preload = path.join(fixtures, 'module', 'access-blink-apis.js')
const w = await openTheWindow({
show: false,
webPreferences: {
preload: preload
}
webPreferences: { preload }
})
const p = emittedOnce(ipcMain, 'answer')
w.loadFile(path.join(fixtures, 'api', 'preload.html'))
@ -1972,26 +1967,20 @@ describe('BrowserWindow module', () => {
}
})
return new Promise((resolve, reject) => {
ipcRenderer.send('set-web-preferences-on-next-new-window', w.webContents.id, 'preload', path.join(fixtures, 'api', 'window-open-preload.js'))
ipcMain.once('answer', (event, args, typeofProcess) => {
assert.strictEqual(args.includes('--node-integration=false'), true)
assert.strictEqual(args.includes('--native-window-open'), true)
assert.strictEqual(typeofProcess, 'undefined')
resolve()
})
const p = emittedOnce(ipcMain, 'answer')
w.loadFile(path.join(fixtures, 'api', 'window-open-location-open.html'))
})
const [, args, typeofProcess] = await p
expect(args).to.include('--node-integration=false')
expect(args).to.include('--native-window-open')
expect(typeofProcess).to.eql('undefined')
})
it('should have nodeIntegration disabled in child windows', async () => {
return new Promise((resolve, reject) => {
ipcMain.once('answer', (event, typeofProcess) => {
assert.strictEqual(typeofProcess, 'undefined')
resolve()
})
const p = emittedOnce(ipcMain, 'answer')
w.loadFile(path.join(fixtures, 'api', 'native-window-open-argv.html'))
})
const [, typeofProcess] = await p
expect(typeofProcess).to.eql('undefined')
})
})
})
@ -2397,7 +2386,6 @@ describe('BrowserWindow module', () => {
let called = false
let gotInitialFullSizeFrame = false
const [contentWidth, contentHeight] = w.getContentSize()
w.loadFile(path.join(fixtures, 'api', 'frame-subscriber.html'))
w.webContents.on('did-finish-load', () => {
w.webContents.beginFrameSubscription(true, (data, rect) => {
if (data.length === 0) {
@ -2426,6 +2414,7 @@ describe('BrowserWindow module', () => {
done()
})
})
w.loadFile(path.join(fixtures, 'api', 'frame-subscriber.html'))
})
it('throws error when subscriber is not well defined', (done) => {
w.loadFile(path.join(fixtures, 'api', 'frame-subscriber.html'))
@ -2455,17 +2444,17 @@ describe('BrowserWindow module', () => {
}
})
it('should save page to disk', (done) => {
w.webContents.on('did-finish-load', () => {
it('should save page to disk', async () => {
await w.loadFile(path.join(fixtures, 'pages', 'save_page', 'index.html'))
const error = await new Promise(resolve => {
w.webContents.savePage(savePageHtmlPath, 'HTMLComplete', function (error) {
assert.strictEqual(error, null)
resolve(error)
})
})
expect(error).to.be.null()
assert(fs.existsSync(savePageHtmlPath))
assert(fs.existsSync(savePageJsPath))
assert(fs.existsSync(savePageCssPath))
done()
})
})
w.loadFile(path.join(fixtures, 'pages', 'save_page', 'index.html'))
})
})
@ -3436,9 +3425,7 @@ describe('BrowserWindow module', () => {
assert.deepStrictEqual(data, expectedContextData)
})
it('recreates the contexts on reload', async () => {
const loaded = emittedOnce(iw.webContents, 'did-finish-load')
iw.loadFile(path.join(fixtures, 'api', 'isolated.html'))
await loaded
await iw.loadFile(path.join(fixtures, 'api', 'isolated.html'))
const isolatedWorld = emittedOnce(ipcMain, 'isolated-world')
iw.webContents.reload()
const [, data] = await isolatedWorld
@ -3457,9 +3444,7 @@ describe('BrowserWindow module', () => {
assert.deepStrictEqual(data, expectedContextData)
})
it('recreates the contexts on reload with sandbox on', async () => {
const loaded = emittedOnce(ws.webContents, 'did-finish-load')
ws.loadFile(path.join(fixtures, 'api', 'isolated.html'))
await loaded
await ws.loadFile(path.join(fixtures, 'api', 'isolated.html'))
const isolatedWorld = emittedOnce(ipcMain, 'isolated-world')
ws.webContents.reload()
const [, data] = await isolatedWorld

8
spec/api-session-spec.js
View file

@ -73,8 +73,7 @@ describe('session module', () => {
})
server.listen(0, '127.0.0.1', () => {
const port = server.address().port
w.loadURL(`${url}:${port}`)
w.webContents.on('did-finish-load', () => {
w.webContents.once('did-finish-load', () => {
w.webContents.session.cookies.get({ url }, (error, list) => {
if (error) return done(error)
for (let i = 0; i < list.length; i++) {
@ -90,6 +89,7 @@ describe('session module', () => {
done('Can\'t find cookie')
})
})
w.loadURL(`${url}:${port}`)
})
})
@ -251,7 +251,6 @@ describe('session module', () => {
assert.strictEqual(count, 0)
done()
})
w.loadFile(path.join(fixtures, 'api', 'localstorage.html'))
w.webContents.on('did-finish-load', () => {
const options = {
origin: 'file://',
@ -262,6 +261,7 @@ describe('session module', () => {
w.webContents.send('getcount')
})
})
w.loadFile(path.join(fixtures, 'api', 'localstorage.html'))
})
})
@ -388,10 +388,10 @@ describe('session module', () => {
const port = downloadServer.address().port
ipcRenderer.sendSync('set-download-option', false, false)
webview = new WebView()
webview.src = `file://${fixtures}/api/blank.html`
webview.addEventListener('did-finish-load', () => {
webview.downloadURL(`${url}:${port}/`)
})
webview.src = `file://${fixtures}/api/blank.html`
ipcRenderer.once('download-done', (event, state, url,
mimeType, receivedBytes,
totalBytes, disposition,

89
spec/api-web-contents-spec.js
View file

@ -279,25 +279,35 @@ describe('webContents module', () => {
})
describe('before-input-event event', () => {
it('can prevent document keyboard events', (done) => {
ipcMain.once('keydown', (event, key) => {
assert.strictEqual(key, 'b')
done()
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))
})
w.webContents.once('did-finish-load', () => {
ipcRenderer.sendSync('prevent-next-input-event', 'a', w.webContents.id)
w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'a' })
w.webContents.sendInputEvent({ type: 'keyDown', keyCode: 'b' })
})
w.loadFile(path.join(fixtures, 'pages', 'key-events.html'))
assert.strictEqual(await keyDown, 'b')
})
it('has the correct properties', async () => {
await w.loadFile(path.join(fixtures, 'pages', 'base-page.html'))
const testBeforeInput = (opts) => {
return new Promise((resolve, reject) => {
w.webContents.once('before-input-event', (event, input) => {
try {
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)
@ -306,27 +316,7 @@ describe('webContents module', () => {
assert.strictEqual(input.control, opts.control)
assert.strictEqual(input.alt, opts.alt)
assert.strictEqual(input.meta, opts.meta)
resolve()
} catch (e) {
reject(e)
}
})
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')
w.webContents.sendInputEvent({
type: opts.type,
keyCode: opts.keyCode,
modifiers: modifiers
})
})
}
await testBeforeInput({
type: 'keyDown',
key: 'A',
@ -553,16 +543,12 @@ describe('webContents module', () => {
})
describe('getOSProcessId()', () => {
it('returns a valid procress id', (done) => {
it('returns a valid procress id', async () => {
assert.strictEqual(w.webContents.getOSProcessId(), 0)
w.webContents.once('did-finish-load', () => {
await w.loadURL('about:blank')
const pid = w.webContents.getOSProcessId()
assert.strictEqual(typeof pid, 'number')
assert(pid > 0, `pid ${pid} is not greater than 0`)
done()
})
w.loadURL('about:blank')
expect(pid).to.be.above(0)
})
})
@ -595,19 +581,17 @@ describe('webContents module', () => {
protocol.unregisterProtocol(zoomScheme, (error) => done(error))
})
it('can set the correct zoom level', (done) => {
w.webContents.on('did-finish-load', () => {
w.webContents.getZoomLevel((zoomLevel) => {
assert.strictEqual(zoomLevel, 0.0)
it('can set the correct zoom level', 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)
w.webContents.getZoomLevel((zoomLevel) => {
assert.strictEqual(zoomLevel, 0.5)
const newZoomLevel = await new Promise(resolve => w.webContents.getZoomLevel(resolve))
expect(newZoomLevel).to.eql(0.5)
} finally {
w.webContents.setZoomLevel(0)
done()
})
})
})
w.loadURL('about:blank')
}
})
it('can persist zoom level across navigation', (done) => {
@ -1148,7 +1132,7 @@ describe('webContents module', () => {
}
})
it('can get printer list', (done) => {
it('can get printer list', async () => {
w.destroy()
w = new BrowserWindow({
show: false,
@ -1156,12 +1140,9 @@ describe('webContents module', () => {
sandbox: true
}
})
w.webContents.once('did-finish-load', () => {
await w.loadURL('data:text/html,%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E')
const printers = w.webContents.getPrinters()
assert.strictEqual(Array.isArray(printers), true)
done()
})
w.loadURL('data:text/html,%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E')
})
})

6
spec/api-web-frame-spec.js
View file

@ -5,7 +5,6 @@ const path = require('path')
const { closeWindow } = require('./window-helpers')
const { remote, webFrame } = require('electron')
const { BrowserWindow, protocol, ipcMain } = remote
const { emittedOnce } = require('./events-helpers')
const { expect } = chai
chai.use(dirtyChai)
@ -148,13 +147,12 @@ describe('webFrame module', function () {
it('calls a spellcheck provider', async () => {
w = new BrowserWindow({ show: false })
w.loadFile(path.join(fixtures, 'pages', 'webframe-spell-check.html'))
await emittedOnce(w.webContents, 'did-finish-load')
await w.loadFile(path.join(fixtures, 'pages', 'webframe-spell-check.html'))
w.focus()
await w.webContents.executeJavaScript('document.querySelector("input").focus()', true)
const spellCheckerFeedback =
new Promise((resolve, reject) => {
new Promise(resolve => {
ipcMain.on('spec-spell-check', (e, words, callback) => {
if (words.length === 2) {
// The promise is resolved only after this event is received twice

5
spec/chromium-spec.js
View file

@ -10,7 +10,6 @@ const ChildProcess = require('child_process')
const { ipcRenderer, remote } = require('electron')
const { closeWindow } = require('./window-helpers')
const { resolveGetters } = require('./assert-helpers')
const { emittedOnce } = require('./events-helpers')
const { app, BrowserWindow, ipcMain, protocol, session, webContents } = remote
const isCI = remote.getGlobal('isCi')
const features = process.atomBinding('features')
@ -1417,9 +1416,7 @@ describe('font fallback', () => {
async function getRenderedFonts (html) {
const w = new BrowserWindow({ show: false })
try {
const loaded = emittedOnce(w.webContents, 'did-finish-load')
w.loadURL(`data:text/html,${html}`)
await loaded
await w.loadURL(`data:text/html,${html}`)
w.webContents.debugger.attach()
const sendCommand = (...args) => new Promise((resolve, reject) => {
w.webContents.debugger.sendCommand(...args, (e, r) => {