posthog-ruby 3.9.2 → 3.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b91bbae760e03c60cedc5e14bebc275a4e0fd112ba20bed4c2539016cc8241
-  data.tar.gz: 15cfdaa8da6474bd7f6854339aa4123a02991eac0eac8bd3b4d78da3f4d131e9
+  metadata.gz: fa0374a1bdfa7b8d76b8f2ffeee64e868883148c50ab714ed3072db48862ee42
+  data.tar.gz: b2729eb5375aea69389ff2fb7ba012a5644e60723fda3b2bc60647161cca11b8
 SHA512:
-  metadata.gz: 3dc592f13f48e806ae7ac7f5985ce4466f7dff80f6965e8a5e0f5df774f4f7529e83023c0cde3a7ad2686d18a4aebab38e8538467576c8b17145c373648382e7
-  data.tar.gz: 3fa007054bb09b32ae6df99570683dc568a35365f44f46375f50a9b0a8338640d281dcb37dc6bc6041013093df0f64cb44a42b44c30e8a6e5ee49b0a8291e880
+  metadata.gz: 7287da0e6624013013c6bddc1565791be27486cfdb9bf7f196c0fc5663fd5f963375d1d3d7f5b8b6cf6e2f57c515991cf605c9abf44dba197a4f85f8f0e352af
+  data.tar.gz: 7e16531f9ca40884c42ef54eff1507efec2b64c09b0f9cd09da7e16186d9e337846699fde96792b4d1ed75c403d95222e37a8de5ec768b8fbd1f16882ecb2225

data/lib/posthog/client.rb

@@ -52,7 +52,7 @@ module PostHog
     end
 
     # @param opts [Hash] Client configuration.
-    # @option opts [String] :api_key Your project's API key. Required.
+    # @option opts [String, nil] :api_key Your project's API key. Missing or blank values disable the client.
     # @option opts [String, nil] :personal_api_key Your personal API key. Required for local feature flag evaluation.
     # @option opts [String] :host Fully qualified hostname of the PostHog server. Defaults to `https://us.i.posthog.com`.
     # @option opts [Integer] :max_queue_size Maximum number of calls to remain queued. Defaults to 10_000.
@@ -72,7 +72,7 @@ module PostHog
     # @option opts [Boolean] :skip_ssl_verification +true+ to disable SSL certificate verification for requests.
     #   Intended only for local development or custom deployments.
     # @option opts [Object] :flag_definition_cache_provider An object implementing the {FlagDefinitionCacheProvider}
-    #   interface for distributed flag definition caching. EXPERIMENTAL: This API may change in future minor versions.
+    #   interface for distributed flag definition caching.
     def initialize(opts = {})
       symbolize_keys!(opts)
 
@@ -82,11 +82,12 @@ module PostHog
 
       @queue = Queue.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
-      @sync_mode = opts[:sync_mode] == true && !opts[:test_mode]
+      @sync_mode = opts[:sync_mode] == true && !opts[:test_mode] && !@disabled
       @on_error = opts[:on_error] || proc { |status, error| }
-      @worker = if opts[:test_mode]
+      @worker = if opts[:test_mode] || @disabled
                   NoopWorker.new(@queue)
                 elsif @sync_mode
                   nil
@@ -105,11 +106,12 @@ module PostHog
       @feature_flags_poller = nil
       @personal_api_key = opts[:personal_api_key]
 
-      check_api_key!
-      logger.error('api_key is empty after trimming whitespace; check your project API key') if @api_key == ''
+      if @disabled && !opts[:silence_disabled_client_error]
+        logger.error('api_key is missing or empty after trimming whitespace; check your project API key')
+      end
 
       # Warn when multiple clients are created with the same API key (can cause dropped events)
-      unless opts[:test_mode] || opts[:disable_singleton_warning]
+      unless @disabled || opts[:test_mode] || opts[:disable_singleton_warning]
         previous_count = self.class._increment_instance_count(@api_key)
         if previous_count >= 1
           logger.warn(
@@ -121,16 +123,18 @@ module PostHog
         end
       end
 
-      @feature_flags_poller =
-        FeatureFlagsPoller.new(
-          opts[:feature_flags_polling_interval],
-          opts[:personal_api_key],
-          @api_key,
-          opts[:host],
-          opts[:feature_flag_request_timeout_seconds] || Defaults::FeatureFlags::FLAG_REQUEST_TIMEOUT_SECONDS,
-          opts[:on_error],
-          flag_definition_cache_provider: opts[:flag_definition_cache_provider]
-        )
+      unless @disabled
+        @feature_flags_poller =
+          FeatureFlagsPoller.new(
+            opts[:feature_flags_polling_interval],
+            opts[:personal_api_key],
+            @api_key,
+            opts[:host],
+            opts[:feature_flag_request_timeout_seconds] || Defaults::FeatureFlags::FLAG_REQUEST_TIMEOUT_SECONDS,
+            opts[:on_error],
+            flag_definition_cache_provider: opts[:flag_definition_cache_provider]
+          )
+      end
 
       @distinct_id_has_sent_flag_calls = SizeLimitedHash.new(Defaults::MAX_HASH_SIZE) do |hash, key|
         hash[key] = []
@@ -198,6 +202,8 @@ module PostHog
     # @return [Boolean] Whether the event was queued or sent.
     # @macro common_attrs
     def capture(attrs)
+      return false if @disabled
+
       symbolize_keys! attrs
       enrich_capture_attrs_with_context(attrs)
 
@@ -226,7 +232,7 @@ module PostHog
       end
 
       send_feature_flags_param = attrs[:send_feature_flags]
-      if send_feature_flags_param
+      if send_feature_flags_param && !@disabled
         _emit_deprecation(
           :capture_send_feature_flags,
           '`send_feature_flags` on `capture` is deprecated and will be removed in a future major ' \
@@ -280,6 +286,8 @@ module PostHog
     #   same `$feature/<key>` and `$active_feature_flags` properties as the snapshot.
     # @return [Boolean, nil] Whether the exception event was queued or sent, or nil if the input could not be parsed.
     def capture_exception(exception, distinct_id = nil, additional_properties = {}, flags: nil)
+      return false if @disabled
+
       exception_info = ExceptionCapture.build_parsed_exception(exception)
 
       return if exception_info.nil?
@@ -306,6 +314,8 @@ module PostHog
     # @return [Boolean] Whether the identify event was queued or sent.
     # @macro common_attrs
     def identify(attrs)
+      return false if @disabled
+
       symbolize_keys! attrs
       enqueue(FieldParser.parse_for_identify(attrs))
     end
@@ -321,6 +331,8 @@ module PostHog
     # @return [Boolean] Whether the group identify event was queued or sent.
     # @macro common_attrs
     def group_identify(attrs)
+      return false if @disabled
+
       symbolize_keys! attrs
       enqueue(FieldParser.parse_for_group_identify(attrs))
     end
@@ -333,6 +345,8 @@ module PostHog
     # @return [Boolean] Whether the alias event was queued or sent.
     # @macro common_attrs
     def alias(attrs)
+      return false if @disabled
+
       symbolize_keys! attrs
       enqueue(FieldParser.parse_for_alias(attrs))
     end
@@ -388,6 +402,8 @@ module PostHog
     # @param flag_key [String, Symbol] The unique flag key of the remote config feature flag.
     # @return [Hash] The parsed remote config payload response.
     def get_remote_config_payload(flag_key)
+      return nil if @disabled
+
       @feature_flags_poller.get_remote_config_payload(flag_key.to_s)
     end
 
@@ -465,6 +481,8 @@ module PostHog
         '`flags.get_flag_payload(key)` instead — this consolidates flag evaluation into a single ' \
         '`/flags` request per incoming request.'
       )
+      return nil if @disabled
+
       _get_feature_flag_result(
         key, distinct_id,
         groups: groups, person_properties: person_properties, group_properties: group_properties,
@@ -507,6 +525,8 @@ module PostHog
         return FeatureFlagEvaluations.new(host: host, distinct_id: '', flags: {})
       end
 
+      return FeatureFlagEvaluations.new(host: host, distinct_id: distinct_id, flags: {}, groups: groups) if @disabled
+
       person_properties, group_properties = add_local_person_and_group_properties(
         distinct_id, groups, person_properties, group_properties
       )
@@ -620,6 +640,8 @@ module PostHog
       group_properties: {},
       only_evaluate_locally: false
     )
+      return {} if @disabled
+
       person_properties, group_properties = add_local_person_and_group_properties(distinct_id, groups,
                                                                                   person_properties, group_properties)
       @feature_flags_poller.get_all_flags(distinct_id, groups, person_properties, group_properties,
@@ -657,6 +679,8 @@ module PostHog
         'instead — this consolidates flag evaluation into a single `/flags` request per ' \
         'incoming request.'
       )
+      return nil if @disabled
+
       key = key.to_s
       person_properties, group_properties = add_local_person_and_group_properties(distinct_id, groups,
                                                                                   person_properties, group_properties)
@@ -683,6 +707,8 @@ module PostHog
       group_properties: {},
       only_evaluate_locally: false
     )
+      return { featureFlags: {}, featureFlagPayloads: {} } if @disabled
+
       person_properties, group_properties = add_local_person_and_group_properties(
         distinct_id, groups, person_properties, group_properties
       )
@@ -700,6 +726,8 @@ module PostHog
     #
     # @return [void]
     def reload_feature_flags
+      return if @disabled
+
       unless @personal_api_key
         logger.error(
           'You need to specify a personal_api_key to locally evaluate feature flags'
@@ -713,8 +741,8 @@ module PostHog
     #
     # @return [void]
     def shutdown
-      self.class._decrement_instance_count(@api_key) if @api_key
-      @feature_flags_poller.shutdown_poller
+      self.class._decrement_instance_count(@api_key) unless @disabled
+      @feature_flags_poller&.shutdown_poller
       flush
       if @sync_mode
         @sync_lock.synchronize { @transport&.shutdown }
@@ -810,6 +838,8 @@ module PostHog
       only_evaluate_locally: false,
       send_feature_flag_events: true
     )
+      return nil if @disabled
+
       key = key.to_s
       person_properties, group_properties = add_local_person_and_group_properties(
         distinct_id, groups, person_properties, group_properties
@@ -875,6 +905,8 @@ module PostHog
     #
     # returns Boolean of whether the item was added to the queue.
     def enqueue(action)
+      return false if @disabled
+
       action = process_before_send(action)
       return false if action.nil? || action.empty?
 
@@ -901,11 +933,6 @@ module PostHog
       end
     end
 
-    # private: Checks that the api_key is properly initialized
-    def check_api_key!
-      raise ArgumentError, 'API key must be initialized' if @api_key.nil?
-    end
-
     def normalize_string_option(value, blank_as_nil: false)
       return value unless value.is_a?(String)
 

data/lib/posthog/flag_definition_cache.rb

@@ -3,8 +3,6 @@
 module PostHog
   # Interface for external caching of feature flag definitions.
   #
-  # EXPERIMENTAL: This API may change in future minor version bumps.
-  #
   # Enables multi-worker environments (Kubernetes, load-balanced servers,
   # serverless functions) to share flag definitions via an external cache,
   # reducing redundant API calls.

data/lib/posthog/version.rb

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

metadata

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