1316 lines
52 KiB
TypeScript
1316 lines
52 KiB
TypeScript
import { app, session, BrowserWindow, ipcMain, WebContents, Extension, Session } from 'electron/main';
|
|
|
|
import { expect } from 'chai';
|
|
import * as WebSocket from 'ws';
|
|
|
|
import { once } from 'node:events';
|
|
import * as fs from 'node:fs/promises';
|
|
import * as http from 'node:http';
|
|
import * as path from 'node:path';
|
|
|
|
import { emittedNTimes, emittedUntil } from './lib/events-helpers';
|
|
import { ifit, listen, waitUntil } from './lib/spec-helpers';
|
|
import { closeAllWindows, closeWindow } from './lib/window-helpers';
|
|
|
|
const uuid = require('uuid');
|
|
|
|
const fixtures = path.join(__dirname, 'fixtures');
|
|
|
|
describe('chrome extensions', () => {
|
|
const emptyPage = '<script>console.log("loaded")</script>';
|
|
|
|
// NB. extensions are only allowed on http://, https:// and ftp:// (!) urls by default.
|
|
let server: http.Server;
|
|
let url: string;
|
|
let port: number;
|
|
before(async () => {
|
|
server = http.createServer((req, res) => {
|
|
if (req.url === '/cors') {
|
|
res.setHeader('Access-Control-Allow-Origin', 'http://example.com');
|
|
}
|
|
res.end(emptyPage);
|
|
});
|
|
|
|
const wss = new WebSocket.Server({ noServer: true });
|
|
wss.on('connection', function connection (ws) {
|
|
ws.on('message', function incoming (message) {
|
|
if (message === 'foo') {
|
|
ws.send('bar');
|
|
}
|
|
});
|
|
});
|
|
|
|
({ port, url } = await listen(server));
|
|
});
|
|
after(() => {
|
|
server.close();
|
|
});
|
|
afterEach(closeAllWindows);
|
|
afterEach(() => {
|
|
for (const e of session.defaultSession.getAllExtensions()) {
|
|
session.defaultSession.removeExtension(e.id);
|
|
}
|
|
});
|
|
|
|
it('does not crash when using chrome.management', async () => {
|
|
const customSession = session.fromPartition(`persist:${require('uuid').v4()}`);
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession, sandbox: true } });
|
|
await w.loadURL('about:blank');
|
|
|
|
const promise = once(app, 'web-contents-created') as Promise<[any, WebContents]>;
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'persistent-background-page'));
|
|
const args: any = await promise;
|
|
const wc: Electron.WebContents = args[1];
|
|
await expect(wc.executeJavaScript(`
|
|
(() => {
|
|
return new Promise((resolve) => {
|
|
chrome.management.getSelf((info) => {
|
|
resolve(info);
|
|
});
|
|
})
|
|
})();
|
|
`)).to.eventually.have.property('id');
|
|
});
|
|
|
|
describe('host_permissions', async () => {
|
|
let customSession: Session;
|
|
let w: BrowserWindow;
|
|
|
|
beforeEach(() => {
|
|
customSession = session.fromPartition(`persist:${require('uuid').v4()}`);
|
|
w = new BrowserWindow({
|
|
show: false,
|
|
webPreferences: {
|
|
session: customSession,
|
|
sandbox: true
|
|
}
|
|
});
|
|
});
|
|
|
|
afterEach(closeAllWindows);
|
|
|
|
it('recognize malformed host permissions', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const extPath = path.join(fixtures, 'extensions', 'host-permissions', 'malformed');
|
|
customSession.loadExtension(extPath);
|
|
|
|
const warning = await new Promise(resolve => { process.on('warning', resolve); });
|
|
|
|
const malformedHost = /Permission 'malformed_host' is unknown or URL pattern is malformed/;
|
|
|
|
expect(warning).to.match(malformedHost);
|
|
});
|
|
|
|
it('can grant special privileges to urls with host permissions', async () => {
|
|
const extPath = path.join(fixtures, 'extensions', 'host-permissions', 'privileged-tab-info');
|
|
await customSession.loadExtension(extPath);
|
|
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'query' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
|
|
expect(response).to.have.lengthOf(1);
|
|
|
|
const tab = response[0];
|
|
expect(tab).to.have.property('url').that.is.a('string');
|
|
expect(tab).to.have.property('title').that.is.a('string');
|
|
expect(tab).to.have.property('active').that.is.a('boolean');
|
|
expect(tab).to.have.property('autoDiscardable').that.is.a('boolean');
|
|
expect(tab).to.have.property('discarded').that.is.a('boolean');
|
|
expect(tab).to.have.property('groupId').that.is.a('number');
|
|
expect(tab).to.have.property('highlighted').that.is.a('boolean');
|
|
expect(tab).to.have.property('id').that.is.a('number');
|
|
expect(tab).to.have.property('incognito').that.is.a('boolean');
|
|
expect(tab).to.have.property('index').that.is.a('number');
|
|
expect(tab).to.have.property('pinned').that.is.a('boolean');
|
|
expect(tab).to.have.property('selected').that.is.a('boolean');
|
|
expect(tab).to.have.property('windowId').that.is.a('number');
|
|
});
|
|
});
|
|
|
|
it('supports minimum_chrome_version manifest key', async () => {
|
|
const customSession = session.fromPartition(`persist:${require('uuid').v4()}`);
|
|
const w = new BrowserWindow({
|
|
show: false,
|
|
webPreferences: {
|
|
session: customSession,
|
|
sandbox: true
|
|
}
|
|
});
|
|
|
|
await w.loadURL('about:blank');
|
|
|
|
const extPath = path.join(fixtures, 'extensions', 'minimum-chrome-version');
|
|
const load = customSession.loadExtension(extPath);
|
|
await expect(load).to.eventually.be.rejectedWith(
|
|
`Loading extension at ${extPath} failed with: This extension requires Chromium version 999 or greater.`
|
|
);
|
|
});
|
|
|
|
function fetch (contents: WebContents, url: string) {
|
|
return contents.executeJavaScript(`fetch(${JSON.stringify(url)})`);
|
|
}
|
|
|
|
it('bypasses CORS in requests made from extensions', async () => {
|
|
const customSession = session.fromPartition(`persist:${require('uuid').v4()}`);
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession, sandbox: true } });
|
|
const extension = await customSession.loadExtension(path.join(fixtures, 'extensions', 'ui-page'));
|
|
await w.loadURL(`${extension.url}bare-page.html`);
|
|
await expect(fetch(w.webContents, `${url}/cors`)).to.not.be.rejectedWith(TypeError);
|
|
});
|
|
|
|
it('loads an extension', async () => {
|
|
// NB. we have to use a persist: session (i.e. non-OTR) because the
|
|
// extension registry is redirected to the main session. so installing an
|
|
// extension in an in-memory session results in it being installed in the
|
|
// default session.
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'red-bg'));
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession } });
|
|
await w.loadURL(url);
|
|
const bg = await w.webContents.executeJavaScript('document.documentElement.style.backgroundColor');
|
|
expect(bg).to.equal('red');
|
|
});
|
|
|
|
it('does not crash when loading an extension with missing manifest', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const promise = customSession.loadExtension(path.join(fixtures, 'extensions', 'missing-manifest'));
|
|
await expect(promise).to.eventually.be.rejectedWith(/Manifest file is missing or unreadable/);
|
|
});
|
|
|
|
it('does not crash when failing to load an extension', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const promise = customSession.loadExtension(path.join(fixtures, 'extensions', 'load-error'));
|
|
await expect(promise).to.eventually.be.rejected();
|
|
});
|
|
|
|
it('serializes a loaded extension', async () => {
|
|
const extensionPath = path.join(fixtures, 'extensions', 'red-bg');
|
|
const manifest = JSON.parse(await fs.readFile(path.join(extensionPath, 'manifest.json'), 'utf-8'));
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const extension = await customSession.loadExtension(extensionPath);
|
|
expect(extension.id).to.be.a('string');
|
|
expect(extension.name).to.be.a('string');
|
|
expect(extension.path).to.be.a('string');
|
|
expect(extension.version).to.be.a('string');
|
|
expect(extension.url).to.be.a('string');
|
|
expect(extension.manifest).to.deep.equal(manifest);
|
|
});
|
|
|
|
it('removes an extension', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const { id } = await customSession.loadExtension(path.join(fixtures, 'extensions', 'red-bg'));
|
|
{
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession } });
|
|
await w.loadURL(url);
|
|
const bg = await w.webContents.executeJavaScript('document.documentElement.style.backgroundColor');
|
|
expect(bg).to.equal('red');
|
|
}
|
|
customSession.removeExtension(id);
|
|
{
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession } });
|
|
await w.loadURL(url);
|
|
const bg = await w.webContents.executeJavaScript('document.documentElement.style.backgroundColor');
|
|
expect(bg).to.equal('');
|
|
}
|
|
});
|
|
|
|
it('emits extension lifecycle events', async () => {
|
|
const customSession = session.fromPartition(`persist:${require('uuid').v4()}`);
|
|
|
|
const loadedPromise = once(customSession, 'extension-loaded');
|
|
const readyPromise = emittedUntil(customSession, 'extension-ready', (event: Event, extension: Extension) => {
|
|
return extension.name !== 'Chromium PDF Viewer';
|
|
});
|
|
const extension = await customSession.loadExtension(path.join(fixtures, 'extensions', 'red-bg'));
|
|
const [, loadedExtension] = await loadedPromise;
|
|
const [, readyExtension] = await readyPromise;
|
|
|
|
expect(loadedExtension).to.deep.equal(extension);
|
|
expect(readyExtension).to.deep.equal(extension);
|
|
|
|
const unloadedPromise = once(customSession, 'extension-unloaded');
|
|
await customSession.removeExtension(extension.id);
|
|
const [, unloadedExtension] = await unloadedPromise;
|
|
expect(unloadedExtension).to.deep.equal(extension);
|
|
});
|
|
|
|
it('lists loaded extensions in getAllExtensions', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const e = await customSession.loadExtension(path.join(fixtures, 'extensions', 'red-bg'));
|
|
expect(customSession.getAllExtensions()).to.deep.equal([e]);
|
|
customSession.removeExtension(e.id);
|
|
expect(customSession.getAllExtensions()).to.deep.equal([]);
|
|
});
|
|
|
|
it('gets an extension by id', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const e = await customSession.loadExtension(path.join(fixtures, 'extensions', 'red-bg'));
|
|
expect(customSession.getExtension(e.id)).to.deep.equal(e);
|
|
});
|
|
|
|
it('confines an extension to the session it was loaded in', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'red-bg'));
|
|
const w = new BrowserWindow({ show: false }); // not in the session
|
|
await w.loadURL(url);
|
|
const bg = await w.webContents.executeJavaScript('document.documentElement.style.backgroundColor');
|
|
expect(bg).to.equal('');
|
|
});
|
|
|
|
it('loading an extension in a temporary session throws an error', async () => {
|
|
const customSession = session.fromPartition(uuid.v4());
|
|
await expect(customSession.loadExtension(path.join(fixtures, 'extensions', 'red-bg'))).to.eventually.be.rejectedWith('Extensions cannot be loaded in a temporary session');
|
|
});
|
|
|
|
describe('chrome.i18n', () => {
|
|
let w: BrowserWindow;
|
|
let extension: Extension;
|
|
const exec = async (name: string) => {
|
|
const p = once(ipcMain, 'success');
|
|
await w.webContents.executeJavaScript(`exec('${name}')`);
|
|
const [, result] = await p;
|
|
return result;
|
|
};
|
|
beforeEach(async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
extension = await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-i18n', 'v2'));
|
|
w = new BrowserWindow({ show: false, webPreferences: { session: customSession, nodeIntegration: true, contextIsolation: false } });
|
|
await w.loadURL(url);
|
|
});
|
|
it('getAcceptLanguages()', async () => {
|
|
const result = await exec('getAcceptLanguages');
|
|
expect(result).to.be.an('array').and.deep.equal(['en-US', 'en']);
|
|
});
|
|
it('getMessage()', async () => {
|
|
const result = await exec('getMessage');
|
|
expect(result.id).to.be.a('string').and.equal(extension.id);
|
|
expect(result.name).to.be.a('string').and.equal('chrome-i18n');
|
|
});
|
|
});
|
|
|
|
describe('chrome.runtime', () => {
|
|
let w: BrowserWindow;
|
|
const exec = async (name: string) => {
|
|
const p = once(ipcMain, 'success');
|
|
await w.webContents.executeJavaScript(`exec('${name}')`);
|
|
const [, result] = await p;
|
|
return result;
|
|
};
|
|
beforeEach(async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-runtime'));
|
|
w = new BrowserWindow({ show: false, webPreferences: { session: customSession, nodeIntegration: true, contextIsolation: false } });
|
|
await w.loadURL(url);
|
|
});
|
|
it('getManifest()', async () => {
|
|
const result = await exec('getManifest');
|
|
expect(result).to.be.an('object').with.property('name', 'chrome-runtime');
|
|
});
|
|
it('id', async () => {
|
|
const result = await exec('id');
|
|
expect(result).to.be.a('string').with.lengthOf(32);
|
|
});
|
|
it('getURL()', async () => {
|
|
const result = await exec('getURL');
|
|
expect(result).to.be.a('string').and.match(/^chrome-extension:\/\/.*main.js$/);
|
|
});
|
|
it('getPlatformInfo()', async () => {
|
|
const result = await exec('getPlatformInfo');
|
|
expect(result).to.be.an('object');
|
|
expect(result.os).to.be.a('string');
|
|
expect(result.arch).to.be.a('string');
|
|
expect(result.nacl_arch).to.be.a('string');
|
|
});
|
|
});
|
|
|
|
describe('chrome.storage', () => {
|
|
it('stores and retrieves a key', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-storage'));
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession, nodeIntegration: true, contextIsolation: false } });
|
|
try {
|
|
const p = once(ipcMain, 'storage-success');
|
|
await w.loadURL(url);
|
|
const [, v] = await p;
|
|
expect(v).to.equal('value');
|
|
} finally {
|
|
w.destroy();
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('chrome.webRequest', () => {
|
|
function fetch (contents: WebContents, url: string) {
|
|
return contents.executeJavaScript(`fetch(${JSON.stringify(url)})`);
|
|
}
|
|
|
|
let customSession: Session;
|
|
let w: BrowserWindow;
|
|
|
|
beforeEach(() => {
|
|
customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
w = new BrowserWindow({ show: false, webPreferences: { session: customSession, sandbox: true, contextIsolation: true } });
|
|
});
|
|
|
|
describe('onBeforeRequest', () => {
|
|
async function haveRejectedFetch () {
|
|
try {
|
|
await fetch(w.webContents, url);
|
|
} catch (ex: any) {
|
|
return ex.message === 'Failed to fetch';
|
|
}
|
|
return false;
|
|
}
|
|
|
|
it('can cancel http requests', async () => {
|
|
await w.loadURL(url);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-webRequest'));
|
|
await expect(waitUntil(haveRejectedFetch)).to.eventually.be.fulfilled();
|
|
});
|
|
|
|
it('does not cancel http requests when no extension loaded', async () => {
|
|
await w.loadURL(url);
|
|
await expect(fetch(w.webContents, url)).to.not.be.rejectedWith('Failed to fetch');
|
|
});
|
|
});
|
|
|
|
it('does not take precedence over Electron webRequest - http', async () => {
|
|
return new Promise<void>((resolve) => {
|
|
(async () => {
|
|
customSession.webRequest.onBeforeRequest((details, callback) => {
|
|
resolve();
|
|
callback({ cancel: true });
|
|
});
|
|
await w.loadURL(url);
|
|
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-webRequest'));
|
|
fetch(w.webContents, url);
|
|
})();
|
|
});
|
|
});
|
|
|
|
it('does not take precedence over Electron webRequest - WebSocket', () => {
|
|
return new Promise<void>((resolve) => {
|
|
(async () => {
|
|
customSession.webRequest.onBeforeSendHeaders(() => {
|
|
resolve();
|
|
});
|
|
await w.loadFile(path.join(fixtures, 'api', 'webrequest.html'), { query: { port: `${port}` } });
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-webRequest-wss'));
|
|
})();
|
|
});
|
|
});
|
|
|
|
describe('WebSocket', () => {
|
|
it('can be proxied', async () => {
|
|
await w.loadFile(path.join(fixtures, 'api', 'webrequest.html'), { query: { port: `${port}` } });
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-webRequest-wss'));
|
|
customSession.webRequest.onSendHeaders((details) => {
|
|
if (details.url.startsWith('ws://')) {
|
|
expect(details.requestHeaders.foo).be.equal('bar');
|
|
}
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('chrome.tabs', () => {
|
|
let customSession: Session;
|
|
before(async () => {
|
|
customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-api'));
|
|
});
|
|
|
|
it('executeScript', async () => {
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession, nodeIntegration: true } });
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'executeScript', args: ['1 + 2'] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
|
|
expect(response).to.equal(3);
|
|
});
|
|
|
|
it('connect', async () => {
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession, nodeIntegration: true } });
|
|
await w.loadURL(url);
|
|
|
|
const portName = uuid.v4();
|
|
const message = { method: 'connectTab', args: [portName] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = responseString.split(',');
|
|
expect(response[0]).to.equal(portName);
|
|
expect(response[1]).to.equal('howdy');
|
|
});
|
|
|
|
it('sendMessage receives the response', async () => {
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession, nodeIntegration: true } });
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'sendMessage', args: ['Hello World!'] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
|
|
expect(response.message).to.equal('Hello World!');
|
|
expect(response.tabId).to.equal(w.webContents.id);
|
|
});
|
|
|
|
it('update', async () => {
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession, nodeIntegration: true } });
|
|
await w.loadURL(url);
|
|
|
|
const w2 = new BrowserWindow({ show: false, webPreferences: { session: customSession } });
|
|
await w2.loadURL('about:blank');
|
|
|
|
const w2Navigated = once(w2.webContents, 'did-navigate');
|
|
|
|
const message = { method: 'update', args: [w2.webContents.id, { url }] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
|
|
await w2Navigated;
|
|
|
|
expect(new URL(w2.getURL()).toString()).to.equal(new URL(url).toString());
|
|
|
|
expect(response.id).to.equal(w2.webContents.id);
|
|
});
|
|
});
|
|
|
|
describe('background pages', () => {
|
|
it('loads a lazy background page when sending a message', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'lazy-background-page'));
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession, nodeIntegration: true, contextIsolation: false } });
|
|
try {
|
|
w.loadURL(url);
|
|
const [, resp] = await once(ipcMain, 'bg-page-message-response');
|
|
expect(resp.message).to.deep.equal({ some: 'message' });
|
|
expect(resp.sender.id).to.be.a('string');
|
|
expect(resp.sender.origin).to.equal(url);
|
|
expect(resp.sender.url).to.equal(url + '/');
|
|
} finally {
|
|
w.destroy();
|
|
}
|
|
});
|
|
|
|
it('can use extension.getBackgroundPage from a ui page', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const { id } = await customSession.loadExtension(path.join(fixtures, 'extensions', 'lazy-background-page'));
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession } });
|
|
await w.loadURL(`chrome-extension://${id}/page-get-background.html`);
|
|
const receivedMessage = await w.webContents.executeJavaScript('window.completionPromise');
|
|
expect(receivedMessage).to.deep.equal({ some: 'message' });
|
|
});
|
|
|
|
it('can use extension.getBackgroundPage from a ui page', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const { id } = await customSession.loadExtension(path.join(fixtures, 'extensions', 'lazy-background-page'));
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession } });
|
|
await w.loadURL(`chrome-extension://${id}/page-get-background.html`);
|
|
const receivedMessage = await w.webContents.executeJavaScript('window.completionPromise');
|
|
expect(receivedMessage).to.deep.equal({ some: 'message' });
|
|
});
|
|
|
|
it('can use runtime.getBackgroundPage from a ui page', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const { id } = await customSession.loadExtension(path.join(fixtures, 'extensions', 'lazy-background-page'));
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession } });
|
|
await w.loadURL(`chrome-extension://${id}/page-runtime-get-background.html`);
|
|
const receivedMessage = await w.webContents.executeJavaScript('window.completionPromise');
|
|
expect(receivedMessage).to.deep.equal({ some: 'message' });
|
|
});
|
|
|
|
it('has session in background page', async () => {
|
|
const customSession = session.fromPartition(`persist:${require('uuid').v4()}`);
|
|
const promise = once(app, 'web-contents-created') as Promise<[any, WebContents]>;
|
|
const { id } = await customSession.loadExtension(path.join(fixtures, 'extensions', 'persistent-background-page'));
|
|
const [, bgPageContents] = await promise;
|
|
expect(bgPageContents.getType()).to.equal('backgroundPage');
|
|
await once(bgPageContents, 'did-finish-load');
|
|
expect(bgPageContents.getURL()).to.equal(`chrome-extension://${id}/_generated_background_page.html`);
|
|
expect(bgPageContents.session).to.not.equal(undefined);
|
|
});
|
|
|
|
it('can open devtools of background page', async () => {
|
|
const customSession = session.fromPartition(`persist:${require('uuid').v4()}`);
|
|
const promise = once(app, 'web-contents-created') as Promise<[any, WebContents]>;
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'persistent-background-page'));
|
|
const [, bgPageContents] = await promise;
|
|
expect(bgPageContents.getType()).to.equal('backgroundPage');
|
|
bgPageContents.openDevTools();
|
|
bgPageContents.closeDevTools();
|
|
});
|
|
});
|
|
|
|
describe('devtools extensions', () => {
|
|
let showPanelTimeoutId: any = null;
|
|
afterEach(() => {
|
|
if (showPanelTimeoutId) clearTimeout(showPanelTimeoutId);
|
|
});
|
|
const showLastDevToolsPanel = (w: BrowserWindow) => {
|
|
w.webContents.once('devtools-opened', () => {
|
|
const show = () => {
|
|
if (w == null || w.isDestroyed()) return;
|
|
const { devToolsWebContents } = w as unknown as { devToolsWebContents: WebContents | undefined };
|
|
if (devToolsWebContents == null || devToolsWebContents.isDestroyed()) {
|
|
return;
|
|
}
|
|
|
|
const showLastPanel = () => {
|
|
// this is executed in the devtools context, where UI is a global
|
|
const { EUI } = (window as any);
|
|
const instance = EUI.InspectorView.InspectorView.instance();
|
|
const tabs = instance.tabbedPane.tabs;
|
|
const lastPanelId = tabs[tabs.length - 1].id;
|
|
instance.showPanel(lastPanelId);
|
|
};
|
|
devToolsWebContents.executeJavaScript(`(${showLastPanel})()`, false).then(() => {
|
|
showPanelTimeoutId = setTimeout(show, 100);
|
|
});
|
|
};
|
|
showPanelTimeoutId = setTimeout(show, 100);
|
|
});
|
|
};
|
|
|
|
// TODO(jkleinsc) fix this flaky test on WOA
|
|
ifit(process.platform !== 'win32' || process.arch !== 'arm64')('loads a devtools extension', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
customSession.loadExtension(path.join(fixtures, 'extensions', 'devtools-extension'));
|
|
const winningMessage = once(ipcMain, 'winning');
|
|
const w = new BrowserWindow({ show: true, webPreferences: { session: customSession, nodeIntegration: true, contextIsolation: false } });
|
|
await w.loadURL(url);
|
|
w.webContents.openDevTools();
|
|
showLastDevToolsPanel(w);
|
|
await winningMessage;
|
|
});
|
|
});
|
|
|
|
describe('chrome extension content scripts', () => {
|
|
const fixtures = path.resolve(__dirname, 'fixtures');
|
|
const extensionPath = path.resolve(fixtures, 'extensions');
|
|
|
|
const addExtension = (name: string) => session.defaultSession.loadExtension(path.resolve(extensionPath, name));
|
|
const removeAllExtensions = () => {
|
|
Object.keys(session.defaultSession.getAllExtensions()).forEach(extName => {
|
|
session.defaultSession.removeExtension(extName);
|
|
});
|
|
};
|
|
|
|
let responseIdCounter = 0;
|
|
const executeJavaScriptInFrame = (webContents: WebContents, frameRoutingId: number, code: string) => {
|
|
return new Promise(resolve => {
|
|
const responseId = responseIdCounter++;
|
|
ipcMain.once(`executeJavaScriptInFrame_${responseId}`, (event, result) => {
|
|
resolve(result);
|
|
});
|
|
webContents.send('executeJavaScriptInFrame', frameRoutingId, code, responseId);
|
|
});
|
|
};
|
|
|
|
const generateTests = (sandboxEnabled: boolean, contextIsolationEnabled: boolean) => {
|
|
describe(`with sandbox ${sandboxEnabled ? 'enabled' : 'disabled'} and context isolation ${contextIsolationEnabled ? 'enabled' : 'disabled'}`, () => {
|
|
let w: BrowserWindow;
|
|
|
|
describe('supports "run_at" option', () => {
|
|
beforeEach(async () => {
|
|
await closeWindow(w);
|
|
w = new BrowserWindow({
|
|
show: false,
|
|
width: 400,
|
|
height: 400,
|
|
webPreferences: {
|
|
contextIsolation: contextIsolationEnabled,
|
|
sandbox: sandboxEnabled
|
|
}
|
|
});
|
|
});
|
|
|
|
afterEach(async () => {
|
|
removeAllExtensions();
|
|
await closeWindow(w);
|
|
w = null as unknown as BrowserWindow;
|
|
});
|
|
|
|
it('should run content script at document_start', async () => {
|
|
await addExtension('content-script-document-start');
|
|
w.webContents.once('dom-ready', async () => {
|
|
const result = await w.webContents.executeJavaScript('document.documentElement.style.backgroundColor');
|
|
expect(result).to.equal('red');
|
|
});
|
|
w.loadURL(url);
|
|
});
|
|
|
|
it('should run content script at document_idle', async () => {
|
|
await addExtension('content-script-document-idle');
|
|
w.loadURL(url);
|
|
const result = await w.webContents.executeJavaScript('document.body.style.backgroundColor');
|
|
expect(result).to.equal('red');
|
|
});
|
|
|
|
it('should run content script at document_end', async () => {
|
|
await addExtension('content-script-document-end');
|
|
w.webContents.once('did-finish-load', async () => {
|
|
const result = await w.webContents.executeJavaScript('document.documentElement.style.backgroundColor');
|
|
expect(result).to.equal('red');
|
|
});
|
|
w.loadURL(url);
|
|
});
|
|
});
|
|
|
|
describe('supports "all_frames" option', () => {
|
|
const contentScript = path.resolve(fixtures, 'extensions/content-script');
|
|
const contentPath = path.join(contentScript, 'frame-with-frame.html');
|
|
|
|
// Computed style values
|
|
const COLOR_RED = 'rgb(255, 0, 0)';
|
|
const COLOR_BLUE = 'rgb(0, 0, 255)';
|
|
const COLOR_TRANSPARENT = 'rgba(0, 0, 0, 0)';
|
|
|
|
let server: http.Server;
|
|
let port: number;
|
|
before(async () => {
|
|
server = http.createServer(async (_, res) => {
|
|
try {
|
|
const content = await fs.readFile(contentPath, 'utf-8');
|
|
res.writeHead(200, { 'Content-Type': 'text/html' });
|
|
res.end(content, 'utf-8');
|
|
} catch (error) {
|
|
res.writeHead(500);
|
|
res.end(`Failed to load ${contentPath} : ${(error as NodeJS.ErrnoException).code}`);
|
|
}
|
|
});
|
|
|
|
({ port, url } = await listen(server));
|
|
|
|
session.defaultSession.loadExtension(contentScript);
|
|
});
|
|
|
|
after(() => {
|
|
session.defaultSession.removeExtension('content-script-test');
|
|
});
|
|
|
|
beforeEach(() => {
|
|
w = new BrowserWindow({
|
|
show: false,
|
|
webPreferences: {
|
|
// enable content script injection in subframes
|
|
nodeIntegrationInSubFrames: true,
|
|
preload: path.join(contentScript, 'all_frames-preload.js')
|
|
}
|
|
});
|
|
});
|
|
|
|
afterEach(() =>
|
|
closeWindow(w).then(() => {
|
|
w = null as unknown as BrowserWindow;
|
|
})
|
|
);
|
|
|
|
it('applies matching rules in subframes', async () => {
|
|
const detailsPromise = emittedNTimes(w.webContents, 'did-frame-finish-load', 2);
|
|
|
|
w.loadURL(`http://127.0.0.1:${port}`);
|
|
const frameEvents = await detailsPromise;
|
|
await Promise.all(
|
|
frameEvents.map(async frameEvent => {
|
|
const [, isMainFrame, , frameRoutingId] = frameEvent;
|
|
const result: any = await executeJavaScriptInFrame(
|
|
w.webContents,
|
|
frameRoutingId,
|
|
`(() => {
|
|
const a = document.getElementById('all_frames_enabled')
|
|
const b = document.getElementById('all_frames_disabled')
|
|
return {
|
|
enabledColor: getComputedStyle(a).backgroundColor,
|
|
disabledColor: getComputedStyle(b).backgroundColor
|
|
}
|
|
})()`
|
|
);
|
|
|
|
expect(result.enabledColor).to.equal(COLOR_RED);
|
|
expect(result.disabledColor).to.equal(isMainFrame ? COLOR_BLUE : COLOR_TRANSPARENT);
|
|
})
|
|
);
|
|
});
|
|
});
|
|
});
|
|
};
|
|
|
|
generateTests(false, false);
|
|
generateTests(false, true);
|
|
generateTests(true, false);
|
|
generateTests(true, true);
|
|
});
|
|
|
|
describe('extension ui pages', () => {
|
|
afterEach(() => {
|
|
for (const e of session.defaultSession.getAllExtensions()) {
|
|
session.defaultSession.removeExtension(e.id);
|
|
}
|
|
});
|
|
|
|
it('loads a ui page of an extension', async () => {
|
|
const { id } = await session.defaultSession.loadExtension(path.join(fixtures, 'extensions', 'ui-page'));
|
|
const w = new BrowserWindow({ show: false });
|
|
await w.loadURL(`chrome-extension://${id}/bare-page.html`);
|
|
const textContent = await w.webContents.executeJavaScript('document.body.textContent');
|
|
expect(textContent).to.equal('ui page loaded ok\n');
|
|
});
|
|
|
|
it('can load resources', async () => {
|
|
const { id } = await session.defaultSession.loadExtension(path.join(fixtures, 'extensions', 'ui-page'));
|
|
const w = new BrowserWindow({ show: false });
|
|
await w.loadURL(`chrome-extension://${id}/page-script-load.html`);
|
|
const textContent = await w.webContents.executeJavaScript('document.body.textContent');
|
|
expect(textContent).to.equal('script loaded ok\n');
|
|
});
|
|
});
|
|
|
|
describe('manifest v3', () => {
|
|
it('registers background service worker', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const registrationPromise = new Promise<string>(resolve => {
|
|
customSession.serviceWorkers.once('registration-completed', (event, { scope }) => resolve(scope));
|
|
});
|
|
const extension = await customSession.loadExtension(path.join(fixtures, 'extensions', 'mv3-service-worker'));
|
|
const scope = await registrationPromise;
|
|
expect(scope).equals(extension.url);
|
|
});
|
|
|
|
it('can run chrome extension APIs', async () => {
|
|
const customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const w = new BrowserWindow({ show: false, webPreferences: { session: customSession, nodeIntegration: true } });
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'mv3-service-worker'));
|
|
|
|
await w.loadURL(url);
|
|
|
|
w.webContents.executeJavaScript('window.postMessage(\'fetch-confirmation\', \'*\')');
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
const { message } = JSON.parse(responseString);
|
|
|
|
expect(message).to.equal('Hello from background.js');
|
|
});
|
|
|
|
describe('chrome.i18n', () => {
|
|
let customSession: Session;
|
|
let w = null as unknown as BrowserWindow;
|
|
|
|
before(async () => {
|
|
customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-i18n', 'v3'));
|
|
});
|
|
|
|
beforeEach(() => {
|
|
w = new BrowserWindow({
|
|
show: false,
|
|
webPreferences: {
|
|
session: customSession,
|
|
nodeIntegration: true
|
|
}
|
|
});
|
|
});
|
|
|
|
afterEach(closeAllWindows);
|
|
|
|
it('getAcceptLanguages', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'getAcceptLanguages' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
|
|
expect(response).to.be.an('array').that.is.not.empty('languages array is empty');
|
|
});
|
|
|
|
it('getUILanguage', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'getUILanguage' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
|
|
expect(response).to.be.a('string');
|
|
});
|
|
|
|
it('getMessage', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'getMessage' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
|
|
expect(response).to.equal('Hola mundo!!');
|
|
});
|
|
|
|
it('detectLanguage', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const greetings = [
|
|
'Ich liebe dich', // German
|
|
'Mahal kita', // Filipino
|
|
'愛してます', // Japanese
|
|
'دوستت دارم', // Persian
|
|
'Minä rakastan sinua' // Finnish
|
|
];
|
|
const message = { method: 'detectLanguage', args: [greetings] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
|
|
expect(response).to.be.an('array');
|
|
|
|
for (const item of response) {
|
|
expect(Object.keys(item)).to.deep.equal(['isReliable', 'languages']);
|
|
}
|
|
|
|
const languages = response.map((r: { isReliable: boolean, languages: any[] }) => r.languages[0]);
|
|
expect(languages).to.deep.equal([
|
|
{ language: 'de', percentage: 100 },
|
|
{ language: 'fil', percentage: 100 },
|
|
{ language: 'ja', percentage: 100 },
|
|
{ language: 'ps', percentage: 100 },
|
|
{ language: 'fi', percentage: 100 }
|
|
]);
|
|
});
|
|
});
|
|
|
|
// chrome.action is not supported in Electron. These tests only ensure
|
|
// it does not explode.
|
|
describe('chrome.action', () => {
|
|
let customSession: Session;
|
|
let w = null as unknown as BrowserWindow;
|
|
|
|
before(async () => {
|
|
customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-action-fail'));
|
|
});
|
|
|
|
beforeEach(() => {
|
|
w = new BrowserWindow({
|
|
show: false,
|
|
webPreferences: {
|
|
session: customSession
|
|
}
|
|
});
|
|
});
|
|
|
|
afterEach(closeAllWindows);
|
|
|
|
it('isEnabled', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'isEnabled' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.equal(false);
|
|
});
|
|
|
|
it('setIcon', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'setIcon' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.equal(null);
|
|
});
|
|
|
|
it('getBadgeText', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'getBadgeText' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.equal('');
|
|
});
|
|
});
|
|
|
|
describe('chrome.tabs', () => {
|
|
let customSession: Session;
|
|
let w = null as unknown as BrowserWindow;
|
|
|
|
before(async () => {
|
|
customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-tabs', 'api-async'));
|
|
});
|
|
|
|
beforeEach(() => {
|
|
w = new BrowserWindow({
|
|
show: false,
|
|
webPreferences: {
|
|
session: customSession
|
|
}
|
|
});
|
|
});
|
|
|
|
afterEach(closeAllWindows);
|
|
|
|
it('getZoom', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'getZoom' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.equal(1);
|
|
});
|
|
|
|
it('setZoom', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'setZoom', args: [2] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.deep.equal(2);
|
|
});
|
|
|
|
it('getZoomSettings', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'getZoomSettings' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.deep.equal({
|
|
defaultZoomFactor: 1,
|
|
mode: 'automatic',
|
|
scope: 'per-origin'
|
|
});
|
|
});
|
|
|
|
it('setZoomSettings', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'setZoomSettings', args: [{ mode: 'disabled' }] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.deep.equal({
|
|
defaultZoomFactor: 1,
|
|
mode: 'disabled',
|
|
scope: 'per-tab'
|
|
});
|
|
});
|
|
|
|
describe('get', () => {
|
|
it('returns tab properties', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'get' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.have.property('url').that.is.a('string');
|
|
expect(response).to.have.property('title').that.is.a('string');
|
|
expect(response).to.have.property('active').that.is.a('boolean');
|
|
expect(response).to.have.property('autoDiscardable').that.is.a('boolean');
|
|
expect(response).to.have.property('discarded').that.is.a('boolean');
|
|
expect(response).to.have.property('groupId').that.is.a('number');
|
|
expect(response).to.have.property('highlighted').that.is.a('boolean');
|
|
expect(response).to.have.property('id').that.is.a('number');
|
|
expect(response).to.have.property('incognito').that.is.a('boolean');
|
|
expect(response).to.have.property('index').that.is.a('number');
|
|
expect(response).to.have.property('pinned').that.is.a('boolean');
|
|
expect(response).to.have.property('selected').that.is.a('boolean');
|
|
expect(response).to.have.property('windowId').that.is.a('number');
|
|
});
|
|
|
|
it('does not return privileged properties without tabs permission', async () => {
|
|
const noPrivilegeSes = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await noPrivilegeSes.loadExtension(path.join(fixtures, 'extensions', 'chrome-tabs', 'no-privileges'));
|
|
|
|
w = new BrowserWindow({ show: false, webPreferences: { session: noPrivilegeSes } });
|
|
await w.loadURL(url);
|
|
|
|
w.webContents.executeJavaScript('window.postMessage(\'{}\', \'*\')');
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
expect(response).not.to.have.property('url');
|
|
expect(response).not.to.have.property('title');
|
|
expect(response).to.have.property('active').that.is.a('boolean');
|
|
expect(response).to.have.property('autoDiscardable').that.is.a('boolean');
|
|
expect(response).to.have.property('discarded').that.is.a('boolean');
|
|
expect(response).to.have.property('groupId').that.is.a('number');
|
|
expect(response).to.have.property('highlighted').that.is.a('boolean');
|
|
expect(response).to.have.property('id').that.is.a('number');
|
|
expect(response).to.have.property('incognito').that.is.a('boolean');
|
|
expect(response).to.have.property('index').that.is.a('number');
|
|
expect(response).to.have.property('pinned').that.is.a('boolean');
|
|
expect(response).to.have.property('selected').that.is.a('boolean');
|
|
expect(response).to.have.property('windowId').that.is.a('number');
|
|
});
|
|
});
|
|
|
|
it('reload', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'reload' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const consoleMessage = once(w.webContents, 'console-message');
|
|
const finish = once(w.webContents, 'did-finish-load');
|
|
|
|
await Promise.all([consoleMessage, finish]).then(([[,, responseString]]) => {
|
|
const response = JSON.parse(responseString);
|
|
expect(response.status).to.equal('reloaded');
|
|
});
|
|
});
|
|
|
|
describe('update', () => {
|
|
it('can update muted status', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'update', args: [{ muted: true }] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
|
|
expect(response).to.have.property('mutedInfo').that.is.a('object');
|
|
const { mutedInfo } = response;
|
|
expect(mutedInfo).to.deep.eq({
|
|
muted: true,
|
|
reason: 'user'
|
|
});
|
|
});
|
|
|
|
it('fails when navigating to an invalid url', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'update', args: [{ url: 'chrome://crash' }] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const { error } = JSON.parse(responseString);
|
|
expect(error).to.eq('I\'m sorry. I\'m afraid I can\'t do that.');
|
|
});
|
|
|
|
it('fails when navigating to prohibited url', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'update', args: [{ url: 'chrome://crash' }] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const { error } = JSON.parse(responseString);
|
|
expect(error).to.eq('I\'m sorry. I\'m afraid I can\'t do that.');
|
|
});
|
|
|
|
it('fails when navigating to a devtools url without permission', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'update', args: [{ url: 'devtools://blah' }] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
const { error } = JSON.parse(responseString);
|
|
expect(error).to.eq('Cannot navigate to a devtools:// page without either the devtools or debugger permission.');
|
|
});
|
|
|
|
it('fails when navigating to a chrome-untrusted url', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'update', args: [{ url: 'chrome-untrusted://blah' }] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
const { error } = JSON.parse(responseString);
|
|
expect(error).to.eq('Cannot navigate to a chrome-untrusted:// page.');
|
|
});
|
|
|
|
it('fails when navigating to a file url withotut file access', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'update', args: [{ url: 'file://blah' }] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
const { error } = JSON.parse(responseString);
|
|
expect(error).to.eq('Cannot navigate to a file URL without local file access.');
|
|
});
|
|
});
|
|
|
|
describe('query', () => {
|
|
it('can query for a tab with specific properties', async () => {
|
|
await w.loadURL(url);
|
|
|
|
expect(w.webContents.isAudioMuted()).to.be.false('muted');
|
|
w.webContents.setAudioMuted(true);
|
|
expect(w.webContents.isAudioMuted()).to.be.true('not muted');
|
|
|
|
const message = { method: 'query', args: [{ muted: true }] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.have.lengthOf(1);
|
|
|
|
const tab = response[0];
|
|
expect(tab.mutedInfo).to.deep.equal({
|
|
muted: true,
|
|
reason: 'user'
|
|
});
|
|
});
|
|
|
|
it('only returns tabs in the same session', async () => {
|
|
await w.loadURL(url);
|
|
w.webContents.setAudioMuted(true);
|
|
|
|
const sameSessionWin = new BrowserWindow({
|
|
show: false,
|
|
webPreferences: {
|
|
session: customSession
|
|
}
|
|
});
|
|
|
|
sameSessionWin.webContents.setAudioMuted(true);
|
|
|
|
const newSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
const differentSessionWin = new BrowserWindow({
|
|
show: false,
|
|
webPreferences: {
|
|
session: newSession
|
|
}
|
|
});
|
|
|
|
differentSessionWin.webContents.setAudioMuted(true);
|
|
|
|
const message = { method: 'query', args: [{ muted: true }] };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [, , responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.have.lengthOf(2);
|
|
for (const tab of response) {
|
|
expect(tab.mutedInfo).to.deep.equal({
|
|
muted: true,
|
|
reason: 'user'
|
|
});
|
|
}
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('chrome.scripting', () => {
|
|
let customSession: Session;
|
|
let w = null as unknown as BrowserWindow;
|
|
|
|
before(async () => {
|
|
customSession = session.fromPartition(`persist:${uuid.v4()}`);
|
|
await customSession.loadExtension(path.join(fixtures, 'extensions', 'chrome-scripting'));
|
|
});
|
|
|
|
beforeEach(() => {
|
|
w = new BrowserWindow({
|
|
show: false,
|
|
webPreferences: {
|
|
session: customSession,
|
|
nodeIntegration: true
|
|
}
|
|
});
|
|
});
|
|
|
|
afterEach(closeAllWindows);
|
|
|
|
it('executeScript', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'executeScript' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const updated = await once(w.webContents, 'page-title-updated');
|
|
expect(updated[1]).to.equal('HEY HEY HEY');
|
|
});
|
|
|
|
it('registerContentScripts', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'registerContentScripts' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.be.an('array').with.lengthOf(1);
|
|
expect(response[0]).to.deep.equal({
|
|
allFrames: false,
|
|
id: 'session-script',
|
|
js: ['content.js'],
|
|
matchOriginAsFallback: false,
|
|
matches: ['<all_urls>'],
|
|
persistAcrossSessions: false,
|
|
runAt: 'document_start',
|
|
world: 'ISOLATED'
|
|
});
|
|
});
|
|
|
|
it('globalParams', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const message = { method: 'globalParams' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
expect(response).to.deep.equal({ changed: true });
|
|
});
|
|
|
|
it('insertCSS', async () => {
|
|
await w.loadURL(url);
|
|
|
|
const bgBefore = await w.webContents.executeJavaScript('window.getComputedStyle(document.body).backgroundColor');
|
|
expect(bgBefore).to.equal('rgba(0, 0, 0, 0)');
|
|
|
|
const message = { method: 'insertCSS' };
|
|
w.webContents.executeJavaScript(`window.postMessage('${JSON.stringify(message)}', '*')`);
|
|
|
|
const [,, responseString] = await once(w.webContents, 'console-message');
|
|
const response = JSON.parse(responseString);
|
|
expect(response.success).to.be.true();
|
|
|
|
const bgAfter = await w.webContents.executeJavaScript('window.getComputedStyle(document.body).backgroundColor');
|
|
expect(bgAfter).to.equal('rgb(255, 0, 0)');
|
|
});
|
|
});
|
|
});
|
|
});
|