fix(ai): warn on unknown chat options - #1091
Open
mikemikimike wants to merge 6 commits into
Open
Conversation
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review. 📝 WalkthroughWalkthrough
ChangesUnknown chat option warnings
Estimated code review effort: 3 (Moderate) | ~20 minutes Merge Risk: ⚪ Minimal · up to This change adds warnings for unknown chat options while preserving existing debug-category control, with unit, end-to-end, type, lint, formatting, and diff checks passing; no actionable merge-blocking risk remains beyond normal review. Sequence Diagram(s)sequenceDiagram
participant PlaywrightTest
participant UnknownChatOptionsRoute
participant ChatActivity
participant Logger
participant AnyTextAdapter
PlaywrightTest->>UnknownChatOptionsRoute: request unknown-chat-options endpoint
UnknownChatOptionsRoute->>ChatActivity: pass top-level providerOptions
ChatActivity->>Logger: emit unknown-option warning
ChatActivity->>AnyTextAdapter: execute chat stream
UnknownChatOptionsRoute->>UnknownChatOptionsRoute: drain stream and collect warnings
UnknownChatOptionsRoute-->>PlaywrightTest: return warnings as JSON
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
packages/ai/src/activities/chat/index.ts (1)
505-548: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winDefine the chat option schema with Zod.
Use a Zod object schema as the source of truth for recognized
chat()option keys. Derive the unknown-key check from that schema. Keep provider-specificmodelOptionsopaque. Declare Zod as a runtime peer dependency because this check runs in the published package.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/ai/src/activities/chat/index.ts` around lines 505 - 548, Replace the manual CHAT_OPTION_KEYS set with a Zod object schema covering the recognized chat() options, while keeping modelOptions opaque and deriving warnOnUnknownChatOptions’ unknown-key detection from the schema’s keys. Add Zod as a runtime peer dependency for the published package and update any required package metadata or imports.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@testing/e2e/tests/unknown-chat-options.spec.ts`:
- Line 1: Add a file-header comment in unknown-chat-options.spec.ts explaining
that the test uses the local adapter and does not call an LLM provider, so
aimock is intentionally not configured.
---
Nitpick comments:
In `@packages/ai/src/activities/chat/index.ts`:
- Around line 505-548: Replace the manual CHAT_OPTION_KEYS set with a Zod object
schema covering the recognized chat() options, while keeping modelOptions opaque
and deriving warnOnUnknownChatOptions’ unknown-key detection from the schema’s
keys. Add Zod as a runtime peer dependency for the published package and update
any required package metadata or imports.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: fd23aba3-027a-4c7b-b61d-f96b7a8b0098
📒 Files selected for processing (6)
.changeset/fix-unknown-chat-options.mdpackages/ai/src/activities/chat/index.tspackages/ai/tests/debug-logging-chat.test.tstesting/e2e/src/routeTree.gen.tstesting/e2e/src/routes/api.unknown-chat-options.tstesting/e2e/tests/unknown-chat-options.spec.ts
Contributor
|
Thanks for the PR, @mikemikimike! 🙌 @jherr will take a look. Automated pre-review checks
Automated triage — a human review follows. |
github-actions
Bot
added
the
waiting-on: maintainer
Contributor
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
github-actions
Bot
added
merge-conflicts
tombeckenham
force-pushed
the
codex/1073-warn-unknown-chat-options
branch
from
August 20, 2026 10:27
64a51d9 to
2fc8385
Compare
|
View your CI Pipeline Execution ↗ for commit 84df0d5
☁️ Nx Cloud last updated this comment at |
tombeckenham
force-pushed
the
codex/1073-warn-unknown-chat-options
branch
from
August 20, 2026 10:49
2fc8385 to
020fdb0
Compare
@tanstack/ai
@tanstack/ai-acp
@tanstack/ai-angular
@tanstack/ai-anthropic
@tanstack/ai-bedrock
@tanstack/ai-byteplus
@tanstack/ai-claude-code
@tanstack/ai-client
@tanstack/ai-code-mode
@tanstack/ai-code-mode-snippets
@tanstack/ai-codex
@tanstack/ai-cohere
@tanstack/ai-devtools-core
@tanstack/ai-durable-stream
@tanstack/ai-elevenlabs
@tanstack/ai-event-client
@tanstack/ai-fal
@tanstack/ai-gemini
@tanstack/ai-grok
@tanstack/ai-grok-build
@tanstack/ai-groq
@tanstack/ai-isolate-cloudflare
@tanstack/ai-isolate-daytona
@tanstack/ai-isolate-node
@tanstack/ai-isolate-quickjs
@tanstack/ai-isolate-quickjs-bun
@tanstack/ai-llmgateway
@tanstack/ai-mcp
@tanstack/ai-memory
@tanstack/ai-mistral
@tanstack/ai-octane
@tanstack/ai-ollama
@tanstack/ai-openai
@tanstack/ai-opencode
@tanstack/ai-openrouter
@tanstack/ai-perplexity
@tanstack/ai-persistence
@tanstack/ai-preact
@tanstack/ai-react
@tanstack/ai-react-ui
@tanstack/ai-sandbox
@tanstack/ai-sandbox-cloudflare
@tanstack/ai-sandbox-daytona
@tanstack/ai-sandbox-docker
@tanstack/ai-sandbox-local-process
@tanstack/ai-sandbox-sprites
@tanstack/ai-sandbox-vercel
@tanstack/ai-solid
@tanstack/ai-solid-ui
@tanstack/ai-svelte
@tanstack/ai-utils
@tanstack/ai-vercel-gateway
@tanstack/ai-vertex
@tanstack/ai-vue
@tanstack/ai-vue-ui
@tanstack/openai-base
@tanstack/preact-ai-devtools
@tanstack/react-ai-devtools
@tanstack/solid-ai-devtools
commit: |
github-actions
Bot
removed
the
merge-conflicts
tombeckenham
force-pushed
the
codex/1073-warn-unknown-chat-options
branch
from
August 21, 2026 03:26
020fdb0 to
eecaa9f
Compare
Contributor
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
tombeckenham
added
waiting-on: maintainer
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
chat()receives unknown top-level optionsmodelOptionswhen the misplaced key isproviderOptionserrorsdebug categoryFixes #1073
Validation
pnpm test:lib --run tests/chat.test.ts tests/debug-logging-chat.test.ts tests/debug-logging-activities.test.ts— 90 passedpnpm --filter @tanstack/ai-e2e test:e2e -- tests/unknown-chat-options.spec.ts --project=chromium— 1 passedpnpm test:typesinpackages/ai— passedpnpm test:oxlintinpackages/ai— passed with existing warningspnpm --filter @tanstack/ai-e2e test:types— passedpnpm test:dts— passedgit diff --check— passedThe repository's
pnpm test:prran all React Native smoke checks and Nx targets successfully, but exited at the final Nx cleanup with WindowsEISDIR: illegal operation on a directory, lstat 'D:'.Summary by CodeRabbit
chat()now warns when it receives unrecognized top-level options instead of silently ignoring them.modelOptionswhenproviderOptionsis supplied incorrectly.