Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

removed headers should stay removed #3991

Closed
wants to merge 3 commits into from

5 participants

@substack

Some headers such as date, transfer-encoding, connection, and content-length are special and get inserted automatically in different circumstances. It's very scattered or impossible to tell node not to send these headers. Users might expect res.removeHeader('connection') to not send the connection header but this is not currently the case.

This patch tells node to not send the special headers when res.removeHeader() has been called with their names. This is useful in circumstances such as upgraded connections where transfer-encoding and connection should be turned off.

@aredridel

Good call.

@bnoordhuis
Owner

LGTM. Can you squash the commits and write up a pretty commit log?

@Nodejs-Jenkins

Can one of the admins verify this patch?

@isaacs isaacs was assigned
@isaacs
Owner

Landed with much surgery on 5555318.

@isaacs isaacs closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
Showing with 82 additions and 4 deletions.
  1. +24 −4 lib/http.js
  2. +58 −0 test/simple/test-http-remove-header-stays-removed.js
View
28 lib/http.js
@@ -248,6 +248,13 @@ var dateExpression = /Date/i;
var expectExpression = /Expect/i;
var continueExpression = /100-continue/i;
+var automaticHeaders = {
+ connection : true,
+ 'content-length' : true,
+ 'transfer-encoding' : true,
+ date : true
+};
+
var dateCache;
function utcDate() {
if (!dateCache) {
@@ -441,6 +448,7 @@ function OutgoingMessage() {
this.shouldKeepAlive = true;
this.useChunkedEncodingByDefault = true;
this.sendDate = false;
+ this._removedHeader = {};
this._hasBody = true;
this._trailer = '';
@@ -599,7 +607,9 @@ OutgoingMessage.prototype._storeHeader = function(firstLine, headers) {
}
// keep-alive logic
- if (sentConnectionHeader === false) {
+ if (this._removedHeader['connection']) {
+ this._last = true;
+ } else if (sentConnectionHeader === false) {
var shouldSendKeepAlive = this.shouldKeepAlive &&
(sentContentLengthHeader ||
this.useChunkedEncodingByDefault ||
@@ -613,7 +623,7 @@ OutgoingMessage.prototype._storeHeader = function(firstLine, headers) {
}
if (sentContentLengthHeader == false && sentTransferEncodingHeader == false) {
- if (this._hasBody) {
+ if (this._hasBody && !this._removedHeader['transfer-encoding']) {
if (this.useChunkedEncodingByDefault) {
messageHeader += 'Transfer-Encoding: chunked\r\n';
this.chunkedEncoding = true;
@@ -649,6 +659,10 @@ OutgoingMessage.prototype.setHeader = function(name, value) {
this._headerNames = this._headerNames || {};
this._headers[key] = value;
this._headerNames[key] = name;
+
+ if (automaticHeaders[key]) {
+ this._removedHeader[key] = false;
+ }
};
@@ -673,9 +687,15 @@ OutgoingMessage.prototype.removeHeader = function(name) {
throw new Error('Can\'t remove headers after they are sent.');
}
- if (!this._headers) return;
-
var key = name.toLowerCase();
+
+ if (key === 'date') {
+ this.sendDate = false;
+ } else if (automaticHeaders[key]) {
+ this._removedHeader[key] = true;
+ }
+
+ if (!this._headers) return;
delete this._headers[key];
delete this._headerNames[key];
};
View
58 test/simple/test-http-remove-header-stays-removed.js
@@ -0,0 +1,58 @@
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+var common = require('../common');
+var assert = require('assert');
+
+var http = require('http');
+
+var server = http.createServer(function(request, response) {
+ // removed headers should stay removed, even if node automatically adds them
+ // to the output:
+ response.removeHeader('connection');
+ response.removeHeader('transfer-encoding');
+
+ // make sure that removing and then setting still works:
+ response.removeHeader('date');
+ response.setHeader('date', 'coffee o clock');
+
+ response.end('beep boop\n');
+
+ this.close();
+});
+
+var response = '';
+
+process.on('exit', function() {
+ assert.equal('beep boop\n', response);
+});
+
+server.listen(common.PORT, function() {
+ http.get({ port: common.PORT }, function(res) {
+ assert.equal(200, res.statusCode);
+ assert.deepEqual(res.headers, { date : 'coffee o clock' });
+
+ res.setEncoding('ascii');
+ res.on('data', function(chunk) {
+ response += chunk;
+ });
+ });
+});
Something went wrong with that request. Please try again.