request_recorder 0.1.2 → 0.2.0

data/Appraisals

@@ -1,7 +1,9 @@
 appraise "rails2" do
+  gem "rack", "~> 1.1.6"
   gem "activerecord", "~>2.3.14"
 end
 
 appraise "rails3" do
+  gem "rack", ">= 1.5.2"
   gem "activerecord", "~>3.2.7"
 end

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 gemspec
 
 gem "appraisal"
@@ -8,3 +8,4 @@ gem "rspec", "~>2"
 gem "activerecord"
 gem "sqlite3"
 gem "fakeredis"
+gem "json"

data/Gemfile.lock

@@ -1,35 +1,50 @@
 PATH
   remote: .
   specs:
-    request_recorder (0.1.2)
+    request_recorder (0.2.0)
       activerecord
+      multi_json
       rack
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activerecord (2.3.14)
-      activesupport (= 2.3.14)
-    activesupport (2.3.14)
-    appraisal (0.4.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    appraisal (0.5.2)
       bundler
       rake
-    bump (0.3.5)
-    diff-lcs (1.1.3)
-    fakeredis (0.4.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    bump (0.4.1)
+    diff-lcs (1.2.3)
+    fakeredis (0.4.2)
       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)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    sqlite3 (1.3.6)
+    i18n (0.6.1)
+    json (1.7.7)
+    multi_json (1.7.2)
+    rack (1.5.2)
+    rake (10.0.4)
+    redis (3.0.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    sqlite3 (1.3.7)
+    tzinfo (0.3.37)
 
 PLATFORMS
   ruby
@@ -39,6 +54,7 @@ DEPENDENCIES
   appraisal
   bump
   fakeredis
+  json
   rake
   request_recorder!
   rspec (~> 2)

data/Readme.md

@@ -1,4 +1,4 @@
-Record your rack/rails requests and store them for future inspection
+Record your rack/rails requests and store them for future inspection + see them in your chrome console.
 
 Install
 =======
@@ -10,28 +10,30 @@ Add to your middleware stack:
     require "request_recorder"
 
     require "request_recorder/cache_logger"
-    use RequestRecorder::Middleware, :store => RequestRecorder::CacheLogger.new(Rails.cache)
-
-    -- or --
-
-    require "request_recorder/redis_logger"
-    use RequestRecorder::Middleware, :store => RequestRecorder::RedisLogger.new(Redis.new)
+    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
 
 Usage
 =====
 
- - request a page with `/something?request_recorder=10|my-session-name` -> record next 10 requests from my browser
+ - request a page with `/something?request_recorder=10-my_session_name` -> record next 10 requests from my browser
  - all the debug-level logging info from rails + activerecord gets stored
  - get log directly from the store or use the frontend
 
-Frontend
-========
+Chrome console
+==============
+(needs `:frontend_auth`)
 
-  Add :frontend_auth and find out if the current user is authorized
+ - Install [Chrome extension](https://chrome.google.com/webstore/detail/chrome-logger/noaneddfkdjfnfdakjjmocngnfkfehhd)
+ - Enable it<br/> ![Enable](http://cdn.craig.is/img/chromelogger/toggle.gif)
+ - Open console<br/> ![Profit](https://dl.dropboxusercontent.com/u/2670385/Web/request_recorder_output.png)
 
-    use RequestRecorder::Middleware, :frontent_auth => lambda{|env| env.warden.user.is_admin? }
-
-Go to `/request_recorder/<key>` and see the recorded log.
+Frontend
+========
+(needs `:frontend_auth`)
+See the log of all requests in an entire session: `/request_recorder/my_session_name`.
+This also includes requests that did not get shown in the chrome logger like redirects.
 
 Author
 ======

data/gemfiles/rails2.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source :rubygems
+source "https://rubygems.org"
 
 gem "appraisal"
 gem "bump"
@@ -8,6 +8,8 @@ gem "rake"
 gem "rspec", "~>2"
 gem "sqlite3"
 gem "fakeredis"
+gem "json"
+gem "rack", "~> 1.1.6"
 gem "activerecord", "~>2.3.14"
 
 gemspec :path=>"../"

data/gemfiles/rails2.gemfile.lock

@@ -1,35 +1,38 @@
 PATH
   remote: /Users/mgrosser/code/tools/request_recorder
   specs:
-    request_recorder (0.1.1)
+    request_recorder (0.1.2)
       activerecord
+      multi_json
       rack
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activerecord (2.3.14)
-      activesupport (= 2.3.14)
-    activesupport (2.3.14)
-    appraisal (0.4.1)
+    activerecord (2.3.18)
+      activesupport (= 2.3.18)
+    activesupport (2.3.18)
+    appraisal (0.5.2)
       bundler
       rake
-    bump (0.3.5)
-    diff-lcs (1.1.3)
-    fakeredis (0.4.1)
+    bump (0.4.1)
+    diff-lcs (1.2.3)
+    fakeredis (0.4.2)
       redis (~> 3.0.0)
-    rack (1.4.1)
-    rake (0.9.2.2)
-    redis (3.0.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    sqlite3 (1.3.6)
+    json (1.7.7)
+    multi_json (1.7.2)
+    rack (1.1.6)
+    rake (10.0.4)
+    redis (3.0.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    sqlite3 (1.3.7)
 
 PLATFORMS
   ruby
@@ -39,6 +42,8 @@ DEPENDENCIES
   appraisal
   bump
   fakeredis
+  json
+  rack (~> 1.1.6)
   rake
   request_recorder!
   rspec (~> 2)

data/gemfiles/rails3.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source :rubygems
+source "https://rubygems.org"
 
 gem "appraisal"
 gem "bump"
@@ -8,6 +8,8 @@ gem "rake"
 gem "rspec", "~>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,48 +1,50 @@
 PATH
   remote: /Users/mgrosser/code/tools/request_recorder
   specs:
-    request_recorder (0.1.1)
+    request_recorder (0.1.2)
       activerecord
+      multi_json
       rack
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
-    appraisal (0.4.1)
+    appraisal (0.5.2)
       bundler
       rake
     arel (3.0.2)
     builder (3.0.4)
-    bump (0.3.5)
-    diff-lcs (1.1.3)
-    fakeredis (0.4.1)
+    bump (0.4.1)
+    diff-lcs (1.2.3)
+    fakeredis (0.4.2)
       redis (~> 3.0.0)
     i18n (0.6.1)
-    multi_json (1.3.6)
-    rack (1.4.1)
-    rake (0.9.2.2)
-    redis (3.0.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    sqlite3 (1.3.6)
-    tzinfo (0.3.33)
+    json (1.7.7)
+    multi_json (1.7.2)
+    rack (1.5.2)
+    rake (10.0.4)
+    redis (3.0.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    sqlite3 (1.3.7)
+    tzinfo (0.3.37)
 
 PLATFORMS
   ruby
@@ -52,6 +54,8 @@ DEPENDENCIES
   appraisal
   bump
   fakeredis
+  json
+  rack (>= 1.5.2)
   rake
   request_recorder!
   rspec (~> 2)

data/lib/request_recorder/middleware.rb

@@ -4,12 +4,16 @@ require "rack/response"
 require "request_recorder/repeater"
 require "request_recorder/frontend"
 require "active_record"
+require "rack"
+require "rack/body_proxy" if defined?(Rack.release) && Rack.release >= "1.5"
+require "base64"
+require "multi_json"
 
 module RequestRecorder
   class Middleware
     MARKER = "request_recorder"
     MAX_STEPS = 100
-    SEPARATOR = "|"
+    SEPARATOR = "-"
     NEED_AUTOFLUSH = (ActiveRecord::VERSION::MAJOR == 2)
     AUTH = :frontend_auth
 
@@ -41,9 +45,10 @@ module RequestRecorder
         id = persist_log(id, log)
 
         if result.is_a?(Exception)
-          raise result
+          raise result # Do not mess up the apps normal exception behavior
         else
-          response_with_data_in_cookie(result, steps_left, id)
+          extra_headers = chrome_logger_headers(log) if @auth && @auth.call(env)
+          response_with_data_in_cookie(result, steps_left, id, extra_headers)
         end
       end
     end
@@ -77,9 +82,9 @@ module RequestRecorder
       [steps.to_i, id]
     end
 
-    def response_with_data_in_cookie(result, to_go, id)
+    def response_with_data_in_cookie(result, to_go, id, extra_headers)
       status, headers, body = result
-      response = Rack::Response.new(body, status, headers)
+      response = Rack::Response.new(body, status, headers.merge(extra_headers || {}))
       if to_go <= 1
         response.delete_cookie(MARKER)
       else
@@ -89,6 +94,24 @@ module RequestRecorder
       response.finish # finish writes out the response in the expected format.
     end
 
+    def chrome_logger_headers(log)
+      data = {
+        'version' => "0.1.1",
+        'columns' => [ 'log' , 'backtrace' , 'type' ],
+        'rows'    =>
+          [
+            [["Rails log"],"xxx.rb:1","group"],
+            *log.split("\n").map{|line| [remove_console_colors(line).split(" "), "xxx.rb:1", ""] },
+            [[], "xxx.rb:1", "groupEnd"],
+          ]
+      }
+      {"X-ChromeLogger-Data" => Base64.encode64(MultiJson.dump(data).encode("UTF-8")).gsub("\n", "")}
+    end
+
+    def remove_console_colors(string)
+      string.gsub(/\e\[[\d;]+m/, "")
+    end
+
     def capture_logging
       old = [
         ActiveRecord::Base.logger.instance_variable_get("@log"),

data/lib/request_recorder/version.rb

@@ -1,3 +1,3 @@
 module RequestRecorder
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/request_recorder.gemspec

@@ -10,5 +10,6 @@ Gem::Specification.new name, RequestRecorder::VERSION do |s|
   s.files = `git ls-files`.split("\n")
   s.license = "MIT"
   s.add_runtime_dependency "rack"
+  s.add_runtime_dependency "multi_json"
   s.add_runtime_dependency "activerecord"
 end

data/spec/request_recorder_spec.rb

@@ -63,7 +63,7 @@ describe RequestRecorder do
   end
 
   it "starts with a given key" do
-    middleware.call({"QUERY_STRING" => "request_recorder=10|abcdefg"})
+    middleware.call({"QUERY_STRING" => "request_recorder=10-abcdefg"})
     redis.hget(redis_key, "abcdefg").should include "SELECT"
   end
 
@@ -77,12 +77,12 @@ describe RequestRecorder do
     it "sets cookie in first step" do
       status, headers, body = middleware.call(activate_logger)
       generated_id = stored.keys.last
-      headers["Set-Cookie"].should include "request_recorder=9%7C#{generated_id.gsub(":", "%3A").gsub(" ", "+")}; expires="
+      headers["Set-Cookie"].should include "request_recorder=9-#{generated_id.gsub(":", "%3A").gsub(" ", "+")}; expires="
       headers["Set-Cookie"].should include "; HttpOnly"
     end
 
     it "appends to existing log" do
-      middleware.call("HTTP_COOKIE" => "request_recorder=8|#{existing_request_id}")
+      middleware.call("HTTP_COOKIE" => "request_recorder=8-#{existing_request_id}")
       existing_request = redis.hget(redis_key, existing_request_id)
       existing_request.should include "SELECT"
       existing_request.should include "BEFORE"
@@ -91,20 +91,20 @@ describe RequestRecorder do
     it "creates a new log if redis dies" do
       existing_request_id # store key
       redis.flushall
-      middleware.call("HTTP_COOKIE" => "request_recorder=8|#{existing_request_id}")
+      middleware.call("HTTP_COOKIE" => "request_recorder=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
-      status, headers, body = middleware.call("HTTP_COOKIE" => "request_recorder=2|#{existing_request_id};foo=bar")
-      headers["Set-Cookie"].should include "request_recorder=1%7C#{existing_request_id}; expires="
+      status, headers, body = middleware.call("HTTP_COOKIE" => "request_recorder=2-#{existing_request_id};foo=bar")
+      headers["Set-Cookie"].sub(" max-age=0;", "").should include "request_recorder=1-#{existing_request_id}; expires="
     end
 
     it "removes cookie if final step is reached" do
-      status, headers, body = middleware.call("HTTP_COOKIE" => "request_recorder=1|#{existing_request_id};foo=bar")
-      headers["Set-Cookie"].should include "request_recorder=; expires="
+      status, headers, body = middleware.call("HTTP_COOKIE" => "request_recorder=1-#{existing_request_id};foo=bar")
+      headers["Set-Cookie"].sub(" max-age=0;", "").should include "request_recorder=; expires="
     end
   end
 
@@ -168,13 +168,36 @@ describe RequestRecorder do
       status.should == 500
       body.should include(":frontend_auth")
     end
+
+    context "chrome logger" do
+      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["rows"][1][0][2..-1] = "---" # remove timing information + activerecord 2/3 diff
+        data.should == {
+          "version"=>"0.1.1",
+          "columns"=>["log", "backtrace", "type"],
+          "rows"=>[
+            [["Rails log"], "xxx.rb:1", "group"],
+            [["Car", "Load", "---"], "xxx.rb:1", ""],
+            [[], "xxx.rb:1", "groupEnd"]
+          ]
+        }
+      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
+      end
+    end
   end
 
   it "integrates" do
     stored.size.should == 0
 
     # request 1 - start + decrement + log
-    status, headers, body = middleware.call({"QUERY_STRING" => "request_recorder=3"})
+    status, headers, body = middleware.call({"QUERY_STRING" => "request_recorder=3-foo"})
     stored.size.should == 1
     stored.values.last.scan("SELECT").size.should == 1
     cookie = headers["Set-Cookie"].split(";").first

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_recorder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2013-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -87,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2574127840943451255
+      hash: -617741979871775185
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -96,10 +112,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2574127840943451255
+      hash: -617741979871775185
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Record your rack/rails requests and store them for future inspection