long_body 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 919ec90f6d67ef12a71c59222abc33cfb7c48256
-  data.tar.gz: 3ba12c21e137a5ecf7351c36a2c03dfdac80b536
+  metadata.gz: a5900eac4ab0756b862af488203a3e5b431a2956
+  data.tar.gz: 2d2cd54282e2eff1bb687a7dcfa5e969f9acf505
 SHA512:
-  metadata.gz: 9947da48ea520ee2a2f5d7d73e103f0264853ce10ae868624d835f61097a78979d6e7c5be1385dfe0a51554e4da22920944c98c6990fcd4f75417b193e37fefc
-  data.tar.gz: 6fcb2f4830d5cc4be8ad2fce1c9c5f899a65423e30d37e3e24b1cfc87d8052bda8e9c24c507d411e7a6a4bb247478dd4a34fc58e6bc6fdf40239d24891edf669
+  metadata.gz: f9651bc656fdfdf9606adbb26f658befbfd5d7c89a1bc199f7d651ff0eff8b0fffcb66288470be42e79c176b3984cedcdcb3dfa4a9c829f131f1a80be3355d45
+  data.tar.gz: 90098d028bb0427d0818e658067a4c40f7dd184421e398db1fa4518fdd9beae1c590ddcb7097775a65f6ad7ae778a826a2653e938adde376a76613a93b0ef341

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.2
+cache: bundler
+sudo: false

data/README.md

@@ -1,5 +1,7 @@
 # long_body
 
+[![Build Status](https://travis-ci.org/julik/long_body.svg?branch=master)](https://travis-ci.org/julik/long_body)
+
 Universal Rack middleware for immediate (after-headers) streaming of long Rack response bodies.
 Normally most Rack handler webservers will buffer your entire response, or buffer your response
 without telling you for some time before sending it.
@@ -43,11 +45,18 @@ Streaming a large file, without buffering:
       [200, h, File.open(s, 'rb')]
     }
 
+## Selective bypass
+
+Most requests in your application (assets, HTML pages and so on) probably do not need this and are better to be sent as-is.
+Also, such processing will likely bypass all HTTP caching you set up. `long_body` is "always on" by default. To bypass it,
+send `X-Rack-Long-Body-Skip` header with any truthy contents in your response headers (better use a string value so that
+`Rack::Lint` does not complain).
+
 ## Compatibility
 
-This gem is tested on Ruby 2.2, and should run acceptably well on Ruby 2.+. If you are using Thin you have to
+This gem is tested on Ruby 2.2, and should run acceptably well on Ruby 2.+. If you are using Thin it is recommended to
 use Ruby 2.+ because of the fiber stack size limitation. If you are using Puma, Rainbows or other threaded
-server running this gem on 1.9.2 should be possible as well.
+server running this gem on 1.9.3+ should be possible as well.
 
 <table>
   <tr><th>Webserver</th><th>Version tested</th><th>Compatibility</th></tr>

data/lib/long_body.rb

@@ -46,6 +46,9 @@ class LongBody
     # Call the upstream first
     s, h, b = @app.call(env)
     
+    # Return as-is if the long body skip is requested
+    return [s, h,b] if h.delete('X-Rack-Long-Body-Skip')
+    
     # If the response has nothing to do with the streaming response, just
     # let it go through as it is not big enough to bother. Also if there is no hijack
     # support there is no sense to bother at all.

data/lib/long_body/hijack_handler.rb

@@ -7,12 +7,6 @@
 # For more on this:
 # http://apidock.com/ruby/IO/write_nonblock
 # http://old.blog.phusion.nl/2013/01/23/the-new-rack-socket-hijacking-api/
-#
-# By using this class as a middleware you will put a select() wait
-# spinlock on the output socket of the webserver.
-#
-# The middleware will only trigger for 200 and 206 responses, and only
-# if the Rack handler it is running on supports rack hijacking.
 module LongBody::HijackHandler
   extend self
   HIJACK_HEADER = 'rack.hijack'.freeze

data/lib/long_body/version.rb

@@ -1,3 +1,3 @@
 class LongBody
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/long_body.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: long_body 0.0.1 ruby lib
+# stub: long_body 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "long_body"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
     "README.md",

data/spec/long_body_spec.rb

@@ -6,6 +6,7 @@ require_relative 'shared_webserver_examples'
 describe "LongBody" do
   SERVERS.each do | server_engine |
     context "on #{server_engine.name}" do
+      let(:port) { server_engine.port }
       it_behaves_like "compliant"
     end
   end

data/spec/shared_webserver_examples.rb

@@ -1,6 +1,6 @@
 RSpec.shared_examples "compliant" do
   it "when the response is sent in full works with predefined Content-Length" do | example |
-    parts = TestDownload.perform("http://0.0.0.0:9393/with-content-length")
+    parts = TestDownload.perform("http://0.0.0.0:#{port}/with-content-length")
     timings = parts.map(&:time_difference)
     
 #   $postrun.puts ""
@@ -22,7 +22,7 @@ RSpec.shared_examples "compliant" do
   end
 
   it 'when the response is sent in full works with chunked encoding' do | example |
-    parts = TestDownload.perform("http://0.0.0.0:9393/chunked")
+    parts = TestDownload.perform("http://0.0.0.0:#{port}/chunked")
     timings = parts.map(&:time_difference)
     
 #    $postrun.puts example.full_description
@@ -40,18 +40,50 @@ RSpec.shared_examples "compliant" do
       expect(received_after_previous).to be_within(1).of(0.3)
     end
   end
-
+  
+  it 'bypasses when X-Rack-Long-Body-Skip is set' do | example |
+    parts = TestDownload.perform("http://0.0.0.0:#{port}/explicitly-skipping-long-body")
+    timings = parts.map(&:time_difference)
+    
+#    $postrun.puts example.full_description
+#    $postrun.puts "Part receive timings: #{timings.inspect}"
+#    $postrun.puts ""
+    
+    expect(File).to exist('/tmp/streamer_close.mark')
+  
+    (1..(parts.length-1)).each do | part_i|
+      this_part = parts[part_i]
+      previous_part = parts[part_i -1]
+      received_after_previous = this_part.time_difference - previous_part.time_difference
+      
+      # Ensure there was some time before this chunk arrived. This is the most important test.
+      expect(received_after_previous).to be_within(1).of(0.3)
+    end
+  end
+  
+  
+  it 'raises an error if no Content-Length or chunked transfer encoding is set' do
+    parts = TestDownload.perform("http://0.0.0.0:#{port}/error-with-unclassified-body")
+    response_body = parts.join
+    expect(response_body).to include('If uncertain, insert Rack')
+  end
+  
   it 'when the HTTP client process is killed midflight, does not read more chunks from the body object' do
     # This test checks whether the server makes the iterable body complete if the client closes the connection
     # prematurely. If you have the callbacks set up wrong on Thin, for instance, it will read the response
     # completely and potentially buffer it in memory, filling up your RAM. We need to ensure that the server
     # uses it's internal mechanics to stop reading the body once the client is dropped.
     pid = fork do
-      TestDownload.perform("http://0.0.0.0:9393/with-content-length")
+      TestDownload.perform("http://0.0.0.0:#{port}/with-content-length")
     end
     sleep(1)
     Process.kill("KILL", pid)
     
+    # Wait for the webserver to terminate operations on that request (the close()
+    # call on the body is usually not immediate, but gets executed once the write
+    # to the client socket fails).
+    sleep 0.9
+    
     written_parts_list = File.read("/tmp/streamer_messages.log").split("\n")
     expect(written_parts_list.length).to be < 6
     

data/spec/streaming_app.ru

@@ -34,12 +34,31 @@ class StreamerWithLength < Streamer
   end
 end
 
+map '/error-with-unclassified-body' do
+  use Rack::ShowExceptions
+  use LongBody
+  run ->(env) { [200, {}, %w( one two three )]}
+end
+
 map '/chunked' do
   use LongBody
   use Rack::Chunked
   run Streamer
 end
 
+class Skipper < Struct.new(:app)
+  def call(env)
+    s, h, b = app.call(env)
+    [s, h.merge('X-Rack-Long-Body-Skip' => 'yes'), b]
+  end
+end
+
+map '/explicitly-skipping-long-body' do
+  use LongBody
+  use Skipper
+  run Streamer
+end
+
 map '/with-content-length' do
   use LongBody
   run StreamerWithLength

data/spec/test_download.rb

@@ -18,25 +18,4 @@ module TestDownload
     end
     response_chunks
   end
-  
-  def perform_and_abort_after_3_chunks(uri)
-    response_chunks = []
-    catch :abort do
-      uri = URI(uri.to_s)
-      conn = Net::HTTP.new(uri.host, uri.port)
-      conn.read_timeout = 120 # Might take LONG
-      conn.start do |http|
-        req = Net::HTTP::Get.new(uri.request_uri)
-        before_first = Time.now.to_i
-        http.request(req) do |res|
-          res.read_body do |chunk|
-            diff = Time.now.to_i - before_first
-            response_chunks << Part.new(diff, chunk)
-            throw :abort if response_chunks.length == 3
-          end
-        end
-      end
-    end
-    response_chunks
-  end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: long_body
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -186,6 +186,7 @@ extra_rdoc_files:
 files:
 - ".document"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md