Skip to content

fix(cloudflare): Reject unknown keys in options callbacks - #23290

Open
JPeer264 wants to merge 1 commit into
developfrom
jp/cloudflare-types
Open

fix(cloudflare): Reject unknown keys in options callbacks#23290
JPeer264 wants to merge 1 commit into
developfrom
jp/cloudflare-types

Conversation

@JPeer264

@JPeer264 JPeer264 commented Aug 11, 2026

Copy link
Copy Markdown
Member

Problem

It seemed that TypeScript didn't bother on wrong types in the options. This enables it and the following throws now a TS error:

withSentry(() => ({ something: null }), handler)

It also seemed that we forgot to add serverName in the available options for Cloudflare

Solution

Some workaround to make the types stricter within functions: TS Playground

It also seems to be known: microsoft/TypeScript#7547 (comment)


Clanker description:

TypeScript's excess property check does not survive a function boundary, so typos in the options callback went unreported:

withSentry(() => ({ dsn, tracesSampleRte: 1 }), handler) // compiled fine

StrictCloudflareOptions<O> infers the returned literal into O and intersects it with a never map over its unknown keys, restoring the error. Applied to every entry point taking options.

Note this is top level only, nested option objects stay unchecked, and it also rejects a pre-built object carrying extra keys, which a plain excess property check would allow.

Two bugs this surfaced: the Hono Cloudflare middleware spread the middleware-only shouldHandleError into the SDK options, and serverName was missing from CloudflareOptions despite being consumed by ServerRuntimeClient.

A plain `CloudflareOptions` parameter already rejects unknown keys when the
caller writes a direct object literal, which is why it is enough everywhere
else. That check does not survive a function boundary though, and since `env`
only exists at request time, a callback is the only way to configure these
APIs — so typos went unreported:

    withSentry(() => ({ dsn, tracesSampleRte: 1 }), handler) // compiled fine

`StrictCloudflareOptions<O>` rebuilds the check for the callbacks only: it
infers the returned literal into `O` and intersects it with a `never` map over
its unknown keys. A function-rejecting branch keeps "returned the options
factory instead of calling it" an error, which the intersection would otherwise
allow. The object forms stay on plain `CloudflareOptions`.

Note this is top level only — nested option objects stay unchecked — and it
also rejects a pre-built object carrying extra keys, which a plain excess
property check would allow.

Two bugs this surfaced: the Hono Cloudflare middleware spread the
middleware-only `shouldHandleError` into the SDK options, and `serverName` was
missing from `CloudflareOptions` despite being consumed by `ServerRuntimeClient`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@JPeer264 JPeer264 self-assigned this Aug 11, 2026
@JPeer264
JPeer264 requested review from a team as code owners August 11, 2026 13:23
@JPeer264
JPeer264 requested review from chargome, isaacs, mydea and s1gr1d and removed request for a team August 11, 2026 13:23
@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size % Change Change
@sentry/browser 30.29 kB - -
@sentry/browser - with treeshaking flags 28.47 kB - -
@sentry/browser - with treeshaking flags tracing without tracing 26.8 kB - -
@sentry/browser (incl. Tracing) 48.54 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 48.56 kB - -
@sentry/browser (incl. Tracing, Profiling) 51.44 kB - -
@sentry/browser (incl. Tracing, Replay) 87.95 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 77.36 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 92.66 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 105.36 kB - -
@sentry/browser (incl. Feedback) 47.61 kB - -
@sentry/browser (incl. sendFeedback) 35.11 kB - -
@sentry/browser (incl. FeedbackAsync) 40.26 kB - -
@sentry/browser (incl. Metrics) 31.28 kB - -
@sentry/browser (incl. Logs) 31.53 kB - -
@sentry/browser (incl. Metrics & Logs) 32.2 kB - -
@sentry/react 32.09 kB - -
@sentry/react (incl. Tracing) 50.73 kB - -
@sentry/vue 35.34 kB - -
@sentry/vue (incl. Tracing) 50.5 kB - -
@sentry/svelte 30.31 kB - -
CDN Bundle 31.59 kB - -
CDN Bundle (incl. Tracing) 48.87 kB - -
CDN Bundle (incl. Logs, Metrics) 33.8 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 50.83 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 74.34 kB - -
CDN Bundle (incl. Tracing, Replay) 86.46 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 88.33 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 92.17 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 94.14 kB - -
CDN Bundle - uncompressed 93.77 kB - -
CDN Bundle (incl. Tracing) - uncompressed 146.66 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 100.17 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 152.46 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 229.1 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 265.92 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 271.7 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 279.61 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 285.38 kB - -
@sentry/nextjs (client) 53.29 kB - -
@sentry/sveltekit (client) 48.96 kB - -
@sentry/core/server 65.44 kB - -
@sentry/core/browser 51.8 kB - -
@sentry/node 117.98 kB - -
@sentry/node/import (ESM hook with diagnostics-channel injection) 0 B added added
@sentry/node - without tracing 82.09 kB - -
@sentry/aws-serverless 91.5 kB - -
@sentry/cloudflare (withSentry) - minified 214.1 kB - -
@sentry/cloudflare (withSentry) 528.64 kB - -

View base workflow run

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