dial 0.2.9 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a57407973b1542535078ec0688bf10ae767acfe0b50b6e6a95374e7b595e9ce
-  data.tar.gz: 164e521cbd64295baee46891e67d01b8e9893b00d876dbc5d8431d9d64c6971d
+  metadata.gz: c57fbfd8d0f023bcfd0606a5d61cfe84dd7b93d618dd844d50332b576dcce3d5
+  data.tar.gz: 27db795cf357bd7c878ea939c9c66374cc50f54e304466f91b9add37e0535a95
 SHA512:
-  metadata.gz: 497288fd60e67bfdf8d0cda035d781feeb59cc9605f1002f6d30bb7e5613c59d40b690f4750e11882f7f2feecb4baf71536c95deb6ae1b4dfa42e4fce4d1a223
-  data.tar.gz: b486a6b420d89312f1733286e4b3f559d5c8026af45562675003ccba179cab9e997dfd02e281669d9b3ccf5ca8d5108daf8bfce4992ae2d88ef611cbf35dee47
+  metadata.gz: ea4ba198fd052cdfed3a35d95a5424f6da32c94da85dec1cad9d78edd6b92e336d35afa76704349c5ef0475ac8a60f9ba90026b753109f4a0cea8caba994d3c4
+  data.tar.gz: 4d1578a97dd8439a4e6060698d24a0605f9747fd471d47844dd5f981f257790a00ecd4a5ed097377ef3af6d61062dd0b76d6023f5fd5dca0990a8f2642421c5a

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.3.1] - 2025-05-03
+
+- Only show truncated summary + one full query in N+1 logs
+- Fix parsing of multiline N+1 query logs
+- Truncate summary N+1 queries to 100 chars
+
+## [0.3.0] - 2025-05-02
+
+- Require rails 7.1.0 or later
+- Add missing logger require
+- Add missing stringio require
+
 ## [0.2.9] - 2025-04-11
 
 - No changes

data/README.md

@@ -10,7 +10,7 @@ Utilizes [vernier](https://github.com/jhawthorn/vernier) for profiling and
 
 > [!NOTE]
 > Check out the resources in the vernier project for more information on how to
-> interpret the viewer, as well as comparisons with other profilers, including `stackprof`.
+> interpret the viewer, as well as comparisons with other profilers, including stackprof.
 
 ![Demo](demo.gif)
 

data/dial.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.files = Dir["{lib}/**/*", "**/*.{gemspec,md,txt}"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "railties", ">= 7"
-  spec.add_dependency "activerecord", ">= 7"
-  spec.add_dependency "actionpack", ">= 7"
+  spec.add_dependency "railties", ">= 7.1"
+  spec.add_dependency "activerecord", ">= 7.1"
+  spec.add_dependency "actionpack", ">= 7.1"
   spec.add_dependency "vernier"
   spec.add_dependency "prosopite"
   spec.add_dependency "pg_query"

data/lib/dial/constants.rb

@@ -2,6 +2,7 @@
 
 require "rack"
 require "action_dispatch"
+require "stringio"
 
 require_relative "version"
 
@@ -10,6 +11,7 @@ module Dial
 
   HTTP_ACCEPT = "HTTP_ACCEPT"
   CONTENT_TYPE = ::Rack::CONTENT_TYPE
+  CONTENT_TYPE_HTML = "text/html"
   CONTENT_LENGTH = ::Rack::CONTENT_LENGTH
   NONCE = ::ActionDispatch::ContentSecurityPolicy::Request::NONCE
   REQUEST_TIMING = "dial_request_timing"

data/lib/dial/middleware/panel.rb

@@ -4,6 +4,8 @@ require "uri"
 
 module Dial
   class Panel
+    QUERY_CHARS_TRUNCATION_THRESHOLD = 100
+
     class << self
       def html env, headers, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
         <<~HTML
@@ -11,20 +13,20 @@ module Dial
 
           <div id="dial">
             <div id="dial-preview">
-              <span>
+              <span id="dial-preview-header">
                 #{formatted_rails_route_info env} |
                 #{formatted_request_timing env} |
                 #{formatted_profile_output env, profile_out_filename}
               </span>
-              <span>#{formatted_rails_version}</span>
-              <span>#{formatted_rack_version}</span>
-              <span>#{formatted_ruby_version}</span>
+              <span id="dial-preview-rails-version">#{formatted_rails_version}</span>
+              <span id="dial-preview-rack-version">#{formatted_rack_version}</span>
+              <span id="dial-preview-ruby-version">#{formatted_ruby_version}</span>
             </div>
 
             <hr>
 
             <div id="dial-details">
-              <details>
+              <details id="dial-details-n-plus-ones">
                 <summary>N+1s</summary>
                 <div class="section query-logs">
                   #{formatted_query_logs query_logs}
@@ -33,7 +35,7 @@ module Dial
 
               <hr>
 
-              <details>
+              <details id="dial-details-server-timing">
                 <summary>Server timing</summary>
                 <div class="section">
                   #{formatted_server_timing server_timing}
@@ -42,7 +44,7 @@ module Dial
 
               <hr>
 
-              <details>
+              <details id="dial-details-ruby-vm-stat">
                 <summary>RubyVM stat</summary>
                 <div class="section">
                   #{formatted_ruby_vm_stat ruby_vm_stat}
@@ -51,7 +53,7 @@ module Dial
 
               <hr>
 
-              <details>
+              <details id="dial-details-gc-stat">
                 <summary>GC stat</summary>
                 <div class="section">
                   #{formatted_gc_stat gc_stat}
@@ -60,7 +62,7 @@ module Dial
 
               <hr>
 
-              <details>
+              <details id="dial-details-gc-stat-heap">
                 <summary>GC stat heap</summary>
                 <div class="section">
                   #{formatted_gc_stat_heap gc_stat_heap}
@@ -223,7 +225,7 @@ module Dial
           query_logs.map do |(queries, stack_lines)|
             <<~HTML
               <details>
-                <summary>#{queries.shift}</summary>
+                <summary>#{truncated_query queries.first}</summary>
                 <div class="section query-logs">
                   #{queries.map { |query| "<span>#{query}</span>" }.join}
                   #{stack_lines.map { |stack_line| "<span>#{stack_line}</span>" }.join}
@@ -236,6 +238,12 @@ module Dial
         end
       end
 
+      def truncated_query query
+        return query if query.length <= QUERY_CHARS_TRUNCATION_THRESHOLD
+
+        query[0...QUERY_CHARS_TRUNCATION_THRESHOLD] + "..."
+      end
+
       def formatted_ruby_vm_stat ruby_vm_stat
         ruby_vm_stat.map { |key, value| "<span><b>#{key}:</b> #{value}</span>" }.join
       end

data/lib/dial/middleware.rb

@@ -17,7 +17,7 @@ module Dial
     end
 
     def call env
-      unless env[HTTP_ACCEPT]&.include? "text/html"
+      unless env[HTTP_ACCEPT]&.include? CONTENT_TYPE_HTML
         return @app.call env
       end
 
@@ -38,7 +38,7 @@ module Dial
       end
       server_timing = server_timing headers
 
-      unless headers[CONTENT_TYPE]&.include? "text/html"
+      unless headers[CONTENT_TYPE]&.include? CONTENT_TYPE_HTML
         return [status, headers, rack_body]
       end
 
@@ -104,13 +104,13 @@ module Dial
       when /N\+1 queries detected/
         [[[],[]], :queries, 0]
       when /Call stack/
-        entry.first << "+ #{count - 5} more queries" if count > 5
+        entry.first << "+ #{count - 1} more queries" if count > 1
         [entry, :call_stack, count]
       else
         case section
         when :queries
           count += 1
-          entry.first << line.strip if count <= 5
+          entry.first << line.strip if count == 1
           [entry, :queries, count]
         when :call_stack
           if line.strip.empty?

data/lib/dial/prosopite.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dial
+  module Prosopite
+    def send_notifications
+      tc[:prosopite_notifications] = tc[:prosopite_notifications].to_h do |queries, kaller|
+        [queries.map { |query| query.squish }, kaller]
+      end
+
+      super
+    end
+  end
+end
+
+module ::Prosopite
+  class << self
+    prepend Dial::Prosopite
+  end
+end

data/lib/dial/prosopite_logger.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "logger"
+
 module Dial
   class ProsopiteLogger < Logger
   end

data/lib/dial/railtie.rb

@@ -4,6 +4,7 @@ require "rails"
 require "active_record"
 require "prosopite"
 
+require_relative "prosopite"
 require_relative "middleware"
 require_relative "prosopite_logger"
 

data/lib/dial/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dial
-  VERSION = "0.2.9"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dial
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.1
 platform: ruby
 authors:
 - Joshua Young
@@ -15,42 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: vernier
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +113,7 @@ files:
 - lib/dial/middleware/panel.rb
 - lib/dial/middleware/rails_stat.rb
 - lib/dial/middleware/ruby_stat.rb
+- lib/dial/prosopite.rb
 - lib/dial/prosopite_logger.rb
 - lib/dial/railtie.rb
 - lib/dial/util.rb