posthog-ruby 3.11.1 → 3.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88289426a920b4e3247b7ed8e3e6c20597b698cdd9c0132c6b7a4f292cdd425b
-  data.tar.gz: fe6279cc8f3526944564722540b05283a381c1216f59db43179de605bbb46cab
+  metadata.gz: f51843606a47a924b1a6b772f02c61c90e9446c16827b3d5b28d92d7fdade73a
+  data.tar.gz: 4cfbb395d74bf0f9630b35fafafc6f4eedcdbce9e32a0a8825880f461b581fd9
 SHA512:
-  metadata.gz: 398ad49eafef48370ff2d97e817ae35bfb988e0cb1849937a9adb9a1e085e3188cc1c4ae1d1b937d60409aec6ab8bac3ebb70dd9a4c19a86d45911765739f58c
-  data.tar.gz: 85600802646e6fe88f59ae99e997749f24b9e88ccfd202d1e53ea95f06b1c08d5453313d2838ad4e1edfd90452d27715e89cc646d4237afc8c51449c88cefc5d
+  metadata.gz: 9978900c0f4091624f901a72396f4b2915cc4532503d1bd3a17c7f7e27a142463f5dbbe8e40d621cb52ae95871055f720d5a1a7a5e4652f266604a7311e2dd68
+  data.tar.gz: a815192b4521d259e0f2b8c3adba4c1ef2ef2b30748b4ca56c38f5b4d2b3633b1d500d7b06fe1f51d7e4046d3df618c82e2f5a0ed84ed12eb2f87d94f57dc7b8

data/lib/posthog/client.rb

@@ -84,10 +84,13 @@ module PostHog
       opts[:host] = normalize_host_option(opts[:host])
 
       @queue = Queue.new
+      @queue_mutex = Mutex.new
       @api_key = opts[:api_key]
       @disabled = @api_key.nil? || @api_key.empty?
       @max_queue_size = opts[:max_queue_size] || Defaults::Queue::MAX_SIZE
       @worker_mutex = Mutex.new
+      @shutdown_mutex = Mutex.new
+      @shutdown = false
       @sync_mode = opts[:sync_mode] == true && !opts[:test_mode] && !@disabled
       @on_error = opts[:on_error] || proc { |status, error| }
       @worker = if opts[:test_mode] || @disabled
@@ -139,8 +142,9 @@ module PostHog
           )
       end
 
+      @distinct_id_has_sent_flag_calls_mutex = Mutex.new
       @distinct_id_has_sent_flag_calls = SizeLimitedHash.new(Defaults::MAX_HASH_SIZE) do |hash, key|
-        hash[key] = []
+        hash[key] = SizeLimitedArray.new(Defaults::MAX_HASH_SIZE)
       end
 
       @before_send = opts[:before_send]
@@ -173,7 +177,7 @@ module PostHog
     #
     # @return [void]
     def clear
-      @queue.clear
+      @queue_mutex.synchronize { @queue.clear }
     end
 
     # @!macro common_attrs
@@ -745,10 +749,28 @@ module PostHog
       @feature_flags_poller.load_feature_flags(true)
     end
 
+    # Whether the client will actually send events. It is disabled when the
+    # api_key is missing or blank, in which case every capture call no-ops.
+    #
+    # @return [Boolean]
+    def enabled?
+      !@disabled
+    end
+
     # Flush pending events and stop background resources.
     #
     # @return [void]
     def shutdown
+      already_shutdown = @shutdown_mutex.synchronize do
+        if @shutdown
+          true
+        else
+          @shutdown = true
+          false
+        end
+      end
+      return if already_shutdown
+
       self.class._decrement_instance_count(@api_key) unless @disabled
       @feature_flags_poller&.shutdown_poller
       flush
@@ -756,6 +778,7 @@ module PostHog
         @sync_lock.synchronize { @transport&.shutdown }
       else
         @worker&.shutdown
+        @worker_thread&.join(1)
       end
     end
 
@@ -813,7 +836,16 @@ module PostHog
           ''
         end
       reported_key = "#{key}_#{response_repr}#{groups_repr}"
-      return if @distinct_id_has_sent_flag_calls[distinct_id].include?(reported_key)
+      should_capture = @distinct_id_has_sent_flag_calls_mutex.synchronize do
+        sent_keys = @distinct_id_has_sent_flag_calls[distinct_id]
+        if sent_keys.include?(reported_key)
+          false
+        else
+          sent_keys << reported_key
+          true
+        end
+      end
+      return unless should_capture
 
       msg = {
         distinct_id: distinct_id,
@@ -824,7 +856,6 @@ module PostHog
       msg[:disable_geoip] = disable_geoip unless disable_geoip.nil?
 
       capture(msg)
-      @distinct_id_has_sent_flag_calls[distinct_id] << reported_key
     end
 
     def _feature_flag_evaluations_host
@@ -913,7 +944,7 @@ module PostHog
     #
     # returns Boolean of whether the item was added to the queue.
     def enqueue(action)
-      return false if @disabled
+      return false if @disabled || shutdown?
 
       action = process_before_send(action)
       return false if action.nil? || action.empty?
@@ -926,10 +957,17 @@ module PostHog
         return true
       end
 
-      if @queue.length < @max_queue_size
-        @queue << action
-        ensure_worker_running
+      queued = @queue_mutex.synchronize do
+        if @queue.length < @max_queue_size
+          @queue << action
+          true
+        else
+          false
+        end
+      end
 
+      if queued
+        ensure_worker_running
         true
       else
         logger.warn(
@@ -987,6 +1025,10 @@ module PostHog
       @worker_thread&.alive?
     end
 
+    def shutdown?
+      @shutdown_mutex.synchronize { @shutdown }
+    end
+
     def add_local_person_and_group_properties(distinct_id, groups, person_properties, group_properties)
       groups ||= {}
       person_properties ||= {}

data/lib/posthog/feature_flags.rb

@@ -1250,7 +1250,9 @@ module PostHog
           uri.hostname,
           uri.port,
           use_ssl: uri.scheme == 'https',
-          read_timeout: request_timeout
+          open_timeout: request_timeout,
+          read_timeout: request_timeout,
+          write_timeout: request_timeout
         ) do |http|
           res = http.request(request_object)
           status_code = res.code.to_i

data/lib/posthog/send_worker.rb

@@ -34,6 +34,8 @@ module PostHog
       batch_size = options[:batch_size] || Defaults::MessageBatch::MAX_SIZE
       @batch = MessageBatch.new(batch_size)
       @lock = Mutex.new
+      @shutdown_mutex = Mutex.new
+      @shutdown = false
       @transport = Transport.new api_host: options[:host], skip_ssl_verification: options[:skip_ssl_verification]
     end
 
@@ -41,26 +43,32 @@ module PostHog
     #
     # @return [void]
     def run
-      until Thread.current[:should_exit]
+      until shutdown?
         return if @queue.empty?
 
         @lock.synchronize do
           consume_message_from_queue! until @batch.full? || @queue.empty?
         end
 
-        unless @batch.empty?
-          res = @transport.send @api_key, @batch
-          @on_error.call(res.status, res.error) unless res.status == 200
+        begin
+          unless @batch.empty?
+            res = @transport.send @api_key, @batch
+            handle_error(res.status, res.error) unless res.status == 200
+          end
+        ensure
+          @lock.synchronize { @batch.clear }
         end
-
-        @lock.synchronize { @batch.clear }
       end
     ensure
+      # Worker threads exit when the queue is drained and are restarted for the
+      # next burst of events. Close the persistent connection on each exit and
+      # let Transport reconnect lazily when a future worker sends another batch.
       @transport.shutdown
     end
 
     # @return [void]
     def shutdown
+      @shutdown_mutex.synchronize { @shutdown = true }
       @transport.shutdown
     end
 
@@ -74,10 +82,20 @@ module PostHog
 
     private
 
+    def shutdown?
+      @shutdown_mutex.synchronize { @shutdown }
+    end
+
     def consume_message_from_queue!
       @batch << @queue.pop
     rescue MessageBatch::JSONGenerationError => e
-      @on_error.call(-1, e.to_s)
+      handle_error(-1, e.to_s)
+    end
+
+    def handle_error(status, error)
+      @on_error.call(status, error)
+    rescue StandardError => e
+      logger.error("Error in on_error callback: #{e.message}")
     end
   end
 end

data/lib/posthog/transport.rb

@@ -52,6 +52,7 @@ module PostHog
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE if options[:skip_ssl_verification]
 
       @http = http
+      @http_mutex = Mutex.new
     end
 
     # Sends a batch of messages to the API
@@ -91,7 +92,9 @@ module PostHog
     #
     # @return [void]
     def shutdown
-      @http.finish if @http.started?
+      @http_mutex.synchronize do
+        @http.finish if @http.started?
+      end
     end
 
     private
@@ -149,9 +152,11 @@ module PostHog
 
         [200, '{}']
       else
-        @http.start unless @http.started? # Maintain a persistent connection
-        response = @http.request(request, payload)
-        [response.code.to_i, response.body]
+        @http_mutex.synchronize do
+          @http.start unless @http.started? # Maintain a persistent connection
+          response = @http.request(request, payload)
+          [response.code.to_i, response.body]
+        end
       end
     end
 

data/lib/posthog/utils.rb

@@ -166,5 +166,24 @@ module PostHog
         super
       end
     end
+
+    # Array that drops the oldest item when it reaches a maximum length.
+    #
+    # @api private
+    class SizeLimitedArray < Array
+      # @param max_length [Integer]
+      def initialize(max_length)
+        super()
+        @max_length = max_length
+      end
+
+      # @param value [Object]
+      # @return [Array]
+      def <<(value)
+        shift if length >= @max_length
+        super
+      end
+    end
+    private_constant :SizeLimitedArray
   end
 end

data/lib/posthog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PostHog
-  VERSION = '3.11.1'
+  VERSION = '3.12.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 3.11.1
+  version: 3.12.1
 platform: ruby
 authors:
 - ''