rails_spotlight 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41eb3756c5f0405d7811d039c0953ac3a62b993486a4fc2e2085686c8c9cd54b
-  data.tar.gz: fd0d5d64ff53a660ade6867f05c152e36cd228ccb02b1d9006c3e4be8ed8e6cd
+  metadata.gz: 811024ca98d1eff1d90ec498134b41d547c19f0a731074f0f76b85f42d34ae62
+  data.tar.gz: fde226acfcae18f43435d64cccd3fae6b0651b0a606d3d196cd08bdaffa60403
 SHA512:
-  metadata.gz: d3159584ad8395c2ea3a17fb969cd9a50c94a120c0db950ff11db8d52ce3357f443c7944a23dc8dc3521844f98e6cdc30da288f53a08e6308f8722c53a85907b
-  data.tar.gz: 2057d0386f21959a19b229ca2f3b4e46db2a0270d1c8f1262f551363eeda54c7127bc3b78c1c209b6e949a62dc2ce1c82989b17650eaa7c6dc02bb99874f3389
+  metadata.gz: b4d436897c9ede10af86c7878abb46cccc119c0c2de60d68bab667ab88b58891108a875d259e64461dbcad36822ac6d5cb9793351a5ac63e88ee3aa7dd98cd52
+  data.tar.gz: ad6cea7c5217d8be6e9487aaa927ef9e90214a890d241000d89602ad9c1339186a90a5d1ee15578d9a09825e8e5e557e308243c3131170a4ea13ca6429892473

data/README.md

@@ -41,8 +41,10 @@ file will be created in `config/rails_spotlight.yml`
   # Rest of the configuration is required for ActionCable. It will be disabled automatically in when ActionCable is not available.
   LIVE_CONSOLE_ENABLED: true
   REQUEST_COMPLETED_BROADCAST_ENABLED: false
-  AUTO_MOUNT_ACTION_CABLE: true
+  AUTO_MOUNT_ACTION_CABLE: false
   ACTION_CABLE_MOUNT_PATH: /cable
+  BLOCK_EDITING_FILES: false
+  BLOCK_EDITING_FILES_OUTSIDE_OF_THE_PROJECT: true
 ```
 
 ## Troubleshooting
@@ -57,6 +59,14 @@ Solution:
   - Set AUTO_MOUNT_ACTION_CABLE: false
   - Add manually `mount ActionCable.server => '/cable'` to `config/routes.rb` with proper authentication method
 
+---
+
+Requests crash when **ActionCable settings** -> **Use action cable for meta requests (required for Safari)**  is on
+
+Solution:
+  - Switch flag off
+  - REQUEST_COMPLETED_BROADCAST_ENABLED: false
+
 ## Testing
 
 To run tests for all versions of Rails and Ruby, run:

data/lib/rails_spotlight/channels/live_console_channel.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative '../rails_command_executor'
 module RailsSpotlight
   module Channels
     class LiveConsoleChannel < ActionCable::Channel::Base
@@ -18,7 +19,7 @@ module RailsSpotlight
         for_project = data['project']
         return publish({ error: project_mismatch_message(for_project) }) if for_project.present? && for_project != project
 
-        output = execute_command(command, { inspect_types: inspect_types })
+        output = execute_command(command, inspect_types)
         publish(output)
       end
 
@@ -37,54 +38,24 @@ module RailsSpotlight
         ::RailsSpotlight.config.project_name
       end
 
-      def execute_command(command, opts = {})
-        output_stream = StringIO.new # Create a new StringIO object to capture output
-        inspect_types = opts[:inspect_types]
-        result = nil
-
-        begin
-          original_stdout = $stdout
-          $stdout = output_stream
-          result = eval(command) # rubocop:disable Security/Eval
-        ensure
-          $stdout = original_stdout
-        end
-
-        # result = eval(command)
-        {
-          result: {
-            inspect: result.inspect,
-            raw: result,
-            type: result.class.name,
-            types: result_inspect_types(inspect_types, result),
-            console: output_stream.string
-          }
-        }
-      rescue StandardError => e
-        { error: e.message }
+      def executor
+        @executor ||= ::RailsSpotlight::RailsCommandExecutor.new
       end
 
-      def result_inspect_types(inspect_types, result)
-        return {} unless inspect_types
+      def execute_command(command, inspect_types)
+        RailsSpotlight.config.logger && RailsSpotlight.config.logger.info("Executing command: #{command}") # rubocop:disable Style/SafeNavigation
 
-        {
-          root: result.class.name,
-          items: result_types_items(result)
-        }
-      end
-
-      def result_types_items(result)
-        case result
-        when Array
-          # Create a hash with indices as keys and class names as values
-          result.each_with_index.to_h { |element, index| [index.to_s, element.class.name] }
-        when Hash
-          # Create a hash with string keys and class names as values
-          result.transform_keys(&:to_s).transform_values { |value| value.class.name }
+        executor.execute(command)
+        if executor.execution_successful?
+          {
+            result: executor.result_as_json(inspect_types: inspect_types),
+            project: ::RailsSpotlight.config.project_name
+          }
         else
-          # For non-collection types, there are no items
-          {}
+          executor.result_as_json
         end
+      rescue => e # rubocop:disable Style/RescueStandardError
+        { error: e.message }
       end
     end
   end

data/lib/rails_spotlight/configuration.rb

@@ -11,20 +11,23 @@ module RailsSpotlight
     }.freeze
 
     attr_reader :project_name, :source_path, :logger, :storage_path, :storage_pool_size, :middleware_skipped_paths,
-                :not_encodable_event_values, :action_cable_mount_path
+                :not_encodable_event_values, :action_cable_mount_path,
+                :block_editing_files, :block_editing_files_outside_of_the_project
 
-    def initialize(opts = {}) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def initialize(opts = {}) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
       @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'))
       @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 : is_true?(opts[:live_console_enabled])
-      @request_completed_broadcast_enabled = is_true?(opts[:request_completed_broadcast_enabled])
+      @live_console_enabled = opts[:live_console_enabled].nil? ? true : true?(opts[:live_console_enabled])
+      @request_completed_broadcast_enabled = 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 : is_true?(opts[:auto_mount_action_cable])
+      @auto_mount_action_cable = opts[:auto_mount_action_cable].nil? ? true : 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])
     end
 
     def live_console_enabled
@@ -75,8 +78,8 @@ module RailsSpotlight
 
     private
 
-    def is_true?(value)
-      value == true || value == 'true' || value == 1 || value == '1'
+    def true?(value)
+      [true, 'true', 1, '1'].include?(value)
     end
 
     def detect_project_name

data/lib/rails_spotlight/middlewares/handlers/console_action_handler.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../../rails_command_executor'
+module RailsSpotlight
+  module Middlewares
+    module Handlers
+      class ConsoleActionHandler < BaseActionHandler
+        def execute
+          validate_project!
+
+          RailsSpotlight.config.logger && RailsSpotlight.config.logger.info("Executing command: #{command}") # rubocop:disable Style/SafeNavigation
+          executor.execute(command)
+        end
+
+        private
+
+        def validate_project!
+          return if for_project.blank?
+          return if for_project.include?(::RailsSpotlight.config.project_name)
+
+          raise UnprocessableEntity, "Check your connection settings the current command is not allowed to be executed on the #{::RailsSpotlight.config.project_name} project"
+        end
+
+        def executor
+          @executor ||= ::RailsSpotlight::RailsCommandExecutor.new
+        end
+
+        def inspect_types
+          @inspect_types ||= json_request_body.fetch('inspect_types')
+        end
+
+        def command
+          @command ||= json_request_body.fetch('command')
+        end
+
+        def for_project
+          @for_project ||= json_request_body['project']
+        end
+
+        def json_response_body
+          executor.result_as_json(inspect_types: inspect_types)
+                  .merge(project: ::RailsSpotlight.config.project_name)
+        end
+      end
+    end
+  end
+end

data/lib/rails_spotlight/middlewares/handlers/file_action_handler.rb

@@ -7,7 +7,11 @@ module RailsSpotlight
         def execute
           raise NotFound, 'File not found' unless path_valid?
 
-          File.write(file_path, new_content) if write_mode?
+          if write_mode?
+            try_to_update_file
+          else
+            File.read(file_path)
+          end
         rescue => e # rubocop:disable Style/RescueStandardError
           raise UnprocessableEntity, e.message
         end
@@ -34,6 +38,22 @@ module RailsSpotlight
           request_mode == 'write'
         end
 
+        def try_to_update_file
+          raise UnprocessableEntity, editing_files_block_msg if block_editing_files?
+          raise UnprocessableEntity, editing_files_blocked_err_msg if editing_outside_project_file_is_blocked?(file_path)
+
+          RailsSpotlight.config.logger && RailsSpotlight.config.logger.info("Updating file: #{file_path}") # rubocop:disable Style/SafeNavigation
+          File.write(file_path, new_content)
+        end
+
+        def editing_files_block_msg
+          'Editing files is blocked. Please check the Rails spotlight BLOCK_EDITING_FILES configuration.'
+        end
+
+        def editing_files_blocked_err_msg
+          'Editing files is blocked. Please check the Rails spotlight BLOCK_EDITING_FILES_OUTSIDE_OF_THE_PROJECT configuration.'
+        end
+
         def request_mode
           @request_mode ||= json_request_body.fetch('mode', 'read')
         end
@@ -43,12 +63,45 @@ module RailsSpotlight
         end
 
         def file_path
-          @file_path ||= if json_request_body.fetch('file').start_with?(::RailsSpotlight.config.rails_root)
-                           json_request_body.fetch('file')
-                         else
-                           File.join(::RailsSpotlight.config.rails_root, json_request_body.fetch('file'))
+          @file_path ||= if path_file_in_project?
+                           original_file_path
+                         elsif file_in_project?
+                           File.join(::RailsSpotlight.config.rails_root, original_file_path)
+                         else # rubocop:disable Lint/DuplicateBranch
+                           original_file_path
                          end
         end
+
+        def original_file_path
+          @original_file_path ||= json_request_body.fetch('file')
+        end
+
+        def path_file_in_project?
+          @path_file_in_project ||= original_file_path.start_with?(::RailsSpotlight.config.rails_root)
+        end
+
+        def file_in_project?
+          File.exist?(File.join(::RailsSpotlight.config.rails_root, original_file_path))
+        end
+
+        def file_outside_project?
+          !file_in_project? && File.exist?(original_file_path)
+        end
+
+        def editing_outside_project_file_is_blocked?(file_path)
+          return false unless file_outside_project?
+          return false unless block_editing_files_outside_of_the_project?
+
+          !file_path.start_with?(::RailsSpotlight.config.rails_root)
+        end
+
+        def block_editing_files?
+          ::RailsSpotlight.config.block_editing_files
+        end
+
+        def block_editing_files_outside_of_the_project?
+          ::RailsSpotlight.config.block_editing_files_outside_of_the_project
+        end
       end
     end
   end

data/lib/rails_spotlight/middlewares/handlers/meta_action_handler.rb

@@ -11,7 +11,8 @@ module RailsSpotlight
         def json_response_body
           {
             events: events,
-            project: ::RailsSpotlight.config.project_name
+            project: ::RailsSpotlight.config.project_name,
+            root_path: ::RailsSpotlight.config.rails_root
           }
         end
 

data/lib/rails_spotlight/middlewares/handlers/sql_action_handler.rb

@@ -16,11 +16,10 @@ module RailsSpotlight
         private
 
         def validate_project!
-          Rails.logger.warn required_projects
           return if required_projects.blank?
           return if required_projects.include?(::RailsSpotlight.config.project_name)
 
-          raise UnprocessableEntity, "Check your connetction settings the current query is not allowed to be executed on the #{::RailsSpotlight.config.project_name} project"
+          raise UnprocessableEntity, "Check your connection settings the current query is not allowed to be executed on the #{::RailsSpotlight.config.project_name} project"
         end
 
         def transaction
@@ -37,7 +36,8 @@ module RailsSpotlight
           end
         end
 
-        def run
+        def run # rubocop:disable Metrics/AbcSize
+          RailsSpotlight.config.logger && RailsSpotlight.config.logger.info("Executing query: #{query}") # rubocop:disable Style/SafeNavigation
           return self.result = ActiveRecord::Base.connection.exec_query(query) if connection_options.blank? || !ActiveRecord::Base.respond_to?(:connects_to)
 
           connections = ActiveRecord::Base.connects_to(**connection_options)

data/lib/rails_spotlight/middlewares/request_handler.rb

@@ -6,6 +6,7 @@ require_relative 'handlers/sql_action_handler'
 require_relative 'handlers/verify_action_handler'
 require_relative 'handlers/not_found_action_handler'
 require_relative 'handlers/meta_action_handler'
+require_relative 'handlers/console_action_handler'
 
 module RailsSpotlight
   module Middlewares
@@ -33,6 +34,7 @@ module RailsSpotlight
         when 'sql' then Handlers::SqlActionHandler.new(*args).call
         when 'verify' then Handlers::VerifyActionHandler.new(*args).call
         when 'meta' then Handlers::MetaActionHandler.new(*args).call
+        when 'console' then Handlers::ConsoleActionHandler.new(*args).call
         else
           Handlers::NotFoundActionHandler.new(*args).call
         end

data/lib/rails_spotlight/rails_command_executor.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module RailsSpotlight
+  class RailsCommandExecutor
+    def execute(command)
+      output_stream = StringIO.new # Create a new StringIO object to capture output
+      @result = nil
+      @error = nil
+      @syntax_error = false
+
+      begin
+        original_stdout = $stdout
+        $stdout = output_stream
+        @result = eval(command) # rubocop:disable Security/Eval
+      rescue SyntaxError => e
+        @error = e
+        @syntax_error = true
+      rescue => e # rubocop:disable Style/RescueStandardError
+        @error = e
+      ensure
+        $stdout = original_stdout
+      end
+
+      @console = output_stream.string
+      self
+    rescue => e # rubocop:disable Style/RescueStandardError
+      @error = e
+    ensure
+      self
+    end
+
+    attr_reader :result, :console, :error, :syntax_error
+
+    def execution_successful?
+      error.nil?
+    end
+
+    def result_as_json(inspect_types: false)
+      if error
+        {
+          status: :error,
+          syntax_error: syntax_error,
+          error: error.respond_to?(:message) ? error.message : error.to_s,
+          backtrace: error.respond_to?(:backtrace) ? error.backtrace : nil
+        }
+      else
+        {
+          status: :ok,
+          inspect: result.inspect,
+          raw: result,
+          type: result.class.name,
+          types: result_inspect_types(inspect_types, result),
+          console: console
+        }
+      end
+    end
+
+    private
+
+    def result_inspect_types(inspect_types, result)
+      return {} unless inspect_types
+
+      {
+        root: result.class.name,
+        items: result_types_items(result)
+      }
+    end
+
+    def result_types_items(result)
+      case result
+      when Array
+        # Create a hash with indices as keys and class names as values
+        result.each_with_index.to_h { |element, index| [index.to_s, element.class.name] }
+      when Hash
+        # Create a hash with string keys and class names as values
+        result.transform_keys(&:to_s).transform_values { |value| value.class.name }
+      else
+        # For non-collection types, there are no items
+        {}
+      end
+    end
+  end
+end

data/lib/rails_spotlight/version.rb

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

data/lib/tasks/init.rake

@@ -2,7 +2,7 @@
 
 require 'rake'
 
-namespace :rails_spotlight do
+namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
   desc 'Generate rails_spotlight configuration file'
   task generate_config: :environment do
     require 'fileutils'
@@ -21,8 +21,10 @@ namespace :rails_spotlight do
       # Rest of the configuration is required for ActionCable. It will be disabled automatically in when ActionCable is not available.
       LIVE_CONSOLE_ENABLED: true
       REQUEST_COMPLETED_BROADCAST_ENABLED: false
-      AUTO_MOUNT_ACTION_CABLE: true
+      AUTO_MOUNT_ACTION_CABLE: false
       ACTION_CABLE_MOUNT_PATH: /cable
+      BLOCK_EDITING_FILES: false
+      BLOCK_EDITING_FILES_OUTSIDE_OF_THE_PROJECT: true
     YAML
 
     if File.exist?(config_path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_spotlight
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Pawel Niemczyk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-11 00:00:00.000000000 Z
+date: 2024-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-contrib
@@ -248,6 +248,7 @@ files:
 - lib/rails_spotlight/middlewares.rb
 - lib/rails_spotlight/middlewares/concerns/skip_request_paths.rb
 - lib/rails_spotlight/middlewares/handlers/base_action_handler.rb
+- lib/rails_spotlight/middlewares/handlers/console_action_handler.rb
 - lib/rails_spotlight/middlewares/handlers/file_action_handler.rb
 - lib/rails_spotlight/middlewares/handlers/meta_action_handler.rb
 - lib/rails_spotlight/middlewares/handlers/not_found_action_handler.rb
@@ -257,6 +258,7 @@ files:
 - lib/rails_spotlight/middlewares/main_request_handler.rb
 - lib/rails_spotlight/middlewares/request_completed.rb
 - lib/rails_spotlight/middlewares/request_handler.rb
+- lib/rails_spotlight/rails_command_executor.rb
 - lib/rails_spotlight/railtie.rb
 - lib/rails_spotlight/storage.rb
 - lib/rails_spotlight/utils.rb