Add debug logging to 5 core files (#2584)

Author: github-actions[bot]

pkg/cli/repo.go

@@ -5,8 +5,12 @@ import (
 	"os/exec"
 	"strings"
 	"sync"
+
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var repoLog = logger.New("cli:repo")
+
 // Global cache for current repository info
 var (
 	getCurrentRepoSlugOnce sync.Once
@@ -25,7 +29,10 @@ func ClearCurrentRepoSlugCache() {
 // getCurrentRepoSlugUncached gets the current repository slug (owner/repo) using gh CLI (uncached)
 // Falls back to git remote parsing if gh CLI is not available
 func getCurrentRepoSlugUncached() (string, error) {
+	repoLog.Print("Fetching current repository slug")
+
 	// Try gh CLI first (most reliable)
+	repoLog.Print("Attempting to get repository slug via gh CLI")
 	cmd := exec.Command("gh", "repo", "view", "--json", "owner,name", "--jq", ".owner.login + \"/\" + .name")
 	output, err := cmd.Output()
 	if err == nil {
@@ -34,19 +41,23 @@ func getCurrentRepoSlugUncached() (string, error) {
 			// Validate format (should be owner/repo)
 			parts := strings.Split(repoSlug, "/")
 			if len(parts) == 2 && parts[0] != "" && parts[1] != "" {
+				repoLog.Printf("Successfully got repository slug via gh CLI: %s", repoSlug)
 				return repoSlug, nil
 			}
 		}
 	}
 
 	// Fallback to git remote parsing if gh CLI is not available or fails
+	repoLog.Print("gh CLI failed, falling back to git remote parsing")
 	cmd = exec.Command("git", "remote", "get-url", "origin")
 	output, err = cmd.Output()
 	if err != nil {
+		repoLog.Printf("Failed to get git remote URL: %v", err)
 		return "", fmt.Errorf("failed to get current repository (gh CLI and git remote both failed): %w", err)
 	}
 
 	remoteURL := strings.TrimSpace(string(output))
+	repoLog.Printf("Parsing git remote URL: %s", remoteURL)
 
 	// Parse GitHub repository from remote URL
 	// Handle both SSH and HTTPS formats
@@ -71,9 +82,11 @@ func getCurrentRepoSlugUncached() (string, error) {
 	// Validate format (should be owner/repo)
 	parts := strings.Split(repoPath, "/")
 	if len(parts) != 2 || parts[0] == "" || parts[1] == "" {
+		repoLog.Printf("Invalid repository format: %s", repoPath)
 		return "", fmt.Errorf("invalid repository format: %s", repoPath)
 	}
 
+	repoLog.Printf("Successfully parsed repository slug from git remote: %s", repoPath)
 	return repoPath, nil
 }
 
@@ -88,5 +101,6 @@ func GetCurrentRepoSlug() (string, error) {
 		return "", currentRepoSlugError
 	}
 
+	repoLog.Printf("Using cached repository slug: %s", currentRepoSlugResult)
 	return currentRepoSlugResult, nil
 }

pkg/workflow/args.go

@@ -3,12 +3,18 @@ package workflow
 import (
 	"encoding/json"
 	"strings"
+
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var argsLog = logger.New("workflow:args")
+
 // extractCustomArgs extracts custom args from tool configuration
 // Handles both []any and []string formats
 func extractCustomArgs(toolConfig map[string]any) []string {
 	if argsValue, exists := toolConfig["args"]; exists {
+		argsLog.Print("Extracting custom args from tool configuration")
+
 		// Handle []any format
 		if argsSlice, ok := argsValue.([]any); ok {
 			customArgs := make([]string, 0, len(argsSlice))
@@ -17,10 +23,12 @@ func extractCustomArgs(toolConfig map[string]any) []string {
 					customArgs = append(customArgs, argStr)
 				}
 			}
+			argsLog.Printf("Extracted %d args from []any format", len(customArgs))
 			return customArgs
 		}
 		// Handle []string format
 		if argsSlice, ok := argsValue.([]string); ok {
+			argsLog.Printf("Extracted %d args from []string format", len(argsSlice))
 			return argsSlice
 		}
 	}
@@ -46,6 +54,8 @@ func getPlaywrightCustomArgs(playwrightTool any) []string {
 // writeArgsToYAML writes custom args to YAML with proper JSON quoting and escaping
 // indent specifies the indentation string for each argument line
 func writeArgsToYAML(yaml *strings.Builder, args []string, indent string) {
+	argsLog.Printf("Writing %d args to YAML", len(args))
+
 	for _, arg := range args {
 		yaml.WriteString(",\n")
 		// Use json.Marshal to properly quote and escape the argument

pkg/workflow/domains.go

@@ -5,8 +5,12 @@ import (
 	"encoding/json"
 	"fmt"
 	"strings"
+
+	"github.com/githubnext/gh-aw/pkg/logger"
 )
 
+var domainsLog = logger.New("workflow:domains")
+
 //go:embed data/ecosystem_domains.json
 var ecosystemDomainsJSON []byte
 
@@ -24,9 +28,13 @@ var CopilotDefaultDomains = []string{
 
 // init loads the ecosystem domains from the embedded JSON
 func init() {
+	domainsLog.Print("Loading ecosystem domains from embedded JSON")
+
 	if err := json.Unmarshal(ecosystemDomainsJSON, &ecosystemDomains); err != nil {
 		panic(fmt.Sprintf("failed to load ecosystem domains from JSON: %v", err))
 	}
+
+	domainsLog.Printf("Loaded %d ecosystem categories", len(ecosystemDomains))
 }
 
 // getEcosystemDomains returns the domains for a given ecosystem category
@@ -67,24 +75,30 @@ func getEcosystemDomains(category string) []string {
 //   - "github-actions": GitHub Actions domains
 func GetAllowedDomains(network *NetworkPermissions) []string {
 	if network == nil {
+		domainsLog.Print("No network permissions specified, using defaults")
 		return getEcosystemDomains("defaults") // Default allow-list for backwards compatibility
 	}
 	if network.Mode == "defaults" {
+		domainsLog.Print("Network mode is defaults, using default ecosystem domains")
 		return getEcosystemDomains("defaults") // Default allow-list for defaults mode
 	}
 
 	// Handle empty allowed list (deny-all case)
 	if len(network.Allowed) == 0 {
+		domainsLog.Print("Empty allowed list, denying all network access")
 		return []string{} // Return empty slice, not nil
 	}
 
+	domainsLog.Printf("Processing %d allowed domains/ecosystems", len(network.Allowed))
+
 	// Process the allowed list, expanding ecosystem identifiers if present
 	var expandedDomains []string
 	for _, domain := range network.Allowed {
 		// Try to get domains for this ecosystem category
 		ecosystemDomains := getEcosystemDomains(domain)
 		if len(ecosystemDomains) > 0 {
 			// This was an ecosystem identifier, expand it
+			domainsLog.Printf("Expanded ecosystem '%s' to %d domains", domain, len(ecosystemDomains))
 			expandedDomains = append(expandedDomains, ecosystemDomains...)
 		} else {
 			// Add the domain as-is (regular domain name)

pkg/workflow/imports.go

@@ -5,13 +5,19 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/githubnext/gh-aw/pkg/logger"
 	"github.com/githubnext/gh-aw/pkg/parser"
 )
 
+var importsLog = logger.New("workflow:imports")
+
 // MergeTools merges two tools maps, combining allowed arrays when keys coincide
 // Handles newline-separated JSON objects from multiple imports/includes
 func (c *Compiler) MergeTools(topTools map[string]any, includedToolsJSON string) (map[string]any, error) {
+	importsLog.Print("Merging tools from imports")
+
 	if includedToolsJSON == "" || includedToolsJSON == "{}" {
+		importsLog.Print("No included tools to merge")
 		return topTools, nil
 	}
 
@@ -22,6 +28,8 @@ func (c *Compiler) MergeTools(topTools map[string]any, includedToolsJSON string)
 		result = make(map[string]any)
 	}
 
+	importsLog.Printf("Processing %d tool definition lines", len(lines))
+
 	for _, line := range lines {
 		line = strings.TrimSpace(line)
 		if line == "" || line == "{}" {
@@ -47,7 +55,10 @@ func (c *Compiler) MergeTools(topTools map[string]any, includedToolsJSON string)
 // MergeMCPServers merges mcp-servers from imports with top-level mcp-servers
 // Takes object maps and merges them directly
 func (c *Compiler) MergeMCPServers(topMCPServers map[string]any, importedMCPServersJSON string) (map[string]any, error) {
+	importsLog.Print("Merging MCP servers from imports")
+
 	if importedMCPServersJSON == "" || importedMCPServersJSON == "{}" {
+		importsLog.Print("No imported MCP servers to merge")
 		return topMCPServers, nil
 	}
 
@@ -59,6 +70,7 @@ func (c *Compiler) MergeMCPServers(topMCPServers map[string]any, importedMCPServ
 
 	// Split by newlines to handle multiple JSON objects from different imports
 	lines := strings.Split(importedMCPServersJSON, "\n")
+	importsLog.Printf("Processing %d MCP server definition lines", len(lines))
 
 	for _, line := range lines {
 		line = strings.TrimSpace(line)
@@ -84,8 +96,11 @@ func (c *Compiler) MergeMCPServers(topMCPServers map[string]any, importedMCPServ
 // MergeNetworkPermissions merges network permissions from imports with top-level network permissions
 // Combines allowed domains from both sources into a single list
 func (c *Compiler) MergeNetworkPermissions(topNetwork *NetworkPermissions, importedNetworkJSON string) (*NetworkPermissions, error) {
+	importsLog.Print("Merging network permissions from imports")
+
 	// If no imported network config, return top-level network as-is
 	if importedNetworkJSON == "" || importedNetworkJSON == "{}" {
+		importsLog.Print("No imported network permissions to merge")
 		return topNetwork, nil
 	}
 
@@ -95,6 +110,7 @@ func (c *Compiler) MergeNetworkPermissions(topNetwork *NetworkPermissions, impor
 		result.Mode = topNetwork.Mode
 		result.Allowed = make([]string, len(topNetwork.Allowed))
 		copy(result.Allowed, topNetwork.Allowed)
+		importsLog.Printf("Starting with %d top-level allowed domains", len(topNetwork.Allowed))
 	}
 
 	// Track domains to avoid duplicates
@@ -105,6 +121,7 @@ func (c *Compiler) MergeNetworkPermissions(topNetwork *NetworkPermissions, impor
 
 	// Split by newlines to handle multiple JSON objects from different imports
 	lines := strings.Split(importedNetworkJSON, "\n")
+	importsLog.Printf("Processing %d network permission lines", len(lines))
 
 	for _, line := range lines {
 		line = strings.TrimSpace(line)

pkg/workflow/yaml.go

@@ -4,14 +4,19 @@ import (
 	"regexp"
 	"sort"
 
+	"github.com/githubnext/gh-aw/pkg/logger"
 	"github.com/goccy/go-yaml"
 )
 
+var yamlLog = logger.New("workflow:yaml")
+
 // UnquoteYAMLKey removes quotes from a YAML key at the start of a line.
 // This is necessary because yaml.Marshal adds quotes around reserved words like "on".
 // The function only replaces the quoted key if it appears at the start of a line
 // (optionally preceded by whitespace) to avoid replacing quoted strings in values.
 func UnquoteYAMLKey(yamlStr string, key string) string {
+	yamlLog.Printf("Unquoting YAML key: %s", key)
+
 	// Create a regex pattern that matches the quoted key at the start of a line
 	// Pattern: (start of line or newline) + (optional whitespace) + quoted key + colon
 	pattern := `(^|\n)([ \t]*)"` + regexp.QuoteMeta(key) + `":`
@@ -36,6 +41,8 @@ func UnquoteYAMLKey(yamlStr string, key string) string {
 // Priority fields are emitted first in the order specified, then remaining fields alphabetically.
 // This is used to ensure GitHub Actions workflow fields appear in a conventional order.
 func MarshalWithFieldOrder(data map[string]any, priorityFields []string) ([]byte, error) {
+	yamlLog.Printf("Marshaling YAML with field order: %d priority fields", len(priorityFields))
+
 	orderedData := OrderMapFields(data, priorityFields)
 	// Marshal the ordered data with proper options for GitHub Actions
 	return yaml.MarshalWithOptions(orderedData,