require-profiler 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 787aa181e1f018e66c9f8163837af8980a0549a23102361206451ca4c640675e
-  data.tar.gz: a7a0a01e40938642a7bd2b505ae18e47e42b3f00fa482c63151c5616d8f746d6
+  metadata.gz: 8e11b353825774069b1dea2916f61688970a61ea00e59c54ccd68d39e311f452
+  data.tar.gz: 1580e8719935ec0d70d98f48fdad60207e777a475a86640e9d1cdac390993329
 SHA512:
-  metadata.gz: f99d748f75f3333f90979bfde8082591bb77e6b56590df2424dc566ff556798a50660d2c125d4b261c37235b0cdc95ff7cf228f146bd1e8f27d88af5498d90a3
-  data.tar.gz: b0b8aa77547e9852c91f699944877450aa03d125f4324b2efc5ea59854c293680215ee8bf272eda892a7c90c33ee5422bdecbeb3c6cf4530e2389a0aa1da8e05
+  metadata.gz: ce85f247ab89347bbd51a609e10254bd1aaf485ae892476a3e67fb722f5037d68b76a153560e8172ea2c9b605aafc005f7accb35a11e77913eba9b7d80616974
+  data.tar.gz: c0897c79cb3cf3bca1c612d9794ebd00f8ff3d295d98b2faf664190f4bc6d0ba235e01b11a06e3edb7f79197db848d2923b15ae34850cdb9b2febf0349219877

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 0.2.1 (2026-05-26)
+
+- Add YAML tracking. ([@palkan][])
+
+- Add HTTP tracking via Sniffer. ([@palkan][])
+
 ## 0.2.0 (2026-05-25) 🔔
 
 - Add ability to run Stackprof for a particular file loading. ([@palkan][])

data/README.md

@@ -108,6 +108,10 @@ Now you can use Speedscope to dig deeper.
 
 **NOTE:** The `stackprof` gem must be present in your Gemfile for that.
 
+### YAML and HTTP support
+
+Require Profiler also captures HTTP requests and YAML file loading and add them to the profile, so you can find which Ruby files trigger the corresponding actions on load. NOTE: For HTTP requests tracking, you MUST add [sniffer][] gem to your Gemfile.
+
 ### Configuration
 
 `RequireProfiler.start` accepts the following keyword arguments:
@@ -189,3 +193,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 [speedscope]: https://www.speedscope.app/
 [require-hooks]: https://github.com/ruby-next/require-hooks
+[sniffer]: https://github.com/aderyabin/sniffer

data/lib/require_profiler/plugins/http_plugin.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RequireProfiler
+  module Plugins
+    # Track HTTP calls using Sniffer and add the to the require profile
+    class HTTPPlugin < Base
+      def activate!
+        begin
+          require "sniffer"
+        rescue LoadError
+          return
+        end
+
+        Sniffer.config.logger = Logger.new(IO::NULL)
+
+        Sniffer.config.middleware do |chain|
+          chain.add HTTPPlugin, reporter
+        end
+
+        Sniffer::DataItem::Request.include(Module.new do
+          def require_path
+            @url ||= "#{method.to_s.upcase}:#{(port == 443) ? "https" : "http"}://#{host}#{query}"
+          end
+        end)
+
+        Sniffer.enable!
+      end
+
+      # Sniffer hook interface
+      def request(data_item)
+        reporter.handle_event(Reporter::Event.new(type: :start, kind: :http, path: data_item.request.require_path))
+        yield
+      end
+
+      def response(data_item)
+        yield
+        time = data_item.response.timing
+        reporter.handle_event(Reporter::Event.new(type: :end, path: data_item.request.require_path, time:))
+      end
+    end
+  end
+end

data/lib/require_profiler/plugins/yaml_plugin.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RequireProfiler
+  module Plugins
+    # Track loading YAML files
+    class YAMLPlugin < Base
+      module Patch
+        def load_file(path, ...)
+          YAMLPlugin.track(path) { super }
+        end
+
+        def unsafe_load_file(path, ...)
+          YAMLPlugin.track(path) { super }
+        end
+
+        def safe_load_file(path, ...)
+          YAMLPlugin.track(path) { super }
+        end
+      end
+
+      class << self
+        attr_accessor :reporter
+
+        def track(path)
+          reporter.handle_event(Reporter::Event.new(type: :start, kind: :yml, path:))
+          start = Time.now
+          yield
+        ensure
+          time = Time.now - start
+          reporter.handle_event(Reporter::Event.new(type: :end, path:, time:))
+        end
+      end
+
+      def activate!
+        require "yaml"
+
+        YAMLPlugin.reporter = reporter
+        ::YAML.singleton_class.prepend(Patch)
+      end
+    end
+  end
+end

data/lib/require_profiler/plugins.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RequireProfiler
+  module Plugins
+    class << self
+      def register_reporter(reporter)
+        HTTPPlugin.new(reporter).activate! unless ENV["REQUIRE_PROFILER_HTTP"] == "false"
+        YAMLPlugin.new(reporter).activate! unless ENV["REQUIRE_PROFILER_YAML"] == "false"
+      end
+    end
+
+    class Base
+      attr_reader :reporter
+
+      def initialize(reporter)
+        @reporter = reporter
+      end
+    end
+
+    autoload :HTTPPlugin, "require_profiler/plugins/http_plugin"
+    autoload :YAMLPlugin, "require_profiler/plugins/yaml_plugin"
+  end
+end

data/lib/require_profiler/printer/call_stack.rb

@@ -8,7 +8,7 @@ module RequireProfiler
         return unless flush?(node)
 
         path = node.path.sub(prefix_stripper, "")
-        self_parts = path.split("/")
+        self_parts = (node.kind == :path) ? path.split("/") : [path]
 
         parts += self_parts.size.times.map { self_parts.take(_1 + 1).join("/") }
         # We only show self-time, so exclude children

data/lib/require_profiler/reporter.rb

@@ -2,14 +2,15 @@
 
 module RequireProfiler
   class Reporter
-    class Event < Struct.new(:type, :path, :time, keyword_init: true)
+    class Event < Struct.new(:type, :path, :time, :kind, keyword_init: true)
     end
 
-    class Node < Struct.new(:path, :time, :parent, :children, :focused, keyword_init: true)
+    class Node < Struct.new(:path, :time, :parent, :children, :kind, :focused, keyword_init: true)
       def initialize(...)
         super
         self.children ||= []
         self.focused = false
+        self.kind ||= :path
       end
 
       def focused!
@@ -37,7 +38,7 @@ module RequireProfiler
 
     def handle_event_sync(event)
       if event.type == :start
-        node = Node.new(path: event.path, children: [])
+        node = Node.new(path: event.path, children: [], kind: event.kind)
         parent = stack.last
 
         if parent

data/lib/require_profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RequireProfiler # :nodoc:
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/require_profiler.rb

@@ -3,6 +3,7 @@
 module RequireProfiler
   autoload :Reporter, "require_profiler/reporter"
   autoload :Printer, "require_profiler/printer"
+  autoload :Plugins, "require_profiler/plugins"
 
   # Autoload doesn't work here, because we call it from the hooks for the first time
   require "require_profiler/ruby_profiling"
@@ -38,6 +39,8 @@ module RequireProfiler
         time = Time.now - start
         reporter.handle_event(Reporter::Event.new(type: :end, path:, time:))
       end
+
+      Plugins.register_reporter(reporter) unless ENV["REQUIRE_PROFILER_PLUGINS"] == "false"
     end
 
     def stop

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: require-profiler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Vladimir Dementyev
@@ -37,6 +37,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +93,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: sniffer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.26'
 description: 'Profile Ruby #require/#load/etc calls'
 email:
 - Vladimir Dementyev
@@ -78,6 +134,9 @@ files:
 - lib/equire-prof.rb
 - lib/require-profiler.rb
 - lib/require_profiler.rb
+- lib/require_profiler/plugins.rb
+- lib/require_profiler/plugins/http_plugin.rb
+- lib/require_profiler/plugins/yaml_plugin.rb
 - lib/require_profiler/printer.rb
 - lib/require_profiler/printer/call_stack.rb
 - lib/require_profiler/printer/json.rb