test-prof 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 119118a5840991b0d1bde28e49aca9f3f72f77f89ba57704c53ce2e8a023ad06
-  data.tar.gz: 6f124770cfeba6346f744dbf66a00b118c6c207711af9f18977abea153de4f7a
+  metadata.gz: b843db2a99bf53e8c380e748bb73340c573e1de8082f76519530eb0ddf32cb95
+  data.tar.gz: 94048d78eaf4857b0a869fad4d551701b0501074cb97ff9ac9ad13a5b69eee03
 SHA512:
-  metadata.gz: 6827f8b914ce78da9cabff0dd04ef643c3571e22864a1c6c215028fd4a2e9f79dbbab0d69e7ac9184753460aee96a2202a9201f7bdf2177074b42de47e893ac4
-  data.tar.gz: 4beacf5a982c0fe64c1c363660f2985be9dd6470ac847eb10e5ef4cd3ddf3360681e8c09fb511d5a99418629b455755e93824768c21520d0c754a908a7e7080c
+  metadata.gz: 5718228b4b63106230f730ef7ee2e1ed53de8457c266f82859a2824b7f9967ba30d0d26d2ee9e4fb1f6363e04eb6a790560e98d529d7e630d93f7dd9dd2dc990
+  data.tar.gz: b6df0f87115a3cfd159b1a132459a7958c204374e9b76a8f0c7282158fe6fe6a11a208a5e60f111d98f89c212d215c8cf6db1087c071257a92a7377f999cae0c

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## master (unreleased)
 
+## 1.6.0 (2026-03-18)
+
+- Add TPS profiler. ([@palkan][])
+
+- Add GC profiling to MemoryProf. ([@palkan][])
+
+- Upgrade to Sidekiq 8. ([@palkan][])
+
+- RSpecStamp now uses Prism if available. ([@kddnewton][])
+
+- Upgrade RSpecDissect to show total setup time and let breakdowns. ([@palkan][])
+
+## 1.5.2 (2026-02-03)
+
+- Avoid using `Gem.loaded_specs` methods in RuboCop plugin version check. ([@Rylan12][])
+
+## 1.5.1 (2026-01-27)
+
+- Fix RuboCop plugin. ([@palkan][])
+
+Now you should use `--plugin test-prof` or `plugins: [test-prof]` (in YAML) (so LintRoller can correctly obtain the plugin class name from the gemspec).
+
 ## 1.5.0 (2025-12-04)
 
 - Logging: support Rails 8.2 structured events based logging. ([@palkan][])
@@ -478,3 +500,5 @@ See [changelog](https://github.com/test-prof/test-prof/blob/v0.8.0/CHANGELOG.md)
 [@john-h-k]: https://github.com/john-h-k
 [@devinburnette]: https://github.com/devinburnette
 [@elasticspoon]: https://github.com/elasticspoon
+[@Rylan12]: https://github.com/Rylan12
+[@kddnewton]: https://github.com/kddnewton

data/lib/{test_prof → rubocop/test_prof}/cops/rspec/aggregate_examples/matchers_with_side_effects.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "test_prof/cops/rspec/language"
+require_relative "../language"
 
 module RuboCop
   module Cop

data/lib/{test_prof → rubocop/test_prof}/cops/rspec/aggregate_examples/node_matchers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "test_prof/cops/rspec/language"
+require_relative "../language"
 
 module RuboCop
   module Cop

data/lib/{test_prof → rubocop/test_prof}/cops/rspec/aggregate_examples.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "test_prof/cops/rspec/aggregate_examples/line_range_helpers"
-require "test_prof/cops/rspec/aggregate_examples/metadata_helpers"
-require "test_prof/cops/rspec/aggregate_examples/node_matchers"
+require_relative "aggregate_examples/line_range_helpers"
+require_relative "aggregate_examples/metadata_helpers"
+require_relative "aggregate_examples/node_matchers"
 
-require "test_prof/cops/rspec/aggregate_examples/its"
-require "test_prof/cops/rspec/aggregate_examples/matchers_with_side_effects"
+require_relative "aggregate_examples/its"
+require_relative "aggregate_examples/matchers_with_side_effects"
 
 module RuboCop
   module Cop

data/lib/{test_prof/cops → rubocop/test_prof}/plugin.rb

@@ -8,8 +8,8 @@ module RuboCop
     class Plugin < LintRoller::Plugin
       def about
         LintRoller::About.new(
-          name: "test_prof",
-          version: VERSION,
+          name: "test-prof",
+          version: ::TestProf::VERSION,
           homepage: "https://test-prof.evilmartians.io/misc/rubocop",
           description: "RuboCop plugin to help you write more performant tests."
         )

data/lib/rubocop/test_prof.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+if Gem::Version.new(RuboCop::Version::STRING) < Gem::Version.new("0.51.0")
+  warn "TestProf cops require RuboCop >= 0.51.0 to run."
+  return
+end
+
+require "rubocop/test_prof/plugin"
+require "rubocop/test_prof/cops/rspec/aggregate_examples"

data/lib/test-prof.rb

@@ -1,3 +1,8 @@
 # frozen_string_literal: true
 
 require "test_prof"
+
+# For RuboCop plugin
+module RuboCop
+  autoload :TestProf, "rubocop/test_prof"
+end

data/lib/test_prof/event_prof/custom_events/sidekiq_inline.rb

@@ -2,7 +2,7 @@
 
 TestProf::EventProf::CustomEvents.register("sidekiq.inline") do
   if TestProf.require(
-    "sidekiq/testing",
+    "sidekiq",
     <<~MSG
       Failed to load Sidekiq.
 

data/lib/test_prof/event_prof/custom_events/sidekiq_jobs.rb

@@ -2,7 +2,7 @@
 
 TestProf::EventProf::CustomEvents.register("sidekiq.jobs") do
   if TestProf.require(
-    "sidekiq/testing",
+    "sidekiq",
     <<~MSG
       Failed to load Sidekiq.
 

data/lib/test_prof/memory_prof/printer.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof/ext/float_duration"
 require "test_prof/memory_prof/printer/number_to_human"
 require "test_prof/ext/string_truncate"
 
@@ -92,5 +93,35 @@ module TestProf
         number_to_human(item[:memory])
       end
     end
+
+    class GCPrinter < Printer
+      using StringTruncate
+      using FloatDuration
+
+      private
+
+      def mode
+        "GC time"
+      end
+
+      def print_total
+        "Total GC time: #{(GC.total_time.to_f / 1_000_000_000).duration}\n\n"
+      end
+
+      def print_items(items)
+        messages =
+          items.map do |item|
+            <<~ITEM
+              #{item[:name].truncate(30)} (#{item[:location]}) – #{gc_time(item)}
+            ITEM
+          end
+
+        messages.join
+      end
+
+      def gc_time(item)
+        (item[:memory].to_f / 1_000_000_000).duration
+      end
+    end
   end
 end

data/lib/test_prof/memory_prof/rspec.rb

@@ -31,10 +31,12 @@ module TestProf
       end
 
       def example_group_started(notification)
+        return unless notification.group.top_level?
         tracker.group_started(notification.group, group(notification))
       end
 
       def example_group_finished(notification)
+        return unless notification.group.top_level?
         tracker.group_finished(notification.group)
       end
 

data/lib/test_prof/memory_prof/tracker.rb

@@ -55,7 +55,7 @@ module TestProf
         node = list.remove_node(id, track)
         return unless node
 
-        groups << {**node.item, memory: node.hooks_memory}
+        groups << {**node.item, memory: node.total_memory}
       end
     end
 
@@ -84,5 +84,15 @@ module TestProf
         !!@rss_tool
       end
     end
+
+    class GCTracker < Tracker
+      def track
+        ::GC.total_time
+      end
+
+      def supported?
+        ::GC.respond_to?(:total_time)
+      end
+    end
   end
 end

data/lib/test_prof/memory_prof.rb

@@ -11,6 +11,7 @@ module TestProf
   #
   #   TEST_MEM_PROF='rss' rspec ...
   #   TEST_MEM_PROF='alloc' rspec ...
+  #   TEST_MEM_PROF='gc' rspec ...
   #
   # By default MemoryProf shows the top 5 examples and groups (for RSpec) but you can
   # set how many items to display with `TEST_MEM_PROF_COUNT`:
@@ -25,6 +26,8 @@ module TestProf
   module MemoryProf
     # MemoryProf configuration
     class Configuration
+      MODES = %w[alloc rss gc].freeze
+
       attr_reader :mode, :top_count
 
       def initialize
@@ -33,7 +36,7 @@ module TestProf
       end
 
       def mode=(value)
-        @mode = (value == "alloc") ? :alloc : :rss
+        @mode = MODES.include?(value) ? value.to_sym : :rss
       end
 
       def top_count=(value)
@@ -45,12 +48,14 @@ module TestProf
     class << self
       TRACKERS = {
         alloc: AllocTracker,
-        rss: RssTracker
+        rss: RssTracker,
+        gc: GCTracker
       }.freeze
 
       PRINTERS = {
         alloc: AllocPrinter,
-        rss: RssPrinter
+        rss: RssPrinter,
+        gc: GCPrinter
       }.freeze
 
       def config

data/lib/test_prof/recipes/rspec/let_it_be.rb

@@ -142,7 +142,7 @@ module TestProf
     end
 
     private def report_duplicates(identifier)
-      if instance_methods.include?(identifier) && File.basename(__FILE__) == File.basename(instance_method(identifier).source_location[0])
+      if method_defined?(identifier) && File.basename(__FILE__) == File.basename(instance_method(identifier).source_location[0])
         error_msg = "let_it_be(:#{identifier}) was redefined in nested group"
         report_level = LetItBe.config.report_duplicates.to_sym
 

data/lib/test_prof/rspec_dissect/collector.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "test_prof/utils/sized_ordered_set"
+require "test_prof/ext/float_duration"
+require "test_prof/ext/string_truncate"
+
+module TestProf # :nodoc: all
+  using FloatDuration
+  using StringTruncate
+
+  module RSpecDissect
+    class Collector
+      attr_reader :results, :name, :top_count
+
+      def initialize(top_count:)
+        @top_count = top_count
+        @results = Utils::SizedOrderedSet.new(
+          top_count, sort_by: :total_setup
+        )
+      end
+
+      def <<(data)
+        results << data
+      end
+
+      def print_result_header
+        <<~MSG
+
+          Top #{top_count} slowest suites by setup time:
+
+        MSG
+      end
+
+      def print_group_result(group)
+        "#{group[:desc].truncate} (#{group[:loc]}) – \e[1m#{group[:total_setup].duration}\e[22m " \
+        "of #{group[:total].duration} / #{group[:count]} " \
+        "(before: #{(group[:total_setup] - group[:total_lazy_let]).duration}, " \
+        "before let: #{group[:total_before_let].duration}, " \
+        "lazy let: #{group[:total_lazy_let].duration})"
+      end
+
+      def print_results
+        msgs = [print_result_header]
+
+        results.each do |group|
+          msgs << print_group_result(group)
+          msgs << "\n" if group[:top_lets].any?
+          group[:top_lets].each do |let|
+            msgs << " ↳ #{let[:name]} – #{let[:duration].duration} (#{let[:size]})\n"
+          end
+          msgs << "\n"
+        end
+
+        msgs.join
+      end
+    end
+  end
+end

data/lib/test_prof/rspec_dissect/rspec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "test_prof/rspec_dissect/collector"
+
 require "test_prof/ext/float_duration"
 
 module TestProf
@@ -15,19 +17,12 @@ module TestProf
       ].freeze
 
       def initialize
-        @collectors = []
-
-        if RSpecDissect.config.let?
-          collectors << Collectors::Let.new(top_count: RSpecDissect.config.top_count)
-        end
-
-        if RSpecDissect.config.before?
-          collectors << Collectors::Before.new(top_count: RSpecDissect.config.top_count)
-        end
+        @collector = Collector.new(top_count: top_count)
 
         @examples_count = 0
         @examples_time = 0.0
         @total_examples_time = 0.0
+        @total_setup_time = 0.0
       end
 
       def example_finished(notification)
@@ -44,9 +39,11 @@ module TestProf
         data[:desc] = notification.group.top_level_description
         data[:loc] = notification.group.metadata[:location]
 
-        collectors.each { |c| c.populate!(data) }
-        collectors.each { |c| c << data }
+        RSpecDissect.populate_from_spans!(data)
 
+        collector << data
+
+        @total_setup_time += data[:total_setup]
         @total_examples_time += @examples_time
         @examples_count = 0
         @examples_time = 0.0
@@ -62,17 +59,12 @@ module TestProf
             RSpecDissect report
 
             Total time: #{@total_examples_time.duration}
+            Total setup time: #{@total_setup_time.duration}
           MSG
 
-        collectors.each do |c|
-          msgs << c.total_time_message
-        end
-
         msgs << "\n"
 
-        collectors.each do |c|
-          msgs << c.print_results
-        end
+        msgs << collector.print_results
 
         log :info, msgs.join
 
@@ -84,9 +76,9 @@ module TestProf
 
         examples = Hash.new { |h, k| h[k] = [] }
 
-        all_results = collectors.inject([]) { |acc, c| acc + c.results.to_a }
+        results = collector.results.to_a
 
-        all_results
+        results
           .map { |obj| obj[:loc] }.each do |location|
           file, line = location.split(":")
           examples[file] << line.to_i
@@ -114,7 +106,7 @@ module TestProf
 
       private
 
-      attr_reader :collectors
+      attr_reader :collector
 
       def top_count
         RSpecDissect.config.top_count

data/lib/test_prof/rspec_dissect.rb

@@ -7,6 +7,9 @@ module TestProf
   # RSpecDissect tracks how much time do you spend in `before` hooks
   # and memoization helpers (i.e. `let`) in your tests.
   module RSpecDissect
+    class Span < Struct.new(:id, :parent_id, :type, :duration, :meta)
+    end
+
     module ExampleInstrumentation # :nodoc:
       def run_before_example(*)
         RSpecDissect.track(:before) { super }
@@ -15,12 +18,15 @@ module TestProf
 
     module MemoizedInstrumentation # :nodoc:
       def fetch_or_store(id, *)
+        return super if id == :subject
+        return @memoized[id] if @memoized[id]
+
         res = nil
         Thread.current[:_rspec_dissect_let_depth] ||= 0
         Thread.current[:_rspec_dissect_let_depth] += 1
         begin
           res = if Thread.current[:_rspec_dissect_let_depth] == 1
-            RSpecDissect.track(:let, id) { super }
+            RSpecDissect.track(:let, name: id) { super }
           else
             super
           end
@@ -33,45 +39,25 @@ module TestProf
 
     # RSpecDisect configuration
     class Configuration
-      MODES = %w[all let before].freeze
-
       attr_accessor :top_count, :let_stats_enabled,
         :let_top_count
 
       alias_method :let_stats_enabled?, :let_stats_enabled
 
-      attr_reader :mode
-
       def initialize
         @let_stats_enabled = true
         @let_top_count = (ENV["RD_PROF_LET_TOP"] || 3).to_i
         @top_count = (ENV["RD_PROF_TOP"] || 5).to_i
         @stamp = ENV["RD_PROF_STAMP"]
-        @mode = (ENV["RD_PROF"] == "1") ? "all" : ENV["RD_PROF"]
-
-        unless MODES.include?(mode)
-          raise "Unknown RSpecDissect mode: #{mode};" \
-                "available modes: #{MODES.join(", ")}"
-        end
 
         RSpecStamp.config.tags = @stamp if stamp?
       end
 
-      def let?
-        mode == "all" || mode == "let"
-      end
-
-      def before?
-        mode == "all" || mode == "before"
-      end
-
       def stamp?
         !@stamp.nil?
       end
     end
 
-    METRICS = %w[before let].freeze
-
     class << self
       include Logging
 
@@ -89,56 +75,64 @@ module TestProf
         RSpec::Core::MemoizedHelpers::ThreadsafeMemoized.prepend(MemoizedInstrumentation)
         RSpec::Core::MemoizedHelpers::NonThreadSafeMemoized.prepend(MemoizedInstrumentation)
 
-        @data = {}
-
-        METRICS.each do |type|
-          @data["total_#{type}"] = 0.0
-        end
-
         reset!
 
         log :info, "RSpecDissect enabled"
       end
 
-      def track(type, meta = nil)
-        start = TestProf.now
-        res = yield
-        delta = (TestProf.now - start)
-        type = type.to_s
-        @data[type][:time] += delta
-        @data[type][:meta] << meta unless meta.nil?
-        @data["total_#{type}"] += delta
-        res
+      def nextid
+        @last_id += 1
+        @last_id.to_s
       end
 
-      def reset!
-        METRICS.each do |type|
-          @data[type.to_s] = {time: 0.0, meta: []}
-        end
+      def current_span
+        Thread.current[:_rspec_dissect_spans_stack].last
       end
 
-      # Whether we are able to track `let` usage
-      def memoization_available?
-        defined?(::RSpec::Core::MemoizedHelpers::ThreadsafeMemoized)
+      def span_stack
+        Thread.current[:_rspec_dissect_spans_stack]
       end
 
-      def time_for(key)
-        @data[key.to_s][:time]
+      def track(type, id: nextid, **meta)
+        span = Span.new(id, current_span&.id, type, 0.0, meta)
+        span_stack << span
+
+        begin
+          start = TestProf.now
+          res = yield
+          delta = (TestProf.now - start)
+          span.duration = delta
+          @spans << span
+          res
+        ensure
+          span_stack.pop
+        end
       end
 
-      def meta_for(key)
-        @data[key.to_s][:meta]
+      def populate_from_spans!(data)
+        data[:total_setup] = @spans.select { !_1.parent_id }.sum(&:duration)
+        data[:total_before_let] = @spans.select { _1.type == :let && _1.parent_id }.sum(&:duration).to_f
+        data[:total_lazy_let] = @spans.select { _1.type == :let && !_1.parent_id }.sum(&:duration).to_f
+
+        data[:top_lets] = @spans.select { _1.type == :let }
+          .group_by { _1.meta[:name] }
+          .transform_values! do |spans|
+            {name: spans.first.meta[:name], duration: spans.sum(&:duration), size: spans.size}
+          end
+          .values
+          .sort_by { -_1[:duration] }
+          .take(RSpecDissect.config.let_top_count)
       end
 
-      def total_time_for(key)
-        @data["total_#{key}"]
+      def reset!
+        @last_id = 1
+        @spans = []
+        Thread.current[:_rspec_dissect_spans_stack] = []
       end
     end
   end
 end
 
-require "test_prof/rspec_dissect/collectors/let"
-require "test_prof/rspec_dissect/collectors/before"
 require "test_prof/rspec_dissect/rspec"
 
 TestProf.activate("RD_PROF") do

data/lib/test_prof/rspec_stamp/parser/prism.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "prism"
+
+module TestProf
+  module RSpecStamp
+    module Parser
+      class Prism
+        def parse(code)
+          result = ::Prism.parse(code)
+          return unless result.success?
+
+          node = result.value.statements.body.first
+          return unless node.is_a?(::Prism::CallNode)
+
+          res = Result.new
+          res.fname =
+            if node.receiver
+              "#{node.receiver.full_name}.#{node.name}"
+            else
+              node.name.name
+            end
+
+          args = node.arguments&.arguments
+          return res if args.nil?
+
+          rest =
+            case (first = args.first).type
+            when :string_node
+              res.desc = first.content
+              args[1..]
+            when :constant_read_node, :constant_path_node
+              res.desc_const = first.full_name
+              args[1..]
+            else
+              args
+            end
+
+          rest.each do |arg|
+            case arg.type
+            when :symbol_node
+              res.add_tag(arg.value.to_sym)
+            when :keyword_hash_node
+              arg.elements.each do |assoc|
+                res.add_htag(
+                  assoc.key.value.to_sym,
+                  parse_htag_value(assoc.value)
+                )
+              end
+            end
+          end
+
+          res
+        end
+
+        private
+
+        def parse_htag_value(node)
+          case node.type
+          when :true_node
+            true
+          when :false_node
+            false
+          when :integer_node, :float_node
+            node.value
+          when :string_node
+            node.unescaped
+          when :symbol_node
+            node.value.to_sym
+          end
+        end
+      end
+    end
+  end
+end