posthog-ruby 2.4.3 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4045560a50a4339e398f41b14198c8f7e8a89b03e9c67c4051f9c3e8a3ddc023
-  data.tar.gz: f5db284d85ca9b085205e435c236a0b74da89c141c2c25254307811308ed038f
+  metadata.gz: 78a70730ff0365203bb5af28ae5fadbb938950bb8980d048e3167878a1dc6645
+  data.tar.gz: e0a73f36a251b3280a21950c960c0a3f89172511a03f1c076898b769eb91ebbf
 SHA512:
-  metadata.gz: b841977f8e744a5420d9fdec891e98d82b486c558dcbbf33c1ecf2441031b454bd5ea62323904e5600458a31fb11263513d49944edfd0c916359fecd1f4881a6
-  data.tar.gz: 2f959dc54d97743c25abe0e3d3ae385f781a05fcdd2c8bc97d84d0909475ba1b183d546086b4cc943cc416c2c2f642810e838b869608779ae518b3482b85a77b
+  metadata.gz: 6f1b69643da1ed3dccfb38de8979436f9f0236676a2858931bea97215e617e6e97282e1b719bf1c811453731fe8e4873e7ac5a0fa021f9785899712b4ef43828
+  data.tar.gz: 7f016c7d172072f837f0780994d8018352356e19ae872578fd5befe2f657aab417c2aec350c357162d44fab52e59a3883236888e4a28a004b35e44b0e0a7bcf7

data/lib/posthog/client.rb

@@ -23,6 +23,7 @@ class PostHog
     # @option opts [Proc] :on_error Handles error calls from the API.
     # @option opts [String] :host Fully qualified hostname of the PostHog server. Defaults to `https://app.posthog.com`
     # @option opts [Integer] :feature_flags_polling_interval How often to poll for feature flag definition changes. Measured in seconds, defaults to 30.
+    # @option opts [Integer] :feature_flag_request_timeout_seconds How long to wait for feature flag evaluation. Measured in seconds, defaults to 3.
     def initialize(opts = {})
       symbolize_keys!(opts)
 
@@ -48,7 +49,9 @@ class PostHog
           opts[:feature_flags_polling_interval],
           opts[:personal_api_key],
           @api_key,
-          opts[:host]
+          opts[:host],
+          opts[:feature_flag_request_timeout_seconds] || Defaults::FeatureFlags::FLAG_REQUEST_TIMEOUT_SECONDS,
+          opts[:on_error]
         )
       
       @distinct_id_has_sent_flag_calls = SizeLimitedHash.new(Defaults::MAX_HASH_SIZE) { |hash, key| hash[key] = Array.new }
@@ -90,7 +93,7 @@ class PostHog
       symbolize_keys! attrs
 
       if attrs[:send_feature_flags]
-        feature_variants = @feature_flags_poller._get_active_feature_variants(attrs[:distinct_id], attrs[:groups])
+        feature_variants = @feature_flags_poller.get_feature_variants(attrs[:distinct_id], attrs[:groups] || {})
 
         attrs[:feature_variants] = feature_variants
       end
@@ -116,6 +119,7 @@ class PostHog
     # @option attrs [String] :group_type Group type
     # @option attrs [String] :group_key Group key
     # @option attrs [Hash] :properties Group properties (optional)
+    # @option attrs [String] :distinct_id Distinct ID (optional)
     # @macro common_attrs
     def group_identify(attrs)
       symbolize_keys! attrs

data/lib/posthog/defaults.rb

@@ -16,6 +16,10 @@ class PostHog
       RETRIES = 10
     end
 
+    module FeatureFlags
+      FLAG_REQUEST_TIMEOUT_SECONDS = 3
+    end
+    
     module Queue
       MAX_SIZE = 10_000
     end

data/lib/posthog/feature_flags.rb

@@ -14,7 +14,7 @@ class PostHog
     include PostHog::Logging
     include PostHog::Utils
 
-    def initialize(polling_interval, personal_api_key, project_api_key, host)
+    def initialize(polling_interval, personal_api_key, project_api_key, host, feature_flag_request_timeout_seconds, on_error = nil)
       @polling_interval = polling_interval || 30
       @personal_api_key = personal_api_key
       @project_api_key = project_api_key
@@ -23,6 +23,8 @@ class PostHog
       @group_type_mapping = Concurrent::Hash.new
       @loaded_flags_successfully_once = Concurrent::AtomicBoolean.new
       @feature_flags_by_key = nil
+      @feature_flag_request_timeout_seconds = feature_flag_request_timeout_seconds
+      @on_error = on_error || proc { |status, error| }
 
       @task =
         Concurrent::TimerTask.new(
@@ -46,30 +48,22 @@ class PostHog
       end
     end
 
-    def get_feature_variants(distinct_id, groups={}, person_properties={}, group_properties={})
-      decide_data = get_decide(distinct_id, groups, person_properties, group_properties)
+    def get_feature_variants(distinct_id, groups={}, person_properties={}, group_properties={}, raise_on_error=false)
+      # TODO: Convert to options hash for easier argument passing
+      decide_data = get_all_flags_and_payloads(distinct_id, groups, person_properties, group_properties, false, raise_on_error)
       if !decide_data.key?(:featureFlags)
-        logger.error "Missing feature flags key: #{decide_data.to_json}"
+        logger.debug "Missing feature flags key: #{decide_data.to_json}"
+        {}
       else
         stringify_keys(decide_data[:featureFlags] || {})
       end
     end
 
-    def _get_active_feature_variants(distinct_id, groups={}, person_properties={}, group_properties={})
-      feature_variants = get_feature_variants(distinct_id, groups, person_properties, group_properties)
-      active_feature_variants = {}
-      feature_variants.each do |key, value|
-        if value != false
-          active_feature_variants[key] = value
-        end
-      end
-      active_feature_variants
-    end
-
     def get_feature_payloads(distinct_id, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false)
-      decide_data = get_decide(distinct_id, groups, person_properties, group_properties)
+      decide_data = get_all_flags_and_payloads(distinct_id, groups, person_properties, group_properties)
       if !decide_data.key?(:featureFlagPayloads)
-        logger.error "Missing feature flag payloads key: #{decide_data.to_json}"
+        logger.debug "Missing feature flag payloads key: #{decide_data.to_json}"
+        return {}
       else
         stringify_keys(decide_data[:featureFlagPayloads] || {})
       end
@@ -115,7 +109,7 @@ class PostHog
         rescue InconclusiveMatchError => e
           logger.debug "Failed to compute flag #{key} locally: #{e}"
         rescue StandardError => e
-          logger.error "Error computing flag locally: #{e}. #{e.backtrace.join("\n")}"
+          @on_error.call(-1, "Error computing flag locally: #{e}. #{e.backtrace.join("\n")}")
         end
       end
 
@@ -123,14 +117,14 @@ class PostHog
 
       if !flag_was_locally_evaluated && !only_evaluate_locally
         begin
-          flags = get_feature_variants(distinct_id, groups, person_properties, group_properties)
+          flags = get_feature_variants(distinct_id, groups, person_properties, group_properties, true)
           response = flags[key]
           if response.nil?
             response = false
           end
           logger.debug "Successfully computed flag remotely: #{key} -> #{response}"
         rescue StandardError => e
-          logger.error "Error computing flag remotely: #{e}. #{e.backtrace.join("\n")}"
+          @on_error.call(-1, "Error computing flag remotely: #{e}. #{e.backtrace.join("\n")}")
         end
       end
 
@@ -143,7 +137,7 @@ class PostHog
       flags = response[:featureFlags]
     end
 
-    def get_all_flags_and_payloads(distinct_id, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false)
+    def get_all_flags_and_payloads(distinct_id, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false, raise_on_error = false)
       load_feature_flags
 
       flags = {}
@@ -161,17 +155,22 @@ class PostHog
         rescue InconclusiveMatchError => e
           fallback_to_decide = true
         rescue StandardError => e
-          logger.error "Error computing flag locally: #{e}."
+          @on_error.call(-1, "Error computing flag locally: #{e}. #{e.backtrace.join("\n")} ")
           fallback_to_decide = true
         end
       end
       if fallback_to_decide && !only_evaluate_locally
         begin
           flags_and_payloads = get_decide(distinct_id, groups, person_properties, group_properties)
+
+          unless flags_and_payloads.key?(:featureFlags)
+            raise StandardError.new("Error flags response: #{flags_and_payloads}")
+          end
           flags = stringify_keys(flags_and_payloads[:featureFlags] || {})
           payloads = stringify_keys(flags_and_payloads[:featureFlagPayloads] || {})
         rescue StandardError => e
-          logger.error "Error computing flag remotely: #{e}"
+          @on_error.call(-1, "Error computing flag remotely: #{e}")
+          raise if raise_on_error
         end
       end
       {"featureFlags": flags, "featureFlagPayloads": payloads}
@@ -370,8 +369,9 @@ class PostHog
     end
 
     def _compute_flag_payload_locally(key, match_value)
-      response = nil
+      return nil if @feature_flags_by_key.nil?
 
+      response = nil
       if [true, false].include? match_value
         response = @feature_flags_by_key.dig(key, :filters, :payloads, match_value.to_s.to_sym)
       elsif match_value.is_a? String
@@ -472,10 +472,15 @@ class PostHog
     end
 
     def _load_feature_flags()
-      res = _request_feature_flag_definitions
+      begin
+        res = _request_feature_flag_definitions
+      rescue StandardError => e
+        @on_error.call(-1, e.to_s)
+        return
+      end
 
       if !res.key?(:flags)
-        logger.error "Failed to load feature flags: #{res}"
+        logger.debug "Failed to load feature flags: #{res}"
       else
         @feature_flags = res[:flags] || []
         @feature_flags_by_key = {}
@@ -508,16 +513,18 @@ class PostHog
       data['token'] = @project_api_key
       req.body = data.to_json
 
-      _request(uri, req)
+      _request(uri, req, @feature_flag_request_timeout_seconds)
     end
 
-    def _request(uri, request_object)
+    def _request(uri, request_object, timeout = nil)
 
       request_object['User-Agent'] = "posthog-ruby#{PostHog::VERSION}"
 
+      request_timeout = timeout || 10
+
       begin
         res_body = nil
-        Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https', :read_timeout => request_timeout) do |http|
           res = http.request(request_object)
           JSON.parse(res.body, {symbolize_names: true})
         end
@@ -527,9 +534,11 @@ class PostHog
              EOFError,
              Net::HTTPBadResponse,
              Net::HTTPHeaderSyntaxError,
+             Net::ReadTimeout,
+             Net::WriteTimeout,
              Net::ProtocolError => e
         logger.debug("Unable to complete request to #{uri}")
-        throw e
+        raise
       end
     end
   end

data/lib/posthog/field_parser.rb

@@ -64,8 +64,7 @@ class PostHog
         check_presence!(group_key, 'group_key')
         check_is_hash!(properties, 'properties')
 
-        distinct_id = "$#{group_type}_#{group_key}"
-        fields[:distinct_id] = distinct_id
+        fields[:distinct_id] ||= "$#{group_type}_#{group_key}"
         common = parse_common_fields(fields)
 
         isoify_dates! properties
@@ -137,10 +136,14 @@ class PostHog
 
         if send_feature_flags
           feature_variants = fields[:feature_variants]
+          active_feature_variants = {}
           feature_variants.each do |key, value|
             parsed[:properties]["$feature/#{key}"] = value
+            if value != false
+              active_feature_variants[key] = value
+            end
           end
-          parsed[:properties]["$active_feature_flags"] = feature_variants.keys
+          parsed[:properties]["$active_feature_flags"] = active_feature_variants.keys
         end
         parsed
       end

data/lib/posthog/version.rb

@@ -1,3 +1,3 @@
 class PostHog
-  VERSION = '2.4.3'
+  VERSION = '2.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 2.5.1
 platform: ruby
 authors:
 - ''
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-29 00:00:00.000000000 Z
+date: 2024-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.6.0
 description: The PostHog ruby library
 email: hey@posthog.com
 executables:
@@ -163,7 +163,7 @@ homepage: https://github.com/PostHog/posthog-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,8 +178,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: PostHog library
 test_files: []