rails-profiler 0.30.13 → 0.30.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2613fd14e9adfbb7911645a1bd23fcd1043d4424f532e64c267601d021db7ad0
-  data.tar.gz: 1f474b73d65dd2aac23151a8ea4f61aba98399f7182cd7db9dda39947afb7b28
+  metadata.gz: e09eb31d9bcb170273cd7c9df1f6e149d772d38cd52fd0f6d2930644054ccc8d
+  data.tar.gz: 5b8996d059b59b4a69e702ff238060dd83e08614fa416ae09ed8ed077d0d550f
 SHA512:
-  metadata.gz: 67dd8e4b429926a3fdef908c1491650c796497c177cb263cfdd94e7b14a5587a7a6ef48ea09c33b430ef5bca1ac0c921a4294d16c093127a39b1eac9db5c5cd3
-  data.tar.gz: 004f12ec514d606d212f49b0ac5c8c1f593437d62cf58e2a2b1242eef67fd144caa1ef165e8371947db4c9d8ae291a9bbdb83a2acf40058a8b53e5e50a78be71
+  metadata.gz: 5042a2f2c93acb5fd91e27907880d01b51aecaa7316a34886b827ec73584d9e3dcf356d07079f368066511fe447b06ecbeba1520e5a245befd82eb10f45b2d46
+  data.tar.gz: 8ca5df627c525ad56bddfcfa01771f0e8d23f2c3b6ade75d71dde0ea9db85a2d06ca2b2807f834f6195aba3423197d674986033427edae7d612ada1b7398b028

data/CHANGELOG.md

@@ -19,6 +19,32 @@ every commit of every tag interval is accounted for one way or the other.
 
 ## [Unreleased]
 
+## [0.30.14] - 2026-10-05
+
+<!-- stamped -->
+
+### Fixed
+
+- **Railtie:** Honor `config.enabled` set in `config/initializers/profiler.rb`. The profiler
+  decided before the application's initializers had run, so `enabled = false` there still put its
+  middlewares in the stack, configured Sidekiq, included its ActiveJob instrumentation and, in
+  the test environment, loaded the test profiler, and `enabled = true` in production got none of
+  them. Those decisions are now taken once the application's initializers have run. An active
+  profiler keeps its place in the middleware stack, and its Sidekiq middlewares and ActiveJob
+  callbacks stay ahead of the ones the application installs. The profiler is now the outermost
+  layer around a job: it runs before every other Sidekiq middleware, including those of gems
+  loaded before it and those the application prepends (such as `Sidekiq::CurrentAttributes`),
+  and before the callbacks Rails adds to ActiveJob (logging, instrumentation, and on Rails 7.0
+  time zone and locale), so the duration of a profiled job now includes them.
+- **Railtie:** Keep the `enabled`, `storage` and `track_tests` values set with
+  `Profiler.configure` in `config/application.rb`, which the Rails defaults overwrote at boot, and
+  apply `config.profiler` (`config.profiler.enabled = false` in `config/application.rb`), which was
+  accepted and never read. A `config.profiler` key that is not a profiler option logs a warning.
+  `config/initializers/profiler.rb` still has the last word. Check these places when upgrading:
+  an `enabled` set with `Profiler.configure` in `config/application.rb` or in a
+  `config/environments` file, or with `config.profiler.enabled`, now takes effect, in production
+  too, where it was overwritten or ignored before.
+
 ## [0.30.13] - 2026-10-04
 
 <!-- stamped -->

data/lib/profiler/configuration.rb

@@ -25,7 +25,11 @@ module Profiler
       BUNDLE_GEMFILE BUNDLE_PATH BUNDLE_WITHOUT GEM_HOME GEM_PATH BOOTSNAP_CACHE_DIR
     ].freeze
 
-    attr_accessor :enabled, :storage_options, :collectors,
+    # Options whose default depends on the Rails environment: the railtie sets them only when
+    # the application has not assigned them itself (see #default).
+    RAILS_DEFAULTED = %i[enabled storage track_tests].freeze
+
+    attr_accessor :storage_options, :collectors,
                   :skip_paths, :slow_query_threshold, :max_queries_warning,
                   :track_memory, :memory_warning_threshold,
                   :mcp_enabled, :mcp_transport, :mcp_port,
@@ -36,7 +40,7 @@ module Profiler
                   :track_jobs,
                   :track_console,
                   :apply_env_overrides_when_disabled,
-                  :track_tests, :test_runner_allow_undiscovered_files,
+                  :test_runner_allow_undiscovered_files,
                   :track_mailers, :capture_mail_body, :sanitize_mailer_recipients, :mailer_skip_actions,
                   :compress_bodies, :compress_body_threshold,
                   :redact_sensitive_data, :filter_parameters, :env_allowlist,
@@ -47,9 +51,10 @@ module Profiler
 
     attr_writer :tmp_path
 
-    attr_reader :authorize_block
+    attr_reader :authorize_block, :enabled, :track_tests
 
     def initialize
+      @assigned = []
       @enabled = false
       @storage = :memory
       @storage_options = {}
@@ -112,6 +117,26 @@ module Profiler
       @tmp_path || default_tmp_path
     end
 
+    def enabled=(value)
+      @assigned |= [:enabled]
+      @enabled = value
+    end
+
+    def track_tests=(value)
+      @assigned |= [:track_tests]
+      @track_tests = value
+    end
+
+    # Sets one of RAILS_DEFAULTED to value unless the application assigned it, in
+    # config/application.rb for instance, which runs before the railtie's initializers.
+    def default(option, value)
+      raise ArgumentError, "#{option} has no Rails default" unless RAILS_DEFAULTED.include?(option)
+      return if @assigned.include?(option)
+
+      public_send("#{option}=", value)
+      @assigned.delete(option)
+    end
+
     def slave?
       !master_url.nil? && !master_url.empty?
     end
@@ -162,6 +187,7 @@ module Profiler
     end
 
     def storage=(value)
+      @assigned |= [:storage]
       @storage = value
       @storage_backend = nil
     end

data/lib/profiler/instrumentation/active_job_instrumentation.rb

@@ -8,11 +8,12 @@ module Profiler
       included do
         attr_accessor :profiler_parent_token
 
-        before_enqueue do |job|
+        # Ahead of the application's callbacks, which may already be there when this is included.
+        before_enqueue(prepend: true) do |job|
           job.profiler_parent_token = Profiler::CurrentContext.token
         end
 
-        around_perform do |job, block|
+        around_perform(prepend: true) do |job, block|
           Profiler::JobProfiler.profile(
             job_class: job.class.name,
             job_id: job.job_id,

data/lib/profiler/railtie.rb

@@ -6,27 +6,38 @@ module Profiler
   class Railtie < Rails::Railtie
     config.profiler = ActiveSupport::OrderedOptions.new
 
+    # Runs before the application's config/initializers, so that they override what it sets.
+    # The Rails defaults go only where config/application.rb, which runs earlier still, has not
+    # assigned the option, and config.profiler, also set there, is applied on top.
     initializer "profiler.set_configs" do |app|
-      # Set default configuration for Rails environment
+      development_or_test = Rails.env.development? || Rails.env.test?
       Profiler.configure do |config|
-        config.enabled = Rails.env.development? || Rails.env.test?
-        config.storage = (Rails.env.development? || Rails.env.test?) ? :file : :memory
-        config.tmp_path = Rails.root.join("tmp", "rails-profiler")
-        config.track_tests = Rails.env.test?
+        config.default(:enabled, development_or_test)
+        config.default(:storage, development_or_test ? :file : :memory)
+        config.default(:track_tests, Rails.env.test?)
+
+        app.config.profiler.each do |key, value|
+          if config.respond_to?("#{key}=")
+            config.public_send("#{key}=", value)
+          else
+            Rails.logger&.warn("[Profiler] config.profiler.#{key} is not a profiler option, ignored")
+          end
+        end
       end
     end
 
+    # Always inserted here, before the application's initializers have decided `enabled`, so
+    # that the profiler keeps its place in the stack relative to the middlewares they insert;
+    # profiler.remove_disabled_middleware takes it out again once they have run.
     initializer "profiler.insert_middleware", before: :build_middleware_stack do |app|
-      if Profiler.configuration.enabled
-        require_relative "middleware/profiler_middleware"
+      require_relative "middleware/profiler_middleware"
 
-        # Always inserted: it sets the framing headers of every profiler response, and its
-        # CORS headers only when extension_cors_enabled is set.
-        require_relative "middleware/cors_middleware"
-        app.middleware.insert_before 0, Profiler::Middleware::CorsMiddleware
+      # It sets the framing headers of every profiler response, and its CORS headers only
+      # when extension_cors_enabled is set.
+      require_relative "middleware/cors_middleware"
+      app.middleware.insert_before 0, Profiler::Middleware::CorsMiddleware
 
-        app.middleware.insert_before 0, Profiler::Middleware::ProfilerMiddleware
-      end
+      app.middleware.insert_before 0, Profiler::Middleware::ProfilerMiddleware
     end
 
     initializer "profiler.load_collectors" do
@@ -52,6 +63,17 @@ module Profiler
       end
     end
 
+    # Everything below runs after the application's config/initializers, where `enabled` is
+    # decided, and before the middleware stack is built. An initializer declared without
+    # `after:` runs after the one declared before it, so these stay declared last, in order.
+    initializer "profiler.remove_disabled_middleware", after: :load_config_initializers do |app|
+      next if Profiler.configuration.enabled
+
+      # Rails applies every delete after the other middleware operations, whatever their order.
+      app.middleware.delete Profiler::Middleware::ProfilerMiddleware
+      app.middleware.delete Profiler::Middleware::CorsMiddleware
+    end
+
     initializer "profiler.setup_test_profiler" do
       next unless Profiler.configuration.enabled && Profiler.configuration.track_tests
 
@@ -68,16 +90,19 @@ module Profiler
 
       require_relative "job_profiler"
 
+      # This runs after the application's initializers: prepend, not add, keeps the profiler
+      # ahead of the middlewares and callbacks they install, so that a job's profile covers them.
+      # Sidekiq::Middleware::Chain#prepend is there from Sidekiq 3.3 (2014) to 8.1 at least.
       if defined?(Sidekiq)
         require_relative "instrumentation/sidekiq_middleware"
         Sidekiq.configure_server do |config|
           config.server_middleware do |chain|
-            chain.add Profiler::Instrumentation::SidekiqMiddleware
+            chain.prepend Profiler::Instrumentation::SidekiqMiddleware
           end
         end
         Sidekiq.configure_client do |config|
           config.client_middleware do |chain|
-            chain.add Profiler::Instrumentation::SidekiqClientMiddleware
+            chain.prepend Profiler::Instrumentation::SidekiqClientMiddleware
           end
         end
       end

data/lib/profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Profiler
-  VERSION = "0.30.13"
+  VERSION = "0.30.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-profiler
 version: !ruby/object:Gem::Version
-  version: 0.30.13
+  version: 0.30.14
 platform: ruby
 authors:
 - Sébastien Duplessy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-04 00:00:00.000000000 Z
+date: 2026-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails