rorvswild 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1da086576b7ffa892064483efd18f9c545ff1ee6e960f23374e82e78722056c5
-  data.tar.gz: cfc4561f2aec3a8880b80e81daf71492516d2d137901e649db588fe4a05988f1
+  metadata.gz: e4752356e6d6e1b7b9883b55c5f9f29223dedd2c31cc4abdac85065215b1b05b
+  data.tar.gz: 254eaff9c5412c5d1e121644d0993f0a8557748ac25370a9266ce1e61fe9f031
 SHA512:
-  metadata.gz: bf988a2610372ae91dd61503005382f962b9656dcfd4f5edd48875a281e133cb333c6b1424d001dd76109522b71ea7c3818a69fffa687160bbc3b1ae992d6d9a
-  data.tar.gz: 41ab36b5b9e3eb59bfd9f28edc6a96fce2081df3be66fc4ac3217d94de4606f0edc858f09ece8a7700b0a9b7be84b65e9f779d968294186ccd4b3cc1d6a43c80
+  metadata.gz: b4b7acb9cc0fe303310648985dda337a3ab11c941af8c0e4d06199404064eee3c9a5cd93993f94e701fbc121f7f633123395fd89e5ddd3e28b52cd9cfa2e65e5
+  data.tar.gz: 404254bcfd4f9bb5c165da7955d712f1435514c061f70b019c84fbc1973626b71935a87ee8b1eae9b9b2741d79e74d2cfaef8378472f65b2a22ca78e03a99590

data/lib/rorvswild/agent.rb

@@ -114,8 +114,8 @@ module RorVsWild
       end
     end
 
-    def start_request
-      current_data || initialize_data
+    def start_request(queue_time_ms = 0)
+      current_data || initialize_data(queue_time_ms)
     end
 
     def stop_request
@@ -195,9 +195,9 @@ module RorVsWild
 
     private
 
-    def initialize_data
+    def initialize_data(queue_time_ms = 0)
       Thread.current[:rorvswild_data] = {
-        started_at: RorVsWild.clock_milliseconds,
+        started_at: RorVsWild.clock_milliseconds - queue_time_ms,
         gc_section: Section.start_gc_timing,
         environment: Host.to_h,
         section_stack: [],

data/lib/rorvswild/deployment.rb

@@ -91,7 +91,7 @@ module RorVsWild
     end
 
     def self.shell(command)
-      stdout, stderr, process = Open3.capture3(command) rescue nil
+      stdout, _, process = Open3.capture3(command) rescue nil
       stdout if process && process.success?
     end
   end

data/lib/rorvswild/host.rb

@@ -8,7 +8,7 @@ module RorVsWild
 
     def self.os
       @os_description ||= `uname -sr`.strip
-    rescue Exception => ex
+    rescue Exception
       @os_description = RbConfig::CONFIG["host_os"]
     end
 

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

@@ -189,11 +189,12 @@ 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 object = {
+    return {
       id: RorVsWild.Local.nextId(),
       impact: RorVsWild.Local.formatImpact(runtime * 100 / this.data.runtime),
       language: RorVsWild.Local.kindToLanguage(section.kind),
       totalRuntime: RorVsWild.Local.relevantRounding(section.total_runtime),
+      asyncRuntime: RorVsWild.Local.relevantRounding(section.async_runtime),
       childrenRuntime: RorVsWild.Local.relevantRounding(section.children_runtime),
       selfRuntime: RorVsWild.Local.relevantRounding(runtime),
       runtime: RorVsWild.Local.relevantRounding(runtime),
@@ -204,9 +205,9 @@ RorVsWild.Local.Request.prototype.sections = function() {
       file: section.file,
       line: section.line,
       location: section.kind == "view" ? section.file : section.file + ":" + section.line,
-      locationUrl: RorVsWild.Local.pathToUrl(this.data.environment.cwd, section.file, section.line)
+      locationUrl: RorVsWild.Local.pathToUrl(this.data.environment.cwd, section.file, section.line),
+      isAsync: RorVsWild.Local.relevantRounding(section.async_runtime) > 0,
     }
-    return object
   }.bind(this)).sort(function(a, b) { return b.selfRuntime - a.selfRuntime })
 }
 

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

@@ -1,4 +1,4 @@
-<div id="RorVsWild.Local" class="<%= widget_css %>" >
+<div id="RorVsWild.Local" class="is-<%= widget_position %>" >
   <% if @current_request %>
     <div data-barber="RorVsWild.Local" data-editor-url="<%= editor_url %>" data-request-uuid="<%= @current_request["uuid"] %>"></div>
   <% else %>
@@ -179,6 +179,12 @@
 
     <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>

data/lib/rorvswild/local/middleware.rb

@@ -35,9 +35,9 @@ module RorVsWild
         if status >= 200 && status < 300 && headers["Content-Type"] && headers["Content-Type"].include?("text/html")
           if headers["Content-Encoding"]
             log_incompatible_middleware_warning
-          elsif body.respond_to?(:each)
+          elsif body.respond_to?(:each) && widget_position != "hidden"
             content_length = 0
-            @current_request = RorVsWild.agent.queue.requests.first
+            @current_request =  RorVsWild.agent.queue.requests.first
             body.each do |string|
               inject_into(string)
               content_length += string.size
@@ -74,9 +74,8 @@ module RorVsWild
 
       private
 
-      def widget_css
-        config = RorVsWild.agent.config
-        config && config[:widget] && "is-#{config[:widget]}"
+      def widget_position
+        (config = RorVsWild.agent.config) && config[:widget]
       end
 
       def editor_url

data/lib/rorvswild/plugin/action_view.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 module RorVsWild
   module Plugin
     class ActionView
       def self.setup
         return if @installed
         return unless defined?(::ActiveSupport::Notifications.subscribe)
-        ActiveSupport::Notifications.subscribe("render_partial.action_view", new)
-        ActiveSupport::Notifications.subscribe("render_template.action_view", new)
+        ActiveSupport::Notifications.subscribe("render_partial.action_view", plugin = new)
+        ActiveSupport::Notifications.subscribe("render_template.action_view", plugin)
+        ActiveSupport::Notifications.subscribe("render_collection.action_view", plugin)
         @installed = true
       end
 
@@ -15,10 +18,11 @@ module RorVsWild
 
       def finish(name, id, payload)
         RorVsWild::Section.stop do |section|
-          section.kind = "view".freeze
+          section.kind = "view"
           section.commands << RorVsWild.agent.locator.relative_path(payload[:identifier])
           section.file = section.command
-          section.line = 1
+          section.line = 0
+          section.calls = payload[:count] if payload[:count] # render collection
         end
       end
     end

data/lib/rorvswild/plugin/active_record.rb

@@ -29,6 +29,18 @@ module RorVsWild
         RorVsWild::Section.stop
       end
 
+      # Async queries
+      def publish_event(event)
+        section = Section.new
+        section.total_ms = event.payload[:lock_wait]
+        section.async_ms = event.duration - event.payload[:lock_wait]
+        section.gc_time_ms = event.respond_to?(:gc_time) ? event.gc_time : 0 # gc_time since Rails 7.2.0
+        section.commands << normalize_sql_query(event.payload[:sql])
+        section.kind = "sql"
+        (parent = Section.current) && parent.children_ms += section.total_ms
+        RorVsWild.agent.add_section(section)
+      end
+
       SQL_STRING_REGEX = /'((?:''|\\'|[^'])*)'/
       SQL_NUMERIC_REGEX = /(?<!\w)\d+(\.\d+)?(?!\w)/
       SQL_PARAMETER_REGEX = /\$\d+/

data/lib/rorvswild/plugin/middleware.rb

@@ -3,6 +3,49 @@
 module RorVsWild
   module Plugin
     class Middleware
+      module RequestQueueTime
+
+        ACCEPTABLE_HEADERS = [
+          'HTTP_X_REQUEST_START',
+          'HTTP_X_QUEUE_START',
+          'HTTP_X_MIDDLEWARE_START'
+        ].freeze
+
+        MINIMUM_TIMESTAMP = 1577836800.freeze # 2020/01/01 UTC
+        DIVISORS = [1_000_000, 1_000, 1].freeze
+
+        def parse_queue_time_header(env)
+          return unless env
+
+          earliest = nil
+
+          ACCEPTABLE_HEADERS.each do |header|
+            if (header_value = env[header])
+              timestamp = parse_timestamp(header_value.delete_prefix("t="))
+              if timestamp && (!earliest || timestamp < earliest)
+                earliest = timestamp
+              end
+            end
+          end
+
+          [earliest, Time.now.to_f].min if earliest
+        end
+
+        private
+
+        def parse_timestamp(timestamp)
+          timestamp = timestamp.to_f
+          return unless timestamp.finite?
+
+          DIVISORS.each do |divisor|
+            t = timestamp / divisor
+            return t if t > MINIMUM_TIMESTAMP
+          end
+        end
+      end
+
+      include RequestQueueTime
+
       def self.setup
         return if @installed
         Rails.application.config.middleware.unshift(RorVsWild::Plugin::Middleware, nil) if defined?(Rails)
@@ -14,8 +57,10 @@ module RorVsWild
       end
 
       def call(env)
-        RorVsWild.agent.start_request
+        queue_time_ms = calculate_queue_time(env)
+        RorVsWild.agent.start_request(queue_time_ms || 0)
         RorVsWild.agent.current_data[:path] = env["ORIGINAL_FULLPATH"]
+        add_queue_time_section(queue_time_ms)
         section = RorVsWild::Section.start
         section.file, section.line = rails_engine_location
         section.commands << "Rails::Engine#call"
@@ -28,6 +73,25 @@ module RorVsWild
 
       private
 
+      def add_queue_time_section(queue_time_ms)
+        return unless queue_time_ms
+
+        section = Section.new
+        section.stop
+        section.total_ms = queue_time_ms
+        section.gc_time_ms = 0
+        section.file = "request-queue"
+        section.line = 0
+        section.kind = "queue"
+        RorVsWild.agent.add_section(section)
+      end
+
+      def calculate_queue_time(env)
+        queue_time_from_header = parse_queue_time_header(env)
+
+        ((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

data/lib/rorvswild/section.rb

@@ -3,7 +3,7 @@
 module RorVsWild
   class Section
     attr_reader :start_ms, :commands, :gc_start_ms
-    attr_accessor :kind, :file, :line, :calls, :children_ms, :total_ms, :gc_time_ms
+    attr_accessor :kind, :file, :line, :calls, :children_ms, :total_ms, :gc_time_ms, :async_ms
 
     def self.start(&block)
       section = Section.new
@@ -31,7 +31,7 @@ module RorVsWild
     def self.start_gc_timing
       section = Section.new
       section.calls = GC.count
-      section.file, section.line = "ruby/gc.c", 42
+      section.file, section.line = "ruby/gc.c", 0
       section.add_command("GC.start")
       section.kind = "gc"
       section
@@ -62,6 +62,7 @@ module RorVsWild
       @calls = 1
       @total_ms = 0
       @children_ms = 0
+      @async_ms = 0
       @kind = "code"
       location = RorVsWild.agent.locator.find_most_relevant_location(caller_locations)
       @file = RorVsWild.agent.locator.relative_path(location.path)
@@ -93,7 +94,7 @@ module RorVsWild
     end
 
     def as_json(options = nil)
-      {calls: calls, total_runtime: total_ms, children_runtime: children_ms, kind: kind, started_at: start_ms, file: file, line: line, command: command}
+      {calls: calls, total_runtime: total_ms, children_runtime: children_ms, async_runtime: async_ms, kind: kind, started_at: start_ms, file: file, line: line, command: command}
     end
 
     def to_json(options = {})
@@ -107,7 +108,7 @@ module RorVsWild
     COMMAND_MAX_SIZE = 5_000
 
     def command
-      string = @commands.join("\n")
+      string = @commands.to_a.join("\n")
       string.size > COMMAND_MAX_SIZE ? string[0, COMMAND_MAX_SIZE] + " [TRUNCATED]" : string
     end
   end

data/lib/rorvswild/version.rb

@@ -1,3 +1,3 @@
 module RorVsWild
-  VERSION = "1.8.0".freeze
+  VERSION = "1.9.0".freeze
 end

data/lib/rorvswild.rb

@@ -83,7 +83,7 @@ module RorVsWild
   def self.check
     api_key = RorVsWild.agent.config[:api_key]
     agent.client.instance_variable_set(:@http_unauthorized, false)
-    return puts "You API key is missing and has to be defined in config/rorvswild.yml." if !api_key || api_key.empty?
+    return puts "Your API key is missing and has to be defined in config/rorvswild.yml." if !api_key || api_key.empty?
     puts case response = agent.client.post("/jobs", jobs: [{sections: [], name: "RorVsWild.check", runtime: 0}])
     when Net::HTTPOK then "Connection to RorVsWild works fine !"
     when Net::HTTPUnauthorized then "Wrong API key"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rorvswild
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Alexis Bernard
 - Antoine Marguerie
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies: []
 description: Performances and errors insights for rails developers.
 email:
@@ -71,7 +71,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/BaseSecrete/rorvswild
   changelog_uri: https://github.com/BaseSecrete/rorvswild/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,8 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Ruby on Rails applications monitoring
 test_files: []