analytics-ruby 0.5.2 → 0.5.3

data/History.md

@@ -1,3 +1,7 @@
+0.5.3 / 2013-12-31
+==================
+* Allow the consumer thread to shut down so it won't remain live in hot deploy scenarios. This fixes the jruby memory leak by [@nirvdrum](https://github.com/nirvdrum)
+
 0.5.2 / 2013-12-02
 ==================
 * adding `sleep` backoff between connection retries
@@ -8,8 +12,7 @@
 
 0.5.0 / 2013-10-03
 ==================
-
-* Removing global Analytics alias in favor of adding it to our config
+* Removing global Analytics alias in favor of adding it to our config. NOTE: If you are upgrading from a previous version and want to continue using the `Analytics` namespace, you'll have to add `Analytics = AnalyticsRuby` to your config. See the [setup docs for more info](https://segment.io/libraries/ruby)
 
 0.4.0 / 2013-08-30
 ==================

data/lib/analytics-ruby/client.rb

@@ -10,6 +10,10 @@ module AnalyticsRuby
 
   class Client
 
+    # Sub-class thread so we have a named thread (useful for debugging in Thread.list).
+    class ConsumerThread < Thread
+    end
+
     # public: Creates a new client
     #
     # options - Hash
@@ -27,7 +31,16 @@ module AnalyticsRuby
       check_secret
 
       @consumer = AnalyticsRuby::Consumer.new @queue, @secret, options
-      @thread = Thread.new { @consumer.run }
+      @thread = ConsumerThread.new { @consumer.run }
+
+      at_exit do
+        # Let the consumer thread know it should exit.
+        @thread[:should_exit] = true
+
+        # Push a flag value to the consumer queue in case it's blocked waiting for a value.  This will allow it
+        # to continue its normal chain of processing, giving it a chance to exit.
+        @queue << nil
+      end
     end
 
     # public: Synchronously waits until the consumer has flushed the queue.

data/lib/analytics-ruby/consumer.rb

@@ -34,7 +34,7 @@ module AnalyticsRuby
     # public: Continuously runs the loop to check for new events
     #
     def run
-      while true
+      until Thread.current[:should_exit]
         flush
       end
     end
@@ -44,6 +44,7 @@ module AnalyticsRuby
     def flush
       # Block until we have something to send
       item = @queue.pop
+      return if item.nil?
 
       # Synchronize on additions to the current batch
       @mutex.synchronize {

data/lib/analytics-ruby/version.rb

@@ -1,3 +1,3 @@
 module AnalyticsRuby
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analytics-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -109,6 +109,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- analytics-ruby-0.5.2.gem
 - analytics-ruby.gemspec
 - Gemfile
 - Gemfile.lock