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.

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

Jump to bottom

Do not try to pipe Gzip responses with no body #2176

Merged
merged 2 commits into from Apr 17, 2016
Merged

Do not try to pipe Gzip responses with no body #2176

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9f0cc5
Do not try to pipe HEAD request responses when using gzip
simov Apr 16, 2016
5553f17
Do not try to pipe Gzip responses with no body
simov Apr 17, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion request.js
View file
Open in desktop
Expand Up @@ -921,7 +921,7 @@ Request.prototype.onRequestResponse = function (response) {
})

var responseContent
if (self.gzip) {
if (self.gzip && self.method !== 'HEAD') {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will fix the particular issue with HEAD requests, but will still cause issues if the response is empty for say a GET. A better way of handling would be to catch the Error from zlib.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Figuring out if the response is empty beforehand would be great, will think about it. I would rather not use try/catch if there is some other way to detect the condition.

Copy link
Member Author

@simov simov Apr 16, 2016 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately there is no reliable way to determine upfront if the response body is empty. And in fact the error is thrown because the gzip content is invalid which may happen even if you have a body.
So the least we can do is forward the error events so that the user can handle them accordingly. Which means that you will receive an error when the request method is GET, the gzip option is set to true, and there is no response body.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway still this PR fixes the mentioned issue in the description which is the most common use case.

@czardoz you can open up another issue and point to this one, so we can have a discussion there.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done: #2177

var contentEncoding = response.headers['content-encoding'] || 'identity'
contentEncoding = contentEncoding.trim().toLowerCase()

Expand Down
16 changes: 16 additions & 0 deletions tests/test-gzip.js
View file
Open in desktop
Expand Up @@ -16,6 +16,12 @@ var server = http.createServer(function(req, res) {
res.statusCode = 200
res.setHeader('Content-Type', 'text/plain')

if (req.method === 'HEAD') {
res.setHeader('Content-Encoding', 'gzip')
res.end()
return
}

if (/\bgzip\b/i.test(req.headers['accept-encoding'])) {
res.setHeader('Content-Encoding', 'gzip')
if (req.url === '/error') {
Expand Down Expand Up @@ -226,6 +232,16 @@ tape('transparently supports deflate decoding to callbacks', function(t) {
})
})

tape('do not try to pipe HEAD request responses', function(t) {
var options = { method: 'HEAD', url: 'http://localhost:6767/foo', gzip: true }

request(options, function(err, res, body) {
t.equal(err, null)
t.equal(body, '')
t.end()
})
})


tape('cleanup', function(t) {
server.close(function() {
Expand Down