feat: add show-history flag

cmd/chatgpt/main.go

@@ -27,6 +27,7 @@ var (
 	GitVersion      string
 	queryMode       bool
 	clearHistory    bool
+	showHistory     bool
 	showVersion     bool
 	newThread       bool
 	showConfig      bool
@@ -171,6 +172,30 @@ func run(cmd *cobra.Command, args []string) error {
 		return nil
 	}
 
+	if showHistory { // TODO integration test
+		var targetThread string
+		if len(args) > 0 {
+			targetThread = args[0]
+		} else {
+			targetThread = cfg.Thread
+		}
+
+		store, err := history.New()
+		if err != nil {
+			return err
+		}
+
+		h := history.NewHistory(store)
+
+		output, err := h.Print(targetThread)
+		if err != nil {
+			return err
+		}
+
+		fmt.Println(output)
+		return nil
+	}
+
 	if showConfig {
 		allSettings := viper.AllSettings()
 
@@ -531,8 +556,9 @@ func setCustomHelp(rootCmd *cobra.Command) {
 		printFlagWithPadding("-v, --version", "Display the version information")
 		printFlagWithPadding("-l, --list-models", "List available models")
 		printFlagWithPadding("--list-threads", "List available threads")
-		printFlagWithPadding("--clear-history", "Clear the history of the current thread")
 		printFlagWithPadding("--delete-thread", "Delete the specified thread")
+		printFlagWithPadding("--clear-history", "Clear the history of the current thread")
+		printFlagWithPadding("--show-history [thread]", "Show the human-readable conversation history")
 		printFlagWithPadding("--set-completions", "Generate autocompletion script for your current shell")
 		fmt.Println()
 
@@ -575,6 +601,7 @@ func setupFlags(rootCmd *cobra.Command) {
 	rootCmd.PersistentFlags().StringVarP(&promptFile, "prompt", "p", "", "Provide a prompt file")
 	rootCmd.PersistentFlags().BoolVarP(&listThreads, "list-threads", "", false, "List available threads")
 	rootCmd.PersistentFlags().StringVar(&threadName, "delete-thread", "", "Delete the specified thread")
+	rootCmd.PersistentFlags().BoolVar(&showHistory, "show-history", false, "Show the human-readable conversation history")
 	rootCmd.PersistentFlags().StringVar(&shell, "set-completions", "", "Generate autocompletion script for your current shell")
 }
 
@@ -608,7 +635,7 @@ func isNonConfigSetter(name string) bool {
 
 func isGeneralFlag(name string) bool {
 	switch name {
-	case "query", "interactive", "config", "version", "new-thread", "list-models", "list-threads", "clear-history", "delete-thread", "prompt", "set-completions", "help":
+	case "query", "interactive", "config", "version", "new-thread", "list-models", "list-threads", "clear-history", "delete-thread", "show-history", "prompt", "set-completions", "help":
 		return true
 	default:
 		return false

history/history.go

@@ -0,0 +1,84 @@
+package history
+
+import (
+	"fmt"
+	"github.com/kardolus/chatgpt-cli/types"
+	"strings"
+)
+
+const (
+	assistantRole = "assistant"
+	systemRole    = "system"
+	userRole      = "user"
+)
+
+type History struct {
+	store HistoryStore
+}
+
+func NewHistory(store HistoryStore) *History {
+	return &History{store: store}
+}
+
+func (h *History) Print(thread string) (string, error) {
+	var result string
+
+	messages, err := h.store.ReadThread(thread)
+	if err != nil {
+		return "", err
+	}
+
+	var (
+		lastRole            string
+		concatenatedMessage string
+	)
+
+	for _, message := range messages {
+		if message.Role == userRole && lastRole == userRole {
+			concatenatedMessage += message.Content
+		} else {
+			if lastRole == userRole && concatenatedMessage != "" {
+				result += formatMessage(types.Message{Role: userRole, Content: concatenatedMessage})
+				concatenatedMessage = ""
+			}
+
+			if message.Role == userRole {
+				concatenatedMessage = message.Content
+			} else {
+				result += formatMessage(message)
+			}
+		}
+
+		lastRole = message.Role
+	}
+
+	// Handle the case where the last message is a user message and was concatenated
+	if lastRole == userRole && concatenatedMessage != "" {
+		result += formatMessage(types.Message{Role: userRole, Content: concatenatedMessage})
+	}
+
+	// TODO update README and mention mdrender
+
+	return result, nil
+}
+
+func formatMessage(msg types.Message) string {
+	var (
+		emoji  string
+		prefix string
+	)
+
+	switch msg.Role {
+	case systemRole:
+		emoji = "💻"
+		prefix = "\n"
+	case userRole:
+		emoji = "👤"
+		prefix = "---\n"
+	case assistantRole:
+		emoji = "🤖"
+		prefix = "\n"
+	}
+
+	return fmt.Sprintf("%s**%s** %s:\n%s\n", prefix, strings.ToUpper(msg.Role), emoji, msg.Content)
+}

history/history_test.go

@@ -0,0 +1,92 @@
+package history_test
+
+import (
+	"errors"
+	"github.com/golang/mock/gomock"
+	"github.com/kardolus/chatgpt-cli/history"
+	"github.com/kardolus/chatgpt-cli/types"
+	. "github.com/onsi/gomega"
+	"github.com/sclevine/spec"
+	"github.com/sclevine/spec/report"
+	"testing"
+)
+
+//go:generate mockgen -destination=historymocks_test.go -package=history_test github.com/kardolus/chatgpt-cli/history HistoryStore
+
+var (
+	mockCtrl         *gomock.Controller
+	mockHistoryStore *MockHistoryStore
+	subject          *history.History
+)
+
+func TestUnitHistory(t *testing.T) {
+	spec.Run(t, "Testing the History", testHistory, spec.Report(report.Terminal{}))
+}
+
+func testHistory(t *testing.T, when spec.G, it spec.S) {
+	it.Before(func() {
+		RegisterTestingT(t)
+		mockCtrl = gomock.NewController(t)
+		mockHistoryStore = NewMockHistoryStore(mockCtrl)
+		subject = history.NewHistory(mockHistoryStore)
+	})
+
+	it.After(func() {
+		mockCtrl.Finish()
+	})
+
+	when("Print()", func() {
+		const threadName = "threadName"
+
+		it("throws an error when there is a problem talking to the store", func() {
+			mockHistoryStore.EXPECT().ReadThread(threadName).Return(nil, errors.New("nope")).Times(1)
+
+			_, err := subject.Print(threadName)
+			Expect(err).To(HaveOccurred())
+		})
+
+		it("concatenates multiple user messages", func() {
+			messages := []types.Message{
+				{Role: "user", Content: "first message"},
+				{Role: "user", Content: " second message"},
+				{Role: "assistant", Content: "response"},
+			}
+
+			mockHistoryStore.EXPECT().ReadThread(threadName).Return(messages, nil).Times(1)
+
+			result, err := subject.Print(threadName)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(result).To(ContainSubstring("**USER** 👤:\nfirst message second message\n"))
+			Expect(result).To(ContainSubstring("**ASSISTANT** 🤖:\nresponse\n"))
+		})
+
+		it("prints all roles correctly", func() {
+			messages := []types.Message{
+				{Role: "system", Content: "system message"},
+				{Role: "user", Content: "user message"},
+				{Role: "assistant", Content: "assistant message"},
+			}
+
+			mockHistoryStore.EXPECT().ReadThread(threadName).Return(messages, nil).Times(1)
+
+			result, err := subject.Print(threadName)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(result).To(ContainSubstring("**SYSTEM** 💻:\nsystem message\n"))
+			Expect(result).To(ContainSubstring("\n---\n**USER** 👤:\nuser message\n"))
+			Expect(result).To(ContainSubstring("**ASSISTANT** 🤖:\nassistant message\n"))
+		})
+
+		it("handles the final user message concatenation", func() {
+			messages := []types.Message{
+				{Role: "user", Content: "first message"},
+				{Role: "user", Content: " second message"},
+			}
+
+			mockHistoryStore.EXPECT().ReadThread(threadName).Return(messages, nil).Times(1)
+
+			result, err := subject.Print(threadName)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(result).To(ContainSubstring("**USER** 👤:\nfirst message second message\n"))
+		})
+	})
+}