[skill-drift] update(sentry-react-sdk): document urlQueryParams rename and new graphQL/databaseQueryData options#293
Open
github-actions[bot] wants to merge 1 commit into
Conversation
…e and new graphQL/databaseQueryData options Automated drift-fix run. Co-Authored-By: Claude (claude-sonnet-5) <noreply@anthropic.com>
| @@ -359,13 +359,18 @@ Fine-grained control over what data the SDK collects. Replaces the simple `sendD | |||
| | `cookies` | `boolean \| { allow: string[] } \| { deny: string[] }` | `true` | Cookie collection and filtering; `true` = all cookies (sensitive keys filtered) | | |||
| | `httpHeaders.request` | `boolean \| { allow: string[] } \| { deny: string[] }` | `true` | HTTP request header collection | | |||
There was a problem hiding this comment.
Bug: Documentation for dataCollection options was updated for the React SDK but not for other affected JavaScript SDKs, creating an inconsistency.
Severity: LOW
Suggested Fix
Update the dataCollection documentation in all relevant JavaScript SDK files (e.g., browser/index.md, node/index.md, svelte/index.md) to replace queryParams with urlQueryParams and add the new graphQL and databaseQueryData options, mirroring the changes made to the React SDK documentation.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: src/references/sdks/react/index.md#L360
Potential issue: The pull request updates the documentation for the React SDK to reflect
a change from `queryParams` to `urlQueryParams` and adds new `graphQL` and
`databaseQueryData` options. This change originates in `@sentry/core`, which suggests it
should apply to all JavaScript SDKs. However, the documentation for other SDKs, such as
Browser, Node, Svelte, NestJS, NextJS, and TanStack Start, was not updated. This creates
an inconsistency where developers using other SDKs are shown outdated and incorrect
configuration options, potentially leading to confusion and misconfiguration.
Also affects:
src/references/sdks/svelte/index.mdsrc/references/sdks/browser/index.mdsrc/references/sdks/node/index.mdsrc/references/sdks/nestjs/index.mdsrc/references/sdks/tanstack-start/index.mdsrc/references/sdks/nextjs/index.md
Did we get this right? 👍 / 👎 to inform future reviews.
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
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.
Warning
Auto-generated from external SDK content. Review all links and code suggestions before acting on them.
What changed upstream
@sentry/react(via@sentry/core) shipped three related changes to thedataCollectioninit option, now released in10.66.0/10.67.0:queryParamsrenamed tourlQueryParams(#22217, released 10.67.0).queryParamsstill works but is now marked@deprecatedin favor of the new name; same shape (boolean | { allow: string[] } | { deny: string[] }) and default (true).dataCollection.graphQLoption (#22221, released 10.66.0) —{ document?: boolean; variables?: boolean }, both defaulttrue. Controls whether the GraphQL document text and operation variables are attached when a GraphQL integration is enabled. Does not add instrumentation on its own.dataCollection.databaseQueryDataoption (#22219, released 10.66.0) —boolean, defaulttrue. Controls collection of DB query parameters, inline literal values, mutation/request bodies, and returned result data (e.g. for Supabase). Sanitizeddb.query.textand structural metadata are always collected regardless of this flag.What was out of date
src/references/sdks/react/index.md'sdataCollectionOptions table still listed only the deprecatedqueryParamsfield and had no rows forgraphQL.document,graphQL.variables, ordatabaseQueryData.Fix
Updated the table in
src/references/sdks/react/index.md:queryParamsrow withurlQueryParams(noting the deprecation and version) and added a deprecation callout below the table.graphQL.document,graphQL.variables, anddatabaseQueryDatarows with their defaults and minimum SDK version.No other file in the
reactreference tree mentionsqueryParams/urlQueryParams/graphQL/databaseQueryData, so no other edits were needed.Other PRs reviewed but not actioned
fix(react): Preserve parent path prefix for descendant route names in react-router— internal bug fix, no public-surface change to document.ref: Use base keys from conventions for dynamic suffix attribute keys(touchespackages/react/src/tanstackrouter.ts) — internal attribute-key refactor, no user-facing config/API change.fix(browser): Propagate trace data from active span if http.client span is non-recording— bug fix, no reference update needed.Note:
@sentry/browser's own reference tree (src/references/sdks/browser/) has the samequeryParams/urlQueryParamsdrift and will need the analogous fix in that SDK's own drift-detection run.Source PRs
queryParamstourlQueryParamsdataCollection.graphQLdataCollection.databaseQueryData(for e.g. Supabase filter values and mutation bodies)