refactor: introduce ContextRetriever for enhanced testability

Introduce the ContextRetriever interface and concrete implementations
to facilitate better testability by abstracting context retrieval in file
and I/O reader scenarios. This change allows for more granular testing
and decoupling of context acquisition from business logic.

While this improvement brings enhanced testability and maintainability, it
also introduces an additional layer of indirection, which can slightly
impact the initial grasping of the context flow. However, this cost is
mitigated by the benefits of having a more testable and modular codebase.

Author: emilkje

.mockery.yaml

@@ -8,4 +8,6 @@ dir: "mocks"
 outpkg: "mocks"
 packages:
   github.com/intility/cwc/internal:
-  github.com/intility/cwc/pkg/templates:
+  github.com/intility/cwc/pkg/templates:
+  github.com/intility/cwc/pkg/config:
+  github.com/intility/cwc/pkg/systemcontext:

cmd/cwc.go

@@ -2,7 +2,11 @@ package cmd
 
 import (
 	"fmt"
+	"github.com/intility/cwc/pkg/config"
+	"github.com/intility/cwc/pkg/filetree"
+	"github.com/intility/cwc/pkg/systemcontext"
 	"github.com/intility/cwc/pkg/templates"
+	"github.com/intility/cwc/pkg/ui"
 	"github.com/spf13/cobra"
 	"os"
 	"path/filepath"
@@ -11,7 +15,8 @@ import (
 )
 
 const (
-	longDescription = `The 'cwc' command initiates a new chat session, 
+	warnFileSizeThreshold = 100000
+	longDescription       = `The 'cwc' command initiates a new chat session, 
 providing granular control over the inclusion and exclusion of files via regular expression patterns. 
 It allows for specification of paths to include or exclude files from the chat context.
 
@@ -60,13 +65,24 @@ func CreateRootCommand() *cobra.Command {
 		Long:  longDescription,
 		Args:  cobra.MaximumNArgs(1),
 		RunE: func(cobraCmd *cobra.Command, args []string) error {
-			deps := createDefaultDeps(args, chatOpts.TemplateName, chatOpts.TemplateVariables)
+			cfgProvider := config.NewDefaultProvider()
+			clientProvider := internal.NewOpenAIClientProvider(cfgProvider)
+			templateLocator := getTemplateLocator(cfgProvider)
+			promptResolver := internal.NewArgsOrTemplatePromptResolver(templateLocator, args, chatOpts.TemplateName)
 
 			if isPiped(os.Stdin) {
+				contextRetriever := systemcontext.NewIOReaderContextRetriever(os.Stdin)
+				smGenerator := internal.NewTemplatedSystemMessageGenerator(
+					templateLocator,
+					chatOpts.TemplateName,
+					chatOpts.TemplateVariables,
+					contextRetriever,
+				)
+
 				nic := internal.NewNonInteractiveCmd(
-					deps.clientProvider,
-					deps.promptResolver,
-					deps.systemMessageGenerator,
+					clientProvider,
+					promptResolver,
+					smGenerator,
 				)
 
 				err := nic.Run()
@@ -77,10 +93,24 @@ func CreateRootCommand() *cobra.Command {
 				return nil
 			}
 
+			contextRetriever := systemcontext.NewFileContextRetriever(
+				cfgProvider,
+				chatOpts.IncludePattern,
+				chatOpts.ExcludePattern,
+				chatOpts.Paths,
+				printContext)
+
+			smGenerator := internal.NewTemplatedSystemMessageGenerator(
+				templateLocator,
+				chatOpts.TemplateName,
+				chatOpts.TemplateVariables,
+				contextRetriever,
+			)
+
 			interactiveCmd := internal.NewInteractiveCmd(
-				deps.promptResolver,
-				deps.clientProvider,
-				deps.systemMessageGenerator,
+				promptResolver,
+				clientProvider,
+				smGenerator,
 				chatOpts,
 			)
 
@@ -103,35 +133,52 @@ func CreateRootCommand() *cobra.Command {
 	return rootCmd
 }
 
+func printContext(fileTree string, files []filetree.File) {
+	ui.PrintMessage(fileTree, ui.MessageTypeInfo)
+	for _, file := range files {
+		printLargeFileWarning(file)
+	}
+}
+
+func printLargeFileWarning(file filetree.File) {
+	if len(file.Data) > warnFileSizeThreshold {
+		largeFileMsg := fmt.Sprintf(
+			"warning: %s is very large (%d bytes) and will degrade performance.\n",
+			file.Path, len(file.Data))
+
+		ui.PrintMessage(largeFileMsg, ui.MessageTypeWarning)
+	}
+}
+
 type defaultDeps struct {
-	configProvider         internal.ConfigProvider
+	configProvider         config.ConfigProvider
 	clientProvider         internal.ClientProvider
 	templateLocator        templates.TemplateLocator
 	promptResolver         internal.PromptResolver
 	systemMessageGenerator internal.SystemMessageGenerator
 }
 
-func createDefaultDeps(args []string, templateName string, templateVars map[string]string) *defaultDeps {
-	cfgProvider := internal.NewDefaultProvider()
-	clientProvider := internal.NewOpenAIClientProvider(cfgProvider)
-	templateLocator := getTemplateLocator(cfgProvider)
-	promptResolver := internal.NewArgsOrTemplatePromptResolver(templateLocator, args, templateName)
-	systemMessageGenerator := internal.NewTemplatedSystemMessageGenerator(
-		templateLocator,
-		templateName,
-		templateVars,
-	)
-
-	return &defaultDeps{
-		configProvider:         cfgProvider,
-		clientProvider:         clientProvider,
-		templateLocator:        templateLocator,
-		promptResolver:         promptResolver,
-		systemMessageGenerator: systemMessageGenerator,
-	}
-}
-
-func getTemplateLocator(cfgProvider internal.ConfigProvider) templates.TemplateLocator {
+//func createDefaultDeps(args []string, templateName string, templateVars map[string]string) *defaultDeps {
+//	cfgProvider := internal.NewDefaultProvider()
+//	clientProvider := internal.NewOpenAIClientProvider(cfgProvider)
+//	templateLocator := getTemplateLocator(cfgProvider)
+//	promptResolver := internal.NewArgsOrTemplatePromptResolver(templateLocator, args, templateName)
+//	systemMessageGenerator := internal.NewTemplatedSystemMessageGenerator(
+//		templateLocator,
+//		templateName,
+//		templateVars,
+//	)
+//
+//	return &defaultDeps{
+//		configProvider:         cfgProvider,
+//		clientProvider:         clientProvider,
+//		templateLocator:        templateLocator,
+//		promptResolver:         promptResolver,
+//		systemMessageGenerator: systemMessageGenerator,
+//	}
+//}
+
+func getTemplateLocator(cfgProvider config.ConfigProvider) templates.TemplateLocator {
 	var locators []templates.TemplateLocator
 
 	configDir, err := cfgProvider.GetConfigDir()

internal/client.go

@@ -2,6 +2,7 @@ package internal
 
 import (
 	"fmt"
+	"github.com/intility/cwc/pkg/config"
 
 	"github.com/sashabaranov/go-openai"
 )
@@ -11,10 +12,10 @@ type ClientProvider interface {
 }
 
 type OpenAIClientProvider struct {
-	cfg ConfigProvider
+	cfg config.ConfigProvider
 }
 
-func NewOpenAIClientProvider(provider ConfigProvider) *OpenAIClientProvider {
+func NewOpenAIClientProvider(provider config.ConfigProvider) *OpenAIClientProvider {
 	return &OpenAIClientProvider{cfg: provider}
 }
 

internal/cmd.go

@@ -6,8 +6,6 @@ import (
 	"github.com/sashabaranov/go-openai"
 
 	"github.com/intility/cwc/pkg/chat"
-	"github.com/intility/cwc/pkg/filetree"
-	"github.com/intility/cwc/pkg/pathmatcher"
 	"github.com/intility/cwc/pkg/ui"
 )
 
@@ -46,18 +44,7 @@ func (c *InteractiveCmd) Run() error {
 		return fmt.Errorf("error creating openaiClient: %w", err)
 	}
 
-	files, fileTree, err := c.gatherAndPrintContext()
-	if err != nil {
-		return err
-	} else if len(files) == 0 { // No files found, terminating or confirming to proceed
-		if !askConfirmation("No files found matching the given criteria.\n", ui.MessageTypeWarning) {
-			return nil
-		}
-	}
-
-	contextStr := createContext(fileTree, files)
-
-	generatedSystemMessage, err := c.smGenerator.GenerateSystemMessage(contextStr)
+	generatedSystemMessage, err := c.smGenerator.GenerateSystemMessage()
 	if err != nil {
 		return fmt.Errorf("error creating system message: %w", err)
 	}
@@ -116,61 +103,3 @@ func (c *InteractiveCmd) printMessageChunk(chunk *chat.ConversationChunk) {
 
 	ui.PrintMessage(chunk.Content, ui.MessageTypeInfo)
 }
-
-func (c *InteractiveCmd) gatherAndPrintContext() ([]filetree.File, string, error) {
-	// gatherAndPrintContext gathers file context based on provided options and prints it out.
-	files, rootNode, err := c.gatherContext()
-	if err != nil {
-		return nil, "", err
-	}
-
-	for _, file := range files {
-		printLargeFileWarning(file)
-	}
-
-	fileTree := filetree.GenerateFileTree(rootNode, "", true)
-
-	ui.PrintMessage("The following files will be used as context:\n", ui.MessageTypeInfo)
-	ui.PrintMessage(fileTree, ui.MessageTypeInfo)
-
-	return files, fileTree, nil
-}
-
-func (c *InteractiveCmd) gatherContext() ([]filetree.File, *filetree.FileNode, error) {
-	var excludeMatchers []pathmatcher.PathMatcher
-
-	// add exclude flag to excludeMatchers
-	if c.chatOptions.ExcludePattern != "" {
-		excludeMatcher, err := pathmatcher.NewRegexPathMatcher(c.chatOptions.ExcludePattern)
-		if err != nil {
-			return nil, nil, fmt.Errorf("error creating exclude matcher: %w", err)
-		}
-
-		excludeMatchers = append(excludeMatchers, excludeMatcher)
-	}
-
-	excludeMatchersFromConfig, err := excludeMatchersFromConfig()
-	if err != nil {
-		return nil, nil, err
-	}
-
-	excludeMatchers = append(excludeMatchers, excludeMatchersFromConfig...)
-
-	excludeMatcher := pathmatcher.NewCompoundPathMatcher(excludeMatchers...)
-
-	includeMatcher, err := pathmatcher.NewRegexPathMatcher(c.chatOptions.IncludePattern)
-	if err != nil {
-		return nil, nil, fmt.Errorf("error creating include matcher: %w", err)
-	}
-
-	files, rootNode, err := filetree.GatherFiles(&filetree.FileGatherOptions{
-		IncludeMatcher: includeMatcher,
-		ExcludeMatcher: excludeMatcher,
-		PathScopes:     c.chatOptions.Paths,
-	})
-	if err != nil {
-		return nil, nil, fmt.Errorf("error gathering files: %w", err)
-	}
-
-	return files, rootNode, nil
-}

internal/interactive.go

@@ -2,9 +2,6 @@ package internal
 
 import (
 	"fmt"
-	"io"
-	"os"
-
 	"github.com/intility/cwc/pkg/chat"
 	"github.com/intility/cwc/pkg/errors"
 	"github.com/intility/cwc/pkg/ui"
@@ -34,12 +31,7 @@ func (c *NonInteractiveCmd) Run() error {
 		return fmt.Errorf("error creating openaiClient: %w", err)
 	}
 
-	systemCtx, err := c.readContextFromStdIn()
-	if err != nil {
-		return fmt.Errorf("error reading context from stdin: %w", err)
-	}
-
-	generateSystemMessage, err := c.smGenerator.GenerateSystemMessage(systemCtx)
+	generateSystemMessage, err := c.smGenerator.GenerateSystemMessage()
 	if err != nil {
 		return fmt.Errorf("error creating system message: %w", err)
 	}
@@ -58,15 +50,6 @@ func (c *NonInteractiveCmd) Run() error {
 	return nil
 }
 
-func (c *NonInteractiveCmd) readContextFromStdIn() (string, error) {
-	inputBytes, err := io.ReadAll(os.Stdin)
-	if err != nil {
-		return "", fmt.Errorf("error reading from stdin: %w", err)
-	}
-
-	return string(inputBytes), nil
-}
-
 func (c *NonInteractiveCmd) printChunk(chunk *chat.ConversationChunk) {
 	ui.PrintMessage(chunk.Content, ui.MessageTypeInfo)
 }