Skip to content

ref(server-utils)!: Consolidate AI integration option types into shared GenAiOptions - #23103

Draft
nicohrubec wants to merge 3 commits into
developfrom
ref/consolidate-genai-options
Draft

ref(server-utils)!: Consolidate AI integration option types into shared GenAiOptions#23103
nicohrubec wants to merge 3 commits into
developfrom
ref/consolidate-genai-options

Conversation

@nicohrubec

Copy link
Copy Markdown
Member

Every AI integration declared its own structurally-identical options interface (OpenAiOptions, AnthropicAiOptions, GoogleGenAIOptions, LangChainOptions, LangGraphOptions, WorkersAiOptions, VercelAiOptions, plus the internal VercelAiChannelOptions) — all just { recordInputs?: boolean; recordOutputs?: boolean }.

This renames the existing internal AIRecordingOptions to GenAiOptions, gives it provider-agnostic JSDoc, exports it from the @sentry/server-utils index, and uses it everywhere the per-integration types were used — deleting all the duplicated interfaces.

Decisions:

  • Kept named per-integration types out entirely (rather than aliasing) since this is a major and we can change the public types. The AI integration functions now accept GenAiOptions directly.
  • The vercel-edge integration keeps its own local, intentionally field-less options type, since that entrypoint only post-processes spans the AI SDK already emitted and cannot decide whether inputs/outputs are recorded.
  • The resolveAIRecordingOptions function name is unchanged.

…ed `GenAiOptions`

Every AI integration declared its own structurally-identical options interface
(`OpenAiOptions`, `AnthropicAiOptions`, `GoogleGenAIOptions`, `LangChainOptions`,
`LangGraphOptions`, `WorkersAiOptions`, `VercelAiOptions`, and the internal
`VercelAiChannelOptions`) — all just `{ recordInputs?: boolean; recordOutputs?: boolean }`.

Rename the existing internal `AIRecordingOptions` to `GenAiOptions`, give it crisp
provider-agnostic JSDoc, export it from the package index, and use it everywhere the
per-integration types were used. Deletes all the duplicated interfaces.

The vercel-edge integration keeps its own (intentionally field-less) local options
type, since that entrypoint cannot honor input/output recording.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit ebbf070. Configure here.

Comment thread packages/server-utils/src/index.ts
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size % Change Change
@sentry/browser 30.15 kB - -
@sentry/browser - with treeshaking flags 28.35 kB - -
@sentry/browser - with treeshaking flags tracing without tracing 26.66 kB - -
@sentry/browser (incl. Tracing) 47.56 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 47.57 kB - -
@sentry/browser (incl. Tracing, Profiling) 52.31 kB - -
@sentry/browser (incl. Tracing, Replay) 86.93 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 76.36 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 91.66 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 104.29 kB - -
@sentry/browser (incl. Feedback) 47.48 kB - -
@sentry/browser (incl. sendFeedback) 34.98 kB - -
@sentry/browser (incl. FeedbackAsync) 40.13 kB - -
@sentry/browser (incl. Metrics) 31.22 kB - -
@sentry/browser (incl. Logs) 31.44 kB - -
@sentry/browser (incl. Metrics & Logs) 32.13 kB - -
@sentry/react 31.95 kB - -
@sentry/react (incl. Tracing) 49.81 kB - -
@sentry/vue 35.25 kB - -
@sentry/vue (incl. Tracing) 49.57 kB - -
@sentry/svelte 30.17 kB - -
CDN Bundle 32.16 kB - -
CDN Bundle (incl. Tracing) 47.83 kB - -
CDN Bundle (incl. Logs, Metrics) 33.7 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 49.21 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 73.03 kB - -
CDN Bundle (incl. Tracing, Replay) 85.47 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 86.79 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 91.29 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 92.61 kB - -
CDN Bundle - uncompressed 95.33 kB - -
CDN Bundle (incl. Tracing) - uncompressed 142.84 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 99.96 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 146.82 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 224.66 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 262.09 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 266.06 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 275.8 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 279.75 kB - -
@sentry/nextjs (client) 52.39 kB - -
@sentry/sveltekit (client) 48.01 kB - -
@sentry/core/server 65.58 kB - -
@sentry/core/browser 51.82 kB - -
@sentry/node 119.28 kB - -
@sentry/node/import (ESM hook with diagnostics-channel injection) 0 B added added
@sentry/node - without tracing 83.3 kB - -
@sentry/aws-serverless 92.61 kB - -
@sentry/cloudflare (withSentry) - minified 212.61 kB - -
@sentry/cloudflare (withSentry) 524.89 kB - -

View base workflow run

nicohrubec and others added 2 commits August 6, 2026 16:23
Shortening the option type names collapsed these multi-line
signatures/imports under the print width, so oxfmt reformats them onto a
single line. Apply the formatting so the CI format check passes.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant