feat: Add path and query params to test-results endpoint #93264

ajay-sentry · 2025-06-10T19:01:23Z

This PR aims to add and uptake a number of path and query parameters for the first codecov endpoint being called in sentry.

First, we're adding both the path parameters:

Repository: string
Owner: string

Second, we're adding a number of query paramters:

sortBy: string
filterBy: string
interval: string (date)
branch: string
first: int
last: int

If neither first nor last are supplied, the default is 20

You'll notice that for the orderby parameter, sentry opts to use a "-" to denote descending rather than "DESC" like we did on the codecov side, so we had to accommodate for that. Otherwise it's fairly straightforward.

This should also update the openAPI spec accordingly.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

codecov · 2025-06-10T19:32:54Z

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@             Coverage Diff             @@
##           master   #93264       +/-   ##
===========================================
+ Coverage   46.19%   87.98%   +41.78%     
===========================================
  Files       10245    10267       +22     
  Lines      591310   592188      +878     
  Branches    23011    23011               
===========================================
+ Hits       273157   521019   +247862     
+ Misses     317663    70679   -246984     
  Partials      490      490

adrianviquez · 2025-06-10T23:10:15Z

src/sentry/codecov/endpoints/TestResults/test_results.py


        variables = {
            "owner": owner,
            "repo": repository,
            "filters": {
-                "branch": branch,
+                "branch": request.query_params.get("branch", "main"),


How would this work w/ master? I suppose main captures more than master these days

You could just pass in a branch name for master, eventually the frontend will be the SOT, we're just defaulting main here so the user doesn't need to pass a branch for most cases

adrianviquez · 2025-06-10T23:11:59Z

src/sentry/codecov/endpoints/TestResults/test_results.py


        variables = {
            "owner": owner,
            "repo": repository,
            "filters": {
-                "branch": branch,
+                "branch": request.query_params.get("branch", "main"),
+                "parameter": request.query_params.get("sortBy"),


Does this support every column value?

Also, I've seen other tables use sort instead of sortBy, thoughts on changing this? We can also adjust in the frontend, but seems consistent to use sort

Yeah it should!

adrianviquez · 2025-06-10T23:18:17Z

src/sentry/apidocs/parameters.py

+        """,
+    )
+    TEST_RESULTS_ORDER_BY = OpenApiParameter(
+        name="orderBy",


The tables I've worked with do sort=-<columnName> (or whatever we choose). Just double checking if this is the behaviour you'd expect here, since we don't explicitly seem to provide an orderBy param, the backend seems to infer it from the sort value

Just updated, thanks for the catch

calvin-codecov · 2025-06-10T23:35:52Z

src/sentry/codecov/endpoints/TestResults/test_results.py

+        if not first and not last:
+            first = 20
+        if first and last:
+            return Response(
+                status=status.HTTP_400_BAD_REQUEST,
+                data={"details": "Cannot specify both `first` and `last`"},
+            )


could we switch these two if statements' ordering? Since the first one can modify first's value, i think it's more clear the other way around.

This commit adds support for the interval query parameter to the TestResultsAggregates endpoint. Adds a new test to verify the interval parameter is correctly passed to the Codecov client. Fixes an existing test that had an incorrect assertion for git_provider_org. Resolves a linter conflict by renaming the endpoint attribute to endpoint_name in the test class to avoid overriding a base class property. Depends on: #93264

This commit adds support for the interval query parameter to the TestResultsAggregates endpoint. Depends on: #93264

joseph-sentry

lgtm just one quick comment`

src/sentry/codecov/endpoints/TestResults/test_results.py

joseph-sentry · 2025-06-11T15:33:42Z

src/sentry/codecov/endpoints/TestResults/test_results.py


        variables = {
            "owner": owner,
            "repo": repository,
            "filters": {
-                "branch": branch,
+                "branch": request.query_params.get("branch", "main"),


hmm, i would think that there's no fallback for branch unless we're just keeping this here for the time that this will be under development

Yeah that's right, just keeping it for development. We can remove as soon as query params are hooked up

This commit adds support for the interval query parameter to the TestResultsAggregates endpoint. Depends on: #93264

…93331) This commit adds support for the interval query parameter to the TestResultsAggregates endpoint. Depends on: #93264

This PR aims to add and uptake a number of path and query parameters for the first codecov endpoint being called in sentry. First, we're adding both the path parameters: - Repository: string - Owner: string Second, we're adding a number of query paramters: - sortBy: string - filterBy: string - interval: string (date) - branch: string - first: int - last: int If neither first nor last are supplied, the default is 20 You'll notice that for the orderby parameter, sentry opts to use a "-" to denote descending rather than "DESC" like we did on the codecov side, so we had to accommodate for that. Otherwise it's fairly straightforward. This should also update the openAPI spec accordingly. <img width="665" alt="Screenshot 2025-06-10 at 3 17 23 PM" src="https://github.com/user-attachments/assets/5135883e-df48-4121-a07e-8cf2e9b650a0" /> <img width="690" alt="Screenshot 2025-06-10 at 3 19 06 PM" src="https://github.com/user-attachments/assets/e738413c-b70f-4303-804f-9eb50e6c008a" />  ### Legal Boilerplate Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

…93331) This commit adds support for the interval query parameter to the TestResultsAggregates endpoint. Depends on: #93264

test results q params, at least most of them, pre tests and debugging

d3455e2

ajay-sentry requested review from a team as code owners June 10, 2025 19:01

github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Jun 10, 2025

add first/last params, just missing cursor for pagination

43aa85a

ajay-sentry changed the title ~~feat: Add and uptake branch,interval,sort,order q params and owner/repo path params~~ feat: Add path and query params to test-results endpoint Jun 10, 2025

vercel bot deployed to Preview June 10, 2025 20:19 View deployment

ajay-sentry added 2 commits June 10, 2025 13:26

new tests

8b2d932

lint errors

bdb31a2

vercel bot deployed to Preview June 10, 2025 20:32 View deployment

clean up code a bit

7409dc4

vercel bot deployed to Preview June 10, 2025 22:21 View deployment

ajay-sentry added 2 commits June 10, 2025 15:22

use owner and repo from path only

d247ad8

change provider org to be owner

02be70a

vercel bot deployed to Preview June 10, 2025 22:24 View deployment

fix test

69ba699

vercel bot deployed to Preview June 10, 2025 22:43 View deployment

adrianviquez reviewed Jun 10, 2025

View reviewed changes

change param names around

d0c658b

vercel bot deployed to Preview June 10, 2025 23:33 View deployment

calvin-codecov reviewed Jun 10, 2025

View reviewed changes

swap conditional

1bce36a

vercel bot deployed to Preview June 10, 2025 23:40 View deployment

adrianviquez approved these changes Jun 11, 2025

View reviewed changes

joseph-sentry added a commit that referenced this pull request Jun 11, 2025

feat(codecov): Add interval param to TestResultsAggregates endpoint

61ccefc

This commit adds support for the interval query parameter to the TestResultsAggregates endpoint. Depends on: #93264

joseph-sentry mentioned this pull request Jun 11, 2025

feat(codecov): Add interval param to TestResultsAggregates endpoint #93331

Merged

joseph-sentry approved these changes Jun 11, 2025

View reviewed changes

ajay-sentry merged commit 2b2767a into master Jun 11, 2025
61 of 62 checks passed

ajay-sentry deleted the Ajay/test-results-q-params branch June 11, 2025 15:39

joseph-sentry added a commit that referenced this pull request Jun 11, 2025

feat(codecov): Add interval param to TestResultsAggregates endpoint

6d4702a

This commit adds support for the interval query parameter to the TestResultsAggregates endpoint. Depends on: #93264

joseph-sentry added a commit that referenced this pull request Jun 11, 2025

feat(codecov): Add interval param to TestResultsAggregates endpoint (#…

0ad041f

…93331) This commit adds support for the interval query parameter to the TestResultsAggregates endpoint. Depends on: #93264

vishnupsatish pushed a commit that referenced this pull request Jun 12, 2025

feat(codecov): Add interval param to TestResultsAggregates endpoint (#…

cd43d3e

…93331) This commit adds support for the interval query parameter to the TestResultsAggregates endpoint. Depends on: #93264

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: Add path and query params to test-results endpoint #93264

feat: Add path and query params to test-results endpoint #93264

Uh oh!

ajay-sentry commented Jun 10, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

adrianviquez Jun 10, 2025

Uh oh!

ajay-sentry Jun 10, 2025

Uh oh!

adrianviquez Jun 10, 2025

Uh oh!

adrianviquez Jun 10, 2025

Uh oh!

ajay-sentry Jun 10, 2025

Uh oh!

adrianviquez Jun 10, 2025

Uh oh!

ajay-sentry Jun 10, 2025

Uh oh!

calvin-codecov Jun 10, 2025

Uh oh!

ajay-sentry Jun 10, 2025

Uh oh!

joseph-sentry left a comment

Uh oh!

Uh oh!

joseph-sentry Jun 11, 2025

Uh oh!

ajay-sentry Jun 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat: Add path and query params to test-results endpoint #93264

feat: Add path and query params to test-results endpoint #93264

Uh oh!

Conversation

ajay-sentry commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Legal Boilerplate

Uh oh!

codecov bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joseph-sentry left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ajay-sentry commented Jun 10, 2025 •

edited

Loading

codecov bot commented Jun 10, 2025 •

edited

Loading