rorvswild 1.5.7 → 1.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 185e306b95a9f95fe78161e62e5e8e03d43ce8f892ad2350882ba44e07ba7d9e
-  data.tar.gz: 8b5e2bba0d15a48f1bde89cd804bd56535e957069b6b1acd59ccec96ec4d2857
+  metadata.gz: 48093e6f93439e8216bd5b0c631b6b56386281d9792f728312d227634834ee11
+  data.tar.gz: 9d7cc84527fc054d47e17ed8f8c736c119660f59d7f077a24b420588875e0685
 SHA512:
-  metadata.gz: 15ae6b40fcf59aa4eabe7db0b0068239b49cd4311d2a03014484110fc51c5574ee00b068549298c720aef4bbe2f9280c480b026887589b999a0f41792b89d116
-  data.tar.gz: bd616d7f191bf7296a4d537e4e9edd81bc4d791e46ecd237da8370c5d3031c697eb43545c429ff2040e8a9e41df2cce68ff1e9a077e2ac1a4a65fa4eb4f05453
+  metadata.gz: 55d90ef1666a3e5696cfbf998a13446d8dc2cddeccf05d56d5dcc6aa3855e5bd5443eb0dccd0b2d54e6af00b1e5babce359fabd2899a4a624a0fcb9f5ab1a5c4
+  data.tar.gz: 909982650664ed49fed2103c7e031ae761ccea22eb5fd39bb82b85e2e3996fd7ec28b891b2151d41ebeadae6f2076ff3c14d895e0a552c006e444e6178d77754

data/README.md

@@ -4,7 +4,7 @@
 [![Gem Version](https://badge.fury.io/rb/rorvswild.svg)](https://badge.fury.io/rb/rorvswild)
 [![Maintainability](https://api.codeclimate.com/v1/badges/2c4805cf658d7af794fe/maintainability)](https://codeclimate.com/github/BaseSecrete/rorvswild/maintainability)
 
-<img align="right" src="/images/rorvswild_logo.jpg">
+<img align="right" src="./images/rorvswild_logo.jpg">
 
 *RoRvsWild* is a ruby gem to monitor performances and exceptions in Ruby on Rails applications.
 
@@ -21,7 +21,7 @@ It can also be used in your production and staging environments with an account
 * Run `bundle install` in you terminal
 * Restart your local server and you’ll see a small button in the bottom left corner of your page.
 
-![RoRvsWild Local Button](/images/rorvswild_local_button.jpg)
+![RoRvsWild Local Button](./images/rorvswild_local_button.jpg)
 
 This is all what you need to do to monitor your local environment requests.
 
@@ -47,15 +47,30 @@ 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)
+![RoRvsWild Local](./images/rorvswild_local.jpg)
 
 *RorVsWild Local* monitors the performances of requests in development environment.
 It shows most of the requests performances insights *RoRvsWild.com* displays. **A big difference is everything works locally and no data is sent and recorded on our servers**. You don’t even need an account to use it.
 
 *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:
 
@@ -69,7 +84,7 @@ If you are using `Rack::Deflater` middleware you won't see the small button in t
 
 ## Production mode: *RoRvsWild.com*
 
-![RoRvsWild.com](/images/rorvswild_prod.jpg)
+![RoRvsWild.com](./images/rorvswild_prod.jpg)
 
 *RoRvsWild.com* makes it easy to monitor requests, background jobs and errors in your production and staging environment.
 It also comes with some extra options listed below.

data/lib/rorvswild/agent.rb

@@ -1,4 +1,6 @@
 require "logger"
+require "socket"
+require "etc"
 
 module RorVsWild
   class Agent
@@ -26,9 +28,9 @@ module RorVsWild
       @config = self.class.default_config.merge(config)
       @client = Client.new(@config)
       @queue = config[:queue] || Queue.new(client)
-      @locator = RorVsWild::Locator.new(defined?(Rails) ? Rails.root.to_s : ENV["PWD"])
+      @locator = RorVsWild::Locator.new
 
-      RorVsWild.logger.info("Start RorVsWild #{RorVsWild::VERSION}")
+      RorVsWild.logger.debug("Start RorVsWild #{RorVsWild::VERSION}")
       setup_plugins
       cleanup_data
     end
@@ -37,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
@@ -72,7 +74,7 @@ module RorVsWild
       begin
         block.call
       rescue Exception => ex
-        push_exception(ex, parameters: parameters)
+        push_exception(ex, parameters: parameters, job: {name: name})
         raise
       ensure
         current_data[:runtime] = RorVsWild.clock_milliseconds - current_data[:started_at]
@@ -105,6 +107,7 @@ 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]
@@ -168,11 +171,26 @@ module RorVsWild
         backtrace: exception.backtrace || ["No backtrace"],
         exception: exception.class.to_s,
         extra_details: extra_details,
+        environment: {
+          os: os_description,
+          user: Etc.getlogin,
+          host: Socket.gethostname,
+          ruby: RUBY_DESCRIPTION,
+          pid: Process.pid,
+          cwd: Dir.pwd,
+          lib_paths: locator.lib_paths,
+        },
       }
     end
 
     def ignored_exception?(exception)
       (config[:ignored_exceptions] || config[:ignore_exceptions]).include?(exception.class.to_s)
     end
+
+    def os_description
+      @os_description ||= `uname -a`
+    rescue Exception => ex
+      @os_description = RUBY_PLATFORM
+    end
   end
 end

data/lib/rorvswild/client.rb

@@ -21,7 +21,11 @@ module RorVsWild
       @connection_count = 0
       @mutex = Mutex.new
       @config = config
-      @headers = {"Content-Type" => "application/json", "X-Gem-Version" => RorVsWild::VERSION}
+      @headers = {
+        "Content-Type" => "application/json",
+        "X-RorVsWild-Version" => RorVsWild::VERSION,
+        "X-Ruby-Version" => RUBY_VERSION,
+      }
       @headers["X-Rails-Version"] = Rails.version if defined?(Rails)
     end
 

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/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

@@ -26,6 +26,7 @@ module RorVsWild
 
       def serve_embed_profiler(env)
         status, headers, body = app.call(env)
+        status = status.to_i
         if status >= 200 && status < 300 && headers["Content-Type"] && headers["Content-Type"].include?("text/html")
           if headers["Content-Encoding"]
             log_incompatible_middleware_warning
@@ -55,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/locator.rb

@@ -2,8 +2,8 @@ module RorVsWild
   class Locator
     attr_reader :current_path
 
-    def initialize(current_path = ENV["PWD"])
-      @current_path = current_path
+    def initialize(current_path = Dir.pwd)
+      @current_path = File.join(current_path, "")
     end
 
     def find_most_relevant_file_and_line(locations)
@@ -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
 
@@ -42,26 +42,25 @@ module RorVsWild
     end
 
     def irrelevant_path?(path)
-      path.start_with?(*irrelevant_paths)
+      path.start_with?(*lib_paths)
     end
 
-    def irrelevant_paths
-      @irrelevant_paths ||= initialize_irrelevant_paths
+    def lib_paths
+      @lib_paths ||= initialize_lib_paths
+    end
+
+    def rorvswild_lib_path
+      @rorvswild_lib_path ||= File.dirname(File.expand_path(__FILE__))
     end
 
     private
 
-    def initialize_irrelevant_paths
-      array = ["RUBYLIB", "GEM_HOME", "GEM_PATH", "BUNDLER_ORIG_GEM_PATH"].flat_map do |name|
+    def initialize_lib_paths
+      array = [RbConfig::CONFIG["rubylibprefix"]] + Gem.default_path + Gem.path
+      array += ["RUBYLIB", "GEM_HOME", "GEM_PATH", "BUNDLER_ORIG_GEM_PATH"].flat_map do |name|
         ENV[name].split(":".freeze) if ENV[name]
       end
-      array += [heroku_ruby_lib_path] if File.exists?(heroku_ruby_lib_path)
-      array += Gem.path
       array.compact.uniq
     end
-
-    def heroku_ruby_lib_path
-      "/app/vendor/ruby-#{RUBY_VERSION}/lib"
-    end
   end
 end

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
@@ -35,7 +35,12 @@ module RorVsWild
         if hash = RorVsWild.agent.push_exception(exception)
           hash[:session] = controller.session.to_hash
           hash[:parameters] = controller.request.filtered_parameters
-          hash[:environment_variables] = extract_http_headers(controller.request.filtered_env)
+          hash[:request] = {
+            headers: extract_http_headers(controller.request.filtered_env),
+            name: "#{controller.class}##{controller.action_name}",
+            method: controller.request.method,
+            url: controller.request.url,
+          }
         end
         raise exception
       end

data/lib/rorvswild/plugin/resque.rb

@@ -2,7 +2,9 @@ module RorVsWild
   module Plugin
     module Resque
       def self.setup
+        return if @installed
         ::Resque::Job.send(:extend, Resque) if defined?(::Resque::Job)
+        @installed = true
       end
 
       def around_perform_rorvswild(*args, &block)

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/section.rb

@@ -66,5 +66,13 @@ module RorVsWild
     def command=(value)
       @command = value && value.size > COMMAND_MAX_SIZE ? value[0, COMMAND_MAX_SIZE] + " [TRUNCATED]" : value
     end
+
+    def to_h
+      {calls: calls, total_runtime: total_runtime, children_runtime: children_runtime, kind: kind, started_at: started_at, file: file, line: line, command: command}
+    end
+
+    def to_json(options = {})
+      to_h.to_json(options)
+    end
   end
 end

data/lib/rorvswild/version.rb

@@ -1,3 +1,3 @@
 module RorVsWild
-  VERSION = "1.5.7".freeze
+  VERSION = "1.5.12".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.5.7
+  version: 1.5.12
 platform: ruby
 authors:
 - Alexis Bernard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2021-05-22 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