rails_mini_profiler 0.7.0 → 0.7.1

data/lib/rails_mini_profiler/tracers/instantiation_tracer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  module Tracers
+    class InstantiationTracer < Tracer
+      class << self
+        def subscribes_to
+          'instantiation.active_record'
+        end
+
+        def presents
+          InstantiationTracePresenter
+        end
+      end
+    end
+  end
+end

data/lib/rails_mini_profiler/{tracing → tracers}/null_trace.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  module Tracing
+  module Tracers
     class NullTrace < Trace; end
   end
 end

data/lib/rails_mini_profiler/tracers/registry.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  module Tracers
+    # This serves as a central store for tracers. Based on the configuration, indidual tracers are registered and are
+    # then available to subscribe to events or render traced events.
+    #
+    # @api private
+    class Registry
+      class << self
+        def setup!(config)
+          new(config)
+        end
+      end
+
+      def initialize(config)
+        @config = config
+        @config.tracers.each { |tracer| add(tracer) }
+      end
+
+      # Tracers that are available in the application, indexed by events they subscribe to.
+      #
+      # @return [Hash] a hash where keys are event names and values are the corresponding tracers
+      def tracers
+        @tracers ||=
+          tracer_map
+            .values
+            .each_with_object({}) do |tracer, obj|
+            subscriptions = wrap(tracer.subscribes_to)
+            subscriptions.each { |subscription| obj[subscription] = tracer }
+          end
+      end
+
+      # Presenters that are available in the application, indexed by events they should present.
+      #
+      # @return [Hash] a hash where keys are event names and values are the corresponding presenters
+      def presenters
+        @presenters ||=
+          tracer_map
+            .values
+            .each_with_object({}) do |tracer, obj|
+            presenters = tracer.presents
+            if presenters.is_a?(Hash)
+              obj.merge!(presenters)
+            else
+              obj[tracer.subscribes_to] = presenters
+            end
+          end
+      end
+
+      private
+
+      def tracer_map
+        @tracer_map ||= {}
+      end
+
+      def add(tracer)
+        tracer = tracer.to_sym
+        tracer = "#{tracer.to_s.camelize}Tracer"
+        constant = "RailsMiniProfiler::Tracers::#{tracer}".safe_constantize
+
+        tracer_map[tracer] = constant if constant
+      end
+
+      def wrap(object)
+        if object.nil?
+          []
+        elsif object.respond_to?(:to_ary)
+          object.to_ary || [object]
+        else
+          [object]
+        end
+      end
+    end
+  end
+end

data/lib/rails_mini_profiler/tracers/rmp_tracer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  module Tracers
+    class RmpTracer < Tracer
+      class << self
+        def subscribes_to
+          'rails_mini_profiler.total_time'
+        end
+
+        def presents
+          RmpTracePresenter
+        end
+      end
+    end
+  end
+end

data/lib/rails_mini_profiler/{tracing → tracers}/sequel_tracer.rb

@@ -1,8 +1,22 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  module Tracing
+  module Tracers
     class SequelTracer < Tracer
+      class << self
+        def subscribes_to
+          'sql.active_record'
+        end
+
+        def build_from(event)
+          new(event).trace
+        end
+
+        def presents
+          SequelTracePresenter
+        end
+      end
+
       def trace
         return NullTrace.new if ignore?
 

data/lib/rails_mini_profiler/{tracing → tracers}/sequel_tracker.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  module Tracing
+  module Tracers
+    # Utility to clean up and simplify SQL Notification events.
+    #
+    # @api private
     class SqlTracker
       TRACKED_SQL_COMMANDS = %w[SELECT INSERT UPDATE DELETE].freeze
       UNTRACKED_NAMES = %w[SCHEMA].freeze

data/lib/rails_mini_profiler/{tracing → tracers}/subscriptions.rb

@@ -1,20 +1,14 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  module Tracing
+  module Tracers
+    # Subscribe to application events. This is used during engine startup.
+    # @api private
     class Subscriptions
-      DEFAULT_SUBSCRIPTIONS = %w[
-        sql.active_record
-        instantiation.active_record
-        render_template.action_view
-        render_partial.action_view
-        process_action.action_controller
-        rails_mini_profiler.total_time
-      ].freeze
-
       class << self
-        def setup!(&callback)
-          DEFAULT_SUBSCRIPTIONS.each do |event|
+        # Subscribe to each individual active support event using a callback.
+        def setup!(subscriptions, &callback)
+          subscriptions.each do |event|
             subscribe(event, &callback)
           end
         end

data/lib/rails_mini_profiler/{tracing → tracers}/trace.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  module Tracing
+  module Tracers
     # A simplified representation of a trace.
     #
     # Is transformed into [RailsMiniProfiler::Trace] when recording has finished.
@@ -23,7 +23,7 @@ module RailsMiniProfiler
     # @!attribute backtrace
     #   @return [String] the line where this trace was recorded
     # @!attribute allocations
-    #   @return [Integer] the number of alloactions
+    #   @return [Integer] the number of allocations
     # @!attribute created_at
     #   @return [DateTime] the creation date
     # @!attribute updated_at

data/lib/rails_mini_profiler/tracers/trace_factory.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  module Tracers
+    # Creates traces based on the tracers registered with the application
+    #
+    # For example, an event with name 'sequel' will result in the lookup of a tracers that responds to that particular
+    # event. The tracer itself will then build the trace from the event.
+    #
+    # @api private
+    class TraceFactory
+      def initialize(registry)
+        @tracers = registry.tracers
+      end
+
+      # Create a new trace from an event
+      #
+      # @param event [ActiveSupport::Notifications::Event] an event from the application
+      #
+      # @return [Trace] a processed trace
+      def create(event)
+        tracer = @tracers[event.name] || Tracer
+        tracer.build_from(event)
+      end
+    end
+  end
+end

data/lib/rails_mini_profiler/{tracing → tracers}/tracer.rb

@@ -1,8 +1,22 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  module Tracing
+  module Tracers
     class Tracer
+      class << self
+        def subscribes_to
+          []
+        end
+
+        def presents
+          TracePresenter
+        end
+
+        def build_from(event)
+          new(event).trace
+        end
+      end
+
       def initialize(event)
         @event = event_data(event)
       end

data/lib/rails_mini_profiler/tracers/view_tracer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  module Tracers
+    class ViewTracer < Tracer
+      class << self
+        def subscribes_to
+          %w[render_template.action_view render_partial.action_view]
+        end
+
+        def build_from(event)
+          new(event).trace
+        end
+
+        def presents
+          {
+            'render_template.action_view' => RenderTemplateTracePresenter,
+            'render_partial.action_view' => RenderPartialTracePresenter
+          }
+        end
+      end
+
+      def trace
+        @event[:payload].slice!(:identifier, :count)
+        super
+      end
+    end
+  end
+end

data/lib/rails_mini_profiler/tracers.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails_mini_profiler/tracers/registry'
+require 'rails_mini_profiler/tracers/subscriptions'
+require 'rails_mini_profiler/tracers/trace'
+require 'rails_mini_profiler/tracers/tracer'
+require 'rails_mini_profiler/tracers/controller_tracer'
+require 'rails_mini_profiler/tracers/instantiation_tracer'
+require 'rails_mini_profiler/tracers/sequel_tracker'
+require 'rails_mini_profiler/tracers/sequel_tracer'
+require 'rails_mini_profiler/tracers/view_tracer'
+require 'rails_mini_profiler/tracers/rmp_tracer'
+require 'rails_mini_profiler/tracers/null_trace'
+require 'rails_mini_profiler/tracers/trace_factory'

data/lib/rails_mini_profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

data/lib/rails_mini_profiler.rb

@@ -8,7 +8,7 @@ require 'rails_mini_profiler/version'
 require 'rails_mini_profiler/engine'
 
 require 'rails_mini_profiler/models/base_model'
-require 'rails_mini_profiler/tracing'
+require 'rails_mini_profiler/tracers'
 require 'rails_mini_profiler/configuration'
 
 require 'rails_mini_profiler/user'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_mini_profiler
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - hschne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-27 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inline_svg
@@ -125,14 +125,8 @@ files:
 - app/javascript/stylesheets/rails-mini-profiler.scss
 - app/javascript/stylesheets/traces.scss
 - app/models/rails_mini_profiler/application_record.rb
-- app/models/rails_mini_profiler/controller_trace.rb
 - app/models/rails_mini_profiler/flamegraph.rb
-- app/models/rails_mini_profiler/instantiation_trace.rb
 - app/models/rails_mini_profiler/profiled_request.rb
-- app/models/rails_mini_profiler/render_partial_trace.rb
-- app/models/rails_mini_profiler/render_template_trace.rb
-- app/models/rails_mini_profiler/rmp_trace.rb
-- app/models/rails_mini_profiler/sequel_trace.rb
 - app/models/rails_mini_profiler/trace.rb
 - app/presenters/rails_mini_profiler/base_presenter.rb
 - app/presenters/rails_mini_profiler/controller_trace_presenter.rb
@@ -191,16 +185,19 @@ files:
 - lib/rails_mini_profiler/request_context.rb
 - lib/rails_mini_profiler/request_wrapper.rb
 - lib/rails_mini_profiler/response_wrapper.rb
-- lib/rails_mini_profiler/tracing.rb
-- lib/rails_mini_profiler/tracing/controller_tracer.rb
-- lib/rails_mini_profiler/tracing/null_trace.rb
-- lib/rails_mini_profiler/tracing/sequel_tracer.rb
-- lib/rails_mini_profiler/tracing/sequel_tracker.rb
-- lib/rails_mini_profiler/tracing/subscriptions.rb
-- lib/rails_mini_profiler/tracing/trace.rb
-- lib/rails_mini_profiler/tracing/trace_factory.rb
-- lib/rails_mini_profiler/tracing/tracer.rb
-- lib/rails_mini_profiler/tracing/view_tracer.rb
+- lib/rails_mini_profiler/tracers.rb
+- lib/rails_mini_profiler/tracers/controller_tracer.rb
+- lib/rails_mini_profiler/tracers/instantiation_tracer.rb
+- lib/rails_mini_profiler/tracers/null_trace.rb
+- lib/rails_mini_profiler/tracers/registry.rb
+- lib/rails_mini_profiler/tracers/rmp_tracer.rb
+- lib/rails_mini_profiler/tracers/sequel_tracer.rb
+- lib/rails_mini_profiler/tracers/sequel_tracker.rb
+- lib/rails_mini_profiler/tracers/subscriptions.rb
+- lib/rails_mini_profiler/tracers/trace.rb
+- lib/rails_mini_profiler/tracers/trace_factory.rb
+- lib/rails_mini_profiler/tracers/tracer.rb
+- lib/rails_mini_profiler/tracers/view_tracer.rb
 - lib/rails_mini_profiler/user.rb
 - lib/rails_mini_profiler/version.rb
 - lib/tasks/rails_mini_profiler_tasks.rake

data/app/models/rails_mini_profiler/controller_trace.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: rmp_traces
-#
-#  id                      :integer          not null, primary key
-#  rmp_profiled_request_id :bigint           not null
-#  name                    :string
-#  start                   :bigint
-#  finish                  :bigint
-#  duration                :integer
-#  allocations             :bigint
-#  payload                 :json
-#  backtrace               :json
-#  created_at              :datetime         not null
-#  updated_at              :datetime         not null
-#
-# Indexes
-#
-#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
-#
-module RailsMiniProfiler
-  class ControllerTrace < Trace
-    store :payload, accessors: %i[view_runtime db_runtime]
-
-    class << self
-      def find_sti_class(_)
-        super(name)
-      end
-
-      def sti_name
-        'process_action.action_controller'
-      end
-    end
-  end
-end

data/app/models/rails_mini_profiler/instantiation_trace.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: rmp_traces
-#
-#  id                      :integer          not null, primary key
-#  rmp_profiled_request_id :bigint           not null
-#  name                    :string
-#  start                   :bigint
-#  finish                  :bigint
-#  duration                :integer
-#  allocations             :bigint
-#  payload                 :json
-#  backtrace               :json
-#  created_at              :datetime         not null
-#  updated_at              :datetime         not null
-#
-# Indexes
-#
-#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
-#
-module RailsMiniProfiler
-  class InstantiationTrace < Trace
-    store :payload, accessors: %i[record_count class_name]
-
-    class << self
-      def find_sti_class(_)
-        super(name)
-      end
-
-      def sti_name
-        'instantiation.active_record'
-      end
-    end
-  end
-end

data/app/models/rails_mini_profiler/render_partial_trace.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: rmp_traces
-#
-#  id                      :integer          not null, primary key
-#  rmp_profiled_request_id :bigint           not null
-#  name                    :string
-#  start                   :bigint
-#  finish                  :bigint
-#  duration                :integer
-#  allocations             :bigint
-#  payload                 :json
-#  backtrace               :json
-#  created_at              :datetime         not null
-#  updated_at              :datetime         not null
-#
-# Indexes
-#
-#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
-#
-module RailsMiniProfiler
-  class RenderPartialTrace < Trace
-    store :payload, accessors: %i[identifier]
-
-    class << self
-      def find_sti_class(_)
-        super(name)
-      end
-
-      def sti_name
-        'render_partial.action_view'
-      end
-    end
-  end
-end

data/app/models/rails_mini_profiler/render_template_trace.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: rmp_traces
-#
-#  id                      :integer          not null, primary key
-#  rmp_profiled_request_id :bigint           not null
-#  name                    :string
-#  start                   :bigint
-#  finish                  :bigint
-#  duration                :integer
-#  allocations             :bigint
-#  payload                 :json
-#  backtrace               :json
-#  created_at              :datetime         not null
-#  updated_at              :datetime         not null
-#
-# Indexes
-#
-#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
-#
-module RailsMiniProfiler
-  class RenderTemplateTrace < Trace
-    store :payload, accessors: %i[identifier]
-
-    class << self
-      def find_sti_class(_)
-        super(name)
-      end
-
-      def sti_name
-        'render_template.action_view'
-      end
-    end
-  end
-end

data/app/models/rails_mini_profiler/rmp_trace.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: rmp_traces
-#
-#  id                      :integer          not null, primary key
-#  rmp_profiled_request_id :bigint           not null
-#  name                    :string
-#  start                   :bigint
-#  finish                  :bigint
-#  duration                :integer
-#  allocations             :bigint
-#  payload                 :json
-#  backtrace               :json
-#  created_at              :datetime         not null
-#  updated_at              :datetime         not null
-#
-# Indexes
-#
-#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
-#
-module RailsMiniProfiler
-  class RmpTrace < Trace
-    class << self
-      def find_sti_class(_)
-        super(name)
-      end
-
-      def sti_name
-        'rails_mini_profiler.total_time'
-      end
-    end
-  end
-end

data/app/models/rails_mini_profiler/sequel_trace.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: rmp_traces
-#
-#  id                      :integer          not null, primary key
-#  rmp_profiled_request_id :bigint           not null
-#  name                    :string
-#  start                   :bigint
-#  finish                  :bigint
-#  duration                :integer
-#  allocations             :bigint
-#  payload                 :json
-#  backtrace               :json
-#  created_at              :datetime         not null
-#  updated_at              :datetime         not null
-#
-# Indexes
-#
-#  index_rmp_traces_on_rmp_profiled_request_id  (rmp_profiled_request_id)
-#
-module RailsMiniProfiler
-  class SequelTrace < Trace
-    store :payload, accessors: %i[name sql binds]
-
-    class << self
-      def find_sti_class(_)
-        super(name)
-      end
-
-      def sti_name
-        'sql.active_record'
-      end
-    end
-  end
-end

data/lib/rails_mini_profiler/tracing/trace_factory.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module RailsMiniProfiler
-  module Tracing
-    class TraceFactory
-      class << self
-        def create(event)
-          factory = new(event)
-          factory.create
-        end
-      end
-
-      def initialize(event)
-        @event = event
-      end
-
-      def create
-        trace_class.new(@event).trace
-      end
-
-      private
-
-      def trace_class
-        case @event.name
-        when 'sql.active_record'
-          SequelTracer
-        when 'render_template.action_view', 'render_partial.action_view'
-          ViewTracer
-        when 'process_action.action_controller'
-          ControllerTracer
-        else
-          Tracer
-        end
-      end
-    end
-  end
-end

data/lib/rails_mini_profiler/tracing/view_tracer.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module RailsMiniProfiler
-  module Tracing
-    class ViewTracer < Tracer
-      def trace
-        @event[:payload].slice!(:identifier, :count)
-        super
-      end
-    end
-  end
-end

data/lib/rails_mini_profiler/tracing.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_mini_profiler/tracing/subscriptions'
-require 'rails_mini_profiler/tracing/trace'
-require 'rails_mini_profiler/tracing/tracer'
-require 'rails_mini_profiler/tracing/controller_tracer'
-require 'rails_mini_profiler/tracing/sequel_tracker'
-require 'rails_mini_profiler/tracing/sequel_tracer'
-require 'rails_mini_profiler/tracing/view_tracer'
-require 'rails_mini_profiler/tracing/null_trace'
-require 'rails_mini_profiler/tracing/trace_factory'