Do not override Accept-Encoding header if already provided (#472)

pietermees · sindresorhus · commit 81f2537e6950 · 2018-04-03T12:02:02.000+07:00
diff --git a/index.js b/index.js
@@ -527,8 +527,8 @@ function normalizeArguments(url, opts) {
 		'user-agent': `${pkg.name}/${pkg.version} (https://github.com/sindresorhus/got)`
 	}, headers);
 
-	if (opts.decompress) {
-		opts.headers['accept-encoding'] = 'gzip,deflate';
+	if (opts.decompress && is.undefined(opts.headers['accept-encoding'])) {
+		opts.headers['accept-encoding'] = 'gzip, deflate';
 	}
 
 	const query = opts.query;
diff --git a/readme.md b/readme.md
@@ -195,7 +195,7 @@ request the resource pointed to in the location header via `GET`. This is in acc
 Type: `boolean`<br>
 Default: `true`
 
-Decompress the response automatically.
+Decompress the response automatically. This will set the `accept-encoding` header to `gzip, deflate` unless you set it yourself.
 
 If this is disabled, a compressed response is returned as a `Buffer`. This may be useful if you want to handle decompression yourself or stream the raw compressed data.
 
diff --git a/test/headers.js b/test/headers.js
@@ -24,7 +24,17 @@ test('user-agent', async t => {
 
 test('accept-encoding', async t => {
 	const headers = (await got(s.url, {json: true})).body;
-	t.is(headers['accept-encoding'], 'gzip,deflate');
+	t.is(headers['accept-encoding'], 'gzip, deflate');
+});
+
+test('do not override accept-encoding', async t => {
+	const headers = (await got(s.url, {
+		json: true,
+		headers: {
+			'accept-encoding': 'gzip'
+		}
+	})).body;
+	t.is(headers['accept-encoding'], 'gzip');
 });
 
 test('do not set accept-encoding header when decompress options is false', async t => {

Original file line number	Diff line number	Diff line change
`@@ -527,8 +527,8 @@ function normalizeArguments(url, opts) {`
`527`	`527`	'user-agent': `${pkg.name}/${pkg.version} (https://github.com/sindresorhus/got)`
`528`	`528`	`}, headers);`
`529`	`529`
`530`		`- if (opts.decompress) {`
`531`		`- opts.headers['accept-encoding'] = 'gzip,deflate';`
	`530`	`+ if (opts.decompress && is.undefined(opts.headers['accept-encoding'])) {`
	`531`	`+ opts.headers['accept-encoding'] = 'gzip, deflate';`
`532`	`532`	`}`
`533`	`533`
`534`	`534`	`const query = opts.query;`