Skip to content

expose frozen original headers #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
greim wants to merge 1 commit into
base: master
Choose a base branch
from
Open

expose frozen original headers #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/body.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import ParamReader from './param-reader'
import BufferReader from './buffer-reader'
import zlib from 'zlib'
import { EventEmitter } from 'events'
import _ from 'lodash'

export default class Body extends EventEmitter {

Expand Down Expand Up @@ -84,6 +85,22 @@ export default class Body extends EventEmitter {

// -------------------------------------------------

get headers() {
return this._getRawDataItem('headers')
}

set headers(headers) {
this._setRawDataItem('headers', _.extend({}, headers))
}

// -------------------------------------------------

get origHeaders() {
return this._getRawDataItem('origHeaders')
}

// -------------------------------------------------

slow(opts) {
if (opts) {
this._setRawDataItem('slow', {
Expand Down
76 changes: 34 additions & 42 deletions src/request.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ export default class Request extends Body {
/**
* Getter/setter for HTTP protocol, e.g. 'http:'
*/
get protocol(){
get protocol() {
return this._getRawDataItem('protocol')
}

set protocol(protocol){
set protocol(protocol) {
if (!validProtocols.hasOwnProperty(protocol)) {
throw new Error('invalid protocol: ' + protocol) // TODO: test this
}
Expand All @@ -51,12 +51,12 @@ export default class Request extends Body {
/**
* Getter/setter for host name. Does not incude port.
*/
get hostname(){
get hostname() {
return this._getRawDataItem('hostname')
}

set hostname(hostname){
if (!hostname){
set hostname(hostname) {
if (!hostname) {
throw new Error('invalid hostname: ' + hostname) // TODO: test this
}
this._setRawDataItem('hostname', hostname)
Expand All @@ -65,16 +65,16 @@ export default class Request extends Body {
/**
* Getter/setter for port.
*/
get port(){
get port() {
return this._getRawDataItem('port')
}

set port(port){
set port(port) {
if (port === undefined) {
this._setRawDataItem('port', undefined)
} else {
let parsedPort = parseInt(port)
if (!parsedPort){
if (!parsedPort) {
throw new Error('invalid port: ' + port) // TODO: test this
}
this._setRawDataItem('port', parsedPort)
Expand All @@ -84,12 +84,12 @@ export default class Request extends Body {
/**
* Getter/setter for HTTP method.
*/
get method(){
get method() {
return this._getRawDataItem('method')
}

set method(method){
if (!method){
set method(method) {
if (!method) {
throw new Error('invalid method') // TODO: test this
}
this._setRawDataItem('method', method.toUpperCase())
Expand All @@ -98,30 +98,19 @@ export default class Request extends Body {
/**
* Getter/setter for URL. Root-relative.
*/
get url(){
get url() {
return this._getRawDataItem('url')
}

set url(aUrl){
if (!/^\//.test(aUrl)){
set url(aUrl) {
if (!/^\//.test(aUrl)) {
throw new Error('invalid url, must start with /') // TODO: test this
}
this._setRawDataItem('url', aUrl)
}

/**
* Getter/setter for HTTP request header object.
*/
get headers(){
return this._getRawDataItem('headers')
}

set headers(headers){
this._setRawDataItem('headers', _.extend({}, headers))
}

fullUrl(u){
if (u){
fullUrl(u) {
if (u) {
let purl = url.parse(u)
if (purl.protocol) { this.protocol = purl.protocol }
if (purl.hostname) { this.hostname = purl.hostname }
Expand All @@ -139,27 +128,29 @@ export default class Request extends Body {
}
}

_setHttpSource(inReq, reverse){
_setHttpSource(inReq, reverse) {
const origHeaders = _.extend({}, inReq.headers)
Object.freeze(origHeaders)
let u = inReq.url
if (reverse){
if (reverse) {
u = url.resolve(reverse, u)
}
let purl = url.parse(u)
if (reverse){
if (reverse) {
inReq.headers.host = purl.host
if (!purl.protocol){
if (!purl.protocol) {
throw new Error('missing protocol on reverse proxy')
}
}
let host = (() => {
let aHost = inReq.headers.host
let result = {}
if (aHost){
if (aHost) {
let matches = aHost.match(/^([^:]+)(:([\d]+))?$/)
if (matches){
if (matches) {
result.name = matches[1]
let port = parseInt(matches[3])
if (port){
if (port) {
result.port = port
}
}
Expand All @@ -168,10 +159,11 @@ export default class Request extends Body {
})()
this.httpVersion = inReq.httpVersion
this.headers = inReq.headers
this._setRawDataItem('origHeaders', origHeaders)
this.protocol = purl.protocol || 'http:'
this.hostname = purl.hostname || host.name
let port = purl.port || host.port
if (port){
if (port) {
this.port = port
}
//this.port = purl.port || host.port || this._getDefaultPort()
Expand All @@ -184,25 +176,25 @@ export default class Request extends Body {
/**
* Returns the default port given the current protocol.
*/
_getDefaultPort(){
_getDefaultPort() {
return this.protocol === 'https:' ? 443 : 80
}

// TODO: emit debug log events for things that are changed.
_finalize(){
_finalize() {
if (nonEntityMethods.hasOwnProperty(this.method)) {
this.string = '' // TODO: test
}
if (!this._source){
if (!this._source) {
this.string = '' // TODO: test?
}

if (!this._source._isOriginal){
if (!this._source._isOriginal) {
delete this.headers['content-length']
if (typeof this._source.finalize === 'function'){
if (typeof this._source.finalize === 'function') {
this._source.finalize()
}
if (typeof this._source.size === 'function'){
if (typeof this._source.size === 'function') {
this.headers['content-length'] = this._source.size()
}
}
Expand All @@ -211,7 +203,7 @@ export default class Request extends Body {
// TODO: test
if (removeHeaders.hasOwnProperty(name)) {
delete this.headers[name]
} else if (this.headers[name] === undefined){
} else if (this.headers[name] === undefined) {
delete this.headers[name]
}
})
Expand Down
14 changes: 3 additions & 11 deletions src/response.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,21 +36,13 @@ export default class Response extends Body {
this._setRawDataItem('statusCode', code)
}

/**
* Getter/setter for HTTP response header object.
*/
get headers() {
return this._getRawDataItem('headers')
}

set headers(headers) {
this._setRawDataItem('headers', _.extend({}, headers))
}

_setHttpSource(inResp) {
const origHeaders = _.extend({}, inResp.headers)
Object.freeze(origHeaders)
this.httpVersion = inResp.httpVersion
this.statusCode = inResp.statusCode
this.headers = inResp.headers
this._setRawDataItem('origHeaders', origHeaders)
inResp._isOriginal = true
this._source = inResp
}
Expand Down
36 changes: 35 additions & 1 deletion test/request.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ function getRequestData() {
describe('Request', function() {

it('should construct', function() {
new Request()
new Request() // eslint-disable-line no-new
})

it('should accept raw data', function() {
Expand Down Expand Up @@ -99,6 +99,40 @@ describe('Request', function() {
assert.deepEqual(req.headers, data.headers)
})

it('should get original headers', function() {
let req = new Request()
let data = getRequestData()
req._setHttpSource(data)
assert.deepEqual(req.origHeaders, data.headers)
})

it('should not set original headers', function() {
let req = new Request()
let data = getRequestData()
req._setHttpSource(data)
assert.throws(() => {
req.origHeaders = {}
})
})

it('original headers are not modified', function() {
let req = new Request()
let data = getRequestData()
req._setHttpSource(data)
req.headers.foo = '1234'
assert.strictEqual(req.headers.foo, '1234')
assert.strictEqual(req.origHeaders.foo, undefined)
})

it('original headers should be frozen', function() {
let req = new Request()
let data = getRequestData()
req._setHttpSource(data)
assert.throws(() => {
req.origHeaders.foo = '2'
})
})

it('should get and set source', function() {
let req = new Request()
let data = getRequestData()
Expand Down
36 changes: 35 additions & 1 deletion test/response.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ function getResponseData(){
describe('Response', function(){

it('should construct', function(){
let resp = new Response()
new Response() // eslint-disable-line no-new
})

it('should accept raw data', function(){
Expand All @@ -39,6 +39,40 @@ describe('Response', function(){
assert.deepEqual(resp.headers, data.headers)
})

it('should get original headers', function() {
let resp = new Response()
let data = getResponseData()
resp._setHttpSource(data)
assert.deepEqual(resp.origHeaders, data.headers)
})

it('should not set original headers', function() {
let resp = new Response()
let data = getResponseData()
resp._setHttpSource(data)
assert.throws(() => {
resp.origHeaders = {}
})
})

it('original headers are not modified', function() {
let resp = new Response()
let data = getResponseData()
resp._setHttpSource(data)
resp.headers.foo = '1234'
assert.strictEqual(resp.headers.foo, '1234')
assert.strictEqual(resp.origHeaders.foo, undefined)
})

it('original headers should be frozen', function() {
let resp = new Response()
let data = getResponseData()
resp._setHttpSource(data)
assert.throws(() => {
resp.origHeaders.foo = '2'
})
})

it('should get and set status code', function(){
let resp = new Response()
resp._setHttpSource(getResponseData())
Expand Down