posthog-ruby 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f17b77ed0648665e282dc6f9483695eebcb955c08f4873350d5bbd01277c6534
-  data.tar.gz: e4e638cd17a013f3b3c1e012a5fd08f825fe6e43ce741050c31f7b084a718b96
+  metadata.gz: 654b547b68b6d0ebcfd4ef3523fa46d32a825d01485138e80443cf494d295f4a
+  data.tar.gz: 9ae165ba631600e2ee0f59ce6d80fe3defe5b2c42f8d99a7c6b30393b73d2760
 SHA512:
-  metadata.gz: 9b22dfa3f6765ffbfeb912d775ce5eee8ee4db21be2236dc13679d816c43fff161a707f33ff280ccc4d101e729d593fd909df8ff38c4d8ac8187da48071a506d
-  data.tar.gz: df159e86bc400f53d3d85b4068fc158f600fc32bc5015e022305d27d8cf65487ae946a90934fc7737efdc8086b387a9988883490d7298d261c9520c68c9e1078
+  metadata.gz: 4ce3e4037abd6e861a0f38a9e51ed4c54ae84622b939768139e4bcdc215f32e69b7dabb1c144e291d8e1f832d766c188a01ce5076a70e0dba03add31e4f64587
+  data.tar.gz: 90b385f84d8047eed291d280e07eef79d8c28c217e89bb53cc621c78a6457bf7542780aeee63b48fca53085ba13d625136ac50a8ea9decd47cfc88a999b5a97b

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,12 +49,12 @@ 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 }
-
-      at_exit { @worker_thread && @worker_thread[:should_exit] = true }
     end
 
     # Synchronously waits until the worker has cleared the queue.
@@ -92,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

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}
@@ -229,7 +228,7 @@ class PostHog
           # Guard against overflow, disallow numbers greater than 10_000
           return nil
         end
-        
+
         interval = match[2]
         if interval == "h"
           parsed_dt = parsed_dt - (number/24r)
@@ -254,7 +253,7 @@ class PostHog
     def self.match_property(property, property_values)
       # only looks for matches where key exists in property_values
       # doesn't support operator is_not_set
-      
+
       PostHog::Utils.symbolize_keys! property
       PostHog::Utils.symbolize_keys! property_values
 
@@ -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
@@ -436,7 +436,7 @@ class PostHog
       if !rollout_percentage.nil? and _hash(flag[:key], distinct_id) > (rollout_percentage.to_f/100)
         return false
       end
-      
+
       return true
     end
 
@@ -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,10 +534,12 @@ 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
   end
 end

data/lib/posthog/field_parser.rb

@@ -137,10 +137,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.2'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -44,70 +44,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.11
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.11
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.2
+        version: 3.16.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.2
+        version: 3.16.3
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -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: