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

test: convert more tests to async / await (#24373)

Browse source
This commit is contained in:
Milan Burda 2020-07-01 21:14:38 +02:00 committed by GitHub
parent 3cb833821a
commit 4c449fbc75
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 116 additions and 137 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
spec-main/api-app-spec.ts
View file

@ -5,6 +5,7 @@ import * as http from 'http';
import * as net from 'net'; import * as net from 'net';
import * as fs from 'fs'; import * as fs from 'fs';
import * as path from 'path'; import * as path from 'path';
import { promisify } from 'util';
import { app, BrowserWindow, Menu, session } from 'electron/main'; import { app, BrowserWindow, Menu, session } from 'electron/main';
import { emittedOnce } from './events-helpers'; import { emittedOnce } from './events-helpers';
import { closeWindow, closeAllWindows } from './window-helpers'; import { closeWindow, closeAllWindows } from './window-helpers';
@ -891,34 +892,24 @@ describe('app module', () => {
expect(app.isDefaultProtocolClient(protocol)).to.equal(false); expect(app.isDefaultProtocolClient(protocol)).to.equal(false);
}); });
it('creates a registry entry for the protocol class', (done) => { it('creates a registry entry for the protocol class', async () => {
app.setAsDefaultProtocolClient(protocol); app.setAsDefaultProtocolClient(protocol);
classesKey.keys((error: Error, keys: any[]) => { const keys = await promisify(classesKey.keys).call(classesKey) as any[];
if (error) throw error; const exists = !!keys.find(key => key.key.includes(protocol));
expect(exists).to.equal(true);
const exists = !!keys.find(key => key.key.includes(protocol));
expect(exists).to.equal(true);
done();
});
}); });
it('completely removes a registry entry for the protocol class', (done) => { it('completely removes a registry entry for the protocol class', async () => {
app.setAsDefaultProtocolClient(protocol); app.setAsDefaultProtocolClient(protocol);
app.removeAsDefaultProtocolClient(protocol); app.removeAsDefaultProtocolClient(protocol);
classesKey.keys((error: Error, keys: any[]) => { const keys = await promisify(classesKey.keys).call(classesKey) as any[];
if (error) throw error; const exists = !!keys.find(key => key.key.includes(protocol));
expect(exists).to.equal(false);
const exists = !!keys.find(key => key.key.includes(protocol));
expect(exists).to.equal(false);
done();
});
}); });
it('only unsets a class registry key if it contains other data', (done) => { it('only unsets a class registry key if it contains other data', async () => {
app.setAsDefaultProtocolClient(protocol); app.setAsDefaultProtocolClient(protocol);
const protocolKey = new Winreg({ const protocolKey = new Winreg({
@ -926,18 +917,12 @@ describe('app module', () => {
key: `\\Software\\Classes\\${protocol}` key: `\\Software\\Classes\\${protocol}`
}); });
protocolKey.set('test-value', 'REG_BINARY', '123', () => { await promisify(protocolKey.set).call(protocolKey, 'test-value', 'REG_BINARY', '123');
app.removeAsDefaultProtocolClient(protocol); app.removeAsDefaultProtocolClient(protocol);
classesKey.keys((error: Error, keys: any[]) => { const keys = await promisify(classesKey.keys).call(classesKey) as any[];
if (error) throw error; const exists = !!keys.find(key => key.key.includes(protocol));
expect(exists).to.equal(true);
const exists = !!keys.find(key => key.key.includes(protocol));
expect(exists).to.equal(true);
done();
});
});
}); });
it('sets the default client such that getApplicationNameForProtocol returns Electron', () => { it('sets the default client such that getApplicationNameForProtocol returns Electron', () => {

100
spec-main/api-browser-window-spec.ts
View file

@ -311,13 +311,15 @@ describe('BrowserWindow module', () => {
server.close(); server.close();
}); });
it('should emit did-start-loading event', (done) => { it('should emit did-start-loading event', async () => {
w.webContents.on('did-start-loading', () => { done(); }); const didStartLoading = emittedOnce(w.webContents, 'did-start-loading');
w.loadURL('about:blank'); w.loadURL('about:blank');
await didStartLoading;
}); });
it('should emit ready-to-show event', (done) => { it('should emit ready-to-show event', async () => {
w.on('ready-to-show', () => { done(); }); const readyToShow = emittedOnce(w, 'ready-to-show');
w.loadURL('about:blank'); w.loadURL('about:blank');
await readyToShow;
}); });
// TODO(deepak1556): The error code now seems to be `ERR_FAILED`, verify what // TODO(deepak1556): The error code now seems to be `ERR_FAILED`, verify what
// changed and adjust the test. // changed and adjust the test.
@ -539,11 +541,10 @@ describe('BrowserWindow module', () => {
after(() => { after(() => {
server.close(); server.close();
}); });
it('is emitted on redirects', (done) => { it('is emitted on redirects', async () => {
w.webContents.on('will-redirect', () => { const willRedirect = emittedOnce(w.webContents, 'will-redirect');
done();
});
w.loadURL(`${url}/302`); w.loadURL(`${url}/302`);
await willRedirect;
}); });
it('is emitted after will-navigate on redirects', async () => { it('is emitted after will-navigate on redirects', async () => {
@ -1986,15 +1987,6 @@ describe('BrowserWindow module', () => {
}); });
describe('"sandbox" option', () => { describe('"sandbox" option', () => {
function waitForEvents<T> (emitter: { once: Function }, events: string[], callback: () => void) {
let count = events.length;
for (const event of events) {
emitter.once(event, () => {
if (!--count) callback();
});
}
}
const preload = path.join(path.resolve(__dirname, 'fixtures'), 'module', 'preload-sandbox.js'); const preload = path.join(path.resolve(__dirname, 'fixtures'), 'module', 'preload-sandbox.js');
let server: http.Server = null as unknown as http.Server; let server: http.Server = null as unknown as http.Server;
@ -2201,7 +2193,7 @@ describe('BrowserWindow module', () => {
expect(webPreferences.foo).to.equal('bar'); expect(webPreferences.foo).to.equal('bar');
}); });
it('should set ipc event sender correctly', (done) => { it('should set ipc event sender correctly', async () => {
const w = new BrowserWindow({ const w = new BrowserWindow({
show: false, show: false,
webPreferences: { webPreferences: {
@ -2224,11 +2216,13 @@ describe('BrowserWindow module', () => {
expect(event.sender).to.equal(childWc, 'sender should be the child'); expect(event.sender).to.equal(childWc, 'sender should be the child');
event.sender.send('verified'); event.sender.send('verified');
}); });
waitForEvents(ipcMain, [
const done = Promise.all([
'parent-answer', 'parent-answer',
'child-answer' 'child-answer'
], done); ].map(name => emittedOnce(ipcMain, name)));
w.loadFile(path.join(__dirname, 'fixtures', 'api', 'sandbox.html'), { search: 'verify-ipc-sender' }); w.loadFile(path.join(__dirname, 'fixtures', 'api', 'sandbox.html'), { search: 'verify-ipc-sender' });
await done;
}); });
describe('event handling', () => { describe('event handling', () => {
@ -2236,24 +2230,24 @@ describe('BrowserWindow module', () => {
beforeEach(() => { beforeEach(() => {
w = new BrowserWindow({ show: false, webPreferences: { sandbox: true } }); w = new BrowserWindow({ show: false, webPreferences: { sandbox: true } });
}); });
it('works for window events', (done) => { it('works for window events', async () => {
waitForEvents(w, [ const pageTitleUpdated = emittedOnce(w, 'page-title-updated');
'page-title-updated'
], done);
w.loadURL('data:text/html,<script>document.title = \'changed\'</script>'); w.loadURL('data:text/html,<script>document.title = \'changed\'</script>');
await pageTitleUpdated;
}); });
it('works for stop events', (done) => { it('works for stop events', async () => {
waitForEvents(w.webContents, [ const done = Promise.all([
'did-navigate', 'did-navigate',
'did-fail-load', 'did-fail-load',
'did-stop-loading' 'did-stop-loading'
], done); ].map(name => emittedOnce(w.webContents, name)));
w.loadURL('data:text/html,<script>stop()</script>'); w.loadURL('data:text/html,<script>stop()</script>');
await done;
}); });
it('works for web contents events', (done) => { it('works for web contents events', async () => {
waitForEvents(w.webContents, [ const done = Promise.all([
'did-finish-load', 'did-finish-load',
'did-frame-finish-load', 'did-frame-finish-load',
'did-navigate-in-page', 'did-navigate-in-page',
@ -2262,8 +2256,9 @@ describe('BrowserWindow module', () => {
'did-stop-loading', 'did-stop-loading',
'did-frame-finish-load', 'did-frame-finish-load',
'dom-ready' 'dom-ready'
], done); ].map(name => emittedOnce(w.webContents, name)));
w.loadFile(path.join(__dirname, 'fixtures', 'api', 'sandbox.html'), { search: 'webcontents-events' }); w.loadFile(path.join(__dirname, 'fixtures', 'api', 'sandbox.html'), { search: 'webcontents-events' });
await done;
}); });
}); });
@ -2929,26 +2924,29 @@ describe('BrowserWindow module', () => {
ifdescribe(process.platform !== 'linux')('max/minimize events', () => { ifdescribe(process.platform !== 'linux')('max/minimize events', () => {
afterEach(closeAllWindows); afterEach(closeAllWindows);
it('emits an event when window is maximized', (done) => { it('emits an event when window is maximized', async () => {
const w = new BrowserWindow({ show: false }); const w = new BrowserWindow({ show: false });
w.once('maximize', () => { done(); }); const maximize = emittedOnce(w, 'maximize');
w.show(); w.show();
w.maximize(); w.maximize();
await maximize;
}); });
it('emits an event when window is unmaximized', (done) => { it('emits an event when window is unmaximized', async () => {
const w = new BrowserWindow({ show: false }); const w = new BrowserWindow({ show: false });
w.once('unmaximize', () => { done(); }); const unmaximize = emittedOnce(w, 'unmaximize');
w.show(); w.show();
w.maximize(); w.maximize();
w.unmaximize(); w.unmaximize();
await unmaximize;
}); });
it('emits an event when window is minimized', (done) => { it('emits an event when window is minimized', async () => {
const w = new BrowserWindow({ show: false }); const w = new BrowserWindow({ show: false });
w.once('minimize', () => { done(); }); const minimize = emittedOnce(w, 'minimize');
w.show(); w.show();
w.minimize(); w.minimize();
await minimize;
}); });
}); });
@ -3162,26 +3160,26 @@ describe('BrowserWindow module', () => {
describe('parent window', () => { describe('parent window', () => {
afterEach(closeAllWindows); afterEach(closeAllWindows);
ifit(process.platform === 'darwin')('sheet-begin event emits when window opens a sheet', (done) => { ifit(process.platform === 'darwin')('sheet-begin event emits when window opens a sheet', async () => {
const w = new BrowserWindow(); const w = new BrowserWindow();
w.once('sheet-begin', () => { const sheetBegin = emittedOnce(w, 'sheet-begin');
done();
});
// eslint-disable-next-line no-new // eslint-disable-next-line no-new
new BrowserWindow({ new BrowserWindow({
modal: true, modal: true,
parent: w parent: w
}); });
await sheetBegin;
}); });
ifit(process.platform === 'darwin')('sheet-end event emits when window has closed a sheet', (done) => { ifit(process.platform === 'darwin')('sheet-end event emits when window has closed a sheet', async () => {
const w = new BrowserWindow(); const w = new BrowserWindow();
const sheet = new BrowserWindow({ const sheet = new BrowserWindow({
modal: true, modal: true,
parent: w parent: w
}); });
w.once('sheet-end', () => { done(); }); const sheetEnd = emittedOnce(w, 'sheet-end');
sheet.close(); sheet.close();
await sheetEnd;
}); });
describe('parent option', () => { describe('parent option', () => {
@ -3872,24 +3870,22 @@ describe('BrowserWindow module', () => {
expect(w.isFullScreen()).to.be.false('isFullScreen'); expect(w.isFullScreen()).to.be.false('isFullScreen');
}); });
it('does not crash when exiting simpleFullScreen (properties)', (done) => { it('does not crash when exiting simpleFullScreen (properties)', async () => {
const w = new BrowserWindow(); const w = new BrowserWindow();
w.setSimpleFullScreen(true); w.setSimpleFullScreen(true);
setTimeout(() => { await delay(1000);
w.setFullScreen(!w.isFullScreen());
done(); w.setFullScreen(!w.isFullScreen());
}, 1000);
}); });
it('does not crash when exiting simpleFullScreen (functions)', (done) => { it('does not crash when exiting simpleFullScreen (functions)', async () => {
const w = new BrowserWindow(); const w = new BrowserWindow();
w.simpleFullScreen = true; w.simpleFullScreen = true;
setTimeout(() => { await delay(1000);
w.setFullScreen(!w.isFullScreen());
done(); w.setFullScreen(!w.isFullScreen());
}, 1000);
}); });
it('should not be changed by setKiosk method', async () => { it('should not be changed by setKiosk method', async () => {

34
spec-main/api-menu-spec.ts
View file

@ -4,7 +4,7 @@ import { expect } from 'chai';
import { BrowserWindow, Menu, MenuItem } from 'electron/main'; import { BrowserWindow, Menu, MenuItem } from 'electron/main';
import { sortMenuItems } from '../lib/browser/api/menu-utils'; import { sortMenuItems } from '../lib/browser/api/menu-utils';
import { emittedOnce } from './events-helpers'; import { emittedOnce } from './events-helpers';
import { ifit } from './spec-helpers'; import { ifit, delay } from './spec-helpers';
import { closeWindow } from './window-helpers'; import { closeWindow } from './window-helpers';
const fixturesPath = path.resolve(__dirname, 'fixtures'); const fixturesPath = path.resolve(__dirname, 'fixtures');
@ -836,7 +836,7 @@ describe('Menu module', function () {
}); });
}); });
it('prevents menu from getting garbage-collected when popuping', (done) => { it('prevents menu from getting garbage-collected when popuping', async () => {
const menu = Menu.buildFromTemplate([{ role: 'paste' }]); const menu = Menu.buildFromTemplate([{ role: 'paste' }]);
menu.popup({ window: w }); menu.popup({ window: w });
@ -844,21 +844,21 @@ describe('Menu module', function () {
// eslint-disable-next-line no-undef // eslint-disable-next-line no-undef
const wr = new (globalThis as any).WeakRef(menu); const wr = new (globalThis as any).WeakRef(menu);
setTimeout(() => { await delay();
// Do garbage collection, since |menu| is not referenced in this closure
// it would be gone after next call. // Do garbage collection, since |menu| is not referenced in this closure
const v8Util = process._linkedBinding('electron_common_v8_util'); // it would be gone after next call.
v8Util.requestGarbageCollectionForTesting(); const v8Util = process._linkedBinding('electron_common_v8_util');
setTimeout(() => { v8Util.requestGarbageCollectionForTesting();
// Try to receive menu from weak reference.
if (wr.deref()) { await delay();
wr.deref().closePopup();
done(); // Try to receive menu from weak reference.
} else { if (wr.deref()) {
done('Menu is garbage-collected while popuping'); wr.deref().closePopup();
} } else {
}); throw new Error('Menu is garbage-collected while popuping');
}); }
}); });
}); });

4
spec-main/api-web-contents-spec.ts
View file

@ -1003,6 +1003,8 @@ describe('webContents module', () => {
defer(() => { defer(() => {
w2.setClosable(true); w2.setClosable(true);
w2.close(); w2.close();
protocol.unregisterProtocol(scheme);
}); });
await w.loadURL(`${scheme}://host3`); await w.loadURL(`${scheme}://host3`);
@ -1015,8 +1017,6 @@ describe('webContents module', () => {
const zoomLevel2 = w2.webContents.zoomLevel; const zoomLevel2 = w2.webContents.zoomLevel;
expect(zoomLevel2).to.equal(0); expect(zoomLevel2).to.equal(0);
expect(zoomLevel1).to.not.equal(zoomLevel2); expect(zoomLevel1).to.not.equal(zoomLevel2);
protocol.unregisterProtocol(scheme);
}); });
it('can persist when it contains iframe', (done) => { it('can persist when it contains iframe', (done) => {

12
spec-main/chromium-spec.ts
View file

@ -450,7 +450,7 @@ describe('chromium features', () => {
} }
}); });
it('returns error when permission is denied', (done) => { it('returns error when permission is denied', async () => {
const w = new BrowserWindow({ const w = new BrowserWindow({
show: false, show: false,
webPreferences: { webPreferences: {
@ -458,13 +458,7 @@ describe('chromium features', () => {
partition: 'geolocation-spec' partition: 'geolocation-spec'
} }
}); });
w.webContents.on('ipc-message', (event, channel) => { const message = emittedOnce(w.webContents, 'ipc-message');
if (channel === 'success') {
done();
} else {
done('unexpected response from geolocation api');
}
});
w.webContents.session.setPermissionRequestHandler((wc, permission, callback) => { w.webContents.session.setPermissionRequestHandler((wc, permission, callback) => {
if (permission === 'geolocation') { if (permission === 'geolocation') {
callback(false); callback(false);
@ -473,6 +467,8 @@ describe('chromium features', () => {
} }
}); });
w.loadFile(path.join(fixturesPath, 'pages', 'geolocation', 'index.html')); w.loadFile(path.join(fixturesPath, 'pages', 'geolocation', 'index.html'));
const [, channel] = await message;
expect(channel).to.equal('success', 'unexpected response from geolocation api');
}); });
}); });

15
spec-main/webview-spec.ts
View file

@ -1,7 +1,7 @@
import * as path from 'path'; import * as path from 'path';
import { BrowserWindow, session, ipcMain, app, WebContents } from 'electron/main'; import { BrowserWindow, session, ipcMain, app, WebContents } from 'electron/main';
import { closeAllWindows } from './window-helpers'; import { closeAllWindows } from './window-helpers';
import { emittedOnce } from './events-helpers'; import { emittedOnce, emittedUntil } from './events-helpers';
import { ifdescribe } from './spec-helpers'; import { ifdescribe } from './spec-helpers';
import { expect } from 'chai'; import { expect } from 'chai';
@ -415,18 +415,17 @@ describe('<webview> tag', function () {
await emittedOnce(app, 'browser-window-created'); await emittedOnce(app, 'browser-window-created');
}); });
it('emits a web-contents-created event', (done) => { it('emits a web-contents-created event', async () => {
app.on('web-contents-created', function listener (event, contents) { const webContentsCreated = emittedUntil(app, 'web-contents-created',
if (contents.getType() === 'window') { (event: Electron.Event, contents: Electron.WebContents) => contents.getType() === 'window');
app.removeListener('web-contents-created', listener);
done();
}
});
loadWebView(w.webContents, { loadWebView(w.webContents, {
allowpopups: 'on', allowpopups: 'on',
webpreferences: 'nativeWindowOpen=1', webpreferences: 'nativeWindowOpen=1',
src: `file://${fixtures}/pages/window-open.html` src: `file://${fixtures}/pages/window-open.html`
}); });
await webContentsCreated;
}); });
}); });

43
spec/webview-spec.js
View file

@ -954,32 +954,35 @@ describe('<webview> tag', function () {
}); });
describe('found-in-page event', () => { describe('found-in-page event', () => {
it('emits when a request is made', (done) => { it('emits when a request is made', async () => {
let requestId = null; const didFinishLoad = waitForEvent(webview, 'did-finish-load');
const activeMatchOrdinal = [];
const listener = (e) => {
expect(e.result.requestId).to.equal(requestId);
expect(e.result.matches).to.equal(3);
activeMatchOrdinal.push(e.result.activeMatchOrdinal);
if (e.result.activeMatchOrdinal === e.result.matches) {
expect(activeMatchOrdinal).to.deep.equal([1, 2, 3]);
webview.stopFindInPage('clearSelection');
done();
} else {
listener2();
}
};
const listener2 = () => {
requestId = webview.findInPage('virtual');
};
webview.addEventListener('found-in-page', listener);
webview.addEventListener('did-finish-load', listener2);
loadWebView(webview, { src: `file://${fixtures}/pages/content.html` }); loadWebView(webview, { src: `file://${fixtures}/pages/content.html` });
// TODO(deepak1556): With https://codereview.chromium.org/2836973002 // TODO(deepak1556): With https://codereview.chromium.org/2836973002
// focus of the webContents is required when triggering the api. // focus of the webContents is required when triggering the api.
// Remove this workaround after determining the cause for // Remove this workaround after determining the cause for
// incorrect focus. // incorrect focus.
webview.focus(); webview.focus();
await didFinishLoad;
const activeMatchOrdinal = [];
for (;;) {
const foundInPage = waitForEvent(webview, 'found-in-page');
const requestId = webview.findInPage('virtual');
const event = await foundInPage;
expect(event.result.requestId).to.equal(requestId);
expect(event.result.matches).to.equal(3);
activeMatchOrdinal.push(event.result.activeMatchOrdinal);
if (event.result.activeMatchOrdinal === event.result.matches) {
break;
}
}
expect(activeMatchOrdinal).to.deep.equal([1, 2, 3]);
webview.stopFindInPage('clearSelection');
}); });
}); });