consolle 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b3d8a284ca63f38a9e02ca394141f50cd4c0d02a63bae7f78d384a027d0c400
-  data.tar.gz: 7ddfdc210a765e4fc8c6598e5b2d38ffe78f2997a4811c55f6bf461862ccba0a
+  metadata.gz: a88f6019a32aaae300dee3a3e39b1dd1084ea1e2900171d6ee02f880923e071e
+  data.tar.gz: e9c468bc8095d8197e8f70cc4c0b75d0cc8da9ba3a7b0af45573300b755e1970
 SHA512:
-  metadata.gz: ce17c1df36c8284f051bfd658e63252846547e0886cbe4330005470ce4997f24334a470196de0310f24cccf7f305b4c358985752d301cc76a9514d15c296feb5
-  data.tar.gz: 93ff0d888e2436be4cc2952508e6b8dba29afdd79303434e0126871022c23f67de70cccbfc0c8e7e33c0d853c2f90aaf8c2be61f6d3e0559ee8694b195b85807
+  metadata.gz: e5c0615769edda8936547380360ed5a7beeaaeda7569ccf91322daa4658923a82cad4ad87e5ffabeca4c230e89f3d371ebcaa5eec58663b25172ee0ab8c2ba07
+  data.tar.gz: 83dd02825015e9f9e73ff48075436f459722cdc045ee4b0b8d90509c5ca91274c27af682549ef114598efcf21d90628fc460360f33a069134b0da63eeab94c81

data/.version

@@ -1 +1 @@
-0.3.6
+0.3.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    consolle (0.3.6)
+    consolle (0.3.7)
       logger (~> 1.0)
       thor (~> 1.0)
 

data/lib/consolle/cli.rb

@@ -418,7 +418,7 @@ module Consolle
 
           stop
           sleep 1
-          invoke(:start)
+          invoke(:start, [], {})
         else
           puts 'Restarting Rails console subprocess...'
 

data/lib/consolle/config.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Consolle
+  # Configuration loader for .consolle.yml
+  class Config
+    CONFIG_FILENAME = '.consolle.yml'
+
+    # Default prompt pattern that matches various console prompts
+    # - Custom sentinel: \u001E\u001F<CONSOLLE>\u001F\u001E
+    # - Rails app prompts: app(env)> or app(env):001>
+    # - IRB prompts: irb(main):001:0> or irb(main):001>
+    # - Generic prompts: >> or >
+    DEFAULT_PROMPT_PATTERN = /^[^\w]*(\u001E\u001F<CONSOLLE>\u001F\u001E|\w+[-_]?\w*\([^)]*\)(:\d+)?>|irb\([^)]+\):\d+:?\d*[>*]|>>|>)\s*$/
+
+    attr_reader :rails_root, :prompt_pattern, :raw_prompt_pattern
+
+    def initialize(rails_root)
+      @rails_root = rails_root
+      @config = load_config
+      @raw_prompt_pattern = @config['prompt_pattern']
+      @prompt_pattern = parse_prompt_pattern(@raw_prompt_pattern)
+    end
+
+    def self.load(rails_root)
+      new(rails_root)
+    end
+
+    # Check if a custom prompt pattern is configured
+    def custom_prompt_pattern?
+      !@raw_prompt_pattern.nil?
+    end
+
+    # Get human-readable description of expected prompt patterns
+    def prompt_pattern_description
+      if custom_prompt_pattern?
+        "Custom pattern: #{@raw_prompt_pattern}"
+      else
+        <<~DESC.strip
+          Default patterns:
+            - app(env)> or app(env):001>  (Rails console)
+            - irb(main):001:0>            (IRB)
+            - >> or >                     (Generic)
+        DESC
+      end
+    end
+
+    private
+
+    def config_path
+      File.join(@rails_root, CONFIG_FILENAME)
+    end
+
+    def load_config
+      return {} unless File.exist?(config_path)
+
+      begin
+        YAML.safe_load(File.read(config_path)) || {}
+      rescue Psych::SyntaxError => e
+        warn "[Consolle] Warning: Failed to parse #{CONFIG_FILENAME}: #{e.message}"
+        {}
+      end
+    end
+
+    def parse_prompt_pattern(pattern_string)
+      return DEFAULT_PROMPT_PATTERN if pattern_string.nil?
+
+      begin
+        Regexp.new(pattern_string)
+      rescue RegexpError => e
+        warn "[Consolle] Warning: Invalid prompt_pattern '#{pattern_string}': #{e.message}"
+        warn "[Consolle] Using default pattern instead."
+        DEFAULT_PROMPT_PATTERN
+      end
+    end
+  end
+end

data/lib/consolle/errors.rb

@@ -39,6 +39,56 @@ module Consolle
       end
     end
 
+    # Prompt detection failure with diagnostic information
+    class PromptDetectionError < Error
+      attr_reader :received_output, :expected_patterns, :config_path
+
+      def initialize(timeout:, received_output:, expected_patterns:, config_path:)
+        @received_output = received_output
+        @expected_patterns = expected_patterns
+        @config_path = config_path
+
+        super(build_message(timeout))
+      end
+
+      private
+
+      def build_message(timeout)
+        # Extract last line that looks like a prompt (ends with > or similar)
+        lines = @received_output.to_s.lines.map(&:strip).reject(&:empty?)
+        potential_prompt = lines.reverse.find { |l| l.match?(/[>*]\s*$/) } || lines.last
+
+        <<~MSG.strip
+          Prompt not detected after #{timeout} seconds
+
+          Received output:
+            #{@received_output.to_s.lines.last(5).map { |l| l.strip }.join("\n    ")}
+
+          Potential prompt found:
+            #{potential_prompt.inspect}
+
+          #{@expected_patterns}
+
+          To fix this, add to #{@config_path}:
+            prompt_pattern: '#{escape_for_yaml(potential_prompt)}'
+
+          Or set environment variable:
+            CONSOLLE_PROMPT_PATTERN='#{escape_for_yaml(potential_prompt)}' cone start
+        MSG
+      end
+
+      def escape_for_yaml(str)
+        return '' if str.nil?
+        # Escape special regex characters and create a simple pattern
+        str.to_s
+           .gsub(/\e\[[\d;]*[a-zA-Z]/, '') # Remove ANSI codes
+           .gsub(/[\x00-\x1F]/, '')        # Remove control characters
+           .strip
+           .gsub(/(\d+)/, '\d+')           # Replace numbers with \d+
+           .gsub(/([().\[\]{}|*+?^$\\])/, '\\\\\1') # Escape regex special chars
+      end
+    end
+
     # Syntax error in executed code
     class SyntaxError < ExecutionError
       def initialize(message)
@@ -80,7 +130,8 @@ module Consolle
         '::RuntimeError' => 'RUNTIME_ERROR',
         'StandardError' => 'STANDARD_ERROR',
         'Exception' => 'EXCEPTION',
-        'Consolle::Errors::ServerUnhealthy' => 'SERVER_UNHEALTHY'
+        'Consolle::Errors::ServerUnhealthy' => 'SERVER_UNHEALTHY',
+        'Consolle::Errors::PromptDetectionError' => 'PROMPT_DETECTION_ERROR'
       }.freeze
 
       def self.to_code(exception)

data/lib/consolle/server/console_supervisor.rb

@@ -5,6 +5,7 @@ require 'timeout'
 require 'fcntl'
 require 'logger'
 require_relative '../constants'
+require_relative '../config'
 require_relative '../errors'
 
 # Ruby 3.4.0+ extracts base64 as a default gem
@@ -17,15 +18,13 @@ $VERBOSE = original_verbose
 module Consolle
   module Server
     class ConsoleSupervisor
-      attr_reader :pid, :reader, :writer, :rails_root, :rails_env, :logger
+      attr_reader :pid, :reader, :writer, :rails_root, :rails_env, :logger, :config
 
       RESTART_DELAY = 1  # seconds
       MAX_RESTARTS = 5   # within 5 minutes
       RESTART_WINDOW = 300 # 5 minutes
-      # Match various Rails console prompts
-      # Match various console prompts: custom sentinel, Rails app prompts, IRB prompts, and generic prompts
-      # Allow optional non-word characters before the prompt (e.g., Unicode symbols like ▽)
-      PROMPT_PATTERN = /^[^\w]*(\u001E\u001F<CONSOLLE>\u001F\u001E|\w+[-_]?\w*\([^)]*\)>|irb\([^)]+\):\d+:?\d*[>*]|>>|>)\s*$/
+      # Legacy constant for backward compatibility - use config.prompt_pattern instead
+      PROMPT_PATTERN = Consolle::Config::DEFAULT_PROMPT_PATTERN
       CTRL_C = "\x03"
 
       def initialize(rails_root:, rails_env: 'development', logger: nil, command: nil, wait_timeout: nil)
@@ -34,6 +33,7 @@ module Consolle
         @command = command || 'bin/rails console'
         @logger = logger || Logger.new(STDOUT)
         @wait_timeout = wait_timeout || Consolle::DEFAULT_WAIT_TIMEOUT
+        @config = Consolle::Config.load(rails_root)
         @pid = nil
         @reader = nil
         @writer = nil
@@ -227,7 +227,7 @@ module Consolle
 
                 # Check if we got prompt back
                 clean = strip_ansi(output)
-                if clean.match?(PROMPT_PATTERN)
+                if clean.match?(prompt_pattern)
                   # Wait a bit for any trailing output
                   sleep 0.1
                   begin
@@ -300,6 +300,11 @@ module Consolle
         end
       end
 
+      # Returns the prompt pattern to use (custom from config or default)
+      def prompt_pattern
+        @config&.prompt_pattern || Consolle::Config::DEFAULT_PROMPT_PATTERN
+      end
+
       def stop
         @running = false
 
@@ -531,7 +536,16 @@ module Consolle
             logger.error "[ConsoleSupervisor] Timeout reached. Current: #{current_time}, Deadline: #{deadline}, Elapsed: #{current_time - start_time}s"
             logger.error "[ConsoleSupervisor] Output so far: #{output.inspect}"
             logger.error "[ConsoleSupervisor] Stripped: #{strip_ansi(output).inspect}"
-            raise Timeout::Error, "No prompt after #{timeout} seconds"
+
+            # Raise PromptDetectionError with diagnostic information
+            config_path = File.join(@rails_root || '.', Consolle::Config::CONFIG_FILENAME)
+            expected_desc = @config&.prompt_pattern_description || "Default prompt patterns"
+            raise Consolle::Errors::PromptDetectionError.new(
+              timeout: timeout,
+              received_output: strip_ansi(output),
+              expected_patterns: expected_desc,
+              config_path: config_path
+            )
           end
 
           # If we found prompt and consume_all is true, continue reading for a bit more
@@ -560,7 +574,7 @@ module Consolle
             clean = strip_ansi(output)
             # Check each line for prompt pattern
             clean.lines.each do |line|
-              if line.match?(PROMPT_PATTERN)
+              if line.match?(prompt_pattern)
                 logger.info '[ConsoleSupervisor] Found prompt!'
                 prompt_found = true
               end
@@ -647,7 +661,7 @@ module Consolle
         # Wait for prompt after configuration with reasonable timeout
         begin
           wait_for_prompt(timeout: 2, consume_all: false)
-        rescue Timeout::Error
+        rescue Timeout::Error, Consolle::Errors::PromptDetectionError
           # This can fail with some console types, but that's okay
           logger.debug '[ConsoleSupervisor] No prompt after IRB configuration, continuing'
         end
@@ -686,7 +700,7 @@ module Consolle
           end
 
           # Skip prompts (but not return values that start with =>)
-          next if line.match?(PROMPT_PATTERN) && !line.start_with?('=>')
+          next if line.match?(prompt_pattern) && !line.start_with?('=>')
 
           # Skip common IRB configuration output patterns
           if line.match?(/^(IRB\.conf|DISABLE_PRY_RAILS|Switch to inspect mode|Loading .*\.rb|nil)$/) ||

data/lib/consolle.rb

@@ -3,6 +3,7 @@
 require_relative 'consolle/version'
 require_relative 'consolle/constants'
 require_relative 'consolle/errors'
+require_relative 'consolle/config'
 require_relative 'consolle/cli'
 
 # Server components

data/rule.ko.md

@@ -20,10 +20,10 @@ Cone은 디버깅, 데이터 탐색, 그리고 개발 보조 도구로 사용됩
 
 ## Cone 서버 시작과 중지
 
-`start` 명령어로 cone을 시작할 수 있으며, `-e`로 실행 환경을 지정할 수 있습니다.
+`start` 명령어로 cone을 시작할 수 있습니다. 실행 환경 지정은 `RAILS_ENV` 환경변수를 사용합니다.
 
 ```bash
-$ cone start # 서버 시작
+$ cone start # 서버 시작 (RAILS_ENV가 없으면 development)
 $ RAILS_ENV=test cone start # test 환경에서 console 시작
 ```
 
@@ -115,3 +115,34 @@ $ cone exec -f complex_task.rb
 ```
 
 모든 방법은 세션 상태를 유지하므로 변수와 객체가 실행 간에 지속됩니다.
+
+## 실행 안전장치 & 타임아웃
+
+- 기본 타임아웃: 60초
+- 타임아웃 우선순위: `CONSOLLE_TIMEOUT`(설정되고 0보다 클 때) > CLI `--timeout` > 기본값(60초)
+- 사전 Ctrl‑C(프롬프트 분리):
+  - 매 `exec` 전에 Ctrl‑C를 보내고 IRB 프롬프트를 최대 3초 대기해 깨끗한 상태를 보장합니다.
+  - 3초 내 프롬프트가 돌아오지 않으면 콘솔 하위 프로세스를 재시작하고 요청은 `SERVER_UNHEALTHY`로 실패합니다.
+  - 서버 전역 비활성화: `CONSOLLE_DISABLE_PRE_SIGINT=1 cone start`
+  - 호출 단위 제어: `--pre-sigint` / `--no-pre-sigint`
+
+### 예시
+
+```bash
+# CLI로 타임아웃 지정(환경변수 미설정 시 유효)
+cone exec 'heavy_task' --timeout 120
+
+# 최우선 타임아웃(클라이언트·서버 모두 적용)
+CONSOLLE_TIMEOUT=90 cone exec 'heavy_task'
+
+# 타임아웃 이후 복구 확인
+cone exec 'sleep 999' --timeout 2      # -> EXECUTION_TIMEOUT로 실패
+cone exec "puts :after_timeout; :ok"   # -> 정상 동작(프롬프트 복구)
+
+# 호출 단위로 사전 Ctrl‑C 비활성화
+cone exec --no-pre-sigint 'code'
+```
+
+### 에러 코드
+- `EXECUTION_TIMEOUT`: 실행한 코드가 타임아웃을 초과함
+- `SERVER_UNHEALTHY`: 사전 프롬프트 확인(3초) 실패로 콘솔 재시작, 요청 실패

data/rule.md

@@ -20,10 +20,10 @@ Existing objects also reference old code, so you need to create new ones to use
 
 ## Starting and Stopping Cone Server
 
-You can start cone with the `start` command and specify the execution environment with `-e`.
+You can start cone with the `start` command. To select the Rails environment, set the `RAILS_ENV` environment variable.
 
 ```bash
-$ cone start # Start server
+$ cone start # Start server (uses RAILS_ENV or defaults to development)
 $ RAILS_ENV=test cone start # Start console in test environment
 ```
 
@@ -115,3 +115,34 @@ $ cone exec -f complex_task.rb
 ```
 
 All methods maintain the session state, so variables and objects persist between executions.
+
+## Execution Safety & Timeouts
+
+- Default timeout: 60s
+- Timeout precedence: `CONSOLLE_TIMEOUT` (if set and > 0) > CLI `--timeout` > default (60s)
+- Pre-exec Ctrl-C (prompt separation):
+  - Before each `exec`, cone sends Ctrl-C and waits up to 3 seconds for the IRB prompt to ensure a clean state.
+  - If the prompt does not return in 3 seconds, the console subprocess is restarted and the request fails with `SERVER_UNHEALTHY`.
+  - Disable globally for the server: `CONSOLLE_DISABLE_PRE_SIGINT=1 cone start`
+  - Per-call control: `--pre-sigint` / `--no-pre-sigint`
+
+### Examples
+
+```bash
+# Set timeout via CLI (fallback when CONSOLLE_TIMEOUT is not set)
+cone exec 'heavy_task' --timeout 120
+
+# Highest priority timeout (applies on client and server)
+CONSOLLE_TIMEOUT=90 cone exec 'heavy_task'
+
+# Verify recovery after a timeout
+cone exec 'sleep 999' --timeout 2      # -> fails with EXECUTION_TIMEOUT
+cone exec "puts :after_timeout; :ok"   # -> should succeed (prompt recovered)
+
+# Disable pre-exec Ctrl-C for a single call
+cone exec --no-pre-sigint 'code'
+```
+
+### Error Codes
+- `EXECUTION_TIMEOUT`: The executed code exceeded its timeout.
+- `SERVER_UNHEALTHY`: The pre-exec prompt did not return within 3 seconds; the console subprocess was restarted and the request failed.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: consolle
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - nacyot
 bindir: bin
 cert_chain: []
-date: 2025-09-01 00:00:00.000000000 Z
+date: 2025-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -79,6 +79,7 @@ files:
 - lib/consolle.rb
 - lib/consolle/adapters/rails_console.rb
 - lib/consolle/cli.rb
+- lib/consolle/config.rb
 - lib/consolle/constants.rb
 - lib/consolle/errors.rb
 - lib/consolle/server/console_socket_server.rb