rspec-buildkite-analytics 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16e763d9b60c9355ce71c372dbb9486802963afce68a134f3224c5a882acea1d
-  data.tar.gz: f359c46b656482c03f0fb6715d286debfc6c834d1737559baf7b9ea7f8bdc1ad
+  metadata.gz: d55751f8e88a6ac7ad250c0c1e2b382dcaeb2d23504aa6d110a22a4a61af8d06
+  data.tar.gz: b21d3d7fe03e1d504870b2d1fba0f188ab94e1f5e1c5c3fa3f11b1536a9f99b1
 SHA512:
-  metadata.gz: 373eec78964085b9309980fa360d748617963c963f1b9ae24b0f2c325a212585b5adfd76d3dd9ce889aefc5502fc7c9ff340c70e2e33e1f76a10f8dc48dba12d
-  data.tar.gz: 34f2b145f7880fe16c2906dd78398a347e56563c879155bcd6c344f1bc35d83538a2f8c86ad3863db6ed73e5a8f73fdba812b938debe3ac4777a67ee0bd4f700
+  metadata.gz: 8bb6efbdc7f9b4f06ab3b0793c9ef5a1c2b41429a755040d0c6b558fbb24b308e59cd862a646b86717bb5bebf4464eec45e3551db043b8332ed37a94b642f789
+  data.tar.gz: 97089293de5331c1329979fd853ff15297e4460aaec7631867e2031398a31603296e53174da6a398134fe7a54bfa9b1e7082817acb989e6f74978a574afae9fc

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    rspec-buildkite-analytics (0.2.0)
-      activesupport
-      rspec-core
-      rspec-expectations
-      websocket
+    rspec-buildkite-analytics (0.3.5)
+      activesupport (>= 5.2, <= 7.0)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      websocket (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -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/lib/rspec/buildkite/analytics/ci.rb

@@ -4,7 +4,7 @@ require "securerandom"
 
 module RSpec::Buildkite::Analytics::CI
   def self.env
-    if ENV["BUILDKITE"]
+    if ENV["BUILDKITE_BUILD_ID"]
       {
         "CI" => "buildkite",
         "key" => ENV["BUILDKITE_BUILD_ID"],

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

@@ -82,6 +82,16 @@ module RSpec::Buildkite::Analytics
         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
 
@@ -96,6 +106,16 @@ module RSpec::Buildkite::Analytics
       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

@@ -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.1"
+      VERSION = "0.3.5"
     end
   end
 end

metadata

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