Repository navigation
fix(replays): Withhold internal field choices from the public replay schema - #128639
Merged
Merged
Conversation
…schema ReplayDetailsResponse already omits info_ids and warning_ids from the public response schema, but ReplayValidator still listed them in the public `field` enum. Generated clients (@sentry/api) therefore advertised two fields that the documented response never contains. Withhold the two choices from the public schema too. They are still accepted at runtime, so the replay UI is unaffected. Co-Authored-By: Burak Yigit Kaya <burak.kaya@sentry.io>
Contributor
decision-model-linterapi
decision-model-linter: 1 call on 1 file, 672 input tokens, $0.000028, model typesafe/jev-1.13-20260917 |
BYK
added a commit
to getsentry/toolkit
that referenced
this pull request
Oct 23, 2026
…1617) This is a follow-up to #1605. `sentry explore --dataset replays` checked `--field` against a hand-written resolver table, plus a `switch` that mapped each nested field to its API root. Every new replay field meant another CLI change. The field list now comes from `@sentry/api/valibot`: - **API fields:** every dotted path in a `vListReplays` row whose root appears in the `field=` enum of `vListOrganizationReplaysData`. - **Request root:** the first segment of the path. - **Value:** read from the replay row by path. The CLI keeps only its own aliases and convenience columns: `url`, `release`, `user`/`user.display`, `count_traces`, `screens`, `seen_by_me`, and similar. **Behavior changes** - No longer accepted, because the published schema doesn't offer them: - `device.model_id` was never in the response, so it always resolved to empty. - `info_id(s)` and `warning_id(s)` are withheld from the public response as internal UI fields. - Newly accepted: `user.display_name`, `clicks`, `segment_names`, `tags`. - `ota_updates.*` and `replay_type` become available once `@sentry/api` moves past 0.356, where the index started accepting them. At that point, flip the `replay_type` assertion in `test/lib/replay-search.test.ts` and `test/commands/explore.test.ts`. **Related:** getsentry/sentry#128639 removes `info_ids`/`warning_ids` from the public `field` enum, so request and response agree. This PR doesn't depend on it, because response paths are already filtered by the enum. **Checks** - Pass: `pnpm run typecheck` and `pnpm run lint`. - Pass: `vitest run` for `test/lib/replay-search.test.ts`, `test/commands/explore.test.ts`, and `test/commands/replay`. - The full `test/lib` + `test/commands` run had 7 failures in permission and daemon tests unrelated to replays. The sandbox doesn't enforce `chmod`, so those tests can't pass there. <!-- junior-request-attribution:start --> via **BYK**. <!-- junior-request-attribution:end --> <!-- junior-session-footer:start --> <!-- junior-conversation-id:slack%3AC010884QHLG%3A1792754298.933159 --> -- [View Junior Session](https://junior-prod.sentry.dev/conversations/slack%3AC010884QHLG%3A1792754298.933159) [[Sentry]](https://sentry.sentry.io/explore/conversations/slack%3AC010884QHLG%3A1792754298.933159/?project=4510944073809921) <!-- junior-session-footer:end --> Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com> Co-authored-by: Burak Yigit Kaya <burak.kaya@sentry.io>
gggritso
approved these changes
Oct 23, 2026
This was referenced Oct 23, 2026
BYK
added a commit
to getsentry/toolkit
that referenced
this pull request
Oct 23, 2026
Upgrades the CLI's `@sentry/api` dependency from `^0.399.0` (#1643) to `^0.400.0`, the first release with getsentry/sentry#128639. That change withholds `info_ids` and `warning_ids` from the public replay `field` enum. The 0.400.0 types differ from 0.399.0 only in that enum, on the replay index and details endpoints. The lockfile change only covers `@sentry/api`. `pnpm-workspace.yaml` moves the `minimumReleaseAgeExclude` entry to 0.400.0, because it was published today. Since #1617, replay explore builds its fields from the schema. New assertions in `test/lib/replay-search.test.ts` check that: - `replay_type` and `ota_updates.channel` are supported. - `info_ids` and `warning_ids` are neither supported fields nor requestable roots. Verification: typecheck and lint pass, and a frozen-lockfile install passes. The replay, explore, and issue-app-links tests pass (149 tests). I didn't rerun the full suite, because the schema change is limited to that enum. <!-- junior-request-attribution:start --> via **BYK**. <!-- junior-request-attribution:end --> <!-- junior-session-footer:start --> <!-- junior-conversation-id:slack%3AC010884QHLG%3A1792754298.933159 --> -- [View Junior Session](https://junior-prod.sentry.dev/conversations/slack%3AC010884QHLG%3A1792754298.933159) [[Sentry]](https://sentry.sentry.io/explore/conversations/slack%3AC010884QHLG%3A1792754298.933159/?project=4510944073809921) <!-- junior-session-footer:end --> Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com> Co-authored-by: BYK <burak.kaya@sentry.io>
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.
ReplayDetailsResponsealready leavesinfo_idsandwarning_idsout of the public response schema ("Internal breadcrumb index used by the replay UI"). ButReplayValidatorstill offered both in the publicfieldenum on the replay index and details endpoints. As a result,@sentry/api(generated via getsentry/sentry-api-schema) lists twofieldvalues the documentedListReplaysresponse never contains.This hides those two choices from the public schema using the same
field.choiceform asReplayCountQueryParamsValidator. The runtime validator is unchanged, so the replay UI can still request them.This is needed by the Sentry CLI in getsentry/toolkit, which wants to build its replay field list from
@sentry/apiinstead of maintaining its own copy.Not run locally: I don't have a Sentry dev environment here. The
api-docsCI build runs the omission guard, which checks this change.via BYK.
--
View Junior Session [Sentry]