coder/coderd/x/chatd/instruction_test.go

package chatd //nolint:testpackage // Uses internal symbols.

import (
	"context"
	"io"
	"strings"
	"testing"

	"charm.land/fantasy"
	"github.com/stretchr/testify/require"
	"go.uber.org/mock/gomock"

	"github.com/coder/coder/v2/coderd/x/chatd/chatprompt"
	"github.com/coder/coder/v2/codersdk"
	"github.com/coder/coder/v2/codersdk/workspacesdk"
	"github.com/coder/coder/v2/codersdk/workspacesdk/agentconnmock"
)

func TestSanitizeInstructionMarkdown(t *testing.T) {
	t.Parallel()

	input := "line 1\r\n<!-- hidden -->\r\nline 2\r\n"
	require.Equal(t, "line 1\n\nline 2", sanitizeInstructionMarkdown(input))
}

func TestReadHomeInstructionFileNotFound(t *testing.T) {
	t.Parallel()

	ctrl := gomock.NewController(t)
	conn := agentconnmock.NewMockAgentConn(ctrl)
	conn.EXPECT().LS(gomock.Any(), "", gomock.Any()).DoAndReturn(
		func(context.Context, string, workspacesdk.LSRequest) (workspacesdk.LSResponse, error) {
			return workspacesdk.LSResponse{}, codersdk.NewTestError(404, "POST", "/api/v0/list-directory")
		},
	)

	content, sourcePath, truncated, err := readHomeInstructionFile(context.Background(), conn)
	require.NoError(t, err)
	require.Empty(t, content)
	require.Empty(t, sourcePath)
	require.False(t, truncated)
}

func TestReadHomeInstructionFileSuccess(t *testing.T) {
	t.Parallel()

	ctrl := gomock.NewController(t)
	conn := agentconnmock.NewMockAgentConn(ctrl)

	conn.EXPECT().LS(gomock.Any(), "", gomock.Any()).DoAndReturn(
		func(context.Context, string, workspacesdk.LSRequest) (workspacesdk.LSResponse, error) {
			return workspacesdk.LSResponse{
				Contents: []workspacesdk.LSFile{{
					Name:               "AGENTS.md",
					AbsolutePathString: "/home/coder/.coder/AGENTS.md",
				}},
			}, nil
		},
	)
	conn.EXPECT().ReadFile(
		gomock.Any(),
		"/home/coder/.coder/AGENTS.md",
		int64(0),
		int64(maxInstructionFileBytes+1),
	).Return(
		io.NopCloser(strings.NewReader("base\n<!-- hidden -->\nlocal")),
		"text/markdown",
		nil,
	)

	content, sourcePath, truncated, err := readHomeInstructionFile(context.Background(), conn)
	require.NoError(t, err)
	require.Equal(t, "base\n\nlocal", content)
	require.Equal(t, "/home/coder/.coder/AGENTS.md", sourcePath)
	require.False(t, truncated)
}

func TestReadHomeInstructionFileTruncates(t *testing.T) {
	t.Parallel()

	ctrl := gomock.NewController(t)
	conn := agentconnmock.NewMockAgentConn(ctrl)
	content := strings.Repeat("a", maxInstructionFileBytes+8)

	conn.EXPECT().LS(gomock.Any(), "", gomock.Any()).Return(
		workspacesdk.LSResponse{
			Contents: []workspacesdk.LSFile{{
				Name:               "AGENTS.md",
				AbsolutePathString: "/home/coder/.coder/AGENTS.md",
			}},
		},
		nil,
	)
	conn.EXPECT().ReadFile(
		gomock.Any(),
		"/home/coder/.coder/AGENTS.md",
		int64(0),
		int64(maxInstructionFileBytes+1),
	).Return(io.NopCloser(strings.NewReader(content)), "text/markdown", nil)

	got, _, truncated, err := readHomeInstructionFile(context.Background(), conn)
	require.NoError(t, err)
	require.True(t, truncated)
	require.Len(t, got, maxInstructionFileBytes)
}

func TestReadInstructionFile(t *testing.T) {
	t.Parallel()

	t.Run("Success", func(t *testing.T) {
		t.Parallel()

		ctrl := gomock.NewController(t)
		conn := agentconnmock.NewMockAgentConn(ctrl)

		conn.EXPECT().ReadFile(
			gomock.Any(),
			"/home/coder/project/AGENTS.md",
			int64(0),
			int64(maxInstructionFileBytes+1),
		).Return(
			io.NopCloser(strings.NewReader("project rules")),
			"text/markdown",
			nil,
		)

		content, source, truncated, err := readInstructionFile(
			context.Background(), conn, "/home/coder/project/AGENTS.md",
		)
		require.NoError(t, err)
		require.Equal(t, "project rules", content)
		require.Equal(t, "/home/coder/project/AGENTS.md", source)
		require.False(t, truncated)
	})

	t.Run("NotFound", func(t *testing.T) {
		t.Parallel()

		ctrl := gomock.NewController(t)
		conn := agentconnmock.NewMockAgentConn(ctrl)

		conn.EXPECT().ReadFile(
			gomock.Any(),
			"/home/coder/project/AGENTS.md",
			int64(0),
			int64(maxInstructionFileBytes+1),
		).Return(nil, "", codersdk.NewTestError(404, "GET", "/api/v0/read-file"))

		content, source, truncated, err := readInstructionFile(
			context.Background(), conn, "/home/coder/project/AGENTS.md",
		)
		require.NoError(t, err)
		require.Empty(t, content)
		require.Empty(t, source)
		require.False(t, truncated)
	})
}

func TestInsertSystemInstructionAfterSystemMessages(t *testing.T) {
	t.Parallel()

	prompt := []fantasy.Message{
		{
			Role: fantasy.MessageRoleSystem,
			Content: []fantasy.MessagePart{
				fantasy.TextPart{Text: "base"},
			},
		},
		{
			Role: fantasy.MessageRoleUser,
			Content: []fantasy.MessagePart{
				fantasy.TextPart{Text: "hello"},
			},
		},
	}

	got := chatprompt.InsertSystem(prompt, "project rules")
	require.Len(t, got, 3)
	require.Equal(t, fantasy.MessageRoleSystem, got[0].Role)
	require.Equal(t, fantasy.MessageRoleSystem, got[1].Role)
	require.Equal(t, fantasy.MessageRoleUser, got[2].Role)

	part, ok := fantasy.AsMessagePart[fantasy.TextPart](got[1].Content[0])
	require.True(t, ok)
	require.Equal(t, "project rules", part.Text)
}

func TestFormatSystemInstructions(t *testing.T) {
	t.Parallel()

	t.Run("HomeAndPwdWithAgentContext", func(t *testing.T) {
		t.Parallel()
		got := formatSystemInstructions("linux", "/home/coder/project", []instructionFileSection{
			{content: "home rules", source: "/home/coder/.coder/AGENTS.md"},
			{content: "project rules", source: "/home/coder/project/AGENTS.md"},
		})
		require.Contains(t, got, "Operating System: linux")
		require.Contains(t, got, "Working Directory: /home/coder/project")
		require.Contains(t, got, "Source: /home/coder/.coder/AGENTS.md")
		require.Contains(t, got, "home rules")
		require.Contains(t, got, "Source: /home/coder/project/AGENTS.md")
		require.Contains(t, got, "project rules")
		require.True(t, strings.HasPrefix(got, "<workspace-context>"))
		require.True(t, strings.HasSuffix(got, "</workspace-context>"))
	})

	t.Run("OnlyPwdFile", func(t *testing.T) {
		t.Parallel()
		got := formatSystemInstructions("", "/home/coder/project", []instructionFileSection{
			{content: "project rules", source: "/home/coder/project/AGENTS.md"},
		})
		require.Contains(t, got, "project rules")
		require.Contains(t, got, "Source: /home/coder/project/AGENTS.md")
		require.NotContains(t, got, ".coder/AGENTS.md")
	})

	t.Run("OnlyAgentContext", func(t *testing.T) {
		t.Parallel()
		got := formatSystemInstructions("darwin", "/Users/dev/repo", nil)
		require.Contains(t, got, "Operating System: darwin")
		require.Contains(t, got, "Working Directory: /Users/dev/repo")
		require.NotContains(t, got, "Source:")
		require.True(t, strings.HasPrefix(got, "<workspace-context>"))
		require.True(t, strings.HasSuffix(got, "</workspace-context>"))
	})

	t.Run("OnlyHomeFile", func(t *testing.T) {
		t.Parallel()
		got := formatSystemInstructions("", "", []instructionFileSection{
			{content: "home rules", source: "~/.coder/AGENTS.md"},
		})
		require.Contains(t, got, "Source: ~/.coder/AGENTS.md")
		require.Contains(t, got, "home rules")
		require.NotContains(t, got, "Operating System:")
		require.NotContains(t, got, "Working Directory:")
	})

	t.Run("Empty", func(t *testing.T) {
		t.Parallel()
		got := formatSystemInstructions("", "", nil)
		require.Empty(t, got)
	})

	t.Run("TruncatedFile", func(t *testing.T) {
		t.Parallel()
		got := formatSystemInstructions("windows", "", []instructionFileSection{
			{content: "rules", source: "/path/AGENTS.md", truncated: true},
		})
		require.Contains(t, got, "truncated to 64KiB")
		require.Contains(t, got, "Operating System: windows")
	})

	t.Run("AgentContextBeforeFiles", func(t *testing.T) {
		t.Parallel()
		got := formatSystemInstructions("linux", "/home/project", []instructionFileSection{
			{content: "home", source: "/home/.coder/AGENTS.md"},
			{content: "pwd", source: "/home/project/AGENTS.md"},
		})
		osIdx := strings.Index(got, "Operating System:")
		dirIdx := strings.Index(got, "Working Directory:")
		homeSourceIdx := strings.Index(got, "Source: /home/.coder/AGENTS.md")
		pwdSourceIdx := strings.Index(got, "Source: /home/project/AGENTS.md")
		require.Less(t, osIdx, homeSourceIdx)
		require.Less(t, dirIdx, homeSourceIdx)
		require.Less(t, homeSourceIdx, pwdSourceIdx)
	})

	t.Run("EmptySectionsIgnored", func(t *testing.T) {
		t.Parallel()
		got := formatSystemInstructions("linux", "", []instructionFileSection{
			{content: "", source: "/empty"},
			{content: "real", source: "/real/AGENTS.md"},
		})
		require.NotContains(t, got, "Source: /empty")
		require.Contains(t, got, "Source: /real/AGENTS.md")
	})
}

func TestPwdInstructionFilePath(t *testing.T) {
	t.Parallel()
	require.Equal(t, "/home/coder/project/AGENTS.md", pwdInstructionFilePath("/home/coder/project"))
	require.Empty(t, pwdInstructionFilePath(""))
}