rspec-buildkite-analytics 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a81e9b877577590dbb59202d72db1ee309a25be50c69e45361a0515cbfed1e5a
-  data.tar.gz: 172a76b3343c2f460013c47b3893f7667aa3e965effde4b370fcf058ee0e3dbf
+  metadata.gz: 44dd3ce4c2f47452f1eb52c96a2b86a7f49dd971d38350152b773dd343a85969
+  data.tar.gz: 81fad9923f72c5a4e733b9e93917323c1037a6a0fa9ba4c0f76e9c3d0820f06b
 SHA512:
-  metadata.gz: 471c20607b1dd61c55bfb1244ca8a5d95c3f30b4f3a26fbd9bf1912d11af3d3e7841762b077472dbc5b0fe3dc647771008a6e68cb5a4f85296a1f41b765ae4f2
-  data.tar.gz: 16145862ef9c26a3132eead4ea6bf11323effe8b6f5bc32140cce966544d508d8a4d83a64e809814d35c71add64102d8e23f7175f02d9f914839381efddc85b8
+  metadata.gz: 6eb38e960fa8c7c8e6b4ff29070d188db20f0868c316a7b2b51051cd733793c8c86ea736385ddefa3eab04afb585d20ebef5fcf3bb7d3a2ee62513d9dcf448d5
+  data.tar.gz: dec76a5f780c47f7f340b83501450545ccd810dbf9b0c43755d4fff300197da750b9411a49eb757f41a094d7058780a78f7a6d859fef34514105be6e97fd8765

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-buildkite-analytics (0.3.6)
+    rspec-buildkite-analytics (0.4.0)
       activesupport (>= 5.2, <= 7.0)
       rspec-core (~> 3.10)
       rspec-expectations (~> 3.10)

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,6 @@
 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
 
@@ -20,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

@@ -12,6 +12,28 @@ module RSpec::Buildkite::Analytics
     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
       @channel = channel
@@ -25,6 +47,8 @@ module RSpec::Buildkite::Analytics
       @url = url
       @authorization_header = authorization_header
 
+      @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."
@@ -43,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
@@ -60,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
@@ -70,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.
@@ -78,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)
@@ -86,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)
@@ -103,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
@@ -125,6 +161,8 @@ module RSpec::Buildkite::Analytics
     end
 
     def connect
+      @logger.write("starting socket connection process")
+
       @connection = SocketConnection.new(self, @url, {
         "Authorization" => @authorization_header,
       })
@@ -137,6 +175,8 @@ module RSpec::Buildkite::Analytics
       })
 
       wait_for_confirm
+
+      @logger.write("connected")
     end
 
     def pop_with_timeout(message_type)
@@ -174,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.
@@ -191,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)
@@ -205,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
 
@@ -214,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,20 +76,25 @@ module RSpec::Buildkite::Analytics
             @session.handle(self, data.data)
           end
         end
-      rescue EOFError, Errno::ECONNRESET
+      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
@@ -104,6 +110,7 @@ module RSpec::Buildkite::Analytics
       @socket.write(frame.to_s)
     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
@@ -112,13 +119,16 @@ module RSpec::Buildkite::Analytics
       # 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
@@ -126,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

@@ -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.6"
+      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.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport