diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go index 3ce8e342ab0..486935a48fb 100644 --- a/coderd/apidoc/docs.go +++ b/coderd/apidoc/docs.go @@ -17938,6 +17938,10 @@ const docTemplate = `{ "file_name": { "type": "string" }, + "hook_rewritten": { + "description": "HookRewritten indicates that a lifecycle hook replaced model-proposed tool input.", + "type": "boolean" + }, "is_error": { "type": "boolean" }, diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json index 92eecc3601c..1d38140c3da 100644 --- a/coderd/apidoc/swagger.json +++ b/coderd/apidoc/swagger.json @@ -16158,6 +16158,10 @@ "file_name": { "type": "string" }, + "hook_rewritten": { + "description": "HookRewritten indicates that a lifecycle hook replaced model-proposed tool input.", + "type": "boolean" + }, "is_error": { "type": "boolean" }, diff --git a/coderd/exp_chats_hooks_test.go b/coderd/exp_chats_hooks_test.go index f1f1db93a58..f5f9cca09a8 100644 --- a/coderd/exp_chats_hooks_test.go +++ b/coderd/exp_chats_hooks_test.go @@ -309,17 +309,26 @@ func TestChatLifecycleHooksWorkedExample(t *testing.T) { messages, err := client.GetChatMessages(ctx, chat.ID, nil) require.NoError(t, err) - var allowedCall *codersdk.ChatMessagePart + var allowedCall, deniedCall *codersdk.ChatMessagePart for _, message := range messages.Messages { for i := range message.Content { part := &message.Content[i] - if part.Type == codersdk.ChatMessagePartTypeToolCall && part.ToolCallID == allowedToolCallID { + if part.Type != codersdk.ChatMessagePartTypeToolCall { + continue + } + switch part.ToolCallID { + case allowedToolCallID: allowedCall = part + case deniedToolCallID: + deniedCall = part } } } require.NotNil(t, allowedCall) require.JSONEq(t, `{"query":"public documentation"}`, string(allowedCall.Args)) + require.True(t, allowedCall.HookRewritten) + require.NotNil(t, deniedCall) + require.False(t, deniedCall.HookRewritten) err = client.SubmitToolResults(ctx, chat.ID, codersdk.SubmitToolResultsRequest{ Results: []codersdk.ToolResult{{ @@ -343,7 +352,7 @@ func TestChatLifecycleHooksWorkedExample(t *testing.T) { continue } for _, part := range message.Content { - if part.Type == codersdk.ChatMessagePartTypeText && part.Text == "Search result approved by policy." { + if part.Type == codersdk.ChatMessagePartTypeHookNotice && part.Text == "Search result approved by policy." { foundPostToolNotice = true } } @@ -410,19 +419,20 @@ func TestChatHooksFileLinksAfterPromptOverride(t *testing.T) { return resp.ID } - redactedFile := uploadFile("redacted.png") + createFile := uploadFile("create.png") chat, err := client.CreateChat(ctx, codersdk.CreateChatRequest{ OrganizationID: user.OrganizationID, ModelConfigID: &model.ID, Content: []codersdk.ChatInputPart{ {Type: codersdk.ChatInputPartTypeText, Text: "REDACTME create"}, - {Type: codersdk.ChatInputPartTypeFile, FileID: redactedFile}, + {Type: codersdk.ChatInputPartTypeFile, FileID: createFile}, }, }) require.NoError(t, err) created, err := client.GetChat(ctx, chat.ID) require.NoError(t, err) - require.Empty(t, created.Files, "overridden create must not link dropped attachments") + require.Len(t, created.Files, 1, "an overridden create must keep linking its attachments") + require.Equal(t, createFile, created.Files[0].ID) coderdtest.WaitForChatSettled(ctx, t, api, chat.ID) @@ -437,23 +447,37 @@ func TestChatHooksFileLinksAfterPromptOverride(t *testing.T) { require.False(t, sendResp.Queued) afterSend, err := client.GetChat(ctx, chat.ID) require.NoError(t, err) - require.Len(t, afterSend.Files, 1) - require.Equal(t, keptFile, afterSend.Files[0].ID) + require.Len(t, afterSend.Files, 2) + require.ElementsMatch(t, []uuid.UUID{createFile, keptFile}, []uuid.UUID{afterSend.Files[0].ID, afterSend.Files[1].ID}) coderdtest.WaitForChatSettled(ctx, t, api, chat.ID) - droppedFile := uploadFile("dropped.png") - _, err = client.CreateChatMessage(ctx, chat.ID, codersdk.CreateChatMessageRequest{ + overriddenFile := uploadFile("overridden.png") + sendResp, err = client.CreateChatMessage(ctx, chat.ID, codersdk.CreateChatMessageRequest{ Content: []codersdk.ChatInputPart{ + {Type: codersdk.ChatInputPartTypeFileReference, FileName: "main.go", StartLine: 1, EndLine: 3, Content: "package main"}, {Type: codersdk.ChatInputPartTypeText, Text: "REDACTME send"}, - {Type: codersdk.ChatInputPartTypeFile, FileID: droppedFile}, + {Type: codersdk.ChatInputPartTypeFile, FileID: overriddenFile}, }, }) require.NoError(t, err) + require.False(t, sendResp.Queued) afterOverride, err := client.GetChat(ctx, chat.ID) require.NoError(t, err) - require.Len(t, afterOverride.Files, 1, "overridden send must not link dropped attachments") - require.Equal(t, keptFile, afterOverride.Files[0].ID) + require.Len(t, afterOverride.Files, 3, "an overridden send must keep linking its attachments") + require.ElementsMatch(t, []uuid.UUID{createFile, keptFile, overriddenFile}, []uuid.UUID{ + afterOverride.Files[0].ID, + afterOverride.Files[1].ID, + afterOverride.Files[2].ID, + }) + + require.NotNil(t, sendResp.Message) + require.Equal(t, codersdk.ChatMessageRoleUser, sendResp.Message.Role) + require.Equal(t, []codersdk.ChatMessagePart{ + codersdk.ChatMessageFileReference("main.go", 1, 3, "package main"), + codersdk.ChatMessageText("redacted"), + codersdk.ChatMessageFile(overriddenFile, "image/png", "overridden.png"), + }, sendResp.Message.Content) } func TestChatHookNoticeMessagesInResponses(t *testing.T) { @@ -576,7 +600,7 @@ func TestChatHookNoticeMessagesInResponses(t *testing.T) { continue } for _, part := range message.Content { - if part.Type == codersdk.ChatMessagePartTypeText && part.Text == "session notice" { + if part.Type == codersdk.ChatMessagePartTypeHookNotice && part.Text == "session notice" { sessionNoticeFound = true } } diff --git a/coderd/x/chatd/chathooks/effects.go b/coderd/x/chatd/chathooks/effects.go index e0f82eb26b2..7b70b75a2e3 100644 --- a/coderd/x/chatd/chathooks/effects.go +++ b/coderd/x/chatd/chathooks/effects.go @@ -36,7 +36,10 @@ func EventMessages(result *Result, modelConfigID uuid.UUID) ([]chatstate.Message }) } if result.GetUserMessage() != "" { - content, err := chatprompt.MarshalParts([]codersdk.ChatMessagePart{codersdk.ChatMessageText(result.UserMessage)}) + content, err := chatprompt.MarshalParts([]codersdk.ChatMessagePart{{ + Type: codersdk.ChatMessagePartTypeHookNotice, + Text: result.UserMessage, + }}) if err != nil { return nil, xerrors.Errorf("marshal hook user message: %w", err) } @@ -156,6 +159,25 @@ func UserPromptParts(result *Result) []codersdk.ChatMessagePart { return parts } +func applyPromptOverride(parts []codersdk.ChatMessagePart, override string) []codersdk.ChatMessagePart { + userParts := make([]codersdk.ChatMessagePart, 0, len(parts)+1) + replaced := false + for _, part := range parts { + if part.Type != codersdk.ChatMessagePartTypeText { + userParts = append(userParts, part) + continue + } + if !replaced { + userParts = append(userParts, codersdk.ChatMessageText(override)) + replaced = true + } + } + if !replaced { + userParts = append(userParts, codersdk.ChatMessageText(override)) + } + return userParts +} + // ComposeUserPromptContent applies a user_prompt_submit result to the // submitted parts. The merge order is fixed: override-or-original user // parts first, then hook-context, then hook-notice. The composite @@ -167,7 +189,7 @@ func ComposeUserPromptContent(parts []codersdk.ChatMessagePart, result *Result) } userParts := parts if overridden { - userParts = []codersdk.ChatMessagePart{codersdk.ChatMessageText(override)} + userParts = applyPromptOverride(parts, override) } hookParts := UserPromptParts(result) if len(hookParts) == 0 { diff --git a/coderd/x/chatd/chathooks/hooks_internal_test.go b/coderd/x/chatd/chathooks/hooks_internal_test.go index eae7a640327..58a8dab9ad0 100644 --- a/coderd/x/chatd/chathooks/hooks_internal_test.go +++ b/coderd/x/chatd/chathooks/hooks_internal_test.go @@ -18,6 +18,7 @@ import ( "github.com/coder/coder/v2/coderd/database/dbgen" "github.com/coder/coder/v2/coderd/database/dbtestutil" "github.com/coder/coder/v2/coderd/x/agenthooks/dispatch" + "github.com/coder/coder/v2/codersdk" "github.com/coder/coder/v2/codersdk/x/agenthooks" "github.com/coder/coder/v2/testutil" ) @@ -273,3 +274,64 @@ func TestEventMessagesSkipsBlankModelContext(t *testing.T) { require.Len(t, messages, 1) require.Equal(t, database.ChatMessageVisibilityModel, messages[0].Visibility) } + +func TestComposeUserPromptContentOverride(t *testing.T) { + t.Parallel() + + text := codersdk.ChatMessageText("original") + reference := codersdk.ChatMessageFileReference("main.go", 1, 3, "package main") + upload := codersdk.ChatMessageFile(uuid.New(), "image/png", "shot.png") + override := &Result{InputOverride: json.RawMessage(`{"prompt":"replacement"}`)} + + t.Run("ReplacesTextInPlaceAndKeepsAttachments", func(t *testing.T) { + t.Parallel() + + parts, overridden, err := ComposeUserPromptContent([]codersdk.ChatMessagePart{reference, text, upload}, override) + require.NoError(t, err) + require.True(t, overridden) + require.Equal(t, []codersdk.ChatMessagePart{ + reference, + codersdk.ChatMessageText("replacement"), + upload, + }, parts) + }) + + t.Run("CollapsesEveryTextPart", func(t *testing.T) { + t.Parallel() + + parts, overridden, err := ComposeUserPromptContent([]codersdk.ChatMessagePart{ + text, + upload, + codersdk.ChatMessageText("trailing"), + }, override) + require.NoError(t, err) + require.True(t, overridden) + require.Equal(t, []codersdk.ChatMessagePart{ + codersdk.ChatMessageText("replacement"), + upload, + }, parts) + }) + + t.Run("AppendsWhenSubmissionHasNoText", func(t *testing.T) { + t.Parallel() + + parts, overridden, err := ComposeUserPromptContent([]codersdk.ChatMessagePart{upload}, override) + require.NoError(t, err) + require.True(t, overridden) + require.Equal(t, []codersdk.ChatMessagePart{upload, codersdk.ChatMessageText("replacement")}, parts) + }) + + t.Run("KeepsSubmittedPartsWithoutOverride", func(t *testing.T) { + t.Parallel() + + submitted := []codersdk.ChatMessagePart{text, upload} + parts, overridden, err := ComposeUserPromptContent(submitted, &Result{UserMessage: "notice"}) + require.NoError(t, err) + require.False(t, overridden) + require.Equal(t, []codersdk.ChatMessagePart{ + text, + upload, + {Type: codersdk.ChatMessagePartTypeHookNotice, Text: "notice"}, + }, parts) + }) +} diff --git a/coderd/x/chatd/generation.go b/coderd/x/chatd/generation.go index 7e87da9a236..8a440187a03 100644 --- a/coderd/x/chatd/generation.go +++ b/coderd/x/chatd/generation.go @@ -748,12 +748,13 @@ func (s *taskStarter) generateAssistant( } outcome.Step.Content = chathooks.ApplyAdmittedToolCalls(outcome.Step.Content, preflight) messages, err := buildCommitStepMessages(buildCommitStepMessagesInput{ - modelConfigID: prepared.ModelConfigID, - modelCallConfig: prepared.ModelConfig, - step: stepDataFromPersisted(outcome.Step), - toolNameToConfigID: prepared.ToolNameToConfigID, - logger: s.opts.Logger, - contentVersion: chatprompt.CurrentContentVersion, + modelConfigID: prepared.ModelConfigID, + modelCallConfig: prepared.ModelConfig, + step: stepDataFromPersisted(outcome.Step), + toolNameToConfigID: prepared.ToolNameToConfigID, + logger: s.opts.Logger, + contentVersion: chatprompt.CurrentContentVersion, + hookRewrittenToolCalls: preflight.Overrides, }) if err != nil { return s.finishGenerationError(ctx, machine, input, err, requireGenerationAttempt(attempt.number)) diff --git a/coderd/x/chatd/hooks_test.go b/coderd/x/chatd/hooks_test.go index ee445e56022..af43976da2d 100644 --- a/coderd/x/chatd/hooks_test.go +++ b/coderd/x/chatd/hooks_test.go @@ -74,6 +74,7 @@ func TestSendMessageUserPromptSubmitHook(t *testing.T) { require.NoError(t, err) require.Equal(t, []codersdk.ChatMessagePart{ codersdk.ChatMessageText("after"), + codersdk.ChatMessageFileReference("main.go", 1, 3, "package main"), {Type: codersdk.ChatMessagePartTypeHookContext, Text: "model only"}, {Type: codersdk.ChatMessagePartTypeHookNotice, Text: "user only"}, }, parts) @@ -475,17 +476,25 @@ func TestEditMessageUserPromptSubmitHook(t *testing.T) { t.Cleanup(consumer.Close) server := newHookTestServer(t, db, ps, consumer) + upload := codersdk.ChatMessageFile(uuid.New(), "image/png", "edited.png") + reference := codersdk.ChatMessageFileReference("main.go", 1, 3, "package main") result, err := server.EditMessage(ctx, chatd.EditMessageOptions{ ChatID: chat.ID, CreatedBy: user.ID, EditedMessageID: inserted[0].ID, - Content: []codersdk.ChatMessagePart{codersdk.ChatMessageText("edited original")}, + Content: []codersdk.ChatMessagePart{ + reference, + codersdk.ChatMessageText("edited original"), + upload, + }, }) require.NoError(t, err) parts, err := chatprompt.ParseContent(result.Message) require.NoError(t, err) require.Equal(t, []codersdk.ChatMessagePart{ + reference, codersdk.ChatMessageText("edited override"), + upload, {Type: codersdk.ChatMessagePartTypeHookContext, Text: "edit context"}, {Type: codersdk.ChatMessagePartTypeHookNotice, Text: "edit notice"}, }, parts) diff --git a/coderd/x/chatd/message_conversion.go b/coderd/x/chatd/message_conversion.go index 82fcc8c2029..d03ae1462fe 100644 --- a/coderd/x/chatd/message_conversion.go +++ b/coderd/x/chatd/message_conversion.go @@ -28,12 +28,13 @@ import ( const interruptedToolResultErrorMessage = "tool call was interrupted before it produced a result" type buildCommitStepMessagesInput struct { - modelConfigID uuid.UUID - modelCallConfig codersdk.ChatModelCallConfig - step stepData - toolNameToConfigID map[string]uuid.UUID - logger slog.Logger - contentVersion int16 + modelConfigID uuid.UUID + modelCallConfig codersdk.ChatModelCallConfig + step stepData + toolNameToConfigID map[string]uuid.UUID + logger slog.Logger + contentVersion int16 + hookRewrittenToolCalls map[string]json.RawMessage } type stepMessagesForCommit struct { @@ -51,7 +52,7 @@ func buildCommitStepMessages(input buildCommitStepMessagesInput) (stepMessagesFo } assistantBlocks, toolResults := splitStepContent(input.step.Content) - assistantParts := buildAssistantParts(input.logger, assistantBlocks, toolResults, input.step, input.toolNameToConfigID) + assistantParts := buildAssistantParts(input.logger, assistantBlocks, toolResults, input.step, input.toolNameToConfigID, input.hookRewrittenToolCalls) messages := make([]chatstate.Message, 0, 1+len(toolResults)) if len(assistantParts) > 0 { @@ -112,6 +113,7 @@ func buildAssistantParts( toolResults []fantasy.ToolResultContent, step stepData, toolNameToConfigID map[string]uuid.UUID, + hookRewrittenToolCalls map[string]json.RawMessage, ) []codersdk.ChatMessagePart { parts := make([]codersdk.ChatMessagePart, 0, len(assistantBlocks)+len(toolResults)) reasoningIdx := 0 @@ -125,6 +127,11 @@ func buildAssistantParts( part.CreatedAt = &ts } } + // Hooks never see provider-executed calls, so such a call must not + // inherit attribution from an ordinary call that reused its ID. + if part.ToolCallID != "" && !part.ProviderExecuted { + _, part.HookRewritten = hookRewrittenToolCalls[part.ToolCallID] + } case codersdk.ChatMessagePartTypeToolResult: if part.ToolCallID != "" && step.ToolResultCreatedAt != nil { if ts, ok := step.ToolResultCreatedAt[part.ToolCallID]; ok { diff --git a/coderd/x/chatd/message_conversion_test.go b/coderd/x/chatd/message_conversion_test.go index 40eb2fa291d..f49f1fa2138 100644 --- a/coderd/x/chatd/message_conversion_test.go +++ b/coderd/x/chatd/message_conversion_test.go @@ -832,3 +832,72 @@ func (s *partialConversionLogSink) entriesAtLevelWithMessage(level slog.Level, m } return entries } + +func TestBuildCommitStepMessages_MarksHookRewrittenToolCalls(t *testing.T) { + t.Parallel() + + got, err := buildCommitStepMessages(buildCommitStepMessagesInput{ + modelConfigID: uuid.New(), + contentVersion: chatprompt.CurrentContentVersion, + logger: slog.Make(), + step: stepData{ + Content: []fantasy.Content{ + fantasy.ToolCallContent{ + ToolCallID: "rewritten", + ToolName: "execute", + Input: `{"command":"echo admitted"}`, + }, + fantasy.ToolCallContent{ + ToolCallID: "untouched", + ToolName: "execute", + Input: `{"command":"echo original"}`, + }, + }, + }, + hookRewrittenToolCalls: map[string]json.RawMessage{"rewritten": {}}, + }) + require.NoError(t, err) + require.Len(t, got.Messages, 1) + + parts := parseMessageParts(t, got.Messages[0].Role, got.Messages[0].Content) + require.Len(t, parts, 2) + require.Equal(t, "rewritten", parts[0].ToolCallID) + require.True(t, parts[0].HookRewritten) + require.Equal(t, "untouched", parts[1].ToolCallID) + require.False(t, parts[1].HookRewritten) +} + +func TestBuildCommitStepMessages_SkipsProviderExecutedRewriteAttribution(t *testing.T) { + t.Parallel() + + got, err := buildCommitStepMessages(buildCommitStepMessagesInput{ + modelConfigID: uuid.New(), + contentVersion: chatprompt.CurrentContentVersion, + logger: slog.Make(), + step: stepData{ + Content: []fantasy.Content{ + fantasy.ToolCallContent{ + ToolCallID: "shared", + ToolName: "web_search", + Input: `{"query":"coder"}`, + ProviderExecuted: true, + }, + fantasy.ToolCallContent{ + ToolCallID: "shared", + ToolName: "execute", + Input: `{"command":"echo admitted"}`, + }, + }, + }, + hookRewrittenToolCalls: map[string]json.RawMessage{"shared": {}}, + }) + require.NoError(t, err) + require.Len(t, got.Messages, 1) + + parts := parseMessageParts(t, got.Messages[0].Role, got.Messages[0].Content) + require.Len(t, parts, 2) + require.True(t, parts[0].ProviderExecuted) + require.False(t, parts[0].HookRewritten) + require.False(t, parts[1].ProviderExecuted) + require.True(t, parts[1].HookRewritten) +} diff --git a/codersdk/chats.go b/codersdk/chats.go index 7c47bead863..b44bed51c81 100644 --- a/codersdk/chats.go +++ b/codersdk/chats.go @@ -295,9 +295,9 @@ const ( // and stripped from every client-facing conversion; the server rejects // it in client-submitted content. ChatMessagePartTypeHookContext ChatMessagePartType = "hook-context" - // ChatMessagePartTypeHookNotice is a user-facing notice attached to a - // user prompt by a lifecycle hook. It is excluded from model prompt - // assembly; the server rejects it in client-submitted content. + // ChatMessagePartTypeHookNotice is a user-facing lifecycle hook notice, + // either attached to a prompt or in its own row. It is excluded from model + // prompts and rejected in client-submitted content. ChatMessagePartTypeHookNotice ChatMessagePartType = "hook-notice" ) @@ -380,6 +380,8 @@ type ChatMessagePart struct { // ProviderExecuted indicates the tool call was executed by // the provider (e.g. Anthropic computer use). ProviderExecuted bool `json:"provider_executed,omitempty" variants:"tool-call?,tool-result?"` + // HookRewritten indicates that a lifecycle hook replaced model-proposed tool input. + HookRewritten bool `json:"hook_rewritten,omitempty" variants:"tool-call?"` // CreatedAt is the timestamp this part carries. The semantics // depend on the part type: for tool-call and tool-result parts // it is the time the call was emitted or the result was diff --git a/docs/admin/setup/chat-lifecycle-hooks.md b/docs/admin/setup/chat-lifecycle-hooks.md index 1487cf7f56f..e33cea7991e 100644 --- a/docs/admin/setup/chat-lifecycle-hooks.md +++ b/docs/admin/setup/chat-lifecycle-hooks.md @@ -121,10 +121,13 @@ Permission rules depend on the event: - For `user_prompt_submit`, `allow` requires `input_override` in the exact form `{"prompt":"replacement text"}`. Coder stores and sends the replacement prompt instead of the original prompt. + The override replaces only submitted text, matching the concatenated `prompt` field the consumer receives. + Attachments and file references remain in `parts`, so consumers that must block them should inspect `parts` and return `deny`. - For `pre_tool_use`, `allow` requires `input_override` containing the replacement tool input. Coder persists the replacement with the tool call and executes the tool with it. An override for a built-in tool must not repeat a key or vary the capitalization of a schema property; an ambiguous override fails the dispatch closed because the model can't correct it. - Nothing marks the call as rewritten in the chat, so the model may misattribute the changed behavior; a consumer that rewrites input should also return `user_message` explaining the change. + The stored call is marked as rewritten, and the chat shows a "Modified by policy" badge. + The marker is client-facing, so return `model_context` if the model also needs an explanation of the rewrite. - For either event, `deny` blocks the input and must not include `input_override`. A denied prompt isn't persisted: Coder rejects the submission and surfaces any returned `user_message` in the rejection, ignoring `model_context`. A denied tool call becomes a synthetic error result, and any returned `model_context` reaches the model separately, so the model can choose another action. diff --git a/docs/reference/api/chats.md b/docs/reference/api/chats.md index aa836872bb4..f84bf3d49a3 100644 --- a/docs/reference/api/chats.md +++ b/docs/reference/api/chats.md @@ -1674,6 +1674,7 @@ Experimental: this endpoint is subject to change. "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -1756,6 +1757,7 @@ Experimental: this endpoint is subject to change. "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -1891,6 +1893,7 @@ Experimental: this endpoint is subject to change. "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -1972,6 +1975,7 @@ Experimental: this endpoint is subject to change. "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -2054,6 +2058,7 @@ Experimental: this endpoint is subject to change. "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -2190,6 +2195,7 @@ Experimental: this endpoint is subject to change. "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -2271,6 +2277,7 @@ Experimental: this endpoint is subject to change. "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -2695,6 +2702,7 @@ Experimental: this endpoint is subject to change. "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -2775,6 +2783,7 @@ Experimental: this endpoint is subject to change. "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -2843,6 +2852,7 @@ Experimental: this endpoint is subject to change. "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md index e1d7560090e..9de2d6a3bee 100644 --- a/docs/reference/api/schemas.md +++ b/docs/reference/api/schemas.md @@ -2869,6 +2869,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -2964,6 +2965,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -3020,6 +3022,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in | `end_line` | integer | false | | | | `file_id` | [uuid.NullUUID](#uuidnulluuid) | false | | | | `file_name` | string | false | | | +| `hook_rewritten` | boolean | false | | Hook rewritten indicates that a lifecycle hook replaced model-proposed tool input. | | `is_error` | boolean | false | | | | `is_media` | boolean | false | | | | `mcp_server_config_id` | [uuid.NullUUID](#uuidnulluuid) | false | | | @@ -3133,6 +3136,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -3215,6 +3219,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -3444,6 +3449,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -3609,6 +3615,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -3689,6 +3696,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -3757,6 +3765,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -3874,6 +3883,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -4575,6 +4585,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -4656,6 +4667,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -4738,6 +4750,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -7274,6 +7287,7 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { @@ -7355,6 +7369,7 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o "valid": true }, "file_name": "string", + "hook_rewritten": true, "is_error": true, "is_media": true, "mcp_server_config_id": { diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts index d6f7e516f40..cbae3b6d914 100644 --- a/site/src/api/typesGenerated.ts +++ b/site/src/api/typesGenerated.ts @@ -3556,6 +3556,10 @@ export interface ChatToolCallPart { * the provider (e.g. Anthropic computer use). */ readonly provider_executed?: boolean; + /** + * HookRewritten indicates that a lifecycle hook replaced model-proposed tool input. + */ + readonly hook_rewritten?: boolean; /** * CreatedAt is the timestamp this part carries. The semantics * depend on the part type: for tool-call and tool-result parts diff --git a/site/src/pages/AgentsPage/components/ChatConversation/ConversationTimeline.stories.tsx b/site/src/pages/AgentsPage/components/ChatConversation/ConversationTimeline.stories.tsx index 2e120d34a57..a08c233e5d3 100644 --- a/site/src/pages/AgentsPage/components/ChatConversation/ConversationTimeline.stories.tsx +++ b/site/src/pages/AgentsPage/components/ChatConversation/ConversationTimeline.stories.tsx @@ -244,6 +244,7 @@ const buildParsedReadFileEntry = ({ content = "", errorMessage, isError = status === "error", + hookRewritten = false, }: { messageId: number; toolId: string; @@ -252,6 +253,7 @@ const buildParsedReadFileEntry = ({ content?: string; errorMessage?: string; isError?: boolean; + hookRewritten?: boolean; }): ParsedMessageEntry => { const args = { path }; const result = @@ -289,6 +291,7 @@ const buildParsedReadFileEntry = ({ result, isError, status, + hookRewritten, }, ], blocks: [{ type: "tool", id: toolId }], @@ -415,7 +418,7 @@ export const LifecycleHookNotice: Story = { role: "system", content: [ { - type: "text", + type: "hook-notice", text: "Your organization requires an approval before deployment.", }, ], @@ -438,6 +441,30 @@ export const LifecycleHookNotice: Story = { }, }; +export const SystemMessageWithoutHookNotice: Story = { + args: { + ...defaultArgs, + parsedMessages: buildMessages([ + { + ...baseMessage, + id: 1, + role: "system", + content: [{ type: "text", text: "Maintenance starts in ten minutes." }], + }, + ]), + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + const notice = canvas.getByRole("note"); + expect( + within(notice).getByText("Maintenance starts in ten minutes."), + ).toBeVisible(); + expect( + within(notice).queryByText("Lifecycle hook"), + ).not.toBeInTheDocument(); + }, +}; + export const LifecycleHookNoticeOnUserMessage: Story = { args: { ...defaultArgs, @@ -2596,6 +2623,89 @@ export const SequentialReadFilesCollapsed: Story = { }, }; +export const ReadFileRewrittenByHook: Story = { + args: { + ...defaultArgs, + parsedMessages: [ + buildParsedReadFileEntry({ + messageId: 1, + toolId: "read-rewritten-1", + path: "site/src/redacted.ts", + status: "completed", + content: "export const redacted = true;\n", + hookRewritten: true, + }), + ], + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + expect(await canvas.findByText("Modified by policy")).toBeVisible(); + }, +}; + +export const GroupedReadFilesRewrittenByHook: Story = { + args: { + ...defaultArgs, + parsedMessages: [ + buildParsedReadFileEntry({ + messageId: 1, + toolId: "read-grouped-1", + path: "site/src/a.ts", + status: "completed", + content: "export const a = 1;\n", + }), + buildParsedReadFileEntry({ + messageId: 2, + toolId: "read-grouped-2", + path: "site/src/b.ts", + status: "completed", + content: "export const b = 2;\n", + hookRewritten: true, + }), + ], + }, + play: async ({ canvasElement, step }) => { + const canvas = within(canvasElement); + await step("group header shows the aggregate badge", async () => { + expect(await canvas.findByText("Modified by policy")).toBeVisible(); + }); + await step("expanded rows credit only the rewritten file", async () => { + await userEvent.click( + await canvas.findByRole("button", { name: /Read 2 files/ }), + ); + expect( + await canvas.findByRole("button", { name: /Read b\.ts/ }), + ).toBeVisible(); + const attributed = canvas + .getAllByRole("group", { name: "Modified by policy" }) + .map((group) => group.textContent ?? ""); + expect(attributed.some((text) => text.includes("b.ts"))).toBe(true); + expect(attributed.some((text) => text.includes("a.ts"))).toBe(false); + expect(canvas.getAllByText("Modified by policy")).toHaveLength(2); + }); + }, +}; + +export const ReadFileNotRewrittenByHook: Story = { + args: { + ...defaultArgs, + parsedMessages: [ + buildParsedReadFileEntry({ + messageId: 1, + toolId: "read-plain-1", + path: "site/src/plain.ts", + status: "completed", + content: "export const plain = true;\n", + }), + ], + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + expect(await canvas.findByText(/plain\.ts/)).toBeVisible(); + expect(canvas.queryByText("Modified by policy")).not.toBeInTheDocument(); + }, +}; + export const SequentialReadFilesEmptyAndErrorStates: Story = { args: { ...defaultArgs, diff --git a/site/src/pages/AgentsPage/components/ChatConversation/ConversationTimeline.tsx b/site/src/pages/AgentsPage/components/ChatConversation/ConversationTimeline.tsx index 6a84edcc895..20bdf50b355 100644 --- a/site/src/pages/AgentsPage/components/ChatConversation/ConversationTimeline.tsx +++ b/site/src/pages/AgentsPage/components/ChatConversation/ConversationTimeline.tsx @@ -222,18 +222,19 @@ const ReadFileTimelineBlock = memo<{ }>(({ tools }) => { const [expanded, setExpanded] = useState(false); const [firstTool] = tools; - if (tools.length === 1) { const readFile = getReadFileToolData(firstTool); return ( -
- -
+ +
+ +
+ ); } @@ -451,6 +452,7 @@ export const BlockList: FC<{ } modelIntent={tool.modelIntent} parsedCommands={tool.parsedCommands} + hookRewritten={tool.hookRewritten} /> ); } @@ -511,6 +513,7 @@ export const BlockList: FC<{ } modelIntent={tool.modelIntent} parsedCommands={tool.parsedCommands} + hookRewritten={tool.hookRewritten} /> ))} @@ -631,9 +634,20 @@ const ChatMessageItem = memo<{ // Keep links in dimmed notices out of accessibility navigation. inert={isAfterEditingMessage ? true : undefined} > - - {parsed.markdown} - + {parsed.hookNotices.length > 0 ? ( + parsed.hookNotices.map((notice, index) => ( + + {notice} + + )) + ) : ( + + {parsed.markdown} + + )} ); } diff --git a/site/src/pages/AgentsPage/components/ChatConversation/messageHelpers.ts b/site/src/pages/AgentsPage/components/ChatConversation/messageHelpers.ts index dd401e2a363..710c8ab382f 100644 --- a/site/src/pages/AgentsPage/components/ChatConversation/messageHelpers.ts +++ b/site/src/pages/AgentsPage/components/ChatConversation/messageHelpers.ts @@ -68,7 +68,8 @@ const getRenderableContentState = (parsed: ParsedMessageContent) => { const hasRenderableContent = visibleBlocks.length > 0 || visibleTools.length > 0 || - parsed.sources.length > 0; + parsed.sources.length > 0 || + parsed.hookNotices.length > 0; const hasThinkingOnlyContent = visibleBlocks.length > 0 && visibleBlocks.every((block) => block.type === "thinking"); diff --git a/site/src/pages/AgentsPage/components/ChatConversation/messageParsing.ts b/site/src/pages/AgentsPage/components/ChatConversation/messageParsing.ts index f597351090a..da90fb396b5 100644 --- a/site/src/pages/AgentsPage/components/ChatConversation/messageParsing.ts +++ b/site/src/pages/AgentsPage/components/ChatConversation/messageParsing.ts @@ -170,6 +170,7 @@ export const mergeTools = ( mcpServerConfigId: call.mcpServerConfigId || result?.mcpServerConfigId, modelIntent, parsedCommands: call.parsedCommands, + hookRewritten: call.hookRewritten, }); } @@ -224,6 +225,7 @@ export const parseMessageContent = ( args: part.args, parsedCommands: part.parsed_commands, mcpServerConfigId: part.mcp_server_config_id, + hookRewritten: part.hook_rewritten, }); parsed.blocks = ensureToolBlock(parsed.blocks, id); break; diff --git a/site/src/pages/AgentsPage/components/ChatConversation/types.ts b/site/src/pages/AgentsPage/components/ChatConversation/types.ts index ad09653cd43..06b1128722c 100644 --- a/site/src/pages/AgentsPage/components/ChatConversation/types.ts +++ b/site/src/pages/AgentsPage/components/ChatConversation/types.ts @@ -7,6 +7,7 @@ export type ParsedToolCall = { args?: unknown; parsedCommands?: readonly string[][]; mcpServerConfigId?: string; + hookRewritten?: boolean; }; export type ParsedToolResult = { @@ -27,6 +28,7 @@ export type MergedTool = { mcpServerConfigId?: string; modelIntent?: string; parsedCommands?: readonly string[][]; + hookRewritten?: boolean; /** Set when a process_signal killed/terminated this process. */ killedBySignal?: "kill" | "terminate"; }; diff --git a/site/src/pages/AgentsPage/components/ChatElements/tools/AskUserQuestionTool.stories.tsx b/site/src/pages/AgentsPage/components/ChatElements/tools/AskUserQuestionTool.stories.tsx index 9e683e4163f..0b2ec3fcd06 100644 --- a/site/src/pages/AgentsPage/components/ChatElements/tools/AskUserQuestionTool.stories.tsx +++ b/site/src/pages/AgentsPage/components/ChatElements/tools/AskUserQuestionTool.stories.tsx @@ -456,6 +456,59 @@ export const ReadOnlyPreviousCall: Story = { }, }; +export const CompletedRewrittenByHook: Story = { + args: { + status: "completed", + result: JSON.stringify(multipleQuestionsPayload), + isChatCompleted: true, + isLatestAskUserQuestion: false, + hookRewritten: true, + onSendAskUserQuestionResponse: fn(), + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + + expect(await canvas.findByText("Modified by policy")).toBeVisible(); + expect( + canvas.getByText(/How should we structure the database migration/), + ).toBeInTheDocument(); + }, +}; + +export const CompletedNotRewrittenByHook: Story = { + args: { + status: "completed", + result: JSON.stringify(multipleQuestionsPayload), + isChatCompleted: true, + isLatestAskUserQuestion: false, + onSendAskUserQuestionResponse: fn(), + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + + expect( + await canvas.findByText(/How should we structure the database migration/), + ).toBeInTheDocument(); + expect(canvas.queryByText("Modified by policy")).not.toBeInTheDocument(); + }, +}; + +export const CompletedEmptyPayloadRewrittenByHook: Story = { + args: { + status: "completed", + result: JSON.stringify({ questions: [] }), + isChatCompleted: true, + isLatestAskUserQuestion: false, + hookRewritten: true, + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + + expect(await canvas.findByText("No questions available.")).toBeVisible(); + expect(canvas.getByText("Modified by policy")).toBeVisible(); + }, +}; + export const ErrorState: Story = { args: { status: "completed", diff --git a/site/src/pages/AgentsPage/components/ChatElements/tools/AskUserQuestionTool.tsx b/site/src/pages/AgentsPage/components/ChatElements/tools/AskUserQuestionTool.tsx index 514e6cc84a8..774bb627fcc 100644 --- a/site/src/pages/AgentsPage/components/ChatElements/tools/AskUserQuestionTool.tsx +++ b/site/src/pages/AgentsPage/components/ChatElements/tools/AskUserQuestionTool.tsx @@ -692,7 +692,6 @@ export const AskUserQuestionTool: FC = ({ /> )} - {isInteractive ? (
{content}
) : ( diff --git a/site/src/pages/AgentsPage/components/ChatElements/tools/ReadFilesTool.tsx b/site/src/pages/AgentsPage/components/ChatElements/tools/ReadFilesTool.tsx index cf2cf63990a..8ec9497a4f0 100644 --- a/site/src/pages/AgentsPage/components/ChatElements/tools/ReadFilesTool.tsx +++ b/site/src/pages/AgentsPage/components/ChatElements/tools/ReadFilesTool.tsx @@ -10,11 +10,13 @@ type ReadFileItem = { status: MergedTool["status"]; isError: boolean; errorMessage?: string; + hookRewritten: boolean; }; const getReadFileItem = (tool: MergedTool): ReadFileItem => ({ id: tool.id, status: tool.status, + hookRewritten: tool.hookRewritten ?? false, ...getReadFileToolData(tool), }); @@ -46,11 +48,18 @@ export const ReadFilesTool: FC<{ expanded={expanded} onExpandedChange={onExpandedChange} > - + item.hookRewritten)} + > + +
{items.map((item) => ( -
+ -
+ ))}
diff --git a/site/src/pages/AgentsPage/components/ChatElements/tools/Tool.stories.tsx b/site/src/pages/AgentsPage/components/ChatElements/tools/Tool.stories.tsx index a918bcf9fff..3f6fd0b45e4 100644 --- a/site/src/pages/AgentsPage/components/ChatElements/tools/Tool.stories.tsx +++ b/site/src/pages/AgentsPage/components/ChatElements/tools/Tool.stories.tsx @@ -2,11 +2,15 @@ import type { Meta, StoryObj } from "@storybook/react-vite"; import { expect, fn, screen, userEvent, waitFor, within } from "storybook/test"; import { reactRouterParameters } from "storybook-addon-remix-react-router"; import { chatModelConfigsKey } from "#/api/queries/chats"; +import { workspaceBuildLogs } from "#/api/queries/workspaceBuilds"; +import { workspaceByIdKey } from "#/api/queries/workspaces"; +import type * as TypesGen from "#/api/typesGenerated"; import { MockChatModelConfig } from "#/testHelpers/chatModels"; +import { MockWorkspace, MockWorkspaceBuild } from "#/testHelpers/entities"; import { ChatWorkspaceContext } from "../../../context/ChatWorkspaceContext"; import { BlockList } from "../../ChatConversation/ConversationTimeline"; import { DesktopPanelContext } from "./DesktopPanelContext"; -import { Tool } from "./Tool"; +import { Tool, toolRendererNames } from "./Tool"; const executeCommand = "git fetch origin"; const executeIntentCommand = "npm test"; @@ -127,6 +131,13 @@ const allToolShowcaseItems: ToolShowcaseItem[] = [ count: 1, }, }, + { + name: "list_agents", + result: { + agents: [{ id: "agent-1", title: "Workspace diagnostics" }], + total: 1, + }, + }, { name: "read_template", args: { template_id: "template-1" }, @@ -394,6 +405,7 @@ export const ExecuteDeniedByHook: Story = { status: "error", isError: true, args: { command: "cat /etc/secrets" }, + parsedCommands: [["cat", "/etc/secrets"]], result: { error: "This tool usage was blocked by an external policy (the deployment's lifecycle hook); the tool call was not executed. Reason: secret reads are blocked. This is an administrative policy decision, not a tool or workspace failure; retrying the same call will be denied again. Explain the policy block to the user and adjust your approach.", @@ -401,10 +413,8 @@ export const ExecuteDeniedByHook: Story = { }, play: async ({ canvasElement }) => { const canvas = within(canvasElement); - expect(canvas.getByText(/Failed to run cat \/etc\/secrets/)).toBeVisible(); - expect( - canvas.queryByText(/Ran cat \/etc\/secrets/), - ).not.toBeInTheDocument(); + expect(canvas.getByText(/Failed to run cat/)).toBeVisible(); + expect(canvas.queryByText(/Ran cat/)).not.toBeInTheDocument(); await expect( canvas.getByRole("img", { name: /blocked by an external policy/, @@ -414,6 +424,117 @@ export const ExecuteDeniedByHook: Story = { }, }; +export const ExecuteRewrittenByHook: Story = { + args: { + name: "execute", + status: "completed", + args: { command: "echo REWRITTEN_BY_HOOK" }, + parsedCommands: [["echo", "REWRITTEN_BY_HOOK"]], + hookRewritten: true, + result: { output: "REWRITTEN_BY_HOOK", exit_code: 0 }, + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + const header = canvas.getByRole("button", { + name: /^(Expand|Collapse) command, modified by policy$/, + }); + expect(within(header).getByText(/Ran echo/)).toBeVisible(); + expect(canvas.getByText("Modified by policy")).toBeVisible(); + }, +}; + +export const ExecuteNotRewrittenByHook: Story = { + args: { + name: "execute", + status: "completed", + args: { command: "echo original" }, + parsedCommands: [["echo", "original"]], + result: { output: "original", exit_code: 0 }, + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + expect(canvas.getByText(/Ran echo/)).toBeVisible(); + expect(canvas.queryByText("Modified by policy")).not.toBeInTheDocument(); + }, +}; + +export const WriteFileRewrittenByHook: Story = { + args: { + name: "write_file", + status: "completed", + codeDiffDisplayMode: "auto", + args: { + path: "src/utils/helpers.ts", + content: "export const helper = true;\n", + }, + hookRewritten: true, + result: { success: true }, + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + expect(canvas.getByText("Modified by policy")).toBeVisible(); + }, +}; + +export const SubagentRewrittenByHook: Story = { + args: { + name: "spawn_agent", + status: "completed", + args: { + title: "Workspace diagnostics", + prompt: "Collect logs and summarize why startup failed.", + }, + hookRewritten: true, + result: { + chat_id: "child-chat-id", + title: "Workspace diagnostics", + status: "completed", + }, + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + expect( + canvas.getByRole("button", { name: /Spawned Workspace diagnostics/ }), + ).toBeVisible(); + expect(canvas.getByText("Modified by policy")).toBeVisible(); + }, +}; + +export const NonCollapsibleRewrittenByHook: Story = { + args: { + name: "read_template", + status: "completed", + args: { template_id: "template-1" }, + hookRewritten: true, + result: { + template: { name: "go-template", display_name: "Go Development" }, + }, + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + expect( + canvas.queryByRole("button", { name: /Read template/ }), + ).not.toBeInTheDocument(); + expect(canvas.getByText("Modified by policy")).toBeVisible(); + }, +}; + +export const NonCollapsibleNotRewrittenByHook: Story = { + args: { + name: "read_template", + status: "completed", + args: { template_id: "template-1" }, + result: { + template: { name: "go-template", display_name: "Go Development" }, + }, + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + expect(canvas.getByText("Read template Go Development")).toBeVisible(); + expect(canvas.queryByText("Modified by policy")).not.toBeInTheDocument(); + }, +}; + export const ExecuteBackgrounded: Story = { args: { name: "execute", @@ -2307,6 +2428,24 @@ export const ReadFileLongLine: Story = { }, }; +export const ReadFileFailed: Story = { + args: { + name: "read_file", + status: "error", + isError: true, + args: { path: "site/src/config.ts" }, + result: { error: "permission denied" }, + }, + play: async ({ canvasElement }) => { + const canvas = within(canvasElement); + // An explicit ariaLabel on the row would replace the computed name and + // drop the failure text the status icon contributes. + expect( + canvas.getByRole("button", { name: /permission denied/ }), + ).toBeVisible(); + }, +}; + export const ReadFileTallAndWide: Story = { args: { name: "read_file", @@ -3159,3 +3298,99 @@ export const AllToolIconsTranscript: Story = { ], }, }; + +const policyCaseLabel = (name: string, index: number) => + `policy case ${name} ${index}`; + +// WorkspaceBuildLogSection falls back to the workspace's latest build when a +// tool result carries no build_id, so both must resolve to the seeded logs. +const showcaseBuildId = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"; + +const policyCaseWorkspace: TypesGen.Workspace = { + ...MockWorkspace, + id: "test-workspace-id", + latest_build: { + ...MockWorkspaceBuild, + id: showcaseBuildId, + workspace_id: "test-workspace-id", + }, +}; + +export const PolicyBadgeCoversEveryRenderer: Story = { + render: () => ( + + +
+ {allToolShowcaseItems.map((tool, index) => ( +
+ +
+ ))} +
+ + + ), + parameters: { + queries: [ + { + key: workspaceByIdKey("test-workspace-id"), + data: policyCaseWorkspace, + }, + { + key: workspaceBuildLogs(showcaseBuildId).queryKey, + data: [], + }, + ], + }, + play: async ({ canvasElement }) => { + const covered = new Set(allToolShowcaseItems.map((tool) => tool.name)); + expect( + toolRendererNames.filter((name) => !covered.has(name)), + ).toStrictEqual([]); + + const canvas = within(canvasElement); + const rendered = new Set(); + const missingBadge: string[] = []; + allToolShowcaseItems.forEach((tool, index) => { + const toolCase = canvas.getByRole("group", { + name: policyCaseLabel(tool.name, index), + }); + if (toolCase.textContent?.trim() === "") { + return; + } + rendered.add(tool.name); + // checkVisibility, not presence: a badge hidden by the card's own + // layout still satisfies a text query. + if ( + !within(toolCase).queryByText("Modified by policy")?.checkVisibility() + ) { + missingBadge.push(tool.name); + } + }); + + expect(missingBadge).toStrictEqual([]); + expect( + toolRendererNames.filter((name) => !rendered.has(name)), + ).toStrictEqual([]); + }, +}; diff --git a/site/src/pages/AgentsPage/components/ChatElements/tools/Tool.tsx b/site/src/pages/AgentsPage/components/ChatElements/tools/Tool.tsx index 5934b2524f6..d1dca3c8743 100644 --- a/site/src/pages/AgentsPage/components/ChatElements/tools/Tool.tsx +++ b/site/src/pages/AgentsPage/components/ChatElements/tools/Tool.tsx @@ -88,6 +88,7 @@ interface ToolProps extends Omit, "children"> { modelIntent?: string; /** Parsed command tuples ([program] or [program, arg]) for execute tool calls. */ parsedCommands?: readonly string[][]; + hookRewritten?: boolean; shellToolDisplayMode?: TypesGen.AgentDisplayMode; codeDiffDisplayMode?: TypesGen.AgentDisplayMode; } @@ -1037,6 +1038,10 @@ const toolRenderers: Record> = { computer: ComputerRenderer, }; +// Exported so tests can assert cross-cutting affordances across every +// registered renderer instead of a hand-picked subset. +export const toolRendererNames: readonly string[] = Object.keys(toolRenderers); + // --------------------------------------------------------------------------- // Public Tool component with a single wrapper div and map dispatch. // --------------------------------------------------------------------------- @@ -1063,6 +1068,7 @@ export const Tool = memo( previousResponseText, modelIntent, parsedCommands, + hookRewritten = false, shellToolDisplayMode, codeDiffDisplayMode, ref, @@ -1088,29 +1094,31 @@ export const Tool = memo( )} {...props} > - + + + ); }, diff --git a/site/src/pages/AgentsPage/components/ChatElements/tools/ToolCall.tsx b/site/src/pages/AgentsPage/components/ChatElements/tools/ToolCall.tsx index d9023d6f87a..bde2ddd5fbc 100644 --- a/site/src/pages/AgentsPage/components/ChatElements/tools/ToolCall.tsx +++ b/site/src/pages/AgentsPage/components/ChatElements/tools/ToolCall.tsx @@ -1,10 +1,16 @@ -import { ChevronDownIcon, LoaderIcon, TriangleAlertIcon } from "lucide-react"; +import { + ChevronDownIcon, + LoaderIcon, + ShieldIcon, + TriangleAlertIcon, +} from "lucide-react"; import { type ComponentPropsWithoutRef, createContext, type FC, type ReactNode, useContext, + useId, useState, } from "react"; import { @@ -44,6 +50,37 @@ type ToolCallContextValue = { const ToolCallContext = createContext(null); +const ToolPolicyContext = createContext<{ hookRewritten: boolean }>({ + hookRewritten: false, +}); + +// Some renderer branches render no `ToolCall.Header`, so emitting the +// badge here rather than in the header keeps attribution on those cards. +const PolicyProvider: FC<{ hookRewritten: boolean; children: ReactNode }> = ({ + hookRewritten, + children, +}) => { + const badgeId = useId(); + return ( + + {hookRewritten ? ( +
+ + + Modified by policy + + {children} +
+ ) : ( + children + )} + + ); +}; + const useToolCallContext = () => { const context = useContext(ToolCallContext); if (!context) { @@ -173,6 +210,13 @@ const HeaderButton: FC = ({ alwaysButton = false, }) => { const { ariaLabel, collapsible, expanded, onToggle } = useToolCallContext(); + const { hookRewritten } = useContext(ToolPolicyContext); + const resolvedAriaLabel = + typeof ariaLabel === "function" ? ariaLabel(expanded) : ariaLabel; + const buttonAriaLabel = + resolvedAriaLabel && hookRewritten + ? `${resolvedAriaLabel}, modified by policy` + : resolvedAriaLabel; if (!collapsible && !alwaysButton) { return ( {children} @@ -191,9 +235,7 @@ const HeaderButton: FC = ({