fix: satisfy SDK compliance harness 0.8.0

.changeset/curly-snakes-retry.md

@@ -0,0 +1,5 @@
+---
+"posthog-ruby": patch
+---
+
+Retry capture delivery on transient HTTP errors such as 408, 429, and 5xx while continuing to avoid retries for non-retryable 4xx responses.

.github/workflows/sdk-compliance.yml

@@ -0,0 +1,21 @@
+name: SDK Compliance Tests
+
+permissions:
+  contents: read
+  packages: read
+  pull-requests: write
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  compliance:
+    name: PostHog SDK compliance tests
+    uses: PostHog/posthog-sdk-test-harness/.github/workflows/test-sdk-action.yml@be8b8d5a3f94a249659844e94832e874f049c1e4
+    with:
+      adapter-dockerfile: "sdk_compliance_adapter/Dockerfile"
+      adapter-context: "."
+      test-harness-version: "0.8.0"

lib/posthog/backoff_policy.rb

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

lib/posthog/client.rb

@@ -67,6 +67,8 @@ def _decrement_instance_count(api_key)
     #   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.
@@ -110,7 +112,7 @@ def initialize(opts = {})
         @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

lib/posthog/feature_flags.rb

@@ -150,7 +150,7 @@ def get_flags(distinct_id, groups = {}, person_properties = {}, group_properties
         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)
 

lib/posthog/send_worker.rb

@@ -48,6 +48,7 @@ def initialize(queue, api_key, options = {})
         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
 

lib/posthog/transport.rb

@@ -8,6 +8,7 @@
 require 'net/http'
 require 'net/https'
 require 'json'
+require 'time'
 require 'zlib'
 
 module PostHog
@@ -42,11 +43,12 @@ def initialize(options = {})
       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]
@@ -103,10 +105,8 @@ def shutdown
     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
@@ -136,15 +136,37 @@ def retry_with_backoff(retries_remaining, &block)
 
       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_path, request_headers, request_payload = build_request(@path, @headers, payload)
@@ -159,6 +181,7 @@ def send_request(api_key, batch)
         @http_mutex.synchronize do
           @http.start unless @http.started? # Maintain a persistent connection
           response = @http.request(request, request_payload)
+          @last_retry_after = response['Retry-After']
           [response.code.to_i, response.body]
         end
       end

sdk_compliance_adapter/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:3.3-slim
+
+WORKDIR /app
+
+RUN gem install concurrent-ruby --no-document
+
+COPY lib/ /app/lib/
+COPY sdk_compliance_adapter/adapter.rb /app/adapter.rb
+
+ENV RUBYLIB=/app/lib
+
+EXPOSE 8080
+
+CMD ["ruby", "/app/adapter.rb"]