Skip to content
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.

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

Add headers duplications preservation #1150

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,7 @@ proxyServer.listen(8015);
* **localAddress**: Local interface string to bind for outgoing connections
* **changeOrigin**: true/false, Default: false - changes the origin of the host header to the target URL
* **preserveHeaderKeyCase**: true/false, Default: false - specify whether you want to keep letter case of response header key
* **preserveHeaderDuplications**: true/false, Default: false - specify whether you want to keep response headers duplication
* **auth**: Basic authentication i.e. 'user:password' to compute an Authorization header.
* **hostRewrite**: rewrites the location hostname on (201/301/302/307/308) redirects.
* **autoRewrite**: rewrites the location host/port on (201/301/302/307/308) redirects based on requested host/port. Default: false.
Expand Down
3 changes: 2 additions & 1 deletion lib/http-proxy.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ function createProxyServer(options) {
* ignorePath: <true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request>
* localAddress : <Local interface string to bind for outgoing connections>
* changeOrigin: <true/false, Default: false - changes the origin of the host header to the target URL>
* preserveHeaderKeyCase: <true/false, Default: false - specify whether you want to keep letter case of response header key >
* preserveHeaderKeyCase: <true/false, Default: false - specify whether you want to keep response headers duplication >
* preserveHeaderDuplications: <true/false, Default: false - specify whether you want to keep letter case of response header key >
* auth : Basic authentication i.e. 'user:password' to compute an Authorization header.
* hostRewrite: rewrites the location hostname on (301/302/307/308) redirects, Default: null.
* autoRewrite: rewrites the location host/port on (301/302/307/308) redirects based on requested host/port. Default: false.
Expand Down
52 changes: 38 additions & 14 deletions lib/http-proxy/passes/web-outgoing.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,11 @@ module.exports = { // <--
* @api private
*/
writeHeaders: function writeHeaders(req, res, proxyRes, options) {
var rewriteCookieDomainConfig = options.cookieDomainRewrite,
var i,
rawHeaderMap,
rewriteCookieDomainConfig = options.cookieDomainRewrite,
preserveHeaderKeyCase = options.preserveHeaderKeyCase,
rawHeaderKeyMap,
preserveHeaderDuplications = options.preserveHeaderDuplications,
setHeader = function(key, header) {
if (header == undefined) return;
if (rewriteCookieDomainConfig && key.toLowerCase() === 'set-cookie') {
Expand All @@ -98,23 +100,45 @@ module.exports = { // <--
rewriteCookieDomainConfig = { '*': rewriteCookieDomainConfig };
}

// message.rawHeaders is added in: v0.11.6
// https://nodejs.org/api/http.html#http_message_rawheaders
if (preserveHeaderKeyCase && proxyRes.rawHeaders != undefined) {
rawHeaderKeyMap = {};
for (var i = 0; i < proxyRes.rawHeaders.length; i += 2) {
var key = proxyRes.rawHeaders[i];
rawHeaderKeyMap[key.toLowerCase()] = key;
if ((preserveHeaderKeyCase || preserveHeaderDuplications) && proxyRes.rawHeaders != undefined) {
rawHeaderMap = {};

for (i = 0; i < proxyRes.rawHeaders.length; i += 2) {
var name = proxyRes.rawHeaders[i];
var nameL = name.toLowerCase();

if (!rawHeaderMap[nameL]) {
rawHeaderMap[nameL] = {name: name, value: []};
}

rawHeaderMap[nameL].value.push(proxyRes.rawHeaders[i + 1]);
}
}

Object.keys(proxyRes.headers).forEach(function(key) {
var header = proxyRes.headers[key];
if (preserveHeaderKeyCase && rawHeaderKeyMap) {
key = rawHeaderKeyMap[key] || key;

// Code optimization: https://jsperf.com/object-keys-vs-for-in-with-closure/137
var keys = Object.keys(proxyRes.headers);
var key;
var header;

for (i = 0; i < keys.length; i++) {
key = keys[i];

if (preserveHeaderDuplications && rawHeaderMap && rawHeaderMap[key]) {
header = rawHeaderMap[key].value || proxyRes.headers[key];
if (Array.isArray(header) && header.length === 1) {
header = header[0];
}
} else {
header = proxyRes.headers[key];
}

if (preserveHeaderKeyCase && rawHeaderMap && rawHeaderMap[key]) {
key = rawHeaderMap[key].name || key;
}

setHeader(key, header);
});
}
},

/**
Expand Down