posthog-ruby 3.16.0 → 3.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1091ed7a7995e58f6abbf25b2a45dba44b9c2f15ff152b5a5bf4044856269161
-  data.tar.gz: f5f5542aa6c66d00bb22c7362ff4e1613eee4ae20b94cf3fe04933ad798b83b5
+  metadata.gz: 75e17034bb60a9af9539cfe28137a91a71d83305e4d3dc7d1db3844870efac38
+  data.tar.gz: b511f71723032dff61fc998ae145d1e650eb6d90bdb4df84024e9335613aed71
 SHA512:
-  metadata.gz: 8f9bc8bf1c98bce5faf4856db35779fd7436df5d538eeb5ae09c3715feb765ade37d22e903056a974f8942f1e207da6de0cba20cd1c08ee601db56a260b33ee3
-  data.tar.gz: 201ed92c1b736ba97e9d76e3221f2297d9f49de0bdee9adc331991d4316db22bf6d014305ef182df6afcc7b1760b2eb7d3026d4337de81c9ce5dbec225239826
+  metadata.gz: d27932884831bba0abb8b90315c1c8c684ae821aa85a5f6df8b486339d53097022ee2d58303b913a46cb05cf576230bf1f45b2ffdbdf465c79fce4875239cfb9
+  data.tar.gz: 043c0f02fb14f744898e7910623757931021d03cb0fbcacc46a305ec2f4d753df81a1ed8482b72f6e9c7e8bc1c826c78b86e889491ceb4c112dfa1844b1cf82a

data/lib/posthog/client.rb

@@ -53,7 +53,11 @@ module PostHog
 
     # @param opts [Hash] Client configuration.
     # @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, nil] :secret_key The credential used for local feature flag evaluation and remote
+    #   config. Accepts either a Personal API Key (`phx_...`) or a Project Secret API Key (`phs_...`). Required
+    #   for local feature flag evaluation.
+    # @option opts [String, nil] :personal_api_key
+    #   @deprecated Use +:secret_key+ instead. Retained as an alias; when both are supplied, +:secret_key+ wins.
     # @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.
     # @option opts [Integer] :batch_size Maximum number of events to send in one async batch.
@@ -88,9 +92,18 @@ module PostHog
       symbolize_keys!(opts)
 
       opts[:api_key] = normalize_string_option(opts[:api_key])
+      opts[:secret_key] = normalize_string_option(opts[:secret_key], blank_as_nil: true)
       opts[:personal_api_key] = normalize_string_option(opts[:personal_api_key], blank_as_nil: true)
       opts[:host] = normalize_host_option(opts[:host])
 
+      if opts[:secret_key].nil? && !opts[:personal_api_key].nil?
+        logger.warn(
+          'The :personal_api_key option is deprecated; use :secret_key instead. It accepts either a ' \
+          'Personal API Key (phx_...) or a Project Secret API Key (phs_...).'
+        )
+      end
+      secret_key = opts[:secret_key] || opts[:personal_api_key]
+
       @queue = Queue.new
       @queue_mutex = Mutex.new
       @api_key = opts[:api_key]
@@ -119,7 +132,8 @@ module PostHog
       end
       @worker_thread = nil
       @feature_flags_poller = nil
-      @personal_api_key = opts[:personal_api_key]
+      @secret_key = secret_key
+      @personal_api_key = secret_key
 
       if @disabled && !opts[:silence_disabled_client_error]
         logger.error('api_key is missing or empty after trimming whitespace; check your project API key')
@@ -142,7 +156,7 @@ module PostHog
         @feature_flags_poller =
           FeatureFlagsPoller.new(
             opts[:feature_flags_polling_interval],
-            opts[:personal_api_key],
+            secret_key,
             @api_key,
             opts[:host],
             opts[:feature_flag_request_timeout_seconds] || Defaults::FeatureFlags::FLAG_REQUEST_TIMEOUT_SECONDS,
@@ -761,9 +775,9 @@ module PostHog
     def reload_feature_flags
       return if @disabled
 
-      unless @personal_api_key
+      unless @secret_key
         logger.error(
-          'You need to specify a personal_api_key to locally evaluate feature flags'
+          'You need to specify a secret_key to locally evaluate feature flags'
         )
         return
       end

data/lib/posthog/exception_capture.rb

@@ -97,8 +97,10 @@ module PostHog
     def self.build_stacktrace(backtrace)
       return nil unless backtrace && !backtrace.empty?
 
+      root = project_root
+      roots = dependency_roots(root)
       frames = backtrace.first(50).map do |line|
-        parse_backtrace_line(line)
+        parse_backtrace_line(line, project_root: root, dependency_roots: roots)
       end.compact.reverse
 
       {
@@ -108,8 +110,10 @@ module PostHog
     end
 
     # @param line [String]
+    # @param project_root [String, nil] Project root used to derive project-relative filenames.
+    # @param dependency_roots [Array<String>, nil] Cached gem and stdlib roots.
     # @return [Hash, nil]
-    def self.parse_backtrace_line(line)
+    def self.parse_backtrace_line(line, project_root: self.project_root, dependency_roots: nil)
       match = line.match(RUBY_INPUT_FORMAT)
       return nil unless match
 
@@ -118,11 +122,11 @@ module PostHog
       method_name = match[5]
 
       frame = {
-        'filename' => File.basename(file),
+        'filename' => frame_filename(file, project_root),
         'abs_path' => file,
         'lineno' => lineno,
         'function' => method_name,
-        'in_app' => !gem_path?(file),
+        'in_app' => !gem_path?(file, dependency_roots || self.dependency_roots(project_root)),
         'platform' => 'ruby'
       }
 
@@ -131,13 +135,71 @@ module PostHog
       frame
     end
 
+    # Root directory the application runs from, used to derive stable
+    # project-relative filenames from per-host deploy paths
+    # (e.g. `/app/releases/20240101/...`).
+    #
+    # @return [String]
+    def self.project_root
+      if defined?(::Rails) && ::Rails.respond_to?(:root) && ::Rails.root
+        ::Rails.root.to_s
+      else
+        Dir.pwd
+      end
+    rescue StandardError
+      Dir.pwd
+    end
+
+    # Stable filename used for fingerprinting: the project-relative path when
+    # the file lives inside the project root, its basename otherwise. The raw
+    # absolute path is kept separately in `abs_path`.
+    #
+    # @param path [String]
+    # @param project_root [String, nil]
+    # @return [String]
+    def self.frame_filename(path, project_root)
+      if project_root && !project_root.empty? && path_within?(path, project_root)
+        relative = path[project_root.length..]
+        relative = relative[1..] while relative.start_with?(File::SEPARATOR)
+        return relative unless relative.empty?
+      end
+
+      File.basename(path)
+    end
+
+    # Whether the path belongs to an installed gem or the Ruby standard library,
+    # based on gem install locations rather than path substrings.
+    #
+    # @param path [String]
+    # @param dependency_roots [Array<String>]
+    # @return [Boolean]
+    def self.gem_path?(path, dependency_roots = self.dependency_roots)
+      dependency_roots.any? { |root| path_within?(path, root) }
+    end
+
+    # @param project_root [String]
+    # @return [Array<String>] Directories containing installed gems and the Ruby stdlib.
+    def self.dependency_roots(project_root = self.project_root)
+      roots = []
+      if defined?(Gem)
+        roots.concat(Gem.path) if Gem.respond_to?(:path)
+        roots << Gem.default_dir if Gem.respond_to?(:default_dir)
+        roots.concat(Gem.loaded_specs.each_value.map(&:full_gem_path)) if Gem.respond_to?(:loaded_specs)
+      end
+      roots << RbConfig::CONFIG['rubylibprefix'] if defined?(RbConfig)
+      # The project itself can be a loaded spec (e.g. a gem developed in place,
+      # or a Rails engine); its frames are still application code.
+      roots.compact.reject(&:empty?).uniq - [project_root]
+    rescue StandardError
+      []
+    end
+
     # @param path [String]
+    # @param root [String]
     # @return [Boolean]
-    def self.gem_path?(path)
-      path.include?('/gems/') ||
-        path.include?('/ruby/') ||
-        path.include?('/.rbenv/') ||
-        path.include?('/.rvm/')
+    def self.path_within?(path, root)
+      root = root.chomp(File::SEPARATOR)
+      path == root || path.start_with?("#{root}#{File::SEPARATOR}")
     end
 
     # @param frame [Hash]

data/lib/posthog/feature_flags.rb

@@ -30,7 +30,8 @@ module PostHog
     include PostHog::Utils
 
     # @param polling_interval [Integer, nil] Seconds between local feature flag definition polls.
-    # @param personal_api_key [String, nil] Personal API key used to fetch local evaluation definitions.
+    # @param secret_key [String, nil] Credential used to fetch local evaluation definitions. Accepts either a
+    #   Personal API Key (`phx_...`) or a Project Secret API Key (`phs_...`).
     # @param project_api_key [String] Project API key.
     # @param host [String] PostHog API host URL.
     # @param feature_flag_request_timeout_seconds [Integer] Timeout for feature flag requests.
@@ -41,7 +42,7 @@ module PostHog
     #   Set to 0 to disable retrying.
     def initialize(
       polling_interval,
-      personal_api_key,
+      secret_key,
       project_api_key,
       host,
       feature_flag_request_timeout_seconds,
@@ -50,7 +51,7 @@ module PostHog
       feature_flag_request_max_retries: nil
     )
       @polling_interval = polling_interval || 30
-      @personal_api_key = personal_api_key
+      @secret_key = secret_key
       @project_api_key = project_api_key
       @host = host
       @feature_flags = Concurrent::Array.new
@@ -74,9 +75,9 @@ module PostHog
           execution_interval: polling_interval
         ) { _load_feature_flags }
 
-      # If no personal API key, disable local evaluation & thus polling for definitions
-      if @personal_api_key.nil?
-        logger.info 'No personal API key provided, disabling local evaluation'
+      # If no secret_key, disable local evaluation & thus polling for definitions
+      if @secret_key.nil?
+        logger.info 'No secret_key provided, disabling local evaluation'
         @loaded_flags_successfully_once.make_true
       else
         # load once before timer
@@ -1227,7 +1228,7 @@ module PostHog
       uri = URI("#{@host}/flags/definitions")
       uri.query = URI.encode_www_form([['token', @project_api_key], %w[send_cohorts true]])
       req = Net::HTTP::Get.new(uri)
-      req['Authorization'] = "Bearer #{@personal_api_key}"
+      req['Authorization'] = "Bearer #{@secret_key}"
       req['If-None-Match'] = etag if etag
 
       _request(uri, req, nil, include_etag: true)
@@ -1253,7 +1254,7 @@ module PostHog
       uri.query = URI.encode_www_form([['token', @project_api_key]])
       req = Net::HTTP::Get.new(uri)
       req['Content-Type'] = 'application/json'
-      req['Authorization'] = "Bearer #{@personal_api_key}"
+      req['Authorization'] = "Bearer #{@secret_key}"
 
       _request(uri, req, @feature_flag_request_timeout_seconds)
     end

data/lib/posthog/flag_definition_cache.rb

@@ -52,7 +52,7 @@ module PostHog
   #   cache = RedisFlagCache.new(redis, service_key: 'my-service')
   #   client = PostHog::Client.new(
   #     api_key: '<project_api_key>',
-  #     personal_api_key: '<personal_api_key>',
+  #     secret_key: '<secret_key>',
   #     flag_definition_cache_provider: cache
   #   )
   #

data/lib/posthog/version.rb

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

metadata

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