rspec-buildkite-analytics 0.3.2 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37d48ebe43bb1567f3ef7d837fd5148b7e8d712409e5f44aa2721dffa930063e
-  data.tar.gz: 531c7bc7bce5cc4a3961e1aa8670f130c0e000a4a8ceda9eaba8cb9bfd0a88c8
+  metadata.gz: a81e9b877577590dbb59202d72db1ee309a25be50c69e45361a0515cbfed1e5a
+  data.tar.gz: 172a76b3343c2f460013c47b3893f7667aa3e965effde4b370fcf058ee0e3dbf
 SHA512:
-  metadata.gz: ee10200839cdfa840fa4e6c980cda83593cecf91c0419f454f3d3e32047374888f03fc782b1caf0bfeded18421f2e4b989a648fb4a262748df484d647629b61d
-  data.tar.gz: f5ed0798c9b89911cd81eab64ba600921b286693a01067676c8de86e14d01927340bcbef4635b3fb9882803710592491f6fd8075757a744f82fae73be7059d7d
+  metadata.gz: 471c20607b1dd61c55bfb1244ca8a5d95c3f30b4f3a26fbd9bf1912d11af3d3e7841762b077472dbc5b0fe3dc647771008a6e68cb5a4f85296a1f41b765ae4f2
+  data.tar.gz: 16145862ef9c26a3132eead4ea6bf11323effe8b6f5bc32140cce966544d508d8a4d83a64e809814d35c71add64102d8e23f7175f02d9f914839381efddc85b8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-buildkite-analytics (0.3.2)
+    rspec-buildkite-analytics (0.3.6)
       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

@@ -4,15 +4,22 @@ require "securerandom"
 
 module RSpec::Buildkite::Analytics::CI
   def self.env
-    env = {
-      "CI" => ENV["BUILDKITE"] ? "buildkite" : nil,
-      "key" => ENV["BUILDKITE_BUILD_ID"] || SecureRandom.uuid,
-      "url" => ENV["BUILDKITE_BUILD_URL"],
-      "branch" => ENV["BUILDKITE_BRANCH"],
-      "commit_sha" => ENV["BUILDKITE_COMMIT"],
-      "number" => ENV["BUILDKITE_BUILD_NUMBER"],
-      "job_id" => ENV["BUILDKITE_JOB_ID"],
-      "message" => ENV["BUILDKITE_MESSAGE"]
-    }
+    if ENV["BUILDKITE_BUILD_ID"]
+      {
+        "CI" => "buildkite",
+        "key" => ENV["BUILDKITE_BUILD_ID"],
+        "url" => ENV["BUILDKITE_BUILD_URL"],
+        "branch" => ENV["BUILDKITE_BRANCH"],
+        "commit_sha" => ENV["BUILDKITE_COMMIT"],
+        "number" => ENV["BUILDKITE_BUILD_NUMBER"],
+        "job_id" => ENV["BUILDKITE_JOB_ID"],
+        "message" => ENV["BUILDKITE_MESSAGE"]
+      }
+    else
+      {
+        "CI" => nil,
+        "key" => SecureRandom.uuid
+      }
+    end
   end
 end

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

@@ -2,6 +2,8 @@ module RSpec::Buildkite::Analytics
   class Reporter
     RSpec::Core::Formatters.register self, :example_passed, :example_failed, :example_pending
 
+    attr_reader :output
+
     def initialize(output)
       @output = output
     end

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

@@ -10,6 +10,7 @@ module RSpec::Buildkite::Analytics
     WAIT_BETWEEN_RECONNECTIONS = 5
 
     class RejectedSubscription < StandardError; end
+    class InitialConnectionFailure < StandardError; end
 
     def initialize(url, authorization_header, channel)
       @queue = Queue.new
@@ -25,8 +26,8 @@ module RSpec::Buildkite::Analytics
       @authorization_header = authorization_header
 
       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)
@@ -138,25 +139,25 @@ module RSpec::Buildkite::Analytics
       wait_for_confirm
     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
 

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

@@ -75,13 +75,23 @@ module RSpec::Buildkite::Analytics
             @session.handle(self, data.data)
           end
         end
-      rescue EOFError
+      rescue EOFError, Errno::ECONNRESET
         if @socket
           @session.disconnected(self)
           disconnect
         end
       rescue IOError
         # This is fine to ignore
+      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.
+        if @socket
+          @session.disconnected(self)
+          disconnect
+        end
       end
     end
 
@@ -92,10 +102,20 @@ 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.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.
+      if @socket
+        @session.disconnected(self)
+        disconnect
+      end
     end
 
     def 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
 

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

@@ -3,7 +3,7 @@
 module RSpec
   module Buildkite
     module Analytics
-      VERSION = "0.3.2"
+      VERSION = "0.3.6"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-buildkite-analytics
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.6
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-06 00:00:00.000000000 Z
+date: 2021-10-29 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