rspec-buildkite-analytics 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9fc407bacf4405e3d3e2ee4043a9c71f20d75a363d3ba33948b37403a6e8de4
-  data.tar.gz: 67f8b42a6ac98518d784eea442fb9efc5a1c8dd5ca0037cc5ce5664b180b75ec
+  metadata.gz: 2b1c6bc2713e36242b9d710e348574bd05b8cda4e4d3961742a781256595114f
+  data.tar.gz: f221e0f6486ceeb41547a344ec72b47c1385d1ec41689d61aa4e9d9653fa51e3
 SHA512:
-  metadata.gz: 6c368891ad4401ac9112a618953686c79b2e69bd33824be1477e3416f99f03233210d80ad3d3a1eccd9b251f595f2b879fd79de0eb1d80193544a6812e8ac0b9
-  data.tar.gz: 2cf265c336146324d21b06d8c3ec4827848dcb0580ac626d49cd82eaab10ef5101f9398bdad10c118c5dfd42276ed2e70441f8c42b6881a8d68bf6a05da73485
+  metadata.gz: a2fd21327c874a8efac7822e995ce9b487029462905ea24ea45aa7e34b89ff2fdf90aec46e1a048fed546ea78192471ce05018546845434821c952f76be36951
+  data.tar.gz: 29ca02ed84c008bf2adad2ee75d2d02562d398ef976bf5f00b0c4f30ca3ddb3a4475c7ba1e5d6eb1a7d3de0f6628421dc1b7b83bc902506440d417da4b7a8078

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-buildkite-analytics (0.5.0)
+    rspec-buildkite-analytics (0.7.0)
       activesupport (>= 5.2, <= 7.0)
       rspec-core (~> 3.10)
       rspec-expectations (~> 3.10)
@@ -10,17 +10,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    i18n (1.8.11)
+    i18n (1.9.1)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -38,7 +37,6 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     websocket (1.2.9)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby

data/lib/rspec/buildkite/analytics/ci.rb

@@ -14,13 +14,17 @@ module RSpec::Buildkite::Analytics::CI
         "number" => ENV["BUILDKITE_BUILD_NUMBER"],
         "job_id" => ENV["BUILDKITE_JOB_ID"],
         "message" => ENV["BUILDKITE_MESSAGE"],
-        "debug" => ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"]
+        "debug" => ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"],
+        "version" => RSpec::Buildkite::Analytics::VERSION,
+        "collector" => RSpec::Buildkite::Analytics::NAME
       }
     else
       {
         "CI" => nil,
         "key" => SecureRandom.uuid,
-        "debug" => ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"]
+        "debug" => ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"],
+        "version" => RSpec::Buildkite::Analytics::VERSION,
+        "collector" => RSpec::Buildkite::Analytics::NAME
       }
     end
   end

data/lib/rspec/buildkite/analytics/reporter.rb

@@ -18,6 +18,7 @@ module RSpec::Buildkite::Analytics
 
       if trace
         trace.example = example
+        trace.failure_reason, trace.failure_expanded = failure_info(notification) if example.execution_result.status == :failed
         RSpec::Buildkite::Analytics.session&.write_result(trace)
       end
     end
@@ -45,9 +46,59 @@ module RSpec::Buildkite::Analytics
         end
       end
     end
- 
+
     alias_method :example_passed, :handle_example
     alias_method :example_failed, :handle_example
     alias_method :example_pending, :handle_example
+
+    private
+
+    MULTIPLE_ERRORS = [
+      RSpec::Expectations::MultipleExpectationsNotMetError,
+      RSpec::Core::MultipleExceptionError
+    ]
+
+    def failure_info(notification)
+      failure_expanded = []
+
+      if RSpec::Buildkite::Analytics::Reporter::MULTIPLE_ERRORS.include?(notification.exception.class)
+        failure_reason = notification.exception.summary
+        notification.exception.all_exceptions.each do |exception|
+          # an example with multiple failures doesn't give us a
+          # separate message lines and backtrace object to send, so
+          # I've reached into RSpec internals and duplicated the
+          # construction of these
+          message_lines = RSpec::Core::Formatters::ExceptionPresenter.new(exception, notification.example).colorized_message_lines
+
+          failure_expanded << {
+            expanded: format_message_lines(message_lines),
+            backtrace:  RSpec.configuration.backtrace_formatter.format_backtrace(exception.backtrace)
+          }
+        end
+      else
+        message_lines = notification.colorized_message_lines
+        failure_reason = strip_diff_colors(message_lines.shift)
+
+        failure_expanded << {
+          expanded:  format_message_lines(message_lines),
+          backtrace: notification.formatted_backtrace
+        }
+      end
+
+      return failure_reason, failure_expanded
+    end
+
+    def format_message_lines(message_lines)
+      message_lines.map! { |l| strip_diff_colors(l) }
+      # the first line is sometimes blank, depending on the error reported
+      message_lines.shift if message_lines.first.blank?
+      # the last line is sometimes blank, depending on the error reported
+      message_lines.pop if message_lines.last.blank?
+      message_lines
+    end
+
+    def strip_diff_colors(string)
+      string.gsub(/\e\[([;\d]+)?m/, '')
+    end
   end
 end

data/lib/rspec/buildkite/analytics/session.rb

@@ -52,9 +52,22 @@ module RSpec::Buildkite::Analytics
 
       @logger = Logger.new
 
-      connect
-    rescue TimeoutError, InitialConnectionFailure => e
-      $stderr.puts "rspec-buildkite-analytics could not establish an initial connection with Buildkite due to #{e.message}. You may be missing some data for this test suite, please contact support."
+      reconnection_count = 0
+
+      begin
+        reconnection_count += 1
+        connect
+      rescue TimeoutError, InitialConnectionFailure => e
+        @logger.write("rspec-buildkite-analytics could not establish an initial connection with Buildkite due to #{e}. Attempting retry #{reconnection_count} of #{MAX_RECONNECTION_ATTEMPTS}...")
+        if reconnection_count > MAX_RECONNECTION_ATTEMPTS
+          $stderr.puts "rspec-buildkite-analytics could not establish an initial connection with Buildkite due to #{e.message} after #{MAX_RECONNECTION_ATTEMPTS} attempts. You may be missing some data for this test suite, please contact support if this issue persists."
+        else
+          sleep(WAIT_BETWEEN_RECONNECTIONS)
+          @logger.write("retrying reconnection")
+          retry
+        end
+      end
+      init_write_thread
     end
 
     def disconnected(connection)
@@ -76,7 +89,8 @@ module RSpec::Buildkite::Analytics
         begin
           reconnection_count += 1
           connect
-        rescue SocketConnection::HandshakeError, RejectedSubscription, TimeoutError, SocketConnection::SocketError => e
+          init_write_thread
+        rescue SocketConnection::HandshakeError, RejectedSubscription, TimeoutError, InitialConnectionFailure, SocketConnection::SocketError => e
           @logger.write("failed reconnection attempt #{reconnection_count} due to #{e}")
           if reconnection_count > MAX_RECONNECTION_ATTEMPTS
             $stderr.puts "rspec-buildkite-analytics experienced a disconnection and could not reconnect to Buildkite due to #{e.message}. Please contact support."
@@ -170,8 +184,10 @@ module RSpec::Buildkite::Analytics
       wait_for_confirm
 
       @logger.write("connected")
+    end
 
-      # As this connect method can be called multiple times in the
+    def init_write_thread
+      # As this method can be called multiple times in the
       # reconnection process, kill prev write threads (if any) before
       # setting up the new one
       @write_thread&.kill

data/lib/rspec/buildkite/analytics/tracer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/hash/indifferent_access"
+
 module RSpec::Buildkite::Analytics
   class Tracer
     class Span

data/lib/rspec/buildkite/analytics/uploader.rb

@@ -22,22 +22,15 @@ require "securerandom"
 module RSpec::Buildkite::Analytics
   class Uploader
     class Trace
-      attr_accessor :example
+      attr_accessor :example, :failure_reason, :failure_expanded
       attr_reader :id, :history
 
       def initialize(example, history)
         @id = SecureRandom.uuid
         @example = example
         @history = history
-      end
-
-      def failure_message
-        case example.exception
-        when RSpec::Expectations::ExpectationNotMetError
-          example.exception.message
-        when Exception
-          "#{example.exception.class}: #{example.exception.message}"
-        end
+        @failure_reason = nil
+        @failure_expanded = []
       end
 
       def result_state
@@ -57,9 +50,10 @@ module RSpec::Buildkite::Analytics
           location: example.location,
           file_name: generate_file_name(example),
           result: result_state,
-          failure: failure_message,
+          failure_reason: failure_reason,
+          failure_expanded: failure_expanded,
           history: history,
-        }.with_indifferent_access
+        }.with_indifferent_access.compact
       end
 
       private
@@ -121,7 +115,8 @@ module RSpec::Buildkite::Analytics
               "Content-Type" => "application/json",
             })
             contact.body = {
-              run_env: CI.env
+              run_env: CI.env,
+              format: "websocket"
             }.to_json
 
             response = begin
@@ -130,6 +125,8 @@ module RSpec::Buildkite::Analytics
               puts "Buildkite Test Analytics: Error communicating with the server: #{e.message}"
             end
 
+            return unless response
+
             case response.code
             when "401"
               puts "Buildkite Test Analytics: Invalid Suite API key. Please double check your Suite API key."

data/lib/rspec/buildkite/analytics/version.rb

@@ -3,7 +3,8 @@
 module RSpec
   module Buildkite
     module Analytics
-      VERSION = "0.5.0"
+      VERSION = "0.7.0"
+      NAME = "rspec-buildkite"
     end
   end
 end

data/lib/rspec/buildkite/analytics.rb

@@ -30,4 +30,10 @@ module RSpec::Buildkite::Analytics
 
     self::Uploader.configure
   end
+
+  def self.annotate(content)
+    tracer = RSpec::Buildkite::Analytics::Uploader.tracer
+    tracer&.enter("annotation", **{ content: content })
+    tracer&.leave
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-buildkite-analytics
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Buildkite
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,7 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description:
+description: 
 email:
 - hello@buildkite.com
 executables: []
@@ -106,7 +106,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/buildkite/rspec-buildkite-analytics
   source_code_uri: https://github.com/buildkite/rspec-buildkite-analytics
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Track execution of specs and report to Buildkite Analytics
 test_files: []