dial 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edead8fe405ee09b2ece6be004f6200ddd9394707a41da3509cbd168f3b88c67
-  data.tar.gz: 506f4b258c2b0acf117b1f4885ede6cf93ec739c1f21e0dc82b1f3da086f9a2c
+  metadata.gz: 24787fba428e09eb96323d44b54df1487172d965b47e88df27b1855cefe8e02d
+  data.tar.gz: 520e95aae1ac2ca66bb09156a54203a200b94e401c35d269990d43978d2e08cb
 SHA512:
-  metadata.gz: c8f6c3705814f0cc0ae49bddf462741cf74d6de0733bd08280f6b01123368afb6ad46a1f7bf09329ee1c16c53a1d651c34b39d7277efce651f72550cd8e06557
-  data.tar.gz: 22236134d9731d47eacbc6d931ed2484b4e5451c875e554dcd5fc5fea3db84e3aaaf429db3f318939de30d52aa49ff49251f5300fc8243bf41e247d40c11c555
+  metadata.gz: dc6187fea22a1334c217461a5b5394ea23f8b1b6c821000ec2629d7537b0986b3626adb16685d4268dd572772fc3fb0ad4eaa4c827faa7c592040258610cad63
+  data.tar.gz: bc4ea0f5fabdece3ee0aef7b098035cecc66faad7d5714457b210510a3fa2e3ffd5b08e73ddeebb26f9704817e128f13cc8d2dbf5b03d4eae08b0a60c0d69781

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.2.5] - 2025-04-04
+
+- Perf: Write prosopite logs to IO stream instead of file
+- Remove upper bound on rails dependencies
+
+## [0.2.4] - 2025-03-03
+
+- Add configuration option for setting script CSP nonce (thanks @matthaigh27)
+
 ## [0.2.3] - 2025-02-28
 
 - Add configuration API

data/README.md

@@ -5,7 +5,14 @@
 
 WIP
 
-A modern profiler for Rails applications.
+A modern profiler for your Rails application.
+
+Utilizes [vernier](https://github.com/jhawthorn/vernier) for profiling and
+[prosopite](https://github.com/charkost/prosopite) for N+1 query detection.
+
+> [!NOTE]
+> Check out the resources in the [Vernier](https://github.com/jhawthorn/vernier) project for more information on how to
+> interpret the viewer, as well as comparisons with other profilers, including `stackprof`.
 
 Check out the demo:
 [![Demo](https://img.youtube.com/vi/LPXtfJ0c284/maxresdefault.jpg)](https://youtu.be/LPXtfJ0c284)
@@ -39,12 +46,40 @@ mount Dial::Engine, at: "/" if Rails.env.development?
 # config/initializers/dial.rb
 
 Dial.configure do |config|
-  config.vernier_interval = 100 # default: 200
-  config.vernier_allocation_interval = 10_000 # default: 20_000
-  config.prosopite_ignore_queries += [/pg_sleep/i] # default: [/schema_migrations/i]
+  config.vernier_interval = 100
+  config.vernier_allocation_interval = 10_000
+  config.prosopite_ignore_queries += [/pg_sleep/i]
 end
 ```
 
+## Options
+
+Option | Description | Default
+:- | :- | :-
+`vernier_interval` | Sets the `interval` option for vernier. | `200`
+`vernier_allocation_interval` | Sets the `allocation_interval` option for vernier. | `20_000`
+`prosopite_ignore_queries` | Sets the `ignore_queries` option for prosopite. | `[/schema_migrations/i]`
+`content_security_policy_nonce` | Sets the content security policy nonce to use when inserting Dial's script. Can be a string, or a Proc which receives `env` and response `headers` as arguments and returns the nonce string. | Rails generated nonce or `nil`
+
+## Comparison with [rack-mini-profiler](https://github.com/MiniProfiler/rack-mini-profiler)
+
+|                           | rack-mini-profiler                 | Dial                                                    |
+| :------------------------ | :--------------------------------- | :------------------------------------------------------ |
+| Compatibility             | Any Rack application               | Only Rails applications                                 |
+| Database Profiling        | Yes                                | Yes (via vernier hook - marker table, chart)            |
+| N+1 Query Detection       | Yes (*needs to be inferred)        | Yes (via prosopite)                                     |
+| Ruby Profiling            | Yes (with stackprof - flame graph) | Yes (via vernier - flame graph, stack chart, call tree) |
+| Ruby Allocation Profiling | Yes (with stackprof - flame graph) | Yes (via vernier - flame graph, stack chart, call tree) |
+| Memory Profiling          | Yes (with memory_profiler)         | Yes (*overall usage only) (via vernier hook - graph)    |
+| View Profiling            | Yes                                | Yes (via vernier hook - marker table, chart)            |
+| Snapshot Sampling         | Yes                                | No                                                      |
+| Production Support        | Yes                                | No (WIP)                                                |
+
+> [!NOTE]
+> SQL queries displayed in the profile are not annotated with the caller location by default. If you're not using the
+> [marginalia](https://github.com/basecamp/marginalia) gem to annotate your queries, you will need to extend your
+> application's [ActiveRecord QueryLogs](https://edgeapi.rubyonrails.org/classes/ActiveRecord/QueryLogs.html) yourself.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the
@@ -60,5 +95,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Dial project's codebases, issue trackers, chat rooms and mailing lists is expected to follow
-the [code of conduct](https://github.com/joshuay03/dial/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Dial project's codebase and issue tracker is expected to follow the
+[code of conduct](https://github.com/joshuay03/dial/blob/main/CODE_OF_CONDUCT.md).

data/dial.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Joshua Young"]
   spec.email = ["djry1999@gmail.com"]
 
-  spec.summary = "A modern Rails profiler"
+  spec.summary = "A modern profiler for your Rails application"
   spec.homepage = "https://github.com/joshuay03/dial"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.3.0"
@@ -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", "< 8.2"
-  spec.add_dependency "activerecord", ">= 7", "< 8.2"
-  spec.add_dependency "actionpack", ">= 7", "< 8.2"
+  spec.add_dependency "railties", ">= 7"
+  spec.add_dependency "activerecord", ">= 7"
+  spec.add_dependency "actionpack", ">= 7"
   spec.add_dependency "vernier"
   spec.add_dependency "prosopite"
   spec.add_dependency "pg_query"

data/lib/dial/configuration.rb

@@ -15,14 +15,15 @@ module Dial
         vernier_interval: VERNIER_INTERVAL,
         vernier_allocation_interval: VERNIER_ALLOCATION_INTERVAL,
         prosopite_ignore_queries: PROSOPITE_IGNORE_QUERIES,
+        content_security_policy_nonce: -> (env, _headers) { env[NONCE] || "" },
       }
 
       @options.keys.each do |key|
-        define_singleton_method(key) do
+        define_singleton_method key do
           @options[key]
         end
 
-        define_singleton_method("#{key}=") do |value|
+        define_singleton_method "#{key}=" do |value|
           @options[key] = value
         end
       end

data/lib/dial/constants.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rack"
+require "action_dispatch"
 
 require_relative "version"
 
@@ -10,6 +11,7 @@ module Dial
   HTTP_ACCEPT = "HTTP_ACCEPT"
   CONTENT_TYPE = ::Rack::CONTENT_TYPE
   CONTENT_LENGTH = ::Rack::CONTENT_LENGTH
+  NONCE = ::ActionDispatch::ContentSecurityPolicy::Request::NONCE
   REQUEST_TIMING = "dial_request_timing"
 
   FILE_STALE_SECONDS = 60 * 60
@@ -17,8 +19,8 @@ module Dial
   VERNIER_INTERVAL = 200
   VERNIER_ALLOCATION_INTERVAL = 20_000
   VERNIER_PROFILE_OUT_RELATIVE_DIRNAME = "tmp/dial/profiles"
+  VERNIER_VIEWER_URL = "https://vernier.prof"
 
   PROSOPITE_IGNORE_QUERIES = [/schema_migrations/i].freeze
-  PROSOPITE_LOG_RELATIVE_DIRNAME = "log/dial"
-  PROSOPITE_LOG_FILENAME = "#{Util.uuid}_prosopite_#{PROGRAM_ID}.log".freeze
+  PROSOPITE_LOG_IO = StringIO.new
 end

data/lib/dial/engine/routes.rb

@@ -9,7 +9,7 @@ Dial::Engine.routes.draw do
       if File.exist? path
         [
           200,
-          { "Content-Type" => "application/json", "Access-Control-Allow-Origin" => "https://vernier.prof" },
+          { "Content-Type" => "application/json", "Access-Control-Allow-Origin" => Dial::VERNIER_VIEWER_URL },
           [File.read(path)]
         ]
       else

data/lib/dial/middleware/panel.rb

@@ -5,7 +5,7 @@ require "uri"
 module Dial
   class Panel
     class << self
-      def html env, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
+      def html env, headers, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
         <<~HTML
           <style>#{style}</style>
 
@@ -69,7 +69,9 @@ module Dial
             </div>
           </div>
 
-          <script>#{script}</script>
+          <script nonce="#{configured_nonce env, headers}">
+            #{script}
+          </script>
         HTML
       end
 
@@ -171,7 +173,7 @@ module Dial
       end
 
       def formatted_rails_route_info env
-        rails_route_info = begin
+        begin
           ::Rails.application.routes.recognize_path env[::Rack::PATH_INFO], method: env[::Rack::REQUEST_METHOD]
         rescue ::ActionController::RoutingError
           {}
@@ -253,6 +255,15 @@ module Dial
           HTML
         end.join
       end
+
+      def configured_nonce env, headers
+        config_nonce = Dial._configuration.content_security_policy_nonce
+        if config_nonce.instance_of? Proc
+          config_nonce.call env, headers
+        else
+          config_nonce
+        end
+      end
     end
   end
 end

data/lib/dial/middleware/ruby_stat.rb

@@ -27,7 +27,7 @@ module Dial
     def stat_diff before, after, no_diff: []
       after.except(*no_diff).each_with_object({}) do |(key, value), diff|
         diff[key] = value - before[key]
-      end.merge after.slice *no_diff
+      end.merge after.slice(*no_diff)
     end
   end
 end

data/lib/dial/middleware.rb

@@ -51,10 +51,12 @@ module Dial
       body = String.new.tap do |str|
         rack_body.each { |chunk| str << chunk }
         rack_body.close if rack_body.respond_to? :close
-      end.sub "</body>", <<~HTML
-          #{Panel.html env, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing}
-        </body>
-      HTML
+
+        str.sub! "</body>", <<~HTML
+            #{Panel.html env, headers, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing}
+          </body>
+        HTML
+      end
 
       headers[CONTENT_LENGTH] = body.bytesize.to_s
 
@@ -86,16 +88,14 @@ module Dial
 
     def clear_query_logs!
       [].tap do |query_logs|
-        File.open("#{query_log_dir_pathname}/#{PROSOPITE_LOG_FILENAME}", "r+") do |file|
-          entry = section = count = nil
-          file.each_line do |line|
-            entry, section, count = process_query_log_line line, entry, section, count
-            query_logs << entry if entry && section.nil?
-          end
-
-          file.truncate 0
-          file.rewind
+        entry = section = count = nil
+        PROSOPITE_LOG_IO.string.lines.each do |line|
+          entry, section, count = process_query_log_line line, entry, section, count
+          query_logs << entry if entry && section.nil?
         end
+
+        PROSOPITE_LOG_IO.truncate 0
+        PROSOPITE_LOG_IO.rewind
       end
     end
 
@@ -126,9 +126,5 @@ module Dial
     def profile_out_dir_pathname
       ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
     end
-
-    def query_log_dir_pathname
-      ::Rails.root.join PROSOPITE_LOG_RELATIVE_DIRNAME
-    end
   end
 end

data/lib/dial/railtie.rb

@@ -31,16 +31,7 @@ module Dial
           require "pg_query"
         end
 
-        prosopite_log_pathname = "#{query_log_dir_pathname}/#{PROSOPITE_LOG_FILENAME}"
-        FileUtils.mkdir_p File.dirname prosopite_log_pathname
-        FileUtils.touch prosopite_log_pathname
-        ::Prosopite.custom_logger = ProsopiteLogger.new prosopite_log_pathname
-      end
-    end
-
-    initializer "dial.clean_up_prosopite_log_files", after: :load_config_initializers do |app|
-      stale_files("#{query_log_dir_pathname}/*.log").each do |query_log_file|
-        File.delete query_log_file rescue nil
+        ::Prosopite.custom_logger = ProsopiteLogger.new PROSOPITE_LOG_IO
       end
     end
 
@@ -48,7 +39,6 @@ module Dial
       app.config.after_initialize do
         Dial._configuration.freeze
 
-        # set static configuration options
         ::Prosopite.ignore_queries = Dial._configuration.prosopite_ignore_queries
       end
     end
@@ -65,9 +55,5 @@ module Dial
     def profile_out_dir_pathname
       ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
     end
-
-    def query_log_dir_pathname
-      ::Rails.root.join PROSOPITE_LOG_RELATIVE_DIRNAME
-    end
   end
 end

data/lib/dial/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dial
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Joshua Young
 bindir: bin
 cert_chain: []
-date: 2025-02-28 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,9 +16,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,9 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -36,9 +30,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -46,9 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -56,9 +44,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -66,9 +51,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: vernier
   requirement: !ruby/object:Gem::Requirement
@@ -157,5 +139,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: A modern Rails profiler
+summary: A modern profiler for your Rails application
 test_files: []