rails_spotlight 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78a4ca508d34706a04ef8d1b7e61cee43a76b9127555a30846156166b41c2c88
-  data.tar.gz: 444e8776ccbdf9840b9ef77cb80bf57d1e1ef99477e7b7c21915e062a3216903
+  metadata.gz: 5e36512b12e263c5853279d061fe2760ad7fff28c754c3362f8c848867845477
+  data.tar.gz: cc4696e37e250be0413f0286503f8a63fa18a2c43353114720e9580fa4fc646e
 SHA512:
-  metadata.gz: c37ba527e29e187dd4f7dac324bbcebbabf1380f0192813b6100eaf9290dc6a3423f5a1477673d266150ccbe8549644cd5643ff0526c817992d28649e0b3033f
-  data.tar.gz: 61ca4aff8b9a1f575ed502e167f6024af5db8146c659239728f6efa9636bc98732bd23016a9db4cd09a90a12543fd693c113095f8c3bdfc2c5a1c53c1cfc6d0c
+  metadata.gz: dd8e249fcfe8ced528c2f60225b00e8142e93989736d77090b9cc3ad0a9cf8c50dcbc85b9f76f196168ab1e6946f85d594c48935fe0751e8675d612f2d3fffa1
+  data.tar.gz: 925e741a5c6b755deed002c3833da4487a24a530d025177373fa86fca3a5ad2ef84d1730497c7c2ad128a2c9bf526127166252793b056e587ed43ab6a585dbea

data/README.md

@@ -38,8 +38,11 @@ file will be created in `config/rails_spotlight.yml`
   LOGGER: <%=Logger.new(Rails.root.join('log', 'rails_spotlight.log'))%>
   MIDDLEWARE_SKIPPED_PATHS: []
   NOT_ENCODABLE_EVENT_VALUES:
+  SKIP_RENDERED_IVARS: []
   # Rest of the configuration is required for ActionCable. It will be disabled automatically in when ActionCable is not available.
-  LIVE_CONSOLE_ENABLED: true
+  # LIVE_CONSOLE_ENABLED from version 0.2.3 do not require ActionCable to be enabled.
+  LIVE_CONSOLE_ENABLED: false
+  # Experimental feature.
   REQUEST_COMPLETED_BROADCAST_ENABLED: false
   AUTO_MOUNT_ACTION_CABLE: false
   ACTION_CABLE_MOUNT_PATH: /cable
@@ -47,6 +50,16 @@ file will be created in `config/rails_spotlight.yml`
   BLOCK_EDITING_FILES_OUTSIDE_OF_THE_PROJECT: true
 ```
 
+## Additional metrics
+
+To enable additional rendering metrics like local variables, instance variables, params etc. add to your layout file:
+
+```erb
+<% if Rails.env.development? %>
+  <%= RailsSpotlight::RenderViewReporter.report_rendered_view_locals(self, locals: local_assigns, params: params, skip_vars: %i[current_template], metadata: { just_test: 'Works' }) %>
+<% end %>
+```
+
 ## Troubleshooting
 
 Known issue:

data/lib/rails_spotlight/app_notifications.rb

@@ -31,6 +31,11 @@ module RailsSpotlight
       Event.new(name, start, ending, transaction_id, payload)
     }
 
+    VIEW_LOCALS_BLOCK = proc { |*args|
+      name, start, ending, transaction_id, payload = args
+      Event.new(name, start, ending, transaction_id, payload)
+    }
+
     # sql processing block - used for sql.active_record and sql.sequel
 
     # HACK: we hardcode the event name to 'sql.active_record' so that the ui will
@@ -75,6 +80,14 @@ module RailsSpotlight
         .subscribe('cache_write.active_support', &CACHE_BLOCK)
         .subscribe('cache_delete.active_support', &CACHE_BLOCK)
         .subscribe('cache_exist?.active_support', &CACHE_BLOCK)
+        .subscribe('render_view.locals', &VIEW_LOCALS_BLOCK)
+
+      # TODO: Consider adding these events
+      # start_processing.action_controller: Triggered when a controller action starts processing a request.
+      # send_file.action_controller: Triggered when a file is sent as a response.
+      # redirect_to.action_controller: Triggered when a redirect response is sent.
+      # halted_callback.action_controller: Triggered when a filter or callback halts the request.
+      # render_collection.action_view: This event is triggered when a collection is rendered using a partial. It includes details about the collection being rendered, such as the collection name and the partial being used to render each item.
     end
 
     def subscribe(event_name)

data/lib/rails_spotlight/configuration.rb

@@ -10,9 +10,29 @@ module RailsSpotlight
       'ActionDispatch' => ['ActionDispatch::Request', 'ActionDispatch::Response']
     }.freeze
 
+    SKIP_RENDERED_IVARS = %i[
+      @_routes
+      @_config
+      @view_renderer
+      @lookup_context
+      @_assigns
+      @_controller
+      @_request
+      @_default_form_builder
+      @view_flow
+      @output_buffer
+      @virtual_path
+      @tag_builder
+      @assets_environment
+      @asset_resolver_strategies
+      @_main_app
+      @_devise_route_context
+      @devise_mapping
+    ].freeze
+
     attr_reader :project_name, :source_path, :logger, :storage_path, :storage_pool_size, :middleware_skipped_paths,
                 :not_encodable_event_values, :action_cable_mount_path,
-                :block_editing_files, :block_editing_files_outside_of_the_project
+                :block_editing_files, :block_editing_files_outside_of_the_project, :skip_rendered_ivars
 
     def initialize(opts = {}) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
       @project_name = opts[:project_name] || detect_project_name
@@ -20,14 +40,15 @@ module RailsSpotlight
       @logger = opts[:logger] || Logger.new(File.join(self.class.rails_root, 'log', 'rails_spotlight.log'))
       @storage_path = opts[:storage_path] || File.join(self.class.rails_root, 'tmp', 'data', 'rails_spotlight')
       @storage_pool_size = opts[:storage_pool_size] || 20
-      @live_console_enabled = opts[:live_console_enabled].nil? ? true : true?(opts[:live_console_enabled])
-      @request_completed_broadcast_enabled = true?(opts[:request_completed_broadcast_enabled])
+      @live_console_enabled = opts[:live_console_enabled].nil? ? false : true?(opts[:live_console_enabled])
+      @request_completed_broadcast_enabled = opts[:request_completed_broadcast_enabled].nil? ? false : true?(opts[:request_completed_broadcast_enabled])
       @middleware_skipped_paths = opts[:middleware_skipped_paths] || []
       @not_encodable_event_values = DEFAULT_NOT_ENCODABLE_EVENT_VALUES.merge(opts[:not_encodable_event_values] || {})
-      @auto_mount_action_cable = opts[:auto_mount_action_cable].nil? ? true : true?(opts[:auto_mount_action_cable])
+      @auto_mount_action_cable = opts[:auto_mount_action_cable].nil? ? false : true?(opts[:auto_mount_action_cable])
       @action_cable_mount_path = opts[:action_cable_mount_path] || '/cable'
-      @block_editing_files = opts[:block_editing_files].nil? ? true : true?(opts[:block_editing_files])
-      @block_editing_files_outside_of_the_project = opts[:block_editing_files_outside_of_the_project].nil? ? false : true?(opts[:block_editing_files_outside_of_the_project])
+      @block_editing_files = opts[:block_editing_files].nil? ? false : true?(opts[:block_editing_files])
+      @block_editing_files_outside_of_the_project = opts[:block_editing_files_outside_of_the_project].nil? ? true : true?(opts[:block_editing_files_outside_of_the_project])
+      @skip_rendered_ivars = SKIP_RENDERED_IVARS + (opts[:skip_rendered_ivars] || []).map(&:to_sym)
     end
 
     def live_console_enabled

data/lib/rails_spotlight/render_view_reporter.rb

@@ -0,0 +1,32 @@
+module RailsSpotlight
+  class RenderViewReporter
+    def self.report_rendered_view_locals(view, locals: nil, params: nil, show_devise: false, skip_vars: [], metadata: {})
+      ActiveSupport::Notifications.instrument(
+        'render_view.locals',
+        params: params,
+        locals: serialize_as_json(locals),
+        instance_variables: dev_instance_variables(view, skip_vars: skip_vars, show_devise: show_devise),
+        metadata: metadata
+      )
+    end
+
+    def self.serialize_as_json(value)
+      value.respond_to?(:as_json) ? value.as_json : nil
+    rescue => e
+      {
+        __serialization_error: e.message,
+        __source: value.inspect
+      }
+    end
+
+    def self.dev_instance_variables(source, skip_vars: [], show_devise: false)
+      source.instance_variables.map do |name|
+        next if skip_vars.include?(name)
+        next if RailsSpotlight.config.skip_rendered_ivars.include?(name)
+        next if !show_devise && name == :@devise_parameter_sanitizer
+
+        [name[1..], source.instance_variable_get(name)]
+      end.compact.to_h
+    end
+  end
+end

data/lib/rails_spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsSpotlight
-  VERSION = '0.2.3'
+  VERSION = '0.2.5'
 end

data/lib/rails_spotlight.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
 module RailsSpotlight
-  autoload :VERSION,          'rails_spotlight/version'
-  autoload :Configuration,    'rails_spotlight/configuration'
-  autoload :Storage,          'rails_spotlight/storage'
-  autoload :Event,            'rails_spotlight/event'
-  autoload :AppRequest,       'rails_spotlight/app_request'
-  autoload :Middlewares,      'rails_spotlight/middlewares'
-  autoload :LogInterceptor,   'rails_spotlight/log_interceptor'
-  autoload :AppNotifications, 'rails_spotlight/app_notifications'
-  autoload :Utils,            'rails_spotlight/utils'
+  autoload :VERSION,            'rails_spotlight/version'
+  autoload :Configuration,      'rails_spotlight/configuration'
+  autoload :Storage,            'rails_spotlight/storage'
+  autoload :Event,              'rails_spotlight/event'
+  autoload :AppRequest,         'rails_spotlight/app_request'
+  autoload :Middlewares,        'rails_spotlight/middlewares'
+  autoload :LogInterceptor,     'rails_spotlight/log_interceptor'
+  autoload :AppNotifications,   'rails_spotlight/app_notifications'
+  autoload :Utils,              'rails_spotlight/utils'
+  autoload :RenderViewReporter, 'rails_spotlight/render_view_reporter'
 
   class << self
     def config

data/lib/tasks/init.rake

@@ -18,8 +18,11 @@ namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
       LOGGER: <%=Logger.new(Rails.root.join('log', 'rails_spotlight.log'))%>
       MIDDLEWARE_SKIPPED_PATHS: []
       NOT_ENCODABLE_EVENT_VALUES:
+      SKIP_RENDERED_IVARS: []
       # Rest of the configuration is required for ActionCable. It will be disabled automatically in when ActionCable is not available.
-      LIVE_CONSOLE_ENABLED: true
+      # LIVE_CONSOLE_ENABLED from version 0.2.3 do not require ActionCable to be enabled.
+      LIVE_CONSOLE_ENABLED: false
+      # Experimental feature.
       REQUEST_COMPLETED_BROADCAST_ENABLED: false
       AUTO_MOUNT_ACTION_CABLE: false
       ACTION_CABLE_MOUNT_PATH: /cable

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_spotlight
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Pawel Niemczyk
@@ -260,6 +260,7 @@ files:
 - lib/rails_spotlight/middlewares/request_handler.rb
 - lib/rails_spotlight/rails_command_executor.rb
 - lib/rails_spotlight/railtie.rb
+- lib/rails_spotlight/render_view_reporter.rb
 - lib/rails_spotlight/storage.rb
 - lib/rails_spotlight/utils.rb
 - lib/rails_spotlight/version.rb