Add support for numeric values and {install,download}_size #105992
Conversation
github-actions
bot
added
the
Scope: Backend
![sentry[bot]](https://avatars.githubusercontent.com/u/1396951?s=60&v=4){kind=small}
| # is defined later in this file | ||
| from sentry.preprod.models import PreprodArtifactSizeMetrics | ||
|
|
||
| main_metrics = PreprodArtifactSizeMetrics.objects.filter( | ||
| preprod_artifact=OuterRef("pk"), | ||
| metrics_artifact_type=PreprodArtifactSizeMetrics.MetricsArtifactType.MAIN_ARTIFACT, | ||
| ) | ||
| return self.annotate( | ||
| install_size=Subquery(main_metrics.values("max_install_size")[:1]), | ||
| download_size=Subquery(main_metrics.values("max_download_size")[:1]), | ||
| ) |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
| {"detail": ERR_FEATURE_REQUIRED.format("organizations:preprod-frontend-routes")}, | ||
| status=400, | ||
| ) | ||
|
|
There was a problem hiding this comment.
Tag values endpoint allows annotation-based keys that fail
Medium Severity
The BuildTagKeyValuesEndpoint validates keys against search_config.allowed_keys, which now includes download_count, download_size, and install_size. These are annotations created by annotate_download_count() and annotate_main_size_metrics(), but this endpoint doesn't add those annotations before querying. When users request tag values for these keys, the query will fail because queryset.values(db_key) references fields that don't exist on the model without the annotations.
chromy
force-pushed
the
chromy/2026-01-09-numeric
branch
from
11f59fd to
50641aa
Compare
| # Key mappings for user-friendly names | ||
| key_mappings={ | ||
| "app_id": ["app_id", "package_name", "bundle_id"], | ||
| "app_id": ["package_name", "bundle_id"], |
There was a problem hiding this comment.
Do we not need to map app_id since it already app_id ?
| assert len(response.json()) == 1 | ||
| assert response.json()[0]["app_info"]["app_id"] == "foo" | ||
|
|
||
| @with_feature("organizations:preprod-frontend-routes") |
There was a problem hiding this comment.
there are only tests for download count, not the other routes, but i assume they all work the same?
There was a problem hiding this comment.
I added one for install size which tests the size bit. It's true it might be good to test all of the fields at least once, I'll fix in a follow up.
chromy
force-pushed
the
chromy/2026-01-09-numeric
branch
from
50641aa to
cf228b9
Compare
| queryset = queryset.values(db_key) | ||
| queryset = queryset.exclude(**{f"{db_key}__isnull": True}) | ||
| queryset = queryset.annotate_download_count() | ||
| queryset = queryset.annotate_main_size_metrics() |
There was a problem hiding this comment.
Bug: The annotate_main_size_metrics() call occurs after the queryset is grouped with .values(db_key), causing the Subquery with OuterRef("pk") to fail as the primary key is unavailable.
Severity: HIGH
🔍 Detailed Analysis
In BuildTagKeyValuesEndpoint.get(), the queryset is grouped by a specific key using .values(db_key) before annotate_main_size_metrics() is called. This annotation method uses a Subquery with OuterRef("pk") to fetch size metrics. However, after the grouping operation, the primary key of individual artifacts is no longer present in the queryset's context. As a result, when the API is queried for install_size or download_size tag values, the subquery will fail to resolve, leading to NULL or incorrect data being returned for those fields.
💡 Suggested Fix
Move the call to annotate_main_size_metrics() to before the queryset is grouped by .values(db_key). Alternatively, refactor the annotation to use aggregate functions that are compatible with grouped querysets, similar to how annotate_download_count() is implemented.
🤖 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/sentry/preprod/api/endpoints/builds.py#L253
Potential issue: In `BuildTagKeyValuesEndpoint.get()`, the queryset is grouped by a
specific key using `.values(db_key)` before `annotate_main_size_metrics()` is called.
This annotation method uses a `Subquery` with `OuterRef("pk")` to fetch size metrics.
However, after the grouping operation, the primary key of individual artifacts is no
longer present in the queryset's context. As a result, when the API is queried for
`install_size` or `download_size` tag values, the subquery will fail to resolve, leading
to `NULL` or incorrect data being returned for those fields.
Did we get this right? 👍 / 👎 to inform future reviews.
Reference ID: 8404362
Add support the following properties:
Also add support for:
Finally prevent a 500 from build tags endpoint when passed an invalid field.