rack-insight 0.5.21 → 0.5.22

data/CHANGELOG

@@ -1,5 +1,31 @@
 == HEAD
 
+== 0.5.22 / 2012-09-14
+
+  * New Features
+
+    * Improve handling of decoding and marshalling problems with new config options and implementation: (pboling - Peter Boling)
+
+      :database => a hash.  Keys :raise_encoding_errors, and :raise_decoding_errors are self explanatory
+                   :raise_encoding_errors
+                       When set to true, if there is an encoding error (unlikely)
+                       it will cause a 500 error on your site.  !!!WARNING!!!
+                   :raise_decoding_errors
+                       The bundled panels should work fine with :raise_decoding_errors set to true or false
+                       but custom panel implementations may prefer one over the other
+                       The bundled panels will capture these errors and perform admirably.
+                       Site won't go down unless a custom panel is not handling the errors well.
+
+  * Bug Fixes
+
+    * Fixes for redis panel. (oggy - George Ogata)
+
+  * Other
+
+    * Error system improvements and refactoring (pboling - Peter Boling)
+
+    * Internal config validation system (pboling - Peter Boling)
+
 == 0.5.21 / 2012-09-13 - Peter Boling
 
   * Attempting to handle values that get stored in the sqlite db, but which can't be re-marshalled, without failing the entire panel

data/README.md

@@ -127,6 +127,15 @@ Options:
                 "Logger" => [:instance, :add]
         }}
 
+    :database => a hash.  Keys :raise_encoding_errors, and :raise_decoding_errors are self explanatory
+                 :raise_encoding_errors
+                     When set to true, if there is an encoding error (unlikely)
+                     it will cause a 500 error on your site.  !!!WARNING!!!
+                 :raise_decoding_errors
+                     The bundled panels should work fine with :raise_decoding_errors set to true or false
+                     but custom panel implementations may prefer one over the other
+                     The bundled panels will capture these errors and perform admirably.
+                     Site won't go down unless a custom panel is not handling the errors well.
 
 Configure Middleware
 --------------------
@@ -200,7 +209,7 @@ Restrict access using a password:
       :ip_masks   => false # Default is 127.0.0.1
       :password   => "yourpassword"
 
-#### custom file path for the logging database ####
+#### custom file path for the request recording database ####
 
 Logical Rack::Insight uses SQLite to store data from requests, and outputs a database
 file in the root directory. If you need the file to be created at another

data/lib/rack/insight/config.rb

@@ -2,7 +2,8 @@ module Rack::Insight
   class Config
     class << self
       attr_reader :config, :verbosity, :log_file, :log_level, :rails_log_copy,
-                  :filtered_backtrace, :panel_configs, :silence_magic_insight_warnings
+                  :filtered_backtrace, :panel_configs, :silence_magic_insight_warnings,
+                  :database
     end
     @log_file = STDOUT
     @log_level = ::Logger::DEBUG
@@ -26,6 +27,10 @@ module Rack::Insight
       :templates => {:probes => {'ActionView::Template' => [:instance, :render]}}
     }
     @silence_magic_insight_warnings = false
+    @database = {
+      :raise_encoding_errors => false,  # Either way will be logged
+      :raise_decoding_errors => true,   # Either way will be logged
+    }
 
     DEFAULTS = {
       # You can augment or replace the default set of panel load paths.
@@ -45,7 +50,16 @@ module Rack::Insight
       :verbosity => @verbosity, # true is equivalent to relying soley on the log level of each logged message
       :filtered_backtrace => @filtered_backtrace, # Full backtraces, or filtered ones?
       :panel_configs => @panel_configs, # Allow specific panels to have their own configurations, and make it extensible
-      :silence_magic_insight_warnings => @silence_magic_insight_warnings # Should Rack::Insight warn when the MagicInsight is used?
+      :silence_magic_insight_warnings => @silence_magic_insight_warnings, # Should Rack::Insight warn when the MagicInsight is used?
+      :database => @database # a hash.  Keys :raise_encoding_errors, and :raise_decoding_errors are self explanatory
+                             # :raise_encoding_errors
+                             #    When set to true, if there is an encoding error (unlikely)
+                             #    it will cause a 500 error on your site.  !!!WARNING!!!
+                             # :raise_decoding_errors
+                             #    The bundled panels should work fine with :raise_decoding_errors set to true or false
+                             #    but custom panel implementations may prefer one over the other
+                             #    The bundled panels will capture these errors and perform admirably.
+                             #    Site won't go down unless a custom panel is not handling the errors well.
     }
 
     @config ||= DEFAULTS
@@ -53,21 +67,34 @@ module Rack::Insight
       yield @config
       logger.debug("Rack::Insight::Config#configure:\n  called from: #{caller[0]}\n  with: #{@config}") if config[:verbosity] == true || config[:verbosity].respond_to?(:<) && config[:verbosity] <= 1
       @logger = config[:logger]
-      @log_level = config[:log_level]
-      @log_file = config[:log_file]
+      if @logger.nil?
+        @log_level = config[:log_level]
+        @log_file = config[:log_file]
+      elsif config[:log_level] || config[:log_file]
+        logger.warn("Rack::Insight::Config#configure: when logger is set, log_level and log_file have no effect, and will only confuse you.")
+      end
       @verbosity = config[:verbosity]
       @filtered_backtrace = config[:filtered_backtrace]
       @silence_magic_insight_warnings = config[:silence_magic_insight_warnings]
+      @database = config[:database]
 
       config[:panel_configs].each do |panel_name_sym, config|
         set_panel_config(panel_name_sym, config)
       end
 
-      unless config[:panel_load_paths].kind_of?(Array)
-        raise "Rack::Insight::Config.config[:panel_load_paths] is invalid: Expected kind of Array but got #{config[:panel_load_paths].class}"
-      end
-      unless config[:panel_configs].kind_of?(Hash)
-        raise "Rack::Insight::Config.config[:panel_configs] is invalid: Expected kind of Hash but got #{config[:panel_configs].class}"
+      validate_config(:panel_configs, Hash)
+      validate_config(:panel_load_paths, Array)
+      validate_config(:database, Hash)
+    end
+
+    def self.validate_config(key, klass)
+      raise ConfigurationError.new(key, klass.to_s) unless config[key].kind_of?(klass)
+    end
+
+    class ConfigurationError < StandardError;
+      def self.new(key, expected)
+        actual = Rack::Insight::Config.config[key].class
+        super("Rack::Insight::Config.config[:#{key}] is invalid: Expected kind of #{expected} but got #{actual}")
       end
     end
 

data/lib/rack/insight/database.rb

@@ -14,6 +14,7 @@ module Rack::Insight
     #      # Setting as below is only required when not using a table (Why are you including this module then?)
     #      # self.has_table = false
     #    end
+    # TODO: Move the has_table definition into this module's included hook.
     module RequestDataClient
       def key_sql_template(sql)
         @key_sql_template = sql
@@ -185,12 +186,39 @@ module Rack::Insight
         insert(sql)
       end
 
+      # We sometimes get errors in the encoding and decoding, and they could be from any number of root causes.
+      # This will allow those root causes to be exposed at the top layer by wrapping all errors in a Rack::Insight
+      # namespaced error class, which will be rescued higher up the stack.
+      module ErrorWrapper
+        def new(parent, message = '')
+          ex = super("#{message}#{parent.class}: #{parent.message}")
+          ex.set_backtrace parent.backtrace
+          ex
+        end
+      end
+
+      class EncodingError < StandardError
+        extend ErrorWrapper
+      end
+
+      class DecodingError < StandardError
+        extend ErrorWrapper
+      end
+
       def encode_value(value)
         Base64.encode64(YAML.dump(value))
+      rescue Exception => ex
+        wrapped = EncodingError.new(ex, "Rack::Insight::Database#encode_value failed with error: ")
+        logger.error(wrapped)
+        raise wrapped if Rack::Insight::Config.database[:raise_encoding_errors]
       end
 
       def decode_value(value)
-        YAML.load(Base64.decode64(value)) rescue "Unable to decode"
+        YAML.load(Base64.decode64(value))
+      rescue Exception => ex
+        wrapped = DecodingError.new(ex, "Rack::Insight::Database#decode_value failed with error: ")
+        logger.error(wrapped)
+        raise wrapped if Rack::Insight::Config.database[:raise_decoding_errors]
       end
 
       def retrieve(key_sql)

data/lib/rack/insight/panels/redis_panel/redis_extension.rb

@@ -12,9 +12,9 @@ if defined?(Redis)
     elsif defined?(Redis::Client) # newer versions of redis-rb
 
       Redis::Client.class_eval do
-        def call_with_insight(*argv)
-          Rack::Insight::RedisPanel.record(argv, Kernel.caller) do
-            call_without_insight(*argv)
+        def call_with_insight(command, &block)
+          Rack::Insight::RedisPanel.record(command, Kernel.caller) do
+            call_without_insight(command, &block)
           end
         end
       end

data/lib/rack/insight/version.rb

@@ -1,7 +1,7 @@
 module Rack
   module Insight
 
-  VERSION = '0.5.21'
+  VERSION = '0.5.22'
 
   end
 end

data/lib/rack/insight/views/decoding_error.html.erb

@@ -0,0 +1,14 @@
+<h3><%= name %></h3>
+<p>Unable to Decoding or Marshalling Objects from rack-insight data storage.</p>
+<h4>Error</h4>
+<p><%= @error.message %></p>
+<h4>Backtrace</h4>
+<p>
+  <pre>
+    <code>
+      <%- @error.backtrace.each do |line| %>
+        <%= line %>
+      <%- end %>
+    </code>
+  </pre>
+</p>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-insight
 version: !ruby/object:Gem::Version
-  version: 0.5.21
+  version: 0.5.22
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000 Z
+date: 2012-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -283,6 +283,7 @@ files:
 - lib/rack/insight/rspec_matchers.rb
 - lib/rack/insight/toolbar.rb
 - lib/rack/insight/version.rb
+- lib/rack/insight/views/decoding_error.html.erb
 - lib/rack/insight/views/enable-button.html.erb
 - lib/rack/insight/views/error.html.erb
 - lib/rack/insight/views/headers_fragment.html.erb