posthog-ruby 3.12.0 → 3.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8e287772525236ba5312d91e3a5e9c0f71ba079dbe90e73108dea39b1d02d73
-  data.tar.gz: d5f52b018111579ab218dbfeb3220b55bb8b4d953273ef4f216d07455578cc82
+  metadata.gz: 333bb9ea61d04be7324d0c46eb5dbfa2938a583f8fd88bba845ee6300d219702
+  data.tar.gz: eeceaa50cc3defed270dc48ad6863e555d3068a21929c0157f03743b943fdde2
 SHA512:
-  metadata.gz: cc598260671fd298d28335308a66f5b4b4472e6c38cfd0697198ef61942f9bd9118897dc6c6b6d0e4e163d568094520f0ce08f40579af7c7b0549e6a83c46369
-  data.tar.gz: 6227c32f2dd2c10f14c48953b4bc86e7ee7d4ddb0a7b04b28a8d5917e932a11c95f615d8ad21bdc1cb02ba6b01bd36a545c062cefb30b7201f32e55251a76120
+  metadata.gz: a35cbbd21df7355144bf1f1c6f25e36fc1ab3341d09a326941f8d4f41b7e40766019a4935e6930f8874bf18fe9bf4b0a265879c8f6e87f5a4eb930ddac33c923
+  data.tar.gz: 9269f70dd837716bcbf638e626a6928dcc32f7f9c3e4e49b53777cac2d4347b050b65d1393c70ff750cdee8a25baad5607467b2da4454d272a0fd1ad6f4b311d

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,12 +177,14 @@ module PostHog
     #
     # @return [void]
     def clear
-      @queue.clear
+      @queue_mutex.synchronize { @queue.clear }
     end
 
     # @!macro common_attrs
-    #   @option attrs [String] :message_id ID that uniquely
-    #     identifies a message across the API. (optional)
+    #   @option attrs [String] :message_id Deprecated. Use `:uuid` instead. If `:uuid` is absent or
+    #     invalid and `:message_id` is a valid UUID, it is sent as `uuid` for backwards compatibility.
+    #     If neither value is valid, the SDK generates a `uuid`. SDK metadata is sent as `$lib` and
+    #     `$lib_version` properties.
     #   @option attrs [Time] :timestamp When the event occurred (optional)
     #   @option attrs [String] :distinct_id The ID for this user in your database
 
@@ -757,6 +763,16 @@ module PostHog
     #
     # @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
@@ -764,6 +780,7 @@ module PostHog
         @sync_lock.synchronize { @transport&.shutdown }
       else
         @worker&.shutdown
+        @worker_thread&.join(1)
       end
     end
 
@@ -821,7 +838,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,
@@ -832,7 +858,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
@@ -921,23 +946,27 @@ 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?
 
-      # add our request id for tracing purposes
-      action[:messageId] ||= uid
-
       if @sync_mode
         send_sync(action)
         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(
@@ -995,6 +1024,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/field_parser.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 require 'posthog/logging'
 
 module PostHog
@@ -25,7 +27,6 @@ module PostHog
         event = fields[:event]
         properties = fields[:properties] || {}
         groups = fields[:groups]
-        uuid = fields[:uuid]
         check_presence!(event, 'event')
         check_is_hash!(properties, 'properties')
 
@@ -36,8 +37,6 @@ module PostHog
 
         isoify_dates! properties
 
-        common['uuid'] = uuid if valid_uuid_for_event_props? uuid
-
         common.merge(
           {
             type: 'capture',
@@ -130,12 +129,13 @@ module PostHog
       #
       # - "timestamp"
       # - "distinct_id"
-      # - "message_id"
+      # - "message_id" (deprecated; normalized to "uuid" when it is a valid UUID)
       # - "send_feature_flags"
+      #
+      # A new "uuid" is generated when neither "uuid" nor "message_id" is valid.
       def parse_common_fields(fields)
         timestamp = fields[:timestamp] || Time.new
         distinct_id = fields[:distinct_id]
-        message_id = fields[:message_id].to_s if fields[:message_id]
         send_feature_flags = fields[:send_feature_flags]
 
         check_timestamp! timestamp
@@ -151,13 +151,12 @@ module PostHog
 
         parsed = {
           timestamp: datetime_in_iso8601(timestamp),
-          library: 'posthog-ruby',
-          library_version: PostHog::VERSION.to_s,
-          messageId: message_id,
           distinct_id: distinct_id,
           properties: properties
         }
 
+        parsed['uuid'] = normalized_uuid(fields)
+
         if send_feature_flags && fields[:feature_variants]
           feature_variants = fields[:feature_variants]
           active_feature_variants = {}
@@ -190,6 +189,16 @@ module PostHog
         raise ArgumentError, "#{name} must be a Hash" unless obj.is_a? Hash
       end
 
+      def normalized_uuid(fields)
+        uuid = fields[:uuid]
+        return uuid if uuid && valid_uuid_for_event_props?(uuid)
+
+        message_id = fields[:message_id]
+        return message_id if message_id && valid_uuid_for_event_props?(message_id)
+
+        SecureRandom.uuid
+      end
+
       # @param [Object] uuid - the UUID to validate, user provided, so we don't know the type
       # @return [TrueClass, FalseClass] - true if the UUID is valid or absent, false otherwise
       def valid_uuid_for_event_props?(uuid)

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'securerandom'
-
 module PostHog
   class InconclusiveMatchError < StandardError
   end
@@ -60,16 +58,6 @@ module PostHog
       hash.replace isoify_dates hash
     end
 
-    # public: Returns a uid string
-    #
-    def uid
-      arr = SecureRandom.random_bytes(16).unpack('NnnnnN')
-      arr[2] = (arr[2] & 0x0fff) | 0x4000
-      arr[3] = (arr[3] & 0x3fff) | 0x8000
-
-      '%08x-%04x-%04x-%04x-%04x%08x' % arr # rubocop:disable Style/FormatStringToken, Style/FormatString
-    end
-
     def datetime_in_iso8601(datetime)
       case datetime
       when Time
@@ -166,5 +154,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.12.0'
+  VERSION = '3.12.2'
 end

metadata

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