buildkite-test_collector 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e8ff4ceff4d825291a8878bf19a912362d45c36d6750c5e14628f446cec0bbd
-  data.tar.gz: 215441296a3c91547b0c43b062893239fbe5bae5ca2e1a80cca7b2ec65277e77
+  metadata.gz: 646d052c76b21f29bedb5526bf78b6a936c2c68091160ba393d4247936aeaf91
+  data.tar.gz: 4755eab1880142bfd38ef61413e9bf868f9d5b48c95c23a849735710d31d3bdf
 SHA512:
-  metadata.gz: d31e59e76f2dc92ef5951f9d97663f14cb84d9ba1256c8586931146151222c7ce3769a8913517910312d0a75a7cafb3488f0b9690257c4fc6686fbf37cbed9ee
-  data.tar.gz: 995fc9e592b74a41385058c4eac868e9639f6ef9bfb2ba9068cd156fd6ab5d90bf40aca86a9ab9c8560cf7c9ba80c4f172747a948e4e219976c680d035eae0af
+  metadata.gz: 6c4688fd37b1031374a0ff483bc36d751ae99dcd8b6f4ddf2d561ebfe2b71974316c6c0bd83fead42e20b5e355658a2f9cbbfa564427dc4021576286a6cd2cc1
+  data.tar.gz: '0298aa60472fd0f52c97e98c581268345798f41781ee8234021cd4c8837e91f336adebef4ee209db0a2b14fac7001ecff3cd8991b6f0d723b3479ae80792a4c3'

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## v2.7.0
+
+Features:
+
+- Add configurable span filters #220 - @catkins
+
+Fixes:
+
+- Correctly report HTTP error during upload #223 - @zhming0
+
+## v2.6.1
+
+- Fix missing failed examples if rspec hooks fail #221 - @zhming0
+
 ## v2.6.0
 
 - Trace spans can be filtered by minimum duration #215 - @pda

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    buildkite-test_collector (2.6.0)
+    buildkite-test_collector (2.7.0)
 
 GEM
   remote: https://rubygems.org/

data/buildkite.yaml

@@ -1,22 +1,17 @@
-steps:
-  - label: ":rspec: Tests :ruby: 3.3-rc"
-    command:
-      - "bundle"
-      - "bundle exec rake"
-    plugins:
-      - docker#v3.7.0:
-          image: "445615400570.dkr.ecr.us-east-1.amazonaws.com/ecr-public/docker/library/ruby:3.3-rc"
-    soft_fail: true
+agents:
+  queue: hosted
 
+steps:
   - label: ":rspec: Tests :ruby: {{matrix}}"
     command:
       - "bundle"
       - "bundle exec rake"
     plugins:
       - docker#v3.7.0:
-          image: "445615400570.dkr.ecr.us-east-1.amazonaws.com/ecr-public/docker/library/ruby:{{matrix}}"
+          image: "public.ecr.aws/docker/library/ruby:{{matrix}}"
     matrix:
       - "latest"
+      - "3.3"
       - "3.2"
       - "3.1"
       - "3.0"

data/lib/buildkite/test_collector/http_client.rb

@@ -38,7 +38,13 @@ module Buildkite::TestCollector
 
       contact.body = compressed_body.string
 
-      http.request(contact)
+      response = http.request(contact)
+
+      if response.is_a?(Net::HTTPSuccess)
+        response
+      else
+        raise "HTTP Request Failed: #{response.code} #{response.message}"
+      end
     end
 
     def metadata

data/lib/buildkite/test_collector/library_hooks/rspec.rb

@@ -23,13 +23,20 @@ RSpec.configure do |config|
     # The _buildkite prefix here is added as a safeguard against name collisions
     # as we are in the main thread
     Thread.current[:_buildkite_tracer] = tracer
-    example.run
-    Thread.current[:_buildkite_tracer] = nil
-
-    tracer.finalize
-
-    trace = Buildkite::TestCollector::RSpecPlugin::Trace.new(example, history: tracer.history)
-    Buildkite::TestCollector.uploader.traces[example.id] = trace
+    # It's important to use begin/ensure here, because otherwise if other hooks fail,
+    # the cleanup code won't run, meaning we will miss some data.
+    #
+    # Having said that, this behavior isn't documented by RSpec.
+    begin
+      example.run
+    ensure
+      Thread.current[:_buildkite_tracer] = nil
+
+      tracer.finalize
+
+      trace = Buildkite::TestCollector::RSpecPlugin::Trace.new(example, history: tracer.history)
+      Buildkite::TestCollector.uploader.traces[example.id] = trace
+    end
   end
 
   config.after(:suite) do

data/lib/buildkite/test_collector/tracer.rb

@@ -58,7 +58,6 @@ module Buildkite::TestCollector
     def initialize(min_duration: nil)
       @top = Span.new(:top, MonotonicTime.call, nil, {})
       @stack = [@top]
-      @min_duration = min_duration
     end
 
     def enter(section, **detail)
@@ -69,17 +68,17 @@ module Buildkite::TestCollector
 
     def leave
       current_span.end_at = MonotonicTime.call
-      duration = current_span.duration
       @stack.pop
-      current_span.children.pop if @min_duration && duration < @min_duration
+
+      current_span.children.pop unless retain_span?(current_span.children.last)
+
       nil # avoid ambiguous return type/value
     end
 
     def backfill(section, duration, **detail)
-      return if @min_duration && duration < @min_duration
       now = MonotonicTime.call
       new_entry = Span.new(section, now - duration, now, detail)
-      current_span.children << new_entry
+      current_span.children << new_entry if retain_span?(new_entry)
     end
 
     def current_span
@@ -95,5 +94,15 @@ module Buildkite::TestCollector
     def history
       @top.as_hash
     end
+
+    private
+
+    def retain_span?(span)
+      return true unless Buildkite::TestCollector.span_filters
+
+      Buildkite::TestCollector.span_filters.all? do |filter|
+        filter.call(span)
+      end
+    end
   end
 end

data/lib/buildkite/test_collector/uploader.rb

@@ -25,7 +25,8 @@ module Buildkite::TestCollector
       OpenSSL::SSL::SSLError,
       OpenSSL::SSL::SSLErrorWaitReadable,
       EOFError,
-      Errno::ETIMEDOUT
+      Errno::ETIMEDOUT,
+      # TODO: some retries for server-side error would be great.
     ]
 
     def self.tracer
@@ -38,7 +39,7 @@ module Buildkite::TestCollector
       http = Buildkite::TestCollector::HTTPClient.new(Buildkite::TestCollector.url)
 
       Thread.new do
-        response = begin
+        begin
           upload_attempts ||= 0
           http.post_json(data)
         rescue *Buildkite::TestCollector::Uploader::RETRYABLE_UPLOAD_ERRORS => e

data/lib/buildkite/test_collector/version.rb

@@ -2,7 +2,7 @@
 
 module Buildkite
   module TestCollector
-    VERSION = "2.6.0"
+    VERSION = "2.7.0"
     NAME = "buildkite-test_collector"
   end
 end

data/lib/buildkite/test_collector.rb

@@ -28,7 +28,6 @@ module Buildkite
   module TestCollector
     DEFAULT_URL = "https://analytics-api.buildkite.com/v1/uploads"
     DEFAULT_UPLOAD_BATCH_SIZE = 500
-
     class << self
       attr_accessor :api_token
       attr_accessor :url
@@ -39,6 +38,7 @@ module Buildkite
       attr_accessor :env
       attr_accessor :batch_size
       attr_accessor :trace_min_duration
+      attr_accessor :span_filters
     end
 
     def self.configure(hook:, token: nil, url: nil, tracing_enabled: true, artifact_path: nil, env: {})
@@ -54,6 +54,11 @@ module Buildkite
         Float(trace_min_ms_string) / 1000
       end
 
+      self.span_filters = []
+      unless self.trace_min_duration.nil?
+        self.span_filters << MinDurationSpanFilter.new(self.trace_min_duration)
+      end
+
       self.hook_into(hook)
     end
 
@@ -84,5 +89,15 @@ module Buildkite
         Buildkite::TestCollector::Uploader.tracer&.backfill(:sql, finish - start, **{ query: payload[:sql] })
       end
     end
+
+    class MinDurationSpanFilter
+      def initialize(min_duration)
+        @min_duration = min_duration
+      end
+
+      def call(span)
+        span.duration > @min_duration
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-test_collector
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Track test executions and report to Buildkite Test Analytics