rspec_telemetry 0.3.0

data/lib/rspec_telemetry/trace/viewer/timeline_pane.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "theme"
+require_relative "label"
+require_relative "format"
+
+module RSpecTelemetry
+  module Trace
+    module Viewer
+      class TimelinePane
+        EXPANDED = "- "
+        COLLAPSED = "+ "
+        NO_CHILDREN = "  "
+        EVENT_INDENT = "    "
+
+        def initialize(entries, list:, focus:, collapsed: nil, childful: nil, durations: nil)
+          @entries = entries
+          @list = list
+          @focus = focus
+          @collapsed = collapsed || []
+          @childful = childful || []
+          @durations = durations || {}
+        end
+
+        def draw(canvas, rect)
+          highlight = @focus ? Theme::SELECT : Theme::SELECT_BLUR
+          TuiTui::List.new(@list).draw(canvas, rect, highlight: highlight, scrollbar: Theme.base) do |index, selected|
+            entry = @entries[index]
+            text = prefix(entry) + Label.plain(entry) + duration_suffix(entry)
+            style = selected ? highlight : Theme.style(Label.category(entry))
+            TuiTui::Line[TuiTui::Span[text, style]]
+          end
+        end
+
+        private
+
+        def prefix(entry)
+          return EVENT_INDENT unless entry.is_a?(Document::Action)
+          return NO_CHILDREN unless @childful.include?(entry.seq)
+
+          @collapsed.include?(entry.seq) ? COLLAPSED : EXPANDED
+        end
+
+        def duration_suffix(entry)
+          return "" unless entry.is_a?(Document::Action)
+
+          formatted = Format.ms(@durations[entry.seq])
+          formatted ? "  (#{formatted})" : ""
+        end
+      end
+    end
+  end
+end

data/lib/rspec_telemetry/trace/viewer/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSpecTelemetry
+  module Trace
+    module Viewer
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/rspec_telemetry/trace/viewer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "viewer/version"
+require_relative "viewer/document"
+require_relative "viewer/format"
+require_relative "viewer/theme"
+require_relative "viewer/label"
+require_relative "viewer/text_report"
+require_relative "viewer/timeline_pane"
+require_relative "viewer/detail_lines"
+require_relative "viewer/detail_pane"
+require_relative "viewer/status_line"
+require_relative "viewer/time_bar"
+require_relative "viewer/source_pane"
+require_relative "viewer/source"
+require_relative "viewer/source_resolver"
+require_relative "viewer/source_view"
+require_relative "viewer/layout"
+require_relative "viewer/report_view"
+require_relative "viewer/report_pane"
+require_relative "viewer/app_renderer"
+require_relative "viewer/screen/timeline_screen"
+require_relative "viewer/screen/ranked_screen"
+require_relative "viewer/app"
+
+module RSpecTelemetry
+  module Trace
+    module Viewer
+    end
+  end
+end

data/lib/rspec_telemetry/version.rb

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

data/lib/rspec_telemetry/writer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "json"
+require "fileutils"
+
+module RSpecTelemetry
+  class Writer
+    def initialize(output_path, flush_each: false)
+      @output_path = output_path
+      @flush_each = flush_each
+      @mutex = Mutex.new
+      @io = nil
+    end
+
+    def open
+      FileUtils.mkdir_p(File.dirname(@output_path))
+      # Each run gets a fresh stream; appending would create misleading time gaps.
+      @io = File.open(@output_path, "w")
+    rescue => e
+      warn_failure("open", e)
+      @io = nil
+    end
+
+    def write(event)
+      return unless @io
+
+      @mutex.synchronize do
+        @io.puts(JSON.generate(event))
+        @io.flush if @flush_each
+      end
+
+    rescue => e
+      warn_failure("write", e)
+    end
+
+    def flush
+      @mutex.synchronize { @io&.flush }
+    rescue => e
+      warn_failure("flush", e)
+    end
+
+    def close
+      @mutex.synchronize do
+        @io&.flush
+        @io&.close
+        @io = nil
+      end
+
+    rescue => e
+      warn_failure("close", e)
+    end
+
+    private
+
+    def warn_failure(action, error)
+      warn("[rspec-telemetry] failed to #{action} event: #{error.class}: #{error.message}")
+    end
+  end
+end

data/lib/rspec_telemetry.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative "rspec_telemetry/version"
+require_relative "rspec_telemetry/config"
+require_relative "rspec_telemetry/writer"
+require_relative "rspec_telemetry/summary"
+require_relative "rspec_telemetry/recorder"
+
+module RSpecTelemetry
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config if block_given?
+      config
+    end
+
+    def recorder
+      @recorder ||= Recorder.new(config)
+    end
+
+    def start!
+      return unless config.enabled
+
+      recorder.start
+      return unless recorder.started?
+
+      subscribe!
+      recorder
+    end
+
+    def finish!
+      @recorder&.finish
+      unsubscribe!
+    end
+
+    def reset!
+      unsubscribe!
+      @config = nil
+      @recorder = nil
+      @warned = nil
+    end
+
+    def safely(context)
+      yield
+    # Telemetry must never break the user's RSpec run, even on non-StandardError failures.
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      warn_once(context, e)
+      nil
+    end
+
+    private
+
+    def warn_once(context, error)
+      @warned ||= {}
+      return if @warned[context]
+
+      @warned[context] = true
+      warn(
+        "[rspec-telemetry] #{context} で例外を無視しました(以後同種は抑制): " \
+          "#{error.class}: #{error.message}"
+      )
+    end
+
+    def subscribe!
+      return unless config.capture_factory_bot
+      return if @factory_bot_subscriber
+
+      subscriber = build_factory_bot_subscriber
+      return unless subscriber
+
+      @factory_bot_subscriber = subscriber
+      @factory_bot_subscriber.subscribe
+    end
+
+    # activesupport is an optional dependency: it is only needed for FactoryBot
+    # tracking, which relies on ActiveSupport::Notifications. FactoryBot itself
+    # pulls in activesupport, so when it is absent there are no factory events to
+    # capture and we silently skip the subscription.
+    def build_factory_bot_subscriber
+      require_relative "rspec_telemetry/subscribers/factory_bot"
+      Subscribers::FactoryBot.new(recorder)
+    rescue LoadError
+      nil
+    end
+
+    def unsubscribe!
+      @factory_bot_subscriber&.unsubscribe
+      @factory_bot_subscriber = nil
+    end
+  end
+end
+
+if defined?(RSpec) && RSpec.respond_to?(:configure) && !ENV.key?("RSPEC_TELEMETRY_NO_AUTOLOAD")
+  require_relative "rspec_telemetry/formatter"
+
+  RSpec.configure do |config|
+    config.add_formatter(RSpecTelemetry::Formatter)
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: rspec_telemetry
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- takahashimm
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tui_tui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Collect RSpec / FactoryBot telemetry as NDJSON to find slow tests.
+email:
+- takahashimm@gmail.com
+executables:
+- rspec-telemetry
+- rspec-telemetry-compare
+- rspec-telemetry-viewer
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- examples/sample.ndjson
+- exe/rspec-telemetry
+- exe/rspec-telemetry-compare
+- exe/rspec-telemetry-viewer
+- lib/rspec_telemetry.rb
+- lib/rspec_telemetry/analyzer.rb
+- lib/rspec_telemetry/cli.rb
+- lib/rspec_telemetry/compare_cli.rb
+- lib/rspec_telemetry/config.rb
+- lib/rspec_telemetry/console_report.rb
+- lib/rspec_telemetry/factory_aggregation.rb
+- lib/rspec_telemetry/factory_comparison.rb
+- lib/rspec_telemetry/formatter.rb
+- lib/rspec_telemetry/ndjson.rb
+- lib/rspec_telemetry/recorder.rb
+- lib/rspec_telemetry/subscribers/factory_bot.rb
+- lib/rspec_telemetry/summary.rb
+- lib/rspec_telemetry/trace/viewer.rb
+- lib/rspec_telemetry/trace/viewer/app.rb
+- lib/rspec_telemetry/trace/viewer/app_renderer.rb
+- lib/rspec_telemetry/trace/viewer/detail_lines.rb
+- lib/rspec_telemetry/trace/viewer/detail_pane.rb
+- lib/rspec_telemetry/trace/viewer/document.rb
+- lib/rspec_telemetry/trace/viewer/follow_controller.rb
+- lib/rspec_telemetry/trace/viewer/format.rb
+- lib/rspec_telemetry/trace/viewer/label.rb
+- lib/rspec_telemetry/trace/viewer/layout.rb
+- lib/rspec_telemetry/trace/viewer/pane_resizer.rb
+- lib/rspec_telemetry/trace/viewer/report_pane.rb
+- lib/rspec_telemetry/trace/viewer/report_view.rb
+- lib/rspec_telemetry/trace/viewer/screen/ranked_screen.rb
+- lib/rspec_telemetry/trace/viewer/screen/timeline_screen.rb
+- lib/rspec_telemetry/trace/viewer/source.rb
+- lib/rspec_telemetry/trace/viewer/source_pane.rb
+- lib/rspec_telemetry/trace/viewer/source_resolver.rb
+- lib/rspec_telemetry/trace/viewer/source_view.rb
+- lib/rspec_telemetry/trace/viewer/status_line.rb
+- lib/rspec_telemetry/trace/viewer/text_report.rb
+- lib/rspec_telemetry/trace/viewer/theme.rb
+- lib/rspec_telemetry/trace/viewer/time_bar.rb
+- lib/rspec_telemetry/trace/viewer/timeline_pane.rb
+- lib/rspec_telemetry/trace/viewer/version.rb
+- lib/rspec_telemetry/version.rb
+- lib/rspec_telemetry/writer.rb
+homepage: https://github.com/takahashim/rspec_telemetry
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/takahashim/rspec_telemetry
+  source_code_uri: https://github.com/takahashim/rspec_telemetry
+  changelog_uri: https://github.com/takahashim/rspec_telemetry
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Collect RSpec / FactoryBot telemetry as NDJSON to find slow tests.
+test_files: []