rspec-mergify 0.1.3 → 0.2.0

data/README.md

@@ -41,7 +41,7 @@ For detailed documentation, see the [official guide](https://docs.mergify.com/ci
 
 ### Prerequisites
 
-- Ruby >= 3.1 (`.ruby-version` pins to 3.4.4 — use [rbenv](https://github.com/rbenv/rbenv) or [mise](https://mise.jdx.dev/) to install it)
+- Ruby >= 3.1 (`.ruby-version` pins to 4.0.6 — use [rbenv](https://github.com/rbenv/rbenv) or [mise](https://mise.jdx.dev/) to install it)
 - Bundler
 
 ### Setup
@@ -65,4 +65,4 @@ bundle exec rubocop
 
 ## License
 
-GPL-3.0-only
+Apache-2.0 — see the [LICENSE](../../LICENSE) at the repository root.

data/lib/mergify/rspec/ci_insights.rb

@@ -3,30 +3,25 @@
 require 'securerandom'
 require 'opentelemetry-sdk'
 require_relative 'utils'
+require_relative 'native'
 require_relative 'synchronous_batch_span_processor'
-require_relative 'resources/ci'
-require_relative 'resources/git'
-require_relative 'resources/github_actions'
-require_relative 'resources/jenkins'
-require_relative 'resources/buildkite'
-require_relative 'resources/mergify'
 require_relative 'resources/rspec'
 
 module Mergify
   module RSpec
     # Central orchestrator for Mergify Test Insights: sets up OpenTelemetry tracing,
     # manages the tracer provider, and coordinates flaky detection and quarantine.
-    # rubocop:disable Metrics/ClassLength
+    # rubocop:disable-next Metrics/ClassLength
     class CIInsights
       attr_reader :token, :repo_name, :api_url, :test_run_id,
                   :tracer_provider, :tracer, :exporter,
                   :branch_name,
                   :flaky_detector, :flaky_detector_error_message, :quarantined_tests
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def initialize
         @token = ENV.fetch('MERGIFY_TOKEN', nil)
-        @repo_name = Utils.repository_name
+        @repo_name = Native.detect_repository_name
         @api_url = ENV.fetch('MERGIFY_API_URL', 'https://api.mergify.com')
         @test_run_id = SecureRandom.hex(8)
         @tracer_provider = nil
@@ -39,7 +34,6 @@ module Mergify
 
         setup_tracing if Utils.in_ci?
       end
-      # rubocop:enable Metrics/MethodLength
 
       def mark_test_as_quarantined_if_needed(example_id) # rubocop:disable Naming/PredicateMethod
         return false unless @quarantined_tests&.include?(example_id)
@@ -96,24 +90,20 @@ module Mergify
         [processor, exp]
       end
 
-      # rubocop:disable Metrics/MethodLength
+      # The cicd.* and vcs.* attributes come from the Rust core, which every
+      # Mergify test client shares, so a provider gains them everywhere at once.
+      # What stays here is what only Ruby knows: the test framework, and the id
+      # this run invented for itself.
       def build_resource
         resources = [
-          Resources::CI.detect,
-          Resources::Git.detect,
-          Resources::GitHubActions.detect,
-          Resources::Jenkins.detect,
-          Resources::Buildkite.detect,
-          Resources::Mergify.detect,
-          Resources::RSpec.detect
+          OpenTelemetry::SDK::Resources::Resource.create(Native.detect_attributes),
+          Resources::RSpec.detect,
+          OpenTelemetry::SDK::Resources::Resource.create('test.run.id' => @test_run_id)
         ]
-        base = resources.reduce(OpenTelemetry::SDK::Resources::Resource.create({})) do |merged, r|
+        resources.reduce(OpenTelemetry::SDK::Resources::Resource.create({})) do |merged, r|
           merged.merge(r)
         end
-        run_id_resource = OpenTelemetry::SDK::Resources::Resource.create('test.run.id' => @test_run_id)
-        base.merge(run_id_resource)
       end
-      # rubocop:enable Metrics/MethodLength
 
       def extract_branch_name(resource)
         attrs = resource.attribute_enumerator.to_h
@@ -121,7 +111,7 @@ module Mergify
         @base_branch_name || attrs['vcs.ref.head.name']
       end
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def create_otlp_exporter(endpoint)
         require 'opentelemetry-exporter-otlp'
         original_env = ENV.fetch('OTEL_EXPORTER_OTLP_TRACES_ENDPOINT', nil)
@@ -140,9 +130,8 @@ module Mergify
           end
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def load_flaky_detector
         return unless @token && @repo_name
 
@@ -161,7 +150,6 @@ module Mergify
       rescue StandardError => e
         @flaky_detector_error_message = "Could not load flaky detector: #{e.message}"
       end
-      # rubocop:enable Metrics/MethodLength
 
       def load_quarantine
         return unless @token && @repo_name && @branch_name
@@ -175,6 +163,5 @@ module Mergify
         )
       end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/mergify/rspec/configuration.rb

@@ -10,7 +10,7 @@ module Mergify
       module_function
 
       # rubocop:disable Metrics/MethodLength,Metrics/BlockLength,Metrics/AbcSize
-      # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+      # rubocop:disable-next Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       def setup!
         ::RSpec.configure do |config|
           # Add formatter when in CI
@@ -111,7 +111,6 @@ module Mergify
           end
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       # rubocop:enable Metrics/MethodLength,Metrics/BlockLength,Metrics/AbcSize
     end
   end

data/lib/mergify/rspec/flaky_detection.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'json'
-require 'uri'
 require 'set'
 require_relative 'utils'
+require_relative 'native'
+require_relative 'version'
 
 module Mergify
   module RSpec
@@ -15,7 +14,7 @@ module Mergify
     class FlakyDetectionDisabledError < StandardError; end
 
     # Manages intelligent test rerunning with budget constraints for flaky detection.
-    # rubocop:disable Metrics/ClassLength
+    # rubocop:disable-next Metrics/ClassLength
     class FlakyDetector
       # Per-test tracking metrics.
       class TestMetrics
@@ -74,38 +73,28 @@ module Mergify
         @tests_to_process = []
         @budget = 0.0
 
-        fetch_context
-        validate!
+        @context = fetch_context
+        raise FlakyDetectionDisabledError unless Native::Budget.should_run(@context, @mode)
       end
 
-      # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+      # Which tests this session reruns, and how long it may spend doing it,
+      # both come from the shared budget engine -- so a Ruby suite and a Python
+      # one facing the same context spend the same time.
+      #
+      # The engine sizes the budget from the existing tests *in this session*,
+      # where this class counted every existing test the context knew about. A
+      # session running part of a suite was handed the whole suite's budget; it
+      # now gets its own.
       def prepare_for_session(test_ids)
-        existing = Set.new(@context[:existing_test_names])
-        unhealthy = Set.new(@context[:unhealthy_test_names])
+        plan = Native::Budget.compute(@context, @mode, test_ids, [])
 
-        @tests_to_process =
-          if @mode == 'new'
-            test_ids.reject { |id| existing.include?(id) }
-          else
-            test_ids.select { |id| unhealthy.include?(id) }
-          end
-
-        budget_ratio = if @mode == 'new'
-                         @context[:budget_ratio_for_new_tests]
-                       else
-                         @context[:budget_ratio_for_unhealthy_tests]
-                       end
-
-        mean_duration_s = @context[:existing_tests_mean_duration_ms] / 1000.0
-        existing_count = @context[:existing_test_names].size
-        min_budget_s = @context[:min_budget_duration_ms] / 1000.0
-
-        ratio_budget = budget_ratio * mean_duration_s * existing_count
-        @budget = [ratio_budget, min_budget_s].max
+        @tests_to_process = plan['tests_to_process']
+        # The engine works in milliseconds; everything downstream compares
+        # against RSpec's durations, which are seconds.
+        @budget = plan['available_budget_ms'] / 1000.0
       end
-      # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def fill_metrics_from_report(test_id, phase, duration, status)
         if status == :skipped
           @metrics.delete(test_id)
@@ -114,7 +103,7 @@ module Mergify
 
         return unless @tests_to_process.include?(test_id)
 
-        if test_id.length > @context[:max_test_name_length]
+        if test_id.length > @context['max_test_name_length']
           @over_length_tests.add(test_id)
           return
         end
@@ -125,7 +114,6 @@ module Mergify
         @metrics[test_id] ||= TestMetrics.new
         @metrics[test_id].fill_from_report(phase, duration, status)
       end
-      # rubocop:enable Metrics/MethodLength
 
       def rerunning_test?(test_id)
         @metrics.key?(test_id) && @metrics[test_id].rerun_count >= 1
@@ -155,7 +143,7 @@ module Mergify
         return false unless @metrics.key?(test_id)
 
         metrics = @metrics[test_id]
-        min_exec = @context[:min_test_execution_count]
+        min_exec = @context['min_test_execution_count']
         (metrics.initial_duration * min_exec) > metrics.remaining_time
       end
 
@@ -163,14 +151,14 @@ module Mergify
         return false unless @metrics.key?(test_id)
 
         metrics = @metrics[test_id]
-        metrics.will_exceed_deadline? || metrics.rerun_count >= @context[:max_test_execution_count]
+        metrics.will_exceed_deadline? || metrics.rerun_count >= @context['max_test_execution_count']
       end
 
       def test_metrics(test_id)
         @metrics[test_id]
       end
 
-      # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+      # rubocop:disable-next Metrics/MethodLength,Metrics/AbcSize
       def make_report
         lines = []
         lines << 'Mergify Flaky Detection Report'
@@ -195,60 +183,19 @@ module Mergify
 
         lines.join("\n")
       end
-      # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
 
       private
 
-      # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      # A nil context means the repository has not opted into flaky detection,
+      # which is the expected default rather than a failure.
       def fetch_context
-        owner, repo = Utils.split_full_repo_name(@full_repository_name)
-        uri = URI("#{@url}/v1/ci/#{owner}/repositories/#{repo}/flaky-detection-context")
-
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = uri.scheme == 'https'
-        http.open_timeout = 10
-        http.read_timeout = 10
-
-        request = Net::HTTP::Get.new(uri)
-        request['Authorization'] = "Bearer #{@token}"
-
-        response = http.request(request)
-        case response.code.to_i
-        when 200
-          parse_context(response.body)
-        when 404
-          # A 404 means the repository has not opted into flaky detection; this
-          # is the expected default, not an error.
-          raise FlakyDetectionDisabledError
-        else
-          raise "Mergify API returned HTTP #{response.code}"
-        end
-      end
-      # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
-
-      # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
-      def parse_context(body)
-        data = JSON.parse(body, symbolize_names: true)
-        @context = {
-          budget_ratio_for_new_tests: data[:budget_ratio_for_new_tests].to_f,
-          budget_ratio_for_unhealthy_tests: data[:budget_ratio_for_unhealthy_tests].to_f,
-          existing_test_names: Array(data[:existing_test_names]),
-          existing_tests_mean_duration_ms: data[:existing_tests_mean_duration_ms].to_f,
-          unhealthy_test_names: Array(data[:unhealthy_test_names]),
-          max_test_execution_count: data[:max_test_execution_count].to_i,
-          max_test_name_length: data[:max_test_name_length].to_i,
-          min_budget_duration_ms: data[:min_budget_duration_ms].to_f,
-          min_test_execution_count: data[:min_test_execution_count].to_i
-        }
-      end
-      # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
+        raise FlakyDetectionDisabledError unless Native.available?
 
-      def validate!
-        return unless @mode == 'new' && @context[:existing_test_names].empty?
+        owner, repo = Utils.split_full_repo_name(@full_repository_name)
+        context = Native::Client.new(@url, @token, owner, repo, VERSION).fetch_flaky_context
+        raise FlakyDetectionDisabledError if context.nil?
 
-        # Without a baseline, `new` mode would treat every test as new and rerun
-        # the whole suite. Skip instead of surfacing an error.
-        raise FlakyDetectionDisabledError
+        context
       end
 
       def remaining_budget
@@ -264,6 +211,5 @@ module Mergify
         @tests_to_process.count { |id| !@metrics.key?(id) || @metrics[id].deadline.nil? }
       end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/mergify/rspec/formatter.rb

@@ -8,7 +8,7 @@ module Mergify
     # RSpec formatter that creates OpenTelemetry spans for Mergify Test Insights and
     # prints a terminal report. It is purely observational and does not modify
     # test execution.
-    # rubocop:disable Metrics/ClassLength
+    # rubocop:disable-next Metrics/ClassLength
     class Formatter < ::RSpec::Core::Formatters::BaseFormatter
       ::RSpec::Core::Formatters.register self,
                                          :start,
@@ -17,7 +17,7 @@ module Mergify
                                          :example_pending,
                                          :stop
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def start(notification)
         super
 
@@ -34,7 +34,6 @@ module Mergify
         @has_error = false
         @example_spans = {}
       end
-      # rubocop:enable Metrics/MethodLength
 
       def example_started(notification)
         return unless @ci_insights&.tracer && @session_span
@@ -51,7 +50,7 @@ module Mergify
         @example_spans[example.id] = span
       end
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def example_finished(notification)
         return unless @example_spans
 
@@ -73,7 +72,6 @@ module Mergify
 
         span.finish
       end
-      # rubocop:enable Metrics/MethodLength
 
       def example_pending(notification)
         return unless @example_spans
@@ -149,7 +147,7 @@ module Mergify
         @session_span.finish
       end
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def print_report
         output.puts ''
         output.puts '--- Mergify CI ---'
@@ -165,7 +163,6 @@ module Mergify
         output.puts "MERGIFY_TEST_RUN_ID=#{@ci_insights.test_run_id}"
         output.puts '------------------'
       end
-      # rubocop:enable Metrics/MethodLength
 
       def print_configuration_warnings
         output.puts 'WARNING: MERGIFY_TOKEN is not set. Traces will not be sent to Mergify.' unless @ci_insights.token
@@ -217,6 +214,5 @@ module Mergify
         output.puts 'Documentation: https://docs.mergify.com/ci-insights/test-frameworks/'
       end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/mergify/rspec/native.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Mergify
+  module RSpec
+    # The Rust extension over mergify-ci-core: CI detection shared with the
+    # pytest and TypeScript clients.
+    #
+    # Loading is best-effort by design. A precompiled gem carries one extension
+    # per Ruby under `<ruby>/`, the source gem compiles one alongside this file,
+    # and a platform we publish neither for gets neither. Detection is one input
+    # to telemetry, not the point of the gem, so an absent extension degrades
+    # what we can report rather than breaking the suite under test -- the same
+    # fail-open posture the napi binding takes when a platform has no prebuilt
+    # binary. `load_error` keeps the reason, for callers that want to say so.
+    module Native
+      # Raised when a Mergify API call fails outright.
+      #
+      # Distinct from StandardError on purpose: callers degrade on an API
+      # failure, and a bare rescue there would swallow genuine bugs in the
+      # binding as though the backend were down.
+      class ApiError < StandardError; end
+
+      class << self
+        # The LoadError that prevented the extension loading, or nil.
+        attr_accessor :load_error
+
+        def available?
+          load_error.nil?
+        end
+      end
+    end
+  end
+end
+
+begin
+  # Precompiled gems ship lib/mergify/rspec/<ruby>/mergify_ci.<dlext>.
+  require_relative "#{RUBY_VERSION.to_f}/mergify_ci"
+rescue LoadError
+  begin
+    # Source gem, and any local `rake compile`.
+    require_relative 'mergify_ci'
+  rescue LoadError => e
+    Mergify::RSpec::Native.load_error = e
+  end
+end
+
+unless Mergify::RSpec::Native.available?
+  # Stand in for the extension so callers can just ask, and get the same answer
+  # they would get from a machine that is not in CI. Branching on availability
+  # at every call site would only spread the same nil back through the caller.
+  module Mergify
+    module RSpec
+      module Native
+        class << self
+          def detect_provider
+            nil
+          end
+
+          def detect_repository_name
+            nil
+          end
+
+          def detect_attributes
+            {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mergify/rspec/quarantine.rb

@@ -1,14 +1,19 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'json'
-require 'uri'
 require 'set'
 require_relative 'utils'
+require_relative 'native'
+require_relative 'version'
 
 module Mergify
   module RSpec
     # Fetches quarantined test names from the Mergify API and tracks which are used.
+    #
+    # The fetch itself -- pagination, the RFC 8288 `next` links, the status
+    # codes that mean "not subscribed" rather than "broken" -- belongs to the
+    # shared Rust client now, so every Mergify test client reads a quarantine
+    # list the same way. What stays here is what RSpec cares about: which of
+    # those tests this session actually ran, and the report at the end.
     class Quarantine
       attr_reader :quarantined_tests, :init_error_msg
 
@@ -19,10 +24,7 @@ module Mergify
         @used_tests = Set.new
         @init_error_msg = nil
 
-        owner, repo = Utils.split_full_repo_name(repo_name)
-        fetch_quarantined_tests(api_url, token, owner, repo, branch_name)
-      rescue Utils::InvalidRepositoryFullNameError => e
-        @init_error_msg = e.message
+        fetch(api_url, token, branch_name)
       end
 
       def include?(example_id)
@@ -33,7 +35,7 @@ module Mergify
         @used_tests.add(example_id)
       end
 
-      # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+      # rubocop:disable-next Metrics/MethodLength,Metrics/AbcSize
       def report
         used, unused = @quarantined_tests.partition { |t| @used_tests.include?(t) }
 
@@ -50,85 +52,24 @@ module Mergify
         unused.each { |t| lines << "    - #{t}" }
         lines.join("\n")
       end
-      # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
 
       private
 
-      def fetch_quarantined_tests(api_url, token, owner, repo, branch_name)
-        uri = URI("#{api_url}/v1/ci/#{owner}/repositories/#{repo}/quarantines")
-        uri.query = URI.encode_www_form(branch: branch_name, per_page: 100)
-        collected = walk_paginated_quarantines(uri, token)
-        @quarantined_tests = collected if collected
-      rescue Net::OpenTimeout, Net::ReadTimeout, Errno::ECONNREFUSED, SocketError => e
-        @init_error_msg = "Failed to connect to Mergify API: #{e.message}"
-      rescue JSON::ParserError => e
-        @init_error_msg = "Mergify API returned a malformed quarantine list: #{e.message}"
-      end
-
-      # Follows the RFC 5988 `next` link until exhausted. Returns the full list
-      # on success, or `nil` when the run was aborted (subscription missing or
-      # an error already recorded in @init_error_msg).
-      # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
-      def walk_paginated_quarantines(uri, token)
-        collected = []
-        # Guard against a server returning a `next` link that loops back to a
-        # URL we have already fetched.
-        seen = Set.new
-        while uri
-          if seen.include?(uri.to_s)
-            @init_error_msg = 'Mergify API returned a cyclic `next` link, aborting.'
-            return nil
-          end
-          seen.add(uri.to_s)
-
-          response = perform_request(uri, token)
-          case response.code.to_i
-          when 200
-            data = JSON.parse(response.body)
-            collected.concat(data.fetch('quarantined_tests', []).map { |t| t['test_name'] })
-            next_url = parse_next_link(response['Link'])
-            uri = next_url ? URI(next_url) : nil
-          when 402
-            return nil
-          else
-            @init_error_msg = "Mergify API returned HTTP #{response.code}"
-            return nil
-          end
+      # A nil list means the repository has no quarantine subscription, which is
+      # not an error: the session simply quarantines nothing. Anything that went
+      # genuinely wrong is recorded and the suite carries on -- this plugin has
+      # never let the backend fail a test run.
+      def fetch(api_url, token, branch_name)
+        unless Native.available?
+          @init_error_msg = "Mergify native extension unavailable: #{Native.load_error}"
+          return
         end
-        collected
-      end
-      # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
-
-      def perform_request(uri, token)
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = uri.scheme == 'https'
-        http.open_timeout = 10
-        http.read_timeout = 10
-
-        request = Net::HTTP::Get.new(uri)
-        request['Authorization'] = "Bearer #{token}"
-        http.request(request)
-      end
 
-      # Parses RFC 8288 Link headers tolerantly: accepts both quoted
-      # (`rel="next"`) and token (`rel=next`) forms, and matches when `next`
-      # is one of several space-separated rel-types (`rel="next prev"`).
-      def parse_next_link(link_header)
-        return nil if link_header.nil? || link_header.empty?
-
-        link_header.split(',').each do |part|
-          match = part.strip.match(/\A<([^>]+)>\s*;\s*(.+)\z/)
-          next unless match && next_rel?(match[2])
-
-          return match[1]
-        end
-        nil
-      end
-
-      def next_rel?(params)
-        params.scan(/rel\s*=\s*(?:"([^"]+)"|([^\s;,]+))/i).any? do |quoted, token|
-          (quoted || token).split.include?('next')
-        end
+        owner, repo = Utils.split_full_repo_name(@repo_name)
+        client = Native::Client.new(api_url, token, owner, repo, VERSION)
+        @quarantined_tests = client.fetch_quarantine(branch_name) || []
+      rescue Utils::InvalidRepositoryFullNameError, Native::ApiError => e
+        @init_error_msg = e.message
       end
     end
   end