rorvswild 1.10.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec6464a7193ffe1e78cc6d84804a74e37dd66e20f086b357215e143cca8e3339
-  data.tar.gz: 0547a433e44c778c2f7199be0e6532325e572ac868f85b2209dd99eea1ba4593
+  metadata.gz: b29f5881ffc0b495ede8b88ca53f68161a5bbfa09ca4005c0384a18f17a77ce9
+  data.tar.gz: 8cf948c1c9ea720aeb35068160e61a506085194c3ad2f5caa5b43f6c6c5ee5a2
 SHA512:
-  metadata.gz: 5929a6e6deb9fab72c05e5446363ed3cab3368c2b3c7a2e68ef9e4fa58b0fcc1736421936b6153a8eab650f33a4337bb691744af4739bd99dad63db9c1dbdb2d
-  data.tar.gz: d5533fe4bc53ec97eed6d52e8637a7f231ffed0d56af0716d7e1713d0d3042d88620c201d50edb61e29af26bd786d666d30a403d54ff9b64d046b15ae180fb71
+  metadata.gz: 90e4b903eec8db8e89d3c6fdb77397bb75e7bb09212d7cc86fea9a865b1d5d13ab7ea9e9d9d7d199fda10ad20d3b5fb12749eb41841329de0db0b6893e05e6db
+  data.tar.gz: 1745b14bce30d4dccc1584e35c301f55b481156f8919e5030fee11c52e879ff6b7e77b2128b286d1566f0b407666799e6b4c6551b30e457a66b3ac213e1ce0bd

data/README.md

@@ -1,26 +1,25 @@
 
-# RorVsWild
+# RoRvsWild
 
 [![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" width="120px" src="./images/rorvswild_logo.jpg">
+<img align="right" width="120px" src="./images/rorvswild_logo.png">
 
-*RoRvsWild* is a ruby gem to monitor performances and exceptions in Ruby on Rails applications.
+*RoRvsWild* is a Ruby gem to monitor performances and exceptions in Ruby on Rails applications.
 
-This gem has a double mode, **development** and **production**.  
-It can be used without an account to monitor your requests performances in your development environment.  
-It can also be used in your production and staging environments with an account on https://rorvswild.com. With such an account you also get extra benefits such as 30 day trace, background jobs monitoring, exceptions monitoring and notifications.
+This gem has a double mode: **development** and **production**.  
+It can be used without an account to monitor the performance of your requests in your development environment.  
+It can also be used in your production and staging environments with an account on https://rorvswild.com. With such an account, you also get additional benefits, including 30-day trace, background job monitoring, exception monitoring, and notifications.
 
 ## Development mode
 
 ### Install the gem
 
 * Add in your Gemfile `gem "rorvswild"`
-* 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.
+* Run `bundle install` in your terminal.
+* Restart your local server, and you’ll see a small button in the bottom left corner of your page.
 
-<img width="166px" src="./images/rorvswild_local_button.png">
+<img width="218px" src="./images/rorvswild_local_button.png" alt="RoRvsWild Local button">
 
 Click on the button, or navigate to http://localhost:3000/rorvswild to see the details panel:
 
@@ -29,13 +28,13 @@ Click on the button, or navigate to http://localhost:3000/rorvswild to see the d
 ## Production mode
 
 **To monitor your production or staging environment, you need an API key.**
-Signup on https://www.rorvswild.com and create an app to get one.
+Sign up on https://www.rorvswild.com and create an app to get one.
 
 * Add in your Gemfile `gem "rorvswild"`
-* Run `bundle install` in you terminal
-* Run `rorvswild-install API_KEY` in you terminal
-* Deploy/Restart your app
-* Make a few requests and refresh your app page on rorvswild.com to view the dashboard.
+* Run `bundle install` in your terminal.
+* Run `rorvswild-install API_KEY` in your terminal.
+* Deploy/Restart your app.
+* Make a few requests, and refresh your app page on rorvswild.com to view the dashboard.
 
 ![RoRvsWild Production](./images/rorvswild_prod.png)
 

data/lib/rorvswild/client.rb

@@ -2,6 +2,7 @@
 
 require "set"
 require "uri"
+require "zlib"
 require "json/ext"
 require "net/http"
 
@@ -24,6 +25,7 @@ module RorVsWild
       @mutex = Mutex.new
       @config = config
       @headers = {
+        "Content-Encoding" => "deflate",
         "Content-Type" => "application/json",
         "X-RorVsWild-Version" => RorVsWild::VERSION,
         "X-Ruby-Version" => RUBY_VERSION,
@@ -36,7 +38,7 @@ module RorVsWild
       uri = URI(api_url + path)
       post = Net::HTTP::Post.new(uri.path, @headers)
       post.basic_auth(nil, api_key)
-      post.body = JSON.generate(data)
+      post.body = Zlib.deflate(JSON.generate(data), Zlib::BEST_SPEED)
       transmit(post)
     end
 

data/lib/rorvswild/installer.rb

@@ -22,10 +22,12 @@ development:
   # widget: top-left, top-right, bottom-left, bottom-right or hidden
 
   # Open files in your text editor by clicking from the local widget.
-  # VSCode: vscode://file${path}:${line}
-  # Sublime: subl://${path}:${line}
-  # It should be set with an env variable when developers are not using the same editor.
-  editor_url: <%= ENV.fetch("RORVSWILD_EDITOR_URL", "vscode://file${path}:${line}") %>
+  # Leave commented to auto-detect from RAILS_EDITOR or EDITOR env vars (Rails 8.1+).
+  # Or set explicitly:
+  # editor_url: <%= ENV.fetch("RORVSWILD_EDITOR_URL", "vscode://file${path}:${line}") %>
+  # for VSCode: "vscode://file${path}:${line}"
+  # for Sublime: "subl://${path}:${line}"
+  
 
 production:
   api_key: #{api_key}

data/lib/rorvswild/local/javascript/local.js

@@ -74,6 +74,18 @@ RorVsWild.Local.prototype.toggleCommand = function(event) {
   document.querySelector(event.currentTarget.dataset.target).classList.toggle("is-open")
 }
 
+RorVsWild.Local.prototype.toggleLowImpactSections = function(event) {
+  var button = event.currentTarget
+  var sections = document.querySelectorAll(".rorvswild-local-panel__details__section[data-low-impact]")
+  var isHidden = sections[0].classList.contains("is-hidden")
+  
+  sections.forEach(function(section) {
+    section.classList.toggle("is-hidden")
+  })
+  
+  button.textContent = isHidden ? "↑ Hide low impact sections" : "↓ View low impact sections"
+}
+
 RorVsWild.Local.prototype.expand = function() {
   this.active = true
   this.goToRequestDetail(event)
@@ -107,6 +119,7 @@ RorVsWild.Local.formatImpact = function(impact) {
 }
 
 RorVsWild.Local.formatDateTime = function(date) {
+  if (!date || isNaN(date.getTime())) return ""
   var months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
   var minutes = date.getMinutes() < 10 ? "0" + date.getMinutes() : date.getMinutes()
   var hours = date.getHours() < 10 ? "0" +  date.getHours() : date.getHours()
@@ -189,9 +202,11 @@ RorVsWild.Local.Request.prototype.runtime = function() {
 RorVsWild.Local.Request.prototype.sections = function() {
   return this.data.sections.map(function(section) {
     var runtime = (section.total_runtime - section.children_runtime)
+    var impactValue = runtime * 100 / this.data.runtime
     return {
       id: RorVsWild.Local.nextId(),
-      impact: RorVsWild.Local.formatImpact(runtime * 100 / this.data.runtime),
+      impact: RorVsWild.Local.formatImpact(impactValue),
+      isLowImpact: impactValue < 1,
       language: RorVsWild.Local.kindToLanguage(section.kind),
       totalRuntime: RorVsWild.Local.relevantRounding(section.total_runtime),
       asyncRuntime: RorVsWild.Local.relevantRounding(section.async_runtime),
@@ -212,6 +227,10 @@ RorVsWild.Local.Request.prototype.sections = function() {
   }.bind(this)).sort(function(a, b) { return b.selfRuntime - a.selfRuntime })
 }
 
+RorVsWild.Local.Request.prototype.hasLowImpactSections = function() {
+  return this.sections().some(function(section) { return section.isLowImpact })
+}
+
 RorVsWild.Local.Request.prototype.sectionsImpactPerKind = function() {
   var total = 0
   var perKind = this.sections().reduce(function(object, section) {

data/lib/rorvswild/local/local.html.erb

@@ -148,6 +148,11 @@
     {{#sections}}
       {{> RorVsWild.Local.Section}}
     {{/sections}}
+    {{#hasLowImpactSections}}
+      <div class="rorvswild-local-panel__toggle-low-impact">
+        <button data-events="click->toggleLowImpactSections" class="rorvswild-local-panel__toggle-low-impact__button">↓ view low impact sections</button>
+      </div>
+    {{/hasLowImpactSections}}
   </div>
 </script>
 
@@ -162,7 +167,7 @@
 </script>
 
 <script type="x-tmpl-mustache" data-partial="RorVsWild.Local.Section">
-  <div class="rorvswild-local-panel__details__section" id="section-{{id}}">
+  <div class="rorvswild-local-panel__details__section {{#isLowImpact}}is-hidden{{/isLowImpact}}" {{#isLowImpact}}data-low-impact{{/isLowImpact}} id="section-{{id}}">
     <div class="rorvswild-local-panel__details__section__main">
       <span class="rorvswild-local-panel__details__section__file">
         <button data-events="click->toggleCommand" data-target="#section-{{id}}" class="rorvswild-local-panel__details__section__kind"><span>{{kind}}</button>
@@ -181,32 +186,32 @@
 
     <div class="rorvswild-local-panel__details__section__code">
       <dl>
-        {{#isAsync}}
-          <div>
-            <dt title="Time spent as non blocking IO">Async runtime</dt>
-            <dd>{{asyncRuntime}}<small>ms</small></dd>
-          </div>
-        {{/isAsync}}
         <div>
-          <dt title="self + children">Total runtime</dt>
-          <dd title="{{selfRuntime}} + {{childrenRuntime}}">{{totalRuntime}}<small>ms</small></dd>
+          <dt title="self runtime / calls">Average runtime</dt>
+          <dd title="{{selfRuntime}} / {{calls}}">{{averageRuntime}}<small>ms</small></dd>
         </div>
         <div>
-          <dt title="total - self">Children runtime</dt>
-          <dd title="{{totalRuntime}} - {{selfRuntime}}">{{childrenRuntime}}<small>ms</small></dd>
+          <dt>Calls</dt>
+          <dd class="dd--calls">{{calls}}<small>x</small></dd>
         </div>
         <div>
           <dt title="total - children">Self runtime</dt>
           <dd title="{{totalRuntime}} - {{childrenRuntime}}">{{selfRuntime}}<small>ms</small></dd>
         </div>
         <div>
-          <dt>Calls</dt>
-          <dd class="dd--calls">{{calls}}<small>x</small></dd>
+          <dt title="total - self">Children runtime</dt>
+          <dd title="{{totalRuntime}} - {{selfRuntime}}">{{childrenRuntime}}<small>ms</small></dd>
         </div>
         <div>
-          <dt title="self runtime / calls">Average runtime</dt>
-          <dd title="{{selfRuntime}} / {{calls}}">{{averageRuntime}}<small>ms</small></dd>
+          <dt title="self + children">Total runtime</dt>
+          <dd title="{{selfRuntime}} + {{childrenRuntime}}">{{totalRuntime}}<small>ms</small></dd>
         </div>
+        {{#isAsync}}
+          <div>
+            <dt title="Time spent as non blocking IO">Async runtime</dt>
+            <dd>{{asyncRuntime}}<small>ms</small></dd>
+          </div>
+        {{/isAsync}}
       </dl>
       {{#command}}
         <pre><code class="{{language}}">{{command}}</code></pre>
@@ -335,5 +340,5 @@
   {{/currentError}}
 </script>
 
-<link rel="stylesheet" media="all" href="/rorvswild.css"/>
+<link rel="stylesheet" media="all" href="/rorvswild.css">
 <script src="/rorvswild.js"></script>

data/lib/rorvswild/local/middleware.rb

@@ -79,7 +79,13 @@ module RorVsWild
       end
 
       def editor_url
-        RorVsWild.agent.config[:editor_url]
+        config[:editor_url] || rails_editor_url
+      end
+
+      def rails_editor_url
+        if editor = defined?(ActiveSupport::Editor) && ActiveSupport::Editor.current
+          editor.url_for("${path}", 999999.999999).gsub("999999.999999", "${line}").gsub("999999", "${line}")
+        end
       end
 
       def inject_into(html)

data/lib/rorvswild/local/queue.rb

@@ -39,7 +39,7 @@ module RorVsWild
       private
 
       def push_to(data, name)
-        data[:queued_at] = Time.now
+        data[:queued_at] = Time.now.iso8601(3)
         data[:uuid] = SecureRandom.uuid
         File.open(File.join(@directoy, "#{name}.ndjson"), "a") { |file| file.write(JSON.dump(data) + "\n") }
       end

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

@@ -126,6 +126,7 @@
   color: rgb(146 149 159) !important;
   cursor: pointer !important;
   line-height: 48px !important;
+  margin: 0 !important;
 }
 
 .rorvswild-local-panel__header nav li:hover {
@@ -350,6 +351,10 @@ h2.rorvswild-local-panel__title {
   display: block !important;
 }
 
+.rorvswild-local-panel__details__section.is-hidden {
+  display: none !important;
+}
+
 .rorvswild-local-panel__details__section:hover {
   background: rgb(26 29 36) !important;
   transition: all .3s !important;
@@ -433,30 +438,31 @@ a.rorvswild-local-panel__file__name:hover::after { opacity: 1; }
 .rorvswild-local-panel__details__section__code dl {
   display: flex;
   align-items: baseline;
-  justify-content: flex-end;
   flex-wrap: wrap;
   margin: 0;
   padding: 0;
-  text-align: right;
+  text-align: center;
   gap: 12px 24px;
 }
 
+.rorvswild-local-panel__details__section__code dl > * {
+  flex: 1;
+}
+
 .rorvswild-local-panel__details__section__code dt {
   white-space: nowrap;
-  margin: 0;
+  margin: 4px 0 0;
   text-transform: uppercase;
   letter-spacing: 1px;
   font-size: 9px !important;
+  line-height: 12px;
+  font-weight: 400;
 }
 
 .rorvswild-local-panel__details__section__code dd {
   margin: 0;
-  color: rgb(182 202 255) !important;
-  font-weight: 700;
-}
-
-.rorvswild-local-panel__details__section__code dd.dd--calls {
   color: rgb(199 203 214) !important;
+  font-weight: 700;
 }
 
 .rorvswild-local-panel__details__section__code dl + pre[class*="language-"] {
@@ -593,6 +599,31 @@ span.rorvswild-local-panel__details__section__kind {
   overflow-wrap: break-word !important;
 }
 
+.rorvswild-local-panel__toggle-low-impact {
+  padding: 12px !important;
+}
+
+.rorvswild-local-panel__toggle-low-impact__button {
+  background: transparent !important;
+  color: rgb(199 203 214) !important;
+  border: 1px solid rgb(72 75 80) !important;
+  box-shadow: none !important;
+  padding: 0px 8px !important;
+  font-size: 10px !important;
+  line-height: 24px !important;
+  text-transform: uppercase !important;
+  letter-spacing: 1px !important;
+  cursor: pointer !important;
+  font-weight: 700 !important;
+  transition: all 0.2s !important;
+}
+
+.rorvswild-local-panel__toggle-low-impact__button:hover {
+  background: transparent !important;
+  color: rgb(223 228 242) !important;
+  border-color: rgb(147 149 156) !important;
+}
+
 /* Panel Footer */
 .rorvswild-local-panel__footer {
   width: 100% !important;

data/lib/rorvswild/local.rb

@@ -6,7 +6,7 @@ module RorVsWild
     def self.start(config = {})
       queue = RorVsWild::Local::Queue.new(config[:queue] || {})
       RorVsWild.start(config.merge(queue: queue))
-      Rails.application.config.middleware.unshift(RorVsWild::Local::Middleware, nil)
+      Rails.application.config.middleware.unshift(RorVsWild::Local::Middleware, config)
     end
   end
 end

data/lib/rorvswild/plugin/rack.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RorVsWild
+  module Plugin
+    class Rack
+      @installed = false
+
+      def self.setup(agent)
+        return if @installed
+        return if !defined?(ActiveSupport::Notifications.subscribe)
+        ActiveSupport::Notifications.subscribe("process_middleware.action_dispatch", new)
+        @installed = true
+      end
+
+      def start(name, id, payload)
+        section = RorVsWild::Section.start
+        section.kind = "rack"
+        if location = source_location(payload[:middleware])
+          section.file = location[0]
+          section.line = location[1]
+          section.commands << payload[:middleware]
+        else
+          section.file = payload[:middleware]
+          section.line = 0
+        end
+      end
+
+      def finish(name, id, payload)
+        RorVsWild::Section.stop
+      end
+
+      private
+
+      def source_location(middleware_name)
+        middleware = Kernel.const_get(middleware_name)
+        middleware.instance_method(:call).source_location
+      rescue NameError
+      end
+    end
+  end
+end

data/lib/rorvswild/plugin/{middleware.rb → rails_engine.rb}

@@ -2,7 +2,7 @@
 
 module RorVsWild
   module Plugin
-    class Middleware
+    module RailsEngine
       module RequestQueueTime
 
         ACCEPTABLE_HEADERS = [
@@ -49,24 +49,19 @@ module RorVsWild
       @installed = false
 
       def self.setup(agent)
-        return if @installed
-        Rails.application.config.middleware.unshift(RorVsWild::Plugin::Middleware, nil) if defined?(Rails)
+        return if @installed || !defined?(Rails::Engine)
+        Rails::Engine.prepend(self)
         @installed = true
       end
 
-      def initialize(app, config)
-        @app, @config = app, config
-      end
-
       def call(env)
-        execution = RorVsWild::Execution::Request.new(env["ORIGINAL_FULLPATH"])
+        execution = RorVsWild::Execution::Request.new(env["REQUEST_URI"])
         execution.add_queue_time(calculate_queue_time(env))
         RorVsWild.agent.start_execution(execution)
         section = RorVsWild::Section.start
-        section.file, section.line = rails_engine_location
+        section.file, section.line = method(:call).super_method.source_location
         section.commands << "Rails::Engine#call"
-        code, headers, body = @app.call(env)
-        [code, headers, body]
+        super
       ensure
         RorVsWild::Section.stop
         RorVsWild.agent.stop_execution
@@ -79,10 +74,6 @@ module RorVsWild
 
         ((Time.now.to_f - queue_time_from_header) * 1000).round if queue_time_from_header
       end
-
-      def rails_engine_location
-        @rails_engine_location = ::Rails::Engine.instance_method(:call).source_location
-      end
     end
   end
 end

data/lib/rorvswild/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RorVsWild
-  VERSION = "1.10.1"
+  VERSION = "1.11.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.0
 platform: ruby
 authors:
 - Alexis Bernard
@@ -55,10 +55,11 @@ files:
 - lib/rorvswild/plugin/delayed_job.rb
 - lib/rorvswild/plugin/elasticsearch.rb
 - lib/rorvswild/plugin/faktory.rb
-- lib/rorvswild/plugin/middleware.rb
 - lib/rorvswild/plugin/mongo.rb
 - lib/rorvswild/plugin/net_http.rb
+- lib/rorvswild/plugin/rack.rb
 - lib/rorvswild/plugin/rails_cache.rb
+- lib/rorvswild/plugin/rails_engine.rb
 - lib/rorvswild/plugin/rails_error.rb
 - lib/rorvswild/plugin/redis.rb
 - lib/rorvswild/plugin/resque.rb
@@ -88,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Ruby on Rails applications monitoring
 test_files: []