Repository navigation
refactor(codersdk): move chat client methods onto request helpers - #30963
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. 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. Chef's kiss. 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. More of your lovely PRs 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". |
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.
fd25e9d to
cd82528
Compare
cd82528 to
1c38e84
Compare
d2cb08a to
00be951
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: - a transport error, which must come back as an error that `errors.Is` matches. If a method swallowed it, callers would get a zero value and no error. If it wrapped it with `%v`, callers that check `errors.Is(err, context.Canceled)` would stop matching. - a 200 response with a body that is not valid JSON, which must come back as an error, not a zero value and no error. `Test_ReadBodyAsJSON` covers the decoder itself, not that a method returns its error. The test calls `ChatModel` (JSON response) and `DeleteChatModel` (no content), which #30961 moves onto the two helpers, through a fake transport. **Proof:** the test passes on `main` and on this branch. With `go test -overlay`, it fails when `ChatModel` returns 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 from `ChatModel` fails `TestChatModelACL` (expects 404), and dropping the request options from `ChatModelACLAvailable` fails `TestChatModelACLAvailable`. 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=1` passes, `golangci-lint run ./codersdk/` reports 0 issues, and the pre-commit hook passed. ## Stack This stack removes two unused chat exports from `codersdk` and moves 70 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 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.
00be951 to
4fc01f9
Compare
Adds two unexported helpers to `codersdk/chats.go` and moves the 16 chat project and chat model client methods onto them. `requestJSON[T]` sends the request, checks for the one status the method expects, and decodes the JSON body. `requestNoContent` does the same for `204 No Content`. Each converted method drops its own copy of that block, so the file loses 116 lines (+46/-162). The test changes in `codersdk/chats_test.go` are +59/-0. **Why it is safe:** the helpers return the same errors as the code they replace: the `Client.Request` error unchanged, `ReadBodyAsError` for any other status, and the `ReadBodyAsJSON` error. A script did the conversion. It rewrites a method only when its body ends in exactly that block, with a zero value that matches the decoded type, and it keeps the HTTP method, path, body, request options, and expected status. **Behavior change:** the helpers close an unexpected-status response body once, in `ReadBodyAsError`, where the old methods also deferred a second `Close`. Standard `net/http` bodies tolerate the second `Close`, but a custom transport's body may not (one whose `Close` closes a channel panics), and #30963 would otherwise have added it to `CreateChat` and `CreateChatMessage`, which closed once. - `TestChatClientRequests` passes here and fails on each of 7 helper mutants (`go test -overlay`): drop the transport error (`requestNoContent`), wrap it with `%v` (`requestJSON`), move the deferred `Close` back above the status check or drop it (one each per helper), and drop the decode error. - Its `ClosesResponseBodyOnce` case, added here, requires exactly one `Close` per call for each helper's success and unexpected status and for an invalid JSON body. Without it the test passed with the `Close` above the status check. It replaces the `Close` counts this layer had added to cases that #30960 dropped after review. - The 776 tests in test files that call a chat client method (12 packages) pass on `main` and here. With `-coverpkg=./codersdk`, every converted method's success path runs and both helpers are fully covered. - Call-site mutants fail existing coderd tests: `CreateChatProject` expecting 200 (`TestChatProjectsCRUDListAndDeleteDetaches`, `TestChatProjectLimit`), `DeleteChatProjectMemory` sending GET (`TestChatProjectMemoriesCRUD`), `ChatModelACLAvailable` without its query option (`TestChatModelACLAvailable`), and `UpdateChatModel` without a body (`TestUpdateChatModel`). **Review focus:** the two helpers; the next two layers only add call sites. `ListChatProjects`, `UpdateChatProject`, `DeleteChatProject`, and `ChatProjectInstructions` stay as they are, so #30439 and #30683 still apply cleanly. Validation: `go test ./codersdk -count=1` passes, `golangci-lint run ./codersdk/` reports 0 issues, and the pre-commit hook passed. ## Stack This stack removes two unused chat exports from `codersdk` and moves 70 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 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.
4fc01f9 to
62d7b7d
Compare
…lpers (#30962) Moves the 31 chat settings client methods in `codersdk/chats.go` onto the `requestJSON` and `requestNoContent` helpers from #30961: the deployment, organization, and user settings under `/chats/config`, and the organization model overrides. Each method drops its own request, status check, and decode block, so the file loses 266 lines. **Why it is safe:** the script from #30961 did the conversion, and this diff is exactly its output. It rewrites a method only when its body ends in the standard block, with a zero value that matches the decoded type, and it keeps the HTTP method, path, body, and expected status. #30961 shows that the helpers return the same errors as the code they replace. - The 776 tests in test files that call a chat client method (12 packages) pass here. With `-coverpkg=./codersdk`, every converted method's success path runs. - Call-site mutants (`go test -overlay`) fail existing coderd tests: `UpdateOrganizationChatModelOverride` without a body (`TestChatModelOverrides`), `DeleteUserChatCompactionThreshold` sending GET (`TestUserChatCompactionThresholds`), `GetChatAdvisorConfig` expecting 201 (`TestChatAdvisorConfig_GetDefault`), and `GetChatRetentionDays` reading the debug retention path (`TestChatRetentionDays`). **Review focus:** each hunk swaps one block for one call, so check the status argument against the deleted check. `UpdateOrganizationChatModelOverride`, `UpdateUserChatCustomPrompt`, and `UpdateUserChatCompactionThreshold` return a body with 200. The other updates expect 204. Validation: `go test ./codersdk -count=1` passes, `golangci-lint run ./codersdk/` reports 0 issues, and the pre-commit hook passed. ## Stack This stack removes two unused chat exports from `codersdk` and moves 70 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 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.
Move 21 more chat client methods (chats, messages, prompts, ACLs, cost, debug runs, diffs, file download URLs, and tool results) onto requestJSON and requestNoContent. Each converted method keeps its signature, HTTP method, path, body, request options, and expected status. Error results are unchanged. EditChatMessage and InterruptChat stay as they are because an open PR edits them. The streaming, upload, raw download, and user AI provider key methods do not fit the helpers.
UploadChatFile and UploadChatWorkspaceFile end in the standard request block, and requestJSON passes their io.Reader body and header option straight to Client.Request, so move both onto it. GetChatFile stays as it is because it returns raw bytes and a response header.
62d7b7d to
f7b72ca
Compare
Moves 23 more chat client methods in
codersdk/chats.goonto therequestJSONandrequestNoContenthelpers from #30961. They cover chats, messages, prompts, ACLs, cost, debug runs, diffs, file uploads and download URLs, and tool results. Each method drops its own request, status check, and decode block, so the file loses 204 lines.Why it is safe: the script from #30961 converted 21 of the methods, and that part of the diff is exactly its output.
UploadChatFileandUploadChatWorkspaceFileare converted by hand, because the script skips request options written as closures. They pass theirio.Readerbody and header option torequestJSONunchanged. #30961 shows that the helpers return the same errors as the code they replace.-coverpkg=./codersdk, every converted method's success path runs.mainand here.go test -overlay) fail existing tests:CreateChatexpecting 200 (TestPostChats),UpdateChatsending PUT (TestPatchChat),GetChatMessageswithout its pagination options (TestGetChatMessages_Pagination),SubmitToolResultsorUploadChatWorkspaceFilewithout a body (TestSubmitToolResults,TestPostChatWorkspaceFile),UploadChatWorkspaceFilewithout its header option (TestUploadChatWorkspaceFileContentType), andUploadChatFileexpecting 200 (TestPostChatFile).Review focus: the methods that stay as they are.
EditChatMessageandInterruptChatstay so that #29215 still applies cleanly.StreamChatandWatchChatsuse WebSockets.GetChatFilereturns raw bytes and a response header. The three user AI provider key methods wrap the request error, which the helpers do not.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.