Add debug logging to engine implementations and safe-outputs features (#3723)

Author: github-actions[bot]

pkg/workflow/codex_engine.go

@@ -9,8 +9,11 @@ import (
 	"time"
 
 	"github.com/githubnext/gh-aw/pkg/constants"
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var codexEngineLog = logger.New("workflow:codex_engine")
+
 // Pre-compiled regexes for Codex log parsing (performance optimization)
 var (
 	codexToolCallOldFormat    = regexp.MustCompile(`\] tool ([^(]+)\(`)
@@ -43,6 +46,7 @@ func NewCodexEngine() *CodexEngine {
 }
 
 func (e *CodexEngine) GetInstallationSteps(workflowData *WorkflowData) []GitHubActionStep {
+	codexEngineLog.Printf("Generating installation steps for Codex engine: workflow=%s", workflowData.Name)
 	var steps []GitHubActionStep
 
 	// Add secret validation step - Codex supports both CODEX_API_KEY and OPENAI_API_KEY as fallback
@@ -76,6 +80,13 @@ func (e *CodexEngine) GetDeclaredOutputFiles() []string {
 
 // GetExecutionSteps returns the GitHub Actions steps for executing Codex
 func (e *CodexEngine) GetExecutionSteps(workflowData *WorkflowData, logFile string) []GitHubActionStep {
+	model := ""
+	if workflowData.EngineConfig != nil && workflowData.EngineConfig.Model != "" {
+		model = workflowData.EngineConfig.Model
+	}
+	codexEngineLog.Printf("Building Codex execution steps: workflow=%s, model=%s, has_agent_file=%v",
+		workflowData.Name, model, workflowData.AgentFile != "")
+
 	// Handle custom steps if they exist in engine config
 	steps := InjectCustomEngineSteps(workflowData, e.convertStepToYAML)
 
@@ -269,6 +280,10 @@ func (e *CodexEngine) renderShellEnvironmentPolicy(yaml *strings.Builder, tools
 }
 
 func (e *CodexEngine) RenderMCPConfig(yaml *strings.Builder, tools map[string]any, mcpTools []string, workflowData *WorkflowData) {
+	if codexEngineLog.Enabled() {
+		codexEngineLog.Printf("Rendering MCP config for Codex: mcp_tools=%v, tool_count=%d", mcpTools, len(tools))
+	}
+
 	yaml.WriteString("          cat > /tmp/gh-aw/mcp-config/config.toml << EOF\n")
 
 	// Add history configuration to disable persistence
@@ -325,6 +340,8 @@ func (e *CodexEngine) RenderMCPConfig(yaml *strings.Builder, tools map[string]an
 
 // ParseLogMetrics implements engine-specific log parsing for Codex
 func (e *CodexEngine) ParseLogMetrics(logContent string, verbose bool) LogMetrics {
+	codexEngineLog.Printf("Parsing Codex log metrics: log_size=%d bytes, lines=%d", len(logContent), len(strings.Split(logContent, "\n")))
+
 	var metrics LogMetrics
 	var totalTokenUsage int
 
@@ -395,6 +412,9 @@ func (e *CodexEngine) ParseLogMetrics(logContent string, verbose bool) LogMetric
 		metrics.Errors = CountErrorsAndWarningsWithPatterns(logContent, errorPatterns)
 	}
 
+	codexEngineLog.Printf("Parsed Codex metrics: turns=%d, token_usage=%d, tool_calls=%d, errors=%d",
+		metrics.Turns, metrics.TokenUsage, len(metrics.ToolCalls), len(metrics.Errors))
+
 	return metrics
 }
 

pkg/workflow/create_agent_task.go

@@ -2,8 +2,12 @@ package workflow
 
 import (
 	"fmt"
+
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var createAgentTaskLog = logger.New("workflow:create_agent_task")
+
 // CreateAgentTaskConfig holds configuration for creating GitHub Copilot agent tasks from agent output
 type CreateAgentTaskConfig struct {
 	BaseSafeOutputConfig `yaml:",inline"`
@@ -14,6 +18,7 @@ type CreateAgentTaskConfig struct {
 // parseAgentTaskConfig handles create-agent-task configuration
 func (c *Compiler) parseAgentTaskConfig(outputMap map[string]any) *CreateAgentTaskConfig {
 	if configData, exists := outputMap["create-agent-task"]; exists {
+		createAgentTaskLog.Print("Parsing create-agent-task configuration")
 		agentTaskConfig := &CreateAgentTaskConfig{}
 		agentTaskConfig.Max = 1 // Default max is 1
 
@@ -49,6 +54,9 @@ func (c *Compiler) buildCreateOutputAgentTaskJob(data *WorkflowData, mainJobName
 		return nil, fmt.Errorf("safe-outputs.create-agent-task configuration is required")
 	}
 
+	createAgentTaskLog.Printf("Building create-agent-task job: workflow=%s, main_job=%s, base=%s",
+		data.Name, mainJobName, data.SafeOutputs.CreateAgentTasks.Base)
+
 	var steps []string
 
 	// Step 1: Checkout repository for gh CLI to work

pkg/workflow/create_issue.go

@@ -3,8 +3,12 @@ package workflow
 import (
 	"fmt"
 	"strings"
+
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var createIssueLog = logger.New("workflow:create_issue")
+
 // CreateIssuesConfig holds configuration for creating GitHub issues from agent output
 type CreateIssuesConfig struct {
 	BaseSafeOutputConfig `yaml:",inline"`
@@ -17,6 +21,7 @@ type CreateIssuesConfig struct {
 // parseIssuesConfig handles create-issue configuration
 func (c *Compiler) parseIssuesConfig(outputMap map[string]any) *CreateIssuesConfig {
 	if configData, exists := outputMap["create-issue"]; exists {
+		createIssueLog.Print("Parsing create-issue configuration")
 		issuesConfig := &CreateIssuesConfig{}
 		issuesConfig.Max = 1 // Default max is 1
 
@@ -68,6 +73,11 @@ func (c *Compiler) buildCreateOutputIssueJob(data *WorkflowData, mainJobName str
 		return nil, fmt.Errorf("safe-outputs.create-issue configuration is required")
 	}
 
+	if createIssueLog.Enabled() {
+		createIssueLog.Printf("Building create-issue job: workflow=%s, main_job=%s, assignees=%d, labels=%d",
+			data.Name, mainJobName, len(data.SafeOutputs.CreateIssues.Assignees), len(data.SafeOutputs.CreateIssues.Labels))
+	}
+
 	// Build custom environment variables specific to create-issue
 	var customEnvVars []string
 

pkg/workflow/create_pull_request.go

@@ -5,8 +5,11 @@ import (
 	"strings"
 
 	"github.com/githubnext/gh-aw/pkg/constants"
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var createPRLog = logger.New("workflow:create_pull_request")
+
 // CreatePullRequestsConfig holds configuration for creating GitHub pull requests from agent output
 type CreatePullRequestsConfig struct {
 	BaseSafeOutputConfig `yaml:",inline"`
@@ -24,6 +27,15 @@ func (c *Compiler) buildCreateOutputPullRequestJob(data *WorkflowData, mainJobNa
 		return nil, fmt.Errorf("safe-outputs.create-pull-request configuration is required")
 	}
 
+	if createPRLog.Enabled() {
+		draftValue := true // Default
+		if data.SafeOutputs.CreatePullRequests.Draft != nil {
+			draftValue = *data.SafeOutputs.CreatePullRequests.Draft
+		}
+		createPRLog.Printf("Building create-pull-request job: workflow=%s, main_job=%s, draft=%v, reviewers=%d",
+			data.Name, mainJobName, draftValue, len(data.SafeOutputs.CreatePullRequests.Reviewers))
+	}
+
 	// Build pre-steps for patch download, checkout, and git config
 	var preSteps []string
 
@@ -133,9 +145,11 @@ func (c *Compiler) buildCreateOutputPullRequestJob(data *WorkflowData, mainJobNa
 func (c *Compiler) parsePullRequestsConfig(outputMap map[string]any) *CreatePullRequestsConfig {
 	// Check for singular form only
 	if _, exists := outputMap["create-pull-request"]; !exists {
+		createPRLog.Print("No create-pull-request configuration found")
 		return nil
 	}
 
+	createPRLog.Print("Parsing create-pull-request configuration")
 	configData := outputMap["create-pull-request"]
 	pullRequestsConfig := &CreatePullRequestsConfig{}
 	pullRequestsConfig.Max = 1 // Always max 1 for pull requests

pkg/workflow/custom_engine.go

@@ -3,8 +3,12 @@ package workflow
 import (
 	"fmt"
 	"strings"
+
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var customEngineLog = logger.New("workflow:custom_engine")
+
 // CustomEngine represents a custom agentic engine that executes user-defined GitHub Actions steps
 type CustomEngine struct {
 	BaseEngine
@@ -34,6 +38,12 @@ func (e *CustomEngine) GetInstallationSteps(workflowData *WorkflowData) []GitHub
 
 // GetExecutionSteps returns the GitHub Actions steps for executing custom steps
 func (e *CustomEngine) GetExecutionSteps(workflowData *WorkflowData, logFile string) []GitHubActionStep {
+	stepCount := 0
+	if workflowData.EngineConfig != nil {
+		stepCount = len(workflowData.EngineConfig.Steps)
+	}
+	customEngineLog.Printf("Building custom engine execution steps: workflow=%s, custom_steps=%d", workflowData.Name, stepCount)
+
 	var steps []GitHubActionStep
 
 	// Generate each custom step if they exist, with environment variables
@@ -219,6 +229,7 @@ func (e *CustomEngine) renderAgenticWorkflowsMCPConfig(yaml *strings.Builder, is
 // ParseLogMetrics implements basic log parsing for custom engine
 // For custom engines, try both Claude and Codex parsing approaches to extract turn information
 func (e *CustomEngine) ParseLogMetrics(logContent string, verbose bool) LogMetrics {
+	customEngineLog.Printf("Parsing custom engine log metrics: log_size=%d bytes", len(logContent))
 	var metrics LogMetrics
 
 	// First try Claude-style parsing to see if the logs are Claude-format
@@ -228,6 +239,7 @@ func (e *CustomEngine) ParseLogMetrics(logContent string, verbose bool) LogMetri
 		claudeMetrics := claudeEngine.ParseLogMetrics(logContent, verbose)
 		if claudeMetrics.Turns > 0 || claudeMetrics.TokenUsage > 0 || claudeMetrics.EstimatedCost > 0 {
 			// Found structured data, use Claude parsing
+			customEngineLog.Print("Using Claude-style parsing for custom engine logs")
 			if verbose {
 				fmt.Println("Custom engine: Using Claude-style parsing for logs")
 			}
@@ -241,6 +253,7 @@ func (e *CustomEngine) ParseLogMetrics(logContent string, verbose bool) LogMetri
 		codexMetrics := codexEngine.ParseLogMetrics(logContent, verbose)
 		if codexMetrics.Turns > 0 || codexMetrics.TokenUsage > 0 {
 			// Found some data, use Codex parsing
+			customEngineLog.Print("Using Codex-style parsing for custom engine logs")
 			if verbose {
 				fmt.Println("Custom engine: Using Codex-style parsing for logs")
 			}
@@ -249,6 +262,7 @@ func (e *CustomEngine) ParseLogMetrics(logContent string, verbose bool) LogMetri
 	}
 
 	// Fall back to basic parsing if neither Claude nor Codex approaches work
+	customEngineLog.Print("Using basic fallback parsing for custom engine logs")
 	if verbose {
 		fmt.Println("Custom engine: Using basic fallback parsing for logs")
 	}