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

404 with encodings_provided sets encoding Header but doesn't encode response body #144

Open
Asmod4n opened this issue Jan 4, 2014 · 7 comments
Labels

Comments

@Asmod4n
Copy link
Member

Asmod4n commented Jan 4, 2014

#!/usr/bin/env ruby

require 'bundler/setup'
require 'webmachine'

class Resource < Webmachine::Resource
  def resource_exists?
    false
  end

  def encodings_provided
    { 'gzip' => :encode_gzip,
      'deflate' => :encode_deflate,
      'identity' => :encode_identity }
  end

  def to_html
    "Hello"
  end
end

Webmachine.application.routes do
  add_route ['*'], Resource
end

Webmachine.run

This is the reply

HTTP/1.1 404 Not Found 
Content-Type: text/html
Content-Encoding: gzip
Vary: Accept-Encoding
Content-Length: 213
Date: Sat, 04 Jan 2014 22:48:04 GMT
Server: Webmachine-Ruby/1.2.1 WEBrick/1.3.1 (Ruby/2.1.0/2013-12-25)
Connection: Keep-Alive

<!DOCTYPE html><html> <head><title>404 Not Found</title></head> <body><h1>404 Not Found</h1><p>The requested document was not found on this server.</p> <address>Webmachine-Ruby/1.2.1 server</address></body></html>
@ghost
Copy link

ghost commented Jan 4, 2014

@Asmod4n
Copy link
Member Author

Asmod4n commented Jan 4, 2014

A dirty trick to resolve it would be to unset the Content-Encoding header in https://github.com/seancribbs/webmachine-ruby/blob/master/lib/webmachine/errors.rb#L14 because the length is also for the unencoded response.

@ghost
Copy link

ghost commented Jan 20, 2014

unset the Content-Encoding header

That sounds like the simplest thing to do. We'll know once someone implements it :)

@bethesque
Copy link
Contributor

Close and mark as wont-fix for now until someone else wants it?

@Asmod4n
Copy link
Member Author

Asmod4n commented Jan 15, 2015

Dunno if I would close it, since it is a bug

@bethesque
Copy link
Contributor

Tis. But you don't have to fix every bug ;) That's why the 'wont-fix' tag exists!

It seems like a low impact bug which nobody is enthusiastic about fixing, so I'm not sure if there's much point in leaving it open. But we can leave it if nobody else shares my particular obsession with checking items off lists!

@jimvm
Copy link
Contributor

jimvm commented Oct 11, 2015

I wanted to understand this issue better so I first created a resource with a to_html method containing the current 404 not found response body.

class Resource < Webmachine::Resource
  def resource_exists?
    true
  end

  def to_html
    "<!DOCTYPE html><html>\n <head><title>404 Not Found</title></head>\n <body><h1>404 Not Found</h1>\n <p>The requested document was not found on this server.</p>\n <address>Webmachine-Ruby/1.4.0 server</address></body></html>\n"
  end
end

The response:
Content-Length: 219

Then I added the encodings_provided method.

class Resource < Webmachine::Resource
  def resource_exists?
    false
  end

  def encodings_provided
    { 'gzip' => :encode_gzip,
      'deflate' => :encode_deflate,
      'identity' => :encode_identity }
  end

  def to_html
    "<!DOCTYPE html><html>\n <head><title>404 Not Found</title></head>\n <body><h1>404 Not Found</h1>\n <p>The requested document was not found on this server.</p>\n <address>Webmachine-Ruby/1.4.0 server</address></body></html>\n"
  end
end

The response:
Content-Length: 175
Content-Encoding: gzip

Here it works because it was a 200 response, not a 404 response. The path it took through the FSM was different.

Now I set the resource_exists? to false with no encodings_provided method present.

class Resource < Webmachine::Resource
  def resource_exists?
    false
  end

  def to_html
    "hello"
  end
end

The response:
Content-Length: 219

And lastly I added the encodings_provided method.

class Resource < Webmachine::Resource
  def resource_exists?
    false
  end

  def encodings_provided
    { 'gzip' => :encode_gzip,
      'deflate' => :encode_deflate,
      'identity' => :encode_identity }
  end

  def to_html
    "hello"
  end
end

The response:
Content-Length: 219
Content-Encoding: gzip

The problem is that Content-Length should have been 175.

render_error creates a response body when no body is given. A response body can be encoded when you know which encodings are provided by the resource. So I think this can't happen inside render_error because the resource isn't available there.

A 404 response can be given because:

  1. The Dispatcher can't find a resource for a request. In this case there is no custom response body possible but also encodings_provided isn't available at all because the resource doesn't exist.
  2. resource_exists? has been set to false. Here a custom response body should be possible and encodings_provided can be used.

I think to fix the issue for 2. the l7 state in the FSM should set up the response body and encode it before the response is passed to the render_error method. (The state diagram for reference.)

(I tried to fix it by unsetting the Content-Encoding header in render_error but this didn't had an effect.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants