dial 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22930c6ef22196a525fb4986ce053b36f148867083636976d54f184a2dd2f46d
-  data.tar.gz: a7131f94657e6fca3f8826306cf8d9a1cd98e888def46e05ba690833492dcd8d
+  metadata.gz: 31949e2dbaf8b3ca4f422ae02115747913ce3bd704b0aaf8d45d5956d0ba2ac5
+  data.tar.gz: aecdd78df3d7e50c0dd9b98c67c0f7633d6cc2fa43ea33d01987a148dff53cf0
 SHA512:
-  metadata.gz: f0bca632784f1ff0f5b8cd82df1117dcb0e8f2c7bcf07973b174964106a4eb67ac23fead61930b8ddd99376dcf0dc4df32624494518303b7a85be136c2a8e669
-  data.tar.gz: d9da11b80ac380b8db0991498f966397707e9c3e6a270c75a68644de16b9bbd610604bb819345885c474047bb4ed4531ae106f19748972df594fac19a7e838e0
+  metadata.gz: 21ed80548f3559308cfdc13ff69df8168ef87ffa6268faea8d5901e2209cbd1e9f775bcbd48db355e83c1d3e48cb59f285af0c0271fc1fa14442852c84dab521
+  data.tar.gz: 202f8d84d6ce0520b7bf53df0cac7545a85f1c6f723c845158c9161cf52f1a1a6fbe55e70671a70c9bf1ca43aad052d28d2f10b3a7572ea34c5747090121ab98

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.1.9] - 2025-01-27
+
+- Increase default vernier allocation interval from 10k to 100k
+
+## [0.1.8] - 2025-01-27
+
+- Require ruby 3.3.0 or later
+- Handle stale file deletion in railtie, extend to log files
+- Make log files unique to each session - simplify installation
+
 ## [0.1.7] - 2025-01-25
 
 - Increase default vernier allocation interval from 1k to 10k

data/README.md

@@ -12,11 +12,12 @@ Check out the demo:
 
 ## Installation
 
-1. Add the gem to your Rails application's Gemfile (adjust the `require` option to match your server of choice):
+1. Add the gem to your Rails application's Gemfile:
 
 ```ruby
-# require in just the server process
-gem "dial", require: !!($PROGRAM_NAME =~ /puma/)
+group :development do
+  gem "dial"
+end
 ```
 
 2. Install the gem:
@@ -29,7 +30,7 @@ bundle install
 
 ```ruby
 # this will mount the engine at /dial
-mount Dial::Engine, at: "/" if Object.const_defined? "Dial::Engine"
+mount Dial::Engine, at: "/" if Rails.env.development?
 ```
 
 ## Development

data/dial.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "A modern Rails profiler"
   spec.homepage = "https://github.com/joshuay03/dial"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.1"
+  spec.required_ruby_version = ">= 3.3.0"
 
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"

data/lib/dial/constants.rb

@@ -3,11 +3,17 @@
 require_relative "version"
 
 module Dial
+  PROGRAM_ID = Process.getsid Process.pid
+
   REQUEST_TIMING_HEADER = "dial_request_timing"
 
-  PROFILE_OUT_STALE_SECONDS = 60 * 60
-  PROFILE_OUT_RELATIVE_DIRNAME = "tmp/dial/profiles/"
+  FILE_STALE_SECONDS = 60 * 60
+
+  VERNIER_INTERVAL = 500
+  VERNIER_ALLOCATION_INTERVAL = 100_000
+  VERNIER_PROFILE_OUT_RELATIVE_DIRNAME = "tmp/dial/profiles"
 
-  PROSOPITE_IGNORE_QUERIES = [/schema_migrations/]
-  PROSOPITE_LOG_RELATIVE_PATHNAME = "log/dial/prosopite.log"
+  PROSOPITE_IGNORE_QUERIES = [/schema_migrations/].freeze
+  PROSOPITE_LOG_RELATIVE_DIRNAME = "log/dial"
+  PROSOPITE_LOG_FILENAME = "#{Util.uuid}_prosopite_#{PROGRAM_ID}.log".freeze
 end

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::PROFILE_OUT_RELATIVE_DIRNAME, "#{uuid}.json"
+      path = String ::Rails.root.join Dial::VERNIER_PROFILE_OUT_RELATIVE_DIRNAME, "#{uuid}.json"
 
       if File.exist? path
         [

data/lib/dial/middleware.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "securerandom"
-
 require "vernier"
 require "prosopite"
 
@@ -21,13 +19,13 @@ module Dial
     def call env
       start_time = Process.clock_gettime Process::CLOCK_MONOTONIC
 
-      profile_out_filename = "#{SecureRandom.uuid_v7}.json"
-      profile_out_pathname = "#{profile_out_dir_pathname}#{profile_out_filename}"
+      profile_out_filename = "#{Util.uuid}_vernier.json"
+      profile_out_pathname = "#{profile_out_dir_pathname}/#{profile_out_filename}"
 
       status, headers, rack_body = nil
       ruby_vm_stat, gc_stat, gc_stat_heap = nil
       ::Prosopite.scan do
-        ::Vernier.profile out: profile_out_pathname, interval: 500, allocation_interval: 10_000, hooks: [:memory_usage, :rails] do
+        ::Vernier.profile out: profile_out_pathname, interval: VERNIER_INTERVAL, allocation_interval: VERNIER_ALLOCATION_INTERVAL, 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
@@ -36,12 +34,10 @@ module Dial
       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
 
       query_logs = clear_query_logs!
-      remove_stale_profile_out_files!
 
       finish_time = Process.clock_gettime Process::CLOCK_MONOTONIC
       env[REQUEST_TIMING_HEADER] = ((finish_time - start_time) * 1_000).round 2
@@ -73,26 +69,9 @@ module Dial
       ]
     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|
+        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
@@ -129,8 +108,12 @@ module Dial
       end
     end
 
-    def query_log_pathname
-      @_query_log_dir_pathname ||= ::Rails.root.join PROSOPITE_LOG_RELATIVE_PATHNAME
+    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

@@ -14,7 +14,13 @@ module Dial
 
     initializer "dial.set_up_vernier" do |app|
       app.config.after_initialize do
-        FileUtils.mkdir_p ::Rails.root.join PROFILE_OUT_RELATIVE_DIRNAME
+        FileUtils.mkdir_p ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
+      end
+    end
+
+    initializer "dial.clean_up_vernier_profile_out_files" do |app|
+      stale_files("#{profile_out_dir_pathname}/*.json").each do |profile_out_file|
+        File.delete profile_out_file rescue nil
       end
     end
 
@@ -24,7 +30,7 @@ module Dial
           require "pg_query"
         end
 
-        prosopite_log_pathname = ::Rails.root.join PROSOPITE_LOG_RELATIVE_PATHNAME
+        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
@@ -32,5 +38,28 @@ module Dial
         ::Prosopite.ignore_queries = PROSOPITE_IGNORE_QUERIES
       end
     end
+
+    initializer "dial.clean_up_prosopite_log_files" do |app|
+      stale_files("#{query_log_dir_pathname}/*.log").each do |query_log_file|
+        File.delete query_log_file rescue nil
+      end
+    end
+
+    private
+
+    def stale_files glob_pattern
+      Dir.glob(glob_pattern).select do |file|
+        timestamp = Util.uuid_timestamp Util.file_name_uuid File.basename file
+        timestamp < Time.now - FILE_STALE_SECONDS
+      end
+    end
+
+    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/util.rb

@@ -1,9 +1,19 @@
 # frozen_string_literal: true
 
+require "securerandom"
+
 module Dial
   module Util
     class << self
-      def uuid_v7_timestamp uuid
+      def uuid
+        SecureRandom.uuid_v7
+      end
+
+      def file_name_uuid file_name
+        file_name.split("_").first
+      end
+
+      def uuid_timestamp uuid
         high_bits_hex = uuid.split("-").first(2).join[0, 12].to_i 16
         Time.at high_bits_hex / 1000.0
       end

data/lib/dial/version.rb

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

data/lib/dial.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "dial/constants"
 require_relative "dial/util"
+require_relative "dial/constants"
 
 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.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Joshua Young
 bindir: bin
 cert_chain: []
-date: 2025-01-25 00:00:00.000000000 Z
+date: 2025-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -147,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.1
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="