electron/spec/api-web-request-spec.js

415 lines
11 KiB
JavaScript
Raw Normal View History

/* globals $ */
2016-03-25 20:03:49 +00:00
const assert = require('assert')
const http = require('http')
const qs = require('querystring')
const remote = require('electron').remote
const session = remote.session
2016-01-12 02:40:23 +00:00
2016-03-25 20:03:49 +00:00
describe('webRequest module', function () {
var ses = session.defaultSession
var server = http.createServer(function (req, res) {
res.setHeader('Custom', ['Header'])
var content = req.url
2016-01-12 02:40:23 +00:00
if (req.headers.accept === '*/*;test/header') {
2016-03-25 20:03:49 +00:00
content += 'header/received'
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
res.end(content)
})
var defaultURL = null
2016-03-25 20:03:49 +00:00
before(function (done) {
server.listen(0, '127.0.0.1', function () {
var port = server.address().port
defaultURL = 'http://127.0.0.1:' + port + '/'
done()
})
})
2016-03-25 20:03:49 +00:00
after(function () {
server.close()
})
2016-03-25 20:03:49 +00:00
describe('webRequest.onBeforeRequest', function () {
afterEach(function () {
ses.webRequest.onBeforeRequest(null)
})
2016-03-25 20:03:49 +00:00
it('can cancel the request', function (done) {
ses.webRequest.onBeforeRequest(function (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
})
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function () {
done('unexpected success')
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function () {
done()
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
2016-03-25 20:03:49 +00:00
it('can filter URLs', function (done) {
var filter = {
2016-03-25 20:03:49 +00:00
urls: [defaultURL + 'filter/*']
}
ses.webRequest.onBeforeRequest(filter, function (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
})
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-03-25 20:03:49 +00:00
url: defaultURL + 'nofilter/test',
success: function (data) {
assert.equal(data, '/nofilter/test')
2016-02-17 01:39:11 +00:00
$.ajax({
2016-03-25 20:03:49 +00:00
url: defaultURL + 'filter/test',
success: function () {
done('unexpected success')
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function () {
done()
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
2016-03-25 20:03:49 +00:00
it('receives details object', function (done) {
ses.webRequest.onBeforeRequest(function (details, callback) {
assert.equal(typeof details.id, 'number')
assert.equal(typeof details.timestamp, 'number')
assert.equal(details.url, defaultURL)
assert.equal(details.method, 'GET')
assert.equal(details.resourceType, 'xhr')
assert(!details.uploadData)
callback({})
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data) {
assert.equal(data, '/')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
2016-03-25 20:03:49 +00:00
it('receives post data in details object', function (done) {
var postData = {
name: 'post test',
type: 'string'
2016-03-25 20:03:49 +00:00
}
ses.webRequest.onBeforeRequest(function (details, callback) {
assert.equal(details.url, defaultURL)
assert.equal(details.method, 'POST')
assert.equal(details.uploadData.length, 1)
var data = qs.parse(details.uploadData[0].bytes.toString())
assert.deepEqual(data, postData)
2016-02-17 01:39:11 +00:00
callback({
cancel: true
2016-03-25 20:03:49 +00:00
})
})
2016-02-17 01:39:11 +00:00
$.ajax({
url: defaultURL,
type: 'POST',
data: postData,
2016-03-25 20:03:49 +00:00
success: function () {},
error: function () {
done()
}
2016-03-25 20:03:49 +00:00
})
})
2016-03-25 20:03:49 +00:00
it('can redirect the request', function (done) {
ses.webRequest.onBeforeRequest(function (details, callback) {
2016-01-12 02:40:23 +00:00
if (details.url === defaultURL) {
2016-02-17 01:39:11 +00:00
callback({
2016-03-25 20:03:49 +00:00
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
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data) {
assert.equal(data, '/redirect')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
})
2016-03-25 20:03:49 +00:00
describe('webRequest.onBeforeSendHeaders', function () {
afterEach(function () {
ses.webRequest.onBeforeSendHeaders(null)
})
2016-03-25 20:03:49 +00:00
it('receives details object', function (done) {
ses.webRequest.onBeforeSendHeaders(function (details, callback) {
assert.equal(typeof details.requestHeaders, 'object')
callback({})
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data) {
assert.equal(data, '/')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
2016-03-25 20:03:49 +00:00
it('can change the request headers', function (done) {
ses.webRequest.onBeforeSendHeaders(function (details, callback) {
var requestHeaders = details.requestHeaders
requestHeaders.Accept = '*/*;test/header'
2016-02-17 01:39:11 +00:00
callback({
2016-01-12 02:40:23 +00:00
requestHeaders: requestHeaders
2016-03-25 20:03:49 +00:00
})
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data) {
assert.equal(data, '/header/received')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
2016-03-25 20:03:49 +00:00
it('resets the whole headers', function (done) {
2016-02-17 01:39:11 +00:00
var requestHeaders = {
2016-01-12 02:40:23 +00:00
Test: 'header'
2016-03-25 20:03:49 +00:00
}
ses.webRequest.onBeforeSendHeaders(function (details, callback) {
2016-02-17 01:39:11 +00:00
callback({
2016-01-12 02:40:23 +00:00
requestHeaders: requestHeaders
2016-03-25 20:03:49 +00:00
})
})
ses.webRequest.onSendHeaders(function (details) {
assert.deepEqual(details.requestHeaders, requestHeaders)
done()
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
})
2016-03-25 20:03:49 +00:00
describe('webRequest.onSendHeaders', function () {
afterEach(function () {
ses.webRequest.onSendHeaders(null)
})
2016-03-25 20:03:49 +00:00
it('receives details object', function (done) {
ses.webRequest.onSendHeaders(function (details) {
assert.equal(typeof details.requestHeaders, 'object')
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data) {
assert.equal(data, '/')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
})
2016-03-25 20:03:49 +00:00
describe('webRequest.onHeadersReceived', function () {
afterEach(function () {
ses.webRequest.onHeadersReceived(null)
})
2016-03-25 20:03:49 +00:00
it('receives details object', function (done) {
ses.webRequest.onHeadersReceived(function (details, callback) {
assert.equal(details.statusLine, 'HTTP/1.1 200 OK')
assert.equal(details.statusCode, 200)
assert.equal(details.responseHeaders['Custom'], 'Header')
callback({})
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data) {
assert.equal(data, '/')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
2016-03-25 20:03:49 +00:00
it('can change the response header', function (done) {
ses.webRequest.onHeadersReceived(function (details, callback) {
var responseHeaders = details.responseHeaders
responseHeaders['Custom'] = ['Changed']
2016-02-17 01:39:11 +00:00
callback({
2016-01-12 02:40:23 +00:00
responseHeaders: responseHeaders
2016-03-25 20:03:49 +00:00
})
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data, status, xhr) {
assert.equal(xhr.getResponseHeader('Custom'), 'Changed')
assert.equal(data, '/')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
2016-03-25 20:03:49 +00:00
it('does not change header by default', function (done) {
ses.webRequest.onHeadersReceived(function (details, callback) {
callback({})
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data, status, xhr) {
assert.equal(xhr.getResponseHeader('Custom'), 'Header')
assert.equal(data, '/')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
})
2016-03-25 20:03:49 +00:00
describe('webRequest.onResponseStarted', function () {
afterEach(function () {
ses.webRequest.onResponseStarted(null)
})
2016-03-25 20:03:49 +00:00
it('receives details object', function (done) {
ses.webRequest.onResponseStarted(function (details) {
assert.equal(typeof details.fromCache, 'boolean')
assert.equal(details.statusLine, 'HTTP/1.1 200 OK')
assert.equal(details.statusCode, 200)
assert.equal(details.responseHeaders['Custom'], 'Header')
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data, status, xhr) {
assert.equal(xhr.getResponseHeader('Custom'), 'Header')
assert.equal(data, '/')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
})
2016-03-25 20:03:49 +00:00
describe('webRequest.onBeforeRedirect', function () {
afterEach(function () {
ses.webRequest.onBeforeRedirect(null)
ses.webRequest.onBeforeRequest(null)
})
2016-03-25 20:03:49 +00:00
it('receives details object', function (done) {
var redirectURL = defaultURL + 'redirect'
ses.webRequest.onBeforeRequest(function (details, callback) {
2016-01-12 02:40:23 +00:00
if (details.url === defaultURL) {
2016-02-17 01:39:11 +00:00
callback({
2016-01-12 02:40:23 +00:00
redirectURL: redirectURL
2016-03-25 20:03:49 +00:00
})
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(function (details) {
assert.equal(typeof details.fromCache, 'boolean')
assert.equal(details.statusLine, 'HTTP/1.1 307 Internal Redirect')
assert.equal(details.statusCode, 307)
assert.equal(details.redirectURL, redirectURL)
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data) {
assert.equal(data, '/redirect')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
})
2016-03-25 20:03:49 +00:00
describe('webRequest.onCompleted', function () {
afterEach(function () {
ses.webRequest.onCompleted(null)
})
2016-03-25 20:03:49 +00:00
it('receives details object', function (done) {
ses.webRequest.onCompleted(function (details) {
assert.equal(typeof details.fromCache, 'boolean')
assert.equal(details.statusLine, 'HTTP/1.1 200 OK')
assert.equal(details.statusCode, 200)
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function (data) {
assert.equal(data, '/')
done()
2016-01-12 02:40:23 +00:00
},
2016-03-25 20:03:49 +00:00
error: function (xhr, errorType) {
done(errorType)
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
})
2016-03-25 20:03:49 +00:00
describe('webRequest.onErrorOccurred', function () {
afterEach(function () {
ses.webRequest.onErrorOccurred(null)
ses.webRequest.onBeforeRequest(null)
})
2016-03-25 20:03:49 +00:00
it('receives details object', function (done) {
ses.webRequest.onBeforeRequest(function (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
})
})
ses.webRequest.onErrorOccurred(function (details) {
assert.equal(details.error, 'net::ERR_BLOCKED_BY_CLIENT')
done()
})
2016-02-17 01:39:11 +00:00
$.ajax({
2016-01-12 02:40:23 +00:00
url: defaultURL,
2016-03-25 20:03:49 +00:00
success: function () {
done('unexpected success')
2016-01-12 02:40:23 +00:00
}
2016-03-25 20:03:49 +00:00
})
})
})
})