logster 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad8ab40a4cbb66a605f51194121b6d53c06b535d
-  data.tar.gz: 62a4583c35dc53e28ae789ff3c4d74304bce8861
+  metadata.gz: eadf4ac198a2256f98ce3bfcb70be74dbe2056eb
+  data.tar.gz: c85f2dac78f07d7cc0b77eedcafd1572942e9ebe
 SHA512:
-  metadata.gz: 0a750c530e9b5b2365ba544aa034a9433992d24ef7da5c79d688263946d999445284f3c79682c2341b54ec7885f10bf7c95e5572467008c72a0da7b5327d7cd9
-  data.tar.gz: 5706d286cad50e1a00200be2a78199284b44076ab3aa8c028b17ba7a6e16072edc4e0873d4643637721050df1a218beca5d426374b617f74bd9cfd808d5458bf
+  metadata.gz: caee98bce33d83120e194452898da0533a1ffcd180c05f8c893563b0039d453b3cd6620cf9a5ffa333722ee1cabc17eefb1c2c61acddfb31afb739f61642b2c9
+  data.tar.gz: 7b35e552e33df43b0d3e513f68cc380b21064b48df88b82f5aaa333345844b457f7f677a0ef79a1492e4049cf9bb5d2d91b1333bb42fdc6abaf73a2c60723c85

data/README.md

@@ -17,15 +17,17 @@ And then execute:
 
     $ bundle
 
-Logster will wire up `/logs` path in your Rails app in **development** mode only. Production mode is being worked on.
+Logster will wire up `/logs` path in your Rails app in **development** mode only. To wire up in production you will need to set
 
-## Usage
+```
+Logster.config.authorize_callback = lambda{|env| your_own_can_see_logs? }
+```
 
-Logster is in current development, at the moment the focus is on a decent tool for dev. Once that is complete production mode will be built.
+## Usage
 
 The concept is to have an embedded "exception reporting service" admins can view on live sites.
 
-Logs will be visible by default at `http://sitename.com/logs`, only dev mode is implemented now. 
+Logs will be visible by default at `http://sitename.com/logs`
 
 ## Thanks
 
@@ -56,3 +58,7 @@ Logster UI is built using [Ember.js](http://emberjs.com/)
   - Fix pacakging binstubs by mistake
 - 2014-05-13: Version 0.0.9
   - Stray debugger message removed, add window.location logging to js
+- 2014-05-24: Version 0.0.10
+  - Correct context for error reporting
+  - Clean up backtraces of reported exceptions
+  - Report params in env tab

data/assets/javascript/app.js

@@ -62,8 +62,19 @@ App.Message = Ember.Object.extend({
     if(env){
       var buffer = [];
       _.each(env, function(v,k){
-        buffer.push(k + ": " + v);
+        if(k !== "params"){
+          buffer.push(k + ": " + v);
+        }
       });
+
+      buffer.push("");
+      if(_.size(env.params) > 0){
+        buffer.push("Params:");
+        buffer.push("");
+        _.each(env.params, function(v,k){
+          buffer.push("  " + k + ": " + v);
+        });
+      }
       return buffer.join("\n");
     }
 

data/lib/logster/configuration.rb

@@ -1,5 +1,5 @@
 module Logster
   class Configuration
-    attr_accessor :authorize_callback, :subdirectory
+    attr_accessor :authorize_callback, :subdirectory, :current_context
   end
 end

data/lib/logster/logger.rb

@@ -4,7 +4,7 @@ module Logster
   class Logger < ::Logger
     LOGSTER_ENV = "logster_env".freeze
 
-    attr_accessor :store
+    attr_accessor :store, :skip_store
 
     def initialize(store)
       super(nil)
@@ -16,6 +16,7 @@ module Logster
       @chained << logger
     end
 
+
     def add(severity, message, progname, &block)
       if severity < @level
         return true
@@ -41,6 +42,8 @@ module Logster
         end
       end
 
+      return if @skip_store
+
       @store.report(severity, progname, message, {
         env: Thread.current[LOGSTER_ENV]
       })

data/lib/logster/message.rb

@@ -59,6 +59,16 @@ module Logster
     def self.populate_from_env(env)
       env[LOGSTER_ENV] ||= begin
           scrubbed = {}
+          request = Rack::Request.new(env)
+          params = {}
+          request.params.each do |k,v|
+            if k.include? "password"
+              params[k] = "[reducted]"
+            else
+              params[k] = v[0..100]
+            end
+          end
+          scrubbed["params"] = params if params.length > 0
           ALLOWED_ENV.map{ |k|
            scrubbed[k] = env[k] if env[k]
           }

data/lib/logster/middleware/debug_exceptions.rb

@@ -0,0 +1,19 @@
+class Logster::Middleware::DebugExceptions < ActionDispatch::DebugExceptions
+  private
+
+  def log_error(env,wrapper)
+    Logster.logger.skip_store = true
+    exception = wrapper.exception
+
+    Logster.config.current_context.call(env) do
+       Logster.store.report(::Logger::Severity::FATAL,
+                        "web",
+                        exception.class.to_s << " (" << exception.to_s << ")",
+                        backtrace: exception.backtrace.join("\n"),
+                        env: env)
+    end
+    super(env, wrapper)
+  ensure
+    Logster.logger.skip_store = false
+  end
+end

data/lib/logster/middleware/reporter.rb

@@ -14,7 +14,10 @@ module Logster
 
         path = env[PATH_INFO]
         if path == @error_path
-          return report_js_error(env)
+          Logster.config.current_context.call(env) do
+            report_js_error(env)
+          end
+          return [200,{},["OK"]]
         end
 
         @app.call(env)
@@ -36,7 +39,6 @@ module Logster
                             message,
                             backtrace: backtrace,
                             env: env)
-        [200,{},["OK"]]
       end
 
     end

data/lib/logster/middleware/viewer.rb

@@ -16,7 +16,6 @@ module Logster
 
         @assets_path = File.expand_path("../../../../assets", __FILE__)
         @fileserver = Rack::File.new(@assets_path)
-        @authorize_callback = Logster.config.authorize_callback
       end
 
       def call(env)
@@ -29,7 +28,7 @@ module Logster
 
         if resource = resolve_path(path)
 
-          return @app.call(env) if @authorize_callback && !@authorize_callback.call(env)
+          return @app.call(env) if !Logster.config.authorize_callback.call(env)
 
           if resource =~ /\.js$|\.handlebars$|\.css$/
             env[PATH_INFO] = resource

data/lib/logster/rails/railtie.rb

@@ -8,7 +8,7 @@ module Logster::Rails
     return unless Rails.env.development? || Rails.env.production?
 
     if defined?(Redis)
-      require 'logster/middleware/viewer'
+      require 'logster/middleware/debug_exceptions'
       require 'logster/middleware/reporter'
       require 'logster/redis_store'
 
@@ -25,18 +25,14 @@ module Logster::Rails
     end
   end
 
+
   def self.initialize!(app)
     return unless Rails.env.development? || Rails.env.production?
 
     if Logster::Logger === Rails.logger
-      if Rails.env.development?
-        # in production you must mount in routes.rb
-        # or by inserting middleware
-        app.middleware.use Logster::Middleware::Viewer
-      end
-
       app.middleware.insert_before ActionDispatch::ShowExceptions, Logster::Middleware::Reporter
-
+      app.middleware.insert_before ActionDispatch::DebugExceptions, Logster::Middleware::DebugExceptions, Rails.application
+      app.middleware.delete ActionDispatch::DebugExceptions
       app.config.colorize_logging = false
     end
   end
@@ -44,6 +40,9 @@ module Logster::Rails
   class Railtie < ::Rails::Railtie
 
     config.before_initialize do
+      Logster.config.authorize_callback = lambda {|env|
+        Rails.env == "development"
+      }
       Logster::Rails.set_logger(config)
     end
 

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
 module Logster
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/lib/logster/web.rb

@@ -0,0 +1,8 @@
+require 'logster/middleware/viewer'
+
+class Logster::Web
+  def self.call(env)
+    @middleware ||= Logster::Middleware::Viewer.new(nil)
+    @middleware.call(env)
+  end
+end

data/lib/logster.rb

@@ -1,6 +1,7 @@
 require 'logster/logger'
 require 'logster/message'
 require 'logster/configuration'
+require 'logster/web'
 
 module Logster
   def self.logger=(logger)
@@ -33,6 +34,9 @@ module Logster
   end
 end
 
+Logster.config.current_context = lambda{|env, &block| block.call}
+Logster.config.authorize_callback = lambda{|env| true}
+
 if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3
   require 'logster/rails/railtie'
 end

data/test/logster/middleware/test_reporter.rb

@@ -0,0 +1,21 @@
+require_relative '../../test_helper'
+require 'rack'
+require 'logster/redis_store'
+require 'logster/middleware/reporter'
+
+
+class TestReporter < Minitest::Test
+
+  def test_logs_errors
+    Logster.store = Logster::TestStore.new
+
+    reporter = Logster::Middleware::Reporter.new(nil)
+    env = Rack::MockRequest.env_for("/logs/report_js_error?message=hello")
+    status, = reporter.call(env)
+
+    assert_equal(200, status)
+    assert_equal(1, Logster.store.reported.length)
+  end
+
+end
+

data/test/logster/test_redis_store.rb

@@ -1,5 +1,6 @@
 require_relative '../test_helper'
 require 'logster/redis_store'
+require 'rack'
 
 class TestRedisStore < Minitest::Test
 
@@ -148,18 +149,26 @@ class TestRedisStore < Minitest::Test
   end
 
   def test_env
-    env = {
-      "REQUEST_URI" => "/test",
+    env = Rack::MockRequest.env_for("/test").merge({
       "HTTP_HOST" => "www.site.com",
-      "REQUEST_METHOD" => "GET",
       "HTTP_USER_AGENT" => "SOME WHERE"
-    }
+    })
     orig = env.dup
     orig["test"] = "tests"
     orig["test1"] = "tests1"
-
     Logster.add_to_env(env,"test","tests")
     Logster.add_to_env(env,"test1","tests1")
+
+    orig.delete_if do |k,v|
+      !%w{
+        HTTP_HOST
+        REQUEST_METHOD
+        HTTP_USER_AGENT
+        test
+        test1
+      }.include? k
+    end
+
     @store.report(Logger::INFO, "test", "test",  env: env)
     assert_equal(orig, @store.latest.last.env)
   end

data/test/test_helper.rb

@@ -5,3 +5,14 @@ require 'minitest/pride'
 require 'logster'
 require 'redis'
 
+
+class Logster::TestStore
+  attr_accessor :reported
+  def initialize
+    @reported = []
+  end
+
+  def report(*args)
+    @reported << args
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - UI for viewing logs in Rack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,12 +125,15 @@ files:
 - lib/logster/configuration.rb
 - lib/logster/logger.rb
 - lib/logster/message.rb
+- lib/logster/middleware/debug_exceptions.rb
 - lib/logster/middleware/reporter.rb
 - lib/logster/middleware/viewer.rb
 - lib/logster/rails/railtie.rb
 - lib/logster/redis_store.rb
 - lib/logster/version.rb
+- lib/logster/web.rb
 - logster.gemspec
+- test/logster/middleware/test_reporter.rb
 - test/logster/middleware/test_viewer.rb
 - test/logster/test_logger.rb
 - test/logster/test_redis_store.rb
@@ -161,6 +164,7 @@ signing_key:
 specification_version: 4
 summary: UI for viewing logs in Rack
 test_files:
+- test/logster/middleware/test_reporter.rb
 - test/logster/middleware/test_viewer.rb
 - test/logster/test_logger.rb
 - test/logster/test_redis_store.rb