dial 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c66ebfd5f92223dfdb75e7f13880a293074408ccfbf835eae6b641bed9b8fcc
+  data.tar.gz: ef11315610241303543d3319ead19364effe60b326ee29f901ece1623331e8f2
+SHA512:
+  metadata.gz: 004b0ed1ce0ba338bce6ec32a9c15b634263d6bdac011215a49497923c5f72bd6730d31ea76a6f38ce910efe67e09322d25efdd5e2dd97a6fd91959afe14bdcc
+  data.tar.gz: a60be22b96db02f9bdcfe3d1a314ef98fa1b1d51af6b2744962156fe191703ad07d1b7fc8242fbefcb8098d4d889302cc7f66a3a6a0775ee6758102f8904c50c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-08
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Joshua Young
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Dial
+
+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>
+
+## Installation
+
+Install the gem and add it to your application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the
+tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joshuay03/dial.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/dial.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "lib/dial/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dial"
+  spec.version = Dial::VERSION
+  spec.authors = ["Joshua Young"]
+  spec.email = ["djry1999@gmail.com"]
+
+  spec.summary = "A modern Rails profiler"
+  spec.homepage = "https://github.com/joshuay03/dial"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  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"
+end

data/lib/dial/constants.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Dial
+  module Constants
+    DIAL_REQUEST_TIMING = "dial_request_timing"
+  end
+end

data/lib/dial/middleware.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "ruby_stat"
+require_relative "rails_stat"
+require_relative "constants"
+require_relative "panel"
+
+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
+
+      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"
+
+      finish_time = ::Process.clock_gettime ::Process::CLOCK_MONOTONIC
+      env[DIAL_REQUEST_TIMING] = ((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
+      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
+      end.sub "</body>", <<~HTML
+          #{Panel.html env, ruby_vm_stat_diff, gc_stat_diff, gc_stat_heap_diff, server_timing}
+        </body>
+      HTML
+
+      headers[::Rack::CONTENT_LENGTH] = body.bytesize.to_s
+
+      [status, headers, [body]]
+    end
+  end
+end

data/lib/dial/panel.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require_relative "constants"
+
+module Dial
+  class Panel
+    class << self
+      include Constants
+
+      def html env, 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_version}</span>
+              <span>#{formatted_rack_version}</span>
+              <span>#{formatted_ruby_version}</span>
+            </div>
+
+            <div id="dial-details">
+              <hr>
+
+              <details>
+                <summary>RubyVM stat</summary>
+                <div class="section">
+                  #{formatted_ruby_vm_stat(ruby_vm_stat)}
+                </div>
+              </details>
+
+              <details>
+                <summary>GC stat</summary>
+                <div class="section">
+                  #{formatted_gc_stat(gc_stat)}
+                </div>
+              </details>
+
+              <details>
+                <summary>GC stat heap</summary>
+                <div class="section">
+                  #{formatted_gc_stat_heap(gc_stat_heap)}
+                </div>
+              </details>
+
+              <details>
+                <summary>Server timing</summary>
+                <div class="section">
+                  #{formatted_server_timing(server_timing)}
+                </div>
+              </details>
+            </div>
+          </div>
+
+          <script>#{script}</script>
+        HTML
+      end
+
+      private
+
+      def style
+        <<~CSS
+          #dial {
+            z-index: 9999;
+            position: fixed;
+            bottom: 0;
+            right: 0;
+            background-color: white;
+            border-top-left-radius: 1rem;
+            box-shadow: -0.2rem -0.2rem 0.4rem rgba(0, 0, 0, 0.5);
+            display: flex;
+            flex-direction: column;
+            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;
+          }
+        CSS
+      end
+
+      def script
+        <<~JS
+          const dialPreview = document.getElementById("dial-preview");
+          const dialDetails = document.getElementById("dial-details");
+          dialPreview.addEventListener("click", () => {
+            const collapsed = ["", "none"].includes(dialDetails.style.display);
+            dialDetails.style.display = collapsed ? "block" : "none";
+          });
+        JS
+      end
+
+      def formatted_rails_route_info env
+        rails_route_info = begin
+          ::Rails.application.routes.recognize_path env[::Rack::PATH_INFO], method: env[::Rack::REQUEST_METHOD]
+        rescue ::ActionController::RoutingError
+          {}
+        end.then do |info|
+          "<b>Controller:</b> #{info[:controller] || "NA"} | <b>Action:</b> #{info[:action] || "NA"}"
+        end
+      end
+
+      def formatted_request_timing env
+        "<b>Request timing:</b> #{env[DIAL_REQUEST_TIMING]}ms"
+      end
+
+      def formatted_rails_version
+        "<b>Rails version:</b> #{::Rails::VERSION::STRING}"
+      end
+
+      def formatted_rack_version
+        "<b>Rack version:</b> #{::Rack.release}"
+      end
+
+      def formatted_ruby_version
+        "<b>Ruby version:</b> #{RUBY_DESCRIPTION}"
+      end
+
+      def formatted_ruby_vm_stat ruby_vm_stat
+        ruby_vm_stat.map { |key, value| "<span><b>#{key}:</b> #{value}</span>" }.join
+      end
+
+      def formatted_gc_stat gc_stat
+        gc_stat.map { |key, value| "<span><b>#{key}:</b> #{value}</span>" }.join
+      end
+
+      def formatted_gc_stat_heap gc_stat_heap
+        gc_stat_heap.map do |slot, stats|
+          <<~HTML
+            <div class="section">
+              <span><u>Heap slot #{slot}</u></span>
+              <div class="section">
+                #{gc_stat_heap[slot].map { |key, value| "<span><b>#{key}:</b> #{value}</span>" }.join}
+              </div>
+            </div>
+          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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dial
+  module RailsStat
+    private
+
+    def server_timing headers
+      timing = if (ActionDispatch.const_defined? :Constants)  && (ActionDispatch::Constants.const_defined? :SERVER_TIMING)
+        headers[ActionDispatch::Constants::SERVER_TIMING]
+      else
+        headers["Server-Timing"]
+      end
+      (timing || "").split(", ").to_h do |pair|
+        event, duration = pair.split ";dur="
+        [event, duration.to_f]
+      end
+    end
+  end
+end

data/lib/dial/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails"
+
+require_relative "middleware"
+
+module Dial
+  class Railtie < ::Rails::Railtie
+    initializer "dial.use_middleware" do |app|
+      app.middleware.insert_before 0, Middleware
+    end
+  end
+end

data/lib/dial/ruby_stat.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Dial
+  module RubyStat
+    private
+
+    def ruby_vm_stat_diff before, after
+      stat_diff before, after, except: [:next_shape_id]
+    end
+
+    def gc_stat_diff before, after
+      stat_diff before, after, except: [
+        :heap_allocatable_slots,
+        :malloc_increase_bytes_limit,
+        :remembered_wb_unprotected_objects_limit,
+        :old_objects_limit,
+        :oldmalloc_increase_bytes_limit
+      ]
+    end
+
+    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]
+      end
+    end
+
+    def stat_diff before, after, except: []
+      after.except(*except).each_with_object({}) do |(key, value), diff|
+        diff[key] = value - before[key]
+      end
+    end
+  end
+end

data/lib/dial/version.rb

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

data/lib/dial.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "dial/version"
+require_relative "dial/railtie"

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: dial
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Young
+bindir: bin
+cert_chain: []
+date: 2024-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+email:
+- djry1999@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- dial.gemspec
+- lib/dial.rb
+- lib/dial/constants.rb
+- lib/dial/middleware.rb
+- lib/dial/panel.rb
+- lib/dial/rails_stat.rb
+- lib/dial/railtie.rb
+- lib/dial/ruby_stat.rb
+- lib/dial/version.rb
+homepage: https://github.com/joshuay03/dial
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/joshuay03/dial
+  changelog_uri: https://github.com/joshuay03/dial/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+specification_version: 4
+summary: A modern Rails profiler
+test_files: []