posthog-ruby 3.20.0 → 3.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36dffe9438cc269541f1642261b27b020bf05993eda1ad9999887428caa1667b
-  data.tar.gz: 9575ff454af5b89c0be1eb6abf4c7a1158fdbca88d4c708860339a1710b1393d
+  metadata.gz: b47ba497bca9801a2d3a530351c021a9441368b63c16cebb2e04dcfe7d0d3b21
+  data.tar.gz: ab1cb2e8238e5f19e3d9c33d96386c98478e357d7bdb96121d8332910f61477a
 SHA512:
-  metadata.gz: 9badf7f03c2009d4c643b6e41f4ede382c0bf488eb0ae4d5cf33ec454110102e3fc342b5f3357b58b881f2a513628ba6056f0ccfa82d54ac8cafb4d814ae3811
-  data.tar.gz: e7918e45f9645da0052d65d205359e8384709f645f0f1b5201500a5cc97bb092aed771cd7fac7846f5bfc142fcb9e8168f55d9cbc750c6bbb8aab26e60e1138d
+  metadata.gz: cc57a456ab1f6ecdce0508ccea5a5896e42901938e8eb8d29b2f8ec07bd1a16c069030feed87aa196a604fffd2e3d0e40999f12434dca839e3aa507f008afdb7
+  data.tar.gz: d4c2693b6a8c60706707599d2958cdf24c54aa21f4ee8d067fbdae1cf9624fad08c923d95e67c5a629cd69aaee420e221a1d7edc51422d644bef8e4218d60b66

data/lib/posthog/client.rb

@@ -22,6 +22,31 @@ module PostHog
     include PostHog::Utils
     include PostHog::Logging
 
+    # Strict allowlist of properties kept on minimal `$feature_flag_called`
+    # events (server-gated, non-experiment flags only). Everything else —
+    # context properties, `$feature/<key>`, payloads, system metadata — is
+    # stripped. Includes symbol forms so allowlisted properties supplied
+    # through context with symbol keys survive.
+    MINIMAL_FLAG_CALLED_EVENT_PROPERTIES = %w[
+      $feature_flag
+      $feature_flag_response
+      $feature_flag_has_experiment
+      $feature_flag_id
+      $feature_flag_version
+      $feature_flag_reason
+      $feature_flag_request_id
+      $feature_flag_evaluated_at
+      $feature_flag_error
+      locally_evaluated
+      $groups
+      $process_person_profile
+      $session_id
+      $is_server
+      $lib
+      $lib_version
+    ].flat_map { |key| [key, key.to_sym] }.freeze
+    private_constant :MINIMAL_FLAG_CALLED_EVENT_PROPERTIES
+
     # Thread-safe tracking of client instances per API key for singleton warnings
     @instances_by_api_key = {}
     @instances_mutex = Mutex.new
@@ -118,7 +143,10 @@ module PostHog
       @max_queue_size = opts[:max_queue_size] || Defaults::Queue::MAX_SIZE
       @worker_mutex = Mutex.new
       @shutdown_mutex = Mutex.new
+      @shutdown_condition = ConditionVariable.new
       @shutdown = false
+      @shutdown_complete = false
+      @shutdown_result = 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
@@ -184,29 +212,40 @@ module PostHog
       @deprecation_emitted_for = Concurrent::Set.new
     end
 
-    # Synchronously waits until the worker has cleared the queue.
+    # When sync_mode is enabled, blocks until in-flight requests are complete
+    # and returns true. Timeout parameter has no effect.
     #
-    # Use only for scripts which are not long-running, and will specifically
-    # exit.
+    # Otherwise, waits until the worker has cleared the queue or timeout is hit.
+    # Note: The asynchronous wait polls and can be starved if another thread is
+    # actively continuing to enqueue new events.
     #
-    # @return [void]
-    def flush
+    # @param timeout [Numeric, nil] Maximum seconds to wait for pending events
+    #   to be sent, or +nil+ to wait indefinitely.
+    # @return [Boolean] +true+ if all pending events were sent, +false+ if the
+    #   timeout elapsed first.
+    def flush(timeout: nil)
       if @sync_mode
         # Wait for any in-flight sync send to complete
         @sync_lock.synchronize {} # rubocop:disable Lint/EmptyBlock
-        return
+        return true
       end
 
       if @worker.is_a?(NoopWorker)
         clear
-        return
+        return true
       end
 
+      deadline = timeout && (monotonic_time + timeout)
+
       while !@queue.empty? || @worker.is_requesting?
         ensure_worker_running
         @worker.request_flush
-        sleep(0.1)
+        remaining = deadline && (deadline - monotonic_time)
+        return false if remaining && remaining <= 0
+
+        sleep(remaining ? remaining.clamp(0, 0.1) : 0.1)
       end
+      true
     end
 
     # Clears the queue without waiting.
@@ -253,6 +292,7 @@ module PostHog
       return false if @disabled
 
       symbolize_keys! attrs
+      minimal_flag_called_event = attrs.delete(:_minimal_flag_called_event) == true
       enrich_capture_attrs_with_context(attrs)
 
       # Precedence: an explicit `flags` snapshot always wins, regardless of
@@ -321,7 +361,13 @@ module PostHog
       end
 
       attrs[:is_server] = @is_server
-      enqueue(FieldParser.parse_for_capture(attrs))
+      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.
+      if minimal_flag_called_event
+        message[:properties] = message[:properties].slice(*MINIMAL_FLAG_CALLED_EVENT_PROPERTIES)
+      end
+      enqueue(message)
     end
 
     # Captures an exception as an event
@@ -627,6 +673,11 @@ module PostHog
       evaluated_at = nil
       errors_while_computing = false
       quota_limited = false
+      # Server-controlled gate for minimal `$feature_flag_called` events. When
+      # the snapshot uses a remote /flags response, the response's top-level
+      # `minimalFlagCalledEvents` field governs; a local-only snapshot reads
+      # the gate polled with the flag definitions.
+      minimal_flag_called_events = @feature_flags_poller.minimal_flag_called_events
 
       # Skip the remote `/flags` round-trip when the caller scoped the request
       # to a fixed set of `flag_keys` and we've already resolved every one of
@@ -635,10 +686,16 @@ module PostHog
       all_requested_flags_resolved_locally = flag_keys_set && (flag_keys_set - locally_evaluated_keys).empty?
 
       if !only_evaluate_locally && !all_requested_flags_resolved_locally
+        # The gate is team-level, so the /flags response gate supersedes the
+        # poller gate for mixed snapshots — both signals come from the same
+        # server and agree in steady state. When the response omits the gate,
+        # the whole snapshot fails safe to full events.
+        minimal_flag_called_events = false
         begin
           flags_response = @feature_flags_poller.get_flags(
             distinct_id, groups, person_properties, group_properties, flag_keys, disable_geoip
           )
+          minimal_flag_called_events = flags_response[:minimalFlagCalledEvents] == true
           request_id = flags_response[:requestId]
           evaluated_at = flags_response[:evaluatedAt]
           errors_while_computing = flags_response[:errorsWhileComputingFlags] == true
@@ -677,7 +734,8 @@ module PostHog
         evaluated_at: evaluated_at,
         flag_definitions_loaded_at: @feature_flags_poller.flag_definitions_loaded_at,
         errors_while_computing: errors_while_computing,
-        quota_limited: quota_limited
+        quota_limited: quota_limited,
+        minimal_flag_called_events: minimal_flag_called_events
       )
     end
 
@@ -777,6 +835,7 @@ module PostHog
       response.delete(:requestId)
       response.delete(:evaluatedAt)
       response.delete(:flagDetails)
+      response.delete(:minimalFlagCalledEvents)
       response
     end
 
@@ -817,29 +876,65 @@ module PostHog
 
     # Flush pending events and stop background resources.
     #
-    # @return [void]
-    def shutdown
-      already_shutdown = @shutdown_mutex.synchronize do
+    # When sync_mode is not set, this method calls the flush method; see flush
+    # method documentation for timeout semantics. Unlike flush, this method
+    # stops the worker. So any events still queued after the timeout will not be
+    # sent. After the timeout, this method may wait up to one additional second
+    # for worker and transport cleanup, which may continue after it returns.
+    #
+    # @param timeout [Numeric, nil] Maximum seconds to wait for pending events
+    #   to be sent, or +nil+ to wait indefinitely. Has no effect when sync_mode
+    #   is true.
+    # @return [Boolean] +true+ if all pending events were sent, +false+ if the
+    #   timeout elapsed first.
+    def shutdown(timeout: nil)
+      deadline = timeout && (monotonic_time + timeout)
+      shutdown_result = @shutdown_mutex.synchronize do
         if @shutdown
-          true
+          until @shutdown_complete
+            # Avoid deadlocking when an in-flight send's on_error callback
+            # re-enters shutdown while the original caller is waiting for it.
+            break if Thread.current == @worker_thread || (@sync_mode && @sync_lock.owned?)
+
+            remaining = deadline && (deadline - monotonic_time)
+            break if remaining && remaining <= 0
+
+            @shutdown_condition.wait(@shutdown_mutex, remaining)
+          end
+          @shutdown_complete ? @shutdown_result : false
         else
           @shutdown = true
-          false
+          nil
         end
       end
-      return if already_shutdown
+      return shutdown_result unless shutdown_result.nil?
 
-      self.class._decrement_instance_count(@api_key) unless @disabled
-      @feature_flags_poller&.shutdown_poller
-      flush
-      if @sync_mode
-        @sync_lock.synchronize { @transport&.shutdown }
-      else
-        @worker&.shutdown
-        @worker_thread&.join(1)
-      end
-      @distinct_id_has_sent_flag_calls_mutex.synchronize do
-        @distinct_id_has_sent_flag_calls.clear
+      flushed = false
+      begin
+        self.class._decrement_instance_count(@api_key) unless @disabled
+        @feature_flags_poller&.shutdown_poller
+        flushed =
+          if @sync_mode
+            # Waiting for @sync_lock lets any in-flight sync send finish before
+            # the connection is closed.
+            @sync_lock.synchronize { @transport&.shutdown }
+            true
+          else
+            drained = flush(timeout: timeout)
+            @worker&.shutdown
+            @worker_thread&.join(1)
+            drained
+          end
+        @distinct_id_has_sent_flag_calls_mutex.synchronize do
+          @distinct_id_has_sent_flag_calls.clear
+        end
+        flushed
+      ensure
+        @shutdown_mutex.synchronize do
+          @shutdown_result = flushed
+          @shutdown_complete = true
+          @shutdown_condition.broadcast
+        end
       end
     end
 
@@ -885,7 +980,7 @@ module PostHog
     # separate event for each group a user is evaluated under.
     def _capture_feature_flag_called_if_needed(
       distinct_id: nil, key: nil, response: nil, properties: nil,
-      groups: nil, disable_geoip: nil
+      groups: nil, disable_geoip: nil, minimal: false
     )
       response_repr = response.nil? ? '::null::' : response
       groups_repr =
@@ -915,6 +1010,7 @@ module PostHog
       }
       msg[:groups] = groups if groups
       msg[:disable_geoip] = disable_geoip unless disable_geoip.nil?
+      msg[:_minimal_flag_called_event] = true if minimal
 
       capture(msg)
     end
@@ -945,7 +1041,7 @@ module PostHog
         groups, person_properties, group_properties
       )
       feature_flag_response, flag_was_locally_evaluated, request_id, evaluated_at, feature_flag_error, payload,
-        has_experiment =
+        has_experiment, minimal_flag_called_events =
         @feature_flags_poller.get_feature_flag(
           key, distinct_id, groups, person_properties, group_properties, only_evaluate_locally
         )
@@ -960,9 +1056,13 @@ module PostHog
         properties['$feature_flag_evaluated_at'] = evaluated_at if evaluated_at
         properties['$feature_flag_error'] = feature_flag_error if feature_flag_error
 
+        # Emit a minimal event only when the server gate is on and the flag is
+        # known to have no linked experiment. Any missing signal fails safe to
+        # the full event.
+        minimal = minimal_flag_called_events == true && has_experiment == false
         _capture_feature_flag_called_if_needed(
           distinct_id: distinct_id, key: key, response: feature_flag_response,
-          properties: properties, groups: groups
+          properties: properties, groups: groups, minimal: minimal
         )
       end
 

data/lib/posthog/feature_flag_evaluations.rb

@@ -44,6 +44,8 @@ module PostHog
     # @param flag_definitions_loaded_at [Time, nil] When local flag definitions were loaded.
     # @param errors_while_computing [Boolean] Whether the server reported errors while computing flags.
     # @param quota_limited [Boolean] Whether feature flag evaluation was quota limited.
+    # @param minimal_flag_called_events [Boolean] Server-controlled gate for minimal
+    #   `$feature_flag_called` events.
     # @param accessed [Array<String>, Set<String>, nil] Flag keys already accessed by this snapshot.
     def initialize(
       host: nil,
@@ -56,6 +58,7 @@ module PostHog
       flag_definitions_loaded_at: nil,
       errors_while_computing: false,
       quota_limited: false,
+      minimal_flag_called_events: false,
       accessed: nil
     )
       @host = host
@@ -68,6 +71,7 @@ module PostHog
       @flag_definitions_loaded_at = flag_definitions_loaded_at
       @errors_while_computing = errors_while_computing
       @quota_limited = quota_limited
+      @minimal_flag_called_events = minimal_flag_called_events == true
       @accessed = Set.new(accessed || [])
     end
 
@@ -188,13 +192,19 @@ module PostHog
       errors << 'flag_missing' if flag.nil?
       properties['$feature_flag_error'] = errors.join(',') unless errors.empty?
 
+      # Emit a minimal event only when the server gate is on and the flag is
+      # known to have no linked experiment. Any missing signal (unknown flag,
+      # has_experiment absent) fails safe to the full event.
+      minimal = @minimal_flag_called_events && !flag.nil? && flag.has_experiment == false
+
       @host.capture_flag_called_event_if_needed.call(
         distinct_id: @distinct_id,
         key: key,
         response: response,
         properties: properties,
         groups: @groups,
-        disable_geoip: @disable_geoip
+        disable_geoip: @disable_geoip,
+        minimal: minimal
       )
     end
 
@@ -210,6 +220,7 @@ module PostHog
         flag_definitions_loaded_at: @flag_definitions_loaded_at,
         errors_while_computing: @errors_while_computing,
         quota_limited: @quota_limited,
+        minimal_flag_called_events: @minimal_flag_called_events,
         accessed: @accessed.dup
       )
     end

data/lib/posthog/feature_flags.rb

@@ -72,7 +72,10 @@ module PostHog
       @flags_etag = Concurrent::AtomicReference.new(nil)
       @flag_definitions_loaded_at = Concurrent::AtomicReference.new(nil)
       @async_load = async_load
-
+      # 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.
+      @minimal_flag_called_events = false
       @flag_definition_cache_provider = flag_definition_cache_provider
       FlagDefinitionCacheProvider.validate!(@flag_definition_cache_provider) if @flag_definition_cache_provider
 
@@ -111,7 +114,7 @@ module PostHog
       @flag_definitions_loaded_at.value
     end
 
-    attr_reader :feature_flags_by_key
+    attr_reader :feature_flags_by_key, :minimal_flag_called_events
 
     def get_feature_variants(
       distinct_id,
@@ -245,6 +248,11 @@ module PostHog
       # evaluated flags carry it in the response metadata. nil when the server
       # (an older deployment) does not report it.
       has_experiment = feature_flag[:has_experiment] if flag_was_locally_evaluated
+      # Server-controlled gate for minimal `$feature_flag_called` events.
+      # Locally-evaluated flags read it from the definitions payload; remotely
+      # evaluated flags read it from the /flags response. nil when the signal
+      # is unavailable, which fails safe to the full event.
+      minimal_flag_called_events = @minimal_flag_called_events if flag_was_locally_evaluated
 
       request_id = nil
       evaluated_at = nil
@@ -279,6 +287,7 @@ module PostHog
 
           flag_detail = flags_data[:flagDetails]&.[](key.to_sym)
           has_experiment = flag_detail&.metadata&.has_experiment
+          minimal_flag_called_events = flags_data[:minimalFlagCalledEvents]
 
           logger.debug "Successfully computed flag remotely: #{key} -> #{response}"
         rescue Timeout::Error => e
@@ -293,7 +302,8 @@ module PostHog
         end
       end
 
-      [response, flag_was_locally_evaluated, request_id, evaluated_at, feature_flag_error, payload, has_experiment]
+      [response, flag_was_locally_evaluated, request_id, evaluated_at, feature_flag_error, payload, has_experiment,
+       minimal_flag_called_events]
     end
 
     def get_all_flags(
@@ -352,6 +362,7 @@ module PostHog
       quota_limited = nil
       status_code = nil
       flag_details = nil
+      minimal_flag_called_events = nil
 
       if fallback_to_server && !only_evaluate_locally
         begin
@@ -367,6 +378,7 @@ module PostHog
 
           request_id = flags_and_payloads[:requestId]
           evaluated_at = flags_and_payloads[:evaluatedAt]
+          minimal_flag_called_events = flags_and_payloads[:minimalFlagCalledEvents]
 
           # Check if feature_flags are quota limited
           if quota_limited&.include?('feature_flags')
@@ -402,7 +414,8 @@ module PostHog
         evaluatedAt: evaluated_at,
         errorsWhileComputingFlags: errors_while_computing,
         quotaLimited: quota_limited,
-        status: status_code
+        status: status_code,
+        minimalFlagCalledEvents: minimal_flag_called_events
       }
     end
 
@@ -1203,6 +1216,7 @@ module PostHog
         @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
         return
@@ -1226,7 +1240,8 @@ module PostHog
         data = {
           flags: @feature_flags.to_a,
           group_type_mapping: @group_type_mapping.to_h,
-          cohorts: @cohorts.to_h
+          cohorts: @cohorts.to_h,
+          minimal_flag_called_events: @minimal_flag_called_events
         }
         @flag_definition_cache_provider.on_flag_definitions_received(data)
       rescue StandardError => e
@@ -1238,6 +1253,7 @@ module PostHog
       flags = get_by_symbol_or_string_key(data, 'flags') || []
       group_type_mapping = get_by_symbol_or_string_key(data, 'group_type_mapping') || {}
       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) })
 
@@ -1249,6 +1265,7 @@ module PostHog
 
       @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

data/lib/posthog/flag_definition_cache.rb

@@ -14,9 +14,11 @@ module PostHog
   #
   # @!method flag_definitions
   #   Retrieve cached flag definitions. Return a Hash with +:flags+,
-  #   +:group_type_mapping+, and +:cohorts+ keys, or +nil+ if the cache
-  #   is empty. Returning +nil+ triggers an API fetch when no flags are
-  #   loaded yet (emergency fallback).
+  #   +:group_type_mapping+, +:cohorts+, and +:minimal_flag_called_events+
+  #   keys, or +nil+ if the cache is empty. Returning +nil+ triggers an API
+  #   fetch when no flags are loaded yet (emergency fallback). Providers
+  #   written before +:minimal_flag_called_events+ existed continue to work;
+  #   a missing key is treated as +false+.
   #   @return [Hash, nil]
   #
   # @!method should_fetch_flag_definitions?
@@ -27,9 +29,9 @@ module PostHog
   #
   # @!method on_flag_definitions_received(data)
   #   Called after successfully fetching new definitions from the API.
-  #   +data+ is a Hash with +:flags+, +:group_type_mapping+, and +:cohorts+
-  #   keys (plain Ruby types, not Concurrent:: wrappers). Store it in your
-  #   external cache.
+  #   +data+ is a Hash with +:flags+, +:group_type_mapping+, +:cohorts+, and
+  #   +:minimal_flag_called_events+ keys (plain Ruby types, not Concurrent::
+  #   wrappers). Store it in your external cache.
   #   @param data [Hash]
   #   @return [void]
   #

data/lib/posthog/send_worker.rb

@@ -213,9 +213,5 @@ module PostHog
     rescue StandardError => e
       logger.error("Error shutting down transport: #{e.message}")
     end
-
-    def monotonic_time
-      Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    end
   end
 end

data/lib/posthog/utils.rb

@@ -136,6 +136,12 @@ module PostHog
       end
     end
 
+    # public: Current monotonic clock time in seconds, for measuring durations
+    #
+    def monotonic_time
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
     # Hash that clears itself when it reaches a maximum length.
     #
     # @api private

data/lib/posthog/version.rb

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

metadata

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