rorvswild 1.5.9 → 1.5.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82e99bed32ec2670bc121da6de38cdfa320cf2d86f1e09004f08629eab6c0040
-  data.tar.gz: d92ed6e8faa815ff9be3dd3d6ee8528a5c9b43824c803616c0106276111baf45
+  metadata.gz: 262b40730d9fc77d334a2f3b4da10d4ddaea1cbd06b5c6c7da320d214ce18715
+  data.tar.gz: abe5d9f0bcda336c7ced3a1eee9071c3d9fdef32c9c49c45914fb483d093ed2f
 SHA512:
-  metadata.gz: 3b48fea4d285459afe675e47cde1a2ca2cd658f09dcc742b8f425e83dfa346714940688bbcbd83a356db24c154ea7bb15643b68e673714563a35261416cc6eec
-  data.tar.gz: 3162a68b10887ea2733757f7bd7cf3edb8b76479e6f558ac2f096aa3e9225486350dca307c22611743448cc0801b0883c42b42b16f25cf6096e39586c6c34955
+  metadata.gz: 2b809c27a4e650398c384ee828026381828d145393ea13f31d02cedc9b17be540dd0bec22845b293526d33658b33e5118faddaebf21866016c902f233e30a722
+  data.tar.gz: 9c75b3789da4f450ee58bd47b9bdbb536b6076a28af82366b2c18f4546e5e2d04cbe8df5c4db1362731b83719e1713a2525bc03b25cb5108eab56827056717a5

data/README.md

@@ -47,6 +47,8 @@ RorVsWild.start(api_key: API_KEY)
 
 You can create unlimited apps on *rorvswild.com*. If you want to monitor your staging environment, create a new app and edit your rorvswild.yml to add the API key.
 
+In case there is no data in the dashboard, you can run in a rails console : `RorVsWild.check`.
+
 ## Development mode: *RoRvsWild Local*
 
 ![RoRvsWild Local](./images/rorvswild_local.jpg)
@@ -56,6 +58,19 @@ It shows most of the requests performances insights *RoRvsWild.com* displays. **
 
 *RoRvsWild Local* renders a small button in the bottom left corner of your page showing the runtime of the current request. If you click on it, you get all the profiled sections ordered by impact, which is depending on the sections average runtime and the calls count. As on RoRvsWild.com, the bottleneck is always on the top of the list.
 
+You may want to hide or change the widget position like in the example below with the `widget` option :
+
+```yaml
+# config/rorvswild.yml
+
+development:
+  widget: top-right 
+  
+#accepted values : top-left, top-right, bottom-right, bottom-left (default), hidden
+```
+
+You can still access the profiler at http://localhost:3000/rorvswild if you choose to hide the widget.
+
 Be aware that the performances on your development machine may vary from the production server. Obviously because of the different hardware and database size. Also, Rails is reloading all the code in development environment and this takes quite a lot of time.
 To prevent this behaviour and better match the production, turn on cache_classes in your config/environments/development.rb:
 
@@ -121,6 +136,18 @@ RorVsWild.record_error(exception, {something: "important"})
 RorVsWild.catch_error(something: "important") { 1 / 0 }
 ```
 
+It is also possible to pre-fill this context data at the begining of each request or job :
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :prefill_error_context
+
+  def prefill_error_context
+    RorVsWild.merge_error_context(something: "important")
+  end
+end
+```
+
 #### Ignore requests, jobs, exceptions and plugins
 
 From the configuration file, you can tell RorVsWild to skip monitoring some requests, jobs, exceptions and plugins.

data/lib/rorvswild/agent.rb

@@ -30,7 +30,7 @@ module RorVsWild
       @queue = config[:queue] || Queue.new(client)
       @locator = RorVsWild::Locator.new
 
-      RorVsWild.logger.info("Start RorVsWild #{RorVsWild::VERSION}")
+      RorVsWild.logger.debug("Start RorVsWild #{RorVsWild::VERSION}")
       setup_plugins
       cleanup_data
     end
@@ -39,7 +39,7 @@ module RorVsWild
       for name in RorVsWild::Plugin.constants
         next if config[:ignore_plugins] && config[:ignore_plugins].include?(name.to_s)
         if (plugin = RorVsWild::Plugin.const_get(name)).respond_to?(:setup)
-          RorVsWild.logger.info("Setup RorVsWild::Plugin::#{name}")
+          RorVsWild.logger.debug("Setup RorVsWild::Plugin::#{name}")
           plugin.setup
         end
       end
@@ -107,11 +107,24 @@ module RorVsWild
 
     def push_exception(exception, options = nil)
       return if ignored_exception?(exception)
+      return unless current_data
       current_data[:error] = exception_to_hash(exception)
       current_data[:error].merge!(options) if options
       current_data[:error]
     end
 
+    def merge_error_context(hash)
+      self.error_context = error_context ? error_context.merge(hash) : hash
+    end
+
+    def error_context
+      current_data[:error_context] if current_data
+    end
+
+    def error_context=(hash)
+      current_data[:error_context] = hash if current_data
+    end
+
     def current_data
       Thread.current[:rorvswild_data]
     end
@@ -161,15 +174,16 @@ module RorVsWild
       client.post_async("/errors".freeze, error: hash)
     end
 
-    def exception_to_hash(exception, extra_details = nil)
+    def exception_to_hash(exception, context = nil)
       file, line = locator.find_most_relevant_file_and_line_from_exception(exception)
+      context = context ? error_context.merge(context) : error_context if error_context
       {
         line: line.to_i,
         file: locator.relative_path(file),
         message: exception.message,
         backtrace: exception.backtrace || ["No backtrace"],
         exception: exception.class.to_s,
-        extra_details: extra_details,
+        extra_details: context,
         environment: {
           os: os_description,
           user: Etc.getlogin,

data/lib/rorvswild/local/{local.html → local.html.erb}

@@ -1,4 +1,4 @@
-<div id="RorVsWild.Local">
+<div id="RorVsWild.Local" class="<%= widget_css %>">
   <div data-barber="RorVsWild.Local">
   </div>
 </div>

data/lib/rorvswild/local/middleware.rb

@@ -56,9 +56,15 @@ module RorVsWild
 
       private
 
+      def widget_css
+        config = RorVsWild.agent.config
+        config && config[:widget] && "is-#{config[:widget]}"
+      end
+
       def inject_into(html)
         if index = html.index("</body>")
-          markup = File.read(File.join(LOCAL_FOLDER, "local.html"))
+          markup = File.read(File.join(LOCAL_FOLDER, "local.html.erb"))
+          markup = ERB.new(markup).result(binding)
           markup = markup.html_safe if markup.respond_to?(:html_safe)
           html.insert(index, markup)
         end

data/lib/rorvswild/local/stylesheet/local.css

@@ -25,6 +25,30 @@
   display: inline-block !important;
 }
 
+/************* TOGGLER POSITION OPTION(default bottom-left)**********************/
+
+.is-top-right .rorvswild-local-toggler {
+  bottom: auto !important;
+  left: auto !important;
+  right: 12px !important;
+  top: 12px !important;
+}
+
+.is-top-left .rorvswild-local-toggler {
+  bottom: auto !important;
+  top: 12px !important;
+}
+
+.is-bottom-right .rorvswild-local-toggler {
+  bottom: 12px !important;
+  left: auto !important;
+  right: 12px !important;
+}
+
+.is-hidden .rorvswild-local-toggler {
+  display: none;
+}
+
 /********************************************/
 /*************** PANEL **********************/
 /********************************************/

data/lib/rorvswild/local.rb

@@ -3,9 +3,9 @@ require "rorvswild/local/queue"
 
 module RorVsWild
   module Local
-    def self.start
+    def self.start(config = {})
       Rails.application.config.middleware.unshift(RorVsWild::Local::Middleware, nil)
-      RorVsWild.start(queue: RorVsWild::Local::Queue.new)
+      RorVsWild.start(config.merge(queue: RorVsWild::Local::Queue.new))
     end
   end
 end

data/lib/rorvswild/locator.rb

@@ -12,7 +12,7 @@ module RorVsWild
     end
 
     def find_most_relevant_location(locations)
-      locations.find { |l| relevant_path?(l.path) } || locations.find { |l| !irrelevant_path?(l.path) } || locations.first
+      locations.find { |l| relevant_path?(l.path) } || locations.find { |l| !l.path.start_with?(rorvswild_lib_path) } || locations.first
     end
 
     def find_most_relevant_file_and_line_from_exception(exception)
@@ -29,7 +29,7 @@ module RorVsWild
 
     def find_most_relevant_file_and_line_from_array_of_strings(stack)
       location = stack.find { |str| relevant_path?(str) }
-      location ||= stack.find { |str| !irrelevant_path?(str) }
+      location ||= stack.find { |str| !str.start_with?(rorvswild_lib_path) }
       relative_path(location || stack.first).split(":".freeze)
     end
 
@@ -49,6 +49,10 @@ module RorVsWild
       @lib_paths ||= initialize_lib_paths
     end
 
+    def rorvswild_lib_path
+      @rorvswild_lib_path ||= File.dirname(File.expand_path(__FILE__))
+    end
+
     private
 
     def initialize_lib_paths

data/lib/rorvswild/plugin/action_controller.rb

@@ -23,7 +23,7 @@ module RorVsWild
             section.file, section.line = controller.method(method_name).source_location
             section.file = RorVsWild.agent.locator.relative_path(section.file)
             section.command = "#{controller.class}##{method_name}"
-            RorVsWild.agent.current_data[:name] = controller_action
+            RorVsWild.agent.current_data[:name] = controller_action if RorVsWild.agent.current_data
           end
           block.call
         ensure

data/lib/rorvswild/queue.rb

@@ -63,7 +63,7 @@ module RorVsWild
     end
 
     def start_thread
-      RorVsWild.logger.info("RorVsWild::Queue#start_thread".freeze)
+      RorVsWild.logger.debug("RorVsWild::Queue#start_thread".freeze)
       @thread = Thread.new { flush_indefinetely }
     end
 

data/lib/rorvswild/rails_loader.rb

@@ -10,20 +10,19 @@ module RorVsWild
     def self.start
       return if RorVsWild.agent
 
-      if (path = Rails.root.join("config/rorvswild.yml")).exist?
-        if config = RorVsWild::RailsLoader.load_config_file(path)[Rails.env]
-          RorVsWild.start(config.symbolize_keys)
-        end
-      end
-
-      if !RorVsWild.agent && Rails.env.development?
+      if (config = load_config) && config[:api_key]
+        RorVsWild.start(config)
+      elsif Rails.env.development?
         require "rorvswild/local"
-        RorVsWild::Local.start
+        RorVsWild::Local.start(config || {})
       end
     end
 
-    def self.load_config_file(path)
-      YAML.load(ERB.new(path.read).result)
+    def self.load_config
+      if (path = Rails.root.join("config/rorvswild.yml")).exist?
+        hash = YAML.load(ERB.new(path.read).result)[Rails.env]
+        hash && hash.deep_symbolize_keys
+      end
     end
   end
 end

data/lib/rorvswild/version.rb

@@ -1,3 +1,3 @@
 module RorVsWild
-  VERSION = "1.5.9".freeze
+  VERSION = "1.5.13".freeze
 end

data/lib/rorvswild.rb

@@ -39,6 +39,10 @@ module RorVsWild
     agent.record_error(exception, extra_details) if agent
   end
 
+  def self.merge_error_context(hash)
+    agent.merge_error_context(hash) if agent
+  end
+
   def self.initialize_logger(destination = nil)
     if destination.respond_to?(:info) && destination.respond_to?(:warn) && destination.respond_to?(:error)
       destination

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.5.13
 platform: ruby
 authors:
 - Alexis Bernard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-19 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies: []
 description: Performances and errors insights for rails developers.
 email:
@@ -34,7 +34,7 @@ files:
 - lib/rorvswild/local/javascript/vendor/barber.js
 - lib/rorvswild/local/javascript/vendor/mustache.js
 - lib/rorvswild/local/javascript/vendor/prism.js
-- lib/rorvswild/local/local.html
+- lib/rorvswild/local/local.html.erb
 - lib/rorvswild/local/middleware.rb
 - lib/rorvswild/local/queue.rb
 - lib/rorvswild/local/stylesheet/local.css