Repository navigation
test(codersdk): cover chat client request errors - #30960
Conversation
|
@codex review |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Codex Review: Didn't find any major issues. Keep them coming! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
|
@codex review
|
|
Codex Review: Didn't find any major issues. Already looking forward to the next diff. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
|
@codex review
|
|
Codex Review: Didn't find any major issues. Bravo. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Removes two unused exports from `codersdk/chats.go`: the `ChatGitChange` type and `IsChatGitWatchFallbackMessage`. Regenerating the TypeScript types drops the `ChatGitChange` interface from `site/src/api/typesGenerated.ts`. **Why removal is safe:** neither symbol has a caller anywhere in this repository, including `site/`, `cli/`, `enterprise/`, `scaletest/` and tests. A GitHub code search across the coder organization finds only forks of this file and a copy of `typesGenerated.ts`. `IsChatGitWatchFallbackMessage` lost its only caller when #25190 removed the agents TUI. The comment on the git watch messages loses the sentences about that helper and the "keep in sync" note: `coderd/exp_chats.go` uses these constants directly. **Kept on purpose:** - `NewDynamicTool`, `DynamicToolCall`, `DynamicToolResponse` and the `invopop/jsonschema` import: bots outside this repository build on them (#24036). - `ChatMessageSource`: also unused, but #30861 adds a function right above it, and deleting it here would make that PR conflict. It can go after #30861 merges. - `AllChatMessagePartTypes`, `ChatDebugTerminalStatuses` and `WithChatDiffStatusRef`: `scripts/apitypings`, a guard test and a coderd test use them. Validation: the pre-commit hook passed (`make gen`, formatting, golangci-lint over every package and test file, and the slim build). `make site/src/api/typesGenerated.ts` produces exactly the TypeScript change in this PR. ## Stack This stack removes two unused chat exports from `codersdk` and moves 72 chat client methods in `codersdk/chats.go` onto two shared request helpers. Client behavior does not change, except that #30961 closes an unexpected-status response body once instead of twice. 1. #30959 Remove unused chat exports from codersdk 2. #30960 Cover chat client request errors and options 3. #30961 Add chat client request helpers, for the project and model methods 4. #30962 Move the chat settings methods onto the request helpers 5. #30963 Move the chat methods onto the request helpers > Xum, an AI agent, opened this PR for @ibetitsmike and wrote this description.
95506e7 to
51089c6
Compare
ethanndickson
left a comment
There was a problem hiding this comment.
Do we need this test? I'm not sure what it guards that we don't already cover.
The existing coderd tests already run the chat client against coderd, so the success paths, error statuses and query options already go through the code this stack changes. Bad JSON is also covered by the ReadBodyAsJSON tests. That seems to leave whether a transport or decode error gets passed back, and whether a different 2xx counts as an error, which is a small surface for a return err and a status check.
Some of the assertions also seem tied to how the code is written rather than what callers see. For example, the check that the transport error is never wrapped would fail if we added context to it, which callers using errors.Is or errors.As wouldn't notice. Not every surviving mutant points at a missing test.
Is there a regression this catches that the existing tests would miss?
Generated by an agent on behalf of the user
51089c6 to
e727382
Compare
|
@ethanndickson You're right that most of it duplicated existing coverage. I removed those cases in 16abee4:
Two cases stay because a real server can't produce them, so no coderd test reaches them:
Both fail under
|
|
@codex review
|
|
Codex Review: Didn't find any major issues. Another round soon, please! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
No test reaches the transport error branch of any chat client method, and none sends an invalid JSON body. TestChatClientRequestErrors covers both, and an unexpected status, through ChatModel and DeleteChatModel. The next layers move those methods onto shared request helpers.
TestChatClientRequestErrors also answers with 202 Accepted, so a status check that accepts any 2xx code fails the test.
TestChatClientRequestErrors did not check that request options reach the request, so a request helper that dropped them would still pass. Add a case that sends query options through ChatModelACLAvailable, and rename the test to TestChatClientRequests because it now covers more than errors.
The TransportError case only checked errors.Is, which still passes when a method wraps the transport error. http.Client.Do returns the fake transport's error as a *url.Error, so also require that type.
…aches Review asked what TestChatClientRequests guards that existing tests miss. coderd tests already run chat client methods against a real server, so error statuses (TestChatModelACL expects 404 from ChatModel) and request options (TestChatModelACLAvailable filters by search and limit) already fail when a method drops its status check or options. A different 2xx status is not something coderd returns, so that case guards no caller. Keep the two cases no other test can produce: a transport error and an undecodable success body must come back as errors. Assert the transport error with errors.Is only, so adding context with %w still passes.
16abee4 to
f641994
Compare
Adds
TestChatClientRequests, a test of the two chat client request failures that no other test reaches. It is the test-first layer for the refactor above it, and it only adds test lines (+42).Why it is needed: the next layers replace the request handling in 70 chat client methods with two shared helpers. The coderd tests already run those methods against a real server, so they cover success paths, error statuses, and request options. A real server cannot produce two failures:
errors.Ismatches. If a method swallowed it, callers would get a zero value and no error. If it wrapped it with%v, callers that checkerrors.Is(err, context.Canceled)would stop matching.Test_ReadBodyAsJSONcovers the decoder itself, not that a method returns its error.The test calls
ChatModel(JSON response) andDeleteChatModel(no content), which #30961 moves onto the two helpers, through a fake transport.Proof: the test passes on
mainand on this branch. Withgo test -overlay, it fails whenChatModelreturns no error for a transport failure, wraps it with%v, or drops the decode error, and it passes when the transport error is wrapped with%w. Cases I dropped because existing tests already fail on the same mutants: removing the status check fromChatModelfailsTestChatModelACL(expects 404), and dropping the request options fromChatModelACLAvailablefailsTestChatModelACLAvailable. I also dropped the check that another 2xx status is an error, because coderd never returns one on these routes.Validation:
go test ./codersdk/... -count=1passes,golangci-lint run ./codersdk/reports 0 issues, and the pre-commit hook passed.Stack
This stack removes two unused chat exports from
codersdkand moves 70 chat client methods incodersdk/chats.goonto two shared request helpers. Client behavior does not change, except that #30961 closes an unexpected-status response body once instead of twice.