rspec-buildkite-analytics 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a29588419eb727d74849c54b0d38f5b90974c3f58f083e48958a17288a1dc1fe
-  data.tar.gz: 1fd5fd323f7737c247b61bcd87ea9778e3f020601514eb52777c0ba5871c24aa
+  metadata.gz: 4ac283b3f333632c2909b0dd7b35dd1c4f9765d659489c00d8ae93a169433aa8
+  data.tar.gz: eb45c11b5da7a61597b915749f04bb77d46408b764f22cb84dba349ae3fba4f8
 SHA512:
-  metadata.gz: 45624d6a321c8ff16008e259b4a3eb3f118449d36947f1cb0efb86c7e988ee3e904a2665be517b4be2cd8075d4c1352d8356df88ac43c615664ec28383ced50f
-  data.tar.gz: fdb57102cd80974a01e939e8ab8bc8ae3ce22f39ff5a6862cc7cdc9d5250672a93ff966dfa391e47e80cdfaf70354082f0afd9ca1f6d4e1104edb53dbc11d977
+  metadata.gz: deb2c39374b9a86cea6ab81b8f81137eb919e78f7d5a5f4ad28fb1cb51dfdbda72f930e71dca67dcd4353860519109627852f52c07238523bc6aeb3b8b83513a
+  data.tar.gz: 64036687b205256d27f656066bdc182b936dcb29daa10f6149ce18972303b4b8140c44ab6db22028cce0a19fd84bab4b59d679f4e8f1471f87f86e0c31fe3a1f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v0.8.1
+
+- Improve the EOT confirmation #93 — @blaknite
+
 ## v0.8.0
 
 - Support multiple CI platforms and generic env #80 — @blaknite

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-buildkite-analytics (0.8.0)
+    rspec-buildkite-analytics (0.8.1)
       activesupport (>= 5.2, < 8)
       rspec-core (~> 3.10)
       rspec-expectations (~> 3.10)
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
+    activesupport (7.0.2.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)

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/version.rb

@@ -3,7 +3,7 @@
 module RSpec
   module Buildkite
     module Analytics
-      VERSION = "0.8.0"
+      VERSION = "0.8.1"
       NAME = "rspec-buildkite"
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-buildkite-analytics
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-25 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport