request_recorder 0.2.2 → 0.2.3

data/Appraisals

@@ -4,6 +4,5 @@ appraise "rails2" do
 end
 
 appraise "rails3" do
-  gem "rack", ">= 1.5.2"
-  gem "activerecord", "~>3.2.7"
+  # see Gemfile
 end

data/Gemfile

@@ -5,7 +5,8 @@ gem "appraisal"
 gem "bump"
 gem "rake"
 gem "rspec", "~>2"
-gem "activerecord"
+gem "activerecord", ">= 3"
+gem "rack", ">= 1.5.2"
 gem "sqlite3"
 gem "fakeredis"
 gem "json"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    request_recorder (0.2.2)
+    request_recorder (0.2.3)
       activerecord
       multi_json
       rack
@@ -50,11 +50,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord
+  activerecord (>= 3)
   appraisal
   bump
   fakeredis
   json
+  rack (>= 1.5.2)
   rake
   request_recorder!
   rspec (~> 2)

data/Readme.md

@@ -13,6 +13,8 @@ Add to your middleware stack:
     use RequestRecorder::Middleware,
       :store => RequestRecorder::CacheLogger.new(Rails.cache),
       :frontend_auth => lambda { |env| Rails.env.development? } # TODO use something like `env.warden.user.is_admin?` in production
+      # if you get 502's because of too large headers, you can reduce them: everything in :remove will be removed when above :max
+      # :header => {:max => 10_000, :remove => [/SELECT count(\*)/, /SELECT \* FROM/, /Cache local read/, /Cache read/, /Identity Map/] }
 
 Usage
 =====

data/gemfiles/rails2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mgrosser/code/tools/request_recorder
   specs:
-    request_recorder (0.2.0)
+    request_recorder (0.2.2)
       activerecord
       multi_json
       rack

data/gemfiles/rails3.gemfile

@@ -6,10 +6,10 @@ gem "appraisal"
 gem "bump"
 gem "rake"
 gem "rspec", "~>2"
+gem "activerecord", ">= 3"
+gem "rack", ">= 1.5.2"
 gem "sqlite3"
 gem "fakeredis"
 gem "json"
-gem "rack", ">= 1.5.2"
-gem "activerecord", "~>3.2.7"
 
 gemspec :path=>"../"

data/gemfiles/rails3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mgrosser/code/tools/request_recorder
   specs:
-    request_recorder (0.2.0)
+    request_recorder (0.2.2)
       activerecord
       multi_json
       rack
@@ -50,7 +50,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 3.2.7)
+  activerecord (>= 3)
   appraisal
   bump
   fakeredis

data/lib/request_recorder/middleware.rb

@@ -21,6 +21,7 @@ module RequestRecorder
       @app = app
       @store = options.fetch(:store)
       @auth = options[AUTH]
+      @headers = options[:headers] || {}
     end
 
     def call(env)
@@ -95,10 +96,14 @@ module RequestRecorder
     end
 
     def chrome_logger_headers(log)
+      log = log.split("\n").map { |line| remove_console_colors(line) }
+      log = reduce_header_size(log) if @headers
+
+
       # fake chrome-logger format
       rows = []
       rows << [["Rails log"],"xxx.rb:1","group"]
-      rows.concat log.split("\n").map{|line| [remove_console_colors(line).split(" "), "xxx.rb:1", ""] }
+      rows.concat log.map{|line| [line.split(" "), "xxx.rb:1", ""] }
       rows << [[], "xxx.rb:1", "groupEnd"]
 
       data = {
@@ -115,6 +120,33 @@ module RequestRecorder
       {"X-ChromeLogger-Data" => data}
     end
 
+    def reduce_header_size(array)
+      size = @headers.fetch(:max)
+      return array if array.sum(&:size) <= size
+
+      size -= 20 # make room for removed message
+      removed_count = 0
+      removed_match = []
+
+      while array.sum(&:size) > size
+        if remove = (@headers[:remove] || []).pop
+          removed_match << remove
+          array.reject! { |line| line =~ remove }
+        else
+          removed_count += 1
+          array.shift
+        end
+      end
+
+      # tell user what was removed
+      message = []
+      message << "all #{removed_match.map(&:inspect).join(", ")}" if removed_match.any?
+      message << "#{removed_count} lines" if removed_count > 0
+      array << "Removed: #{message.join(", ")}"
+
+      array
+    end
+
     def remove_console_colors(string)
       string.gsub(/\e\[[\d;]+m/, "")
     end

data/lib/request_recorder/repeater.rb

@@ -15,7 +15,7 @@ module RequestRecorder
         if t.respond_to?(:add)
           t.add(*args)
         else
-          t.write(args[1])
+          t.write("#{args[1]}\n")
         end
       end
     end

data/lib/request_recorder/version.rb

@@ -1,3 +1,3 @@
 module RequestRecorder
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/request_recorder/middleware_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe RequestRecorder::Middleware do
+  describe "#reduce_header_size" do
+    let(:middleware) { RequestRecorder::Middleware.new(nil, :store => {}, :headers => {:max => 100, :remove => [/b/]}) }
+
+    it "does not touch small" do
+      middleware.send(:reduce_header_size, ["a"*40, "b"*40]).should == ["a"*40, "b"*40]
+    end
+
+    it "removes from the front and notifies of removal" do
+      middleware.send(:reduce_header_size, ["a"*60, "c"*60]).should == ["c"*60, "Removed: all /b/, 1 lines"]
+    end
+
+    it "removes :header :remove when above max before other things" do
+      middleware.send(:reduce_header_size, ["a" * 40,"b"*40,"c" * 40]).should == [
+        "a" * 40, "c" * 40, "Removed: all /b/"
+      ]
+    end
+  end
+end

data/spec/request_recorder_spec.rb

@@ -7,6 +7,9 @@ describe RequestRecorder do
   let(:activate_logger){ {"QUERY_STRING" => "request_recorder=10"} }
   let(:inner_app){ lambda{|env|
     Car.first
+
+    (env["log"] || []).each { |line| ActiveRecord::Base.logger.info(line) }
+
     if env["raise"]
       # rails also logs errors
       ActiveRecord::Base.logger.error(env["raise"])
@@ -136,7 +139,8 @@ describe RequestRecorder do
       RequestRecorder::Middleware.new(
         inner_app,
         :store => store,
-        :frontend_auth => lambda{|env| env["success"] }
+        :frontend_auth => lambda{|env| env["success"] },
+        :headers => {:max => 1000}
       )
     }
 
@@ -163,17 +167,21 @@ describe RequestRecorder do
     end
 
     it "warns about unconfigured :frontend_auth" do
-      middleware = RequestRecorder::Middleware.new(inner_app, :store => store)
+      middleware = RequestRecorder::Middleware.new(inner_app, :store => store, :max_header_size => 1000)
       status, headers, body = middleware.call("PATH_INFO" => "/request_recorder/xxx")
       status.should == 500
       body.should include(":frontend_auth")
     end
 
     context "chrome logger" do
+      def decode(headers)
+        MultiJson.load(Base64.decode64(headers["X-ChromeLogger-Data"]))
+      end
+
       it "logs into chrome logger" do
         status, headers, body = middleware.call("QUERY_STRING" => "request_recorder=10-xxx", "success" => true)
         headers["X-ChromeLogger-Data"].should_not == nil
-        data = MultiJson.load(Base64.decode64(headers["X-ChromeLogger-Data"]))
+        data = decode(headers)
         data["rows"][1][0][2..-1] = "---" # remove timing information + activerecord 2/3 diff
         data.should == {
           "version"=>"0.1.1",
@@ -186,6 +194,16 @@ describe RequestRecorder do
         }
       end
 
+      it "removes header length above max" do
+        status, headers, body = middleware.call(
+          "QUERY_STRING" => "request_recorder=10-xxx",
+          "success" => true,
+          "log" => Array.new(20).fill(("a" * 100))
+        )
+        headers["X-ChromeLogger-Data"].size.should be_within(200).of(1700)
+        decode(headers)["rows"].inspect.should include '"Removed:", "12", "lines"' # tells users that something was removed
+      end
+
       it "does not log without frontend_auth" do
         status, headers, body = middleware.call("QUERY_STRING" => "request_recorder=10-xxx")
         headers["X-ChromeLogger-Data"].should == nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_recorder
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -85,6 +85,7 @@ files:
 - request_recorder.gemspec
 - spec/request_recorder/cache_logger_spec.rb
 - spec/request_recorder/frontend_spec.rb
+- spec/request_recorder/middleware_spec.rb
 - spec/request_recorder/redis_logger_spec.rb
 - spec/request_recorder_spec.rb
 - spec/spec_helper.rb
@@ -103,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1774609380025706584
+      hash: 542393427719907215
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -112,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1774609380025706584
+      hash: 542393427719907215
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25