request_recorder 0.0.1 → 0.0.2

data/Gemfile

@@ -3,4 +3,6 @@ gemspec
 
 gem "rake"
 gem "rspec", "~>2"
+gem "activerecord", "2.3.14"
 gem "sqlite3"
+gem "fakeredis"

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    request_recorder (0.0.1)
-      activerecord (= 2.3.14)
+    request_recorder (0.0.2)
       rack
 
 GEM
@@ -12,8 +11,11 @@ GEM
       activesupport (= 2.3.14)
     activesupport (2.3.14)
     diff-lcs (1.1.3)
+    fakeredis (0.4.0)
+      redis (~> 3.0.0)
     rack (1.4.1)
     rake (0.9.2)
+    redis (3.0.1)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -28,6 +30,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (= 2.3.14)
+  fakeredis
   rake
   request_recorder!
   rspec (~> 2)

data/Readme.md

@@ -4,15 +4,22 @@ Install
 =======
 
     gem install request_recorder
-    # generate a add_recorded_requests migration and paste content of MIGRATION
+
+Add to your middleware stack:
+
+    require "request_recorder"
+    use RequestRecorder::Middleware, :store => RequestRecorder::RedisLogger.new(Redis.new)
+
+### No Redis, No problem
+If you do not have redis, you can write your own logger, you only need a .write method,
+see [RedisLogger](https://github.com/grosser/request_recorder/blob/master/lib/request_recorder/redis_logger.rb)
 
 Usage
 =====
 
- - Add it to the bottom of you middleware stack
- - request a page with __request_recording=10 -> record next 10 requests from my browser
- - RequestRecorded::Requests gets a new entry with all the logging info from rails + activerecord
- - go to the database or build a nice frontend for RequestRecorded::Requests
+ - request a page with `/something?__request_recording=10` -> record next 10 requests from my browser
+ - redis 'request_recorder' gets a new entry with all the logging info from rails + activerecord
+ - go to redis or build a nice frontend
 
 Author
 ======

data/lib/request_recorder/middleware.rb

@@ -1,3 +1,4 @@
+require "stringio"
 require "rack/request"
 require "rack/response"
 
@@ -8,6 +9,7 @@ module RequestRecorder
 
     def initialize(app, options={})
       @app = app
+      @store = options.fetch(:store)
     end
 
     def call(env)
@@ -17,29 +19,28 @@ module RequestRecorder
         (env["HTTP_COOKIE"] && env["HTTP_COOKIE"].include?(MARKER))
       )
 
-      result = logging_to_recorded do
-        @app.call(env)
+      result = nil
+      log = capture_logging do
+        result = @app.call(env)
       end
 
       steps_left, id = read_state_from_env(env)
       return [500, {}, "__request_recording exceeded maximum value #{MAX_STEPS}"] if steps_left > MAX_STEPS
-      id = persist_log(id, @recorder.log)
+      id = persist_log(id, log)
       response_with_data_in_cookie(result, steps_left, id)
     end
 
     private
 
     def persist_log(id, log)
-      record = (id ? Log.find(id) : Log.new(:log => ""))
-      record.log += log.join("\n") + "\n\n"
-      record.save!
-      record.id
+      @store.write(id, log)
     end
 
     def read_state_from_env(env)
       request = Rack::Request.new(env)
       if request.cookies[MARKER]
-        request.cookies[MARKER].split(":").map(&:to_i)
+        steps, id = request.cookies[MARKER].split(":")
+        [steps.to_i, id]
       else
         [env["QUERY_STRING"][/#{MARKER}=(\d+)/, 1].to_i, nil]
       end
@@ -51,27 +52,30 @@ module RequestRecorder
       if to_go <= 1
         response.delete_cookie(MARKER)
       else
-        response.set_cookie(MARKER, {:value => "#{to_go.to_i - 1}:#{id}", :path => "/", :expires => Time.now+24*60*60})
+        response.set_cookie(MARKER, {:value => "#{to_go.to_i - 1}:#{id}", :expires => Time.now+24*60*60, :httponly => true})
       end
 
       response.finish # finish writes out the response in the expected format.
     end
 
-    def logging_to_recorded
-      @recorder = Recorder.new
+    def capture_logging
+      recorder = StringIO.new
       old = [
         ActiveRecord::Base.logger.instance_variable_get("@log"),
         ActiveRecord::Base.logger.auto_flushing,
         ActiveRecord::Base.logger.level
       ]
-      ActiveRecord::Base.logger.instance_variable_set("@log", @recorder)
+      ActiveRecord::Base.logger.instance_variable_set("@log", recorder)
       ActiveRecord::Base.logger.auto_flushing = true
       ActiveRecord::Base.logger.level = Logger::DEBUG
       yield
+      recorder.string
     ensure
-      ActiveRecord::Base.logger.instance_variable_set("@log", old[0])
-      ActiveRecord::Base.logger.auto_flushing = old[1]
-      ActiveRecord::Base.logger.level = old[2]
+      if old
+        ActiveRecord::Base.logger.instance_variable_set("@log", old[0])
+        ActiveRecord::Base.logger.auto_flushing = old[1]
+        ActiveRecord::Base.logger.level = old[2]
+      end
     end
   end
 end

data/lib/request_recorder/redis_logger.rb

@@ -0,0 +1,16 @@
+module RequestRecorder
+  class RedisLogger
+    KEY = "request_recorder"
+
+    def initialize(redis)
+      @redis = redis
+    end
+
+    def write(id, text)
+      old = (id ? @redis.hget(KEY, id) : "")
+      id = "#{Time.now.to_i}_#{Process.pid}" unless id
+      @redis.hset(KEY, id, old.to_s + text)
+      id
+    end
+  end
+end

data/lib/request_recorder/version.rb

@@ -1,3 +1,3 @@
 module RequestRecorder
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/request_recorder.rb

@@ -1,7 +1,6 @@
 require "request_recorder/version"
-require "request_recorder/log"
 require "request_recorder/middleware"
-require "request_recorder/recorder"
+require "request_recorder/redis_logger"
 
 module RequestRecorder
 end

data/request_recorder.gemspec

@@ -9,6 +9,5 @@ Gem::Specification.new name, RequestRecorder::VERSION do |s|
   s.homepage = "http://github.com/grosser/#{name}"
   s.files = `git ls-files`.split("\n")
   s.license = "MIT"
-  s.add_dependency "activerecord", "2.3.14"
   s.add_dependency "rack"
 end

data/spec/request_recorder_spec.rb

@@ -7,7 +7,10 @@ describe RequestRecorder do
     Car.first
     [200, {}, "assadasd"]
   } }
-  let(:existing_request){ RequestRecorder::Log.create(:log => "BEFORE") }
+  let(:middleware){ RequestRecorder::Middleware.new(inner_app, :store => RequestRecorder::RedisLogger.new(redis)) }
+  let(:redis){ FakeRedis::Redis.new }
+  let(:redis_key){ RequestRecorder::RedisLogger::KEY }
+  let(:existing_request_id){ redis.hset(redis_key, "123_456", "BEFORE") ; "123_456"}
 
   before do
     ActiveRecord::Base.logger.instance_variable_set("@log", original_logger)
@@ -16,7 +19,7 @@ describe RequestRecorder do
   end
 
   after do
-    RequestRecorder::Log.delete_all
+    redis.flushall
   end
 
   it "has a VERSION" do
@@ -24,13 +27,11 @@ describe RequestRecorder do
   end
 
   it "records activerecord queries" do
-    middleware = RequestRecorder::Middleware.new(inner_app)
     middleware.call(activate_logger)
-    RequestRecorder::Log.last.log.should include "SELECT"
+    stored.values.last.should include "SELECT"
   end
 
   it "blows up if you go over the maximum" do
-    middleware = RequestRecorder::Middleware.new(inner_app)
     status, headers, body = middleware.call("QUERY_STRING" => "__request_recording=99999")
     status.should == 500
     body.should include "maximum"
@@ -38,47 +39,92 @@ describe RequestRecorder do
 
   context "subsequent requests" do
     it "sets cookie in first step" do
-      middleware = RequestRecorder::Middleware.new(inner_app)
       status, headers, body = middleware.call(activate_logger)
-      generated = RequestRecorder::Log.last
-      headers["Set-Cookie"].should include "__request_recording=9%3A#{generated.id}; path=/; expires="
+      generated_id = stored.keys.last
+      headers["Set-Cookie"].should include "__request_recording=9%3A#{generated_id}; expires="
+      headers["Set-Cookie"].should include "; HttpOnly"
     end
 
     it "appends to existing log" do
-      middleware = RequestRecorder::Middleware.new(inner_app)
-      middleware.call("HTTP_COOKIE" => "__request_recording=8:#{existing_request.id}")
-      existing_request.reload
-      existing_request.log.should include "SELECT"
-      existing_request.log.should include "BEFORE"
+      middleware.call("HTTP_COOKIE" => "__request_recording=8:#{existing_request_id}")
+      existing_request = redis.hget(redis_key, existing_request_id)
+      existing_request.should include "SELECT"
+      existing_request.should include "BEFORE"
+    end
+
+    it "creates a new log if redis dies" do
+      existing_request_id # store key
+      redis.flushall
+      middleware.call("HTTP_COOKIE" => "__request_recording=8:#{existing_request_id}")
+      existing_request = redis.hget(redis_key, existing_request_id)
+      existing_request.should include "SELECT"
+      existing_request.should_not include "BEFORE"
     end
 
     it "decrements cookie on each step" do
-      middleware = RequestRecorder::Middleware.new(inner_app)
-      status, headers, body = middleware.call("HTTP_COOKIE" => "__request_recording=2:#{existing_request.id};foo=bar")
-      headers["Set-Cookie"].should include "__request_recording=1%3A#{existing_request.id}; path=/; expires="
+      status, headers, body = middleware.call("HTTP_COOKIE" => "__request_recording=2:#{existing_request_id};foo=bar")
+      headers["Set-Cookie"].should include "__request_recording=1%3A#{existing_request_id}; expires="
     end
 
     it "removes cookie if final step is reached" do
-      middleware = RequestRecorder::Middleware.new(inner_app)
-      status, headers, body = middleware.call("HTTP_COOKIE" => "__request_recording=1:#{existing_request.id};foo=bar")
+      status, headers, body = middleware.call("HTTP_COOKIE" => "__request_recording=1:#{existing_request_id};foo=bar")
       headers["Set-Cookie"].should include "__request_recording=; expires="
     end
   end
 
   it "should not record if __request_recording is not given" do
-    middleware = RequestRecorder::Middleware.new(inner_app)
     middleware.call(
       "QUERY_STRING" => "stuff=hello", "HTTP_COOKIE" => "bar=foo"
     )
-    RequestRecorder::Log.count.should == 0
+    stored.count.should == 0
   end
 
   it "restores the AR logger after executing" do
-    middleware = RequestRecorder::Middleware.new(inner_app)
     middleware.call(activate_logger)
 
     ActiveRecord::Base.logger.instance_variable_get("@log").object_id.should == original_logger.object_id
     ActiveRecord::Base.logger.auto_flushing.should == 1000
     ActiveRecord::Base.logger.level.should == Logger::ERROR
   end
+
+  it "fails with a nice message if logging_to_recorded blows up" do
+    StringIO.should_receive(:new).and_raise("Oooops")
+    expect{
+      middleware.call(activate_logger)
+    }.to raise_error "Oooops"
+  end
+
+  it "integrates" do
+    stored.size.should == 0
+
+    # request 1 - start + decrement + log
+    status, headers, body = middleware.call({"QUERY_STRING" => "__request_recording=3"})
+    stored.size.should == 1
+    stored.values.last.scan("SELECT").size.should == 1
+    cookie = headers["Set-Cookie"].split(";").first
+
+    # request 2 - decrement + log
+    status, headers, body = middleware.call({"HTTP_COOKIE" => cookie})
+    stored.size.should == 1
+    stored.values.last.scan("SELECT").size.should == 2
+    cookie = headers["Set-Cookie"].split(";").first
+
+    # request 3 - remove cookie + log
+    status, headers, body = middleware.call({"HTTP_COOKIE" => cookie})
+    stored.size.should == 1
+    stored.values.last.scan("SELECT").size.should == 3
+    cookie = headers["Set-Cookie"].split(";").first
+    cookie.should == "__request_recording="
+
+    # request 4 - no more logging
+    status, headers, body = middleware.call({})
+    stored.size.should == 1
+    stored.values.last.scan("SELECT").size.should == 3
+  end
+
+  private
+
+  def stored
+    redis.hgetall(redis_key)
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 require "request_recorder"
 
+require "active_record"
+require "fakeredis"
+
 ActiveRecord::Base.logger = ActiveSupport::BufferedLogger.new("/dev/null")
 
 # connect
@@ -11,9 +14,6 @@ ActiveRecord::Base.establish_connection(
 # create tables
 ActiveRecord::Schema.verbose = false
 ActiveRecord::Schema.define(:version => 1) do
-  eval(File.read(File.expand_path("../../MIGRATION", __FILE__)))
-  AddRecordedRequests.up
-
   create_table :cars do |t|
     t.timestamps
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_recorder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,22 +11,6 @@ bindir: bin
 cert_chain: []
 date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.3.14
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.3.14
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -52,13 +36,11 @@ files:
 - .travis.yml
 - Gemfile
 - Gemfile.lock
-- MIGRATION
 - Rakefile
 - Readme.md
 - lib/request_recorder.rb
-- lib/request_recorder/log.rb
 - lib/request_recorder/middleware.rb
-- lib/request_recorder/recorder.rb
+- lib/request_recorder/redis_logger.rb
 - lib/request_recorder/version.rb
 - request_recorder.gemspec
 - spec/request_recorder_spec.rb
@@ -78,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1997442405915248740
+      hash: -3099537396771962597
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -87,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1997442405915248740
+      hash: -3099537396771962597
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/MIGRATION

@@ -1,12 +0,0 @@
-class AddRecordedRequests < ActiveRecord::Migration
-  def self.up
-    create_table :recorded_request_log do |t|
-      t.text "log"
-      t.timestamp :created_at
-    end
-  end
-
-  def self.down
-    drop_table :recorded_request_log
-  end
-end

data/lib/request_recorder/log.rb

@@ -1,7 +0,0 @@
-require "active_record"
-
-module RequestRecorder
-  class Log < ActiveRecord::Base
-    set_table_name "recorded_request_log" # TODO use self.table_name = in rails 3
-  end
-end

data/lib/request_recorder/recorder.rb

@@ -1,13 +0,0 @@
-module RequestRecorder
-  class Recorder
-    attr_reader :log
-
-    def initialize
-      @log = []
-    end
-
-    def write(s)
-      @log << s
-    end
-  end
-end