rails-profiler 0.31.2 → 0.31.4

data/lib/profiler/storage/unavailable.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Profiler
+  module Storage
+    # Stands in for a store that could not be created (an index or lock replaced by a symbolic
+    # link, a directory that cannot be written, a database that cannot be opened): the cause is
+    # said once per process, without a backtrace, rather than with one on every request. Saves are
+    # dropped; reads, which a person asked for from the dashboard or an MCP tool, raise the cause.
+    # Profiler.storage tries to create the store again on its next call, so fixing the cause is
+    # enough.
+    class Unavailable
+      # What the reads raise: the cause in one line, without a path (the profiler's routes answer
+      # it as a 503, the MCP tools as an error).
+      class Error < Profiler::Error; end
+
+      @said = {}
+      @mutex = Mutex.new
+
+      class << self
+        def for(error)
+          key = [Process.pid, error.class.name, error.message]
+          first = @mutex.synchronize { @said[key] ? false : (@said[key] = true) }
+          if first
+            warn "[Profiler] storage unavailable, profiles are not saved until it is fixed: " \
+                 "#{error.class}: #{error.message}"
+          end
+          new(error)
+        end
+
+        def reset!
+          @mutex.synchronize { @said = {} }
+        end
+      end
+
+      def initialize(error)
+        @error = Error.new("The profiler storage is unavailable: #{self.class.short_cause(error)}")
+      end
+
+      # First line of the message, absolute paths replaced, credentials masked, at most 300
+      # characters.
+      def self.short_cause(error)
+        line = error.message.to_s.lines.first.to_s.strip
+        line = line.gsub(%r{(?<=\A|[\s'"(=])(?:[A-Za-z]:)?[/\\][^\s'"]*[^\s'":,.;)]}, "[path]")
+        line = Redaction.hide_credentials(line) if defined?(Redaction)
+        line = line[0, 300]
+        line.empty? ? error.class.name : line
+      end
+
+      def save(token, _profile)
+        token
+      end
+
+      %i[load list cleanup exists? find_by_parent delete clear].each do |name|
+        define_method(name) { |*, **| raise @error }
+      end
+    end
+  end
+end

data/lib/profiler/test_helpers/reporter.rb

@@ -8,7 +8,7 @@ module Profiler
       def self.print
         return unless Profiler.enabled?
 
-        profiles = Profiler.storage.list(limit: 1000).select { |p| p.profile_type == "test" }
+        profiles = Profiler.storage.list(limit: 1000, type: "test").select { |p| p.profile_type == "test" }
         return if profiles.empty?
 
         passed  = profiles.count { |p| test_status(p) == "passed" }

data/lib/profiler/version.rb

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

data/lib/profiler.rb

@@ -16,6 +16,9 @@ module Profiler
     attr_accessor :function_profiling_max_frames
     attr_accessor :function_profiling_mode
     attr_accessor :function_profiling_clock
+    # Without stackprof, the function profiler stays off unless this is true: it then traces
+    # every method call of the request's thread with a TracePoint, several times slower.
+    attr_accessor :function_profiling_tracepoint_fallback
 
     def configuration
       @configuration ||= Configuration.new
@@ -25,8 +28,17 @@ module Profiler
       yield(configuration)
     end
 
+    STORAGE_LOCK = Mutex.new
+
+    # Built once, under a lock: the first requests of a threaded server ask for it together, and
+    # a profile saved into a store that another thread replaced would be lost. Read without the
+    # lock once it exists.
+    # A store that cannot be created is said once (Storage::Unavailable) and tried again on the
+    # next call.
     def storage
-      @storage ||= configuration.storage_backend
+      @storage || STORAGE_LOCK.synchronize { @storage ||= configuration.storage_backend }
+    rescue StandardError => e
+      Storage::Unavailable.for(e)
     end
 
     # Saves a profile from a path of the application (a job, a console command, a test, an
@@ -114,6 +126,7 @@ module Profiler
   self.function_profiling_max_frames = 2000
   self.function_profiling_mode = "lite"
   self.function_profiling_clock = "wall"
+  self.function_profiling_tracepoint_fallback = false
 end
 
 # Require core components
@@ -136,8 +149,11 @@ require_relative "profiler/collectors/mailer_collector"
 
 require_relative "profiler/storage/token"
 require_relative "profiler/storage/private_files"
+require_relative "profiler/storage/unavailable"
+require_relative "profiler/ajax_data"
 require_relative "profiler/env_override_store"
 require_relative "profiler/instrumentation/thread_context_propagation"
+require_relative "profiler/instrumentation/executor_context_propagation"
 require_relative "profiler/sse/event_bus"
 require_relative "profiler/sse/redis_event_bus"
 require_relative "profiler/sse/bus"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-profiler
 version: !ruby/object:Gem::Version
-  version: 0.31.2
+  version: 0.31.4
 platform: ruby
 authors:
 - Sébastien Duplessy
@@ -133,6 +133,7 @@ files:
 - config/routes.rb
 - exe/profiler-mcp
 - lib/profiler.rb
+- lib/profiler/ajax_data.rb
 - lib/profiler/allocation_counter.rb
 - lib/profiler/boot_env.rb
 - lib/profiler/cluster/master_client.rb
@@ -158,6 +159,7 @@ files:
 - lib/profiler/collectors/mailer_collector.rb
 - lib/profiler/collectors/request_collector.rb
 - lib/profiler/collectors/routes_collector.rb
+- lib/profiler/collectors/scoped_notifications.rb
 - lib/profiler/collectors/test_collector.rb
 - lib/profiler/collectors/view_collector.rb
 - lib/profiler/configuration.rb
@@ -167,8 +169,10 @@ files:
 - lib/profiler/env_override_store.rb
 - lib/profiler/explain_runner.rb
 - lib/profiler/instrumentation/active_job_instrumentation.rb
+- lib/profiler/instrumentation/executor_context_propagation.rb
 - lib/profiler/instrumentation/irb_instrumentation.rb
 - lib/profiler/instrumentation/net_http_instrumentation.rb
+- lib/profiler/instrumentation/request_context.rb
 - lib/profiler/instrumentation/sidekiq_middleware.rb
 - lib/profiler/instrumentation/thread_context_propagation.rb
 - lib/profiler/job_profiler.rb
@@ -215,6 +219,7 @@ files:
 - lib/profiler/models/profile.rb
 - lib/profiler/models/sql_query.rb
 - lib/profiler/models/timeline_event.rb
+- lib/profiler/process_snapshot.rb
 - lib/profiler/railtie.rb
 - lib/profiler/redaction.rb
 - lib/profiler/sql_statement.rb
@@ -228,7 +233,9 @@ files:
 - lib/profiler/storage/private_files.rb
 - lib/profiler/storage/redis_store.rb
 - lib/profiler/storage/sqlite_store.rb
+- lib/profiler/storage/summary.rb
 - lib/profiler/storage/token.rb
+- lib/profiler/storage/unavailable.rb
 - lib/profiler/tasks/profiler.rake
 - lib/profiler/test_helpers/minitest_support.rb
 - lib/profiler/test_helpers/reporter.rb