posthog-ruby 3.14.3 → 3.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78690fdd0687ca0ba5ca1580bd38be10ee4ca8af77886ba7613556f27cadc882
-  data.tar.gz: 01cefb30c994729d2950cfc9d5701bdf29dbf8555101a0cbc7febd7be9e5a81f
+  metadata.gz: edb7fbf2f848ccb05f6a79f9c3429d395ac39cde5fdd1f83c59d97990231cbc8
+  data.tar.gz: bf96ccaccf1cf2117b502311895d95eb32de786b005809bf1d03471c67fc3920
 SHA512:
-  metadata.gz: fbfa25966ae2e7a7275bbb11faa1fa1b1b9813dfc08540cd5e26693c765db48c3d3faa3fe1c542b044693cded6676a71465eb3ce2092428d7b4cc3c9567bf47b
-  data.tar.gz: 458ae4437710f4f6adf0e62271cf8cf5b8788334bb35ed016dc4e1ccfdbc7434ba29c1efad5d58243aad97dffb3a8a8949a2571c97557ed4e036809d3b1e4ffe
+  metadata.gz: a60d451d311741d7d3407515a8b05a0029a24d098445aae51fe4c4d51ab894c4005c0f78267f4d5717681a258ef83091e62e508d8f902068a6e9321ceead274b
+  data.tar.gz: 01b522405e918921a9667a1cf47271b314cf55cada33687ea31d8c2ed04239f602f61adf35c891920691c25a10d0ac6ad76c816ef2160b3ccfaf6208e564baa1

data/lib/posthog/backoff_policy.rb

@@ -33,7 +33,7 @@ module PostHog
 
       @attempts += 1
 
-      [interval, @max_timeout_ms].min
+      interval.clamp(@min_timeout_ms, @max_timeout_ms)
     end
 
     private

data/lib/posthog/client.rb

@@ -67,6 +67,8 @@ module PostHog
     #   in seconds. Defaults to 30.
     # @option opts [Integer] :feature_flag_request_timeout_seconds How long to wait for feature flag evaluation,
     #   in seconds. Defaults to 3.
+    # @option opts [Integer] :max_retries How many times to retry batch uploads after the first send attempt.
+    #   Defaults to the transport default. Set to 0 to disable retrying.
     # @option opts [Integer] :feature_flag_request_max_retries How many times to retry a flag request after a
     #   transient network error. Each retry sleeps on the calling thread before retrying, so this adds to
     #   worst-case latency. Defaults to 1. Set to 0 to disable retrying.
@@ -76,6 +78,7 @@ module PostHog
     #   the same API key. Use only when you intentionally need multiple clients. Defaults to +false+.
     # @option opts [Boolean] :skip_ssl_verification +true+ to disable SSL certificate verification for requests.
     #   Intended only for local development or custom deployments.
+    # @option opts [Boolean] :compress_request Set to +false+ to disable gzip compression for batch uploads.
     # @option opts [Object] :flag_definition_cache_provider An object implementing the {FlagDefinitionCacheProvider}
     #   interface for distributed flag definition caching.
     # @option opts [Boolean] :is_server +true+ to stamp captured events with `$is_server => true` so PostHog
@@ -109,7 +112,8 @@ module PostHog
         @transport = Transport.new(
           api_host: opts[:host],
           skip_ssl_verification: opts[:skip_ssl_verification],
-          retries: 3
+          retries: opts.key?(:max_retries) ? opts[:max_retries].to_i + 1 : 3,
+          compress_request: opts[:compress_request]
         )
         @sync_lock = Mutex.new
       end

data/lib/posthog/feature_flags.rb

@@ -150,7 +150,7 @@ module PostHog
         group_properties: group_properties
       }
       request_data[:flag_keys_to_evaluate] = flag_keys if flag_keys && !flag_keys.empty?
-      request_data[:geoip_disable] = true if disable_geoip
+      request_data[:geoip_disable] = disable_geoip unless disable_geoip.nil?
 
       flags_response = _request_feature_flag_evaluation(request_data)
 

data/lib/posthog/send_worker.rb

@@ -27,6 +27,7 @@ module PostHog
     # @option options [Proc] :on_error Callback invoked as `on_error.call(status, error)`.
     # @option options [String] :host PostHog API host URL.
     # @option options [Boolean] :skip_ssl_verification Disable SSL certificate verification.
+    # @option options [Boolean] :compress_request Set to +false+ to disable gzip batch request bodies.
     def initialize(queue, api_key, options = {})
       symbolize_keys! options
       @queue = queue
@@ -42,7 +43,12 @@ module PostHog
       @flush_requested = false
       @shutdown = false
       @pid = Process.pid
-      @transport_options = { api_host: options[:host], skip_ssl_verification: options[:skip_ssl_verification] }
+      @transport_options = {
+        api_host: options[:host],
+        skip_ssl_verification: options[:skip_ssl_verification],
+        compress_request: options[:compress_request]
+      }
+      @transport_options[:retries] = options[:max_retries].to_i + 1 if options.key?(:max_retries)
       @transport = Transport.new(@transport_options)
     end
 

data/lib/posthog/transport.rb

@@ -8,6 +8,8 @@ require 'posthog/backoff_policy'
 require 'net/http'
 require 'net/https'
 require 'json'
+require 'time'
+require 'zlib'
 
 module PostHog
   # HTTP transport used by the SDK workers.
@@ -28,6 +30,7 @@ module PostHog
     # @option options [Integer] :retries Number of retry attempts for retryable failures.
     # @option options [PostHog::BackoffPolicy] :backoff_policy Backoff policy used between retries.
     # @option options [Boolean] :skip_ssl_verification Disable SSL certificate verification.
+    # @option options [Boolean] :compress_request Whether to gzip batch request bodies. Defaults to +true+.
     def initialize(options = {})
       if options[:api_host]
         uri = URI.parse(options[:api_host])
@@ -40,10 +43,12 @@ module PostHog
       options[:port] = options[:port].nil? ? PORT : options[:port]
       options[:ssl] = options[:ssl].nil? ? SSL : options[:ssl]
 
-      @headers = options[:headers] || HEADERS
+      @headers = (options[:headers] || HEADERS).dup
       @path = options[:path] || PATH
       @retries = options[:retries] || RETRIES
       @backoff_policy = options[:backoff_policy] || PostHog::BackoffPolicy.new
+      @compress_request = options[:compress_request] != false
+      @last_retry_after = nil
 
       http = Net::HTTP.new(options[:host], options[:port])
       http.use_ssl = options[:ssl]
@@ -100,10 +105,8 @@ module PostHog
     private
 
     def should_retry_request?(status_code, body)
-      if status_code >= 500
-        true # Server error
-      elsif status_code == 429 # rubocop:disable Lint/DuplicateBranch
-        true # Rate limited
+      if status_code >= 500 || [408, 429].include?(status_code)
+        true # Server error, request timeout, or rate limited
       elsif status_code >= 400
         logger.error(body)
         false # Client error. Do not retry, but log
@@ -133,33 +136,75 @@ module PostHog
 
       if should_retry && (retries_remaining > 1)
         logger.debug("Retrying request, #{retries_remaining} retries left")
-        sleep(@backoff_policy.next_interval.to_f / 1000)
+        sleep(retry_delay_seconds)
         retry_with_backoff(retries_remaining - 1, &block)
       else
         [result, caught_exception]
       end
     end
 
+    def retry_delay_seconds
+      retry_after = parse_retry_after(@last_retry_after)
+      @last_retry_after = nil
+      return retry_after if retry_after
+
+      @backoff_policy.next_interval.to_f / 1000
+    end
+
+    def parse_retry_after(value)
+      return nil if value.nil? || value.empty?
+
+      seconds = Float(value, exception: false)
+      return seconds if seconds && seconds >= 0
+
+      parsed_time = Time.httpdate(value)
+      delay = parsed_time - Time.now
+      delay.positive? ? delay : nil
+    rescue ArgumentError
+      nil
+    end
+
     # Sends a request for the batch, returns [status_code, body]
     def send_request(api_key, batch)
+      @last_retry_after = nil
       payload = JSON.generate(api_key: api_key, batch: batch)
 
-      request = Net::HTTP::Post.new(@path, @headers)
+      request_path, request_headers, request_payload = build_request(@path, @headers, payload)
+      request = Net::HTTP::Post.new(request_path, request_headers)
 
       if self.class.stub
-        logger.debug "stubbed request to #{@path}: " \
+        logger.debug "stubbed request to #{request_path}: " \
                      "api key = #{api_key}, batch = #{JSON.generate(batch)}"
 
         [200, '{}']
       else
         @http_mutex.synchronize do
           @http.start unless @http.started? # Maintain a persistent connection
-          response = @http.request(request, payload)
+          response = @http.request(request, request_payload)
+          @last_retry_after = response['Retry-After']
           [response.code.to_i, response.body]
         end
       end
     end
 
+    def build_request(path, headers, payload)
+      return [path, headers, payload] unless @compress_request
+
+      compressed_payload = gzip_payload(payload)
+      return [path, headers, payload] unless compressed_payload
+
+      compressed_headers = headers.merge('Content-Encoding' => 'gzip')
+
+      [path, compressed_headers, compressed_payload]
+    end
+
+    def gzip_payload(payload)
+      Zlib.gzip(payload)
+    rescue Zlib::Error => e
+      logger.warn("gzip compression failed; sending uncompressed - #{e.message}")
+      nil
+    end
+
     class << self
       attr_writer :stub
 

data/lib/posthog/version.rb

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

metadata

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