rspec-mergify 0.1.4 → 0.3.0

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)
@@ -53,80 +55,21 @@ module Mergify
 
       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-next 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
-        end
-        collected
-      end
-
-      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]
+      # 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
-        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

data/lib/mergify/rspec/resources/rspec.rb

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
 
-require 'opentelemetry-sdk'
 require 'rspec/core/version'
 
 module Mergify
   module RSpec
     module Resources
-      # Detects OpenTelemetry Resource attributes for RSpec.
+      # The resource attributes only Ruby knows: which framework ran the suite,
+      # and in which language.
       module RSpec
         module_function
 
         def detect
-          OpenTelemetry::SDK::Resources::Resource.create(
+          {
             'test.framework' => 'rspec',
-            'test.framework.version' => ::RSpec::Core::Version::STRING
-          )
+            'test.framework.version' => ::RSpec::Core::Version::STRING,
+            # Mergify takes a test's language from here when the span does not
+            # name one. The OpenTelemetry SDK sets this on its default resource,
+            # but this gem never used that resource, so nothing had ever sent it.
+            'telemetry.sdk.language' => 'ruby'
+          }
         end
       end
     end

data/lib/mergify/rspec/trace.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Mergify
+  module RSpec
+    # The little of OpenTelemetry this plugin actually used.
+    #
+    # A test run needs identifiers, a start and an end, some attributes and a
+    # status -- and the shared Rust client does the rest: the wire format, the
+    # compression, the retries, the size limit. The SDK brought samplers,
+    # context propagation machinery, batch processors and an exporter registry
+    # to do the part that fits here, and its dependency tree landed in every
+    # consumer's bundle. So the spans are assembled directly.
+    module Trace
+      # W3C traceparent: version-traceid-spanid-flags, all lowercase hex.
+      TRACEPARENT = /\A00-(?<trace_id>[0-9a-f]{32})-(?<span_id>[0-9a-f]{16})-[0-9a-f]{2}\z/
+
+      # A span being recorded, and once finished, the record itself.
+      class Span
+        attr_reader :name, :trace_id, :span_id, :parent_span_id, :attributes
+        attr_accessor :status, :status_message
+
+        def initialize(name:, trace_id:, span_id:, parent_span_id: nil, attributes: {})
+          @name = name
+          @trace_id = trace_id
+          @span_id = span_id
+          @parent_span_id = parent_span_id
+          @attributes = attributes.transform_keys(&:to_s)
+          @status = 'unset'
+          @status_message = nil
+          @start_unix_nano = Trace.now_unix_nano
+          @end_unix_nano = nil
+        end
+
+        # Ids travel as bytes and are read as hex -- in a traceparent, in a
+        # backend URL, in a log line.
+        def hex_trace_id
+          @trace_id.unpack1('H*')
+        end
+
+        def hex_span_id
+          @span_id.unpack1('H*')
+        end
+
+        def set_attribute(key, value)
+          @attributes[key.to_s] = value
+        end
+
+        def error!(message)
+          @status = 'error'
+          @status_message = message
+        end
+
+        def ok!
+          @status = 'ok'
+        end
+
+        def finish
+          @end_unix_nano ||= Trace.now_unix_nano
+          self
+        end
+
+        # The shape the binding accepts, which is the wire format's own.
+        # rubocop:disable-next Metrics/MethodLength
+        def to_h
+          {
+            'name' => @name,
+            'trace_id' => @trace_id,
+            'span_id' => @span_id,
+            'parent_span_id' => @parent_span_id,
+            'start_unix_nano' => @start_unix_nano,
+            'end_unix_nano' => @end_unix_nano || Trace.now_unix_nano,
+            'attributes' => @attributes,
+            'status' => @status,
+            'status_message' => @status_message
+          }.compact
+        end
+      end
+
+      # Collects a run's spans and hands them to the client in one upload.
+      #
+      # Deliberately not streaming: a suite's spans are worth one request at the
+      # end, and exporting mid-run would put HTTP in the middle of the thing
+      # being timed. That was already why the gem replaced the SDK's batch
+      # processor with its own.
+      class Recorder
+        attr_reader :resource_attributes, :finished_spans, :trace_id
+
+        # `traceparent` is the W3C header a caller can hand down to put this
+        # run inside a trace it already started; the session span then hangs off
+        # that caller's span rather than starting a trace of its own.
+        def initialize(resource_attributes: {}, traceparent: nil)
+          @resource_attributes = resource_attributes.transform_keys(&:to_s)
+          inherited = Trace.parse_traceparent(traceparent)
+          @trace_id = inherited ? inherited.first : Trace.generate_trace_id
+          @root_parent_span_id = inherited&.last
+          @finished_spans = []
+        end
+
+        def start_span(name, parent: nil, attributes: {})
+          Span.new(
+            name: name,
+            trace_id: @trace_id,
+            span_id: Trace.generate_span_id,
+            parent_span_id: parent&.span_id || @root_parent_span_id,
+            attributes: attributes
+          )
+        end
+
+        def record(span)
+          @finished_spans << span.finish
+          span
+        end
+
+        def clear
+          @finished_spans = []
+        end
+      end
+
+      class << self
+        def now_unix_nano
+          (Time.now.to_r * 1_000_000_000).to_i
+        end
+
+        def generate_trace_id
+          SecureRandom.bytes(16)
+        end
+
+        def generate_span_id
+          SecureRandom.bytes(8)
+        end
+
+        # The trace this run belongs to, when a parent handed one down.
+        # Returns [trace_id, parent_span_id] as raw bytes, or nil.
+        def parse_traceparent(header)
+          match = TRACEPARENT.match(header.to_s)
+          return nil unless match
+
+          [[match[:trace_id]].pack('H*'), [match[:span_id]].pack('H*')]
+        end
+      end
+    end
+  end
+end

data/lib/mergify/rspec/utils.rb

@@ -1,24 +1,21 @@
 # frozen_string_literal: true
 
-require 'open3'
-
 module Mergify
   module RSpec
     # Utility methods shared across the rspec-mergify gem.
+    #
+    # CI detection used to live here -- the provider table, the git shelling
+    # out, the per-provider environment mappings. It is the Rust core's now, via
+    # the extension in Mergify::RSpec::Native, so that every Mergify test client
+    # detects identically. What is left is what is genuinely Ruby's: parsing a
+    # repository name the API needs split, and deciding whether the plugin
+    # should switch itself on at all.
     module Utils
       module_function
 
       # Raised when a repository full name (owner/repo) is malformed.
       class InvalidRepositoryFullNameError < StandardError; end
 
-      SUPPORTED_CIS = {
-        'GITHUB_ACTIONS' => :github_actions,
-        'CIRCLECI' => :circleci,
-        'JENKINS_URL' => :jenkins,
-        'BUILDKITE' => :buildkite,
-        '_RSPEC_MERGIFY_TEST' => :rspec_mergify_suite
-      }.freeze
-
       TRUTHY_STRINGS = %w[y yes t true on 1].freeze
       FALSY_STRINGS  = %w[n no f false off 0].freeze
 
@@ -40,44 +37,14 @@ module Mergify
 
       # Returns true when the suite is running inside CI or when
       # RSPEC_MERGIFY_ENABLE is set to a truthy value.
+      #
+      # Deliberately not the core's provider detection: this asks whether the
+      # plugin should run, which an unrecognised CI or a developer setting
+      # RSPEC_MERGIFY_ENABLE both answer yes to.
       def in_ci?
         env_truthy?('CI') || env_truthy?('RSPEC_MERGIFY_ENABLE')
       end
 
-      # Evaluates whether a CI environment variable should be considered enabled.
-      # rubocop:disable-next Metrics/MethodLength
-      def ci_provider
-        SUPPORTED_CIS.each do |envvar, name|
-          next unless ENV.key?(envvar)
-
-          enabled =
-            begin
-              strtobool(ENV.fetch(envvar, ''))
-            rescue ArgumentError
-              !ENV.fetch(envvar, '').strip.empty?
-            end
-
-          return name if enabled
-        end
-        nil
-      end
-
-      # Parse a git remote URL (SSH or HTTPS) into "owner/repo" form.
-      # Returns nil when the URL cannot be recognised.
-      def repository_name_from_url(url)
-        # SSH: git@github.com:owner/repo.git
-        if (m = url.match(%r{\Agit@[\w.-]+:(?<full_name>[\w.-]+/[\w.-]+?)(?:\.git)?/?$}))
-          return m[:full_name]
-        end
-
-        # HTTPS/HTTP with optional host (and optional port)
-        if (m = url.match(%r{\A(?:https?://[\w.-]+(?::\d+)?/)?(?<full_name>[\w.-]+/[\w.-]+)/?\z}))
-          return m[:full_name]
-        end
-
-        nil
-      end
-
       # Split "owner/repo" into [owner, repo].
       # Raises InvalidRepositoryFullNameError when the format is wrong.
       def split_full_repo_name(full_repo_name)
@@ -86,55 +53,6 @@ module Mergify
 
         raise InvalidRepositoryFullNameError, "Invalid repository name: #{full_repo_name}"
       end
-
-      # Run a git subcommand via Open3.
-      # Returns stripped stdout on success, nil on failure.
-      def git(*args)
-        stdout, status = Open3.capture2('git', *args, err: File::NULL)
-        status.success? ? stdout.strip : nil
-      rescue StandardError
-        nil
-      end
-
-      # Build an attribute hash from a mapping of
-      # { attr_name => [cast_method_symbol, env_var_name_or_callable] }.
-      # Attributes whose env var is unset or whose callable returns nil are omitted.
-      def get_attributes(mapping)
-        mapping.each_with_object({}) do |(attr, (cast, env_or_callable)), result|
-          value = env_or_callable.respond_to?(:call) ? env_or_callable.call : ENV.fetch(env_or_callable, nil)
-
-          next if value.nil?
-          next if value.respond_to?(:empty?) && value.empty?
-
-          result[attr] = value.public_send(cast)
-        end
-      end
-
-      # Detect the repository name using CI environment variables or a git
-      # remote fallback.
-      # rubocop:disable-next Metrics/MethodLength,Metrics/CyclomaticComplexity
-      def repository_name
-        provider = ci_provider
-
-        case provider
-        when :jenkins
-          url = ENV.fetch('GIT_URL', nil)
-          return repository_name_from_url(url) if url
-        when :github_actions
-          return ENV.fetch('GITHUB_REPOSITORY', nil)
-        when :circleci
-          url = ENV.fetch('CIRCLE_REPOSITORY_URL', nil)
-          return repository_name_from_url(url) if url
-        when :buildkite
-          url = ENV.fetch('BUILDKITE_REPO', nil)
-          return repository_name_from_url(url) if url
-        when :rspec_mergify_suite
-          return 'Mergifyio/rspec-mergify'
-        end
-
-        url = git('config', '--get', 'remote.origin.url')
-        repository_name_from_url(url) if url
-      end
     end
   end
 end

data/lib/mergify/rspec/version.rb

@@ -8,6 +8,6 @@ module Mergify
     # which resolved against whatever repository happened to be the working
     # directory at load time -- the monorepo's namespaced tags here, the user's
     # own tags once the gem was installed.
-    VERSION = '0.1.4'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-mergify
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Mergify
@@ -9,34 +9,6 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-exporter-otlp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.29'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.29'
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-sdk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -66,15 +38,10 @@ files:
 - lib/mergify/rspec/configuration.rb
 - lib/mergify/rspec/flaky_detection.rb
 - lib/mergify/rspec/formatter.rb
+- lib/mergify/rspec/native.rb
 - lib/mergify/rspec/quarantine.rb
-- lib/mergify/rspec/resources/buildkite.rb
-- lib/mergify/rspec/resources/ci.rb
-- lib/mergify/rspec/resources/git.rb
-- lib/mergify/rspec/resources/github_actions.rb
-- lib/mergify/rspec/resources/jenkins.rb
-- lib/mergify/rspec/resources/mergify.rb
 - lib/mergify/rspec/resources/rspec.rb
-- lib/mergify/rspec/synchronous_batch_span_processor.rb
+- lib/mergify/rspec/trace.rb
 - lib/mergify/rspec/utils.rb
 - lib/mergify/rspec/version.rb
 - lib/rspec_mergify.rb
@@ -99,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: RSpec plugin for Mergify CI Insights
 test_files: []

data/lib/mergify/rspec/resources/buildkite.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'opentelemetry-sdk'
-require_relative '../utils'
-require_relative 'git'
-
-module Mergify
-  module RSpec
-    module Resources
-      # Detects OpenTelemetry Resource attributes for Buildkite.
-      module Buildkite
-        module_function
-
-        BUILDKITE_MAPPING = {
-          'cicd.pipeline.name' => [:to_s, 'BUILDKITE_PIPELINE_SLUG'],
-          'cicd.pipeline.task.name' => [
-            :to_s,
-            lambda {
-              label = ENV.fetch('BUILDKITE_LABEL', nil)
-              label && !label.empty? ? label : ENV.fetch('BUILDKITE_STEP_KEY', nil)
-            }
-          ],
-          'cicd.pipeline.run.id' => [:to_s, 'BUILDKITE_BUILD_ID'],
-          'cicd.pipeline.run.url' => [:to_s, 'BUILDKITE_BUILD_URL'],
-          'cicd.pipeline.run.attempt' => [
-            :to_i,
-            -> { ENV.fetch('BUILDKITE_RETRY_COUNT', '0').to_i + 1 }
-          ],
-          'cicd.pipeline.runner.name' => [:to_s, 'BUILDKITE_AGENT_NAME'],
-          'vcs.ref.head.name' => [:to_s, 'BUILDKITE_BRANCH'],
-          'vcs.ref.base.name' => [:to_s, 'BUILDKITE_PULL_REQUEST_BASE_BRANCH'],
-          'vcs.ref.head.revision' => [:to_s, 'BUILDKITE_COMMIT'],
-          'vcs.repository.url.full' => [:to_s, 'BUILDKITE_REPO'],
-          'vcs.repository.name' => [
-            :to_s,
-            lambda {
-              url = ENV.fetch('BUILDKITE_REPO', nil)
-              Utils.repository_name_from_url(url) if url
-            }
-          ]
-        }.freeze
-
-        def detect
-          return OpenTelemetry::SDK::Resources::Resource.create({}) if Utils.ci_provider != :buildkite
-
-          git_attrs = Utils.get_attributes(Git::GIT_MAPPING)
-          buildkite_attrs = Utils.get_attributes(BUILDKITE_MAPPING)
-          merged = git_attrs.merge(buildkite_attrs)
-          OpenTelemetry::SDK::Resources::Resource.create(merged)
-        end
-      end
-    end
-  end
-end

data/lib/mergify/rspec/resources/ci.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'opentelemetry-sdk'
-require_relative '../utils'
-
-module Mergify
-  module RSpec
-    module Resources
-      # Detects OpenTelemetry Resource attributes for the CI provider.
-      module CI
-        module_function
-
-        def detect
-          provider = Utils.ci_provider
-          return OpenTelemetry::SDK::Resources::Resource.create({}) if provider.nil?
-
-          OpenTelemetry::SDK::Resources::Resource.create(
-            'cicd.provider.name' => provider.to_s
-          )
-        end
-      end
-    end
-  end
-end

data/lib/mergify/rspec/resources/git.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'opentelemetry-sdk'
-require_relative '../utils'
-
-module Mergify
-  module RSpec
-    module Resources
-      # Detects OpenTelemetry Resource attributes from git.
-      module Git
-        module_function
-
-        GIT_MAPPING = {
-          'vcs.ref.head.name' => [:to_s, -> { Utils.git('rev-parse', '--abbrev-ref', 'HEAD') }],
-          'vcs.ref.head.revision' => [:to_s, -> { Utils.git('rev-parse', 'HEAD') }],
-          'vcs.repository.url.full' => [:to_s, -> { Utils.git('config', '--get', 'remote.origin.url') }],
-          'vcs.repository.name' => [
-            :to_s,
-            lambda {
-              url = Utils.git('config', '--get', 'remote.origin.url')
-              Utils.repository_name_from_url(url) if url
-            }
-          ]
-        }.freeze
-
-        def detect
-          return OpenTelemetry::SDK::Resources::Resource.create({}) if Utils.ci_provider.nil?
-
-          attributes = Utils.get_attributes(GIT_MAPPING)
-          OpenTelemetry::SDK::Resources::Resource.create(attributes)
-        end
-      end
-    end
-  end
-end