dial 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1ac4b6e83d9c20da87125b635bb0d9e98d71147d1fa0490606bc7f5431aa171
-  data.tar.gz: ad2c423d69ade789af8cb6c52776d1688607a6a97c04215c231f26931a986f0d
+  metadata.gz: 61252b82f8769e8c0724a9cb40a8771afc59df61de01847add599037939b1e7d
+  data.tar.gz: 3944fe8e444853a4dfe4f2fb474bf6ed6a4b30814d55dc127df986e99c08bcf6
 SHA512:
-  metadata.gz: 957163d6a4b723704c6956d0056f6f36a67f1ce07415b5e39ae84be396ca58a77cb5fd076ce8dec8471e019e10d7fb516594cb8c9ea5806b7c80f15af8063c17
-  data.tar.gz: df6125c631c2948aa24cc03508f951b47bc198c39ecc34d4a1a091eb265c0b6aa572f75d8e6b4883d6856b2bf830ba1bd7617e6e0fb5bacd924c7475876302fd
+  metadata.gz: cdbc7c51f7392b280a56f56d232204c93ee77e436ee6891f7f88e9d9c39570b77b85af3ff07dc15a54c854757053be0ab8c85d7adb6c21ed23f438c43c0d4da7
+  data.tar.gz: 8b8b5400414355f6012d87b490b719ab3b79cfacc229705e752e8822162cc383979e8898711f76b0b1393c497ec0c5a0cd4a344f9050ab1832e1317b314c30bd

data/CHANGELOG.md

@@ -1,13 +1,18 @@
 ## [Unreleased]
 
+## [0.1.4] - 2024-12-27
+
+- Use vernier memory usage and rails hooks by default
+- Add support for N+1 detection with prosopite
+
+## [0.1.3] - 2024-11-14
+
+- Enable allocation profiling by default
+
 ## [0.1.2] - 2024-11-10
 
 - Add support for request profiling with vernier
 
 ## [0.1.1] - 2024-11-08
 
-- Set upper bound on dependencies
-
-## [0.1.0] - 2024-11-08
-
 - Initial release

data/README.md

@@ -7,26 +7,24 @@ WIP
 
 A modern profiler for Rails applications.
 
-<details>
-<summary>POC</summary>
-
-![Snapshot 1](https://github.com/user-attachments/assets/904daaf5-3f18-4c94-a7e4-9418539a19f3)
-
-![Snapshot 2](https://github.com/user-attachments/assets/eb6ed9f5-b258-42df-8901-222c7d969fdd)
-
-https://github.com/user-attachments/assets/bae59681-ebeb-42b3-9489-9692c072c3dc
-
-</details>
+Check out the demo:
+[![Demo](https://img.youtube.com/vi/LPXtfJ0c284/maxresdefault.jpg)](https://youtu.be/LPXtfJ0c284)
 
 ## Installation
 
-Install the gem and add it to your Rails application's Gemfile by executing:
+1. Install the gem and add it to your Rails application's Gemfile by executing:
 
 ```bash
 bundle add dial
 ```
 
-and everything should just work.
+2. Mount the engine in your `config/routes.rb` file:
+
+
+```ruby
+# this will mount the engine at /dial
+mount Dial::Engine, at: "/"
+```
 
 ## Development
 

data/dial.gemspec

@@ -22,5 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "railties", ">= 7", "< 8.2"
   spec.add_dependency "activerecord", ">= 7", "< 8.2"
   spec.add_dependency "actionpack", ">= 7", "< 8.2"
-  spec.add_dependency "vernier", "~> 1.3"
+  spec.add_dependency "vernier", "~> 1.5"
+  spec.add_dependency "prosopite", "~> 1.4"
+  spec.add_dependency "pg_query", "~> 5.1"
 end

data/lib/dial/constants.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "version"
+
 module Dial
   REQUEST_TIMING_HEADER = "dial_request_timing"
+
+  PROFILE_OUT_STALE_SECONDS = 60 * 60
   PROFILE_OUT_RELATIVE_DIRNAME = "tmp/dial/profile/"
+
+  PROSOPITE_IGNORE_QUERIES = [/schema_migrations/]
+  PROSOPITE_LOG_RELATIVE_PATHNAME = "log/dial/prosopite.log"
 end

data/lib/dial/engine/routes.rb

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

data/lib/dial/{panel.rb → middleware/panel.rb}

@@ -1,22 +1,20 @@
 # frozen_string_literal: true
 
-require "cgi"
-
-require_relative "constants"
+require "uri"
 
 module Dial
   class Panel
     class << self
-      def html env, profile_out_filename, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
+      def html env, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
         <<~HTML
           <style>#{style}</style>
 
           <div id="dial">
             <div id="dial-preview">
               <span>
-                #{formatted_rails_route_info(env)} |
-                #{formatted_request_timing(env)} |
-                #{formatted_profile_ouput(env, profile_out_filename)}
+                #{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>
@@ -27,30 +25,37 @@ module Dial
               <hr>
 
               <details>
-                <summary>RubyVM stat</summary>
+                <summary>Server timing</summary>
                 <div class="section">
-                  #{formatted_ruby_vm_stat(ruby_vm_stat)}
+                  #{formatted_server_timing server_timing}
                 </div>
               </details>
 
               <details>
-                <summary>GC stat</summary>
+                <summary>N+1s</summary>
+                <div class="section query-logs">
+                  #{formatted_query_logs query_logs}
+                </div>
+              </details>
+
+              <details>
+                <summary>RubyVM stat</summary>
                 <div class="section">
-                  #{formatted_gc_stat(gc_stat)}
+                  #{formatted_ruby_vm_stat ruby_vm_stat}
                 </div>
               </details>
 
               <details>
-                <summary>GC stat heap</summary>
+                <summary>GC stat</summary>
                 <div class="section">
-                  #{formatted_gc_stat_heap(gc_stat_heap)}
+                  #{formatted_gc_stat gc_stat}
                 </div>
               </details>
 
               <details>
-                <summary>Server timing</summary>
+                <summary>GC stat heap</summary>
                 <div class="section">
-                  #{formatted_server_timing(server_timing)}
+                  #{formatted_gc_stat_heap gc_stat_heap}
                 </div>
               </details>
             </div>
@@ -77,42 +82,49 @@ module Dial
             padding: 0.5rem;
             font-size: 0.85rem;
             color: black;
-            cursor: pointer;
-          }
-
-          #dial-preview {
-            display: flex;
-            flex-direction: column;
-            cursor: pointer;
-          }
-
-          #dial-details {
-            display: none;
-          }
-
-          .section {
-            display: flex;
-            flex-direction: column;
-            margin-top: 0.5rem;
-          }
-
-          span {
-            text-align: left;
-          }
-
-          hr {
-            width: -moz-available;
-            margin-top: 0.5rem;
-          }
-
-          details {
-            margin-top: 0.5rem;
-            text-align: left;
-          }
 
-          summary {
-            margin-bottom: 0.25rem;
-            cursor: pointer;
+            #dial-preview {
+              display: flex;
+              flex-direction: column;
+              cursor: pointer;
+            }
+
+            #dial-details {
+              display: none;
+            }
+
+            .section {
+              display: flex;
+              flex-direction: column;
+              margin: 0.25rem 0 0 0;
+            }
+
+            .query-logs {
+              padding-left: 0.75rem;
+
+              details {
+                margin-top: 0;
+              }
+            }
+
+            span {
+              text-align: left;
+            }
+
+            hr {
+              width: -moz-available;
+              margin: 0.65rem 0 0 0;
+            }
+
+            details {
+              margin: 0.5rem 0 0 0;
+              text-align: left;
+            }
+
+            summary {
+              margin: 0.25rem 0 0 0;
+              cursor: pointer;
+            }
           }
         CSS
       end
@@ -142,15 +154,13 @@ module Dial
         "<b>Request timing:</b> #{env[REQUEST_TIMING_HEADER]}ms"
       end
 
-      def formatted_profile_ouput env, profile_out_filename
-        uuid = profile_out_filename.sub ".json", ""
-        path = "dial/profile?uuid=#{uuid}"
-        host = env[::Rack::HTTP_HOST]
-        base_url = ::Rails.application.routes.url_helpers.dial_url host: host
-        profile_out_url = CGI.escape base_url + path
-        url = "https://vernier.prof/from-url/#{profile_out_url}"
+      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"
+        profile_out_url = URI.encode_www_form_component url_base + "#{prefix}dial/profile?uuid=#{uuid}"
 
-        "<a href='#{url}' target='_blank'>View profile</a>"
+        "<a href='https://vernier.prof/from-url/#{profile_out_url}' target='_blank'>View profile</a>"
       end
 
       def formatted_rails_version
@@ -162,7 +172,32 @@ module Dial
       end
 
       def formatted_ruby_version
-        "<b>Ruby version:</b> #{RUBY_DESCRIPTION}"
+        "<b>Ruby version:</b> #{::RUBY_DESCRIPTION}"
+      end
+
+      def formatted_server_timing server_timing
+        if server_timing.any?
+          server_timing
+            # TODO: Nested sorting
+            .sort_by { |_, timing| -timing }
+            .map { |event, timing| "<span><b>#{event}:</b> #{timing}</span>" }.join
+        else
+          "NA"
+        end
+      end
+
+      def formatted_query_logs query_logs
+        query_logs.map do |(queries, stack_lines)|
+          <<~HTML
+            <details>
+              <summary>#{queries.shift}</summary>
+              <div class="section query-logs">
+                #{queries.map { |query| "<span>#{query}</span>" }.join}
+                #{stack_lines.map { |stack_line| "<span>#{stack_line}</span>" }.join}
+              </div>
+            </details>
+          HTML
+        end.join
       end
 
       def formatted_ruby_vm_stat ruby_vm_stat
@@ -185,17 +220,6 @@ module Dial
           HTML
         end.join
       end
-
-      def formatted_server_timing server_timing
-        if server_timing.any?
-          server_timing
-            # TODO: Nested sorting
-            .sort_by { |_, timing| -timing }
-            .map { |event, timing| "<span><b>#{event}:</b> #{timing}</span>" }.join
-        else
-          "NA"
-        end
-      end
     end
   end
 end

data/lib/dial/{rails_stat.rb → middleware/rails_stat.rb}

@@ -5,8 +5,8 @@ module Dial
     private
 
     def server_timing headers
-      timing = if (ActionDispatch.const_defined? :Constants)  && (ActionDispatch::Constants.const_defined? :SERVER_TIMING)
-        headers[ActionDispatch::Constants::SERVER_TIMING]
+      timing = if ::ActionDispatch.const_defined? "Constants::SERVER_TIMING"
+        headers[::ActionDispatch::Constants::SERVER_TIMING]
       else
         headers["Server-Timing"]
       end

data/lib/dial/{ruby_stat.rb → middleware/ruby_stat.rb}

@@ -5,11 +5,11 @@ module Dial
     private
 
     def ruby_vm_stat_diff before, after
-      stat_diff before, after, except: [:next_shape_id]
+      stat_diff before, after, no_diff: [:next_shape_id]
     end
 
     def gc_stat_diff before, after
-      stat_diff before, after, except: [
+      stat_diff before, after, no_diff: [
         :heap_allocatable_slots,
         :malloc_increase_bytes_limit,
         :remembered_wb_unprotected_objects_limit,
@@ -20,14 +20,14 @@ module Dial
 
     def gc_stat_heap_diff before, after
       after.each_with_object({}) do |(slot_index, slot_stat), diff|
-        diff[slot_index] = stat_diff before[slot_index], slot_stat, except: [:slot_size]
+        diff[slot_index] = stat_diff before[slot_index], slot_stat, no_diff: [:slot_size]
       end
     end
 
-    def stat_diff before, after, except: []
-      after.except(*except).each_with_object({}) do |(key, value), diff|
+    def stat_diff before, after, no_diff: []
+      after.except(*no_diff).each_with_object({}) do |(key, value), diff|
         diff[key] = value - before[key]
-      end
+      end.merge after.slice *no_diff
     end
   end
 end

data/lib/dial/middleware.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require "securerandom"
+
 require "vernier"
+require "prosopite"
 
-require_relative "ruby_stat"
-require_relative "rails_stat"
-require_relative "constants"
-require_relative "panel"
+require_relative "middleware/panel"
+require_relative "middleware/ruby_stat"
+require_relative "middleware/rails_stat"
 
 module Dial
   class Middleware
@@ -17,40 +19,38 @@ module Dial
     end
 
     def call env
-      start_time = ::Process.clock_gettime ::Process::CLOCK_MONOTONIC
-
-      ruby_vm_stat_before = RubyVM.stat
-      gc_stat_before = GC.stat
-      gc_stat_heap_before = GC.stat_heap
+      start_time = Process.clock_gettime Process::CLOCK_MONOTONIC
 
-      profile_out_dirname = String ::Rails.root.join PROFILE_OUT_RELATIVE_DIRNAME
-      FileUtils.mkdir_p profile_out_dirname
-      profile_out_filename = "#{SecureRandom.uuid}.json"
-      profile_out_pathname = "#{profile_out_dirname}#{profile_out_filename}"
+      profile_out_filename = "#{SecureRandom.uuid_v7}.json"
+      profile_out_pathname = "#{profile_out_dir_pathname}#{profile_out_filename}"
 
       status, headers, rack_body = nil
-      ::Vernier.profile out: profile_out_pathname do
-        status, headers, rack_body = @app.call env
+      ruby_vm_stat, gc_stat, gc_stat_heap = nil
+      ::Prosopite.scan do
+        ::Vernier.profile out: profile_out_pathname, interval: 500, allocation_interval: 1000, hooks: [:memory_usage, :rails] do
+          ruby_vm_stat, gc_stat, gc_stat_heap = with_diffed_ruby_stats do
+            status, headers, rack_body = @app.call env
+          end
+        end
       end
+      server_timing = server_timing headers
 
       unless headers[::Rack::CONTENT_TYPE]&.include? "text/html"
         File.delete profile_out_pathname if File.exist? profile_out_pathname
         return [status, headers, rack_body]
       end
 
-      finish_time = ::Process.clock_gettime ::Process::CLOCK_MONOTONIC
-      env[REQUEST_TIMING_HEADER] = ((finish_time - start_time) * 1_000).round 2
+      query_logs = clear_query_logs!
+      remove_stale_profile_out_files!
 
-      ruby_vm_stat_diff = ruby_vm_stat_diff ruby_vm_stat_before, RubyVM.stat
-      gc_stat_diff = gc_stat_diff gc_stat_before, GC.stat
-      gc_stat_heap_diff = gc_stat_heap_diff gc_stat_heap_before, GC.stat_heap
-      server_timing = server_timing headers
+      finish_time = Process.clock_gettime Process::CLOCK_MONOTONIC
+      env[REQUEST_TIMING_HEADER] = ((finish_time - start_time) * 1_000).round 2
 
       body = String.new.tap do |str|
         rack_body.each { |chunk| str << chunk }
-        rack_body.close if body.respond_to? :close
+        rack_body.close if rack_body.respond_to? :close
       end.sub "</body>", <<~HTML
-          #{Panel.html env, profile_out_filename, ruby_vm_stat_diff, gc_stat_diff, gc_stat_heap_diff, server_timing}
+          #{Panel.html env, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing}
         </body>
       HTML
 
@@ -58,5 +58,77 @@ module Dial
 
       [status, headers, [body]]
     end
+
+    private
+
+    def with_diffed_ruby_stats
+      ruby_vm_stat_before = RubyVM.stat
+      gc_stat_before = GC.stat
+      gc_stat_heap_before = GC.stat_heap
+      yield
+      [
+        ruby_vm_stat_diff(ruby_vm_stat_before, RubyVM.stat),
+        gc_stat_diff(gc_stat_before, GC.stat),
+        gc_stat_heap_diff(gc_stat_heap_before, GC.stat_heap)
+      ]
+    end
+
+    def remove_stale_profile_out_files!
+      stale_profile_out_files.each do |profile_out_file|
+        File.delete profile_out_file
+      end
+    end
+
+    def stale_profile_out_files
+      Dir.glob("#{profile_out_dir_pathname}/*.json").select do |profile_out_file|
+        timestamp = Util.uuid_v7_timestamp File.basename profile_out_file
+        timestamp < Time.now - PROFILE_OUT_STALE_SECONDS
+      end
+    end
+
+    def profile_out_dir_pathname
+      @_profile_out_dir_pathname ||= ::Rails.root.join PROFILE_OUT_RELATIVE_DIRNAME
+    end
+
+    def clear_query_logs!
+      [].tap do |query_logs|
+        File.open(query_log_pathname, "r+") do |file|
+          entry = reading_section = query_count = nil
+          file.each_line do |line|
+            case line
+            when /N\+1 queries detected/
+              entry = [[], []]
+              reading_section = :queries
+              query_count = 0
+            when /Call stack/
+              reading_section = :call_stack
+              if query_count > 5
+                entry.first << "+ #{query_count - 5} more queries"
+              end
+            else
+              case reading_section
+              when :queries
+                query_count += 1
+                entry.first << line.strip if query_count <= 5
+              when :call_stack
+                if line.strip.empty?
+                  query_logs << entry
+                  reading_section = nil
+                else
+                  entry.last << line.strip
+                end
+              end
+            end
+          end
+
+          file.truncate 0
+          file.rewind
+        end
+      end
+    end
+
+    def query_log_pathname
+      @_query_log_dir_pathname ||= ::Rails.root.join PROSOPITE_LOG_RELATIVE_PATHNAME
+    end
   end
 end

data/lib/dial/prosopite_logger.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Dial
+  class ProsopiteLogger < Logger
+  end
+end

data/lib/dial/railtie.rb

@@ -1,13 +1,36 @@
 # frozen_string_literal: true
 
 require "rails"
+require "prosopite"
 
 require_relative "middleware"
+require_relative "prosopite_logger"
 
 module Dial
   class Railtie < ::Rails::Railtie
     initializer "dial.use_middleware" do |app|
       app.middleware.insert_before 0, Middleware
     end
+
+    initializer "dial.set_up_vernier" do |app|
+      app.config.after_initialize do
+        FileUtils.mkdir_p ::Rails.root.join PROFILE_OUT_RELATIVE_DIRNAME
+      end
+    end
+
+    initializer "dial.set_up_prosopite" do |app|
+      app.config.after_initialize do
+        if ::ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+          require "pg_query"
+        end
+
+        prosopite_log_pathname = ::Rails.root.join PROSOPITE_LOG_RELATIVE_PATHNAME
+        FileUtils.mkdir_p File.dirname prosopite_log_pathname
+        FileUtils.touch prosopite_log_pathname
+        ::Prosopite.custom_logger = ProsopiteLogger.new prosopite_log_pathname
+
+        ::Prosopite.ignore_queries = PROSOPITE_IGNORE_QUERIES
+      end
+    end
   end
 end

data/lib/dial/util.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Dial
+  module Util
+    class << self
+      def uuid_v7_timestamp uuid
+        high_bits_hex = uuid.split("-").first(2).join[0, 12].to_i 16
+        Time.at high_bits_hex / 1000.0
+      end
+    end
+  end
+end

data/lib/dial/version.rb

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

data/lib/dial.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "dial/version"
+require_relative "dial/constants"
+require_relative "dial/util"
+
 require_relative "dial/railtie"
 require_relative "dial/engine"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dial
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Joshua Young
 bindir: bin
 cert_chain: []
-date: 2024-11-10 00:00:00.000000000 Z
+date: 2024-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -75,14 +75,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: prosopite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: pg_query
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 email:
 - djry1999@gmail.com
 executables: []
@@ -99,10 +127,12 @@ files:
 - lib/dial/engine.rb
 - lib/dial/engine/routes.rb
 - lib/dial/middleware.rb
-- lib/dial/panel.rb
-- lib/dial/rails_stat.rb
+- lib/dial/middleware/panel.rb
+- lib/dial/middleware/rails_stat.rb
+- lib/dial/middleware/ruby_stat.rb
+- lib/dial/prosopite_logger.rb
 - lib/dial/railtie.rb
-- lib/dial/ruby_stat.rb
+- lib/dial/util.rb
 - lib/dial/version.rb
 homepage: https://github.com/joshuay03/dial
 licenses:
@@ -124,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A modern Rails profiler
 test_files: []