electron/spec-main/api-web-request-spec.ts

472 lines
16 KiB
TypeScript
Raw Normal View History

import { expect } from 'chai'
import * as http from 'http'
import * as qs from 'querystring'
import * as path from 'path'
import * as WebSocket from 'ws'
import { ipcMain, protocol, session, WebContents, webContents } from 'electron'
2019-11-01 20:37:02 +00:00
import { AddressInfo } from 'net'
import { emittedOnce } from './events-helpers'
const fixturesPath = path.resolve(__dirname, 'fixtures')
2017-11-23 22:22:43 +00:00
describe('webRequest module', () => {
const ses = session.defaultSession
const server = http.createServer((req, res) => {
2016-06-29 16:37:10 +00:00
if (req.url === '/serverRedirect') {
res.statusCode = 301
res.setHeader('Location', 'http://' + req.rawHeaders[1])
res.end()
} 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)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
let defaultURL: string
before((done) => {
protocol.registerStringProtocol('neworigin', (req, cb) => cb(''))
server.listen(0, '127.0.0.1', () => {
const port = (server.address() as AddressInfo).port
defaultURL = `http://127.0.0.1:${port}/`
2016-03-25 20:03:49 +00:00
done()
})
})
after(() => {
2016-03-25 20:03:49 +00:00
server.close()
protocol.unregisterProtocol('neworigin')
2016-03-25 20:03:49 +00:00
})
let contents: WebContents = null as unknown as WebContents
// NB. sandbox: true is used because it makes navigations much (~8x) faster.
before(async () => {
2019-11-01 20:37:02 +00:00
contents = (webContents as any).create({ sandbox: true })
await contents.loadFile(path.join(fixturesPath, 'pages', 'jquery.html'))
})
after(() => (contents as any).destroy())
async function ajax (url: string, options = {}) {
return contents.executeJavaScript(`ajax("${url}", ${JSON.stringify(options)})`)
}
describe('webRequest.onBeforeRequest', () => {
afterEach(() => {
2016-03-25 20:03:49 +00:00
ses.webRequest.onBeforeRequest(null)
})
it('can cancel the request', async () => {
ses.webRequest.onBeforeRequest((details, callback) => {
2016-02-17 01:39:11 +00:00
callback({
2016-01-12 02:40:23 +00:00
cancel: true
2016-03-25 20:03:49 +00:00
})
})
await expect(ajax(defaultURL)).to.eventually.be.rejectedWith('404')
2016-03-25 20:03:49 +00:00
})
it('can filter URLs', async () => {
const filter = { urls: [defaultURL + 'filter/*'] }
ses.webRequest.onBeforeRequest(filter, (details, callback) => {
2018-09-13 16:10:51 +00:00
callback({ cancel: true })
2016-03-25 20:03:49 +00:00
})
const { data } = await ajax(`${defaultURL}nofilter/test`)
expect(data).to.equal('/nofilter/test')
await expect(ajax(`${defaultURL}filter/test`)).to.eventually.be.rejectedWith('404')
2016-03-25 20:03:49 +00:00
})
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.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()
2016-03-25 20:03:49 +00:00
callback({})
})
const { data } = await ajax(defaultURL)
expect(data).to.equal('/')
2016-03-25 20:03:49 +00:00
})
it('receives post data in details object', async () => {
const postData = {
name: 'post test',
type: 'string'
2016-03-25 20:03:49 +00:00
}
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 })
2016-03-25 20:03:49 +00:00
})
await expect(ajax(defaultURL, {
type: 'POST',
2019-11-01 20:37:02 +00:00
data: postData
})).to.eventually.be.rejectedWith('404')
2016-03-25 20:03:49 +00:00
})
it('can redirect the request', async () => {
ses.webRequest.onBeforeRequest((details, callback) => {
2016-01-12 02:40:23 +00:00
if (details.url === defaultURL) {
callback({ redirectURL: `${defaultURL}redirect` })
2016-01-12 02:40:23 +00:00
} else {
2016-03-25 20:03:49 +00:00
callback({})
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
const { data } = await ajax(defaultURL)
expect(data).to.equal('/redirect')
2016-03-25 20:03:49 +00:00
})
it('does not crash for redirects', async () => {
ses.webRequest.onBeforeRequest((details, callback) => {
callback({ cancel: false })
})
await ajax(defaultURL + 'serverRedirect')
await ajax(defaultURL + 'serverRedirect')
})
2016-03-25 20:03:49 +00:00
})
describe('webRequest.onBeforeSendHeaders', () => {
afterEach(() => {
2016-03-25 20:03:49 +00:00
ses.webRequest.onBeforeSendHeaders(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')
2016-03-25 20:03:49 +00:00
callback({})
})
const { data } = await ajax(defaultURL, { headers: { 'Foo.Bar': 'baz' } })
expect(data).to.equal('/')
2016-03-25 20:03:49 +00:00
})
it('can change the request headers', async () => {
ses.webRequest.onBeforeSendHeaders((details, callback) => {
const requestHeaders = details.requestHeaders
2016-03-25 20:03:49 +00:00
requestHeaders.Accept = '*/*;test/header'
callback({ requestHeaders: requestHeaders })
2016-03-25 20:03:49 +00:00
})
const { data } = await ajax(defaultURL)
expect(data).to.equal('/header/received')
2016-03-25 20:03:49 +00:00
})
it('can change request origin', async () => {
ses.webRequest.onBeforeSendHeaders((details, callback) => {
const requestHeaders = details.requestHeaders
requestHeaders.Origin = 'http://new-origin'
callback({ requestHeaders: 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('neworigin://host')
expect(called).to.be.true()
})
it('resets the whole headers', async () => {
const requestHeaders = {
2016-01-12 02:40:23 +00:00
Test: 'header'
2016-03-25 20:03:49 +00:00
}
ses.webRequest.onBeforeSendHeaders((details, callback) => {
callback({ requestHeaders: requestHeaders })
2016-03-25 20:03:49 +00:00
})
ses.webRequest.onSendHeaders((details) => {
expect(details.requestHeaders).to.deep.equal(requestHeaders)
2016-03-25 20:03:49 +00:00
})
await ajax(defaultURL)
2016-03-25 20:03:49 +00:00
})
})
describe('webRequest.onSendHeaders', () => {
afterEach(() => {
2016-03-25 20:03:49 +00:00
ses.webRequest.onSendHeaders(null)
})
it('receives details object', async () => {
ses.webRequest.onSendHeaders((details) => {
expect(details.requestHeaders).to.be.an('object')
2016-03-25 20:03:49 +00:00
})
const { data } = await ajax(defaultURL)
expect(data).to.equal('/')
2016-03-25 20:03:49 +00:00
})
})
describe('webRequest.onHeadersReceived', () => {
afterEach(() => {
2016-03-25 20:03:49 +00:00
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'])
2016-03-25 20:03:49 +00:00
callback({})
})
const { data } = await ajax(defaultURL)
expect(data).to.equal('/')
2016-03-25 20:03:49 +00:00
})
it('can change the response header', async () => {
ses.webRequest.onHeadersReceived((details, callback) => {
const responseHeaders = details.responseHeaders!
responseHeaders.Custom = ['Changed'] as any
callback({ responseHeaders: responseHeaders })
2016-03-25 20:03:49 +00:00
})
const { headers } = await ajax(defaultURL)
expect(headers).to.match(/^custom: Changed$/m)
2016-03-25 20:03:49 +00:00
})
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: responseHeaders })
})
const { headers } = await ajax(defaultURL)
expect(headers).to.match(/^access-control-allow-origin: http:\/\/new-origin$/m)
})
it('can change headers of CORS responses', async () => {
ses.webRequest.onHeadersReceived((details, callback) => {
const responseHeaders = details.responseHeaders!
responseHeaders.Custom = ['Changed'] as any
callback({ responseHeaders: responseHeaders })
})
const { headers } = await ajax('neworigin://host')
expect(headers).to.match(/^custom: Changed$/m)
})
it('does not change header by default', async () => {
ses.webRequest.onHeadersReceived((details, callback) => {
2016-03-25 20:03:49 +00:00
callback({})
})
const { data, headers } = await ajax(defaultURL)
expect(headers).to.match(/^custom: Header$/m)
expect(data).to.equal('/')
2016-03-25 20:03:49 +00:00
})
it('follows server redirect', async () => {
ses.webRequest.onHeadersReceived((details, callback) => {
const responseHeaders = details.responseHeaders
callback({ responseHeaders: responseHeaders })
})
const { headers } = await ajax(defaultURL + 'serverRedirect')
expect(headers).to.match(/^custom: Header$/m)
})
2016-04-08 08:33:57 +00:00
it('can change the header status', async () => {
ses.webRequest.onHeadersReceived((details, callback) => {
const responseHeaders = details.responseHeaders
2016-04-08 08:33:57 +00:00
callback({
responseHeaders: responseHeaders,
2016-06-29 16:37:10 +00:00
statusLine: 'HTTP/1.1 404 Not Found'
2016-04-08 08:33:57 +00:00
})
})
const { headers } = await contents.executeJavaScript(`new Promise((resolve, reject) => {
const options = {
2019-11-01 20:37:02 +00:00
...${JSON.stringify({ url: defaultURL })},
success: (data, status, request) => {
reject(new Error('expected failure'))
},
error: (xhr) => {
resolve({ headers: xhr.getAllResponseHeaders() })
}
2016-04-08 08:33:57 +00:00
}
$.ajax(options)
})`)
expect(headers).to.match(/^custom: Header$/m)
2016-04-08 08:33:57 +00:00
})
2016-03-25 20:03:49 +00:00
})
describe('webRequest.onResponseStarted', () => {
afterEach(() => {
2016-03-25 20:03:49 +00:00
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'])
2016-03-25 20:03:49 +00:00
})
const { data, headers } = await ajax(defaultURL)
expect(headers).to.match(/^custom: Header$/m)
expect(data).to.equal('/')
2016-03-25 20:03:49 +00:00
})
})
describe('webRequest.onBeforeRedirect', () => {
afterEach(() => {
2016-03-25 20:03:49 +00:00
ses.webRequest.onBeforeRedirect(null)
ses.webRequest.onBeforeRequest(null)
})
it('receives details object', async () => {
const redirectURL = defaultURL + 'redirect'
ses.webRequest.onBeforeRequest((details, callback) => {
2016-01-12 02:40:23 +00:00
if (details.url === defaultURL) {
callback({ redirectURL: redirectURL })
2016-01-12 02:40:23 +00:00
} else {
2016-03-25 20:03:49 +00:00
callback({})
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
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)
2016-03-25 20:03:49 +00:00
})
const { data } = await ajax(defaultURL)
expect(data).to.equal('/redirect')
2016-03-25 20:03:49 +00:00
})
})
describe('webRequest.onCompleted', () => {
afterEach(() => {
2016-03-25 20:03:49 +00:00
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)
2016-03-25 20:03:49 +00:00
})
const { data } = await ajax(defaultURL)
expect(data).to.equal('/')
2016-03-25 20:03:49 +00:00
})
})
describe('webRequest.onErrorOccurred', () => {
afterEach(() => {
2016-03-25 20:03:49 +00:00
ses.webRequest.onErrorOccurred(null)
ses.webRequest.onBeforeRequest(null)
})
it('receives details object', async () => {
ses.webRequest.onBeforeRequest((details, callback) => {
callback({ cancel: true })
2016-03-25 20:03:49 +00:00
})
ses.webRequest.onErrorOccurred((details) => {
expect(details.error).to.equal('net::ERR_BLOCKED_BY_CLIENT')
2016-03-25 20:03:49 +00:00
})
await expect(ajax(defaultURL)).to.eventually.be.rejectedWith('404')
2016-03-25 20:03:49 +00:00
})
})
describe('WebSocket connections', () => {
it('can be proxyed', async () => {
// Setup server.
const reqHeaders : { [key: string] : any } = {}
const server = http.createServer((req, res) => {
reqHeaders[req.url!] = req.headers
res.setHeader('foo1', 'bar1')
res.end('ok')
})
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')
}
})
})
server.on('upgrade', function upgrade (request, socket, head) {
const pathname = require('url').parse(request.url).pathname
if (pathname === '/websocket') {
reqHeaders[request.url] = request.headers
wss.handleUpgrade(request, socket, head, function done (ws) {
wss.emit('connection', ws, request)
})
}
})
// Start server.
await new Promise(resolve => server.listen(0, '127.0.0.1', resolve))
const port = String((server.address() as AddressInfo).port)
// 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 = require('url').parse(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 any).create({
session: ses,
nodeIntegration: true,
webSecurity: false
})
// Cleanup.
after(() => {
contents.destroy()
server.close()
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 } })
await emittedOnce(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')
})
})
2016-03-25 20:03:49 +00:00
})