chocomint 1.0.0

data/lib/chocomint/edit_html.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Chocomint
+  module EditHandlers
+    # /edit のシングルページ HTML。実体は public/edit/index.html (CSS/JS も同ディレクトリ) で、
+    # ここでは読み込むだけ。__WS_CONFIG__ はサーバー側で WebSocket 接続情報 (JSON) に置換される。
+    EDIT_HTML_TEMPLATE = File.read(File.expand_path("../../public/edit/index.html", __dir__))
+  end
+end

data/lib/chocomint/errors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Chocomint
+  # すべての chocomint 例外の基底。
+  class Error < StandardError; end
+
+  # 主 LLM の提案 JSON が不正 (DESIGN §14: FAIL)。
+  class InvalidProposalError < Error; end
+
+  # 未知のツール名 (DESIGN §14: FAIL)。
+  class UnknownToolError < Error; end
+
+  # リトライ上限超過 (DESIGN §14: FAIL)。
+  class RetryLimitExceededError < Error; end
+
+  # PathGuard によるアクセス拒否 (DESIGN §13)。ツール内で捕捉され exit_code=1 になる。
+  class PathAccessError < Error; end
+end

data/lib/chocomint/factory.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module Chocomint
+  # config から各コンポーネントを組み立てて Orchestrator を返す。
+  module Factory
+    module_function
+
+    # config から PathGuard を組み立てる (edit UI がファイルアクセスに使う)。
+    def build_path_guard(config, base_dir: Dir.pwd)
+      Security::PathGuard.new(config.allowed_dirs, base_dir: base_dir)
+    end
+
+    def build(config, base_dir: Dir.pwd)
+      path_guard = build_path_guard(config, base_dir: base_dir)
+
+      registry = Tools::Registry.new
+      registry.register(Tools::WriteFile.new(path_guard: path_guard,
+                                             max_file_bytes: config.max_file_bytes))
+      registry.register(Tools::ReadFile.new(path_guard: path_guard,
+                                            max_file_bytes: config.max_file_bytes))
+      registry.register(Tools::ListDir.new(path_guard: path_guard))
+      registry.register(Tools::AppendFile.new(path_guard: path_guard,
+                                              max_file_bytes: config.max_file_bytes))
+      registry.register(Tools::DeleteFile.new(path_guard: path_guard))
+      registry.register(Tools::FileInfo.new(path_guard: path_guard))
+      registry.register(Tools::MakeDir.new(path_guard: path_guard))
+      registry.register(Tools::RunCommand.new(allowed_commands: config.allowed_commands,
+                                              timeout_sec: config.timeout_sec,
+                                              max_output_bytes: config.max_output_bytes,
+                                              cwd: base_dir,
+                                              path_guard: path_guard,
+                                              allow_all: config.allow_all_commands?))
+      registry.register(Tools::Edit.new(path_guard: path_guard,
+                                        max_file_bytes: config.max_file_bytes))
+      registry.register(Tools::Grep.new(path_guard: path_guard,
+                                        max_output_bytes: config.max_output_bytes,
+                                        base_dir: base_dir))
+      registry.register(Tools::Glob.new(path_guard: path_guard, base_dir: base_dir))
+      registry.register(Tools::Ls.new(path_guard: path_guard))
+      registry.register(Tools::Shell.build("bash", timeout_sec: config.timeout_sec,
+                                                   max_output_bytes: config.max_output_bytes,
+                                                   cwd: base_dir,
+                                                   path_guard: path_guard))
+      registry.register(Tools::Shell.build("powershell", timeout_sec: config.timeout_sec,
+                                                         max_output_bytes: config.max_output_bytes,
+                                                         cwd: base_dir,
+                                                         path_guard: path_guard))
+
+      # ロガーは LLM クライアントにも注入するため先に生成する。
+      logger = Logger::SqliteLogger.new(config.sqlite_path)
+
+      # ウェブサイト参照ツールは取得した本文を LLM (ChatClient) に要約・抽出させる。
+      registry.register(Tools::FetchUrl.new(chat_client: chat_client(config, logger),
+                                            timeout_sec: config.timeout_sec))
+
+      primary = build_primary(config, registry, logger)
+      verifier = build_verifier_client(config, logger)
+      semantic = Validator::SemanticValidator.new(
+        verifier_client: verifier, enabled: config.verifier_enabled?, path_guard: path_guard
+      )
+
+      machine = Validator::MachineValidator.new(
+        path_guard: path_guard, max_output_bytes: config.max_output_bytes
+      )
+
+      orchestrator = Orchestrator.new(
+        primary: primary,
+        registry: registry,
+        machine_validator: machine,
+        semantic_validator: semantic,
+        logger: logger,
+        max_retry: config.max_retry,
+        timeout_sec: config.timeout_sec
+      )
+
+      # マルチステップ (複数ツールを順に実行する要求) に対応する外側ループ。
+      # 単一ツールで完結する要求は 1 ステップ目の全体判定で即完了する。
+      Planner.new(
+        primary: primary,
+        orchestrator: orchestrator,
+        verifier: config.verifier_enabled? ? verifier : nil,
+        logger: logger,
+        max_steps: config.max_steps,
+        step_retry: config.max_retry
+      )
+    end
+
+    # 会話 (ツール不要の普通の質問) に答えるための生クライアント。
+    # /edit チャットで、タスク判定が「会話」だったときに直接応答させるのに使う。
+    def build_chat_client(config, base_dir: Dir.pwd)
+      chat_client(config, Logger::SqliteLogger.new(config.sqlite_path))
+    end
+
+    # ChatClient を組み立てる。build 内では既存 logger を再利用するため logger を受け取る
+    # (fetch_url ツールと /edit チャットの双方で使う)。
+    def chat_client(config, logger)
+      client = LLM::BaseClient.new(
+        base_url: config.llm.fetch("base_url"),
+        model: config.llm.fetch("model"),
+        api_key: api_key(config.llm),
+        max_tokens: config.llm.fetch("max_tokens", 1024),
+        timeout: config.timeout_sec,
+        payload_logger: logger,
+        role: "chat"
+      )
+      LLM::ChatClient.new(base_client: client)
+    end
+
+    def build_primary(config, registry, logger)
+      client = LLM::BaseClient.new(
+        base_url: config.llm.fetch("base_url"),
+        model: config.llm.fetch("model"),
+        api_key: api_key(config.llm),
+        max_tokens: config.llm.fetch("max_tokens", 1024),
+        timeout: config.timeout_sec,
+        payload_logger: logger,
+        role: "primary"
+      )
+      LLM::PrimaryClient.new(base_client: client,
+                             tool_definitions: registry.tool_definitions)
+    end
+
+    # verifier が無効なら nil を返す (Planner / SemanticValidator 双方でそのまま扱える)。
+    def build_verifier_client(config, logger)
+      return nil unless config.verifier_enabled?
+
+      # verifier は primary と同じモデルを共有する (VRAM 節約のため単一モデルに統一)。
+      client = LLM::BaseClient.new(
+        base_url: config.llm.fetch("base_url"),
+        model: config.llm.fetch("model"),
+        api_key: api_key(config.llm),
+        max_tokens: config.verifier.fetch("max_tokens", 1024),
+        timeout: config.timeout_sec,
+        payload_logger: logger,
+        role: "verifier"
+      )
+      LLM::VerifierClient.new(base_client: client)
+    end
+
+    def api_key(llm_config)
+      env_name = llm_config["api_key_env"]
+      env_name && ENV[env_name]
+    end
+  end
+end

data/lib/chocomint/llm/base_client.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+module Chocomint
+  module LLM
+    # Anthropic Messages API 互換クライアント (DESIGN §10)。
+    # base_url を差し替えるだけで Ollama / Claude / OpenRouter などに対応する。
+    # リトライは orchestrator の責務なので、ここは単発呼び出しに徹する。
+    class BaseClient
+      # payload_logger: LLM 送信内容を記録するロガー (record_llm_payload を持つ / 任意)。
+      # role: ペイロードの識別子 ("primary" / "verifier")。ログ表示で区別するため。
+      def initialize(base_url:, model:, api_key: nil, max_tokens: 1024, timeout: 60,
+                     payload_logger: nil, role: nil)
+        @base_url = base_url.to_s.chomp("/")
+        @model = model
+        @api_key = api_key
+        @max_tokens = max_tokens
+        @timeout = timeout
+        @payload_logger = payload_logger
+        @role = role
+      end
+
+      # messages: Anthropic 形式の配列。tools / system は任意。
+      # trace_id: 監査ログと突き合わせるための識別子 (任意)。
+      # 戻り値は生のレスポンス Hash (content 配列を含む)。
+      def create_message(messages:, tools: nil, system: nil, trace_id: nil)
+        body = {
+          "model" => @model,
+          "max_tokens" => @max_tokens,
+          "messages" => messages
+        }
+        body["tools"] = tools if tools
+        body["system"] = system if system
+
+        headers = {
+          "content-type" => "application/json",
+          "anthropic-version" => "2023-06-01"
+        }
+        headers["x-api-key"] = @api_key if @api_key && !@api_key.empty?
+
+        # 送信直前に、LLM へ渡す全内容 (ボディ + ヘッダ) をそのまま記録する。
+        # 戻り値の行 id にレスポンスを後から追記する。
+        payload_id = log_payload(body, headers, trace_id)
+
+        response = begin
+          connection.post("#{@base_url}/messages") do |req|
+            headers.each { |k, v| req.headers[k] = v }
+            req.body = JSON.generate(body)
+          end
+        rescue Faraday::ConnectionFailed => e
+          # Ollama 等のローカル LLM サーバーが起動していない場合にここに来る。
+          # 生の接続拒否メッセージは分かりにくいため、原因が伝わる日本語メッセージに置き換える。
+          log_response(payload_id, nil, e.message)
+          raise Chocomint::Error,
+                "LLM サーバーに接続できません (#{@base_url})。Ollama 等の LLM サーバーが" \
+                "起動しているか確認してください。"
+        rescue Faraday::Error => e
+          # その他の接続失敗・タイムアウト等。orchestrator の RETRY 扱いに乗せるため
+          # Chocomint::Error でラップする (素通りすると server.rb の例外処理網から漏れる)。
+          log_response(payload_id, nil, e.message)
+          raise Chocomint::Error, "LLM request failed: #{e.message}"
+        end
+
+        # 成功・失敗を問わず LLM レスポンス (ステータス + 生ボディ) を記録する。
+        log_response(payload_id, response.status, response.body)
+
+        unless response.success?
+          raise Chocomint::Error, "LLM HTTP #{response.status}: #{response.body}"
+        end
+
+        JSON.parse(response.body)
+      rescue JSON::ParserError => e
+        raise Chocomint::Error, "LLM response is not valid JSON: #{e.message}"
+      end
+
+      private
+
+      # ロガーが無い / 記録失敗時も LLM 呼び出し本体は止めない (堅牢性優先)。
+      # 戻り値: 記録した行 id (ロガー無し・失敗時は nil)。
+      def log_payload(body, headers, trace_id)
+        return nil unless @payload_logger
+
+        @payload_logger.record_llm_payload(
+          role: @role, model: @model, trace_id: trace_id,
+          request_body: body, request_headers: headers
+        )
+      rescue StandardError => e
+        warn "llm payload logging failed: #{e.message}"
+        nil
+      end
+
+      # LLM レスポンスを対応するペイロード行に追記する。記録失敗は無視する。
+      def log_response(payload_id, status, response_body)
+        return unless @payload_logger && payload_id
+
+        @payload_logger.update_llm_payload_response(
+          payload_id, response_status: status, response_body: response_body
+        )
+      rescue StandardError => e
+        warn "llm response logging failed: #{e.message}"
+      end
+
+      def connection
+        @connection ||= Faraday.new do |f|
+          f.options.timeout = @timeout
+          f.options.open_timeout = @timeout
+        end
+      end
+    end
+  end
+end

data/lib/chocomint/llm/chat_client.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "../errors"
+
+module Chocomint
+  module LLM
+    # /edit チャットの「普通の質問」応答を担う軽量クライアント。
+    #
+    # 役割は 2 つ:
+    #   1. classify — ユーザー指示が「ファイル操作/コマンド実行を要するタスク」か、
+    #      「ツール不要の普通の質問・会話」かを 1 語で判定する。
+    #   2. answer   — 会話と判定された指示に、ツールを使わず自然文で直接答える。
+    #
+    # タスクと判定された指示は呼び出し側 (EditHandlers) が Planner に渡す。
+    class ChatClient
+      # 分類プロンプト。ローカル小型モデルでも安定するよう、出力を 1 語に強制する。
+      CLASSIFY_SYSTEM_PROMPT = <<~PROMPT
+        あなたはユーザーの指示を 2 種類に分類する分類器です。
+        - "task": 実際の操作が必要なもの。ファイルの作成・編集・削除、
+          コマンド・プログラムの実行、外部ツールでの調査 (ping・実行・ビルド・
+          テスト・検索・一覧取得など) を伴うもの。「〜して」「〜を実行して」
+          「〜した結果をまとめて/教えて」のように、動かして結果を得る依頼はすべて task。
+          具体的な URL が示されていて、その内容を参照・要約する依頼も task。
+        - "chat": 操作を一切伴わず、言葉の説明・質問・相談・雑談だけで済むもの。
+          知識の説明や意見を求めるものはこちら。
+          また、今日の天気・最新ニュース・現在の株価のように「その場では調べる対象
+          (場所・URL など) が特定できない、リアルタイム情報を尋ねる質問」も chat。
+          これらは会話として聞き返し、必要な情報を確認するのが適切なため。
+        迷ったら task を選ぶこと (操作が必要なのに chat と誤ると何も実行されないため)。
+        出力は task または chat のいずれか 1 語のみ。他の文字は一切出力しないこと。
+      PROMPT
+
+      # 会話応答プロンプト。エディタ上のアシスタントとして簡潔に日本語で答えさせる。
+      # 現在日時・OS・シェルの情報は answer 実行時に environment_prompt を付加する。
+      ANSWER_SYSTEM_PROMPT = <<~PROMPT
+        あなたはコードエディタに組み込まれた親切なアシスタントです。
+        ユーザーの質問や相談に、簡潔で正確な日本語で答えてください。
+        実際のファイル操作やコマンド実行は行いません (この応答では行えません)。
+        操作が必要な場合は、その旨と具体的な手順を説明してください。
+        今日の天気・最新ニュースなどリアルタイム情報は、あなた自身は把握していません。
+        推測で答えず、参照したいウェブページの URL を教えてもらえれば内容を調べられる旨を
+        案内し、必要なら場所や対象を聞き返してください。
+        コマンド例を示すときは PowerShell (pwsh) の構文を優先してください。
+        絵文字は一切使わないでください。
+      PROMPT
+
+      # 実行結果の要約プロンプト。実行済みのツール列とその結果をもとに、
+      # ユーザー要求に対して何を行い・どうなったかを自然文でまとめさせる。
+      SUMMARIZE_SYSTEM_PROMPT = <<~PROMPT
+        あなたはコードエディタのアシスタントです。ユーザー要求を達成するために
+        いくつかのツール (ファイル編集やコマンド実行) を実行しました。
+        実行したツールとその結果をふまえ、「何をして・結果どうなったか」を
+        ユーザー向けに簡潔な日本語でまとめてください。
+        コマンドの生出力をそのまま貼るのではなく、要点を短く説明してください。
+        絵文字は一切使わないでください。
+      PROMPT
+
+      # ウェブページ内容の抽出プロンプト。fetch_url ツールが取得した本文テキストから、
+      # ユーザーの目的 (query) に沿って必要な情報を抜き出し・要約させる。
+      EXTRACT_SYSTEM_PROMPT = <<~PROMPT
+        あなたはウェブページの内容を読み取るアシスタントです。あるページの本文テキストと、
+        ユーザーが知りたいこと (目的) が渡されます。本文から目的に関係する情報だけを
+        抜き出し、簡潔で正確な日本語にまとめてください。
+        本文に答えが書かれていない場合は、その旨を正直に述べてください。
+        推測で補わず、本文に書かれている事実だけを根拠にしてください。
+        絵文字は一切使わないでください。
+      PROMPT
+
+      # 会話履歴の圧縮プロンプト。これまでのやり取りを、後から見返して文脈を
+      # 思い出せる短い要約に畳み込ませる (/compact 用)。
+      COMPACT_SYSTEM_PROMPT = <<~PROMPT
+        あなたはコードエディタのアシスタントです。これまでのユーザーとの
+        やり取りの記録を渡します。後から読み返して文脈を思い出せるよう、
+        「何を相談し・何を行い・どう決着したか」の要点を、簡潔な日本語の
+        箇条書きでまとめてください。未解決の課題や次の一手があれば残してください。
+        細部の生出力は省き、重要な事実と結論だけを残します。
+        絵文字は一切使わないでください。
+      PROMPT
+
+      def initialize(base_client:)
+        @client = base_client
+      end
+
+      # 指示を "task" / "chat" に分類する。判定不能時は安全側の "task" を返す
+      # (タスクを会話扱いして取りこぼすより、会話をタスク扱いして Planner に流す方が無難)。
+      def classify(instruction, trace_id: nil)
+        response = @client.create_message(
+          system: CLASSIFY_SYSTEM_PROMPT,
+          messages: [{ "role" => "user", "content" => instruction.to_s }],
+          trace_id: trace_id
+        )
+        text = extract_text(response).to_s.downcase
+        text.include?("chat") ? "chat" : "task"
+      end
+
+      # 会話としての自然文回答を返す。現在日時・OS・シェルの情報を毎回付加する
+      # (ローカルモデルが日付や実行環境を誤解しないようにするため)。
+      def answer(instruction, context: nil, trace_id: nil)
+        content = context.to_s.empty? ? instruction.to_s : "#{context}\n\n#{instruction}"
+        system_prompt = "#{ANSWER_SYSTEM_PROMPT}\n#{PrimaryClient.environment_prompt}"
+        response = @client.create_message(
+          system: system_prompt,
+          messages: [{ "role" => "user", "content" => content }],
+          trace_id: trace_id
+        )
+        text = strip_emoji(extract_text(response))
+        raise Chocomint::Error, "chat response is empty" if text.nil? || text.empty?
+
+        text
+      end
+
+      # 実行済みステップ列を自然文でまとめる。失敗しても要約なしで続行できるよう
+      # 例外時は nil を返す (呼び出し側は生の結果表示にフォールバックする)。
+      # steps: [{ tool:, arguments:, status:, output: }, ...] 形式。
+      def summarize(request, steps, trace_id: nil)
+        content = <<~MSG
+          ユーザー要求:
+          #{request}
+
+          実行したステップ:
+          #{format_steps(steps)}
+        MSG
+        response = @client.create_message(
+          system: SUMMARIZE_SYSTEM_PROMPT,
+          messages: [{ "role" => "user", "content" => content }],
+          trace_id: trace_id
+        )
+        text = strip_emoji(extract_text(response))
+        text.nil? || text.empty? ? nil : text
+      rescue Chocomint::Error
+        nil
+      end
+
+      # ウェブページ本文 (text) から、目的 (query) に沿った情報を抽出・要約する。
+      # fetch_url ツールから呼ばれる。抽出できないときは Chocomint::Error を投げる。
+      def extract(query, text, url: nil, trace_id: nil)
+        content = <<~MSG
+          対象URL: #{url}
+          知りたいこと: #{query.to_s.empty? ? '(指定なし。ページの要点をまとめる)' : query}
+
+          ページ本文:
+          #{text}
+        MSG
+        response = @client.create_message(
+          system: EXTRACT_SYSTEM_PROMPT,
+          messages: [{ "role" => "user", "content" => content }],
+          trace_id: trace_id
+        )
+        result = strip_emoji(extract_text(response))
+        raise Chocomint::Error, "extract response is empty" if result.nil? || result.empty?
+
+        result
+      end
+
+      # これまでの会話ログ (プレーンテキスト) を短い要約に畳み込む (/compact 用)。
+      # 要約できないときは Chocomint::Error を投げる (呼び出し側で 500 にする)。
+      def compact(transcript, trace_id: nil)
+        response = @client.create_message(
+          system: COMPACT_SYSTEM_PROMPT,
+          messages: [{ "role" => "user", "content" => transcript.to_s }],
+          trace_id: trace_id
+        )
+        text = strip_emoji(extract_text(response))
+        raise Chocomint::Error, "compact response is empty" if text.nil? || text.empty?
+
+        text
+      end
+
+      private
+
+      # モデルがプロンプト指示に反して絵文字を混ぜた場合の保険。
+      # 絵文字・記号ピクトグラム・異体字セレクタ・ZWJ を除去し、余分な空白を整える。
+      EMOJI_PATTERN = /[\u{1F000}-\u{1FAFF}\u{2600}-\u{27BF}\u{2B00}-\u{2BFF}\u{FE00}-\u{FE0F}\u{200D}\u{20E3}]/
+
+      def strip_emoji(text)
+        return text if text.nil?
+
+        text.gsub(EMOJI_PATTERN, "").gsub(/[ \t]{2,}/, " ").strip
+      end
+
+      SUMMARY_OUTPUT_LIMIT = 500
+
+      def format_steps(steps)
+        Array(steps).each_with_index.map do |s, i|
+          tool = s[:tool] || s["tool"]
+          status = s[:status] || s["status"]
+          out = (s[:output] || s["output"]).to_s.strip
+          out = "#{out[0, SUMMARY_OUTPUT_LIMIT]}…" if out.length > SUMMARY_OUTPUT_LIMIT
+          line = "#{i + 1}. #{tool} (#{status})"
+          out.empty? ? line : "#{line}\n   結果: #{out}"
+        end.join("\n")
+      end
+
+      def extract_text(response)
+        blocks = Array(response["content"])
+        texts = blocks.filter_map do |b|
+          b["text"] if b.is_a?(Hash) && b["type"] == "text"
+        end
+        return texts.join("\n") unless texts.empty?
+
+        response["content"].is_a?(String) ? response["content"] : nil
+      end
+    end
+  end
+end