ref(search): Add EAP API attribute visibility checks by nsdeschenes · Pull Request #116091 · getsentry/sentry

nsdeschenes · 2026-05-22T13:47:54Z

The goal of this PR is to lie down the foundational work of removing/hiding internal attributes from non-staff/non-super-user requests.

To determine if an attribute should be hidden or not, we pull that information from the Sentry conventions package from the visibility field from attribute metadata.

These changes are limited to the eap search resolver, as such this PR does not doing any enforcement of these attributes, that will come in follow up PRs. As well, this PR adds in some tests.

Add a shared helper for hiding internal Sentry convention attributes from API surfaces and let SearchResolver track attributes hidden by API visibility configuration. This keeps default resolver behavior unchanged unless an API caller opts into visibility enforcement.

The `as ATTRIBUTE_METADATA` pattern tells mypy this is an intentional re-export, fixing the attr-defined errors in tests that access it via `eap_utils.ATTRIBUTE_METADATA`.

linear-code · 2026-05-22T13:57:14Z

EXP-966

adrianviquez

Couple of comments, lmk what you think and can take a 2nd look!

The candidates set already prevents duplicates since we check `replacement not in candidates` before adding to pending.

Reverts the import move to avoid a circular import risk between resolver and utils modules.

When public_alias_override is set (e.g. equation resolution), the column_definition.public_alias becomes a synthetic label like "equation|…" which can_expose_attribute_to_api cannot evaluate against conventions, prefixes, or mappings.

…visibility-core

Update EAP attribute visibility tests to exercise real sentry_conventions metadata instead of mocked convention metadata. Keep alias and replacement edge-case coverage while pointing those mappings at real internal DSC attributes. Co-Authored-By: Codex <noreply@openai.com>

Apply API attribute visibility while resolving selected attributes instead of storing hidden attribute names on the SearchResolver instance. Keep the API visibility config as the switch for this behavior and add coverage for hidden internal attributes and the include-internal override. Co-Authored-By: Codex <noreply@openai.com>

Apply API attribute visibility filtering to aggregate and equation operands so hidden attributes cannot be embedded in resolved RPC columns. Reject orderby fallback resolution when the selected column was filtered out for API visibility. Co-Authored-By: GPT-5 Codex <codex@openai.com>

Reject API-hidden attributes when resolving EAP WHERE terms, HAVING aggregate terms, and nested query combinator filters. This keeps api_attribute_visibility_item_type from exposing internal attributes through filter-only query paths. Co-Authored-By: Codex <noreply@openai.com>

Reject API-hidden attributes when resolving required EAP attributes. This prevents timeseries group_by requests from silently dropping hidden fields and becoming ungrouped aggregate queries. Co-Authored-By: Codex <noreply@openai.com>

Validate API attribute visibility against remapped storage attributes for virtual contexts. This prevents hidden backing attributes from being exposed through timeseries group-bys and order-bys that use virtual context aliases. Co-Authored-By: Codex <noreply@openai.com>

…check Use the same "Could not parse" error message for hidden API attributes as for genuinely unknown fields, preventing attribute enumeration via distinct error messages. Remove the spans-only guard on the dsc./\_internal. prefix expansion in candidate generation so the visibility check applies to all item types. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

nsdeschenes · 2026-05-26T13:03:45Z

@sentry review

nsdeschenes · 2026-05-26T13:03:49Z

@cursor review

cursor

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

^{Reviewed by Cursor Bugbot for commit fe11be7. Configure here.}

wmak

small nits but lgtm

Combine _raise_if_hidden_api_attribute and _raise_if_hidden_resolved_attribute into one function that accepts both ResolvedAttribute and ResolvedFunction, doing the isinstance check internally. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

cursor

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

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

^{Reviewed by Cursor Bugbot for commit c309e19. Configure here.}

cursor · 2026-05-26T17:36:35Z

+            if isinstance(resolved_column, ResolvedAttribute) and self._should_hide_api_attribute(
+                column, resolved_column
+            ):
+                continue


Hidden fields skipped versus rejected

Medium Severity

With API visibility configured, the same hidden attribute is handled differently by code path: resolve_columns, resolve_functions, and resolve_equations silently drop it, while resolve_attributes, _resolve_term, and aggregate resolution raise HiddenApiAttribute. Users can see empty or misaligned results (dropped series/columns) alongside parse errors for filters, or orderby failures when a hidden name remains in selected_columns but was stripped from resolved output.

Additional Locations (2)

src/sentry/search/eap/resolver.py#L1040-L1044

src/sentry/search/eap/resolver.py#L537-L538

^{Reviewed by Cursor Bugbot for commit c309e19. Configure here.}

nsdeschenes mentioned this pull request May 22, 2026

fix(api): Hide internal trace attributes from discovery #116092

Closed

github-actions Bot added the Scope: Backend Automatically applied to PRs that change backend components label May 22, 2026

This was referenced May 22, 2026

fix(api): Filter internal trace attributes from results #116093

Closed

fix(api): Hide internal attributes in events and cross-trace queries #116094

Closed

feat(attributes): Hide internal attributes from responses #116084

Closed

fix(typing): Explicitly re-export ATTRIBUTE_METADATA from eap utils

85f1e75

The `as ATTRIBUTE_METADATA` pattern tells mypy this is an intentional re-export, fixing the attr-defined errors in tests that access it via `eap_utils.ATTRIBUTE_METADATA`.

nsdeschenes marked this pull request as ready for review May 22, 2026 14:17

nsdeschenes requested review from a team as code owners May 22, 2026 14:17

adrianviquez reviewed May 22, 2026

View reviewed changes

Comment thread src/sentry/search/eap/resolver.py Outdated

adrianviquez reviewed May 22, 2026

View reviewed changes

Comment thread src/sentry/search/eap/utils.py

adrianviquez reviewed May 22, 2026

View reviewed changes

nsdeschenes added 2 commits May 22, 2026 13:16

ref(search): Move can_expose_attribute_to_api import to top of module

3d585d7

ref(search): Remove redundant seen set in visibility candidates

1c0058e

The candidates set already prevents duplicates since we check `replacement not in candidates` before adding to pending.

nsdeschenes requested a review from adrianviquez May 22, 2026 16:18

cursor Bot reviewed May 22, 2026

View reviewed changes

Comment thread src/sentry/search/eap/resolver.py Outdated

nsdeschenes added 2 commits May 22, 2026 13:31

ref(search): Move can_expose_attribute_to_api import back to local scope

c002e60

Reverts the import move to avoid a circular import risk between resolver and utils modules.

adrianviquez approved these changes May 22, 2026

View reviewed changes

wmak reviewed May 25, 2026

View reviewed changes

Comment thread src/sentry/search/eap/utils.py

wmak reviewed May 25, 2026

View reviewed changes

Comment thread tests/sentry/search/eap/test_spans.py Outdated

wmak reviewed May 25, 2026

View reviewed changes

Comment thread src/sentry/search/eap/resolver.py Outdated

nsdeschenes and others added 4 commits May 25, 2026 13:13

Merge remote-tracking branch 'origin/master' into nd/feat-attributes-…

208c427

…visibility-core

Add in description comment

409b9a9

nsdeschenes requested a review from wmak May 25, 2026 17:57

cursor Bot reviewed May 25, 2026

View reviewed changes

Comment thread src/sentry/search/eap/resolver.py

Comment thread src/sentry/search/eap/utils.py

nsdeschenes requested a review from a team as a code owner May 25, 2026 18:34

cursor Bot reviewed May 25, 2026

View reviewed changes

Comment thread src/sentry/search/eap/resolver.py

Comment thread src/sentry/search/eap/resolver.py Outdated

nsdeschenes and others added 2 commits May 25, 2026 15:54

fix(search): Reject hidden EAP group by attributes

661211e

Reject API-hidden attributes when resolving required EAP attributes. This prevents timeseries group_by requests from silently dropping hidden fields and becoming ungrouped aggregate queries. Co-Authored-By: Codex <noreply@openai.com>

cursor Bot reviewed May 25, 2026

View reviewed changes

Comment thread src/sentry/search/eap/resolver.py Outdated

nsdeschenes and others added 3 commits May 26, 2026 07:19

Merge branch 'master' into nd/feat-attributes-visibility-core

fe11be7

vercel Bot deployed to Preview May 26, 2026 12:03 View deployment

cursor Bot reviewed May 26, 2026

View reviewed changes

wmak approved these changes May 26, 2026

View reviewed changes

Comment thread src/sentry/search/eap/resolver.py Outdated

Comment thread src/sentry/search/eap/resolver.py Outdated

nsdeschenes and others added 2 commits May 26, 2026 14:25

Remove underscore from name

24ae53b

cursor Bot reviewed May 26, 2026

View reviewed changes

nsdeschenes merged commit aff6a03 into master May 27, 2026
70 checks passed

nsdeschenes deleted the nd/feat-attributes-visibility-core branch May 27, 2026 13:24

sentry-release-bot Bot mentioned this pull request May 27, 2026

publish: getsentry/sentry@26.5.1 getsentry/publish#8288

Closed

3 tasks

Uh oh!

Conversation

nsdeschenes commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linear-code Bot commented May 22, 2026

Uh oh!

Uh oh!

Uh oh!

adrianviquez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nsdeschenes commented May 26, 2026

Uh oh!

nsdeschenes commented May 26, 2026

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

wmak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor Bot May 26, 2026

Choose a reason for hiding this comment

Hidden fields skipped versus rejected

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nsdeschenes commented May 22, 2026 •

edited

Loading