Removes production code in `coderd/x/chatd` that nothing reaches, the tests that only existed to exercise it, and option/config fields that callers filled in but chatd never read. No runtime behaviour changes; the only edits outside `coderd/x/chatd` drop the now-nonexistent fields at their three call sites (`coderd/coderd.go`, `coderd/exp_chats.go`, `coderd/coderdtest`). Net: 42 files, +147 / -1065. Verification method for every item: `golang.org/x/tools/cmd/deadcode` (with and without `-test`) rooted at `cmd/coder`, `enterprise/cmd/coder` and every package that imports chatd; a `go/packages` pass counting `TypesInfo.Uses` per declared type, const, var, field and method across the same roots, split into test and non-test use sites, plus a read-vs-write split for struct fields; `rg` over the whole repo including `site/src` for json tag names; then `go build ./...`, `go vet ./coderd/x/chatd/...`, `golangci-lint run ./coderd/x/chatd/... ./coderd/ ./coderd/coderdtest/`, and `go test ./coderd/x/chatd/...` (all 20 packages) locally. <details> <summary>Evidence per deletion</summary> | Removed | What it was | Why unused | |---|---|---| | `subagent.go` `resolveConfiguredModelOverride`, `parseModelOverride`, `parsedModelOverride` (~135 lines) + `TestResolveConfiguredModelOverride_*`, `TestParseModelOverride` | raw-string model override resolver | Only callers were its two tests; production resolves overrides through `resolveOrganizationModelOverride` (`title_override.go`, `compaction_override.go`, `subagent.go`). | | `chatd.go` `removeSkillIndexMessages`, `isSkillIndexMessage` + `TestSkillIndexRefreshReplacesStaleAliases` | skill-index refresh helpers | Zero production references; the test simulated a refresh path no production code performs. | | `chatd.go` `chatMessage`, `newChatMessage`, `withCreatedBy`, `appendMessageFields`, `BuildSingleChatMessageInsertParams` (~90 lines) | insert-params builder | Exported, but every caller was a `chatd_test` file (6 sites). Replaced by a 25-line `singleChatMessageInsertParams` helper in `chatd_helpers_test.go`. | | `chatd.go` `Server.closeInflightAdmission` | one-line wrapper around `inflightClosed.Store(true)` | Single call site (`Close`); inlined. | | `chatd.go` `Server.workerID`, `instructionLookupTimeout`, `pendingChatAcquireInterval`, `maxChatsPerAcquire`, `chatHeartbeatInterval` | Server struct fields | Assigned in `New` and never read anywhere (the values reach the worker through `chatWorkerOptions`, not these fields). | | `Config.InstructionLookupTimeout`, `homeInstructionLookupTimeout`, `coderd.Options.ChatdInstructionLookupTimeout`, `coderdtest.Options.ChatdInstructionLookupTimeout` | timeout plumbing | The value only landed in the dead `Server.instructionLookupTimeout`; no CLI flag sets it and nothing reads it. | | `PromoteQueuedOptions.CreatedBy` | option field | Set by `coderd/exp_chats.go` and three tests, never read in chatd (promotion keeps the queued row's `created_by`). | | `SubmitToolResultsOptions.DynamicTools` | option field | Set by `coderd/exp_chats.go` (which re-read `chat.DynamicTools` just to pass it) and three tests, never read in chatd. | | `attachments.go` `buildAssistantPartsForPersist` (whole file) | assistant part builder | Stale copy left by #26270; production uses `buildAssistantParts` in `message_conversion.go`. Its six tests were retargeted to the live function (now `message_conversion_internal_test.go`) and a dead-copy assertion in `subagent_internal_test.go` was dropped. | | `chatloop.RunOptions` (94 lines) | old loop options struct | Only two of 23 fields were ever populated, for one internal call to `prepareMessagesForRequest`, which now takes `model, logger` directly and no longer returns the ignored canonical slice. `GenerateAssistantOptions` / `ExecuteLocalToolsOptions` are the live types. | | `chatloop.ErrDynamicToolCall`, `ErrStopAfterTool`, `PendingToolCall`, `PersistedStep.PendingDynamicToolCalls` | dynamic-tool exit protocol | Zero references outside their declarations (one stale comment in `chatdebug/service.go` updated). | | `chatloop.CompactionOptions.Persist`, `.OnError` | callbacks | `Persist` had zero references; `OnError` was set only by two tests that asserted it was never invoked. | | `chatloop` `stepResult.shouldContinue` + its computation | flag | Written once, never read. | | `chatloop.StateWaiting` | metric label const | Zero references. | | `generation.go` `generationOutcome.InsertedMessages`, `runnerActionMessage` | outcome field | Built on every commit, never read. | | `chatstate` `ExecutionState.IsArchived`, `AllOwnershipStates`, `OwnershipState`/`StateU`/`StateO`, `TransitionAcquire` | state-machine leftovers | Zero references (the ownership consts became dead once `AllOwnershipStates` went). | | `chatstate` `ExecutionState.QueueNonEmpty` | predicate | Only referenced by the test asserting its own table; the sibling `IsRunnable` check in that test is kept. | | `chatdebug.Attempt.RetryClassification`, `.RetryDelayMs` | json fields | Never assigned anywhere, `omitempty`, and `retry_classification`/`retry_delay_ms` do not appear in `site/src` or `typesGenerated.ts`. | | `chatdebug.RunContext.Kind`, `StepContext.HistoryTipMessageID`, `RecorderOptions.Provider`/`.Model`, `stepHandle.opts`/`.usage`/`.err` | context/handle fields | Written (from `chatd.go`, `chatloop/compaction.go`, `modelcall.go`, `recorder.go`) and never read. The DB run row keeps its own `kind` column. | | `chatprovider.MergeProviderAPIKeys` + `TestMergeProviderAPIKeys_PreservesProviderRegions` | key merge | Superseded by `ResolveUserProviderKeys`, whose region test already covers the same behaviour. | | `chatprovider` `providerCreationError` | one-line `xerrors.Errorf` wrapper | Single call site; inlined with identical message. | | `chatretry.IsRetryable` | classifier wrapper | Zero references. | | `computeruse.IsTool` + `TestComputerUseTool` | one-line forwarder to `fantasyopenai.IsComputerUseTool` | No production caller; two test assertions now call the fantasy function directly, and the dropped test only asserted the library's own constructor. | | `chatprompt.ToolResultToPart` | one-line forwarder to `codersdk.ChatMessageToolResult` | Single call site; inlined. | | `subagent_catalog.go` `formatSubagentDefinitions` | forwarder with `nil` overrides | Single call site; inlined. | | `worker.go` `chatWorker.chatWorkerID` | getter | Only tests called it; they read `opts.WorkerID` directly now. | | `chattest.AnthropicErrorResponse`, `OpenAIServerErrorResponse`, `ChatMessageWithParts` (`messages.go` removed) | test fixtures | Zero references. | | `chattest` `AnthropicRequest.Options`, `OpenAIRequest.Options` | `json:",inline"` map fields | `encoding/json` has no inline tag (the TODO on each said so); never populated, never read. | </details> <details> <summary>Considered and kept</summary> - `chatstate.CreateChat` (test-only thin wrapper over `insertChat`, production uses `CreateChatWithID`): documented package API with 25 test call sites; not worth the churn. - `chatprompt.MarshalContent` / `MarshalToolResult`: test-only, but they deliberately produce legacy-format DB rows so the read path's legacy handling stays covered. - `chatstate.AllowedExecutionTransitionsFrom` / `AllowedInputStates` / `AllowedExecutionTransitionOutputs`, `chatdebug.StepFromContext`, `WithClock`, `WithStaleThreshold`, `WaitUntilIdleForTest`, `PublishBuffer.BufferedChannels`, `chattool.NewWorkspaceMCPTool`: test seams that tests actively use to reach otherwise unexported state. - `AgentCapacityLimiter` interface (one production implementation): tests inject fakes. - `applyHookResultMessages` / `appendHookResultMessages`: a named pair over one placement enum, both used. - Nil-receiver guards on `*Metrics`, `*Result`, `*streamSyncPoller`, `*runnerDebugTurn`: nil is a supported "disabled" value on those paths. - Tests flagged by heuristics as assertion-light (`TestNopMetrics_DoesNotPanic`, `TestStepHandleFinish_NilHandle`, `TestRetry_OnRetryNilDoesNotPanic`, the `chatstate` synthetic-cancellation tests that assert through helpers): they cover real nil-safety or delegate assertions to helpers; kept. </details> <details> <summary>Out-of-scope findings (not changed here)</summary> - `chatdebug.Service.FinalizeStale` has had no production caller since #26270 removed the background sweep loop; only its tests call it, and comments in `chatd_debug.go` and `database/querier.go` still describe the loop. Deleting it would erase the implementation a fix needs, so it is left for a decision. - `coderd_chatd_chats` (gauge) and `coderd_chatd_stream_buffer_dropped_total` (counter) are registered and documented in `docs/admin/integrations/prometheus.md` but never set or incremented in production; `Metrics.RecordStreamBufferDropped` is test-only. Removing them changes the exported metric set and the docs, so they are left alone. </details> ## Declined review findings None yet. > Xum (AI agent) opened this PR on behalf of @ibetitsmike.
131 lines
4.6 KiB
Go
131 lines
4.6 KiB
Go
package chatstate
|
|
|
|
import (
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
)
|
|
|
|
// ExecutionState identifies a chat's current execution state. Values
|
|
// outside the chat execution state model are represented by
|
|
// [StateInvalid].
|
|
type ExecutionState string
|
|
|
|
const (
|
|
// StateN: chat does not exist.
|
|
StateN ExecutionState = "N"
|
|
// StateW: waiting, empty queue, not archived.
|
|
StateW ExecutionState = "W"
|
|
// StateE0: error, empty queue, not archived.
|
|
StateE0 ExecutionState = "E0"
|
|
// StateE1: error, non-empty queue, not archived.
|
|
StateE1 ExecutionState = "E1"
|
|
// StateR0: running, empty queue, not archived.
|
|
StateR0 ExecutionState = "R0"
|
|
// StateR1: running, non-empty queue, not archived.
|
|
StateR1 ExecutionState = "R1"
|
|
// StateI0: interrupting, empty queue, not archived.
|
|
StateI0 ExecutionState = "I0"
|
|
// StateI1: interrupting, non-empty queue, not archived.
|
|
StateI1 ExecutionState = "I1"
|
|
// StateA0: requires_action, empty queue, not archived.
|
|
StateA0 ExecutionState = "A0"
|
|
// StateA1: requires_action, non-empty queue, not archived.
|
|
StateA1 ExecutionState = "A1"
|
|
// StateXW: archived waiting, empty queue.
|
|
StateXW ExecutionState = "XW"
|
|
// StateXE0: archived error, empty queue.
|
|
StateXE0 ExecutionState = "XE0"
|
|
// StateXE1: archived error, non-empty queue.
|
|
StateXE1 ExecutionState = "XE1"
|
|
|
|
// StateInvalid groups every status/archive/queue combination that
|
|
// is not one of the valid states above. The state machine refuses
|
|
// non-reconciliation transitions on invalid states and exposes the
|
|
// [Tx.ReconcileInvalidState] transition to recover.
|
|
StateInvalid ExecutionState = "Invalid"
|
|
)
|
|
|
|
// String implements fmt.Stringer.
|
|
func (s ExecutionState) String() string { return string(s) }
|
|
|
|
// AllExecutionStates is the canonical enumeration of every value the
|
|
// classifier can return. Tests rely on this list to iterate over every
|
|
// state when verifying transition coverage.
|
|
var AllExecutionStates = []ExecutionState{
|
|
StateN,
|
|
StateW,
|
|
StateE0,
|
|
StateE1,
|
|
StateR0,
|
|
StateR1,
|
|
StateI0,
|
|
StateI1,
|
|
StateA0,
|
|
StateA1,
|
|
StateXW,
|
|
StateXE0,
|
|
StateXE1,
|
|
StateInvalid,
|
|
}
|
|
|
|
// IsRunnable returns true for the execution states that the chat
|
|
// worker is allowed to acquire and drive forward: R0, R1, I0, I1,
|
|
// A0, and A1. Requires-action states need worker ownership for
|
|
// timeout processing. Other states are idle (W, E*, XW, XE*), absent
|
|
// (N), or invalid.
|
|
func (s ExecutionState) IsRunnable() bool {
|
|
switch s {
|
|
case StateR0, StateR1, StateI0, StateI1, StateA0, StateA1:
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
|
|
// ClassifyExecutionState turns the chat row, queue cardinality, and
|
|
// whether the chat row exists into an [ExecutionState]. The caller is
|
|
// responsible for loading the chat under the row lock and reading the
|
|
// queue count in the same transaction.
|
|
//
|
|
// Callers that have no chat row (lookup returned sql.ErrNoRows)
|
|
// should pass exists=false; the chat, status, and archive arguments
|
|
// are then ignored.
|
|
//
|
|
// The classifier is a single flat switch over the valid (status,
|
|
// archived, queue) tuples in the chat execution state model. Anything
|
|
// outside that set (archived busy states, waiting with a non-empty
|
|
// queue, future enum values) falls through to [StateInvalid].
|
|
//
|
|
//nolint:revive // queueNonEmpty/exists are simple classifier inputs.
|
|
func ClassifyExecutionState(chat database.Chat, queueNonEmpty, exists bool) ExecutionState {
|
|
if !exists {
|
|
return StateN
|
|
}
|
|
switch {
|
|
case chat.Status == database.ChatStatusWaiting && !chat.Archived && !queueNonEmpty:
|
|
return StateW
|
|
case chat.Status == database.ChatStatusWaiting && chat.Archived && !queueNonEmpty:
|
|
return StateXW
|
|
case chat.Status == database.ChatStatusError && !chat.Archived && !queueNonEmpty:
|
|
return StateE0
|
|
case chat.Status == database.ChatStatusError && !chat.Archived && queueNonEmpty:
|
|
return StateE1
|
|
case chat.Status == database.ChatStatusError && chat.Archived && !queueNonEmpty:
|
|
return StateXE0
|
|
case chat.Status == database.ChatStatusError && chat.Archived && queueNonEmpty:
|
|
return StateXE1
|
|
case chat.Status == database.ChatStatusRunning && !chat.Archived && !queueNonEmpty:
|
|
return StateR0
|
|
case chat.Status == database.ChatStatusRunning && !chat.Archived && queueNonEmpty:
|
|
return StateR1
|
|
case chat.Status == database.ChatStatusInterrupting && !chat.Archived && !queueNonEmpty:
|
|
return StateI0
|
|
case chat.Status == database.ChatStatusInterrupting && !chat.Archived && queueNonEmpty:
|
|
return StateI1
|
|
case chat.Status == database.ChatStatusRequiresAction && !chat.Archived && !queueNonEmpty:
|
|
return StateA0
|
|
case chat.Status == database.ChatStatusRequiresAction && !chat.Archived && queueNonEmpty:
|
|
return StateA1
|
|
}
|
|
return StateInvalid
|
|
}
|