dial 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f762021d933bef646eb988e55b0ec442340bfa99da4f4c1d66a14cbe26f25054
-  data.tar.gz: bb66fb389dad9e99b60254082fc908db828cd67ea04db037ea964c7d34a5258a
+  metadata.gz: dcc8b8f15acf035328c3330930476af9621529608cabcb511b240cc7da9a9ecf
+  data.tar.gz: 05b4c3610edad8e1b6b4cb1cad387ea962d7e250c8cb165a845926bbd668e37c
 SHA512:
-  metadata.gz: ab5085f5003418be961eb813f945949500e3a122cb90af764e28c2c2378e815362e00cc45fa146c5fe1daf179bfce17a5a86e2fd11e7d806c86d7779ca4b522e
-  data.tar.gz: 6cba71872c47594b3964a8ffe17b802e7564694d83aceb9416f51048e68f42e0682e7b9546e304cdb7cc3ece8a8396e5142692381e93e68ba92bab15a8084e68
+  metadata.gz: 9bf37053b4f2bc59bd322646d7485326378c6d234d822571e59f14530ea4382830a6b842f514bef3f9fc7d6719b9b212251023b5c6a214304fb920aac0c4abd3
+  data.tar.gz: c5688daab1bd6d82310bab1270a243e507eb54bbc12cbf187c2d3237e43fe1d5022df34fa7f105b642ca563f10f7b343181a74bc5c1864a1dd36d5cca6d15f85

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 ## [Unreleased]
 
-## [0.1.1] - 2024-11-08
+## [0.1.3] - 2024-11-14
+
+- Enable allocation profiling by default
 
-- Set upper bound on dependencies
+## [0.1.2] - 2024-11-10
 
-## [0.1.0] - 2024-11-08
+- Add support for request profiling with vernier
+
+## [0.1.1] - 2024-11-08
 
 - Initial release

data/README.md

@@ -1,25 +1,24 @@
 # Dial
 
+![Version](https://img.shields.io/gem/v/dial)
+![Build](https://img.shields.io/github/actions/workflow/status/joshuay03/dial/.github/workflows/main.yml?branch=main)
+
 WIP
 
 A modern profiler for Rails applications.
 
-<details>
-<summary>POC</summary>
-
-![Demo 1](https://github.com/user-attachments/assets/904daaf5-3f18-4c94-a7e4-9418539a19f3)
-![Demo 2](https://github.com/user-attachments/assets/eb6ed9f5-b258-42df-8901-222c7d969fdd)
-
-</details>
+https://github.com/user-attachments/assets/bae59681-ebeb-42b3-9489-9692c072c3dc
 
 ## Installation
 
-Install the gem and add it to your application's Gemfile by executing:
+Install the gem and add it to your Rails application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add dial
 ```
 
+and everything should just work.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the

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.0.0"
+  spec.required_ruby_version = ">= 3.2.1"
 
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.files = Dir["{lib}/**/*", "**/*.{gemspec,md,txt}"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "railties", ">= 7.0.0", "<= 8.0"
-  spec.add_dependency "activerecord", ">= 7.0.0", "<= 8.0"
-  spec.add_dependency "actionpack", ">= 7.0.0", "<= 8.0"
+  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"
 end

data/lib/dial/constants.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Dial
-  module Constants
-    DIAL_REQUEST_TIMING = "dial_request_timing"
-  end
+  REQUEST_TIMING_HEADER = "dial_request_timing"
+  PROFILE_OUT_RELATIVE_DIRNAME = "tmp/dial/profile/"
 end

data/lib/dial/engine/routes.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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"
+
+      if File.exist? path
+        [
+          200,
+          { "Content-Type" => "application/json", "Access-Control-Allow-Origin" => "https://vernier.prof" },
+          [File.read(path)]
+        ]
+      else
+        [
+          404,
+          { "Content-Type" => "text/plain" },
+          ["Not Found"]
+        ]
+      end
+    }
+  end
+end

data/lib/dial/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module Dial
+  class Engine < ::Rails::Engine
+    isolate_namespace Dial
+
+    paths["config/routes.rb"] = ["lib/dial/engine/routes.rb"]
+  end
+end

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

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
-require_relative "constants"
+require "uri"
 
 module Dial
   class Panel
     class << self
-      include Constants
-
-      def html env, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
+      def html env, profile_out_filename, 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)}</span>
+              <span>
+                #{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>
@@ -23,30 +25,30 @@ 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>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>
@@ -73,42 +75,41 @@ 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;
+            }
+
+            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
@@ -135,7 +136,16 @@ module Dial
       end
 
       def formatted_request_timing env
-        "<b>Request timing:</b> #{env[DIAL_REQUEST_TIMING]}ms"
+        "<b>Request timing:</b> #{env[REQUEST_TIMING_HEADER]}ms"
+      end
+
+      def formatted_profile_output env, profile_out_filename
+        uuid = profile_out_filename.delete_suffix ".json"
+        host = env[::Rack::HTTP_HOST]
+        base_url = ::Rails.application.routes.url_helpers.dial_url host: host
+        profile_out_url = URI.encode_www_form_component base_url + "dial/profile?uuid=#{uuid}"
+
+        "<a href='https://vernier.prof/from-url/#{profile_out_url}' target='_blank'>View profile</a>"
       end
 
       def formatted_rails_version
@@ -147,7 +157,18 @@ 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_ruby_vm_stat ruby_vm_stat
@@ -170,17 +191,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,43 +1,56 @@
 # frozen_string_literal: true
 
-require_relative "ruby_stat"
-require_relative "rails_stat"
+require "vernier"
+
 require_relative "constants"
-require_relative "panel"
+require_relative "middleware/panel"
+require_relative "middleware/ruby_stat"
+require_relative "middleware/rails_stat"
 
 module Dial
   class Middleware
     include RubyStat
     include RailsStat
-    include Constants
 
     def initialize app
       @app = app
     end
 
     def call env
-      start_time = ::Process.clock_gettime ::Process::CLOCK_MONOTONIC
+      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
 
-      status, headers, rack_body = @app.call env
-      return [status, headers, rack_body] unless headers[::Rack::CONTENT_TYPE]&.include? "text/html"
+      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}"
+
+      status, headers, rack_body = nil
+      ::Vernier.profile out: profile_out_pathname, interval: 500, allocation_interval: 1000 do
+        status, headers, rack_body = @app.call env
+      end
+
+      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[DIAL_REQUEST_TIMING] = ((finish_time - start_time) * 1_000).round 2
+      finish_time = Process.clock_gettime Process::CLOCK_MONOTONIC
+      env[REQUEST_TIMING_HEADER] = ((finish_time - start_time) * 1_000).round 2
 
-      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
+      ruby_vm_stat = ruby_vm_stat_diff ruby_vm_stat_before, RubyVM.stat
+      gc_stat = gc_stat_diff gc_stat_before, GC.stat
+      gc_stat_heap = gc_stat_heap_diff gc_stat_heap_before, GC.stat_heap
       server_timing = server_timing headers
 
       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, ruby_vm_stat_diff, gc_stat_diff, gc_stat_heap_diff, server_timing}
+          #{Panel.html env, profile_out_filename, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing}
         </body>
       HTML
 

data/lib/dial/version.rb

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

data/lib/dial.rb

@@ -2,3 +2,4 @@
 
 require_relative "dial/version"
 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.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Joshua Young
 bindir: bin
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -15,60 +15,74 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<="
+        version: '7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<="
+        version: '7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<="
+        version: '7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<="
+        version: '7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<="
+        version: '7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
-    - - "<="
+        version: '7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: vernier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 email:
 - djry1999@gmail.com
 executables: []
@@ -82,11 +96,13 @@ files:
 - dial.gemspec
 - lib/dial.rb
 - lib/dial/constants.rb
+- 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/railtie.rb
-- lib/dial/ruby_stat.rb
 - lib/dial/version.rb
 homepage: https://github.com/joshuay03/dial
 licenses:
@@ -101,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="