Changeset 6158

Timestamp:

02/17/07 18:16:44 (1 year ago)

Author:

david

Message:

Added that rendering will automatically insert the etag header on 200 OK responses. The etag is calculated using MD5 of the response body. If a request comes in that has a matching etag, the response will be changed to a 304 Not Modified and the response body will be set to an empty string. [DHH]

Files:

• trunk/actionpack/CHANGELOG (modified) (1 diff)
• trunk/actionpack/lib/action_controller/base.rb (modified) (3 diffs)
• trunk/actionpack/lib/action_controller/request.rb (modified) (1 diff)
• trunk/actionpack/test/controller/render_test.rb (modified) (2 diffs)

trunk/actionpack/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Added that rendering will automatically insert the etag header on 200 OK responses. The etag is calculated using MD5 of the response body. If a request comes in that has a matching etag, the response will be changed to a 304 Not Modified and the response body will be set to an empty string. [DHH]
-
-* Added X-Runtime to all responses with the request run time [DHH]

trunk/actionpack/lib/action_controller/base.rb

@@ -8 +8 @@
-require 'drb'
-require 'set'
+require 'md5'
-
-module ActionController #:nodoc:
@@ -649 +650 @@
-      # <tt>render_partial_collection(partial_name, collection, partial_spacer_template = nil, local_assigns = {})</tt>.
-      #
+      # == Automatic etagging
+      #
+      # Rendering will automatically insert the etag header on 200 OK responses. The etag is calculated using MD5 of the
+      # response body. If a request comes in that has a matching etag, the response will be changed to a 304 Not Modified
+      # and the response body will be set to an empty string.
+      #
-      # === Rendering a template
-      #
@@ -871 +878 @@
-          response.body = text
-        end
+
+        if response.headers['Status'] == "200 OK" && response.body.size > 0
+          response.headers['Etag'] = "\"#{MD5.new(text).to_s}\""
+          
+          if request.headers['HTTP_IF_NONE_MATCH'] == response.headers['Etag']
+            response.headers['Status'] = "304 Not Modified"
+            response.body = ''
+          end
+        end
+        
+        response.body
-      end
-

trunk/actionpack/lib/action_controller/request.rb

@@ -50 +50 @@
-    def head?
-      @env['REQUEST_METHOD'].downcase.to_sym == :head
+    end
+
+    def headers
+      @env
-    end
-

trunk/actionpack/test/controller/render_test.rb

@@ -68 +68 @@
-    @name = "David"
-    render "test/hello"
+  end
+
+  def heading
+    head :ok
-  end
-
@@ -287 +291 @@
-  end
-
+  def test_render_200_should_set_etag
+    get :render_hello_world_from_variable
+    assert_equal etag_for("hello david"), @response.headers['Etag']
+  end
+
+  def test_render_against_etag_request_should_304_when_match
+    @request.headers["HTTP_IF_NONE_MATCH"] = etag_for("hello david")
+    get :render_hello_world_from_variable
+    assert_equal "304 Not Modified", @response.headers['Status']
+    assert @response.body.empty?
+  end
+
+  def test_render_against_etag_request_should_200_when_no_match
+    @request.headers["HTTP_IF_NONE_MATCH"] = etag_for("hello somewhere else")
+    get :render_hello_world_from_variable
+    assert_equal "200 OK", @response.headers['Status']
+    assert !@response.body.empty?
+  end
+
+  def test_render_with_etag
+    get :render_hello_world_from_variable
+    expected_etag = "\"#{MD5.new("hello david").to_s}\""
+    assert_equal expected_etag, @response.headers['Etag']
+    
+    @request.headers["HTTP_IF_NONE_MATCH"] = expected_etag
+    get :render_hello_world_from_variable
+    assert_equal "304 Not Modified", @response.headers['Status']
+    
+    @request.headers["HTTP_IF_NONE_MATCH"] = "\"diftag\""
+    get :render_hello_world_from_variable
+    assert_equal "200 OK", @response.headers['Status']
+  end
+
+  def render_with_404_shouldnt_have_etag
+    get :render_custom_code
+    assert_nil @response.headers['Etag']
+  end
+
-  protected
-    def assert_deprecated_render(&block)
-      assert_deprecated(/render/, &block)
-    end
+    
+    def etag_for(text)
+      "\"#{MD5.new(text).to_s}\""
+    end
-end