rails_spotlight 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97fa9dc74cea28532602f60c83e5dd0c5ca79f6bd63ad68f8d1b1cd84a5ce0b7
-  data.tar.gz: 002f2d9081c6877a6c569f49db2f17e2fcb02d4cc2800e0a69cff5375c89ab2f
+  metadata.gz: ed7177dae7290c4108d3f82dbe6705449358e3b8805219b6780e93924547419e
+  data.tar.gz: e4c0c873e82299d1637e43ef0c844c4444150677b24881ab570e508023f154e2
 SHA512:
-  metadata.gz: 637f0d742d42129342fc6733a823e72c2fdf9f00c627dd137f78f2f7b0801108c5c522c208123383139f84335e6d02c3e3493efd986b0bd328e8097f7d769678
-  data.tar.gz: 80eac812bd515eda62d6ed28123b114b287e35b8467542837ef789fda7f43498f2188227ec5c3eb8959691d4b6d0b70d7279fe9b2b166fec2b48d18c92df8921
+  metadata.gz: 0d04a55bf3d180539e32f12dd183ee910e94a543ce81c416dd14b8d9d027ee271bbb099071c8c3b9e921303d14e3d4e4b026619e73ef44b17f762c4e045b54a4
+  data.tar.gz: d0dd1ccb93add3a50cb773d9cc4019aac268363f673a688a8b1c6aea39b33eceea61eee51e8f656a49798e9213b8a2d1c76661a0b2ffe3d3d7301e681149b36d

data/README.md

@@ -38,6 +38,7 @@ file will be created in `config/rails_spotlight.yml`
 ### Configuration options
 
 ```yaml
+  ENABLED: true
   # Default configuration for RailsSpotlight
   PROJECT_NAME: <%=Rails.application.class.respond_to?(:module_parent_name) ? Rails.application.class.module_parent_name : Rails.application.class.parent_name%>
   SOURCE_PATH: <%=Rails.root%>
@@ -143,7 +144,6 @@ You can add to your Initializers `config/initializers/rails_spotlight.rb` file w
   end
 ```
 
-
 ## Troubleshooting
 
 Known issue:

data/fake_spec_res/config/rails_spotlight.yml

@@ -1,3 +1,4 @@
+  ENABLED: true
   # Default configuration for RailsSpotlight
   PROJECT_NAME: <%=Rails.application.class.respond_to?(:module_parent_name) ? Rails.application.class.module_parent_name : Rails.application.class.parent_name%>
   SOURCE_PATH: <%=Rails.root%>
@@ -15,6 +16,7 @@
   SKIP_RENDERED_IVARS: []
   
   # Features
+  LOGS_ENABLED: true
   FILE_MANAGER_ENABLED: true
   RUBOCOP_ENABLED: true
   SQL_CONSOLE_ENABLED: true

data/lib/rails_spotlight/configuration.rb

@@ -40,13 +40,15 @@ module RailsSpotlight
       @devise_mapping
     ].freeze
 
-    attr_reader :project_name, :source_path, :logger, :storage_path, :storage_pool_size, :middleware_skipped_paths,
-                :not_encodable_event_values, :cable_mount_path,
+    attr_reader :enabled, :project_name, :source_path, :logger, :storage_path, :storage_pool_size, :middleware_skipped_paths,
+                :not_encodable_event_values, :cable_mount_path, :logs_enabled,
                 :file_manager_enabled, :block_editing_files, :block_editing_files_outside_of_the_project, :skip_rendered_ivars,
                 :directory_index_ignore, :rubocop_enabled, :rubocop_config_path, :use_cable, :default_rs_src,
                 :form_js_execution_token, :sql_console_enabled, :irb_console_enabled, :data_access_token
 
     def initialize(opts = {}) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+      @enabled = bool_val(:enabled, opts, default: false)
+      @logs_enabled = bool_val(:logs_enabled, opts, default: true)
       @project_name = opts[:project_name] || detect_project_name
       @source_path = opts[:source_path] || self.class.rails_root
       @logger = opts[:logger] || Logger.new(File.join(self.class.rails_root, 'log', 'rails_spotlight.log'))
@@ -80,6 +82,8 @@ module RailsSpotlight
     def auto_mount_cable = @auto_mount_cable && use_cable && action_cable_present?
     def action_cable_present? = defined?(ActionCable) && true
 
+    alias enabled? enabled
+    alias logs_enabled? logs_enabled
     alias cable_console_enabled? cable_console_enabled
     alias cable_logs_enabled? cable_logs_enabled
     alias use_cable? use_cable

data/lib/rails_spotlight/log_interceptor.rb

@@ -38,9 +38,9 @@ module RailsSpotlight
 
     private
 
-    def _skip_logging?(message)
+    def _skip_cable_logging?(message)
       return false unless ::RailsSpotlight.config.use_cable?
-      return false unless message.is_a?(String)
+      return false unless ActionCable.server.config&.cable&.dig(:adapter).present?
 
       message.include?(::RailsSpotlight::Channels::SPOTLIGHT_CHANNEL)
     end
@@ -60,13 +60,14 @@ module RailsSpotlight
         end
       end
 
-      return if _skip_logging?(message)
+      return unless message.is_a?(String)
 
       callsite = Utils.dev_callsite(caller.drop(1))
       name = progname.is_a?(String) || progname.is_a?(Symbol) ? progname : nil
-      message = yield if message.nil? && block_given?
 
       AppRequest.current.events << Event.new('rsl.notification.log', 0, 0, 0, (callsite || {}).merge(message:, level: severity, progname: name)) if AppRequest.current
+      return if _skip_cable_logging?(message)
+
       ::RailsSpotlight::Channels::SpotlightChannel.broadcast_log(message, level, callsite, name)
     rescue StandardError => e
       RailsSpotlight.config.logger.fatal("#{e.message}\n #{e.backtrace&.join("\n ")}")

data/lib/rails_spotlight/middlewares/concerns/skip_request_paths.rb

@@ -3,7 +3,7 @@
 module RailsSpotlight
   module Middlewares
     module SkipRequestPaths
-      PATHS_TO_SKIP = %w[/__better_errors /__rails_spotlight /__meta_request].freeze
+      PATHS_TO_SKIP = %w[/__better_errors /__rails_spotlight /__meta_request /rails].freeze
 
       private
 

data/lib/rails_spotlight/middlewares/header_marker.rb

@@ -15,8 +15,10 @@ module RailsSpotlight
 
       def call(env)
         request_path = env['PATH_INFO']
+        return app.call(env) if skip?(request_path)
+
         middleware = Rack::ResponseHeaders.new(app) do |headers|
-          headers['X-Rails-Spotlight-Version'] = RailsSpotlight::VERSION unless skip?(request_path)
+          headers['X-Rails-Spotlight-Version'] = RailsSpotlight::VERSION
         end
         middleware.call(env)
       end
@@ -25,7 +27,7 @@ module RailsSpotlight
 
       attr_reader :app, :app_config
 
-      def default_skip_paths = %w[/__better_errors /__meta_request]
+      def default_skip_paths = %w[/__better_errors /__meta_request /rails]
     end
   end
 end

data/lib/rails_spotlight/middlewares/request_completed.rb

@@ -14,15 +14,12 @@ module RailsSpotlight
       end
 
       def call(env)
+        return app.call(env) if skip?(env['PATH_INFO']) || (env['HTTP_CONNECTION'] == 'Upgrade' && env['HTTP_UPGRADE'] == 'websocket')
         return app.call(env) unless ::RailsSpotlight.config.request_completed_broadcast_enabled?
 
-        if skip?(env['PATH_INFO']) || (env['HTTP_CONNECTION'] == 'Upgrade' && env['HTTP_UPGRADE'] == 'websocket')
-          app.call(env)
-        else
-          status, headers, body = app.call(env)
-          publish_event(status, headers, env)
-          [status, headers, body]
-        end
+        status, headers, body = app.call(env)
+        publish_event(status, headers, env)
+        [status, headers, body]
       rescue => e # rubocop:disable Style/RescueStandardError
         ::RailsSpotlight.config.logger.error "Error in RailsSpotlight::Middlewares::RequestCompletedHandler instrumentation: #{e.message}"
         app.call(env)

data/lib/rails_spotlight/railtie.rb

@@ -6,22 +6,29 @@ require_relative 'log_interceptor'
 module RailsSpotlight
   class Railtie < ::Rails::Railtie
     initializer 'rails_spotlight.inject_middlewares' do
-      insert_base_middlewares unless Rails.env.production?
+      next unless ::RailsSpotlight.config.enabled?
+
+      insert_base_middlewares
     end
 
     initializer 'rails_spotlight.log_interceptor' do
-      unless Rails.env.production?
-        Rails.logger&.extend(LogInterceptor)
-        defined?(Sidekiq::Logger) && Sidekiq.logger&.extend(LogInterceptor)
-      end
+      next unless ::RailsSpotlight.config.enabled?
+      next unless ::RailsSpotlight.config.logs_enabled?
+
+      Rails.logger&.extend(LogInterceptor)
+      defined?(Sidekiq::Logger) && Sidekiq.logger&.extend(LogInterceptor)
     end
 
     initializer 'rails_spotlight.subscribe_to_notifications' do
-      AppNotifications.subscribe unless Rails.env.production?
+      next unless ::RailsSpotlight.config.enabled?
+
+      AppNotifications.subscribe
     end
 
     initializer 'rails_spotlight.action_cable_setup' do
-      insert_action_cable_helpers unless Rails.env.production?
+      next unless ::RailsSpotlight.config.enabled?
+
+      insert_action_cable_helpers
     end
 
     def insert_action_cable_helpers
@@ -53,6 +60,7 @@ module RailsSpotlight
       app.middleware.use ::RailsSpotlight::Middlewares::MainRequestHandler
 
       return unless ::RailsSpotlight.config.request_completed_broadcast_enabled?
+      return unless ActionCable.server.config&.cable&.dig(:adapter).present?
 
       # app.middleware.insert_after ::RailsSpotlight::Middlewares::HeaderMarker, RailsSpotlight::Middlewares::RequestCompleted, app.config
       if defined? ActionDispatch::Executor

data/lib/rails_spotlight/version.rb

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

data/lib/tasks/init.rake

@@ -10,6 +10,7 @@ namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
     config_path = Rails.root.join('config', 'rails_spotlight.yml')
 
     default_config = <<~YAML
+      ENABLED: true
       # Default configuration for RailsSpotlight
       PROJECT_NAME: <%=Rails.application.class.respond_to?(:module_parent_name) ? Rails.application.class.module_parent_name : Rails.application.class.parent_name%>
       SOURCE_PATH: <%=Rails.root%>
@@ -27,6 +28,7 @@ namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
       SKIP_RENDERED_IVARS: []
       
       # Features
+      LOGS_ENABLED: true
       FILE_MANAGER_ENABLED: true
       RUBOCOP_ENABLED: true
       SQL_CONSOLE_ENABLED: true
@@ -123,9 +125,9 @@ namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
 
     case layout_format
     when 'slim', 'haml'
-      puts "- if Rails.env.development?\n  = render 'layouts/#{partial_name.split('.').first}'" # rubocop:disable Style/StringLiteralsInInterpolation
+      puts "- if defined?(RailsSpotlight) && Rails.env.development?\n  = render 'layouts/#{partial_name.split('.').first}'" # rubocop:disable Style/StringLiteralsInInterpolation
     else
-      puts "<% if Rails.env.development? %>\n  <%= render 'layouts/#{partial_name.split('.').first}' %>\n<% end %>" # rubocop:disable Style/StringLiteralsInInterpolation
+      puts "<% if defined?(RailsSpotlight) && Rails.env.development? %>\n  <%= render 'layouts/#{partial_name.split('.').first}' %>\n<% end %>" # rubocop:disable Style/StringLiteralsInInterpolation
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_spotlight
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Pawel Niemczyk
 bindir: exe
 cert_chain: []
-date: 2025-03-16 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-contrib