dial 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42f0f94ef6fdc4992e56f9b1938f464916c2ac36ded2ae17a506fc3798cda278
-  data.tar.gz: 05e9b4db37fa643be44ca3b9800d44ecc79dbe1b69209d4978e13de1dbec82d6
+  metadata.gz: 1cf2ace9f735e0ffd4c290b742bbf7f89f322babb96636e942fe1faaf92a8e45
+  data.tar.gz: '06279e4a580959080df277abe1a8488bca20f50276d9221ca399366f570e1426'
 SHA512:
-  metadata.gz: 6f071e302b7b7f83395a3f4e796d9b8cb3b99138dcd9b67c7cabfd57dea537d197266e01f4789644c06c482b72badc6f6c858bb28913631959c9255ebf162536
-  data.tar.gz: f6782c98fde560a03f29aa95bdae546e1d1aae0388b6a2403617d229d15cebe3d4ab2d36d606a4ede4b5b4ff43c9f9690336716865b22eb526b9a706f98906a0
+  metadata.gz: bde524497181a25dbeddc54f8f04ff128714844a5f2b6d8c84ae569bf4d45cb39942dddbe0d687e63c7b3c23f590410128de4abfffa69e5ee41923be4a73b6c1
+  data.tar.gz: e2bd5aef0ee0975a8e9c227a77296f40811d558251035771177c11f2128b599d905644186237280b3718f64ff65b31b834e01cfd222e5baba0077a53ee631451

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.3.2] - 2025-05-14
+
+- Consolidate railtie initializers
+
+## [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

data/lib/dial/configuration.rb

@@ -31,6 +31,7 @@ module Dial
 
     def freeze
       @options.freeze
+
       super
     end
   end

data/lib/dial/constants.rb

@@ -11,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"
@@ -20,6 +21,7 @@ module Dial
   VERNIER_INTERVAL = 200
   VERNIER_ALLOCATION_INTERVAL = 2_000
   VERNIER_PROFILE_OUT_RELATIVE_DIRNAME = "tmp/dial/profiles"
+  VERNIER_PROFILE_OUT_FILE_EXTENSION = ".json.gz"
   VERNIER_VIEWER_URL = "https://vernier.prof"
 
   PROSOPITE_IGNORE_QUERIES = [/schema_migrations/i].freeze

data/lib/dial/engine/routes.rb

@@ -4,7 +4,7 @@ Dial::Engine.routes.draw do
   scope path: "/dial", as: "dial" do
     get "profile", to: lambda { |env|
       uuid = env[::Rack::QUERY_STRING].sub "uuid=", ""
-      path = String ::Rails.root.join Dial::VERNIER_PROFILE_OUT_RELATIVE_DIRNAME, "#{uuid}.json.gz"
+      path = String ::Rails.root.join Dial::VERNIER_PROFILE_OUT_RELATIVE_DIRNAME, (uuid + VERNIER_PROFILE_OUT_FILE_EXTENSION)
 
       if File.exist? path
         [

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
@@ -190,7 +192,7 @@ module Dial
       def formatted_profile_output env, profile_out_filename
         url_base = ::Rails.application.routes.url_helpers.dial_url host: env[::Rack::HTTP_HOST]
         prefix = "/" unless url_base.end_with? "/"
-        uuid = profile_out_filename.delete_suffix ".json.gz"
+        uuid = profile_out_filename.delete_suffix VERNIER_PROFILE_OUT_FILE_EXTENSION
         profile_out_url = URI.encode_www_form_component url_base + "#{prefix}dial/profile?uuid=#{uuid}"
 
         "<a href='https://vernier.prof/from-url/#{profile_out_url}' target='_blank'>View profile</a>"
@@ -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

@@ -3,6 +3,7 @@
 require "vernier"
 require "prosopite"
 
+require_relative "prosopite"
 require_relative "middleware/panel"
 require_relative "middleware/ruby_stat"
 require_relative "middleware/rails_stat"
@@ -12,20 +13,18 @@ module Dial
     include RubyStat
     include RailsStat
 
-    HTML_CONTENT_TYPE = "text/html"
-
     def initialize app
       @app = app
     end
 
     def call env
-      unless env[HTTP_ACCEPT]&.include? HTML_CONTENT_TYPE
+      unless env[HTTP_ACCEPT]&.include? CONTENT_TYPE_HTML
         return @app.call env
       end
 
       start_time = Process.clock_gettime Process::CLOCK_MONOTONIC
 
-      profile_out_filename = "#{Util.uuid}_vernier.json.gz"
+      profile_out_filename = "#{Util.uuid}_vernier" + VERNIER_PROFILE_OUT_FILE_EXTENSION
       profile_out_pathname = "#{profile_out_dir_pathname}/#{profile_out_filename}"
 
       status, headers, rack_body, ruby_vm_stat, gc_stat, gc_stat_heap, vernier_result = nil
@@ -40,7 +39,7 @@ module Dial
       end
       server_timing = server_timing headers
 
-      unless headers[CONTENT_TYPE]&.include? HTML_CONTENT_TYPE
+      unless headers[CONTENT_TYPE]&.include? CONTENT_TYPE_HTML
         return [status, headers, rack_body]
       end
 
@@ -106,13 +105,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,21 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/filters"
+
+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/railtie.rb

@@ -9,36 +9,27 @@ require_relative "prosopite_logger"
 
 module Dial
   class Railtie < ::Rails::Railtie
-    initializer "dial.use_middleware", after: :load_config_initializers do |app|
+    initializer "dial.setup", after: :load_config_initializers do |app|
+      # use middleware
       app.middleware.insert_before 0, Middleware
-    end
-
-    initializer "dial.set_up_vernier", after: :load_config_initializers do |app|
-      app.config.after_initialize do
-        FileUtils.mkdir_p ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
-      end
-    end
 
-    initializer "dial.clean_up_vernier_profile_out_files", after: :load_config_initializers do |app|
-      stale_files("#{profile_out_dir_pathname}/*.json.gz").each do |profile_out_file|
+      # clean up stale vernier profile output files
+      stale_files("#{profile_out_dir_pathname}/*" + VERNIER_PROFILE_OUT_FILE_EXTENSION).each do |profile_out_file|
         File.delete profile_out_file rescue nil
       end
-    end
 
-    initializer "dial.set_up_prosopite", after: :load_config_initializers do |app|
       app.config.after_initialize do
+        # set up vernier
+        FileUtils.mkdir_p ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
+
+        # set up prosopite
         if ::ActiveRecord::Base.configurations.configurations.any? { |config| config.adapter == "postgresql" }
           require "pg_query"
         end
-
         ::Prosopite.custom_logger = ProsopiteLogger.new PROSOPITE_LOG_IO
-      end
-    end
 
-    initializer "dial.setup", after: :load_config_initializers do |app|
-      app.config.after_initialize do
+        # finalize configuration
         Dial._configuration.freeze
-
         ::Prosopite.ignore_queries = Dial._configuration.prosopite_ignore_queries
       end
     end

data/lib/dial/version.rb

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

data/lib/dial.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "dial/util"
 require_relative "dial/constants"
+require_relative "dial/util"
 
 require_relative "dial/configuration"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dial
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Joshua Young
@@ -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
@@ -137,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A modern profiler for your Rails application
 test_files: []