posthog-rails 3.12.2 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62ff8f270eaa05f59e416c798a1788f8ce3baa16c1dcba8b09f58039a4ac52c6
-  data.tar.gz: 4bc7f6753ef7bd80fca9418c679085ae894441b5efcb06bd4d31348a30ec2ef7
+  metadata.gz: dbadf59825cbf2d519a1eab2aa36e56cba2bc9c395076857e50bc126e41300b0
+  data.tar.gz: de897b215980ee6bcbbfe54416073fed3d5b9321fce30443dacb015a7785b073
 SHA512:
-  metadata.gz: 849ca061d5d4ce429e2361f22b89c95b1ee9e8f4ce2fb1462e841a5deaef896f38b4095335fa6aafa4a70d92a5b53218d08fb0772c4089d4117cb1639a4f0dcb
-  data.tar.gz: 2f117183afbf4ec5cce029afe3e4170739b1f52707c4465a2a3312891bf10cc2a0d0202c37622ea32e6ccae6d4e2e211057b8fdbe1851cdf66d33414de086a8e
+  metadata.gz: 33068f5f9b2673d0f9acf9f1acb20f50a8f99c04e1182911d9245c539e8d2566a3c42fb6da125d89853a7cadadf187754b3d49e24666a46d274800bc9badf82f
+  data.tar.gz: d94d7cff285e97a7769683f1349689b770d8ddb3610ceb0f21cf68067ca56b0fe2ffbb103f2c5720fd39270cc3d84f6c8fb9e9c4e39fb83e2fb65a8da35123c3

data/lib/generators/posthog/templates/posthog.rb

@@ -37,6 +37,12 @@ PostHog::Rails.configure do |config|
   # making it easier to identify affected users and debug user-specific issues.
   # config.current_user_method = :current_user
 
+  # Or provide a resolver for apps that store user context outside controllers,
+  # such as ActiveSupport::CurrentAttributes. The resolver takes precedence over
+  # current_user_method and may accept the controller as an argument.
+  # config.current_user_resolver = proc { Current.user }
+  # config.current_user_resolver = proc { |controller| controller.current_user }
+
   # Additional exception classes to exclude from reporting
   # These are added to the default excluded exceptions
   # config.excluded_exceptions = [

data/lib/posthog/rails/capture_exceptions.rb

@@ -69,20 +69,40 @@ module PostHog
       def extract_distinct_id(env)
         # Prefer authenticated Rails user context. Request/tracing context is
         # applied later by the core capture path if this returns nil.
-        if PostHog::Rails.config&.capture_user_context && env['action_controller.instance']
-          controller = env['action_controller.instance']
-          method_name = PostHog::Rails.config&.current_user_method || :current_user
+        return nil unless PostHog::Rails.config&.capture_user_context
 
-          if controller.respond_to?(method_name, true)
-            user = controller.send(method_name)
-            user_id = extract_user_id(user) if user
-            return user_id if present?(user_id)
-          end
-        end
+        user = extract_current_user(env['action_controller.instance'])
+        user_id = extract_user_id(user) if user
+        return user_id if present?(user_id)
 
         nil
       end
 
+      def extract_current_user(controller)
+        resolver = PostHog::Rails.config&.current_user_resolver
+        return resolve_current_user(resolver, controller) if resolver
+
+        method_name = PostHog::Rails.config&.current_user_method || :current_user
+        return unless controller.respond_to?(method_name, true)
+
+        controller.send(method_name)
+      end
+
+      def resolve_current_user(resolver, controller)
+        call_current_user_resolver(resolver, controller)
+      rescue StandardError => e
+        PostHog::Logging.logger.warn("current_user_resolver failed: #{e.message}")
+        nil
+      end
+
+      def call_current_user_resolver(resolver, controller)
+        if resolver.arity.zero?
+          controller ? controller.instance_exec(&resolver) : resolver.call
+        elsif controller
+          resolver.call(controller)
+        end
+      end
+
       def extract_user_id(user)
         # Use configured method if specified
         method_name = PostHog::Rails.config&.user_id_method

data/lib/posthog/rails/configuration.rb

@@ -32,6 +32,10 @@ module PostHog
       # @return [Symbol] Method name to call on controller to get the current user. Defaults to :current_user.
       attr_accessor :current_user_method
 
+      # @return [Proc, nil] Callable used to resolve the current user. When set, this takes precedence over
+      #   current_user_method. The callable may accept the controller instance or no arguments.
+      attr_accessor :current_user_resolver
+
       # @return [Symbol, nil] Method name to call on the user object to get distinct_id. When nil, tries:
       #   posthog_distinct_id, distinct_id, id, pk, uuid in order.
       attr_accessor :user_id_method
@@ -68,6 +72,7 @@ module PostHog
         @use_tracing_headers = true
         @capture_user_context = true
         @current_user_method = :current_user
+        @current_user_resolver = nil
         @user_id_method = nil
         @logs_enabled = false
         @logs_forward_rails_logger = true

data/lib/posthog/rails/facade.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module PostHog
+  module Rails
+    # Install the Rails singleton-style PostHog facade at load time so Rails app
+    # initializers can call PostHog.init before Railtie initializers run.
+    #
+    # @api private
+    # @return [void]
+    def self.install_posthog_facade!
+      return if @posthog_facade_installed
+
+      PostHog.class_eval do
+        class << self
+          attr_accessor :client
+
+          # Initialize the singleton PostHog client used by Rails delegators.
+          #
+          # @param options [Hash] Core {PostHog::Client} options.
+          # @yieldparam config [PostHog::Rails::InitConfig] Block-based core SDK configuration.
+          # @return [PostHog::Client]
+          def init(options = {})
+            # If block given, yield to configuration
+            if block_given?
+              config = PostHog::Rails::InitConfig.new(options)
+              yield config
+              options = config.to_client_options
+            end
+
+            # Let the PostHog Logs pipeline reuse the same api_key/host without
+            # the core client exposing public readers.
+            PostHog::Rails::Logs::Setup.remember_client_options(options) if defined?(PostHog::Rails::Logs::Setup)
+
+            # Create the PostHog client. If a client already exists, shut it down
+            # after replacement so repeated init calls do not leave background
+            # resources from the previous instance running.
+            previous_client = @client
+            @client = PostHog::Client.new(options)
+            begin
+              previous_client&.shutdown
+            rescue StandardError => e
+              PostHog::Logging.logger.warn("Failed to shut down previous PostHog client: #{e.message}")
+            end
+            @client
+          end
+
+          # @return [Boolean] Whether {PostHog.init} has created a client.
+          def initialized?
+            !@client.nil?
+          end
+
+          # Fallback for any client methods not explicitly defined.
+          #
+          # @api private
+          def method_missing(method_name, ...)
+            ensure_initialized!
+
+            if client.respond_to?(method_name)
+              client.public_send(method_name, ...)
+            else
+              super
+            end
+          end
+
+          # @api private
+          def respond_to_missing?(method_name, include_private = false)
+            ensure_initialized!
+            client.respond_to?(method_name, include_private) || super
+          end
+
+          private
+
+          def ensure_initialized!
+            return if initialized?
+
+            @client = PostHog::Client.new(api_key: nil, silence_disabled_client_error: true)
+          end
+        end
+      end
+
+      %i[
+        capture
+        capture_exception
+        identify
+        alias
+        group_identify
+        is_feature_enabled
+        get_feature_flag
+        get_all_flags
+      ].each do |method_name|
+        PostHog.define_singleton_method(method_name) do |*args, **kwargs, &block|
+          ensure_initialized!
+          client.public_send(method_name, *args, **kwargs, &block)
+        end
+      end
+
+      @posthog_facade_installed = true
+    end
+  end
+end

data/lib/posthog/rails/railtie.rb

@@ -1,97 +1,14 @@
 # frozen_string_literal: true
 
+require 'posthog/rails/facade'
+
 module PostHog
   module Rails
     class Railtie < ::Rails::Railtie
-      # Add PostHog module methods for accessing Rails-specific client
+      # Keep the historical Railtie initializer name, but install the facade at
+      # load time so application initializers can call PostHog.init.
       initializer 'posthog.set_configs' do |_app|
-        PostHog.class_eval do
-          class << self
-            attr_accessor :client
-
-            # Methods explicitly delegated to the client
-            DELEGATED_METHODS = %i[
-              capture
-              capture_exception
-              identify
-              alias
-              group_identify
-              is_feature_enabled
-              get_feature_flag
-              get_all_flags
-            ].freeze
-
-            # Initialize the singleton PostHog client used by Rails delegators.
-            #
-            # @param options [Hash] Core {PostHog::Client} options.
-            # @yieldparam config [PostHog::Rails::InitConfig] Block-based core SDK configuration.
-            # @return [PostHog::Client]
-            def init(options = {})
-              # If block given, yield to configuration
-              if block_given?
-                config = PostHog::Rails::InitConfig.new(options)
-                yield config
-                options = config.to_client_options
-              end
-
-              # Let the PostHog Logs pipeline reuse the same api_key/host without
-              # the core client exposing public readers.
-              PostHog::Rails::Logs::Setup.remember_client_options(options) if defined?(PostHog::Rails::Logs::Setup)
-
-              # Create the PostHog client. If a client already exists, shut it down
-              # after replacement so repeated init calls do not leave background
-              # resources from the previous instance running.
-              previous_client = @client
-              @client = PostHog::Client.new(options)
-              begin
-                previous_client&.shutdown
-              rescue StandardError => e
-                PostHog::Logging.logger.warn("Failed to shut down previous PostHog client: #{e.message}")
-              end
-              @client
-            end
-
-            # Define delegated methods using metaprogramming
-            DELEGATED_METHODS.each do |method_name|
-              define_method(method_name) do |*args, **kwargs, &block|
-                ensure_initialized!
-                client.public_send(method_name, *args, **kwargs, &block)
-              end
-            end
-
-            # @return [Boolean] Whether {PostHog.init} has created a client.
-            def initialized?
-              !@client.nil?
-            end
-
-            # Fallback for any client methods not explicitly defined.
-            #
-            # @api private
-            def method_missing(method_name, ...)
-              ensure_initialized!
-
-              if client.respond_to?(method_name)
-                client.public_send(method_name, ...)
-              else
-                super
-              end
-            end
-
-            # @api private
-            def respond_to_missing?(method_name, include_private = false)
-              ensure_initialized!
-              client.respond_to?(method_name, include_private) || super
-            end
-
-            private
-
-            def ensure_initialized!
-              return if initialized?
-
-              @client = PostHog::Client.new(api_key: nil, silence_disabled_client_error: true)
-            end
-          end
-        end
+        PostHog::Rails.install_posthog_facade!
       end
 
       # Insert middleware for request context and exception capturing

data/lib/posthog/rails.rb

@@ -12,6 +12,7 @@ require 'posthog/rails/logs/severity'
 require 'posthog/rails/logs/rate_limiter'
 require 'posthog/rails/logs/appender'
 require 'posthog/rails/logs/setup'
+require 'posthog/rails/facade'
 require 'posthog/rails/railtie'
 
 module PostHog
@@ -63,3 +64,5 @@ module PostHog
     end
   end
 end
+
+PostHog::Rails.install_posthog_facade!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posthog-rails
 version: !ruby/object:Gem::Version
-  version: 3.12.2
+  version: 3.13.0
 platform: ruby
 authors:
 - PostHog
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 description: Automatic exception tracking and instrumentation for Ruby on Rails applications
   using PostHog
 email: engineering@posthog.com
@@ -52,6 +52,7 @@ files:
 - lib/posthog/rails/capture_exceptions.rb
 - lib/posthog/rails/configuration.rb
 - lib/posthog/rails/error_subscriber.rb
+- lib/posthog/rails/facade.rb
 - lib/posthog/rails/logs/appender.rb
 - lib/posthog/rails/logs/rate_limiter.rb
 - lib/posthog/rails/logs/setup.rb