Merge pull request #7 from i365dev/feature/execution-limits

Add Execution Limits and Statistics Tracking to AgentForge

Author: madawei2699

README.md

@@ -93,6 +93,44 @@ Compose handlers into pipelines:
 workflow = [&validate/2, &process/2, &notify/2]
 ```
 
+## Execution Limits
+
+AgentForge now supports execution limits for flows to prevent long-running processes:
+
+```elixir
+# Create a handler
+handler = fn signal, state ->
+  # Processing logic...
+  {{:emit, Signal.new(:done, result)}, state}
+end
+
+# Apply timeout limit
+{:ok, result, state} = AgentForge.process_with_limits(
+  [handler], 
+  signal, 
+  %{}, 
+  timeout_ms: 5000  # Execution limited to 5 seconds
+)
+
+# Get execution statistics in the result
+{:ok, result, state, stats} = AgentForge.process_with_limits(
+  [handler], 
+  signal, 
+  %{}, 
+  return_stats: true
+)
+
+# Or retrieve the last execution statistics afterwards
+stats = AgentForge.get_last_execution_stats()
+```
+
+The execution limits feature supports the following options:
+- `timeout_ms`: Maximum execution time in milliseconds (default: `30000`)
+- `collect_stats`: Whether to collect execution statistics (default: `true`)
+- `return_stats`: Whether to include statistics in the return value (default: `false`)
+
+See the documentation for more details.
+
 ## Documentation
 
 - [Getting Started Guide](guides/getting_started.md)

examples/limited_workflow.exs

@@ -0,0 +1,143 @@
+defmodule Examples.LimitedWorkflow do
+  @moduledoc """
+  This example demonstrates how to use execution limits in AgentForge.
+  
+  It shows:
+  1. How to set timeout limits
+  2. How to collect and analyze execution statistics
+  3. How to handle timeouts gracefully
+  """
+  
+  alias AgentForge.{Signal, Flow, ExecutionStats}
+  
+  def run do
+    IO.puts("=== Running Limited Workflow Example ===\n")
+    
+    # Simple example with timeout
+    run_with_timeout()
+    
+    # Example collecting statistics
+    run_with_statistics()
+    
+    # Example with long-running handler that will timeout
+    run_with_timeout_error()
+  end
+  
+  defp run_with_timeout do
+    IO.puts("\n--- Basic Example with Timeout ---")
+    
+    # Define a simple handler
+    handler = fn signal, state ->
+      IO.puts("Processing signal: #{signal.type} -> #{inspect(signal.data)}")
+      Process.sleep(100) # Simulate some work
+      {{:emit, Signal.new(:processed, signal.data)}, state}
+    end
+    
+    # Create signal and process with a generous timeout
+    signal = Signal.new(:task, "Sample data")
+    
+    {:ok, result, _state} = Flow.process_with_limits(
+      [handler], 
+      signal, 
+      %{},
+      timeout_ms: 5000 # 5 second timeout
+    )
+    
+    IO.puts("Result: #{result.type} -> #{inspect(result.data)}")
+  end
+  
+  defp run_with_statistics do
+    IO.puts("\n--- Example with Statistics Collection ---")
+    
+    # Define handlers that we'll track statistics for
+    handlers = [
+      # First handler - validate data
+      fn signal, state ->
+        IO.puts("Validating data...")
+        Process.sleep(50) # Simulate validation
+        {{:emit, Signal.new(:validated, signal.data)}, state}
+      end,
+      
+      # Second handler - transform data
+      fn signal, state ->
+        IO.puts("Transforming data...")
+        Process.sleep(100) # Simulate transformation
+        {{:emit, Signal.new(:transformed, "#{signal.data} (transformed)")}, state}
+      end,
+      
+      # Third handler - finalize
+      fn signal, state ->
+        IO.puts("Finalizing...")
+        Process.sleep(75) # Simulate finalization
+        {{:emit, Signal.new(:completed, signal.data)}, state}
+      end
+    ]
+    
+    # Create signal and process with statistics
+    signal = Signal.new(:input, "Test data")
+    
+    {:ok, result, _state, stats} = Flow.process_with_limits(
+      handlers, 
+      signal, 
+      %{},
+      timeout_ms: 5000,
+      return_stats: true # Return stats in the result
+    )
+    
+    IO.puts("Result: #{result.type} -> #{inspect(result.data)}")
+    IO.puts("\nExecution Statistics:")
+    IO.puts("- Total steps: #{stats.steps}")
+    IO.puts("- Elapsed time: #{stats.elapsed_ms}ms")
+    IO.puts("- Completed: #{stats.complete}")
+  end
+  
+  defp run_with_timeout_error do
+    IO.puts("\n--- Example with Timeout Error ---")
+    
+    # Define a handler that will take too long
+    slow_handler = fn signal, state ->
+      IO.puts("Starting long process...")
+      # This will exceed our timeout
+      Process.sleep(2000)
+      {{:emit, Signal.new(:done, signal.data)}, state}
+    end
+    
+    signal = Signal.new(:task, "Important data")
+    
+    # Process with a short timeout - this should timeout
+    result = Flow.process_with_limits(
+      [slow_handler], 
+      signal, 
+      %{},
+      timeout_ms: 500 # Only 500ms timeout
+    )
+    
+    case result do
+      {:error, error_message, _state} ->
+        IO.puts("Error handled gracefully: #{error_message}")
+        
+      other ->
+        IO.puts("Unexpected result: #{inspect(other)}")
+    end
+    
+    # We can still retrieve the execution stats afterwards
+    stats = Flow.get_last_execution_stats()
+    
+    if stats do
+      IO.puts("\nTimeout Statistics:")
+      IO.puts("- Elapsed time: #{stats.elapsed_ms}ms")
+      IO.puts("- Completed: #{stats.complete}")
+    else
+      IO.puts("\nNo statistics available")
+    end
+  end
+end
+
+# Run the example when this file is executed directly
+if Code.ensure_loaded?(IEx) && IEx.started?() do
+  # Running in IEx, let the user decide when to run
+  IO.puts("Run Examples.LimitedWorkflow.run() to execute the example")
+else
+  # Running as a script, execute immediately
+  Examples.LimitedWorkflow.run()
+end