posthog-ruby 3.23.5 → 3.23.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e7240af788ef7054780bd976e8d568fc5c5deab52c8e448e18097b3ab2f4206
-  data.tar.gz: 64fe80390d35ffd7aac25a10ff2c98584a0f74cf353ba4d697503b472e1859ee
+  metadata.gz: 67be906751ad3545830e00ac558a3787ba935d08c5414b216b653b63a745a424
+  data.tar.gz: 589fa3335b009dc16e22224e4708d55079e9b236c5c6cdfdba6f996fdb191af3
 SHA512:
-  metadata.gz: 63adc1ce6c3381d2261076783610e1e71d04cbc4d925548dc777663d8c996228bd61ce80b3813ecec1a5b98c07ad687953b1bee408d30931a8002b1e5175ea3e
-  data.tar.gz: 24954a02c8857733331f5976718e212786e7ce713ca60b3ea329dcbadc5defcd28d6c5cf02f684cc1f285573d972374b718653885b98daf7e05df4ecb386f6cd
+  metadata.gz: 1d7c92afb919cfb24e8e3a9bcfd3605cb4fce07d784019f1dd80fd0c685bc4ddde18d5b0322091fe49ad0e474cedbcae3804baf624697be650eed0418a450cdd
+  data.tar.gz: c9bec9d494e68a63b594c6960dc5e9d30d32d918c68df1a7dd83ba3a047179ff87bf5756f5dd0434ffde305b14a392457cbac7762c84e8ea91ed9839fab09763

data/lib/posthog/client.rb

@@ -141,6 +141,9 @@ module PostHog
       @api_key = opts[:api_key]
       @disabled = @api_key.nil? || @api_key.empty?
       @max_queue_size = opts[:max_queue_size] || Defaults::Queue::MAX_SIZE
+      @lib = opts[:_lib] || 'posthog-ruby'
+      @lib_version = (opts[:_lib_version] || PostHog::VERSION).to_s
+      @headers = Defaults::Request::HEADERS.merge('User-Agent' => "#{@lib}/#{@lib_version}")
       @worker_mutex = Mutex.new
       @shutdown_mutex = Mutex.new
       @shutdown_condition = ConditionVariable.new
@@ -154,11 +157,12 @@ module PostHog
                 elsif @sync_mode
                   nil
                 else
-                  SendWorker.new(@queue, @api_key, opts)
+                  SendWorker.new(@queue, @api_key, opts.merge(headers: @headers))
                 end
       if @sync_mode
         @transport = Transport.new(
           api_host: opts[:host],
+          headers: @headers,
           skip_ssl_verification: opts[:skip_ssl_verification],
           retries: opts.key?(:max_retries) ? opts[:max_retries].to_i + 1 : 3,
           compress_request: opts[:compress_request]
@@ -187,6 +191,12 @@ module PostHog
         end
       end
 
+      # Initialize tracking before the poller can load definitions (including async loads).
+      @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] = SizeLimitedArray.new(Defaults::MAX_HASH_SIZE)
+      end
+
       unless @disabled
         @feature_flags_poller =
           FeatureFlagsPoller.new(
@@ -198,15 +208,13 @@ module PostHog
             opts[:on_error],
             flag_definition_cache_provider: opts[:flag_definition_cache_provider],
             feature_flag_request_max_retries: opts[:feature_flag_request_max_retries],
-            async_load: opts[:feature_flags_async_load] == true
+            async_load: opts[:feature_flags_async_load] == true,
+            user_agent: @headers['User-Agent'],
+            flag_definitions_update_mutex: @distinct_id_has_sent_flag_calls_mutex,
+            on_flag_definitions_updated: -> { @distinct_id_has_sent_flag_calls.clear }
           )
       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] = SizeLimitedArray.new(Defaults::MAX_HASH_SIZE)
-      end
-
       @before_send = opts[:before_send]
       @is_server = opts.fetch(:is_server, true) != false
       @deprecation_emitted_for = Concurrent::Set.new
@@ -362,6 +370,8 @@ module PostHog
       end
 
       attrs[:is_server] = @is_server
+      attrs[:lib] = @lib
+      attrs[:lib_version] = @lib_version
       message = FieldParser.parse_for_capture(attrs)
       # Minimal events are built from the allowlist after full assembly so
       # context properties and parser-added metadata can never leak in.
@@ -417,6 +427,8 @@ module PostHog
 
       symbolize_keys! attrs
       attrs[:is_server] = @is_server
+      attrs[:lib] = @lib
+      attrs[:lib_version] = @lib_version
       enqueue(FieldParser.parse_for_identify(attrs))
     end
 
@@ -435,6 +447,8 @@ module PostHog
 
       symbolize_keys! attrs
       attrs[:is_server] = @is_server
+      attrs[:lib] = @lib
+      attrs[:lib_version] = @lib_version
       enqueue(FieldParser.parse_for_group_identify(attrs))
     end
 
@@ -450,6 +464,8 @@ module PostHog
 
       symbolize_keys! attrs
       attrs[:is_server] = @is_server
+      attrs[:lib] = @lib
+      attrs[:lib_version] = @lib_version
       enqueue(FieldParser.parse_for_alias(attrs))
     end
 

data/lib/posthog/feature_flags.rb

@@ -44,6 +44,10 @@ module PostHog
     # @param async_load [Boolean] When true, flag definitions are fetched only on the poller thread: an
     #   immediate first tick at construction, then the regular polling cadence, which keeps retrying until a
     #   load succeeds.
+    # @param user_agent [String] User-Agent header sent with feature flag requests.
+    # @param flag_definitions_update_mutex [Mutex] Internal lock shared with flag-called deduplication.
+    # @param on_flag_definitions_updated [Proc, nil] Internal callback after definitions are applied or discarded,
+    #   called while holding flag_definitions_update_mutex.
     def initialize(
       polling_interval,
       secret_key,
@@ -53,7 +57,10 @@ module PostHog
       on_error = nil,
       flag_definition_cache_provider: nil,
       feature_flag_request_max_retries: nil,
-      async_load: false
+      async_load: false,
+      user_agent: "posthog-ruby/#{PostHog::VERSION}",
+      on_flag_definitions_updated: nil,
+      flag_definitions_update_mutex: Mutex.new
     )
       @polling_interval = polling_interval || Defaults::FeatureFlags::POLLING_INTERVAL_SECONDS
       @secret_key = secret_key
@@ -72,6 +79,9 @@ module PostHog
       @flags_etag = Concurrent::AtomicReference.new(nil)
       @flag_definitions_loaded_at = Concurrent::AtomicReference.new(nil)
       @async_load = async_load
+      @user_agent = user_agent
+      @on_flag_definitions_updated = on_flag_definitions_updated
+      @flag_definitions_update_mutex = flag_definitions_update_mutex
       # Server-controlled gate for minimal `$feature_flag_called` events, read
       # from the top-level `minimal_flag_called_events` key of the local
       # evaluation definitions payload. false when the server does not send it.
@@ -1218,14 +1228,18 @@ module PostHog
           '[FEATURE FLAGS] Feature flags quota limit exceeded - unsetting all local flags. ' \
           'Learn more about billing limits at https://posthog.com/docs/billing/limits-alerts'
         )
-        @feature_flags = Concurrent::Array.new
-        @feature_flags_by_key = {}
-        @group_type_mapping = Concurrent::Hash.new
-        @cohorts = Concurrent::Hash.new
-        @flag_definitions_loaded_at.value = nil
-        @minimal_flag_called_events = false
-        @loaded_flags_successfully_once.make_false
-        @quota_limited.make_true
+        @flag_definitions_update_mutex.synchronize do
+          definitions_were_loaded = definitions_loaded?
+          @feature_flags = Concurrent::Array.new
+          @feature_flags_by_key = {}
+          @group_type_mapping = Concurrent::Hash.new
+          @cohorts = Concurrent::Hash.new
+          @flag_definitions_loaded_at.value = nil
+          @minimal_flag_called_events = false
+          @loaded_flags_successfully_once.make_false
+          @quota_limited.make_true
+          @on_flag_definitions_updated&.call if definitions_were_loaded
+        end
         return
       end
 
@@ -1262,21 +1276,26 @@ module PostHog
       cohorts = get_by_symbol_or_string_key(data, 'cohorts') || {}
       minimal_flag_called_events = get_by_symbol_or_string_key(data, 'minimal_flag_called_events')
 
-      @feature_flags = Concurrent::Array.new(flags.map { |f| deep_symbolize_keys(f) })
-
+      new_flags = Concurrent::Array.new(flags.map { |f| deep_symbolize_keys(f) })
       new_by_key = {}
-      @feature_flags.each do |flag|
+      new_flags.each do |flag|
         new_by_key[flag[:key]] = flag unless flag[:key].nil?
       end
-      @feature_flags_by_key = new_by_key
-
-      @group_type_mapping = Concurrent::Hash[deep_symbolize_keys(group_type_mapping)]
-      @cohorts = Concurrent::Hash[deep_symbolize_keys(cohorts)]
-      @minimal_flag_called_events = minimal_flag_called_events == true
-
-      logger.debug "Loaded #{@feature_flags.length} feature flags and #{@cohorts.length} cohorts"
-      @flag_definitions_loaded_at.value = (Time.now.to_f * 1000).to_i
-      @loaded_flags_successfully_once.make_true if @loaded_flags_successfully_once.false?
+      new_group_type_mapping = Concurrent::Hash[deep_symbolize_keys(group_type_mapping)]
+      new_cohorts = Concurrent::Hash[deep_symbolize_keys(cohorts)]
+
+      # A read of the new definitions must not record its event before the tracker reset.
+      @flag_definitions_update_mutex.synchronize do
+        @feature_flags = new_flags
+        @feature_flags_by_key = new_by_key
+        @group_type_mapping = new_group_type_mapping
+        @cohorts = new_cohorts
+        @minimal_flag_called_events = minimal_flag_called_events == true
+        @flag_definitions_loaded_at.value = (Time.now.to_f * 1000).to_i
+        @loaded_flags_successfully_once.make_true if @loaded_flags_successfully_once.false?
+        @on_flag_definitions_updated&.call
+      end
+      logger.debug "Loaded #{new_flags.length} feature flags and #{new_cohorts.length} cohorts"
     end
 
     def _request_feature_flag_definitions(etag: nil)
@@ -1326,7 +1345,7 @@ module PostHog
     RETRYABLE_FLAGS_REQUEST_STATUS_CODES = [502, 504].freeze
 
     def _request(uri, request_object, timeout = nil, include_etag: false, retry_status_codes: [])
-      request_object['User-Agent'] = "posthog-ruby/#{PostHog::VERSION}"
+      request_object['User-Agent'] = @user_agent
       request_timeout = timeout || 10
       backoff_policy = nil
       attempts = 0

data/lib/posthog/field_parser.rb

@@ -144,8 +144,8 @@ module PostHog
         is_server = fields.fetch(:is_server, true) != false
 
         properties = {
-          '$lib' => 'posthog-ruby',
-          '$lib_version' => PostHog::VERSION.to_s
+          '$lib' => fields.fetch(:lib, 'posthog-ruby'),
+          '$lib_version' => fields.fetch(:lib_version, PostHog::VERSION.to_s)
         }
         properties['$is_server'] = true if is_server
 

data/lib/posthog/send_worker.rb

@@ -45,6 +45,7 @@ module PostHog
       @pid = Process.pid
       @transport_options = {
         api_host: options[:host],
+        headers: options[:headers],
         skip_ssl_verification: options[:skip_ssl_verification],
         compress_request: options[:compress_request]
       }

data/lib/posthog/version.rb

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

metadata

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