rspec-buildkite-analytics 0.6.3 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 499229f993ea2f8556a6d908f011325bf989de60c9a69a266338356b9f89426f
-  data.tar.gz: 901fec67b35b6ca85f61900a4cd9fa00293959892eb45e95339b6d4a6c27f527
+  metadata.gz: 4ac283b3f333632c2909b0dd7b35dd1c4f9765d659489c00d8ae93a169433aa8
+  data.tar.gz: eb45c11b5da7a61597b915749f04bb77d46408b764f22cb84dba349ae3fba4f8
 SHA512:
-  metadata.gz: 0b7942d5c6b1abd45ff662cd52878d348bb1f9b3e2fa9fd1a6285eb7f521ac1d1f9dcc52007650dde979da9ddcbdd0506afe869708c785d033f9cf2e969eb009
-  data.tar.gz: c5484d6a416ac0faf663390c64d86e6c24184ddadbaa286b66407afd169444b7af9a6b9e665ead3438e87e719b5563ea0bc184c963643e17b13cdb8d3517ad1c
+  metadata.gz: deb2c39374b9a86cea6ab81b8f81137eb919e78f7d5a5f4ad28fb1cb51dfdbda72f930e71dca67dcd4353860519109627852f52c07238523bc6aeb3b8b83513a
+  data.tar.gz: 64036687b205256d27f656066bdc182b936dcb29daa10f6149ce18972303b4b8140c44ab6db22028cce0a19fd84bab4b59d679f4e8f1471f87f86e0c31fe3a1f

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# CHANGELOG
+
+## v0.8.1
+
+- Improve the EOT confirmation #93 — @blaknite
+
+## v0.8.0
+
+- Support multiple CI platforms and generic env #80 — @blaknite
+- Replace invalid UTF-8 characters in test names #85 — @mariovisic
+- Relax Active Support constraint #87 — @ags

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    rspec-buildkite-analytics (0.6.3)
-      activesupport (>= 5.2, <= 7.0)
+    rspec-buildkite-analytics (0.8.1)
+      activesupport (>= 5.2, < 8)
       rspec-core (~> 3.10)
       rspec-expectations (~> 3.10)
       websocket (~> 1.2)
@@ -10,14 +10,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.0)
+    activesupport (7.0.2.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.4.4)
-    i18n (1.8.11)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     minitest (5.15.0)
     rake (13.0.6)

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

@@ -2,30 +2,85 @@
 
 require "securerandom"
 
-module RSpec::Buildkite::Analytics::CI
+class RSpec::Buildkite::Analytics::CI
   def self.env
-    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"],
-        "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"],
-        "version" => RSpec::Buildkite::Analytics::VERSION,
-        "collector" => RSpec::Buildkite::Analytics::NAME
-      }
-    end
+    new.env
+  end
+
+  # The analytics env are more specific than the automatic ci platform env.
+  # If they've been specified we'll assume the user wants to use that value instead.
+  def env
+    ci_env.merge(analytics_env)
+  end
+
+  private
+
+  def ci_env
+    return buildkite if ENV["BUILDKITE_BUILD_ID"]
+    return github_actions if ENV["GITHUB_RUN_NUMBER"]
+    return circleci if ENV["CIRCLE_BUILD_NUM"]
+    return generic if ENV["CI"]
+
+    {
+      "CI" => nil,
+      "key" => SecureRandom.uuid,
+    }
+  end
+
+  def analytics_env
+    {
+      "key" => ENV["BUILDKITE_ANALYTICS_KEY"],
+      "url" => ENV["BUILDKITE_ANALYTICS_URL"],
+      "branch" => ENV["BUILDKITE_ANALYTICS_BRANCH"],
+      "commit_sha" => ENV["BUILDKITE_ANALYTICS_SHA"],
+      "number" => ENV["BUILDKITE_ANALYTICS_NUMBER"],
+      "job_id" => ENV["BUILDKITE_ANALYTICS_JOB_ID"],
+      "message" => ENV["BUILDKITE_ANANLYTICS_MESSAGE"],
+      "debug" => ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"],
+      "version" => RSpec::Buildkite::Analytics::VERSION,
+      "collector" => RSpec::Buildkite::Analytics::NAME,
+  }.compact
+  end
+
+  def generic
+    {
+      "CI" => "generic",
+      "key" => SecureRandom.uuid,
+    }
+  end
+
+  def buildkite
+    {
+      "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"],
+    }
+  end
+
+  def github_actions
+    {
+      "CI" => "github_actions",
+      "key" => "#{ENV["GITHUB_ACTION"]}-#{ENV["GITHUB_RUN_NUMBER"]}-#{ENV["GITHUB_RUN_ATTEMPT"]}",
+      "url" => File.join("https://github.com", ENV["GITHUB_REPOSITORY"], "actions/runs", ENV["GITHUB_RUN_ID"]),
+      "branch" => ENV["GITHUB_REF"],
+      "commit_sha" => ENV["GITHUB_SHA"],
+      "number" => ENV["GITHUB_RUN_NUMBER"],
+    }
+  end
+
+  def circleci
+    {
+      "CI" => "circleci",
+      "key" => "#{ENV["CIRCLE_WORKFLOW_ID"]}-#{ENV["CIRCLE_BUILD_NUM"]}",
+      "url" => ENV["CIRCLE_BUILD_URL"],
+      "branch" => ENV["CIRCLE_BRANCH"],
+      "commit_sha" => ENV["CIRCLE_SHA1"],
+      "number" => ENV["CIRCLE_BUILD_NUM"],
+    }
   end
 end

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

@@ -5,9 +5,9 @@ require_relative "socket_connection"
 module RSpec::Buildkite::Analytics
   class Session
     # Picked 75 as the magic timeout number as it's longer than the TCP timeout of 60s 🤷‍♀️
-    CONFIRMATION_TIMEOUT = 75
-    MAX_RECONNECTION_ATTEMPTS = 3
-    WAIT_BETWEEN_RECONNECTIONS = 5
+    CONFIRMATION_TIMEOUT = ENV.fetch("BUILDKITE_ANALYTICS_CONFIRMATION_TIMEOUT") { 75 }.to_i
+    MAX_RECONNECTION_ATTEMPTS = ENV.fetch("BUILDKITE_ANALYTICS_RECONNECTION_ATTEMPTS") { 3 }.to_i
+    WAIT_BETWEEN_RECONNECTIONS = ENV.fetch("BUILDKITE_ANALYTICS_RECONNECTION_WAIT") { 5 }.to_i
 
     class RejectedSubscription < StandardError; end
     class InitialConnectionFailure < StandardError; end
@@ -116,20 +116,24 @@ module RSpec::Buildkite::Analytics
       # to which the server will respond with the last bits of data
       send_eot
 
+      # After EOT, we wait for 75 seconds for the send queue to be drained and for the
+      # server to confirm the last idents. If everything has already been confirmed we can
+      # proceed without waiting.
       @idents_mutex.synchronize do
-        @logger.write("waiting for last confirm")
-        # Here, we sleep for 75 seconds while waiting for the send
-        # queue to be drained and 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.
-        @empty.wait(@idents_mutex, CONFIRMATION_TIMEOUT) unless @unconfirmed_idents.empty?
+        if @unconfirmed_idents.any?
+          puts "Waiting for Buildkite Test Analytics to send results..."
+          @logger.write("waiting for last confirm")
+
+          @empty.wait(@idents_mutex, CONFIRMATION_TIMEOUT)
+        end
       end
 
       # Then we always disconnect cos we can't wait forever? 🤷‍♀️
       @connection.close
       # We kill the write thread cos it's got a while loop in it, so it won't finish otherwise
       @write_thread&.kill
+
+      puts "Buildkite Test Analytics completed"
       @logger.write("socket connection closed")
     end
 
@@ -183,6 +187,7 @@ module RSpec::Buildkite::Analytics
 
       wait_for_confirm
 
+      puts "Connected to Buildkite Test Analytics!"
       @logger.write("connected")
     end
 
@@ -255,23 +260,21 @@ module RSpec::Buildkite::Analytics
       @idents_mutex.synchronize do
         @unconfirmed_idents[ident] = result_as_hash
 
-        data = {
+        @send_queue << {
           "action" => "record_results",
           "results" => [result_as_hash]
         }
-
-        @send_queue << data
       end
     end
 
-    def remove_unconfirmed_idents(idents)
-      return if idents.empty?
+    def confirm_idents(idents)
+      retransmit_required = @closing
 
       @idents_mutex.synchronize do
         # Remove received idents from unconfirmed_idents
         idents.each { |key| @unconfirmed_idents.delete(key) }
 
-        @logger.write("received confirm for indentifiers: #{idents.join(", ")}")
+        @logger.write("received confirm for indentifiers: #{idents}")
 
         # 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
@@ -281,23 +284,27 @@ module RSpec::Buildkite::Analytics
         # send the EOT message, so the prior broadcasts shouldn't do anything.
         if @unconfirmed_idents.empty?
           @empty.broadcast
-          @logger.write("broadcast empty")
+
+          retransmit_required = false
+
+          @logger.write("all identifiers have been confirmed")
         else
-          @logger.write("still waiting on confirm for #{@unconfirmed_idents.keys}")
+          @logger.write("still waiting on confirm for identifiers: #{@unconfirmed_idents.keys}")
         end
       end
+
+      # If we're closing, any unconfirmed results need to be retransmitted.
+      retransmit if retransmit_required
     end
 
     def send_eot
       @eot_queued_mutex.synchronize do
         return if @eot_queued
-        # Expect server to respond with data of indentifiers last upload part
-        data = {
+
+        @send_queue << {
           "action" => "end_of_transmission",
           "examples_count" => @examples_count.to_json
         }
-
-        @send_queue << data
         @eot_queued = true
 
         @logger.write("added EOT to send queue")
@@ -310,7 +317,7 @@ module RSpec::Buildkite::Analytics
 
       case
       when data["message"].key?("confirm")
-        remove_unconfirmed_idents(data["message"]["confirm"])
+        confirm_idents(data["message"]["confirm"])
       else
         # unhandled message
         @logger.write("received unhandled message #{data["message"]}")
@@ -322,13 +329,12 @@ module RSpec::Buildkite::Analytics
         results = @unconfirmed_idents.values
 
         # queue the contents of the buffer, unless it's empty
-        unless results.empty?
-          data = {
+        if results.any?
+          @send_queue << {
             "action" => "record_results",
             "results" => results
           }
 
-          @send_queue << data
           @logger.write("queueing up retransmitted results #{@unconfirmed_idents.keys}")
         end
       end

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

@@ -42,7 +42,7 @@ module RSpec::Buildkite::Analytics
       end
 
       def as_hash
-        {
+        strip_invalid_utf8_chars(
           id: @id,
           scope: example.example_group.metadata[:full_description],
           name: example.description,
@@ -53,14 +53,14 @@ module RSpec::Buildkite::Analytics
           failure_reason: failure_reason,
           failure_expanded: failure_expanded,
           history: history,
-        }.with_indifferent_access.compact
+        ).with_indifferent_access.compact
       end
 
       private
 
       def generate_file_name(example)
         file_path_regex = /^(.*?\.(rb|feature))/
-        identifier_file_name = example.id[file_path_regex]
+        identifier_file_name = strip_invalid_utf8_chars(example.id)[file_path_regex]
         location_file_name = example.location[file_path_regex]
 
         if identifier_file_name != location_file_name
@@ -78,6 +78,18 @@ module RSpec::Buildkite::Analytics
           identifier_file_name
         end
       end
+
+      def strip_invalid_utf8_chars(object)
+        if object.is_a?(Hash)
+          Hash[object.map { |key, value| [key, strip_invalid_utf8_chars(value)] }]
+        elsif object.is_a?(Array)
+          object.map { |value| strip_invalid_utf8_chars(value) }
+        elsif object.is_a?(String)
+          object.encode('UTF-8', :invalid => :replace, :undef => :replace)
+        else
+          object
+        end
+      end
     end
 
     def self.traces

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

@@ -3,7 +3,7 @@
 module RSpec
   module Buildkite
     module Analytics
-      VERSION = "0.6.3"
+      VERSION = "0.8.1"
       NAME = "rspec-buildkite"
     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

data/rspec-buildkite-analytics.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  spec.add_dependency "activesupport", ">= 5.2", "<= 7.0"
+  spec.add_dependency "activesupport", ">= 5.2", "< 8"
   spec.add_dependency "rspec-core", '~> 3.10'
   spec.add_dependency "rspec-expectations", '~> 3.10'
   spec.add_dependency "websocket", '~> 1.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-buildkite-analytics
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.8.1
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +81,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Track execution of specs and report to Buildkite Analytics