rspec-buildkite-analytics 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 852e10cf6b6c63174c82c06f3f5f249b9093fc666582041b01a5fa44d1bdc421
-  data.tar.gz: f88e00ffe339bb34f9edd90d6503e61ec308af5387e19d85b9bc790c076edf49
+  metadata.gz: 44dd3ce4c2f47452f1eb52c96a2b86a7f49dd971d38350152b773dd343a85969
+  data.tar.gz: 81fad9923f72c5a4e733b9e93917323c1037a6a0fa9ba4c0f76e9c3d0820f06b
 SHA512:
-  metadata.gz: 4a9c3b5d0c9b19cd2c8b5e5614ed38cc799f34852c6f6d551be4da788a009137e181015d67a27cd602c1c81b34e84d5ac108b076ff2365c4d153c66388b63f64
-  data.tar.gz: d6ce7ee6ed3988f12fe93c92a1ee3280c39d353b7c741f43423e42acba05f4c52c7da6e3bae772bbc3f0dc3ceec3bb51d4c8e0c187255f8bda98541b6516400d
+  metadata.gz: 6eb38e960fa8c7c8e6b4ff29070d188db20f0868c316a7b2b51051cd733793c8c86ea736385ddefa3eab04afb585d20ebef5fcf3bb7d3a2ee62513d9dcf448d5
+  data.tar.gz: dec76a5f780c47f7f340b83501450545ccd810dbf9b0c43755d4fff300197da750b9411a49eb757f41a094d7058780a78f7a6d859fef34514105be6e97fd8765

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-buildkite-analytics (0.3.3)
+    rspec-buildkite-analytics (0.4.0)
       activesupport (>= 5.2, <= 7.0)
       rspec-core (~> 3.10)
       rspec-expectations (~> 3.10)
@@ -38,7 +38,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     websocket (1.2.9)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -49,4 +49,4 @@ DEPENDENCIES
   rspec-buildkite-analytics!
 
 BUNDLED WITH
-   2.2.20
+   2.2.22

data/README.md

@@ -15,10 +15,7 @@ end
 
 Configure your API key:
 ```ruby
-RSpec::Buildkite::Analytics.configure do |config|
-  config.suite_key = "........"
-  # other config
-end
+RSpec::Buildkite::Analytics.configure(token: "........")
 ```
 
 Run bundler to install the gem and update your `Gemfile.lock`:

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

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

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

@@ -1,6 +1,8 @@
 module RSpec::Buildkite::Analytics
   class Reporter
-    RSpec::Core::Formatters.register self, :example_passed, :example_failed, :example_pending
+    RSpec::Core::Formatters.register self, :example_passed, :example_failed, :example_pending, :dump_summary
+
+    attr_reader :output
 
     def initialize(output)
       @output = output
@@ -18,6 +20,30 @@ module RSpec::Buildkite::Analytics
       end
     end
 
+    def dump_summary(notification)
+      if RSpec::Buildkite::Analytics.session.present?
+        examples_count = {
+          examples: notification.examples.count,
+          failed: notification.failed_examples.count,
+          pending: notification.pending_examples.count,
+          errors_outside_examples: notification.errors_outside_of_examples_count
+        }
+
+        RSpec::Buildkite::Analytics.session.close(examples_count)
+
+        # Write the debug file, if debug mode is enabled
+        if RSpec::Buildkite::Analytics.debug_enabled
+          filename = "#{RSpec::Buildkite::Analytics.debug_filepath}/bk-analytics-#{DateTime.current.strftime("%F-%R:%S")}-#{ENV["BUILDKITE_JOB_ID"]}.log.gz"
+
+          File.open(filename, "wb") do |f|
+            gz = Zlib::GzipWriter.new(f)
+            gz.puts(RSpec::Buildkite::Analytics.session.logger.to_array)
+            gz.close
+          end
+        end
+      end
+    end
+ 
     alias_method :example_passed, :handle_example
     alias_method :example_failed, :handle_example
     alias_method :example_pending, :handle_example

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

@@ -10,6 +10,29 @@ module RSpec::Buildkite::Analytics
     WAIT_BETWEEN_RECONNECTIONS = 5
 
     class RejectedSubscription < StandardError; end
+    class InitialConnectionFailure < StandardError; end
+
+    class Logger
+      def initialize
+        @log = Queue.new
+      end
+
+      def write(str)
+        @log << "#{Time.now.strftime("%F-%R:%S.%9N")} #{Thread.current} #{str}"
+      end
+
+      def to_array
+        # This empty check is important cos calling pop on a Queue is blocking until
+        # it's not empty
+        if @log.empty?
+          []
+        else
+          Array.new(@log.size) { @log.pop }
+        end
+      end
+    end
+
+    attr_reader :logger
 
     def initialize(url, authorization_header, channel)
       @queue = Queue.new
@@ -24,9 +47,11 @@ module RSpec::Buildkite::Analytics
       @url = url
       @authorization_header = authorization_header
 
+      @logger = Logger.new
+
       connect
-    rescue TimeoutError => e
-      $stderr.puts "rspec-buildkite-analytics could not establish an initial connection with Buildkite. Please contact support."
+    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."
     end
 
     def disconnected(connection)
@@ -42,16 +67,19 @@ module RSpec::Buildkite::Analytics
         # time the mutex is released, the value of @connection has been refreshed, and so
         # the second thread returns early and does not reattempt the reconnection.
         return unless connection == @connection
+        @logger.write("starting reconnection")
 
         begin
           reconnection_count += 1
           connect
         rescue SocketConnection::HandshakeError, RejectedSubscription, TimeoutError, 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."
             raise e
           else
             sleep(WAIT_BETWEEN_RECONNECTIONS)
+            @logger.write("retrying reconnection")
             retry
           end
         end
@@ -59,8 +87,10 @@ module RSpec::Buildkite::Analytics
       retransmit
     end
 
-    def close()
+    def close(examples_count)
       @closing = true
+      @examples_count = examples_count
+      @logger.write("closing socket connection")
 
       # Because the server only sends us confirmations after every 10mb of
       # data it uploads to S3, we'll never get confirmation of the
@@ -69,6 +99,7 @@ module RSpec::Buildkite::Analytics
       send_eot
 
       @idents_mutex.synchronize do
+        @logger.write("waiting for last confirm")
         # Here, we sleep for 75 seconds while waiting for the server to confirm the last idents.
         # We are woken up when the unconfirmed_idents is empty, and given back the mutex to
         # continue operation.
@@ -77,6 +108,7 @@ module RSpec::Buildkite::Analytics
 
       # Then we always disconnect cos we can't wait forever? 🤷‍♀️
       @connection.close
+      @logger.write("socket connection closed")
     end
 
     def handle(_connection, data)
@@ -85,11 +117,14 @@ module RSpec::Buildkite::Analytics
       when "ping"
         # In absence of other message, the server sends us a ping every 3 seconds
         # We are currently not doing anything with these
+        @logger.write("received ping")
       when "welcome", "confirm_subscription"
         # Push these two messages onto the queue, so that we block on waiting for the
         # initializing phase to complete
         @queue.push(data)
+      @logger.write("received #{data['type']}")
       when "reject_subscription"
+        @logger.write("received rejected_subscription")
         raise RejectedSubscription
       else
         process_message(data)
@@ -102,6 +137,8 @@ module RSpec::Buildkite::Analytics
       add_unconfirmed_idents(result.id, result_as_json)
 
       transmit_results([result_as_json])
+
+      @logger.write("transmitted #{result.id}")
     end
 
     def unconfirmed_idents_count
@@ -124,6 +161,8 @@ module RSpec::Buildkite::Analytics
     end
 
     def connect
+      @logger.write("starting socket connection process")
+
       @connection = SocketConnection.new(self, @url, {
         "Authorization" => @authorization_header,
       })
@@ -136,27 +175,29 @@ module RSpec::Buildkite::Analytics
       })
 
       wait_for_confirm
+
+      @logger.write("connected")
     end
 
-    def pop_with_timeout
-      Timeout.timeout(30, RSpec::Buildkite::Analytics::TimeoutError, "Waited 30 seconds") do
+    def pop_with_timeout(message_type)
+      Timeout.timeout(30, RSpec::Buildkite::Analytics::TimeoutError, "Timeout: Waited 30 seconds for #{message_type}") do
         @queue.pop
       end
     end
 
     def wait_for_welcome
-      welcome = pop_with_timeout
+      welcome = pop_with_timeout("welcome")
 
       if welcome && welcome != { "type" => "welcome" }
-        raise "Not a welcome: #{welcome.inspect}"
+        raise InitialConnectionFailure.new("Wrong message received, expected a welcome, but received: #{welcome.inspect}")
       end
     end
 
     def wait_for_confirm
-      confirm = pop_with_timeout
+      confirm = pop_with_timeout("confirm")
 
       if confirm && confirm != { "type" => "confirm_subscription", "identifier" => @channel }
-        raise "Not a confirm: #{confirm.inspect}"
+        raise InitialConnectionFailure.new("Wrong message received, expected a confirm, but received: #{confirm.inspect}")
       end
     end
 
@@ -173,6 +214,8 @@ module RSpec::Buildkite::Analytics
         # Remove received idents from unconfirmed_idents
         idents.each { |key| @unconfirmed_idents.delete(key) }
 
+        @logger.write("received confirm for indentifiers: #{idents.join(", ")}")
+
         # This @empty ConditionVariable broadcasts every time that @unconfirmed_idents is
         # empty, which will happen about every 10mb of data as that's when the server
         # sends back confirmations.
@@ -190,9 +233,12 @@ module RSpec::Buildkite::Analytics
         "identifier" => @channel,
         "command" => "message",
         "data" => {
-          "action" => "end_of_transmission"
+          "action" => "end_of_transmission",
+          "examples_count" => @examples_count.to_json
         }.to_json
       })
+
+      @logger.write("transmitted EOT")
     end
 
     def process_message(data)
@@ -204,6 +250,7 @@ module RSpec::Buildkite::Analytics
         remove_unconfirmed_idents(data["message"]["confirm"])
       else
         # unhandled message
+        @logger.write("received unhandled message #{data["message"]}")
       end
     end
 
@@ -213,7 +260,11 @@ module RSpec::Buildkite::Analytics
       end
 
       # send the contents of the buffer, unless it's empty
-      transmit_results(data) unless data.empty?
+      unless data.empty?
+        @logger.write("retransmitting data")
+        transmit_results(data)
+      end
+
       # if we were disconnected in the closing phase, then resend the EOT
       # message so the server can persist the last upload part
       send_eot if @closing

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

@@ -66,6 +66,7 @@ module RSpec::Buildkite::Analytics
       # Setting up a new thread that listens on the socket, and processes incoming
       # comms from the server
       @thread = Thread.new do
+        @session.logger.write("listening in on socket")
         frame = WebSocket::Frame::Incoming::Client.new
 
         while @socket
@@ -75,13 +76,28 @@ module RSpec::Buildkite::Analytics
             @session.handle(self, data.data)
           end
         end
-      rescue EOFError
+      rescue EOFError, Errno::ECONNRESET => e
+        @session.logger.write("#{e}")
         if @socket
+          @session.logger.write("attempting disconnected flow")
           @session.disconnected(self)
           disconnect
         end
       rescue IOError
         # This is fine to ignore
+        @session.logger.write("IOError")
+      rescue IndexError
+        # I don't like that we're doing this but I think it's the best of the options
+        #
+        # This relates to this issue https://github.com/ruby/openssl/issues/452
+        # A fix for it has been released but the repercussions of overriding
+        # the OpenSSL version in the stdlib seem worse than catching this error here.
+        @session.logger.write("IndexError")
+        if @socket
+          @session.logger.write("attempting disconnected flow")
+          @session.disconnected(self)
+          disconnect
+        end
       end
     end
 
@@ -92,13 +108,27 @@ module RSpec::Buildkite::Analytics
       raw_data = data.to_json
       frame = WebSocket::Frame::Outgoing::Client.new(data: raw_data, type: :text, version: @version)
       @socket.write(frame.to_s)
-    rescue Errno::EPIPE, OpenSSL::SSL::SSLError => e
+    rescue Errno::EPIPE, Errno::ECONNRESET, OpenSSL::SSL::SSLError => e
       return unless @socket
+      @session.logger.write("got #{e}, attempting disconnected flow")
       @session.disconnected(self)
       disconnect
+    rescue IndexError
+      # I don't like that we're doing this but I think it's the best of the options
+      #
+      # This relates to this issue https://github.com/ruby/openssl/issues/452
+      # A fix for it has been released but the repercussions of overriding
+      # the OpenSSL version in the stdlib seem worse than catching this error here.
+      @session.logger.write("IndexError")
+      if @socket
+        @session.logger.write("attempting disconnected flow")
+        @session.disconnected(self)
+        disconnect
+      end
     end
 
     def close
+      @session.logger.write("socket close")
       transmit(nil, type: :close)
       disconnect
     end
@@ -106,6 +136,7 @@ module RSpec::Buildkite::Analytics
     private
 
     def disconnect
+      @session.logger.write("socket disconnect")
       socket = @socket
       @socket = nil
       socket&.close

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

@@ -65,7 +65,7 @@ module RSpec::Buildkite::Analytics
       private
 
       def generate_file_name(example)
-        file_path_regex = /^(.*?\.rb)/
+        file_path_regex = /^(.*?\.(rb|feature))/
         identifier_file_name = example.id[file_path_regex]
         location_file_name = example.location[file_path_regex]
 
@@ -127,12 +127,12 @@ module RSpec::Buildkite::Analytics
             response = begin
               http.request(contact)
             rescue *REQUEST_EXCEPTIONS => e
-              puts "Error communicating with the server: #{e.message}"
+              puts "Buildkite Test Analytics: Error communicating with the server: #{e.message}"
             end
 
             case response.code
             when "401"
-              puts "Invalid Suite API key. Please double check your Suite API key."
+              puts "Buildkite Test Analytics: Invalid Suite API key. Please double check your Suite API key."
             when "200"
               json = JSON.parse(response.body)
 
@@ -141,10 +141,10 @@ module RSpec::Buildkite::Analytics
               end
             else
               request_id = response.to_hash["x-request-id"]
-              puts "Unknown error. If this error persists, please contact support+analytics@buildkite.com with this request ID `#{request_id}`."
+              puts "Buildkite Test Analytics: Unknown error. If this error persists, please contact support+analytics@buildkite.com with this request ID `#{request_id}`."
             end
           else
-            puts "No Suite API key provided. You can get the API key from your Suite settings page."
+            puts "Buildkite Test Analytics: No Suite API key provided. You can get the API key from your Suite settings page."
           end
         end
 
@@ -162,12 +162,6 @@ module RSpec::Buildkite::Analytics
           trace = RSpec::Buildkite::Analytics::Uploader::Trace.new(example, tracer.history)
           RSpec::Buildkite::Analytics.uploader.traces << trace
         end
-
-        config.after(:suite) do
-          # This needs the lonely operater as the session will be nil
-          # if auth against the API token fails
-          RSpec::Buildkite::Analytics.session&.close
-        end
       end
 
       RSpec::Buildkite::Analytics::Network.configure

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

@@ -3,7 +3,7 @@
 module RSpec
   module Buildkite
     module Analytics
-      VERSION = "0.3.3"
+      VERSION = "0.4.0"
     end
   end
 end

data/lib/rspec/buildkite/analytics.rb

@@ -15,11 +15,15 @@ module RSpec::Buildkite::Analytics
     attr_accessor :url
     attr_accessor :uploader
     attr_accessor :session
+    attr_accessor :debug_enabled
+    attr_accessor :debug_filepath
   end
 
-  def self.configure(token: nil, url: nil)
+  def self.configure(token: nil, url: nil, debug_enabled: false, debug_filepath: nil)
     self.api_token = token || ENV["BUILDKITE_ANALYTICS_TOKEN"]
     self.url = url || DEFAULT_URL
+    self.debug_enabled = debug_enabled || !!(ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"])
+    self.debug_filepath = debug_filepath || ENV["BUILDKITE_ANALYTICS_DEBUG_FILEPATH"]
 
     require_relative "analytics/uploader"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-buildkite-analytics
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Track execution of specs and report to Buildkite Analytics