4a46949a21
* build: use github actions for windows (#44136) * build: test windows runner * build: try build windows on windows? * build: take win/cross changes * build: use bash as default shell always * build: configure git for windows build tools * build: bash as default * build: configure windows correctly * build: use sha1sum * build: force windows cipd init and python3 existence * just pain * build: restore cache on windows * build: use build-tools gclient * build: sync gclient vars to build windows job * build: output depshash for debugging * build: past sam was a silly goose * build: depshash logging * build: force lf endings for lock and DEPS * build: platform strings are hard * build: checkout on windows host * sup * no check * idk * sigh * ... * no double checkout * build: yolo some stuff * build: run gn-check for windows on linux hosts for speed * use container... * cry ? * build: e d * e d * no log * fix toolchain on windows cross check * build: use powershell to add mksnapshot_args * build: enable x86 and arm64 windows builds too * clean up * maybe not needed * build: keep action around for post step * build: configure git global on win * build: ia32 zip manifest * build: no patch depot_tools for tests * build: get arm64 windows closer to working * build: windows tar is ass * 32 bit on 32 bit * maybe bash * build: set up nodejs * correct windows sharding * fix some spec runner stuff * fix windows tests * overwrite -Force * sigh * screen res * wat * logs * ... more logs * line endings will be the death of me * remove 1080p force thing * vsctools + logging * disable some fullscreen tests on GHA * no progress * run all CI * install visual studio on arm64 * windows hax for non windows * maybe arm sdk * clean up depshash logic * build: use single check per platform * ensure clean args * fix loop * remove debug * update default build image sha for dispatch * plzzzz * one more try * arm64 vctools * sad * build: fix non-dispatch windows gn check * chore: debug datadog-ci location * chore: update build-tools for newer toolchain * chore: set path for datadog-ci * try this * chore: fixup gn check * fixup gn-check some more * fixup windows gn check * chore: fixup windows gn check * test: use cmd for Windows testing * fixup use cmd for testing on Windows * fixup windows GN check * fixup npm config arch for x86 * Can we set test files via powershell * fixup to set test files via powershell * fixup set test files via powershell * Don't check cross instance cache disk space on Windows * Use separate step to set env variables for testing * fixup Use separate step to set env variables for testing * fixup Use separate step to set env variables for testing * fixup Use separate step to set env variables for testing (AGAIN) * use powershell if in powershell * fixup use powershell if in powershell * chore: remove no longer needed changes to depot_tools xref: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/5669094 and https://chromium-review.googlesource.com/c/chromium/src/+/5844046 * chore: try using 7zip on Windows to extract tarball * Revert "chore: try using 7zip on Windows to extract tarball" This reverts commit c7432b6a37857fd0746b8f1776fbd1103dba0b85. * test: debug failing tests on GHA windows * fix: ftbfs when including simdjson in Node.js (cherry picked from commit 48e44c40d61b7aa843a990d4e0c8dec676b4ce8f) * chore: try to track down Windows testing hang * use correct timeout * try this * see if this helps * try to figure out why node is running * shard tests to try to narrow down WOA lockup * try to narrow down problem test * Narrow down blocking test more * do we need a combo to repro * see if this cleans up the tests * fixup navigator.usb test * remove logging from problematic tests * Revert "shard tests to try to narrow down WOA lockup" This reverts commit a1806583769678491814cb8b008131c32be4e8fb. * remove logging * debug keyboard test * add timeout for Windows since arm64 sometimes hangs * see if this helps * put back original timeout * try to use screenCapture to get screenshots of what is going on on WOA * try using electron screencapture to debug WOA hang * chore: turn off privacy experience * run screenshot on both shards * fixup screencap * try to narrow down hanging spec * chore: cleanup servers left open * cleanup tests * Revert "try to narrow down hanging spec" This reverts commit a0f959f5382f4012a9919ac535d42c5333eb7d5f. * cleanup test debugging * fixup extensions spec * cleanup unneeded items * run wtf with 2 shards instead of 6 * Revert "run wtf with 2 shards instead of 6" This reverts commit ca2d282129ee42c535d80f9876d6fa0dc6c08344. * debug windows version on woa * dump more info * Get detailed CPU info * revert debugging * use same args as AppVeyor WOA for GHA WOA * fixup use same args as AppVeyor WOA for GHA WOA * fixup use same args as AppVeyor WOA for GHA WOA * try to track down which tests trigger hang * one or more of these combinations should hang * break up web contents spec to find hang * further break down api-web-contents to find hang * test: ensure all webContents are closed * test: fix require is not defined error * see if api-web-contents spec is now good * test: ensure all webContents are closed * Revert "try to track down which tests trigger hang" This reverts commit 07298d6ffeb4873ef7615a8ec3d1a6696e354ff4. * chore: use alternate location for windows toolchain * Reapply "try to track down which tests trigger hang" This reverts commit 0321f76d01069ef325339b6fe6ed39700eae2b6b. * try to narrow down problem test * fix TEST_SHARD env var * no, really fix TEST_SHARD env var * see if this fixes it * test: cleanup any remaining windows and webcontents * see if new cleanup helps * dont destroy webcontents for now * fixup dont destroy webcontents for now * Only cleanup right before process.exit * see if this fixes the hang * actually destroy webcontents * Revert "Reapply "try to track down which tests trigger hang"" This reverts commit cdee7de049ce6bb5f67bbcc64882c56aa2c73027. * see if this helps * Revert "see if this helps" This reverts commit 9a15a69cf7dbc456db7a61efa5b6870535bae993. * Is it all about the web contents? * it is all about the webcontents but which one? * Narrow down problem webcontents test * try to speed up git install on WOA * disable problematic test on WOA * remove debugging * remove debugging from choco installs * Revert "disable problematic test on WOA" This reverts commit e060fb0839b73d53cfde1f8acdca634f8e267937. * Revert "remove debugging" This reverts commit f18dd8b1a555f56bb06d0ea996a6eff31b424bf1. * run against all the tests in the failing shard * don't run visibility tests first * remove debugging * 3 is a magic number * Revert "3 is a magic number" This reverts commit 36b91ccf9f03a4b34230cd69ceca482f7d8428c1. * match what Appveyor runs exactly * Revert "match what Appveyor runs exactly" This reverts commit 7260dd432216c62696e4bc864930f17c857eabbe. * chore: sort files alphabetically * find out what spec is leaving stuff open * chore: Checkout PR HEAD commit instead of merge commit * try using app.exit instead of process.exit * test: cleanup BrowserWindows and webContents * Revert "chore: sort files alphabetically" This reverts commit d9e217ffb1522076e150fce9e43a31bf56716acb. * chore: use win32 to match process.platform Needed for build-tools to download from PRs * chore: cache yarn dir * fixup cache yarn * fixup use win32 to match process.platform * fixup use win32 to match process.platform * fixup cache yarn * Add debugging for WOA hang * Add debugging for failing keyboard lock test * Revert "Add debugging for WOA hang" This reverts commit 8df03d568d15a269e4026140d1158e8cdf551dec. * try using process.kill * add more debugging to keyboard.lock test * Revert "Add debugging for failing keyboard lock test" * remove debugging * test: disable keyboard.lock on Windows * test: disable fullscreen tests on Windows * test: only force test suite exit on WOA * fixup test: only force test suite exit on WOA * cleanup tests * extract yarn caching/install to action * try using bash to run windows tests * remove left over debugging * standardize on 'win' for Windows builds * use 'x86' for arch for manifest files * fixup try using bash to run windows tests * fixup use 'x86' for arch for manifest files * standardize on 'win' for Windows builds * fixup use 'x86' for arch for manifest files * fixup try using bash to run windows tests --------- Co-authored-by: John Kleinschmidt <jkleinsc@electronjs.org> Co-authored-by: Charles Kerr <charles@charleskerr.com> (cherry picked from commitbe1a3dce83) * fixup checkout-macos * fixup gn check * fixup electron_chromedriver_zip build * fixup checkout-macos * Revert "fixup electron_chromedriver_zip build" This reverts commit d4657bac566288cd9742895b4b003e41518d89d6. * clear out reproxy_tmp after build * fixup gclient.diff patch * Clear out reproxy_tmp in its own step * Reapply "fixup electron_chromedriver_zip build" This reverts commit af1b06d98991d621611e68329a5d678e88c2eb0a. * clear out reproxy_tmp later * fixup gclient.diff patch * fixup gclient.diff patch * Use powershell to clear out reproxy_tmp * Use checked out depot_tools for build tools * chore: update build tools to correct sha * fixup Use powershell to clear out reproxy_tmp * fixup Use powershell to clear out reproxy_tmp * fixup Use powershell to clear out reproxy_tmp * try setting LongPathsEnabled in its own step * try just setting LongPathsEnabled * test: disable fullscreen test on GHA * test: fixup flaky visibility test (#43064) (cherry picked from commit1a6e651844) * test: cleanup webcontents in visibility tests * test: take screenshots to debug visibility tests * temporarily disable openExternal spec * test: close edge after shell.openExternal * Revert "test: take screenshots to debug visibility tests" This reverts commit 494c6fc203a87e9af5981e82bd08fa7664f0c957. * test: close edge async after shell.openExternal * Reapply "test: take screenshots to debug visibility tests" This reverts commit b4c691443bf63b6e57cb6ddcb3984c4b31e215e2. * Revert "Reapply "test: take screenshots to debug visibility tests"" This reverts commit 09177041284c374657ef1831bd3a59ab3a8a63da. * test: close edge sync after shell.openExternal --------- Co-authored-by: Samuel Attard <sam@electronjs.org>
685 lines
24 KiB
TypeScript
685 lines
24 KiB
TypeScript
import { ipcMain, protocol, session, WebContents, webContents } from 'electron/main';
|
|
|
|
import { expect } from 'chai';
|
|
import * as WebSocket from 'ws';
|
|
|
|
import { once } from 'node:events';
|
|
import * as fs from 'node:fs';
|
|
import * as http from 'node:http';
|
|
import * as http2 from 'node:http2';
|
|
import { Socket } from 'node:net';
|
|
import * as path from 'node:path';
|
|
import * as qs from 'node:querystring';
|
|
import { ReadableStream } from 'node:stream/web';
|
|
import * as url from 'node:url';
|
|
|
|
import { listen, defer } from './lib/spec-helpers';
|
|
|
|
const fixturesPath = path.resolve(__dirname, 'fixtures');
|
|
|
|
describe('webRequest module', () => {
|
|
const ses = session.defaultSession;
|
|
const server = http.createServer((req, res) => {
|
|
if (req.url === '/serverRedirect') {
|
|
res.statusCode = 301;
|
|
res.setHeader('Location', 'http://' + req.rawHeaders[1]);
|
|
res.end();
|
|
} else if (req.url === '/contentDisposition') {
|
|
res.writeHead(200, [
|
|
'content-disposition',
|
|
Buffer.from('attachment; filename=aa中aa.txt').toString('binary')
|
|
]);
|
|
const content = req.url;
|
|
res.end(content);
|
|
} else {
|
|
res.setHeader('Custom', ['Header']);
|
|
let content = req.url;
|
|
if (req.headers.accept === '*/*;test/header') {
|
|
content += 'header/received';
|
|
}
|
|
if (req.headers.origin === 'http://new-origin') {
|
|
content += 'new/origin';
|
|
}
|
|
res.end(content);
|
|
}
|
|
});
|
|
let defaultURL: string;
|
|
let http2URL: string;
|
|
|
|
const certPath = path.join(fixturesPath, 'certificates');
|
|
const h2server = http2.createSecureServer({
|
|
key: fs.readFileSync(path.join(certPath, 'server.key')),
|
|
cert: fs.readFileSync(path.join(certPath, 'server.pem'))
|
|
}, async (req, res) => {
|
|
if (req.method === 'POST') {
|
|
const chunks = [];
|
|
for await (const chunk of req) chunks.push(chunk);
|
|
res.end(Buffer.concat(chunks).toString('utf8'));
|
|
} else {
|
|
res.end('<html></html>');
|
|
}
|
|
});
|
|
|
|
before(async () => {
|
|
protocol.registerStringProtocol('cors', (req, cb) => cb(''));
|
|
defaultURL = (await listen(server)).url + '/';
|
|
http2URL = (await listen(h2server)).url + '/';
|
|
});
|
|
|
|
after(() => {
|
|
server.close();
|
|
h2server.close();
|
|
protocol.unregisterProtocol('cors');
|
|
});
|
|
|
|
let contents: WebContents;
|
|
// NB. sandbox: true is used because it makes navigations much (~8x) faster.
|
|
before(async () => {
|
|
contents = (webContents as typeof ElectronInternal.WebContents).create({ sandbox: true });
|
|
// const w = new BrowserWindow({webPreferences: {sandbox: true}})
|
|
// contents = w.webContents
|
|
await contents.loadFile(path.join(fixturesPath, 'pages', 'fetch.html'));
|
|
});
|
|
after(() => contents.destroy());
|
|
|
|
async function ajax (url: string, options = {}) {
|
|
return contents.executeJavaScript(`ajax("${url}", ${JSON.stringify(options)})`);
|
|
}
|
|
|
|
describe('webRequest.onBeforeRequest', () => {
|
|
afterEach(() => {
|
|
ses.webRequest.onBeforeRequest(null);
|
|
});
|
|
|
|
const cancel = (details: Electron.OnBeforeRequestListenerDetails, callback: (response: Electron.CallbackResponse) => void) => {
|
|
callback({ cancel: true });
|
|
};
|
|
|
|
it('can cancel the request', async () => {
|
|
ses.webRequest.onBeforeRequest(cancel);
|
|
await expect(ajax(defaultURL)).to.eventually.be.rejected();
|
|
});
|
|
|
|
it('can filter URLs', async () => {
|
|
const filter = { urls: [defaultURL + 'filter/*'] };
|
|
ses.webRequest.onBeforeRequest(filter, cancel);
|
|
const { data } = await ajax(`${defaultURL}nofilter/test`);
|
|
expect(data).to.equal('/nofilter/test');
|
|
await expect(ajax(`${defaultURL}filter/test`)).to.eventually.be.rejected();
|
|
});
|
|
|
|
it('can filter URLs and types', async () => {
|
|
const filter1: Electron.WebRequestFilter = { urls: [defaultURL + 'filter/*'], types: ['xhr'] };
|
|
ses.webRequest.onBeforeRequest(filter1, cancel);
|
|
const { data } = await ajax(`${defaultURL}nofilter/test`);
|
|
expect(data).to.equal('/nofilter/test');
|
|
await expect(ajax(`${defaultURL}filter/test`)).to.eventually.be.rejected();
|
|
|
|
const filter2: Electron.WebRequestFilter = { urls: [defaultURL + 'filter/*'], types: ['stylesheet'] };
|
|
ses.webRequest.onBeforeRequest(filter2, cancel);
|
|
expect((await ajax(`${defaultURL}nofilter/test`)).data).to.equal('/nofilter/test');
|
|
expect((await ajax(`${defaultURL}filter/test`)).data).to.equal('/filter/test');
|
|
});
|
|
|
|
it('receives details object', async () => {
|
|
ses.webRequest.onBeforeRequest((details, callback) => {
|
|
expect(details.id).to.be.a('number');
|
|
expect(details.timestamp).to.be.a('number');
|
|
expect(details.webContentsId).to.be.a('number');
|
|
expect(details.webContents).to.be.an('object');
|
|
expect(details.webContents!.id).to.equal(details.webContentsId);
|
|
expect(details.frame).to.be.an('object');
|
|
expect(details.url).to.be.a('string').that.is.equal(defaultURL);
|
|
expect(details.method).to.be.a('string').that.is.equal('GET');
|
|
expect(details.resourceType).to.be.a('string').that.is.equal('xhr');
|
|
expect(details.uploadData).to.be.undefined();
|
|
callback({});
|
|
});
|
|
const { data } = await ajax(defaultURL);
|
|
expect(data).to.equal('/');
|
|
});
|
|
|
|
it('receives post data in details object', async () => {
|
|
const postData = {
|
|
name: 'post test',
|
|
type: 'string'
|
|
};
|
|
ses.webRequest.onBeforeRequest((details, callback) => {
|
|
expect(details.url).to.equal(defaultURL);
|
|
expect(details.method).to.equal('POST');
|
|
expect(details.uploadData).to.have.lengthOf(1);
|
|
const data = qs.parse(details.uploadData[0].bytes.toString());
|
|
expect(data).to.deep.equal(postData);
|
|
callback({ cancel: true });
|
|
});
|
|
await expect(ajax(defaultURL, {
|
|
method: 'POST',
|
|
body: qs.stringify(postData)
|
|
})).to.eventually.be.rejected();
|
|
});
|
|
|
|
it('can redirect the request', async () => {
|
|
ses.webRequest.onBeforeRequest((details, callback) => {
|
|
if (details.url === defaultURL) {
|
|
callback({ redirectURL: `${defaultURL}redirect` });
|
|
} else {
|
|
callback({});
|
|
}
|
|
});
|
|
const { data } = await ajax(defaultURL);
|
|
expect(data).to.equal('/redirect');
|
|
});
|
|
|
|
it('does not crash for redirects', async () => {
|
|
ses.webRequest.onBeforeRequest((details, callback) => {
|
|
callback({ cancel: false });
|
|
});
|
|
await ajax(defaultURL + 'serverRedirect');
|
|
await ajax(defaultURL + 'serverRedirect');
|
|
});
|
|
|
|
it('works with file:// protocol', async () => {
|
|
ses.webRequest.onBeforeRequest((details, callback) => {
|
|
callback({ cancel: true });
|
|
});
|
|
const fileURL = url.format({
|
|
pathname: path.join(fixturesPath, 'blank.html').replaceAll('\\', '/'),
|
|
protocol: 'file',
|
|
slashes: true
|
|
});
|
|
await expect(ajax(fileURL)).to.eventually.be.rejected();
|
|
});
|
|
|
|
it('can handle a streaming upload', async () => {
|
|
// Streaming fetch uploads are only supported on HTTP/2, which is only
|
|
// supported over TLS, so...
|
|
session.defaultSession.setCertificateVerifyProc((req, cb) => cb(0));
|
|
defer(() => {
|
|
session.defaultSession.setCertificateVerifyProc(null);
|
|
});
|
|
const contents = (webContents as typeof ElectronInternal.WebContents).create({ sandbox: true });
|
|
defer(() => contents.close());
|
|
await contents.loadURL(http2URL);
|
|
|
|
ses.webRequest.onBeforeRequest((details, callback) => {
|
|
callback({});
|
|
});
|
|
|
|
const result = await contents.executeJavaScript(`
|
|
const stream = new ReadableStream({
|
|
async start(controller) {
|
|
controller.enqueue('hello world');
|
|
controller.close();
|
|
},
|
|
}).pipeThrough(new TextEncoderStream());
|
|
fetch("${http2URL}", {
|
|
method: 'POST',
|
|
body: stream,
|
|
duplex: 'half',
|
|
}).then(r => r.text())
|
|
`);
|
|
expect(result).to.equal('hello world');
|
|
});
|
|
|
|
it('can handle a streaming upload if the uploadData is read', async () => {
|
|
// Streaming fetch uploads are only supported on HTTP/2, which is only
|
|
// supported over TLS, so...
|
|
session.defaultSession.setCertificateVerifyProc((req, cb) => cb(0));
|
|
defer(() => {
|
|
session.defaultSession.setCertificateVerifyProc(null);
|
|
});
|
|
const contents = (webContents as typeof ElectronInternal.WebContents).create({ sandbox: true });
|
|
defer(() => contents.close());
|
|
await contents.loadURL(http2URL);
|
|
|
|
function makeStreamFromPipe (pipe: any): ReadableStream {
|
|
const buf = new Uint8Array(1024 * 1024 /* 1 MB */);
|
|
return new ReadableStream({
|
|
async pull (controller) {
|
|
try {
|
|
const rv = await pipe.read(buf);
|
|
if (rv > 0) {
|
|
controller.enqueue(buf.subarray(0, rv));
|
|
} else {
|
|
controller.close();
|
|
}
|
|
} catch (e) {
|
|
controller.error(e);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
ses.webRequest.onBeforeRequest(async (details, callback) => {
|
|
const chunks = [];
|
|
for await (const chunk of makeStreamFromPipe((details.uploadData[0] as any).body)) { chunks.push(chunk); }
|
|
callback({});
|
|
});
|
|
|
|
const result = await contents.executeJavaScript(`
|
|
const stream = new ReadableStream({
|
|
async start(controller) {
|
|
controller.enqueue('hello world');
|
|
controller.close();
|
|
},
|
|
}).pipeThrough(new TextEncoderStream());
|
|
fetch("${http2URL}", {
|
|
method: 'POST',
|
|
body: stream,
|
|
duplex: 'half',
|
|
}).then(r => r.text())
|
|
`);
|
|
|
|
// NOTE: since the upload stream was consumed by the onBeforeRequest
|
|
// handler, it can't be used again to upload to the actual server.
|
|
// This is a limitation of the WebRequest API.
|
|
expect(result).to.equal('');
|
|
});
|
|
});
|
|
|
|
describe('webRequest.onBeforeSendHeaders', () => {
|
|
afterEach(() => {
|
|
ses.webRequest.onBeforeSendHeaders(null);
|
|
ses.webRequest.onSendHeaders(null);
|
|
});
|
|
|
|
it('receives details object', async () => {
|
|
ses.webRequest.onBeforeSendHeaders((details, callback) => {
|
|
expect(details.requestHeaders).to.be.an('object');
|
|
expect(details.requestHeaders['Foo.Bar']).to.equal('baz');
|
|
callback({});
|
|
});
|
|
const { data } = await ajax(defaultURL, { headers: { 'Foo.Bar': 'baz' } });
|
|
expect(data).to.equal('/');
|
|
});
|
|
|
|
it('can change the request headers', async () => {
|
|
ses.webRequest.onBeforeSendHeaders((details, callback) => {
|
|
const requestHeaders = details.requestHeaders;
|
|
requestHeaders.Accept = '*/*;test/header';
|
|
callback({ requestHeaders });
|
|
});
|
|
const { data } = await ajax(defaultURL);
|
|
expect(data).to.equal('/header/received');
|
|
});
|
|
|
|
it('can change the request headers on a custom protocol redirect', async () => {
|
|
protocol.registerStringProtocol('no-cors', (req, callback) => {
|
|
if (req.url === 'no-cors://fake-host/redirect') {
|
|
callback({
|
|
statusCode: 302,
|
|
headers: {
|
|
Location: 'no-cors://fake-host'
|
|
}
|
|
});
|
|
} else {
|
|
let content = '';
|
|
if (req.headers.Accept === '*/*;test/header') {
|
|
content = 'header-received';
|
|
}
|
|
callback(content);
|
|
}
|
|
});
|
|
|
|
// Note that we need to do navigation every time after a protocol is
|
|
// registered or unregistered, otherwise the new protocol won't be
|
|
// recognized by current page when NetworkService is used.
|
|
await contents.loadFile(path.join(__dirname, 'fixtures', 'pages', 'fetch.html'));
|
|
|
|
try {
|
|
ses.webRequest.onBeforeSendHeaders((details, callback) => {
|
|
const requestHeaders = details.requestHeaders;
|
|
requestHeaders.Accept = '*/*;test/header';
|
|
callback({ requestHeaders });
|
|
});
|
|
const { data } = await ajax('no-cors://fake-host/redirect');
|
|
expect(data).to.equal('header-received');
|
|
} finally {
|
|
protocol.unregisterProtocol('no-cors');
|
|
}
|
|
});
|
|
|
|
it('can change request origin', async () => {
|
|
ses.webRequest.onBeforeSendHeaders((details, callback) => {
|
|
const requestHeaders = details.requestHeaders;
|
|
requestHeaders.Origin = 'http://new-origin';
|
|
callback({ requestHeaders });
|
|
});
|
|
const { data } = await ajax(defaultURL);
|
|
expect(data).to.equal('/new/origin');
|
|
});
|
|
|
|
it('can capture CORS requests', async () => {
|
|
let called = false;
|
|
ses.webRequest.onBeforeSendHeaders((details, callback) => {
|
|
called = true;
|
|
callback({ requestHeaders: details.requestHeaders });
|
|
});
|
|
await ajax('cors://host');
|
|
expect(called).to.be.true();
|
|
});
|
|
|
|
it('resets the whole headers', async () => {
|
|
const requestHeaders = {
|
|
Test: 'header'
|
|
};
|
|
ses.webRequest.onBeforeSendHeaders((details, callback) => {
|
|
callback({ requestHeaders });
|
|
});
|
|
ses.webRequest.onSendHeaders((details) => {
|
|
expect(details.requestHeaders).to.deep.equal(requestHeaders);
|
|
});
|
|
await ajax(defaultURL);
|
|
});
|
|
|
|
it('leaves headers unchanged when no requestHeaders in callback', async () => {
|
|
let originalRequestHeaders: Record<string, string>;
|
|
ses.webRequest.onBeforeSendHeaders((details, callback) => {
|
|
originalRequestHeaders = details.requestHeaders;
|
|
callback({});
|
|
});
|
|
ses.webRequest.onSendHeaders((details) => {
|
|
expect(details.requestHeaders).to.deep.equal(originalRequestHeaders);
|
|
});
|
|
await ajax(defaultURL);
|
|
});
|
|
|
|
it('works with file:// protocol', async () => {
|
|
const requestHeaders = {
|
|
Test: 'header'
|
|
};
|
|
let onSendHeadersCalled = false;
|
|
ses.webRequest.onBeforeSendHeaders((details, callback) => {
|
|
callback({ requestHeaders });
|
|
});
|
|
ses.webRequest.onSendHeaders((details) => {
|
|
expect(details.requestHeaders).to.deep.equal(requestHeaders);
|
|
onSendHeadersCalled = true;
|
|
});
|
|
await ajax(url.format({
|
|
pathname: path.join(fixturesPath, 'blank.html').replaceAll('\\', '/'),
|
|
protocol: 'file',
|
|
slashes: true
|
|
}));
|
|
expect(onSendHeadersCalled).to.be.true();
|
|
});
|
|
});
|
|
|
|
describe('webRequest.onSendHeaders', () => {
|
|
afterEach(() => {
|
|
ses.webRequest.onSendHeaders(null);
|
|
});
|
|
|
|
it('receives details object', async () => {
|
|
ses.webRequest.onSendHeaders((details) => {
|
|
expect(details.requestHeaders).to.be.an('object');
|
|
});
|
|
const { data } = await ajax(defaultURL);
|
|
expect(data).to.equal('/');
|
|
});
|
|
});
|
|
|
|
describe('webRequest.onHeadersReceived', () => {
|
|
afterEach(() => {
|
|
ses.webRequest.onHeadersReceived(null);
|
|
});
|
|
|
|
it('receives details object', async () => {
|
|
ses.webRequest.onHeadersReceived((details, callback) => {
|
|
expect(details.statusLine).to.equal('HTTP/1.1 200 OK');
|
|
expect(details.statusCode).to.equal(200);
|
|
expect(details.responseHeaders!.Custom).to.deep.equal(['Header']);
|
|
callback({});
|
|
});
|
|
const { data } = await ajax(defaultURL);
|
|
expect(data).to.equal('/');
|
|
});
|
|
|
|
it('can change the response header', async () => {
|
|
ses.webRequest.onHeadersReceived((details, callback) => {
|
|
const responseHeaders = details.responseHeaders!;
|
|
responseHeaders.Custom = ['Changed'] as any;
|
|
callback({ responseHeaders });
|
|
});
|
|
const { headers } = await ajax(defaultURL);
|
|
expect(headers).to.to.have.property('custom', 'Changed');
|
|
});
|
|
|
|
it('can change response origin', async () => {
|
|
ses.webRequest.onHeadersReceived((details, callback) => {
|
|
const responseHeaders = details.responseHeaders!;
|
|
responseHeaders['access-control-allow-origin'] = ['http://new-origin'] as any;
|
|
callback({ responseHeaders });
|
|
});
|
|
const { headers } = await ajax(defaultURL);
|
|
expect(headers).to.to.have.property('access-control-allow-origin', 'http://new-origin');
|
|
});
|
|
|
|
it('can change headers of CORS responses', async () => {
|
|
ses.webRequest.onHeadersReceived((details, callback) => {
|
|
const responseHeaders = details.responseHeaders!;
|
|
responseHeaders.Custom = ['Changed'] as any;
|
|
callback({ responseHeaders });
|
|
});
|
|
const { headers } = await ajax('cors://host');
|
|
expect(headers).to.to.have.property('custom', 'Changed');
|
|
});
|
|
|
|
it('does not change header by default', async () => {
|
|
ses.webRequest.onHeadersReceived((details, callback) => {
|
|
callback({});
|
|
});
|
|
const { data, headers } = await ajax(defaultURL);
|
|
expect(headers).to.to.have.property('custom', 'Header');
|
|
expect(data).to.equal('/');
|
|
});
|
|
|
|
it('does not change content-disposition header by default', async () => {
|
|
ses.webRequest.onHeadersReceived((details, callback) => {
|
|
expect(details.responseHeaders!['content-disposition']).to.deep.equal(['attachment; filename=aa中aa.txt']);
|
|
callback({});
|
|
});
|
|
const { data, headers } = await ajax(defaultURL + 'contentDisposition');
|
|
const disposition = Buffer.from('attachment; filename=aa中aa.txt').toString('binary');
|
|
expect(headers).to.to.have.property('content-disposition', disposition);
|
|
expect(data).to.equal('/contentDisposition');
|
|
});
|
|
|
|
it('follows server redirect', async () => {
|
|
ses.webRequest.onHeadersReceived((details, callback) => {
|
|
const responseHeaders = details.responseHeaders;
|
|
callback({ responseHeaders });
|
|
});
|
|
const { headers } = await ajax(defaultURL + 'serverRedirect');
|
|
expect(headers).to.to.have.property('custom', 'Header');
|
|
});
|
|
|
|
it('can change the header status', async () => {
|
|
ses.webRequest.onHeadersReceived((details, callback) => {
|
|
const responseHeaders = details.responseHeaders;
|
|
callback({
|
|
responseHeaders,
|
|
statusLine: 'HTTP/1.1 404 Not Found'
|
|
});
|
|
});
|
|
const { headers } = await ajax(defaultURL);
|
|
expect(headers).to.to.have.property('custom', 'Header');
|
|
});
|
|
});
|
|
|
|
describe('webRequest.onResponseStarted', () => {
|
|
afterEach(() => {
|
|
ses.webRequest.onResponseStarted(null);
|
|
});
|
|
|
|
it('receives details object', async () => {
|
|
ses.webRequest.onResponseStarted((details) => {
|
|
expect(details.fromCache).to.be.a('boolean');
|
|
expect(details.statusLine).to.equal('HTTP/1.1 200 OK');
|
|
expect(details.statusCode).to.equal(200);
|
|
expect(details.responseHeaders!.Custom).to.deep.equal(['Header']);
|
|
});
|
|
const { data, headers } = await ajax(defaultURL);
|
|
expect(headers).to.to.have.property('custom', 'Header');
|
|
expect(data).to.equal('/');
|
|
});
|
|
});
|
|
|
|
describe('webRequest.onBeforeRedirect', () => {
|
|
afterEach(() => {
|
|
ses.webRequest.onBeforeRedirect(null);
|
|
ses.webRequest.onBeforeRequest(null);
|
|
});
|
|
|
|
it('receives details object', async () => {
|
|
const redirectURL = defaultURL + 'redirect';
|
|
ses.webRequest.onBeforeRequest((details, callback) => {
|
|
if (details.url === defaultURL) {
|
|
callback({ redirectURL });
|
|
} else {
|
|
callback({});
|
|
}
|
|
});
|
|
ses.webRequest.onBeforeRedirect((details) => {
|
|
expect(details.fromCache).to.be.a('boolean');
|
|
expect(details.statusLine).to.equal('HTTP/1.1 307 Internal Redirect');
|
|
expect(details.statusCode).to.equal(307);
|
|
expect(details.redirectURL).to.equal(redirectURL);
|
|
});
|
|
const { data } = await ajax(defaultURL);
|
|
expect(data).to.equal('/redirect');
|
|
});
|
|
});
|
|
|
|
describe('webRequest.onCompleted', () => {
|
|
afterEach(() => {
|
|
ses.webRequest.onCompleted(null);
|
|
});
|
|
|
|
it('receives details object', async () => {
|
|
ses.webRequest.onCompleted((details) => {
|
|
expect(details.fromCache).to.be.a('boolean');
|
|
expect(details.statusLine).to.equal('HTTP/1.1 200 OK');
|
|
expect(details.statusCode).to.equal(200);
|
|
});
|
|
const { data } = await ajax(defaultURL);
|
|
expect(data).to.equal('/');
|
|
});
|
|
});
|
|
|
|
describe('webRequest.onErrorOccurred', () => {
|
|
afterEach(() => {
|
|
ses.webRequest.onErrorOccurred(null);
|
|
ses.webRequest.onBeforeRequest(null);
|
|
});
|
|
|
|
it('receives details object', async () => {
|
|
ses.webRequest.onBeforeRequest((details, callback) => {
|
|
callback({ cancel: true });
|
|
});
|
|
ses.webRequest.onErrorOccurred((details) => {
|
|
expect(details.error).to.equal('net::ERR_BLOCKED_BY_CLIENT');
|
|
});
|
|
await expect(ajax(defaultURL)).to.eventually.be.rejected();
|
|
});
|
|
});
|
|
|
|
describe('WebSocket connections', () => {
|
|
it('can be proxyed', async () => {
|
|
// Setup server.
|
|
const reqHeaders : { [key: string] : any } = {};
|
|
let server = http.createServer((req, res) => {
|
|
reqHeaders[req.url!] = req.headers;
|
|
res.setHeader('foo1', 'bar1');
|
|
res.end('ok');
|
|
});
|
|
let wss = new WebSocket.Server({ noServer: true });
|
|
wss.on('connection', function connection (ws) {
|
|
ws.on('message', function incoming (message) {
|
|
if (message === 'foo') {
|
|
ws.send('bar');
|
|
}
|
|
});
|
|
});
|
|
server.on('upgrade', function upgrade (request, socket, head) {
|
|
const pathname = new URL(request.url!, `http://${request.headers.host}`).pathname;
|
|
if (pathname === '/websocket') {
|
|
reqHeaders[request.url!] = request.headers;
|
|
wss.handleUpgrade(request, socket as Socket, head, function done (ws) {
|
|
wss.emit('connection', ws, request);
|
|
});
|
|
}
|
|
});
|
|
|
|
// Start server.
|
|
const { port } = await listen(server);
|
|
|
|
// Use a separate session for testing.
|
|
const ses = session.fromPartition('WebRequestWebSocket');
|
|
|
|
// Setup listeners.
|
|
const receivedHeaders : { [key: string] : any } = {};
|
|
ses.webRequest.onBeforeSendHeaders((details, callback) => {
|
|
details.requestHeaders.foo = 'bar';
|
|
callback({ requestHeaders: details.requestHeaders });
|
|
});
|
|
ses.webRequest.onHeadersReceived((details, callback) => {
|
|
const pathname = new URL(details.url).pathname;
|
|
receivedHeaders[pathname] = details.responseHeaders;
|
|
callback({ cancel: false });
|
|
});
|
|
ses.webRequest.onResponseStarted((details) => {
|
|
if (details.url.startsWith('ws://')) {
|
|
expect(details.responseHeaders!.Connection[0]).be.equal('Upgrade');
|
|
} else if (details.url.startsWith('http')) {
|
|
expect(details.responseHeaders!.foo1[0]).be.equal('bar1');
|
|
}
|
|
});
|
|
ses.webRequest.onSendHeaders((details) => {
|
|
if (details.url.startsWith('ws://')) {
|
|
expect(details.requestHeaders.foo).be.equal('bar');
|
|
expect(details.requestHeaders.Upgrade).be.equal('websocket');
|
|
} else if (details.url.startsWith('http')) {
|
|
expect(details.requestHeaders.foo).be.equal('bar');
|
|
}
|
|
});
|
|
ses.webRequest.onCompleted((details) => {
|
|
if (details.url.startsWith('ws://')) {
|
|
expect(details.error).be.equal('net::ERR_WS_UPGRADE');
|
|
} else if (details.url.startsWith('http')) {
|
|
expect(details.error).be.equal('net::OK');
|
|
}
|
|
});
|
|
|
|
const contents = (webContents as typeof ElectronInternal.WebContents).create({
|
|
session: ses,
|
|
nodeIntegration: true,
|
|
webSecurity: false,
|
|
contextIsolation: false
|
|
});
|
|
|
|
// Cleanup.
|
|
defer(() => {
|
|
contents.destroy();
|
|
server.close();
|
|
server = null as unknown as http.Server;
|
|
wss.close();
|
|
wss = null as unknown as WebSocket.Server;
|
|
ses.webRequest.onBeforeRequest(null);
|
|
ses.webRequest.onBeforeSendHeaders(null);
|
|
ses.webRequest.onHeadersReceived(null);
|
|
ses.webRequest.onResponseStarted(null);
|
|
ses.webRequest.onSendHeaders(null);
|
|
ses.webRequest.onCompleted(null);
|
|
});
|
|
|
|
contents.loadFile(path.join(fixturesPath, 'api', 'webrequest.html'), { query: { port: `${port}` } });
|
|
await once(ipcMain, 'websocket-success');
|
|
|
|
expect(receivedHeaders['/websocket'].Upgrade[0]).to.equal('websocket');
|
|
expect(receivedHeaders['/'].foo1[0]).to.equal('bar1');
|
|
expect(reqHeaders['/websocket'].foo).to.equal('bar');
|
|
expect(reqHeaders['/'].foo).to.equal('bar');
|
|
});
|
|
});
|
|
});
|