instrumental_agent 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5faedb2800827d3604f4a6c0b13bd33234d55ec
-  data.tar.gz: a0115cc25b12d9749dcfeef580bfb26734001e21
+  metadata.gz: 32d9f3dab94080e4c8194ab8c71e0ddf4d83bb8a
+  data.tar.gz: fa78452258ca2f450d5a6da975a5c1d0a114902a
 SHA512:
-  metadata.gz: 282bb711342714bdb4be0a1afec481f39bb6fd9fce58f001a9ba662ae10e17ddade912743b85bcf87a8f026b8db0c873d420e9ecffcb213cb5e047a018794886
-  data.tar.gz: a3114f1773d7442e74d9775906324eb8717ad799980668e0dc0be7a1f754196c34331f9859603249c115f748a7934248762329f275f6022135837019524d8f5d
+  metadata.gz: 5174c7be573fab85d465dc2a6db07d35a62b7bcae160668fc4182da5fefc795930911392c556fa71af0a210723a5534c8548305f2de74c1ccbaae40d535ae448
+  data.tar.gz: 69d4ad769e79161afa6d0c915c9a2b21835a010fc5452a975cfa438484f61906e4474e366c845ce1f46443b3effeba6b737c2f738dfaadfad9a7441604fc05f6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 1.0.1 [July 12, 2016]
+* Make agent initialization threadsafe
+
 ### 1.0.0 [May 13, 2016]
 * No significant code changes
 

data/lib/instrumental/agent.rb

@@ -77,6 +77,8 @@ module Instrumental
       @certs           = certificates
       @dns_resolutions = 0
       @last_connect_at = 0
+      @start_worker_mutex = Mutex.new
+      @queue = Queue.new
 
       setup_cleanup_at_exit if @enabled
     end
@@ -287,7 +289,7 @@ module Instrumental
       cmd = "%s %s\n" % [cmd, args.collect { |a| a.to_s }.join(" ")]
       if enabled?
 
-        start_connection_worker if !running?
+        start_connection_worker
         if @queue && @queue.size < MAX_BUFFER
           @queue_full_warning = false
           logger.debug "Queueing: #{cmd.chomp}"
@@ -365,9 +367,15 @@ module Instrumental
     end
 
     def start_connection_worker
-      if enabled?
+      # NOTE: We need a mutex around both `running?` and thread creation,
+      # otherwise we could create two threads.
+      # Return early and queue the message if another thread is
+      # starting the worker.
+      return if !@start_worker_mutex.try_lock
+      begin
+        return if running?
+        return unless enabled?
         disconnect
-        @queue ||= Queue.new
         address = ipv4_address_for_host(@host, @port)
         if address
           @pid = Process.pid
@@ -379,6 +387,8 @@ module Instrumental
             run_worker_loop
           end
         end
+      ensure
+        @start_worker_mutex.unlock
       end
     end
 

data/lib/instrumental/version.rb

@@ -1,3 +1,3 @@
 module Instrumental
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/agent_spec.rb

@@ -235,6 +235,25 @@ shared_examples "Instrumental Agent" do
         end
       end
 
+      it "shouldn't start multiple background threads" do
+        # Force a wait that would cause a race condition
+        allow(agent).to receive(:disconnect) {
+          sleep 1
+        }
+
+        run_worker_loop_calls = 0
+        allow(agent).to receive(:run_worker_loop) {
+          run_worker_loop_calls += 1
+          sleep 3 # keep the worker thread alive
+        }
+
+        t = Thread.new { agent.increment("race") }
+        agent.increment("race")
+        wait(2)
+        expect(run_worker_loop_calls).to eq(1)
+        expect(agent.queue.size).to eq(2)
+      end
+
       it "should never let an exception reach the user" do
         expect(agent).to receive(:send_command).twice { raise(Exception.new("Test Exception")) }
         expect(agent.increment('throws_exception', 2)).to eq(nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instrumental_agent
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Elijah Miller
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry