[file-diet] Refactor add_interactive.go into focused modules (1025 lines)

[agentic-workflows-dev]

Overview

The file pkg/cli/add_interactive.go has grown to 1025 lines, making it difficult to maintain and test. This task involves refactoring it into smaller, focused files with improved test coverage.

Current State

• File: pkg/cli/add_interactive.go
• Size: 1025 lines
• Test Coverage: No test file found
• Complexity: Multiple distinct functional domains with 23 functions handling Git operations, GitHub API interactions, user prompts, and workflow orchestration

Full File Analysis

Detailed Breakdown

The file contains 23 functions organized into these functional areas:

1. Repository & Authentication Checks (5 functions, ~170 lines)

• checkGHAuthStatus() - Verify GitHub CLI authentication
• checkGitRepository() - Verify git repo and get org/repo info
• checkRepoVisibility() - Check if repo is public/private
• checkActionsEnabled() - Verify GitHub Actions enabled
• checkUserPermissions() - Check user has write access

2. Secret Management (2 functions, ~80 lines)

• checkExistingSecrets() - Fetch existing repository secrets
• addRepositorySecret() - Add a new repository secret

3. AI Engine Selection & API Key Collection (4 functions, ~240 lines)

• selectAIEngineAndKey() - Prompt user to select engine and provide key (110 lines)
• collectAPIKey() - Collect API key for selected engine
• collectCopilotPAT() - Special handling for Copilot PAT creation (60 lines)
• collectGenericAPIKey() - Generic API key collection (60 lines)

4. Workflow Resolution & Display (3 functions, ~50 lines)

• resolveWorkflows() - Resolve workflow specifications early
• showWorkflowDescriptions() - Display workflow descriptions
• determineFilesToAdd() - Determine which files will be added

5. Change Application & Git Operations (4 functions, ~120 lines)

• getSecretInfo() - Get secret name and value for engine
• confirmChanges() - Ask user to confirm changes
• applyChanges() - Create PR, merge it, and add secret (70 lines)
• updateLocalBranch() - Update local branch after merge (40 lines)

6. Workflow Execution & Status (4 functions, ~160 lines)

• checkStatusAndOfferRun() - Check workflow status and offer to run (135 lines)
• getWorkflowStatuses() - Helper to get workflow statuses (45 lines)
• mergePullRequest() - Merge a pull request (10 lines)
• showFinalInstructions() - Display final instructions (20 lines)

7. Main Orchestration (1 function, ~95 lines)

• RunAddInteractive() - Main entry point that coordinates all steps

Complexity Hotspots

• selectAIEngineAndKey() (lines 372-478): 110 lines handling engine selection logic with multiple priority checks (workflow frontmatter, existing secrets, environment variables)
• checkStatusAndOfferRun() (lines 825-956): 135 lines managing workflow status polling, spinner UI, and conditional run triggering
• collectCopilotPAT() (lines 499-557): 60 lines with extensive GitHub PAT creation instructions
• applyChanges() (lines 701-769): 70 lines coordinating workflow addition, PR creation, and merging

Code Patterns

• Heavy use of console formatting for user-facing output
• Interactive prompts using charmbracelet/huh library
• GitHub CLI (gh) command execution via workflow.RunGH()
• State stored in AddInteractiveConfig struct passed through methods
• No test coverage for any interactive flows

Refactoring Strategy

Proposed File Splits

Based on semantic analysis, split the file into the following modules:

1. add_interactive_orchestrator.go

   • Functions: RunAddInteractive(), resolveWorkflows(), showWorkflowDescriptions(), determineFilesToAdd(), confirmChanges(), showFinalInstructions()
   • Responsibility: Main orchestration and workflow coordination
   • Estimated LOC: ~250 lines

2. add_interactive_auth.go

   • Functions: checkGHAuthStatus(), checkGitRepository(), checkRepoVisibility(), checkActionsEnabled(), checkUserPermissions()
   • Responsibility: Authentication and repository validation
   • Estimated LOC: ~200 lines

3. add_interactive_secrets.go

   • Functions: checkExistingSecrets(), addRepositorySecret(), getSecretInfo()
   • Responsibility: Secret management and GitHub Secrets API interaction
   • Estimated LOC: ~120 lines

4. add_interactive_engine.go

   • Functions: selectAIEngineAndKey(), collectAPIKey(), collectCopilotPAT(), collectGenericAPIKey()
   • Responsibility: AI engine selection and API key collection
   • Estimated LOC: ~240 lines

5. add_interactive_git.go

   • Functions: applyChanges(), updateLocalBranch(), mergePullRequest()
   • Responsibility: Git operations, PR creation, and merging
   • Estimated LOC: ~120 lines

6. add_interactive_workflow.go

   • Functions: checkStatusAndOfferRun(), getWorkflowStatuses()
   • Responsibility: Workflow status polling and execution
   • Estimated LOC: ~160 lines

Shared Configuration

Keep AddInteractiveConfig struct in add_interactive_orchestrator.go since it's the central state container used by all modules.

Test Coverage Plan

Add comprehensive tests for each new file:

1. add_interactive_orchestrator_test.go

   • Test orchestration logic with mocked dependencies
   • Test workflow resolution and file determination
   • Target coverage: >80%

2. add_interactive_auth_test.go

   • Test auth status checks with mock gh commands
   • Test repository validation logic
   • Test public/private repo detection
   • Target coverage: >80%

3. add_interactive_secrets_test.go

   • Test secret existence checking
   • Test secret name/value extraction
   • Mock GitHub Secrets API responses
   • Target coverage: >80%

4. add_interactive_engine_test.go

   • Test engine selection priority logic (frontmatter > secrets > env)
   • Test API key validation
   • Test Copilot PAT instructions
   • Target coverage: >80%

5. add_interactive_git_test.go

   • Test PR creation and merging logic
   • Test local branch update logic
   • Mock git and gh CLI commands
   • Target coverage: >80%

6. add_interactive_workflow_test.go

   • Test workflow status polling with retries
   • Test workflow dispatch triggering
   • Mock workflow status API responses
   • Target coverage: >80%

Testing Strategy

Since this code is heavily interactive (uses charmbracelet/huh forms), tests should:

• Mock external dependencies (gh CLI, git commands)
• Test business logic separately from UI interactions
• Use table-driven tests for validation logic
• Consider extracting testable functions from interactive prompts

Implementation Guidelines

1. Preserve Behavior: Ensure all existing functionality works identically
2. Maintain Exports: Keep public API unchanged (only RunAddInteractive() is exported)
3. Add Tests First: Write tests for extracted logic before refactoring
4. Incremental Changes: Split one module at a time
5. Run Tests Frequently: Verify make test-unit passes after each split
6. Update Imports: Ensure all import paths are correct
7. Document Changes: Add comments explaining module boundaries
8. Console Formatting: Maintain existing console.Format* patterns

Acceptance Criteria

• Original file is split into 6 focused files
• Each new file is under 300 lines
• All existing functionality preserved (no behavior changes)
• Test coverage ≥80% for testable logic (excluding interactive UI)
• No breaking changes to public API (RunAddInteractive signature unchanged)
• Code passes linting (make lint)
• Build succeeds (make build)
• AddInteractiveConfig struct remains in orchestrator file

Additional Context

• Repository Guidelines: Follow patterns in AGENTS.md
• Code Organization: Prefer many small files grouped by functionality
• Testing: Match existing test patterns in pkg/cli/*_test.go
• Console Output: Use fmt.Fprintln(os.Stderr, console.Format*Message(...)) for all user output
• Debug Logging: Use addInteractiveLog.Printf() for debug output
• Interactive Forms: Use charmbracelet/huh library consistently

---

Priority: Medium
Effort: Large (due to size and lack of existing tests)
Expected Impact: Improved maintainability, easier testing, reduced complexity, better separation of concerns

AI generated by Daily File Diet

[github-actions]

🍪 Issue Monster has assigned this to Copilot!

I've identified this issue as a good candidate for automated resolution and assigned it to the Copilot agent.

The Copilot agent will analyze the issue and create a pull request with the fix.

Om nom nom! 🍪

AI generated by Issue Monster