swarm_sdk 2.7.14 → 3.0.0.alpha2

data/lib/swarm_sdk/agent/chat_helpers/hook_integration.rb

@@ -1,480 +0,0 @@
-# frozen_string_literal: true
-
-module SwarmSDK
-  module Agent
-    module ChatHelpers
-      # Integrates SwarmSDK's hook system with Agent::Chat
-      #
-      # Responsibilities:
-      # - Setup hook system (registry, executor, agent hooks)
-      # - Provide trigger methods for all hook events
-      # - Wrap ask() to inject user_prompt hooks
-      # - Handle hook results (halt, replace, continue, reprompt)
-      #
-      # This module is included in Agent::Chat and provides methods for triggering hooks.
-      # It overrides ask() to inject user_prompt hooks, but does NOT override
-      # handle_tool_calls (that's handled in Agent::Chat with explicit hook calls).
-      module HookIntegration
-        # Expose hook system components for ContextTracker
-        attr_reader :hook_executor, :hook_swarm, :hook_agent_hooks
-
-        # Setup the hook system for this agent chat
-        #
-        # This must be called after setup_context and before the first ask/complete.
-        # It wires up the hook system to trigger at the right times.
-        #
-        # @param registry [Hooks::Registry] Shared registry for named hooks and swarm defaults
-        # @param agent_definition [Agent::Definition] Agent configuration with hooks
-        # @param swarm [Swarm, nil] Reference to swarm for context
-        # @return [void]
-        def setup_hooks(registry:, agent_definition:, swarm: nil)
-          @hook_registry = registry
-          @hook_swarm = swarm
-          @hook_executor = Hooks::Executor.new(registry, logger: RubyLLM.logger)
-
-          # Extract agent hooks based on format
-          hooks = agent_definition.hooks || {}
-
-          # Check if hooks are pre-parsed HookDefinition objects (from DSL)
-          # or raw YAML hash (to be processed by Hooks::Adapter in pass_5)
-          @hook_agent_hooks = if hooks.is_a?(Hash) && hooks.values.all? { |v| v.is_a?(Array) && v.all? { |item| item.is_a?(Hooks::Definition) } }
-            # DSL hooks - already parsed, use them
-            hooks
-          else
-            # YAML hooks - raw hash, will be processed in pass_5 by Hooks::Adapter
-            # For now, use empty hash (pass_5 will add them later)
-            {}
-          end
-        end
-
-        # Add a hook programmatically at runtime
-        #
-        # This allows agents to add hooks dynamically, which is useful for
-        # implementing adaptive behavior or runtime monitoring.
-        #
-        # @param event [Symbol] Event type (e.g., :pre_tool_use)
-        # @param matcher [String, Regexp, nil] Optional regex pattern for tool names
-        # @param priority [Integer] Execution priority (higher = earlier)
-        # @param block [Proc] Hook implementation
-        def add_hook(event, matcher: nil, priority: 0, &block)
-          raise ArgumentError, "Hooks not set up. Call setup_hooks first." unless @hook_executor
-
-          definition = Hooks::Definition.new(
-            event: event,
-            matcher: matcher,
-            priority: priority,
-            proc: block,
-          )
-
-          @hook_agent_hooks[event] ||= []
-          @hook_agent_hooks[event] << definition
-          @hook_agent_hooks[event].sort_by! { |cb| -cb.priority }
-        end
-
-        # NOTE: The ask() method override has been removed.
-        #
-        # In the new wrapper-based architecture, Agent::Chat#ask handles:
-        # 1. System reminder injection
-        # 2. User prompt hooks via trigger_user_prompt
-        # 3. Global semaphore acquisition
-        # 4. Delegation to RubyLLM::Chat
-        #
-        # The hook integration is now done directly in Agent::Chat#ask rather than
-        # through module override, since there's no inheritance chain to call super on.
-
-        # Override check_context_warnings to trigger our hook system
-        #
-        # This wraps the default context warning behavior to also trigger hooks.
-        # Unified implementation that:
-        # 1. Emits context_threshold_hit events (for snapshot reconstruction)
-        # 2. Optionally triggers automatic compression at 60% (if no custom handler)
-        # 3. Emits context_limit_warning events (backward compatibility)
-        # 4. Triggers user-defined context_warning hooks
-        def check_context_warnings
-          return unless respond_to?(:context_usage_percentage)
-
-          current_percentage = context_usage_percentage
-
-          Context::CONTEXT_WARNING_THRESHOLDS.each do |threshold|
-            # Only warn once per threshold
-            next if @agent_context.warning_threshold_hit?(threshold)
-            next if current_percentage < threshold
-
-            # Mark threshold as hit
-            @agent_context.hit_warning_threshold?(threshold)
-
-            # Emit context_threshold_hit event (for snapshot reconstruction) - CRITICAL
-            LogStream.emit(
-              type: "context_threshold_hit",
-              agent: @agent_context.name,
-              threshold: threshold,
-              current_usage_percentage: current_percentage.round(2),
-            )
-
-            # Check if user has defined custom handler for context_warning
-            # Custom handlers take responsibility for managing context at this threshold
-            has_custom_handler = (@hook_agent_hooks[:context_warning] || []).any?
-
-            # Trigger automatic compression at 60% ONLY if no custom handler
-            compression_triggered = false
-            if threshold == SwarmSDK.config.context_compression_threshold && !has_custom_handler
-              compressed_count = apply_automatic_compression
-              compression_triggered = compressed_count > 0
-            end
-
-            # Emit legacy context_limit_warning for backwards compatibility
-            LogStream.emit(
-              type: "context_limit_warning",
-              agent: @agent_context.name,
-              model: model_id,
-              threshold: "#{threshold}%",
-              current_usage: "#{current_percentage}%",
-              tokens_used: cumulative_total_tokens,
-              tokens_remaining: tokens_remaining,
-              context_limit: context_limit,
-              metadata: @agent_context.metadata,
-              compression_triggered: compression_triggered,
-            )
-
-            # Trigger hook system (user-defined handlers)
-            trigger_context_warning(threshold, current_percentage) if @hook_executor
-          end
-        end
-
-        # Trigger pre_tool_use hooks
-        #
-        # Should be called by Agent::Chat before tool execution.
-        # Returns a hash indicating whether to proceed and any custom result.
-        #
-        # @param tool_call [RubyLLM::ToolCall] Tool call from LLM
-        # @return [Hash] { proceed: true/false, custom_result: result (if any) }
-        def trigger_pre_tool_use(tool_call)
-          return { proceed: true } unless @hook_executor
-
-          context = build_hook_context(
-            event: :pre_tool_use,
-            tool_call: wrap_tool_call_to_hooks(tool_call),
-          )
-
-          agent_hooks = @hook_agent_hooks[:pre_tool_use] || []
-
-          result = @hook_executor.execute_safe(
-            event: :pre_tool_use,
-            context: context,
-            callbacks: agent_hooks,
-          )
-
-          # Return custom result if hook provides one
-          if result.replace?
-            { proceed: false, custom_result: result.value }
-          elsif result.halt?
-            { proceed: false, custom_result: result.value || "Tool execution blocked by hook" }
-          elsif result.finish_agent?
-            # Finish agent execution immediately with this message
-            { proceed: false, finish_agent: true, custom_result: result.value }
-          elsif result.finish_swarm?
-            # Finish entire swarm execution immediately with this message
-            { proceed: false, finish_swarm: true, custom_result: result.value }
-          else
-            { proceed: true }
-          end
-        end
-
-        # Trigger post_tool_use hooks
-        #
-        # Should be called by Agent::Chat after tool execution.
-        # Returns modified result if hook replaces it, or a special marker for finish actions.
-        #
-        # @param result [String, Object] Tool execution result
-        # @param tool_call [RubyLLM::ToolCall] Tool call object with full context
-        # @return [Object, Hash] Modified result if hook replaces it, hash with :finish_agent or :finish_swarm if finishing, otherwise original result
-        def trigger_post_tool_use(result, tool_call:)
-          return result unless @hook_executor
-
-          # Extract tracking digest for Read/MemoryRead tools
-          metadata_with_digest = extract_tool_tracking_digest(tool_call, result)
-
-          context = build_hook_context(
-            event: :post_tool_use,
-            tool_result: wrap_tool_result(tool_call.id, tool_call.name, result),
-            metadata: metadata_with_digest,
-          )
-
-          agent_hooks = @hook_agent_hooks[:post_tool_use] || []
-
-          hook_result = @hook_executor.execute_safe(
-            event: :post_tool_use,
-            context: context,
-            callbacks: agent_hooks,
-          )
-
-          # Return modified result or finish markers
-          if hook_result.replace?
-            hook_result.value
-          elsif hook_result.finish_agent?
-            { __finish_agent__: true, message: hook_result.value }
-          elsif hook_result.finish_swarm?
-            { __finish_swarm__: true, message: hook_result.value }
-          else
-            result
-          end
-        end
-
-        private
-
-        # Apply automatic message compression when context threshold is hit
-        #
-        # Called when context usage crosses 60% threshold and no custom handler exists.
-        # Compresses old tool results to save context window space while preserving accuracy.
-        #
-        # @return [Integer] Number of messages compressed (0 if compression not applied)
-        def apply_automatic_compression
-          return 0 unless respond_to?(:context_manager) && respond_to?(:messages)
-
-          # Calculate tokens before compression
-          tokens_before = cumulative_total_tokens
-
-          # Get compressed messages from ContextManager
-          compressed = context_manager.auto_compress_on_threshold(messages, keep_recent: 10)
-
-          # Count how many messages were actually compressed
-          messages_compressed = compressed.count do |msg|
-            msg.content.to_s.include?("[truncated for context management]")
-          end
-
-          # Replace messages using proper abstraction
-          replace_messages(compressed)
-
-          # Log compression event
-          LogStream.emit(
-            type: "context_compression",
-            agent: @agent_context.name,
-            total_messages: message_count,
-            messages_compressed: messages_compressed,
-            tokens_before: tokens_before,
-            current_usage: "#{context_usage_percentage}%",
-            compression_strategy: "progressive_tool_result_compression",
-            keep_recent: 10,
-            triggered_by: "auto_compression_threshold",
-          ) if LogStream.enabled?
-
-          messages_compressed
-        end
-
-        # Trigger context_warning hooks
-        #
-        # Hooks have access to the chat instance via metadata[:chat]
-        # to access and manipulate the messages array.
-        #
-        # @param threshold [Integer] Warning threshold percentage
-        # @param current_usage [Float] Current usage percentage
-        # @return [void]
-        def trigger_context_warning(threshold, current_usage)
-          return unless @hook_executor
-
-          context = build_hook_context(
-            event: :context_warning,
-            metadata: {
-              chat: self, # Provide access to chat instance (for messages array)
-              threshold: threshold,
-              percentage: current_usage,
-              tokens_used: cumulative_total_tokens,
-              tokens_remaining: tokens_remaining,
-              context_limit: context_limit,
-            },
-          )
-
-          agent_hooks = @hook_agent_hooks[:context_warning] || []
-
-          @hook_executor.execute_safe(
-            event: :context_warning,
-            context: context,
-            callbacks: agent_hooks,
-          )
-        end
-
-        # Trigger user_prompt hooks
-        #
-        # This fires before sending a user message to the LLM.
-        # Can halt execution or append hook stdout to prompt.
-        #
-        # @param prompt [String] User's message/prompt
-        # @param source [String] Source of the prompt ("user" or "delegation")
-        # @return [Hash] { halted: bool, halt_message: String, modified_prompt: String }
-        def trigger_user_prompt(prompt, source: "user")
-          return { halted: false, modified_prompt: prompt } unless @hook_executor
-
-          # Get tool names without delegation tools using proper abstraction
-          actual_tools = if respond_to?(:non_delegation_tool_names) && @agent_context
-            non_delegation_tool_names
-          else
-            []
-          end
-
-          # Extract agent names from delegation tool names
-          delegate_agents = if @agent_context&.delegation_tools
-            @agent_context.delegation_tools.map { |tool_name| @context_tracker.extract_delegate_agent_name(tool_name) }
-          else
-            []
-          end
-
-          context = build_hook_context(
-            event: :user_prompt,
-            metadata: {
-              prompt: prompt,
-              message_count: message_count,
-              model: model_id,
-              provider: model_provider,
-              tools: actual_tools,
-              delegates_to: delegate_agents,
-              source: source,
-              timestamp: Time.now.utc.iso8601,
-            },
-          )
-
-          agent_hooks = @hook_agent_hooks[:user_prompt] || []
-
-          result = @hook_executor.execute_safe(
-            event: :user_prompt,
-            context: context,
-            callbacks: agent_hooks,
-          )
-
-          # Handle hook result
-          if result.halt?
-            # Hook blocked execution
-            { halted: true, halt_message: result.value }
-          elsif result.replace?
-            # Hook provided stdout to append to prompt (exit code 0)
-            modified_prompt = "#{prompt}\n\n<hook-context>\n#{result.value}\n</hook-context>"
-            { halted: false, modified_prompt: modified_prompt }
-          else
-            # Normal continue
-            { halted: false, modified_prompt: prompt }
-          end
-        end
-
-        # Build a hook context object
-        #
-        # @param event [Symbol] Event type
-        # @param tool_call [Hooks::ToolCall, nil] Tool call object
-        # @param tool_result [Hooks::ToolResult, nil] Tool result object
-        # @param metadata [Hash] Additional metadata
-        # @return [Hooks::Context] Context object
-        def build_hook_context(event:, tool_call: nil, tool_result: nil, metadata: {})
-          Hooks::Context.new(
-            event: event,
-            agent_name: @agent_context&.name || "unknown",
-            agent_definition: nil, # Could store this in setup_hooks if needed
-            swarm: @hook_swarm,
-            tool_call: tool_call,
-            tool_result: tool_result,
-            metadata: metadata,
-          )
-        end
-
-        # Wrap a RubyLLM tool call in our Hooks::ToolCall value object
-        #
-        # @param tool_call [RubyLLM::ToolCall] RubyLLM tool call
-        # @return [Hooks::ToolCall] Our wrapped tool call
-        def wrap_tool_call_to_hooks(tool_call)
-          Hooks::ToolCall.new(
-            id: tool_call.id,
-            name: tool_call.name,
-            parameters: tool_call.arguments,
-          )
-        end
-
-        # Extract tracking digest for Read/MemoryRead tools
-        #
-        # Queries the appropriate tracker after tool execution to get the digest
-        # that was calculated and stored during the read operation.
-        #
-        # @param tool_call [RubyLLM::ToolCall] Tool call with arguments
-        # @param result [Object] Tool execution result (to check for errors)
-        # @return [Hash] Metadata hash with digest if applicable
-        def extract_tool_tracking_digest(tool_call, result)
-          # Only add digest for successful Read/MemoryRead tool calls
-          return {} if result.is_a?(StandardError)
-          return {} unless ["Read", "MemoryRead"].include?(tool_call.name)
-
-          # Extract path from arguments
-          path = case tool_call.name
-          when "Read"
-            tool_call.arguments[:file_path] || tool_call.arguments["file_path"]
-          when "MemoryRead"
-            tool_call.arguments[:file_path] || tool_call.arguments["file_path"]
-          end
-
-          return {} unless path
-
-          # Query tracker for digest
-          digest = case tool_call.name
-          when "Read"
-            Tools::Stores::ReadTracker.get_read_files(@agent_context.name)[File.expand_path(path)]
-          else
-            # Query registered plugins for digest (e.g., MemoryRead from SwarmMemory plugin)
-            query_plugin_for_digest(tool_call.name, path)
-          end
-
-          digest ? { read_digest: digest, read_path: path } : {}
-        end
-
-        # Query registered plugins for a tool result digest
-        #
-        # This allows plugins to provide digest tracking for their own tools
-        # (e.g., MemoryRead tracking in SwarmMemory plugin).
-        #
-        # @param tool_name [String] Name of the tool
-        # @param path [String] Path or identifier of the resource
-        # @return [String, nil] Digest from first plugin that responds, or nil
-        def query_plugin_for_digest(tool_name, path)
-          return unless @agent_context
-
-          PluginRegistry.all.each do |plugin|
-            digest = plugin.get_tool_result_digest(
-              agent_name: @agent_context.name,
-              tool_name: tool_name,
-              path: path,
-            )
-            return digest if digest
-          end
-
-          nil
-        end
-
-        # Wrap a tool result in our Hooks::ToolResult value object
-        #
-        # @param tool_call_id [String] Tool call ID
-        # @param tool_name [String] Tool name
-        # @param result [Object] Tool execution result
-        # @return [Hooks::ToolResult] Our wrapped result
-        def wrap_tool_result(tool_call_id, tool_name, result)
-          success = !result.is_a?(StandardError)
-          error = result.is_a?(StandardError) ? result.message : nil
-
-          Hooks::ToolResult.new(
-            tool_call_id: tool_call_id,
-            tool_name: tool_name,
-            content: success ? result : nil,
-            success: success,
-            error: error,
-          )
-        end
-
-        # Check if a tool call is a delegation tool
-        #
-        # Delegation tools fire their own pre_delegation/post_delegation events
-        # and should NOT fire pre_tool_use/post_tool_use events.
-        #
-        # @param tool_call [RubyLLM::ToolCall] Tool call to check
-        # @return [Boolean] true if this is a delegation tool
-        def delegation_tool_call?(tool_call)
-          return false unless @agent_context
-
-          @agent_context.delegation_tool?(tool_call.name)
-        end
-      end
-    end
-  end
-end

data/lib/swarm_sdk/agent/chat_helpers/instrumentation.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module SwarmSDK
-  module Agent
-    module ChatHelpers
-      # LLM instrumentation for API request/response logging
-      #
-      # Extracted from Chat to reduce class size and centralize observability logic.
-      module Instrumentation
-        private
-
-        # Inject LLM instrumentation middleware for API request/response logging
-        #
-        # @return [void]
-        def inject_llm_instrumentation
-          puts "=== inject_llm_instrumentation called ===" if ENV["DEBUG_CITATIONS"]
-          return unless @provider
-
-          puts "=== Has provider ===" if ENV["DEBUG_CITATIONS"]
-
-          faraday_conn = @provider.connection&.connection
-          return unless faraday_conn
-
-          puts "=== Has faraday connection ===" if ENV["DEBUG_CITATIONS"]
-          return if @llm_instrumentation_injected
-
-          provider_name = @provider.class.name.split("::").last.downcase
-
-          faraday_conn.builder.insert(
-            0,
-            SwarmSDK::Agent::LLMInstrumentationMiddleware,
-            on_request: method(:handle_llm_api_request),
-            on_response: method(:handle_llm_api_response),
-            provider_name: provider_name,
-          )
-
-          @llm_instrumentation_injected = true
-
-          puts "=== MIDDLEWARE INJECTED ===" if ENV["DEBUG_CITATIONS"]
-          RubyLLM.logger.debug("SwarmSDK: Injected LLM instrumentation middleware for agent #{@agent_name}")
-        rescue StandardError => e
-          puts "=== MIDDLEWARE INJECTION ERROR: #{e.message} ===" if ENV["DEBUG_CITATIONS"]
-          LogStream.emit_error(e, source: "instrumentation", context: "inject_middleware", agent: @agent_name)
-          RubyLLM.logger.debug("SwarmSDK: Failed to inject LLM instrumentation: #{e.message}")
-        end
-
-        # Handle LLM API request event
-        #
-        # @param data [Hash] Request data from middleware
-        def handle_llm_api_request(data)
-          return unless LogStream.emitter
-
-          LogStream.emit(
-            type: "llm_api_request",
-            agent: @agent_name,
-            swarm_id: @agent_context&.swarm_id,
-            parent_swarm_id: @agent_context&.parent_swarm_id,
-            **data,
-          )
-        rescue StandardError => e
-          LogStream.emit_error(e, source: "instrumentation", context: "emit_llm_api_request", agent: @agent_name)
-          RubyLLM.logger.debug("SwarmSDK: Error emitting llm_api_request event: #{e.message}")
-        end
-
-        # Handle LLM API response event
-        #
-        # @param data [Hash] Response data from middleware
-        def handle_llm_api_response(data)
-          return unless LogStream.emitter
-
-          LogStream.emit(
-            type: "llm_api_response",
-            agent: @agent_name,
-            swarm_id: @agent_context&.swarm_id,
-            parent_swarm_id: @agent_context&.parent_swarm_id,
-            **data,
-          )
-        rescue StandardError => e
-          LogStream.emit_error(e, source: "instrumentation", context: "emit_llm_api_response", agent: @agent_name)
-          RubyLLM.logger.debug("SwarmSDK: Error emitting llm_api_response event: #{e.message}")
-        end
-      end
-    end
-  end
-end